View source for WB Modbus Devices Firmware Update/en

<languages/>
== General Information ==
Wiren Board modbus devices have a [[Bootloader |bootloader]], which allows updating firmware via RS-485/Modbus RTU. In bootloader mode, the main functions of the device are disabled, and the communication parameters in bootloader mode are fixed and do not depend on the values in the device memory: 9600 8N2.

The firmware itself is released in the format of releases, which are linked to [[Wiren_Board_Software#releases|controller software releases]], but have a different cycle:
*'''testing''' — firmware that has passed internal testing lands here, available to users of the controller's testing release;
*'''stable''' — three weeks after being published in testing and with no error reports, the firmware is considered stable. At this point, it becomes available to users of the stable release of the controller. If there were major changes in the firmware that affected the device's core functions, the firmware may be slightly delayed in testing.

On the page of each device there is a link to the list of firmware changes, where firmware in testing is marked with the "testing" marker. Firmware without a mark is considered stable.

Distributing firmware updates by releases helps prevent a situation where a new firmware version, without undergoing thorough testing, ends up in a very critical installation. If the new firmware requires new features in the controller's software, either these features will be included in the stable software release along with the firmware, or the firmware update will be delayed in testing until the required features appear in the software.

To update devices connected via a WB-MGE gateway or a similar device, use the socat redirection, [[WB FAQ/modbus-modules-behind-gateway | instructions]].

== Automatic firmware update ==
[[Image:Wb-fw-mcu-updater example 1.png|500px|thumb|right|Example of wb-fw-mcu-updater operation]]
{{note|info|When updating the firmware, IR commands stored in WB-MSW and WB-MIR devices are deleted. We recommend saving command banks before updating using the [[WB-MSx Consumer IR Manual#Reading/Writing Command Banks|script]].}}
Automatic firmware update is performed using the utility [[Wb-mcu-fw-updater|wb-mcu-fw-updater]] preinstalled on Wiren Board controllers, allowing you to install the latest version of the software on all connected devices at once or separately on each one. The device model and new firmware will be automatically identified.

The utility only works on our controller and requires internet access. If you do not have internet or our controller, refer to the section [[#manual|Manual Update]]. 

Updating firmware on devices connected to WB-MGE and WM-MIO-E gateways is also performed [[WB_Modbus_Devices_Firmware_Update#Обновление_прошивки_устройств,_подключенных_к_шлюзам_WB-MGE_и_WM-MIO-E |manually with displaying the network port to local]].

=== Updating all devices on the bus ===
You can update all devices configured in the '''Serial Devices Configuration''' section of the [[Wiren Board Web Interface|web interface]]
# Connect the devices via the [[RS-485|RS-485 bus]] to the controller.
# [[RS-485:Configuration via Web Interface|Configure the connected devices]] in the web interface.
# Open the controller's console via [[SSH]].
# Update all configured devices with the following command:
#:<syntaxhighlight lang="bash">
wb-mcu-fw-updater update-all
</syntaxhighlight>

=== Updating a Single Device ===
To update only one device:
# Connect the device via RS-485 to the controller.
# Determine the [[Wiren Board Device Modbus Address | Modbus address]] of the device you want to update.
# Open the controller console via [[SSH]].
# Run the utility <code>wb-mcu-fw-updater</code> with the following parameters: the <code>update-fw</code> key, as well as the port and Modbus address. 

For example, let's update the firmware of a device with a modbus address of <code>70</code> connected to port <code>/dev/ttyRS485-1</code>:
<syntaxhighlight lang="bash">
wb-mcu-fw-updater update-fw /dev/ttyRS485-1 -a70
</syntaxhighlight>

For the full list of parameters and examples of usage, refer to the [[Wb-mcu-fw-updater | utility page]].

== Manual Update ==
{{Anchor|manual}}
=== Features ===
This method is used if:
* there is no internet access at the object,
* you do not have a controller,
* you are updating the firmware of devices, [[WB_Modbus_Devices_Firmware_Update#Firmware_Update_for_Devices_Connected_to_WB-MGE_and_WB-MIO-E_Gateways|connected through WB-MGE and WB-MIO-E gateways]].

In all other cases, use the [[WB_Modbus_Devices_Firmware_Update#Automatic_Update |automatic update]].

Manual update can be done with the utility '''[[wb-mcu-fw-flasher#Installing the Utility|wb-mcu-fw-flasher]]''', which needs to be installed beforehand. The installation method varies and depends on the operating system being used.

=== Device preparation ===

Devices can be flashed in the following ways:
* by the device's Modbus address.
* by the broadcast address, which is <code>0</code>.

To flash multiple devices on the bus, you need to sequentially switch them to the [[Bootloader MOD|bootloader mode]] and flash them.

=== Firmware upload to the device ===
To upload the firmware, follow these steps:
# Connect the device via [[RS-485 | RS-485 bus]] to the controller or other equipment where the firmware utility is installed.
{{Wbincludes:Prepare modbus_client}}
# Download the firmware file for your device from the repository following the [[Firmware Repository For Wiren Board Modbus Devices | instructions]].
# Upload the firmware file to the [[View controller files from your computer | controller]] or other device.
# Go to the folder with the firmware file and execute the command:
#:* on the controller or a Linux computer:
#:<syntaxhighlight lang="bash">
wb-mcu-fw-flasher -j -d /dev/ttyRS485-1 -a25 -f ./firmware.wbfw
</syntaxhighlight>
#:* on a Windows computer:
#:<syntaxhighlight lang="bash">
wb-mcu-fw-flasher_1.0.3.exe -j -d COM1 -a25 -f firmware.wbfw
</syntaxhighlight>
# If you executed the command from the controller, start the wb-mqtt-serial driver.

In the above command, using the <code>-j</code> flag, we switched the device connected to the port <code>/dev/ttyRS485-1</code> (<code>COM1</code>) with address <code>25</code> to bootloader mode and then flashed it.

A successful firmware update process looks like this:
<syntaxhighlight lang="bash">
~# wb-mcu-fw-flasher -j -d /dev/ttyRS485-1 -a 25 -f mr6c__1.15.5_master_971fe50.wbfw  
   /dev/ttyRS485-1 opened successfully.
   Send jump to bootloader command and wait 2 seconds...
   Ok, device will jump to bootloader.
   mr6c__1.15.5_master_971fe50.wbfw opened successfully, size 14720 bytes

   <div lang="ru" dir="ltr" class="mw-content-ltr">
Sending info block... OK
</div>

   <div lang="ru" dir="ltr" class="mw-content-ltr">
Sending data block 108 of 108... OK.
   All done!
</syntaxhighlight>
</div>

If the device signature and firmware file do not match, you will receive an error message:
<syntaxhighlight lang="bash">
Sending info block...
   Error while sending info block: Slave device or server failure 
   Data format is invalid or firmware signature doesn't match the device
</syntaxhighlight>

== Restoring the device firmware ==
{{Anchor|fw-recovery}}
If an error occurred during the update, the device will enter the [[Wbincludes:Bootloader MOD | bootloader mode]] and you can restore its firmware.

=== Automatically ===
To automatically restore the firmware of one or multiple devices, you can use the utility wb-mcu-fw-updater in the modes '''recover''' and '''recover-all'''.

To recover the device with address <code>10</code> and connected to port <code>/dev/ttyRS485-1</code>, execute the command:
<syntaxhighlight lang="bash">
wb-mcu-fw-updater recover /dev/ttyRS485-1 -a 10
</syntaxhighlight>

For more information on the recover and recover-all modes, read the documentation in [[Wb-mcu-fw-updater#Modes|the documentation]].

=== Manually ===
If you cannot use [[wb-mcu-fw-updater]], you can restore the firmware of devices using the service utility [[wb-mcu-fw-flasher]]. This method can also be used by Windows computer users.

To do this, you will need the utility itself and the firmware file:
# Connect the device via the [[RS-485 | RS-485 bus]] to the controller or other equipment where the firmware utility is installed.
{{Wbincludes:Prepare modbus_client}}
# [[Firmware Repository For Wiren Board Modbus Devices | Download]] the firmware file for your device from the repository.
# Upload the firmware file to the [[View controller files from your computer | controller]] or other device with the firmware utility installed.
# Go to the folder with firmware and execute the command:
#* on a Linux-based controller or computer:
#:<syntaxhighlight lang="bash">
wb-mcu-fw-flasher -d /dev/ttyRS485-1 -a 25 -f ./firmware.wbfw
</syntaxhighlight>
#* on a Windows-based computer:
#:<syntaxhighlight lang="bash">
wb-mcu-fw-flasher_1.0.3.exe -d COM1 -a 25 -f firmware.wbfw
</syntaxhighlight>

Here we flashed the device in bootloader mode with Modbus address <code>25</code> connected to port <code>/dev/ttyRS485-1</code> (<code>COM1</code>) using the file <code>firmware.wbfw</code>.

==Updating firmware of devices connected to WB-MGE and WB-MIO-E gateways==
[[Image:superport-config.png|350px|thumb|right|Gateway settings for firmware update]]
To update the firmware of a Wiren Board device connected to the [[WB-MGE_v.2_Modbus-Ethernet_Interface_Converter|WB-MGE]] and [[WB-MIO-E_v.2_Modbus_Interface_Converter|WB-MIO-E]] gateways via RS-485, it can only be done manually using the [[Wb-mcu-fw-flasher|wb-mcu-fw-flasher]] utility. However, first, you need to convert the network port to a local one using the [[Socat|socat]] utility.

The gateway must be set to TCP Server/None mode (for WB-MGE v2, WB-MIO-E v2) or TCP Server mode (for WB-MGE v1, WB-MIO-E v1).

===Update at any connection speed===

Connection settings can be any, !if! only:

*Version of wb-mcu-fw-flasher is not less than '''1.3.0''' (available in [[testing|testing]]),
*The current firmware version of the device supports '''131''' registers (see Change logs on device pages),
*The current bootloader version is not lower than '''1.3.0'''.

'''Otherwise, the update can only be performed with standard 9600N2 connection settings.'''

Below is an example with the following input data:

*Gateway WB-MGE (WB-MIO-E), configured for Modbus over TCP and having IP address 192.168.0.7, port 23.
*Modbus device Wiren Board with address 14.
*Connection speed is 115200 kbit/s.

{{note|info|'''Attention!''' In your case, the settings may be different.}}

#Prepare the firmware file and install the socat utility if it is not installed:
#:<syntaxhighlight lang="bash">
apt install socat
</syntaxhighlight>
#Connect twice to the controller via SSH, you should have two windows open: the first one for creating a socat tunnel, the second one for sending commands to the device.
#Stop wb-mqtt-serial:
#:<syntaxhighlight lang="bash">
systemctl stop wb-mqtt-serial
</syntaxhighlight>
#In the first window, start redirecting with socat using the current connection settings:
#:<syntaxhighlight lang="bash">
socat -d -d -d -x PTY,raw,b115200,parenb=0,cstopb=2,cs8,link=/dev/ttyRS485-5 tcp:192.168.0.7:23
</syntaxhighlight>
#In the second window, start the device firmware update with the wb-mcu-fw-flasher utility, using the -J parameter. Specify the firmware file prepared earlier:
#:<syntaxhighlight lang="bash">
wb-mcu-fw-flasher -J -d /dev/ttyRS485-5 -a14 -f ./firmware.wbfw
</syntaxhighlight>
#Start wb-mqtt-serial
#:<syntaxhighlight lang="bash">
systemctl start wb-mqtt-serial
</syntaxhighlight>

===Updating with default connection settings===
This instruction is used for devices where the current bootloader version is below '''1.3.0''' and/or the current firmware does not support '''131''' register. 

In this case, the update can only be performed at a speed of '''9600N2''', by specifying the <code>-j</code> parameter for the wb-mcu-fw-flasher utility. If different connection settings are used, they must first be changed to the standard ones.

We also recommend updating the bootloader if its version is 
1.3.0
. This will allow you to update the firmware at any speed of connection [[WB_Modbus_Devices_Firmware_Update#Обновление_на_любой_скорости_соединения |any connection speed]].

Let's consider a synthetic example of firmware update for devices, where non-standard connection settings are used: 
*WB-MGE (WB-MIO-E) gateway configured for Modbus over TCP with IP address 192.168.0.7, port 23.
*Connected to the gateway is WB-MDM3 device with address 58.
*Device and gateway settings are set to a speed of 115200 kbit/s.

{{note|info| '''Attention!''' The instructions consider an example in which the devices operate at a speed of '''115200 8N2'''. In your case, the connection settings may be different.}}
To update the firmware:
#Connect to the controller twice via [[SSH |SSH]], you should have two windows open: the first to create a socat tunnel, the second to send commands to the device.
#Stop wb-mqtt-serial:
#:<syntaxhighlight lang="bash"> 
systemctl stop wb-mqtt-serial 
</syntaxhighlight> 
#In the first window, start the redirect:
#:<syntaxhighlight lang="bash"> 
socat -d -d -d -x PTY,raw,b115200,parenb=0,cstopb=2,cs8,link=/dev/ttyRS485-5 tcp:192.168.0.7:23
</syntaxhighlight> 
#:if you have a stable release up to and including wb-2207, instead of the b115200 parameter, use <code>ispeed=115200,ospeed=115200</code> .
#In the second window, change the device port speed to 9600 kbps:
#:<syntaxhighlight lang="bash"> 
modbus_client --debug -mrtu -b115200 -pnone -s2 /dev/ttyRS485-5 -a58 -t0x06 -r110 96
</syntaxhighlight> 
#In the first window, terminate the socat connection with <kbd>Ctrl</kbd> + <kbd>C</kbd> .
#In [[socat#Configuring a gateway for firmware updates | gateway settings]] set the port speed to 9600 kbps.
#In the first window, restart socat forwarding with the new connection parameters:
#:<syntaxhighlight lang="bash"> 
socat -d -d -d -x PTY,raw,b9600,parenb=0,cstopb=2,cs8,link=/dev/ttyRS485-5 tcp:192.168.0.7:23
</syntaxhighlight> 
#:if you have a stable release up to and including wb-2207, instead of the b9600 parameter, use <code>ispeed=9600,ospeed=9600</code> .
#In the second window, run the device firmware update, for example, with the wb-mcu-fw-flasher utility ([[WB_Modbus_Devices_Firmware_Update#Manual_update|full instructions]]):
#:<syntaxhighlight lang="bash"> 
wb-mcu-fw-flasher -j -d /dev/ttyRS485-5 -a25 -f ./firmware.wbfw
</syntaxhighlight> 
#After finishing the firmware, return the old speed of 115200 kbps to the device:
#:<syntaxhighlight lang="bash"> 
modbus_client --debug -mrtu -b9600 -pnone -s2 /dev/ttyRS485-5 -a58 -t0x06 -r110 1152
</syntaxhighlight> 
#In the first window, break the socat connection with <kbd>Ctrl</kbd> + <kbd>C</kbd> .
#In the gateway settings, change the port speed from 9600 kbps to 115200 kbps.
#Connect the gateway to the controller via Ethernet.
#Run wb-mqtt-serial
#:<syntaxhighlight lang="bash"> 
systemctl start wb-mqtt-serial
</syntaxhighlight>

If you need to flash several devices, you can first modify their speed, reconfigure the gateway, and then flash them one by one, restore their original speed, and reconfigure the gateway again.

===Configuring the gateway for updating the firmware===

The easiest way to change the gateway settings is to connect to its built-in web interface. To do this, you need to:

#connect the gateway to the computer using a UTP cable directly or through a router,
#assign a static IP address to the computer in the gateway network, for example, 192.168.0.201,
#open a browser and enter the gateway's IP address, by default 192.168.0.7.

==  Useful links ==
* [[Restore factory settings Wiren Board Modbus device | Restoring access — resetting communication settings]]
* [[Wiren Board Device Modbus Address | Modbus address of the Wiren Board device]]
* [[wb-mcu-fw-updater | Firmware update and recovery utility wb-mcu-fw-updater]]
* [[wb-mcu-fw-flasher | Service utility wb-mcu-fw-flasher]]
* [[Firmware Repository For Wiren Board Modbus Devices | Firmware repository for Wiren Board Modbus devices]]