Jetstream API
Device Types

Security Cabinets

4min

About

Security cabinets are Jetstream-enabled cabinets that enable access control and logging, alerting, and the ability to remotely lockdown. They do not possess RFID reading or Temperature sensing capabilities like RFID Enclosures. To learn more, visit: https://www.tersosolutions.com/products/large-secured-access-cabinet/.

Model: TS092

Document image


Commands

ConfigParameters

Name

Description

Type

Min

Max

Default

ACLockdownOnPowerFailure

Lockdown unit if AC power fails

bool

0

1

0

ACLogentryOnPowerFailure

Send a logentry alarm if AC power fails

bool

0

1

1

AggregateEventScanCount

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

int

1

100

2

AutoUpdate

Enable the automatic update of firmware

bool

0

1

0

BatteryThreshold

Send logentry alarm when backup battery falls below this level

string

0

30

23

CommandPollInterval

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

int

0

600

60

CommsReboot

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

int

10

1440

230

CommsReconnectInterval

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

int

1

300

10

CommsTimeout

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

int

1

300

60

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

DoorOpenTimeLimit

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

int

1

43200

300

DoorUnlockTimeLimit

After a valid pass unlocks door, it stays unlocked for this long (seconds)

int

1

3600

10

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

HeartbeatEventInterval

The number of minutes between sending a HeartbeatEvent.

int

0

600

60

InactivityInterval

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

int

70

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

JetstreamDeviceUrl

The URL to which the enclosure sends Jetstream messages.

string

JetstreamVersion

Verson of Jetstream that the events will be available after DWS receives them "3" - sends to v3 endpoints as v3 JSON events "2" - send to v2 endpoints as v2 JSON events "1.5" - sends to v1.5 endpoints as XML events

string

2

JetstreamWebsocketAppEndpoint

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

string

/dwsliveconnection.ashx

LocationService

Report location of device (currently not supported on this device)

bool

0

1

0

LogEntryLevel

The verbosity of the logs sent by the enclosure - Off - Error - Warning - Information - Verbose

string

Error

LogFileLevel

The verbosity of the logs saved locally on the enclosure - Off - Error - Warning - Information - Verbose - Trace - Debug

string

Off

ObjectEventHour

The hour to perform the daily system scan as well as other system checks. Set to -1 to turn off

int

-1

23

0

ObjectEventScanCount

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

int

1

100

2

Ping Interval

For sending websocket png to server.

int

0

3600

0

SecureSocket

Use secure communications over HTTPS for the enclosure.

bool

0

1

1

SensorReadingEventInterval

Minutes between reporting temperature sensor data. Set to 0 to turn off temperature readings

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

LogEntryEvents

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.

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.

LowBattery

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

LowFlashSpace

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

Shutdown

Shutdown occurs whenever the enclosure is powered down.

Startup

Startup occurs whenever the enclosure is started up.

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

Secured Cabinets do not generate any SensorReadingEvents.