Jetstream API
Device Types
Security Cabinets
6min
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 they do not send objectevent docid 6kkkdbv1sxgpehyq9dh0j or aggregateevent docid\ atqjfemfm4z9hitjaiepk , so pass access should be monitored via logentryevent docid\ cclcl11t3bliaiko gtmh of the type validpass to learn more, visit https //www tersosolutions com/products/large secured access cabinet/ https //www tersosolutions com/products/large secured access cabinet/ model ts092 commands you can send the following commands to a security cabinet via jetstream name supported get device status docid 0r9xzn3hnqid911qs3wxg yes sync device credentials docid\ l7ik ra1wcy3phhm0fwqs yes get all rfid tags docid 7onvtntdtfl9ptdal2nvo no restart a device docid\ ww54y7kiqnfvyk8zyqakv yes lockdown a device docid\ vboyeohcjlpy 7zr afgz yes unlock a device's door docid 1 ro5cpawezhguxfhofai yes get a device's policy parameters docid\ g6s4nzg5dsgaf dcagbtb yes set a device's policy parameters docid\ g2ehibf dqnwc4nh0cx1w yes get last device credentials sync date/time docid\ xcfht1rs4l0m0ssfmpz8e yes set configuration values for a device docid\ ime76bwc91dxcc4gvdyz8 yes configparameters the following are the parameters that can be configured for a security cabinet via policy available parameters may differ by firmware version to configure your own devices via jetstream, configuring a device policies & parameters docid\ x4p9x9tuutzz9n6fs7jt terso support can also manage these configuration settings for you name description type min max default firmware aclockdownonpowerfailure lockdown unit if ac power fails bool 0 1 0 v4 8+ aclogentryonpowerfailure send a logentry alarm if ac power fails bool 0 1 1 v4 8+ aggregateeventscancount number of times to scan after product is added/removed and door is closed int 1 100 2 v4 8+ autoupdate enable the automatic update of firmware bool 0 1 0 v4 8+ batterythreshold send logentry alarm when backup battery falls below this level string 0 30 23 v4 8+ commandpollinterval the number of minutes between polling for device commands in jetstream int 0 600 60 v4 8+ commsreboot number of minutes after the system loses communication that it will automatically reboot int 10 1440 230 v4 8+ commsreconnectinterval time in seconds to wait before attempting to reconnect with jetstream if there were any communication problems int 1 300 10 v4 8+ commstimeout time in seconds to wait for a reply from jetstream after sending an event or command response int 1 300 60 v4 8+ 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 8+ dooropentimelimit time in seconds that the door can be left open before a dooropen alarm is sent int 1 43200 300 v4 8+ doorunlocktimelimit after a valid pass unlocks door, it stays unlocked for this long (seconds) int 1 3600 10 v4 8+ 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 8+ heartbeateventinterval the number of minutes between sending a heartbeatevent a setting of 0 will disable heartbeatevents int 0 600 60 v4 8+ inactivityinterval time in seconds communications will wait before re establishing a connection if there is no activity int 70 3600 300 v4 8+ 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 0 0 0 0 v4 8+ jetstreamdeviceurl the url to which the enclosure sends jetstream messages string us device jetstreamrfid com v4 8+ 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 1 5 3 1 5 v4 8+ jetstreamwebsocketappendpoint the jetstream resource used to connect for websocket communications using '#' will disable websocket communications string /dwsliveconnection ashx v4 8+ locationservice report location of device (currently not supported on this device) bool 0 1 0 v4 8+ logentrylevel the verbosity of the logs sent by the enclosure \ off \ error \ warning \ information string off information error v4 8+ logfilelevel the verbosity of the logs saved locally on the enclosure \ off \ error \ warning \ information \ verbose \ trace \ debug string off debug off v4 8+ 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 v4 8+ objecteventscancount the number of times to scan during a getepclistcommand or during the daily system scan int 1 100 2 v4 8+ ping interval for sending websocket ping to server int 0 3600 0 v4 8+ securesocket use secure communications over https for the enclosure bool 0 1 1 v4 8+ sensorreadingeventinterval minutes between reporting temperature sensor data set to 0 to turn off temperature readings int 0 600 60 v4 8+ 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 8+ userbypass allow any 10 40 hexadecimal character pass to access the cabinet, ignoring the credentials list synced from jetstream bool 0 1 0 v4 8 42+ events the following are the jetstream events that may come into your queue directly from a security cabinet other events pertaining to, but not generated by, the security cabinet are not listed here as those jetstream generated events do not vary by device type see the event entry in the glossary docid\ k wnsotemg6 ggtqd 6gs to see a complete list of which events are from a device and which come from the jetstream application name supported notes aggregateevent docid\ atqjfemfm4z9hitjaiepk no commandcompletionevent docid\ sj1tshbqvf4fri6az1ywg yes heartbeatevent docid\ g o0yv1ty07c7b ce rdw yes these can be disabled by setting the heartbeateventinterval config parameter to 0 logentryevent docid\ cclcl11t3bliaiko gtmh 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 docid 6kkkdbv1sxgpehyq9dh0j no sensorreadingevent docid\ rgpeiorzuhkz9iqamwxmp no statusevent docid\ wfpf7d 2jsp7uavkaqvmp yes logentryevents the list below are some common, potential logentryevent docid\ cclcl11t3bliaiko gtmh a security 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 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