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 https //www tersosolutions com/products/compact rfid cabinet/ (ts032, ts035, ts037, ts050) large rfid cabinet https //www tersosolutions com/products/compact rfid cabinet/ (ts030, ts056) compact rfid refrigerator https //www tersosolutions com/products/compact rfid refrigerator/ (ts029) compact international rfid refrigerator https //www tersosolutions com/products/compact international rfid refrigerator/ (ts055, ts060, ts061) large rfid refrigerator https //www tersosolutions com/products/large rfid refrigerator/ (ts074) compact rfid freezer https //www tersosolutions com/products/compact rfid freezer/ (ts031 ts034, ts036, ts038, ts042, ts043, ts047, ts048, ts052, ts054, ts068) compact international eco friendly rfid freezer https //www tersosolutions com/products/compact rfid freezer/ (ts047e) large rfid freezer https //www tersosolutions com/products/large rfid freezer/ (ts078) under counter ultra low temperature rfid freezer https //www tersosolutions com/products/under counter ultra low temperature rfid freezer/ (ts079) large ultra low temperature rfid freezer https //www tersosolutions com/products/large ultra low temperature rfid freezer/ (ts057) the countertop cabinet docid\ swnl7hajx6w 68gobsvpd and security cabinets docid\ nj w3umlx 1n x0ks2x are sufficiently distinct in function that they are treated as their own device types commands name supported update firmware docid\ h9h679y t3yztcipn2gcz yes get all passes docid\ d7j1rxbgyehbv3bajwgsp yes add or remove passes docid\ the3s6mtw3baeauul1a83 yes get all rfid tags docid\ ci32mn8hwosbcmjmdu4tp yes restart a device docid 9jcownfudipbznnnryfr0 yes lock a device docid\ wahzv ft98lwrpl3x2p0v yes unlock a device's door docid\ qdtewzyti 4vmdsnli9qm yes get a device's configuration parameters docid 94vzb6djztjxfyzb78uj yes set a device's configuration parameters docid\ llqub1kfyhmeomohn 1fc yes 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 http //us device tersosolutions com/ http //us device tersosolutions com/ 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