kuba/TEF6686_ESP32
1
0
Fork 0
Code Issues Pull Requests Releases 1 Wiki Activity

add instructions for downloading, compiling and uploading code

Mateusz Walkowiak
2023-07-16 17:19:21 +02:00
parent 24c5274d51
commit 5e61c5ec11
1 changed files with 66 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

67
Installing-the-software.md

@@ -1,3 +1,68 @@
# Downloading
There are two ways of downloading our software:
## Releases
Download the code from [Releases page](https://github.com/PE5PVB/TEF6686_ESP32/releases/) - this code isn't the latest. But it is the most stable one.\
Remember to choose your proper version. ARS version is provided to AmateurRadioShop's kit that are selled there. Otherwise just download version without ARS in the name.
## Source code
If you want to have the newest code download whole source code. There are 2 ways to do this.\
First method is using git. Just turn on your Linux terminal and write:\
``git clone https://github.com/PE5PVB/TEF6686_ESP32``
If you are Windows user or you just don't have git installed on your PC just download the code from this [link](https://github.com/PE5PVB/TEF6686_ESP32/archive/refs/heads/main.zip). Or manually by clicking on the green "Code" button (on the [home page](https://github.com/PE5PVB/TEF6686_ESP32)) and then "Download ZIP"
# Compiling
# Uploading
If you downloaded code from Releases page you can just skip this part.
We recommend using [Arduino IDE](https://www.arduino.cc/en/software/) for compiling the code. If you don't have it installed please visit official Arduino's website to download it.\
After installing Arduino IDE you need to download board definitions for ESP32.
1. Open Arduino IDE and in File tab select Preferences.
2. At the bottom you will see Additional Board Manager URLs field. You need to fill it with:\
``https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_index.json``
Then click OK button
3. Now we need to open Board Manager. Select Tools > Board > Boards Manager
4. Search for ESP32 it should pop up on the top. Then click install
5. After installing close the window by clicking OK.
6. Select again Tools > Board and from ESP32 list search for ESP32 Dev Module. Then select it.
Now extract your previously downloaded code to folder named TEF6686_ESP32
1. Double-click on TEF6686_ESP32.ino file to open it in Arduino IDE.
- If you didn't download libraries please follow these steps. Otherwise move to next step.
- In this step you need to download 3 ZIP libraries (TFT_eSPI, TimeLib, Hash). Links to them are included in the code
- Don't extract downloaded ZIP files. Move to Arduino IDE and select Sketch > Include Library > Add .ZIP library
- Select downloaded libraries. After adding 3 libraries you can move to the next step.
2. Modifying TFT_eSPI configuration. If you done that before please move to the next step.
- Open your User_Setup.h file (located in Documents/Arduino/libraries/TFT_eSPI folder) with these values:
```
#define ILI9341_DRIVER
#define TFT_CS 5
#define TFT_DC 17
#define TFT_RST 16
#define SPI_FREQUENCY 10000000
#define LOAD_FONT7
#define LOAD_GFXFF
#define SMOOTH_FONT
```
- **ALL OTHER SETTINGS SHOULD BE REMARKED!**
- If you experience QRM noise nearby 90 MHz please concider lowering SPI_FREQUENCY value.
3. Now we are ready to compile the code. Click "Verify" button (first on the top left) to verify our code. It should compile your sketch and give "Done compiling" message.
4. Select proper COM port. Tools > Port (If you are not sure which port should you select move to step 4a).
- Press WIN+R and type ``devmgmt.msc`` or just run your Device Manager.
- Hold your BOOT button* on your ESP32 and plug USB cable from ESP to your computer
- Your ESP32 should pop-up in Ports section with port name in the brackets that you need to select in Arduino IDE
# Uploading
## Releases
1. Hold your BOOT button* on your ESP32 and plug USB cable from ESP to your computer.
2. Extract downloaded ZIP file and run ``flash.bat`` file.
3. Enter your COM port number (if not sure go to step 3a)
- Press WIN+R and type ``devmgmt.msc`` or just run your Device Manager.
- Your ESP32 should pop-up in Ports section with port name in the brackets that you need to give in flash.bat script
4. The script will upload code to your ESP and end with "Leaving... Hard resetting via RTS pin..." message.
5. Turn off your tuner and unplug USB.
6. Now you can turn on tuner and enjoy the new software!
## Source code
1. After selecting proper COM port and making sure that ESP32 is in BOOT mode you can click "Upload" button (just next to Verify button)
2. Please wait some time and after successful upload Arduino IDE will display "Done Uploading." message.
3. Turn off your tuner and unplug USB.
4. Now you can turn on tuner and enjoy the new software!
*BOOT button location may differ depending on your tuner version