aaribaud/ESPSomfy-RTS
0
0
Fork 0
mirror of https://github.com/rstrouse/ESPSomfy-RTS.git synced 2025-12-15 03:52:11 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Updated Installing the Firmware (markdown)

rstrouse 2023-03-20 11:59:43 -07:00
parent 3637f4d5bd
commit 53dbb0da9f
1 changed files with 27 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

29
Installing-the-Firmware.md

@ -1,6 +1,6 @@
There are three (actually 4 but the fourth method uses the command line) methods you can use to upload the initial firmware to your device. Two of them are a bit technical but not insurmountable. If you develop software on ESP devices then you probably already have the Arduino IDE v1.8 software installed on your computer. If you do not then choose either the ESP32 flash download tool method or the ESPHome web method as they are fairly straight forward. I didn't ask him to try, but I think that even the hairy cave dude from the Geico commercials can get this done.
There are four methods you can use to upload the initial firmware to your device. Two of them are a bit technical but not insurmountable. If you develop software on ESP devices then you probably already have the Arduino IDE v1.8 software installed on your computer or are familiar with the esptool.py script. If you haven't dabbled in these tools, then choose either the ESP32 flash download tool method or the ESPHome web method as they are fairly straight forward. I didn't ask him to try, but I think that even the hairy cave dude from the Geico commercials can get this done.
The initial firmware onboarding can be performed using a single file without having to recompile the software using the `SomfyController.onboard.esp32.bin` file for the release. Download this file to your computer somewhere. The file is located on this repository under releases on the right side of the main page. Please note that if you flash this file to your device it will erase your shade configuration so if this is not a new install perform the [update procedure](https://github.com/rstrouse/ESPSomfy-RTS/wiki/Updating-ESPSomfy-RTS) instead of this onboarding procedure.
The initial firmware onboarding can be performed using a single file without having to recompile the software using the `SomfyController.onboard.esp32.bin` file for the release. Download this file to your computer somewhere. The file is located on this repository under [releases](https://github.com/rstrouse/ESPSomfy-RTS/releases) on the right side of the main page. Please note that if you flash this file to your device it will erase your shade configuration so if this is not a new install perform the [update procedure](https://github.com/rstrouse/ESPSomfy-RTS/wiki/Updating-ESPSomfy-RTS) instead of this onboarding procedure.
![image](https://user-images.githubusercontent.com/47839015/221660466-ab827cf1-4bfe-4e4d-8b5a-5b1245544a53.png)
@ -41,6 +41,31 @@ Once the flash process is complete disconnect any jumpers you have installed to
You are now free to upload firmware using the included web interface.
# Using esptool.py
You can use esptool to install the initial firmware. This will require running a few scripts from the command line.
## Install the Python esptool via pip
If you do not already have esptool installed run the following command to install it.
```bash
pip install --user esptool
```
## Upload the flash image to the device
First determine which port your ESP32 is connected to. If this is a linux computer a likely candidate will be `/dev/ttyUSBn` where `n` is the port number for the usb device. The easiest way to find this port number is to plug in the ESP32 then run `ls -l /dev/ttyUSB*` then disconnect it and run the command again. Whichever port went away is the one you want.
If you are running in a Windows environment you can find the `COMn` port from the device manager.
Once you have determined which port your ESP32 is connected to you can flash it using the following commands. Replace `/dev/ttyUSB0` with the port you identified above and the `~/path/to/SomfyController.onboard.esp32.bin` with the location of the firmware file.
```bash
# Check if everything works by checking the ID of the ESP32
esptool.py --port /dev/ttyUSB0 flash_id
# Erase whatever is on there
esptool.py --port /dev/ttyUSB0 erase_flash
# Write the SomfyController image
esptool.py --port /dev/ttyUSB0 write_flash 0x0 ~/path/to/SomfyController.onboard.esp32.bin
```
# Using Arduiono IDE v1.8
I developed this using the painfully awful Arduino IDE v1.8. I originally installed v2.0 then found out you cannot upload the file data to it. Download v1.8 (legacy) and save yourself several hours of searching through forums for functions that are not supported on 2.0 even several years after its release. If you are using VS Code then you are on your own since I don't have any experience with it. The good news is that you only need this during the initial install and all follow on work for the module is user friendly.