Command 0xD901 - Commit Firmware from File

The host uses this command to commit a file previously uploaded using Command 0xD801 - Load (Firmware File) into the device’s permanent memory after the device has authenticated the file.

Sequence of events:

1

Compose and send request

The host composes a command request in the format below, and sends it to the device.

2

Device acknowledges request

The device sends a response in the format below.

3

Device writes image

The device writes the image file to permanent storage.

4

Device notifies host and resets

If the commit operation was successful, the device sends Notification 0x0905 - Firmware Update Successful to the host. If the commit operation was not successful, the device sends Notification 0x0906 - Firmware Update Failed to the host. In both cases, the device automatically resets.

Table - Request Data for Command 0xD901 - Commit Firmware from File

Tag	Len	Value / Description	Typ	Req	Default
Beginning of any wrappers, at minimum including Request Message	—	—	—	—	—
D901	—	Command 0xD901 - Commit Firmware from File	—	—	—
81	01	Progress Indicator. Reserved for future use. Populate with 0x03.	B	R
82	01	Operation Options. Reserved for future use. Populate with 0x00.	B	R
85	02	Image Type 0x0000 = Boot Loader 1 image 0x0001 = Main App image 0x0002 = WiFi Module image 0x0003 = BLE Module image	B	R
86	20	Hash Checksum This is a SHA-256 hash of the entire Firmware File Type (MAGTEK INTERNAL ONLY) object being uploaded.	B	R
End of any wrappers, at minimum including Request Message

Table - Response Data for Command 0xD901 - Commit Firmware from File

Tag	Len	Value / Description	Typ	Req	Default
Beginning of any wrappers, at minimum including Response Message	—	—	—	—	—
D901	—	Command 0xD901 - Commit Firmware from File	—	—	—
No parameters
End of any wrappers, at minimum including Response Message

If the request started successfully, the Request Status in the message wrapper is: OK, Started / Running, All good / requested operation was successful.

Table - Request Example

Example (Hex)

AA 00 81 04 01 02 D9 01 84 2E D9 01 81 01 03 82 01 00 85 02 00 01 86 20 DF C7 1E 09 
A3 CE 8E 86 B0 F5 B6 75 BE B7 7A 0E 82 33 BF F1 8A CD 8F 38 34 B0 DB 20 D9 40 4B 28

Table - Response Example

Example (Hex)

AA 00 81 04 82 02 D9 01 82 04 00 00 00 00

Table - Notification Example

Example (hex)

AA 00 81 04 83 00 09 05 82 04 08 01 0A 03