Firmware Update
Where: sidebar → Device Management → Firmware Update
Update the software on devices remotely. First upload a firmware package from the manufacturer in "Firmware Package Management", then choose devices in "Device Update List" and start the update. This page has two tabs:
| Tab | Purpose |
|---|---|
| "Device Update List" | See each device's current version and latest update, and start updates |
| "Firmware Package Management" | Upload, view and archive firmware packages |
Firmware package management
List columns
| Column | Description |
|---|---|
| "Version No." | The version declared inside the firmware package |
| "Version Name" | The name declared inside the firmware package; if none is declared, the uploaded file name is used |
| "Uploaded At" | When it was uploaded |
| "Uploaded By" | The account that uploaded it |
| "Status" | "Active" or "Archived" |
| "Actions" | "View Details" and an archive icon |
When there are no firmware packages yet, "No firmware packages" appears.
Uploading a firmware package
- Click "Upload Firmware Package" at the top right.
- Drag the firmware package (.zip) onto the upload area, or click the area to choose a file. The upload starts as soon as you choose it.
- On success, "Firmware package uploaded" appears and the list gains an "Active" firmware package.
| Message | Cause |
|---|---|
| "The uploaded file is not a valid firmware bundle" | The file is not a .zip, or not in the manufacturer's firmware package format |
| "A manifest with this version already exists" | There is already an "Active" firmware package with the same version number |
Use the files the manufacturer provides as they are; do not unzip or modify them.
Viewing details
Click "View Details" to open "Firmware Version Details", which lists every "Components" entry in the firmware package and its "Version No.".
If the firmware package contains a chlcd-ota component, "This firmware includes the chlcd-ota component (high risk)." appears at the top. Before starting this kind of update, check with the manufacturer first.
Archiving
A version you no longer use can be archived: click the archive icon on its row, and in the "Confirm archiving firmware?" window click "Confirm Archive".
- After archiving, that version can no longer be chosen when starting an update.
- Updates already in progress are not affected.
- Archiving cannot be undone. After archiving, you can upload a firmware package with the same version number again.
Device update list
List columns
| Column | Description |
|---|---|
| "Device Name" | The device's name |
| "Hostname" | The device's hostname |
| "Current Version" | The software version the device reported most recently |
| "Target Version" | The version the latest update is updating to |
| "State" | The state of the latest update; see Update states. It shows "Idle" when the device has never been updated |
| "Current Stage" | Which stage the latest update has reached; see Update stages |
| "Launched At" | When the latest update was created |
| "Actions" | "View Detail", which opens this update's detail page |
Above the list you can filter by "Device Name", "Current Version", "Target Version", "State", "Current Stage" and "Launched At". The list refreshes automatically.
Starting an update
- Tick the devices to update (several are allowed). "Start Update" is grey while none are ticked.
- Click "Start Update". The top of the window shows "N device(s) selected" and those devices' current "Firmware Version".
- Under "Firmware Version", choose the version to update to (required). Only "Active" firmware packages are listed.
- To start at a set time, fill in "Scheduled Start Time"; leave it empty to start right away.
- Click "Confirm", confirm in the "Start Update?" window, and it is done; "Batch update created" appears.
| Situation | Result |
|---|---|
| The device already has an update that has not finished | This device is skipped; no new update is created and no separate message is shown |
| "Scheduled Start Time" is filled in | The update is created when the time comes. Until then, these devices' states in the list do not change |
| The device is offline | It stays at "Waiting for Device" and starts downloading only after the device comes online |
| The device is under local control | The device refuses the update and the state shows "Rejected (Not Run)"; see the note below |
A device under local control refuses updates
A device under local control does not run the update, and its state shows "Rejected (Not Run)". Hovering over the state shows "Device is under local control. Take over the device, then create a new update task.". First "Takeover" the device in "Device List", then start the update again. A rejected device did not download or change anything and is not faulty.
While an update is running, "Connectivity" in "Device List" shows "Updating Software".
Update detail
Open it by clicking "View Detail" in "Device Update List"; the page refreshes automatically.
| Field | Description |
|---|---|
| "Device" | The device's name |
| "State" | See Update states |
| "Target Version" | The version being updated to |
| "Current Stage" | See Update stages |
| "Created At" | When the update was created |
| "Notified At" | When the device was told to start the update |
| "Started At" | When the device started downloading |
| "Finished At" | When the update ended |
| "Error Detail" | An error the device reported; shown only when there is one |
"Stage Events" below lists each step the device reported, by time: the stage, the status ("Started", "Succeeded", "Failed", "Skipped"), progress percentage, time and message.
Cancelling an update
When the state is "Waiting for Device" or "Downloading", the page has a "Cancel Task" button at the top. After you click it, confirm "Cancel this firmware update?", and "Firmware update cancelled" appears.
Once it reaches "Applying", it can no longer be cancelled.
Update states
| State | Meaning |
|---|---|
| "Waiting for Device" | Created; waiting for the device to pick up the update. Every update starts in this state |
| "Downloading" | The device is downloading the firmware |
| "Applying" | The device is installing the new version and checking that it works |
| "Succeeded" | The update is complete |
| "Failed (Rolled Back)" | The check after installation failed, and the device automatically returned to the version before the update |
| "Failed (Rollback Failed)" | The check after installation failed, and returning to the old version also failed. Contact the manufacturer |
| "Failed" | The update failed and the device did not report a rollback result (for example the download failed) |
| "Rejected (Not Run)" | The device refused to run it and did not download or change anything; see the note above |
| "Cancelled" | Someone cancelled this update |
| "Not Reached" | This option exists in the state filter, but it does not currently appear for firmware updates |
When an update ends as "Failed (Rolled Back)", "Failed (Rollback Failed)" or "Failed", the system creates an "OTA Failure" notification. "Rejected (Not Run)" is an expected result and does not create a notification.
Update stages
| Stage | Meaning |
|---|---|
| "Downloading" | Downloading the firmware |
| "Applying" | Installing the new version |
| "Health Check" | Checking after installation that the device is working properly |
| "Rolling Back" | The check failed; returning to the version before the update |
| "Overall" | The final result of the whole update |
A system update is a different thing
This page updates the software on devices. To update the E-Paper Content Management System itself, use "System Update" under System Settings.
Related pages: Device List, CMS connection and control