Firmware

These operations allow the device firmware to be upgraded by uploading a new firmware image over API. This includes integrity and signature validation allowing only a legitimate firmware to be install

Embedded Flash Drive is available on Encedo PPA only. On Encedo EPA those endpoints are not available, and response code 404 will be returned.

Allowed users

User

Allowed

Master

ExtAuth

Required access scope

Main

system:upgrade

Alternative

The Authorization header is not required on fresh, not personalized devices.

TLS connection is not required. It is a last resort way to upload fixes. Firmware is signed anyway, no worry about the integrity or genuineness.

Upload the file

Upload a new firmware

POST https://my.ence.do/api/system/upgrade/upload_fw

Upload a new firmware image (firmware.bin) file.

Headers

Name	Type	Description
Authorization	String	Bearer JWT_TOKEN
Content-Type*	String	application/octet-stream
Content-Disposition*	String	attachment; filename="firmware.bin"
Expect*	String	100-continue

Response status code

200: Operation successful

406: Operation failed

401: Missing or invalid JWT_TOKEN

403: Incorrect access scope

Log entries

Event	Result	Source
LOG_TYPE_FAILED_SCOPE_CHECK	LOG_RESULT_FAILED	403

Validate the uploaded file

Check firmware

GET https://my.ence.do/api/system/upgrade/check_fw

Verify that the newly uploaded firmware file is valid.

Headers

Name	Type	Description
Authorization	String	Bearer JWT_TOKEN

Response status code

200: Operation succsessful

202: Validation ongoing

401: Missing or invalid JWT_TOKEN

403: Incorrect access scope

201: Process of validation started

406: Operation failed

Log entries

Event	Result	Source
LOG_TYPE_FAILED_SCOPE_CHECK	LOG_RESULT_FAILED	403

Install new firmware

Install firmware

GET https://my.ence.do/api/system/upgrade/install_fw

Install uploaded and validated firmware (checked) in bootloader mode (the device will reboot on 200).

Headers

Name	Type	Description
Authorization	String	Bearer JWT_TOKEN

200: Operation successful

401: Missing or invalid JWT_TOKEN

403: Incorrect access scope

409: Incorrect internal state

406: Operation failed

Log entries

Event	Result	Source
LOG_TYPE_FAILED_SCOPE_CHECK	LOG_RESULT_FAILED	403
LOG_TYPE_UPGRADE	LOG_RESULT_ERROR	406
LOG_TYPE_UPGRADE	LOG_RESULT_ERROR	409
LOG_TYPE_UPGRADE	LOG_RESULT_OK	200