Jetstream API
Jetstream Navigator

Device Details

12min

This page opens to the specific device selected from the All Devices page. You can also navigate to this page directly from the menu and search for a device by name or serial number.

Selecting a Device

You can select a device by either

  • Entering a Device Name
  • Entering a Device Serial Number

Then selecting "Go".

Both fields will autosuggest matching devices as you type in the field. The Name field will suggest both active and inactive devices (Inactive will be indicated by an "(Inactive)" label), while the Serial Number field will only suggest active devices.

Once a device is selected, the device details will be loaded for that device, this will include the Device Information sidebar, the Events tab, and additional tabs, depending on the device definition.

Device Information

Once a device is selected, the Device Information sidebar will load with several pieces of data about the device.

First, at the very top next to the Device Information header, are the "configuration" options, in the quick action (...) menu.

  1. Edit - Change the editable fields for the currently selected device, including device name, serial number, and device definition.
  2. Delete - Delete the device from Jetstream, rendering it "Inactive".

Within the sidebar itself, the following info may be available. If a piece of info is not available, it will display "unknown".

  • Device Definition - The name of the device definition associated with the device. The device definition defines what commands and parameters are available to a device.
  • Policy - The name of the policy associated with the device. The policy defines the baseline configuration parameter values of the device.
  • Status - Active (in Jetstream) or Inactive (Deleted from Jetstream). This does
  • Websocket - Connected (commands will be received by the device immediately) or Disconnected (commands will be executed when the device does it's poll for commands).
  • Region - The geographic region that the RFID device is being placed. This is used to create the most reliable and lowest latency connection to the device. Options are: US, EU, AP, & USGOV.
  • Added On - The date/time the device was first created in Jetstream.
  • Application Name - The application to which the device was added.
  • Last Comm - The most recent time the device communicated an event of any type.
  • Last AggregateEvent - The most recent AggregateEvent the device communicated.
  • Last ObjectEvent - The most recent ObjectEvent the device communicated.
  • Agent - The version of Terso's firmware running on the device.
  • Reader - The version of firmware the RFID reader on the device is running.
  • Sensor Data - The values from the most recent SensorReadingEvent from the device.

Events

The Events tab is the default device details tab, and allow the searching, sorting, filtering, and export of all events from the device. The filters include:

  • Event Type - select all types of events you wish to view in the table from the selected date range. By default, all types will be displayed. See the Event Types documentation for more details on each event.
  • Received Time - select any start and end date range. Longer ranges may take longer to load. The default is today and yesterday.
  • Search - filter the rows in the table down to only rows which contain the search term. All columns are searchable.

The table is sorted by Generated Time descending (most recent events first), and includes the following columns:

  • Event Type - The type of event. All Event Types are listed int he Event Types filter above the table.
    • Clicking the link will open the exact JSON of the Jetstream event in a modal window, including additional info beyond the 4 columns of the table. Note that the dates and times in this JSON message are always in UTC.
    • Note that SensorReadingEvents will occupy multiple rows for improved table feature function, although the various sensors are all reported in a single SensorReadingEvent.
  • Details - A brief summary of the key contents of the events. Not all event types have details generated.
  • Generated Time - The time that the event actually occurred, as timestamped by the device firmware.
  • Received Time - The time that the event was received, as timestamped by Jetstream.

Tags

The Tags tab is the second device details tab, and presents the "current" count and list of RFID Tag EPCs in the device's read range, as determined by the latest objectevent, plus or minus any tags reported as added or removed in Aggregateevents following the latest ObjectEvent.

The "Get Tags" button will trigger a Get All RFID Tags command and update the tag list based on the CommandCompletionEvent, as appropriate.

Document image


The "Get Tags" button will trigger a Get All RFID Tags command and update the tag list based on the CommandCompletionEvent, as appropriate.

Last Update: the date/time of latest object or Aggregateevent from the device which updated the tag list.

Credentials

The Credentials tab will not appear for some device types which do not offer secured access controls. For those which do require a credential to be presented for access, this tab displays the count and list of current credentials (10-40 digit hexadecimal values).

The Last Sync date/time is the last time a sync was successfully completed. The current list is re-synced with the device every time "Save" is selected on this tab. (Sends a "sync device credentials" command)

Note that credentials can be added and removed in a single command, but for clarity we will present the add and remove credentials steps separately.

Adding Credentials

  1. In the "Add" field, enter any number of 10-40 digit hexadecimal RFID pass values you would like to allow to access this device. Enter each value on a new line, with no additional characters.
  2. No passes are actually added until you click "Save".

Removing Credentials

  1. From the "Current List" simply select a credential to move it into the "Remove" column. You may remove any number of credentials.
    1. Passes can be "unremoved" (placed back in current list) by selecting them in the remove column.
  2. No passes are actually removed until you click "Save".

Commands

The commands tab displays many of the Device Commands that are available for the device, as determined by the device definition. If a device type supports none of these commands, a "Device's Definition does not currently support any commands" message will be displayed.

The following commands may be available on this tab for your device:

  • Restart - Instruct the device to restart. This takes roughly 1-2 minutes, during which the device will not be accessible.
    1. Enter an Execution date/time, and "Execute" to schedule the command. A scheduled restart cannot be undone.
  • Lockdown - Instructs the specified device to lock for a defined number of hours. During a lockdown period, a device cannot be accessed, even with valid credentials. Set value to 0 to end an active lockdown.
    1. Enter a number of Locked Hours between 0 and 168 hours.
    2. Enter an Execution date/time, and "Execute" to schedule the command.
  • Unlock A Device's Door - Virtually presents a device credential to the device to unlock its door for the duration defined by the DoorUnlockTimeLimit parameter of the device's policy. Default is 5 seconds."
    1. Enter a a 10-40 character hexadecimal number or a 36-character GUID. If a 10-40 character hexadecimal number is defined, it needs to be in the access control list of the device.
    2. Enter an Execution date/time, and "Execute" to schedule the command.
  • Update Firmware - Update the firmware version for a device at a specified date and time.
    • Enter the URL for the firmware update.
    • Enter the date and time for the firmware update to execute.

Some commands are handled elsewhere in Navigator, and will not be replicated here: including Sync Device Credentials and Get Last Device Credentials Sync Date/Time of the Credentials Tab, and Get Device Status (The "Websocket" status in the device information sidebar.) Some device commands are not yet available in Navigator, including Get All RFID Tags, Get a Device's Configuration Parameter's, and Set a Device's Configuration Parameters.

Aliases

The Aliases tab displays a list of the aliases that are associated with the device.

Policy

Create, edit, or view policies associated with the device.

Local Access

Generate a one-time multi-factor authentication passcode for the device. The passcode updates every 30 seconds.