FirmwareV1
Information regarding the device firmware and actions to update/modify the value.
Trait Type: Standard
Action Mutations
Note: See Overview: Device Action Lifecycle for more information on action flows
FirmwareV1ScheduleLatestFirmwareUpdate action
Schedule when to download and install the latest production ready firmware version available for the device.
Mutation Inputs
Input Name | Description | Data Type | Nullable |
deviceId | uuid of the device to which mutation should apply | ID! | false |
traitActionArgs | See table below for specific fields | FirmwareV1ScheduleLatestFirmwareUpdateArgs! | false |
FirmwareV1ScheduleLatestFirmwareUpdateArgs Fields
Field Name | Description | Data Type | Nullable |
scheduledAt | UTC dateTime when the device should initiate installation of the latest firmware. | string! Note: String must be ISO8601 UTC format date time | false |
downloadAt | The desired value for the advertising rate of the BLE credential reader. If provided, value must be before the scheduledAt value. If omitted, process will download and immediately install at the scheduled time. | string Note: String must be ISO8601 UTC format date time | true |
GQL Examples
Request Example
mutation FirmwareV1ScheduleLatestFirmwareUpdate {
FirmwareV1ScheduleLatestFirmwareUpdate(
deviceId: "9a8f6104-6c50-476e-90ee-16b9a2dafc8d"
traitActionArgs: { scheduledAt: “2024-12-20T14:49:55.000Z”, downloadAt: "2024-12-20T14:00.000Z" }
){
deviceId
actionId
}
}Response Example
{
"data": {
"FirmwareV1ScheduleLatestFirmwareUpdate": {
"actionId": "7eb3629a-a1c3-49f0-89b6-2831d500ac68",
"deviceId": "9a8f6104-6c50-476e-90ee-16b9a2dafc8d"
}
}
}
FirmwareV1InstallLatestFirmwareUpdate action
Trigger immediate download and install of the latest production ready firmware version available for the device.
Mutation Inputs
Input Name | Description | Data Type | Nullable |
deviceId | uuid of the device to which mutation should apply | ID! | false |
GQL Examples
Request Example
mutation FirmwareV1InstallLatestFirmwareUpdate {
FirmwareV1InstallLatestFirmwareUpdate(
deviceId: "9a8f6104-6c50-476e-90ee-16b9a2dafc8d"
){
deviceId
actionId
}
}Response Example
{
"data": {
"FirmwareV1InstallLatestFirmwareUpdate": {
"actionId": "7eb3629a-a1c3-49f0-89b6-2831d500ac68",
"deviceId": "9a8f6104-6c50-476e-90ee-16b9a2dafc8d"
}
}
}
Reported States
Note: See Overview: Device Reported State for more information on reported state flows.
State Definitions
firmwareVersion State
Indicates the firmware installed on the device.
Data Type: string
firmwareDownloadScheduledAt State
Indicates the time the latest firmware update is scheduled to be installed at.
Data Type: string (Note: String contents will contain a ISO8601 UTC format date time value)
firmwareInstallScheduledAt State
Indicates the time the latest firmware update is scheduled to be installed at.
Data Type: string (Note: String contents will contain a ISO8601 UTC format date time value)
firmwareInstalledAt State
Indicates the UTC DateTime the latest firmware was installed at.
Data Type: string (Note: String contents will contain a ISO8601 UTC format date time value)
Device State Query GQL Examples
Request Example
query Device {
device(deviceId: "9a8f6104-6c50-476e-90ee-16b9a2dafc8d") {
id
traits {
name
... on FirmwareV1DeviceTrait {
name
state {
firmwareVersion {
reported {
value
}
}
firmwareDownloadScheduledAt {
reported {
value
}
}
firmwareInstallScheduledAt {
reported {
value
}
}
firmwareInstalledAt {
reported {
value
}
}
}
}
}
}
}
Response Example
{
"data": {
"device": {
"id": "9a8f6104-6c50-476e-90ee-16b9a2dafc8d",
"traits": [
{
"name": "FirmwareV1",
"state": {
"firmwareVersion": {
"reported": {
"value": "90.3.5806"
}
},
"firmwareDownloadScheduledAt": {
"reported": {
"value": "2024-12-20T14:00.000Z"
}
},
"firmwareInstallScheduledAt": {
"reported": {
"value": "2024-12-20T14:49:55.000Z"
}
},
"firmwareInstalledAt": {
"reported": {
"value": "2024-12-20T14:49:55.859Z"
}
}
}
}
]
}
}
}
On this page
- FirmwareV1