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 Configuring the Software (markdown)

rstrouse 2023-09-15 12:35:47 -07:00
parent 960f6a3dc8
commit e6f0afd0d4
1 changed files with 20 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

25
Configuring-the-Software.md

@ -298,13 +298,28 @@ Unpair the shade from the group
After you get done adding all your shades an groups you may find that the order in which they are shown in the web display is not to your liking. Initially, these are in the order in which they are added to the device. You can change this order by navigating to the Shades and/or Groups tab. Then simply drag each one into the order in which you would like them to appear.
# Backup and Restore
You may back up your shade settings at any time using the backup function. To back up your shade settings, from the gears menu, select the `Updates` tab. From this tab simply click on the backup button and a text file containing the current shade configuration will be downloaded to your browser. You may use this file should you need to replace your ESP32 or simply want to use another device.
To restore the settings you can simply upload a valid backup file to the device using the `Restore` button. But beware, this will overwrite all the shade settings on the device. During the upload process, ESPSomfy RTS will maintain the current rolling code if it is greater than the rolling code stored in the file.
![image](https://user-images.githubusercontent.com/47839015/224568639-406bcf91-a2c6-4dbe-bcaf-9f459f2fc30d.png)
You may back up the settings on your ESPSomfy RTS device at any time using the backup function. Originally, this function backed up only the Shades and Groups settings but starting with v2.1.6 this function also backs up the Radio Settings, System Options, and Network configuration. However, this function will not back up the following items:
* WiFi connection (SSID or Passphrase)
* MQTT Settings
* Security Settings
The backup file is presented in clear text and including these items would expose secrets that should have been set up prior to restoring a backup file anyway. So keep these items in a secure place and feel good about the file not containing information that can be used to mess with your network.
To back up your shade settings, from the gears menu, select the `System` section then the `Firmware` tab. From this tab simply click on the backup button and a text file containing the current settings on the ESPSomfy RTS device will be downloaded to your browser. You may use this file should you need to replace your ESP32 or simply want to use another device. The layout of this file contains a header that allows for validation and consistency checks when restoring the data.
ESPSomfy RTS is capable of ensuring you do not restore a recipe for Hot Dish to your ESPSomfy RTS device. And you really should be eating more Hot Dish as it is a super food. Not making any claims here, but it improves mental acuity, stamina, and creates a handy shelf that keeps your feet dry in the rain.
To restore the settings you can simply upload a valid backup file to the device using the `Restore` button. You will be presented with options that allow you to restore portions of the information in the backup file. Check each option that you want to restore.
* Restore Shades and Groups: All shades and groups will be restored to the configuration in the backup file. Any previous configurations will be lost.
Because rolling codes are incremented sequentially, if there are any rolling codes stored on the ESPSomfy RTS these will be matched to the addresses for the shades or groups so they continue to operate without resetting them.
* Restore System Settings: Restores the SSDP, Hostname, and Time server settings. Security options are not restored and no changes will be made to the security settings.
* Restore Network Settings: All options from the Network section of the configuration will be restored with the exception of the MQTT settings, SSID and Passphrase. However, if you are restoring to an Ethernet enabled device, it will not restore the adapter settings. Many of the ESP32 ethernet boards do not contain any protection on the ethernet chip. Incorrect settings can destroy this chip so ESPSomfy RTS will only restore the adapter settings where the backup came from the target ESP32.
* Restore Radio Settings: This will restore all the radio configuration settings for the device. This includes all the protocol and pin settings as well as any tuning you may have done for the transceiver.
![image](https://github.com/rstrouse/ESPSomfy-RTS/assets/47839015/f6eff198-2d39-4503-8622-f2e37f7e8370)
After you have selected a backup file and reviewed the restore options click the upload file and the restore process will begin. The ESPSomfy RTS device will reboot and the new settings will be applied.