Merge branch 'master' of https://github.com/pjalocha/esp32-ogn-tracker

README.md

@@ -7,12 +7,33 @@ The initial code is written for and tested on HALTEC LoRa 32 module with sx1276
 Most likely it can be easily ported to other ESP32 devices, as these are very flexible for the I/O assignement.
 If you need to change the pins assigned to various periferials, see the top of the hal.cpp file.
 
-To compile and flash the ESP32 board you need to install the ESP-IDF v4.0, start with:
+## To compile the code: install the ESP-IDF
+
+To compile and flash the ESP32 board you need to install the ESP-IDF v4.0
+Start with:
 
 ```
+cd
 git clone -b v4.0 --recursive https://github.com/espressif/esp-idf.git
+cd esp-idf
+./install.sh
+```
+If you are doing this on a Raspberry PI and see error messages about *virtualenv* you may need the following:
+```
+pip install --upgrade virtualenv==16.7.9
+```
+
+Then, in order to be able to *make* projects you need to run
+```
+source ~/esp-idf/export.sh
+```
+
+To get the OGN-Tracker source code from this github repository:
+```
+cd
+git clone https://github.com/pjalocha/esp32-ogn-tracker.git
+cd ogn32-ogn-tracker
 ```
-then run *install.sh* and *export.sh* so you are ready to run *make* in the project directory.
 
 If you want to use the OLED display with the U8g2 library you need to install it from the project directory:
 
@@ -23,6 +44,19 @@ git clone https://github.com/olikraus/u8g2.git
 cd ..
 ```
 
+To choose the configuration file for the T-Beam
+```
+cp T-Beam.cfg main/config.h
+```
+
+To compile and flash the board
+```
+make
+make flash
+```
+
+## Wiring the GPS
+
 For the original HELTEC board you need to wire the UART GPS follow the pins defined in the hal.cpp
 ```
                                   // wire colours for VK2828U GPS
@@ -36,5 +70,5 @@ An attempt to control it from the CPU did not work, to be followed.
 
 Note: I have seen GPSes where red was ground and black was power thus be carefull !
 
-Note: If you use MTK GPS check the definitions in the hal.h accordingly if you want higher baud rates on the GPS UART
+Note: If you use MTK GPS check the definitions in the hal.cpp accordingly if you want higher baud rates on the GPS UART