Updated Upgrading (markdown)

Michael Ingraham 2019-10-17 18:01:36 -04:00
parent ce9655e0c4
commit 4f7eb3603a
1 changed files with 17 additions and 17 deletions

@ -4,6 +4,19 @@ The first rule of upgrading: _**If it ain't broke, don't fix it!**_ In other wor
Any time you upgrade it is highly recommended that you [back up your device settings](#device-settings). This is found in the web UI under the `Configuration` menu.
# Device Settings
Tasmota uses flash memory to store many options and settings. Newer versions of Tasmota add features and use more and more of this area than earlier versions. These regions of flash were therefore not used by Tasmota before. If you did not erase flash when you originally flashed your device, a newer update may be accessing areas with values left over from the original factory firmware. Therefore there could be unexpected behavior. It is best to address this before upgrading across major versions of Tasmota.
1. Make a configuration backup using one of these two methods:
- Use `decode-config.py` from the Tasmota [`tools` code folder](../tree/development/tools) to create the backup in human readable form:
`decode-config.py -d <deviceIP> --backup-file Config-@H-@f-@v --backup-type json`
- If you have a `.dmp` backup already, you can create a JSON extract from that file:
`decode-config.py -f <dmpFile> --backup-file Config-@H-@f-@v --backup-type json`
2. Perform a `Reset 6` (erases flash settings area but retains Wi-Fi and MQTT settings)
3. Upgrade the firmware
4. Restore configuration
Particularly the older your current Tasmota versions is, it is probably best not to restore the backup directly since there may be some outdated settings in your configuration. There are often newer better alternatives, particularly since an upgrade is normally done to use new features. Configure the device manually referring to the [Commands article](Commands) and the settings (e.g., SetOptions, Rules, etc.) in the JSON file you created in step #1.
# OTA upgrade
Upgrading the device firmware [over-the-air](https://en.wikipedia.org/wiki/Over-the-air_programming) is the convenient way to upgrade. Open a web browser to you device's Web UI and select Firmware Upgrade.
@ -17,12 +30,12 @@ If you want to upgrade to the latest release version click the first **Start Upg
![image](https://user-images.githubusercontent.com/5904370/55827075-ac983400-5b09-11e9-83d7-e6d576676db6.png)
During this process Tasmota will download the new firmware from the url and install it. It might need to download **sonoff-minimal.bin** first but all that happens automatically. All you have to do is **wait 2 to 5 minutes**.
During this process Tasmota will download the new firmware from the url and install it. It might need to download **`sonoff-minimal.bin`** first but all that happens automatically. All you have to do is **wait 2 to 5 minutes**.
After the upgrade is completed you can reconnect back to the Web UI and check the firmware version on the bottom of the page.
### Changing Ota Url
If you wish to switch to a different [build](Builds) you have to change OtaUrl to the desired binary from our [OTA Server](http://thehackbox.org/tasmota/release/).
If you wish to switch to a different [build](Builds) you have to change OtaUrl to the desired binary from our [OTA Server](http://thehackbox.org/tasmota/).
It is possible to create your own simple http OTA server (https is not supported) using Python and perform upgrades from there.
Install Python and from the folder where the binary (make sure `sonoff-minimal.bin` is located there too) is located run :
@ -32,7 +45,7 @@ python -m http.server 8000
Change your OtaUrl to http://ipoftheserver:8000/yourbinary.bin and start the upgrade process.
## Upgrade by file upload
This process requires you to have a minimal build ([`sonoff-minimal.bin`](http://thehackbox.org/tasmota/release/sonoff-minimal.bin)) of the firmware since the upload process needs the space in flash memory to upload the new binary.
This process requires you to have a minimal build ([`sonoff-minimal.bin`](http://thehackbox.org/tasmota/sonoff-minimal.bin)) of the firmware since the upload process needs the space in flash memory to upload the new binary.
When you try to immediately upgrade to a new binary without using minimal firmware you will be greeted with this error.
@ -64,7 +77,7 @@ Initiate [upgrade](Commands#upgrade) from OTA server
```lua
upgrade 1
```
Wait for the upgrade process to complete and check the Tasmota version. If in console you can use `status 2`.
Wait for the upgrade process to complete and check the Tasmota version. If in console you can use `Status 2`.
## OTA upgrade using on-device button
Devices with a built in button (the one used to put your device into [flash mode](Hardware-Preparation#bringing-the-module-in-flash-mode)) can initiate OTA upgrade with it.
@ -110,16 +123,3 @@ So to migrate from **Sonoff-MQTT-OTA-Arduino versions before 3.1.0** to **Tasmot
2. Migrate to **Sonoff-Tasmota 4.x**
3. Migrate to **Sonoff-Tasmota 5.14**
4. Migrate to **Tasmota 6.x**
# Device Settings
Tasmota uses flash memory to store many options and settings. Newer versions of Tasmota add features and use more and more of this area than earlier versions. These regions of flash were therefore not used by Tasmota before. If you did not erase flash when you originally flashed your device, a newer update may be accessing areas with values left over from the original factory firmware. Therefore there could be unexpected behavior. It is best to address this before upgrading across major versions of Tasmota.
1. Make a configuration backup using one of these two methods:
- Use `decode-config.py` from the Tasmota [`tools` code folder](../tree/development/tools) to create the backup in human readable form:
`decode-config.py -d <deviceIP> --backup-file Config-@H-@f-@v --backup-type json`
- If you have a `.dmp` backup already, you can create a JSON extract from that file:
`decode-config.py -f <dmpFile> --backup-file Config-@H-@f-@v --backup-type json`
2. Perform a `Reset 6` (erases flash settings area but retains Wi-Fi and MQTT settings)
3. Upgrade the firmware
4. Restore configuration
Particularly the older your current Tasmota versions is, it is probably best not to restore the backup directly since there may be some outdated settings in your configuration. There are often newer better alternatives, particularly since an upgrade is normally done to use new features. Configure the device manually referring to the [Commands article](Commands) and the settings (e.g., SetOptions, Rules, etc.) in the JSON file you created in step #1.