Rate this page
- ★★
- ★★
- ★★
- ★★
- ★★
Can we improve this page? Send us feedbackRate this page
- ★★
- ★★
- ★★
- ★★
- ★★
The Notecard offers a set of host firmware update APIs that can be utilized by developers, in concert with Notehub, to update the firmware of a Host MCU.
Retrieves downloaded firmware data from the Notecard. Note: this request
is functional only when the Notecard has been set to dfu mode with a
hub.set, mode:dfu request.
lengthinteger
The number of bytes of firmware data to read and return to the host. Set to 0
to verify that the Notecard is in DFU mode without attempting to retrieve data.
offsetinteger (optional)
The offset to use before performing a read of firmware data.
payloadstring
A base64 string containing firmware data of the provided length.
{ "payload": "AAAAAAAAAAAAAAAAcy8ACIEvAAgAAAAAjy8ACJ0vAAg=" }
Gets and sets the background download status of MCU host or Notecard firmware updates.
namestring (optional)
Determines which type of firmware update status to view. The value can be "user" (default), which gets the status of MCU host firmware updates, or "card", which gets the status of Notecard firmware updates.
stopboolean (optional)
true to clear DFU state and delete the local firmware image from the
Notecard.
statusstring (optional)
When setting stop to true, an optional string synchronized to Notehub,
which can be used for informational or diagnostic purposes.
versionstring (optional)
The host firmware version passed to Notehub.
vvaluestring (optional)
A voltage-variable string that controls, by Notecard voltage, whether or not DFU is enabled (1 = enabled, 0 = disabled).
onboolean (optional)
true to allow firmware downloads from Notehub.
offboolean (optional)
true to disable firmware downloads from Notehub.
err (Added in v1.5.6)string (optional)
If err text is provided along with "stop":true, this sets the host DFU
to an error state with the specified string.
modestring
The current DFU mode. Will be one of:
"idle" when there is no firmware download in progress, and no data previously
downloaded.
"error" when the download or verification has failed. In this mode, the
status field will contain the reason.
"downloading" when the download is in progress. In this mode, the status
field will contain info about progress.
"ready" when the firmware data is fully downloaded.
statusstring
The current status of the firmware download.
onboolean
true when firmware downloads are enabled.
offboolean
true when firmware downloads are disabled.
pendingboolean
true when Notecard DFU is currently in-progress.
bodyJSON object
Object that includes essential details about the firmware binary, including the length of the length, its md5 hash, notes from the Notehub admin, created and updated dates, and more.
{ "mode": "ready", "status": "successfully downloaded", "on": true, "body": { "crc32": 2525287425, "created": 1599163431, "info": {}, "length": 42892, "md5": "5a3f73a7f1b4bc8917b12b36c2532969", "modified": 1599163431, "name": "stm32-new-firmware$20200903200351.bin", "notes": "Latest prod firmware", "source": "stm32-new-firmware.bin", "type": "firmware" } }