Jetstream API
Device Types

Countertop Cabinet

6min

About

Countertop cabinets are Jetstream enabled devices used to transport, protect, and track field or mobile inventory. These devices support most Jetstream commands and events, but do not include temperature sensors or secured access like larger enclosures. For more information, visit https://www.tersosolutions.com/products/countertoprfidcabinet/.

Model: TS083

Document image


Commands

You can send the following commands to a countertop cabinet via Jetstream.

Config Parameters

The following are the parameters that can be configured for a countertop cabinet via policy. Available parameters may differ by firmware version. To configure your own devices via Jetstream, follow this guide. Terso Support can also manage these configuration settings for you.

Name

Description

Data Type

Min

Max

Default

Firmware

AggregateEventScanCount

Number of times to scan after product is added/removed and door is closed.

Int

1

100

2

v4.5+

AggregateEventScanDelay

Number of seconds to wait between scans.

Int

1

60

1

v4.5+

AggregateEventScanTime

Time in seconds for each scan

Int

1

300

10

v4.5+

AntennaTxPower

The dB transmit power of all of the antennas.

Int

10

23

23

v4.5+

CommandPollInterval

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

Int

0

600

60

v4.5+

CommsReboot

Number of minutes after the system loses communication that it will automatically reboot.

Int

10

1440

230

v4.5+

CommsReconnectInterval

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

Int

1

300

10

v4.5+

CommsTimeout

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

Int

1

300

60

v4.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

v4.5+

DoorOpenTimeLimit

Time in seconds that the door can be left open before a DoorAjar alarm is sent.

Int

0

3600

300

v4.5+

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

v4.5+

HeartbeatEventInterval

The number of minutes between sending a HeartbeatEvent. A setting of 0 will disable HeartbeatEvents.

Int

0

600

60

v4.5+

InactivityInterval

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

Int

70

3600

300

v4.5+

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

v4.5+

JetstreamDeviceUrl

The URL to which the cabinet sends Jetstream messages.

String

-

-

us-device.jetstreamrfid.com

v4.5+

JetstreamWebsocketAppEndpoint

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

String

-

-

/dwsliveconnection.ashx

v4.5+

LogEntryLevel

The verbosity of the logs sent by the cabinet.

  • Off
  • Error
  • Warning
  • Information

String

-

-

Error

v4.5+

LogFileLevel

The verbosity of the logs saved locally on the cabinet.

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

String

-

-

Debug

v4.5+

ObjectEventHour

The hour to perform the daily system scan as well as other system checks. A setting of -1 will disable ObjectEvents.

Int

-1

23

0

v4.5+

ObjectEventScanCount

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

Int

1

100

2

v4.5+

ObjectEventScanDelay

Number of seconds the cabinet should wait between scans.

Int

1

60

1

v4.5+

ObjectEventScanTime

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

Int

1

300

5

v4.5+

ReaderLogEntryOnFailure

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

Bool

0

1

1

v4.5+

ReaderNumAntennas

The number of antennas the cabinet is using.

Int

1

4

2

v4.5+

SecureSocket

Use secure communications over HTTPS for the cabinet.

Bool

0

1

1

v4.5+

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

v4.5+

Events

The following are the Jetstream Events that may come into your queue directly from a countertop cabinet. Other events pertaining to, but not generated by, the countertop cabinet are not listed here as those Jetstream-generated events do not vary by device type. See the Event entry in the Glossary to see a complete list of which events are from a device and which come from the Jetstream application.

Name

Supported

Notes

Yes

PassRFID parameter will always be blank, since the countertop cabinet does not have a pass reader.

Yes

Yes

These can be disabled by setting the HeartbeatEventInterval Config Parameter to 0.

LogEntryEvent

Yes

These can be disabled or increased by configuring the LogEntryLevel Config Parameter. Disabling LogEntryEvents is NOT recommended, as this would prevent you or Terso from remotely monitoring the health of the unit. See the LogEntryEvents section below for more details.

ObjectEvent

Yes

These can be disabled by setting the ObjectEventHour Config Parameter to -1.

No

StatusEvent

Yes

LogEntryEvents

The list below are some common, potential LogEntryEvents a countertop cabinet may send in. However, not all possible LogEntryEvents are listed in this table. The LogEntryLevel Config Parameter determines which LogEntryEvents are sent to Jetstream, the following logentryevents may be sent when LogEntryLevel = Error.

Name

Description

CorruptFlash

CorruptFlash occurs when the event queue on the device cannot be read due to a memory failure.

DoorOpen

DoorOpen occurs when the door is left open for greater than the DoorOpenTimeLimit.

DoorOpenRestore

DoorOpenRestore occurs when the countertop cabinet's door is closed after a DoorOpen scenario.

DoorSensorFailure

DoorSensorFailure occurs when the countertop cabinet believes there is a problem with the door sensor.

FirmwareInfo

FirmwareInfo occurs whenever the countertop cabinet is started up.

LowFlashMemory

LowFlashMemory occurs when the countertop cabinet has less than 25% memory.

LowMemory

LowMemory occurs when the countertop cabinet 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.

ReadException

ReadException occurs when there is an issue performing an RFID scan.

ScanInterruptionAlarm

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

Startup

Startup occurs whenever the countertop cabinet is started up.

SensorReadingEvents

The Countertop Cabinet does not generate any SensorReadingEvents.