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.
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
https://my.ence.do/api/system/upgrade/upload_fwUpload 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
- 411: Protocol error - Content-Length required
- 412: Protocol error - CORS validation failed
- 413: Protocol error - request body too big
- 500: Internal server error
No response body.
No response body.
No response body.
No response body.
No response body.
No response body.
No response body.
No response body.
Log entries
| Event | Result | Source |
|---|---|---|
| LOG_TYPE_FAILED_SCOPE_CHECK | LOG_RESULT_FAILED | 403 |
Validate the uploaded file
Check firmware
https://my.ence.do/api/system/upgrade/check_fwVerify that the newly uploaded firmware file is valid.
Headers
| Name | Type | Description |
|---|---|---|
| Authorization | String | Bearer JWT_TOKEN |
Response status code
- 200: Operation successful
- 202: Validation ongoing
- 401: Missing or invalid JWT_TOKEN
- 403: Incorrect access scope
- 201: Process of validation started
- 404: Not found
- 406: Operation failed
- 412: Protocol error - CORS validation failed
No response body.
No response body.
No response body.
No response body.
No response body.
No response body.
No response body.
No response body.
Log entries
| Event | Result | Source |
|---|---|---|
| LOG_TYPE_FAILED_SCOPE_CHECK | LOG_RESULT_FAILED | 403 |
Install new firmware
Install firmware
https://my.ence.do/api/system/upgrade/install_fwInstall uploaded and validated firmware (checked) in bootloader mode (the device will reboot on 200).
Headers
| Name | Type | Description |
|---|---|---|
| Authorization | String | Bearer JWT_TOKEN |
Response status code
- 200: Operation successful
- 401: Missing or invalid JWT_TOKEN
- 403: Incorrect access scope
- 406: Operation failed
- 409: Incorrect internal state
- 412: Protocol error - CORS validation failed
No response body.
No response body.
No response body.
No response body.
No response body.
No response body.
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 |