Jetstream API
Device Types

Mobile Case

5min

About

RFID Mobile Cases are Jetstream enabled devices used to transport, protect, and track field or mobile inventory. These devices not only support most Jetstream commands and events, but extend them by adding mobile features such as Geolocation through Location Based Services (LBS). To learn more, visit https://www.tersosolutions.com/products/rfid-mobile-case/.

Model: TS080

Document image


Commands

ConfigParameters

Name

Description

Data Type

Min

Max

Default

AggregateEventScanCount

Number of times the case should scan after an end user closes the lid.

Int

1

100

2

AggregateEventScanDelay

Number of seconds the case should wait between scans after an end user closes the lid.

Int

1

60

1

AggregateEventScanTime

The time of each individual scan in seconds after an end user closes the lid.

Int

1

300

2

AntennaTxPower

The dB transmit power of all antennas.

Int

10

23

23

BatteryCritical

The battery percentage threshold to flag if the battery is at a critical charge level. In this state, the case will not perform RFID scans. It may also not be able to communicate depending on charge level.

Int

2

20

10

BatteryLed

Enable the LED to indicate battery level.

Bool

0

1

0

BatteryLow

The battery percentage threshold to flag if the battery is at a low charge level. The case will continue to operate normally by scanning and communicating results.

Int

5

50

20

CommandPollInterval

The number of minutes between polling for device commands in Jetstream.

Int

0

600

60

CommsReconnectInterval

Time in seconds to wait before attempting to communicate with Jetstream if there were any communication problems.

Int

0

60

10

CommsTimeout

Time in seconds to wait for a reply from Jetstream after sending an event or command response.

Int

0

60

10

ConnectRetries

Number of times to retry connecting to the cellular network.

Int

1

3

5

DNS

The DNS to be used in a static LAN environment. When set to '0.0.0.0', the DHCP assigned DNS server is used instead.

IP Address

0.0.0.0

255.255.255.255

0.0.0.0

Gateway

The gateway address to be used in a static LAN environment. When set to '0.0.0.0', the DHCP assigned Gateway address is used instead.

IP Address

0.0.0.0

255.255.255.255

0.0.0.0

HeartbeatEventInterval

The number of minutes between sending a HeartbeatEvent.

Int

0

600

0

InactivityInterval

Time in minutes communications will wait before re-establishing a connection if there is no activity.

Int

0

3600

300

IP

The IP address to be used in a static LAN environment. When set to '0.0.0.0', the DHCP assigned IP address is used instead.

IP Address

0.0.0.0

255.255.255.255

0.0.0.0

JetstreamDeviceUrl

The URL to which the case sends Jetstream messages.

String

-

-

JetstreamWebsocketAppEndpoint

The Jetstream resource used to connect for WebSocket communications. Using '#' will disable WebSocket communications.

String

-

-

/dwsliveconnection.ashx

LidClosedShutdownTime

The number of seconds to wait after the lid is closed before automatically shutting down to conserve power.

Int

1

600

30

LidDebounceTime

The number of seconds to wait after the lid is closed before scan begins.

Int

1

300

3

LidOpenTimeLimit

The number of seconds to wait while the lid remains open before automatically shutting down to conserve power.

Int

1

600

300

LocationService

Use location based services for the case. The Geolocation of the case will be sent in a SensorReadingEvent.

Bool

0

1

1

LogEntryLevel

The verbosity of the logs sent by the case

  • Off
  • Error
  • Warning
  • Information
  • Verbose
  • Trace

String

Off

Trace

Error

LogFileLevel

The verbosity of the logs saved locally on the case

  • Off
  • Error
  • Warning
  • Information
  • Verbose
  • Trace
  • Debug

String

Off

Debug

Off

ObjectEventHour

The hour to perform the daily system scan as well as other system checks.

Int

-1

23

0

ObjectEventOnly

When true, all scans are reported as ObjectEvent. Otherwise, lid open/close report as AggregateEvents.

Bool

0

1

0

ObjectEventScanCount

The number of times to scan during a GetEPCListCommand or during the daily system scan.

Int

1

100

2

ObjectEventScanDelay

Number of times the case should wait between scans after an end user closes the lid.

Int

1

60

1

ObjectEventScanTime

The time in seconds for each scan during a GetEPCListCommand or during the daily system scan.

Int

1

300

2

OperationLed

Enable the LED to indicate operation state.

Bool

0

1

0

PingInterval

Time in seconds between client initiated pings when using WebSockets. A setting of 0 disables client pings.

Int

0

3600

0

ReaderLogEntryOnFailure

Generate a LogEntryEvent when communications to the internal RFID reader fails.

Bool

0

1

1

RegionCode

The region determines the RFID frequency of operation.

String

-

-

FCC

SecureSocket

Use secure communications over HTTPS for the case.

Bool

0

1

1

SensorALogEntryEventHighTemp

High temperature threshold in Celsius for probe A to send a LogEntryEvent.

Int

-100

100

100

SensorALogEntryEventLowTemp

Low temperature threshold in Celsius for probe A to send a LogEntryEvent.

Int

-100

100

-100

SensorReadingEventInterval

The number of seconds between sending a SensorReadingEvent.

Int

0

600

60

Subnet

The subnet address to be used in a static LAN environment. When set to '0.0.0.0', the DHCP assigned subnet is used instead.

IP Address

0.0.0.0

255.255.255.255

0.0.0.0

LogEntryEvents

The list below are some common, potential LogEntryEvents an enclosure may send in. However, not all possible LogEntryEvents are listed in this table. The LogEntryLevel in use determines which LogEntryEvents are sent to Jetstream.

Name

Description

CriticalBattery

CriticalBattery occurs whenever the percent of battery charge is below BatteryCritical. The battery percentage will also be reported.

LowBattery

LowBattery occurs whenever the percent of battery charge is below BatteryLow but above BatteryCritical. The battery percentage will also be reported.

LowFlashMemory

LowFlashMemory occurs when the mobile case has less than 25% flash memory.

LowMemory

LowMemory occurs when the mobile case has less than 25% memory. This event will be sent every hour until the device reboots. Reboot occurs automatically if memory drops to 10%.

NewFirmwareDownloadError

NewFirmwareDownloadError occurs when a request to upgrade firmware fails because the case is not able to download the new firmware.

ReadException

ReadException occurs when there is an issue performing an RF read.

ScanInterruptionAlarm

ScanInterruptionAlarm occurs when someone interrupts a scan by opening the lid.

Shutdown

Shutdown occurs when the case is signaled to shutdown.

Startup

Startup occurs whenever a case is started up.

Temperature

Temperature occurs when a temperature threshold set by SensorALogEntryEventHighTemp or SensorALogEntryEventLowTemp has been reached.

TemperatureRestore

TemperatureRestore occurs when an enclosure has gone back into normal temperature range.

WakeReason

Occurs whenever the case boots up. The message contains the reason why the case booted.

SensorReadingEvents

Geolocation for the case (Latitude, Logitude, and Range) is reported as part of a SensorReadingEvent.

Name

Description

BatteryLevel

The percent charge remaining of the battery.

Connection

The frequency standard the device communicated through: LTE, CDMA, or GSM.

Latitude

The Latitude where case is currently positioned in degrees.

Longitude

The Longitude where case is currently positioned in degrees.

Range

The measure of error from the Latitude/Longitude point where case is currently positioned in meters.

SignalStrength

The cellular network signal strength where the case is currently positioned in dB.

TemperatureA

The temperature reported on probe A in Celsius.