Jetstream API
Device Types

RFID Enclosures (Cabinets, Fridges, Freezers)

6min

About

RFID enclosures are cabinet, freezer and refrigerator Jetstream devices. They not only support most Jetstream commands and events but extend them by enabling access control and the ability to remotely lockdown.To learn more about the specific Terso devices that match this device type, vist their product detail pages at tersosolutions.com.

Compact RFID Cabinet (TS032, TS035, TS037, TS050)

Large RFID Cabinet (TS030, TS056)

Document image

Document image


Compact RFID Freezer (TS031 TS034, TS036, TS038, TS042, TS043, TS047, TS048, TS052, TS054, TS068)

Document image


The Countertop Cabinet and Security Cabinets are sufficiently distinct in function that they are treated as their own device types.

Commands

ConfigParameters

Name

Description

Data Type

Min

Max

Default

ACLockdownOnPowerFailure

Prevent end user access to the enclosure during a power failure event.

Bool

0

1

1

ACLogEntryOnPowerFailure

Generate a LogEntryEvent when AC power is lost and returns.

Bool

0

1

1

AggregateEventScanCount

Number of times the enclosure should scan after an end user closes the enclosure door.

Int

1

100

2

AggregateEventScanDelay

Number of times the enclosure should wait between scans after an end user closes the enclosure door.

Int

1

60

1

AggregateEventScanTime

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

Int

0

300

10

Antenna1TxPower

The dB transmit power of antenna 1.

Int

15

32

26

Antenna1RxSensitivity

The dB receive sensitivity of antenna 1.

Int

-80

-30

-65

Antenna2TxPower

The dB transmit power of antenna 2.

Int

15

32

26

Antenna2RxSensitivity

The dB receive sensitivity of antenna 2.

Int

-80

-30

-65

Antenna3TxPower

The dB transmit power of antenna 3.

Int

15

32

26

Antenna3RxSensitivity

The dB receive sensitivity of antenna 3.

Int

-80

-30

-65

Antenna4TxPower

The dB transmit power of antenna 4.

Int

15

32

26

Antenna4RxSensitivity

The dB receive sensitivity of antenna 4.

Int

-80

-30

-65

AutoUpdate

Automatically update to the latest Firmware version as soon as it is released.

Bool

0

1

0

BatteryThreshold

The battery voltage threshold to determine a good battery.

Float

0

30

23.0

CommandPollInterval

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

Int

0

600

60

CommsReboot

Time in minutes to wait for communication to Jetstream to be restored before a reboot occurs.

Int

10

1440

230

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

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

DisplayBacklight

The brightness percentage for the LCD screen's backlight.

Int

0

100

100

DisplayContrast

The contrast percentage for the LCD screen.

Int

0

100

50

DoorOpenTimeLimit

Time in seconds the door can be left open before generating a LogEntryEvent.

Int

1

3600

300

DoorUnlockTimeLimit

Time in seconds the door is unlocked after a user is granted access.

Int

1

3600

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

HeartbeatEventInterval

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

Int

0

600

60

InactivityInterval

Time in seconds 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 enclosure sends Jetstream messages.

String

-

-

JetstreamWebsocketAppEndpoint

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

String

-

-

/dwsliveconnection.ashx

LanguageFile

The language file to use to display messages on the enclosure's LCD screen.

String

-

-

lang/tsi-en-us.xml

LocationService

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

Bool

0

1

0

LogEntryLevel

The verbosity of the logs sent by the enclosure

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

String

Off

Debug

Error

LogFileLevel

The verbosity of the logs saved locally on the enclosure

  • 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. A setting of -1 will disable ObjectEvents.

Int

-1

23

0

ObjectEventScanCount

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

Int

1

100

2

ObjectEventScanDelay

Number of seconds the enclosure should wait between scans.

Int

1

60

1

ObjectEventScanTime

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

Int

1

300

10

PingInterval

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

Int

0

3600

0

ReaderNumAntennas

The number of antennas the enclosure is using.

Int

0

4

4

ReaderLockdownOnFailure

Prevent end user access to the enclosure if communications fail with the internal RFID reader.

Bool

0

1

1

ReaderLogEntryOnFailure

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

Bool

0

1

1

ScanMode

Specifies whether the reader should scan in Single, Dual, or Suppression modes.

String

-

-

Single

SecureSocket

Use secure communications over HTTPS for the enclosure.

Bool

0

1

1

SensorALockdownHighTemp

High temperature threshold in Celsius for probe A to lockdown the enclosure.

Int

-100

100

100

SensorALockdownLowTemp

Low temperature threshold in Celsius for probe A to lockdown the enclosure.

Int

-100

100

-100

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

SensorAOffset

The offset, in degrees Celsius, to apply to the temperature readings from temperature probe A.

Int

-100

100

0

SensorBLockdownHighTemp

High temperature threshold in Celsius for probe B to lockdown the enclosure.

Int

-100

100

100

SensorBLockdownLowTemp

Low temperature threshold in Celsius for probe B to lockdown the enclosure.

Int

-100

100

-100

SensorBLogEntryEventHighTemp

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

Int

-100

100

100

SensorBLogEntryEventLowTemp

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

Int

-100

100

-100

SensorBOffset

The offset, in degrees Celsius, to apply to the temperature readings from temperature probe B.

Int

-100

100

0

SensorReadingEventInterval

The number of minutes between sending a SensorReadingEvent. A setting of 0 will disable SensorReadingEvents.

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

ACPowerFailure

ACPowerFailure occurs when the enclosure loses AC power and is running on battery backup.

ACPowerRestore

ACPowerRestore occurs when the enclosure has AC power restored.

CorruptFlash

CorruptFlash occurs when the enclosure believes there is a problem with the flash memory.

DoorBreach

DoorBreach occurs when the door lock is released by something other than the enclosure. For example, someone prying the door open would cause this LogEntryEvent to be generated.

DoorOpen

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

DoorOpenRestore

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

DoorSensorFailure

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

InvalidPass

InvalidPass occurs when an RFID pass is presented to the pass reader which does not match any value on the enclosure’s synced credentials list.

LowBattery

LowBattery occurs when the enclosure's internal UPS battery voltage is less than the BatteryThreshold.

LowFlashMemory

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

LowMemory

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

Shutdown

Shutdown occurs when the enclosure is powered down.

Startup

Startup occurs whenever the enclosure is started up.

Temperature

Temperature occurs when a temperature threshold set by SensorA/BLogEntryEventHighTemp or SensorA/BLogEntryEventLowTemp has been reached.

TemperatureRestore

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

UserPassReaderFailure

UserPassReaderFailure occurs when the enclosure loses its connection to the pass reader.

UserPassReaderRestore

UserPassReaderRestore occurs when the enclosure has restored a connection to the pass reader.

SensorReadingEvents

Enclosures typically have two temperature probes installed. A SensorReadingEvent is periodically generated reporting the temperature on the probe(s).

Name

Description

TemperatureA

The temperature reported on probe A in Celsius.

TemperatureB

The temperature reported on probe B in Celsius.