Encedo HEM API Developer Manual
  • Welcome!
  • Preliminary
    • Quick Start
    • General information
  • Security
    • Report an issue
    • Advisory
      • Hall of fame
  • Reference
    • API Reference
      • System
        • Version & Status
        • Checkin
        • Configuration
        • Upgrade
          • Firmware
            • Low level USB mode
          • Management app
        • Self-test
        • Reboot
        • Shutdown
      • Authorization
        • Initialization
        • User authentication
        • External authenticator
          • Registration
          • Authentication
      • Key Management
        • Create a key
        • Derive a key
        • Import a key
        • Update a key
        • Delete a key
        • Get a public key
        • List the keys
        • Search a key
      • Cryptography operations
        • HMAC
        • ExDSA
        • ECDH
        • Encryption
          • Encryption/Decryption
          • Wrap/Unwrap
      • Audit log
      • Storage
Powered by GitBook
On this page
  • Upload the file
  • Upload a new firmware
  • Validate uploaded file
  • Check firmware
  • Install new firmware
  • Install firmware
  1. Reference
  2. API Reference
  3. System
  4. Upgrade

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

Allowed

Allowed

Allowed

Required access scope

system:upgrade

system:config

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 and genuine.

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

Log entries

Event
Result
Source

LOG_TYPE_FAILED_SCOPE_CHECK

LOG_RESULT_FAILED

403

Validate uploaded file

Check firmware

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

Check if the new uploaded firmware file is valid.

Headers

Name
Type
Description

Authorization

String

Bearer JWT_TOKEN

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 validate firmware (checked) in bootloader mode (the device will reboot on 200).

Headers

Name
Type
Description

Authorization

String

Bearer JWT_TOKEN

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

PreviousUpgradeNextLow level USB mode

Last updated 3 years ago