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-02-28 11:42:07 -08:00
parent 1944899970
commit da3c84a853
1 changed files with 14 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

18
Installing-the-Firmware.md

@ -36,7 +36,7 @@ Did I mention that you shouldn't waste your time on Arduino IDE v2.0. As of Janu
First compile and upload the firmware to the ESP32. Then upload the data using the Sketch Data upload tool. You will be happy to know that once the initial install is done you don't have to go through all these hoops to update the firmware or the LittleFS file system if you are using an ESP32S-WROOM-32 module. I created a utility that is part of the software to do this task but it is a chicken/egg thing where you need the hen on the ESP32 to hatch the egg. You can install the future firmware and the applicaton files remotely. So you can put the ESPSomfy RTS module into a remote location.
# Prerequisites
## Prerequisites
You must first install the Arduino IDE v1.8 which you will find on the [Arduino Software Site](https://www.arduino.cc/en/software). Install what they call the `Legacy IDE` for the platform you are developing on. Then follow the instructions to configure it for your ESP32 board. Make sure you use a ***USB data cable*** not one of the ones that is only for charging. If you cannot connect to your ESP32 then this is likely the problem.
To compile the firmware you will need to include four libraries. To install them, navigate to `Sketch` -> `Install Library`. Some of these libraries may be installed by default when you installed the Arduino IDE. They are listed below in the least likelihood of being installed already.
@ -47,22 +47,32 @@ The libraries include:
* WebSockets - Used to communicate the state of the shades over a websocket connection.
* ArduinoJson - JSON serializer and deserializer.
# LittleFS
## LittleFS
This project uses the file system on the ESP32. Follow the instructions found here to set up your Arduino IDE so it can upload the files to your board. Why this isn't just part of the Arduino development suite is a mystery but I guess that is why it is called hacking.
[LittleFS Plugin](https://github.com/lorol/arduino-esp32littlefs-plugin)
# Compile and Upload
## Compile and Upload
Once you have set up the environment press the arrow button at the top left of the Arduino IDE and it will begin compiling the software then upload when it is done. Bear in mind that this takes a bit of time to compile. If it is successful it will show in the console area at the bottom of the IDE.
# Upload the File System
## Upload the File System
All of the files required to build the file system are included in the `/data/` directory of the repository. When you click on the menu `Tool` -> `ESP32 Sketch Data Upload` it will compress these files into the file system layout and upload it to the ESP32. If you have the Serial Monitor open, close it before you perform this operation as it will fail if it is open.
The good news is that it will give you some innocuous message about how the port is busy. So you don't do something silly like shut everything down, open the serial monitor and try it repeatedly.
Once you have completed compiling and uploading the sketch you are done with the arduous part. Hopefully you have not spent all your F-Bombs on this process and have some left for bombing other targets. I am seeking easier ways so if you have a suggestion feel free to open an issue describing it.
# Firmware Updates
Each new release contains two files related to the firmware and can be uploaded without disconnecting the device or connecting it to USB. Keep in mind that flashing with the onboarding process will likely clear your configuration so unless you are onboarding your ESPSomfy RTS do not reflash it with the onboarding procedure.
To update your firmware to the latest version navigate to the releases section on this repository and download the `SomfyController.ino.esp32.bin` and `SomfyController.littlefs.bin` files that are contained with the release version. Once you have downloaded them navigate to the Updates tab on the ESPSomfy RTS configuration page. You should update the firmware first then the application.
![image](https://user-images.githubusercontent.com/47839015/221961284-5973e32a-ee33-4ba8-bd50-830a0a95ef6a.png)
Click the `UPDATE FIRMWARE` button and a screen will appear prompting you to select the `SomfyController.ino.esp32.bin` file. Once you have selected the file, press the `UPLOAD FILE` button to begin the transfer. The progress bard will indicate when it is done uploading the file. Your the ESPSofy RTS device will reboot after it finishes so give it at least 15 seconds to reconnect after the upload finishes.
After the firmware has been updated, you are ready to update the application binary file. Press the `UPDATE APPLICATION` button and select the `SomfyController.littlefs.bin` into the space provided. Once it is selected press the `UPLOAD FILE` button. Once completed, the screen will refresh and your software update is complete.