Update Firmware

8min

About
Instruct the specified device to update the Agent firmware from a specified URL.
Command Type
Device is Online
Device is Offline
Not Synchronous, Queueable
Immediate execution, Published results
Queued execution, Published results
Parameters
Property
Location
Details
AccessKey
string
Required
Unique
Header
The access key for your user account.
This value is a 36-character GUID provided during user account sign up.
DeviceName
string
Required
Unique
URL
The name of the device.
This value has a max length of 128 ASCII characters.
This value must adhere to this regular expression: ^[a-zA-Z0-9-_]*$
NewDeviceDefinition
string
Body
The device will be updated to this specified device definition.
This value is one of the device definitions retrieved by the Get All Device Definitions﻿ request.
This value has a max length of 128 ASCII characters.
This value must adhere to this regular expression: ^[a-zA-Z0-9-_,. ]*$
Url
string
Required
Body
The URL containing the new firmware file.
If updating the Agent from firmware version 3 to 4, this value must be a version number in the following format: Major version.Minor version
If updating the Agent from firmware version 4 to 4+, this value must be a validly formatted HTTP or HTTPS URL.
Component
string
Required
Body
The firmware component that is being upgraded.
If updating the Agent from firmware version 3 to 4, this value is the following: AGENT
If updating the Agent from firmware version 4 to 4+, this value is the following: Agent
Examples
Example Update Agent Firmware v3 to v4
POST https://api.jetstreamrfid.com/2/devices/{DeviceName}/version
{
	"Url": "04.00",
	"Component": "AGENT"
}
200 OK
{
	"CommandId": "527a2f74-af29-410a-8ecb-7ec9f756079a",
	"Status": "Queued",
	"ExceptionList": [],
	"OutputParameterList": []
}
{
	"Device": "MyDeviceName",
	"CommandId": "527a2f74-af29-410a-8ecb-7ec9f756079a",
	"CommandName": "UpdateFirmwareCommand",
	"URI": "/2/devices/MyDeviceName/Version",
	"Verb": "Post",
	"User": "MyUserName",
	"Parameters": [
		{
			"Key": "Component",
			"Value": "AGENT"
		},
		{
			"Key": "Url",
			"Value": "04.00"
		}
	],
	"Type": "CommandQueuedEvent",
	"EventId": "55d8b7f7-63ad-446f-a230-e8f8829a0dbd",
	"EventTime": "2017-05-19T21:06:49Z"
}
None Published
Example Update Agent Firmware v4 to v4+
POST https://api.jetstreamrfid.com/2/devices/{DeviceName}/version
{
	"Url": "MyURL",
	"Component": "Agent"
}
200 OK
{
	"CommandId": "527a2f74-af29-410a-8ecb-7ec9f756079a",
	"Status": "Queued",
	"ExceptionList": [],
	"OutputParameterList": []
}
{
	"Device": "MyDeviceName",
	"CommandId": "527a2f74-af29-410a-8ecb-7ec9f756079a",
	"CommandName": "UpdateFirmwareCommand",
	"URI": "/2/devices/MyDeviceName/Version",
	"Verb": "Post",
	"User": "MyUserName",
	"Parameters": [
		{
			"Key": "Component",
			"Value": "Agent"
		},
		{
			"Key": "Url",
			"Value": "MyURL"
		}
	],
	"Type": "CommandQueuedEvent",
	"EventId": "55d8b7f7-63ad-446f-a230-e8f8829a0dbd",
	"EventTime": "2017-05-19T21:06:49Z"
}
{
	"CommandId": "527a2f74-af29-410a-8ecb-7ec9f756079a",
	"CommandName": "UpdateFirmwareCommand",
	"OutputParameterList": [],
	"ExceptionList": [],
	"Device": "MyDeviceName",
	"ReceivedTime": "2017-05-19T21:17:05Z",
	"Type": "CommandCompletionEvent",
	"EventId": "3a9387ce-e797-4330-9a49-3f0c582c4721",
	"EventTime": "2017-05-19T21:16:46Z"
}
Version Changes
Replaces UpdateFirmwareCommand

Command Type	Device is Online	Device is Offline
Not Synchronous, Queueable	Immediate execution, Published results	Queued execution, Published results

Property	Location	Details
AccessKey string Required Unique	Header	The access key for your user account. This value is a 36-character GUID provided during user account sign up.
DeviceName string Required Unique	URL	The name of the device. This value has a max length of 128 ASCII characters. This value must adhere to this regular expression: ^[a-zA-Z0-9-_]*$
NewDeviceDefinition string	Body	The device will be updated to this specified device definition. This value is one of the device definitions retrieved by the Get All Device Definitions request. This value has a max length of 128 ASCII characters. This value must adhere to this regular expression: ^[a-zA-Z0-9-_,. ]*$
Url string Required	Body	The URL containing the new firmware file. If updating the Agent from firmware version 3 to 4, this value must be a version number in the following format: Major version.Minor version If updating the Agent from firmware version 4 to 4+, this value must be a validly formatted HTTP or HTTPS URL.
Component string Required	Body	The firmware component that is being upgraded. If updating the Agent from firmware version 3 to 4, this value is the following: AGENT If updating the Agent from firmware version 4 to 4+, this value is the following: Agent

Updated 25 Mar 2024

Restart a Device

Get a Device's Configuration Parameters