Agent

A device’s firmware component that communicates with Jetstream.

Alias 

An alternate name a device may assume to communicate on behalf of the alias. A device may report an alias’ ObjectEvent. For example, if you store inventory in three separate offices, you could create three Aliases in Jetstream, each representing an office, associate these Aliases to a TS084 Handheld RFID Device, and then use the one device to report the present inventory from any one of these locations.

Application 

An application created within Jetstream, representing a logical boundary containing devices and users. Security is setup and configured at the application level for users. The users within an application can only communicate and interact with the devices within that application.

This should not be confused with your in-house developed application that consumes Jetstream messages.

Command 

A request or query assigned to a Terso RFID device. A command is executed on a device. A command will be one of three types, described below, and will behave differently depending on whether the device is online or offline.

Command TypeDevice is OnlineDevice is Offline
Synchronous, QueueableImmediate executionQueued execution
Synchronous, Not QueueableImmediate executionFailure to execute
Not Synchronous, QueueableImmediate executionQueued execution

Command Id

A 36-character GUID tying the following pieces of a command request together: Command Response, CommandQueuedEvent, and CommandCompletionEvent. Each of these components will have the same value in their "CommandId" property. Depending on which command type is being handled in a command request, these three parts will be created at different times and may end up buried with many other responses and events.

Using their common "CommandId" property enables you to gather all three pieces to determine if execution of a command on a device was successful or not.

Command Response 

A reply received within the Response Body from a command request being executed. Depending on the command type that was executed, described below, results are returned in the Response Body or not.

Command TypeResults Returned in the Response Body?
SynchronousYes – see the Output Parameter List or Exception List.
Not SynchronousNo – see the Output Parameter List or Exception List of the related CommandCompletionEvent event.

Configuration 

A setup, change, or request performed on a Jetstream application. Configuration actions are performed for the maintenance and management of Jetstream resources (e.g., devices, device definitions, policies, events).

Credential 

A login record containing the authentication information needed to access a device and/or an application.

Jetstream should not be considered the system of record for credentials and customers should be managing and maintaining credentials in their own systems while working with Jetstream.

Device 

A Terso RFID device. Our intelligent devices come in the form factors of enclosures, mobile cases, kiosks, and hand-helds.

WebSockets capable devices are able to process eligible commands right away, providing near real-time interaction. At the moment, device types that are not WebSockets capable include Handhelds and Mobile Cases. All other devices are websockets capable.

Device Definition 

A unique collection of settings defining the capabilities of a specific type of Terso RFID device. The settings are a combination of identifiers (e.g., name, firmware version, configuration parameters) for the device and capabilities (e.g., restart, update firmware, scan for RFID tags) the device supports. The proper device definition for your device can always be provided by Terso Support.

EPC 

An electronic product code (EPC) is an identifier encoded onto an RFID tag, which can then be read by RFID devices.

Event 

A message capturing information pertaining to the single occurrence of a process. An event pertains to a device process and/or a Jetstream process. The table below summarizes the available event types and the process they relate to.

Event TypeDevice ProcessJetstream Process
AggregateEventX
AliasAddedEvent
X
AliasModifiedEvent
X
AliasRemovedEvent
X
ObjectEventX
CommandQueuedEvent
X
CommandCompletionEventX
DeviceAddedEvent
X
DeviceModifiedEvent
X
DeviceRemovedEvent
X
DeviceCredentialsAddedEvent
X
DeviceCredentialsModifiedEvent
X
DeviceCredentialsRemovedEvent
X
HeartbeatEventX
LogEntryEventX
SensorReadingEventX
StatusEventX

Events provide a window into all that is occurring in your Jetstream application. Below are some, but not all of the questions events can answer:

  • What RFID tags were added/removed from a device during the last door open/close?
  • What RFID tags are currently in a device?
  • What commands have been queued for a device to process?
  • What commands have been completed on/processed by a device?
  • What devices have been added to a Jetstream application?
  • What devices have been removed from a Jetstream application?
  • What devices have/don’t have internet connectivity?
  • What devices have a low battery?
  • What are the temperature readings of a device?

Exception List 

A listing of exceptions while executing a command on a device or any issues in queuing/dequeuing the command.

Immediate Results 

Results associated with the execution of a command on a device. These results are returned to the calling system immediately. In these circumstances, the calling system will receive a Command Response as well as a CommandCompletionEvent.

Offline 

A connection status of a device indicating that it is not connected to Jetstream. Either the device is not WebSockets enabled/capable or has lost power/internet connectivity.

Online 

A connection status of a device indicating that it is connected to Jetstream. The device is WebSockets enabled and/or has power and internet connectivity.

Output Parameter List 

A listing of key-value/parameter-value settings resulting from the execution of a command on a device.

Policy

A unique collection of settings to manage a device’s configuration values (the configuration parameters are defined by the device’s definition). A policy may be added to a device to apply its configuration settings. Conversely, a policy may be removed from a device to revoke its configuration settings.

Published Results 

Results associated with the execution of a command on a device. These results are published to Get Events for retrieval. In these circumstances, the calling system will receive a Command Response but the results will only be made available in CommandCompletionEvent which, along with CommandQueuedEvent, can be retrieved via Get Events.

Region

A geographic region where a device is being placed. This is used to create the most reliable and lowest latency connection to the device. Possible locations include the following:

  • US (United States)
  • EU (Europe)
  • AP (Asia Pacific)
  • USGOV (United States - to meet U.S. government compliance requirements)

Unique 

An indicator that the value of a property is distinct and there cannot be another instance of the property with the same value.

User

A person using the Jetstream API. During user account sign up, a user is provided a unique access key and is associated to a Jetstream application. Multiple users may be associated to one Jetstream application. A user must use their access key to make Jetstream API requests and these requests pertain to the user’s Jetstream application.