3.2.20. Firmware Update Meta Data Command Class, version 6¶
The Firmware Update Meta Data Command Class may be used to transfer a firmware image to or from a Z-Wave node.
3.2.20.1. Compatibility considerations¶
This version introduces new status codes for firmware update request responses in the Firmware Meta Data Report Command and Firmware Update Meta Data Request Report Command. It also allows a supporting node to advertise whether the application functionalities will be available during a Firmware Update or not.
Firmware Update Meta Data Command Class, version 6 is backwards compatible with Firmware Update Meta Data Command Class, version 5.
\requirement{CC:007A.06.00.21.001}{0}
All commands and fields not mentioned in this version MUST remain unchanged from version 5.
3.2.20.2. Firmware Meta Data Report Command¶
This command is used to advertise the status of the current firmware in the device.
7 |
6 |
5 |
4 |
3 |
2 |
1 |
0 |
|---|---|---|---|---|---|---|---|
Command Class = COMMAND_CLASS_FIRMWARE_UPDATE_MD (0x7A) |
|||||||
Command = FIRMWARE_MD_REPORT (0x02) |
|||||||
Manufacturer ID 1 |
|||||||
Manufacturer ID 2 |
|||||||
Firmware 0 ID 1 |
|||||||
Firmware 0 ID 2 |
|||||||
Firmware 0 Checksum 1 |
|||||||
Firmware 0 Checksum 2 |
|||||||
Firmware Upgradable |
|||||||
Number of Firmware Targets |
|||||||
Max Fragment Size 1 |
|||||||
Max Fragment Size 2 |
|||||||
Firmware 1 ID 1 |
|||||||
Firmware 1 ID 2 |
|||||||
… |
|||||||
Firmware N ID 1 |
|||||||
Firmware N ID 2 |
|||||||
Hardware Version |
|||||||
Reserved |
CC |
||||||
All fields not described below remain unchanged from version 5.
CC (1 bits)
This field is used to advertise if the supporting node’s Command Classes functionality will continue to function normally during Firmware Update transfer.
\requirement{CC:007A.06.03.11.001}{4}
If all other Command Classes functionalities will function normally during firmware update image transfer, this field MUST be set to 1.
\requirement{CC:007A.06.03.11.002}{4}
If any Command Class functionality will not function normally during firmware update image transfer, this field MUST be set to 0.
For example, if a node is unable to issue Notification Reports during firmware update, this field MUST be set to 0.
3.2.20.3. Firmware Update Meta Data Request Report Command¶
This command is used to advertise if the firmware update will be initiated.
7 |
6 |
5 |
4 |
3 |
2 |
1 |
0 |
|---|---|---|---|---|---|---|---|
Command Class = COMMAND_CLASS_FIRMWARE_UPDATE_MD (0x7A) |
|||||||
Command = FIRMWARE_UPDATE_MD_REQUEST_REPORT (0x04) |
|||||||
Status |
|||||||
Status (8 bits)
\requirement{CC:007A.06.04.11.001}{0}
This field MUST comply with Table 3.81.
Status |
Description |
Version |
|---|---|---|
0x00 |
ERROR. Invalid combination of Manufacturer ID and Firmware ID. The device will not initiate the firmware update. |
1 |
0x01 |
ERROR. Device expected an authentication event to enable firmware update. The device will not initiate the firmware update. |
1 |
0x02 |
ERROR. The requested Fragment Size exceeds the Max Fragment Size. The device will not initiate the firmware update. |
3 |
0x03 |
ERROR. This firmware target is not upgradable. The device will not initiate the firmware update. |
3 |
0x04 |
ERROR. Invalid Hardware Version. The device will not initiate the firmware update. |
5 |
0x05 |
ERROR: Another firmware image is current being transferred. The device will not initiate the firmware update. |
6 |
0x06 |
ERROR: Insufficient battery level The device will not initiate the firmware update. |
6 |
0xFF |
OK. The device will initiate the firmware update of the target specified in the Firmware Update Meta Data Request Get Command. |
1 |
All other values are reserved and MUST NOT be used by a sending node. Reserved values MUST be ignored by a receiving node.
