REST API Devices Routes Special Bootloader info

April 13, 2023 at 2:39 AM

Bootloader info

Role

Read the bootloader info from a device.

Prototype

URL : /device/{$id}/bootloader-info

Method : GET

URL Params : {$id} : the DeviceId of the device. Use GET /devices to enumerate the connected devices.

Request data : None

Success Response

Code : 200 OK

Content : a BOOTLOADER-INFO object, as specified below.

BOOTLOADER-INFO object definition

Field name Type Status Description
Cpu string always Name of the MCU
RomBegin integer always First writable address in the MCU’s flash memory
RomEnd integer always Last writable address in the MCU’s flash memory
RomSize integer always Available size in the MCU’s flash memory (in bytes)
ResetReason string always cold or warm
FirmwareIsNew boolean always false: this is not the first boot
true: this is the fist boot after (re)writing the firmware into the MCU’s flash memory
HasBootloader boolean always false: there is no bootloader in the MCU’s flash memory
true: the MCU features a bootloader
BootloaderRunning boolean always false: the MCU is running its “normal” firmware
true: the MCU is running in bootloader mode
BootloaderForce boolean always false: the bootloader is not enforced
true: the device will stay in bootloader mode after next reset
BootloaderVersion integer option Version of the bootloader, if present
BootloaderTimeout integer option Timeout of the bootloader, if present
HasAes boolean always The device has an embedded AES engine
HasEthernet boolean always The device has an Ethernet (network) interface
HasUsb boolean always The device has an USB interface
HasBattery boolean always The device has a battery
HasVegas boolean always The device has a SpringCard Vegas daughter board (remote battery and UI)
HasExternalFlash boolean always The device has an external flash memory
ExternalFlashId string option Identification string of the external flash memory, if present (hexadecimal string)

Example

{
	"Cpu": "RX65N",
	"RomBegin": 4293918720,
	"RomEnd": 4294950912,
	"RomSize": 1032192,
	"ResetReason": "cold",
	"FirmwareIsNew": false,
	"HasBootloader": true,
	"BootloaderRunning": false,
	"BootloaderForce": false,
	"BootloaderVersion": 0,
	"BootloaderTimeout": 10,
	"HasAes": true,
	"HasEthernet": true,
	"HasUsb": true,
	"HasBattery": false,
	"HasVegas": false,
	"HasExternalFlash": true,
	"ExternalFlashId": "20BA18104000684995001521002A000801F58F61"
}

Error Response

See Error Responses.