Jetstream API
Device Types

RFID Enclosures (Cabinets, Fridges, Freezers)

8min
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, visit their product detail pages at tersosolutions com compact rfid cabinets https //www tersosolutions com/products/compact rfid cabinet/ (ts032, ts035, ts037, ts050) large rfid cabinets https //www tersosolutions com/products/compact rfid cabinet/ (ts030, ts056) countertop rfid refrigerator https //www tersosolutions com/products/countertop rfid refrigerator/ (ts098) undercounter rfid refrigerator https //www tersosolutions com/products/undercounter rfid refrigerator/ (ts097) compact international rfid refrigerators https //www tersosolutions com/products/compact international rfid refrigerator/ (ts055, ts060, ts061) large rfid refrigerator https //www tersosolutions com/products/large rfid refrigerator/ (ts074e) compact rfid freezers 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) undercounter ultra low temperature rfid freezer https //www tersosolutions com/products/under counter ultra low temperature rfid freezer/ (ts079) large ultra low temperature rfid freezers https //www tersosolutions com/products/ultra low temperature rfid freezer/ (ts057, ts088) the countertop cabinet docid\ qylhkyiv aib7jbg7bgtp and security cabinets docid\ bqe4qp4tfhbc880tsbs1w are sufficiently distinct in function that they are treated as their own device types commands you can send the following commands to an rfid enclosure via jetstream name supported get device status docid 0r9xzn3hnqid911qs3wxg yes sync device credentials docid\ l7ik ra1wcy3phhm0fwqs yes get all rfid tags docid 7onvtntdtfl9ptdal2nvo yes 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 an rfid enclosure 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 data type min max default firmware aclockdownonpowerfailure prevent end user access to the enclosure during a power failure event bool 0 1 1 v4 3+ aclogentryonpowerfailure generate a logentryevent when ac power is lost and returns bool 0 1 1 v4 3+ aggregateeventscancount number of times the enclosure should scan after an end user closes the enclosure door a setting of 0 will disable aggregateevents int 0 100 2 v4 3+ aggregateeventscandelay number of seconds the enclosure should wait between scans after an end user closes the enclosure door int 1 60 1 v4 3+ aggregateeventscantime the time of each individual scan in seconds after an end user closes the enclosure door int 1 300 10 v4 3+ antenna1txpower the db transmit power of antenna 1 int 15 32 26 v4 3+ antenna1rxsensitivity the db receive sensitivity of antenna 1 int 80 30 65 v4 3+ antenna2txpower the db transmit power of antenna 2 int 15 32 26 v4 3+ antenna2rxsensitivity the db receive sensitivity of antenna 2 int 80 30 65 v4 3+ antenna3txpower the db transmit power of antenna 3 int 15 32 26 v4 3+ antenna3rxsensitivity the db receive sensitivity of antenna 3 int 80 30 65 v4 3+ antenna4txpower the db transmit power of antenna 4 int 15 32 26 v4 3+ antenna4rxsensitivity the db receive sensitivity of antenna 4 int 80 30 65 v4 3+ antennaalarm generate a logentryevent if a scan finds no tags, since in a typically stocked enclosure this may indicate an antenna failure this should only be disabled if a an empty enclosure is the expected state bool 0 1 1 v4 8 52+ autoupdate automatically update to the latest firmware version as soon as it is released bool 0 1 0 v4 7 v4 8 52 autoupdatefw automatically update to the latest firmware version as soon as it is released bool 0 1 1 v5+ autoupdateos automatically update to the latest operating system version as soon as it is released bool 0 1 1 v5+ batterythreshold the battery voltage threshold to determine a good battery float 0 30 23 0 v4 3+ commandpollinterval the number of minutes between polling for device commands in jetstream int 0 600 60 v4 3+ commsinterfacerestart the time in minutes before the interface is “bounced” continuously after the device loses connection with dws for any reason int 1 480 15 v5 2 16+ commsreboot time in minutes to wait for communication to jetstream to be restored before a reboot occurs int 10 1440 230 v4 7+ commsreconnectinterval time in seconds to wait before attempting to communicate with jetstream if there were any communication problems int 1 300 10 v4 3+ commstimeout time in seconds to wait for a reply from jetstream after sending an event or command response int 5 300 60 v4 3+ delayminutes time in minutes that a valid pass can delay a fw or os update only 60, 90, or 120 minutes allowed int 60 120 60 v5+ delayscans number of times a valid pass can delay an auto update int 0 8 4 v5+ displaybacklight the brightness percentage for the lcd screen's backlight int 0 100 100 v4 3+ displaycontrast the contrast percentage for the lcd screen int 0 100 50 v4 3+ 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 3+ doordebouncetime this is the time in half seconds from when the door is sensed closed until the scan actually starts int 0 20 4 v5 2 16+ doorlocktriggered lock the door only after the door has been closed this parameter must be set to true for the ts088 (ult freezer), and should be false for other models bool 0 1 0 v4 8 36+, v5 1 16+ doorlocktriggereddelay for ts088 only time in seconds from when the door sensor picks up door closed to when door lock is energized only valid when doorlocktriggered is set to true int 1 60 3 v4 8 55+, v5 1 16+ dooropentimelimit time in seconds the door can be left open before generating a logentryevent int 1 43200 300 v4 3+ doorunlocktimelimit time in seconds the door is unlocked after a user is granted access int 1 3600 5 v4 3+ 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 3+ heartbeateventinterval the number of minutes between sending a heartbeatevent a setting of 0 will disable heartbeatevents int 0 600 60 v4 3+ i2cfaillogentryinterval this is the time in minutes between the i2c failure logentry communications when the i2c communication is in constant failure int 0 off 1440 240 v5 2 16+ inactivityinterval time in seconds communications will wait before re establishing a connection if there is no activity int 70 3600 300 v4 3+ 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 3+ jetstreamdeviceurl the url to which the enclosure sends jetstream messages string us device jetstreamrfid com v4 3+ jetstreamversion the jetstreamversion of the intended receiving queue's getevents requests set to 1 5, 2, or 3 duplicate event prevention is present for versions 2 and 3 string 1 5 3 1 5 v4 8 42 v4 8 52 jetstreamwebsocketappendpoint the jetstream resource used to connect for websocket communications using '#' will disable websocket communications string /dwsliveconnection ashx v4 3+ languagefile the language file to use to display messages on the enclosure's lcd screen string lang/tsi en us xml v4 3+ locationservice use location based services for the enclosure the geolocation of the enclosure will be sent in a sensorreadingevent bool 0 1 0 v4 3 v4 8 42 logentrylevel the verbosity of the logs sent by the enclosure off error warning information string off information error v4 3+ logfilelevel the verbosity of the logs saved locally on the enclosure off error warning information verbose trace debug string off debug off v4 3+ objecteventhour the hour of the day (utc) to perform the daily system scan as well as other system checks a setting of 1 will disable objectevents int 1 23 0 v4 3+ objecteventscancount the number of times to scan during a getepclistcommand or during the daily system scan int 1 100 2 v4 3+ objecteventscandelay number of seconds the enclosure should wait between scans int 1 60 1 v4 3+ objecteventscantime the time in seconds for each scan during a getepclistcommand or during the daily system scan int 1 300 10 v4 3+ pinginterval time in seconds between client initiated pings when using websockets a setting of 0 disables client pings int 0 3600 0 v4 3+ readcountthreshold number of times a tag must be "seen" to be reported set to 0, to report anything seen set to 1 or more to filter out spurious reads typically this is only used in a ult int 0 1000 0 v5+ readerlockdownonfailure prevent end user access to the enclosure if communications fail with the internal rfid reader bool 0 1 1 v4 3+ readerlogentryonfailure generate a logentryevent when communications to the internal rfid reader fails bool 0 1 1 v4 3+ readernumantennas the number of antennas the enclosure is using int 2 4 4 v4 7+ removeevent when this is set to 1 (true), epc tags removed are included in aggregateevent when set to false they are omitted from the event bool 1 0 1 v5 2 16+ scanmode specifies whether the reader should scan in single, dual, or suppression modes string single v4 6+ securesocket use secure communications over https for the enclosure bool 0 1 1 v4 3+ sensoralockdownhightemp high temperature threshold in celsius for probe a to lockdown the enclosure int 100 100 100 v4 3+ sensoralockdownlowtemp low temperature threshold in celsius for probe a to lockdown the enclosure int 100 100 100 v4 3+ sensoralogentryeventhightemp high temperature threshold in celsius for probe a to send a logentryevent int 100 100 100 v4 3+ sensoralogentryeventlowtemp low temperature threshold in celsius for probe a to send a logentryevent int 100 100 100 v4 3+ sensoraoffset the offset, in degrees celsius, to apply to the temperature readings from temperature probe a int 20 20 0 v4 7+ sensorblockdownhightemp high temperature threshold in celsius for probe b to lockdown the enclosure int 100 100 100 v4 3+ sensorblockdownlowtemp low temperature threshold in celsius for probe b to lockdown the enclosure int 100 100 100 v4 3+ sensorblogentryeventhightemp high temperature threshold in celsius for probe b to send a logentryevent int 100 100 100 v4 3+ sensorblogentryeventlowtemp low temperature threshold in celsius for probe b to send a logentryevent int 100 100 100 v4 3+ sensorboffset the offset, in degrees celsius, to apply to the temperature readings from temperature probe b int 20 20 0 v4 7+ sensorreadingeventinterval the number of minutes between sending a sensorreadingevent a setting of 0 will disable sensorreadingevents int 0 600 60 v4 3+ 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 3+ temperaturehires report temperature to a tenth of a degree (ex 10 1, rather than 10) if set to false, temperatures will continue to be rounded to the nearest integer bool 0 1 0 v4 8 52+ updateday the day of the week to perform auto updates set to 0 to check every day set to 1 for sunday and sequentially after int 0 7 0 v5+ updatehour the hour of the day (utc) to perform the auto updates set to 1 to tie the auto updates to the obecteventhour parameter int 1 23 1 v5+ updatenotification enables the notification that an auto update is going to occur the countdown starts 60 minutes before scheduled time bool 0 1 1 v5+ 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 an rfid enclosure other events pertaining to, but not generated by, the rfid enclosure 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 yes an aggregateevent is generated whenever an rifd tag has been added or removed from a device commandcompletionevent docid\ sj1tshbqvf4fri6az1ywg yes a commandcompletionevent is published when a command has been completed on a device 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 yes these can be disabled by setting the objecteventhour config parameter to 1 sensorreadingevent docid\ rgpeiorzuhkz9iqamwxmp yes see the sensorreadingevents section below for more details statusevent docid\ wfpf7d 2jsp7uavkaqvmp yes a statusevent reports several pieces of device information every time the device is powered on, and during its nightly scan logentryevents the list below are some common, potential logentryevent docid\ cclcl11t3bliaiko gtmh an rfid enclosure 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 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 displayfailure displayfailure occurs when the firmware attempts to send a message to the lcd but fails displayrestore displayrestore occurs when communication with the lcd is restored 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 validpass validpass occurs when a valid pass is read by the pass reader sensorreadingevents enclosures typically have two temperature probes installed, smaller units may only have one probe (a) a sensorreadingevent docid\ rgpeiorzuhkz9iqamwxmp 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