Jetstream API
Device Types
Mobile Case
5min
about rfid mobile cases are jetstream enabled devices used to transport, protect, and track field or mobile inventory these devices not only support most jetstream commands and events, but extend them by adding mobile features such as geolocation through location based services (lbs) to learn more, visit https //www tersosolutions com/products/rfid mobile case/ https //www tersosolutions com/products/rfid mobile case/ model ts080 commands name supported update firmware docid\ h9h679y t3yztcipn2gcz yes get all passes docid\ d7j1rxbgyehbv3bajwgsp no add or remove passes docid\ the3s6mtw3baeauul1a83 no get all rfid tags docid\ ci32mn8hwosbcmjmdu4tp no restart a device docid 9jcownfudipbznnnryfr0 no lock a device docid\ wahzv ft98lwrpl3x2p0v no unlock a device's door docid\ qdtewzyti 4vmdsnli9qm no 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 aggregateeventscancount number of times the case should scan after an end user closes the lid int 1 100 2 aggregateeventscandelay number of seconds the case should wait between scans after an end user closes the lid int 1 60 1 aggregateeventscantime the time of each individual scan in seconds after an end user closes the lid int 1 300 2 antennatxpower the db transmit power of all antennas int 10 23 23 batterycritical the battery percentage threshold to flag if the battery is at a critical charge level in this state, the case will not perform rfid scans it may also not be able to communicate depending on charge level int 2 20 10 batteryled enable the led to indicate battery level bool 0 1 0 batterylow the battery percentage threshold to flag if the battery is at a low charge level the case will continue to operate normally by scanning and communicating results int 5 50 20 commandpollinterval the number of minutes between polling for device commands in jetstream int 0 600 60 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 connectretries number of times to retry connecting to the cellular network int 1 3 5 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 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 int 0 600 0 inactivityinterval time in minutes 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 case sends jetstream messages string 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 lidclosedshutdowntime the number of seconds to wait after the lid is closed before automatically shutting down to conserve power int 1 600 30 liddebouncetime the number of seconds to wait after the lid is closed before scan begins int 1 300 3 lidopentimelimit the number of seconds to wait while the lid remains open before automatically shutting down to conserve power int 1 600 300 locationservice use location based services for the case the geolocation of the case will be sent in a sensorreadingevent bool 0 1 1 logentrylevel the verbosity of the logs sent by the case off error warning information verbose trace string off trace error logfilelevel the verbosity of the logs saved locally on the case 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 int 1 23 0 objecteventonly when true, all scans are reported as objectevent otherwise, lid open/close report as aggregateevents bool 0 1 0 objecteventscancount the number of times to scan during a getepclistcommand or during the daily system scan int 1 100 2 objecteventscandelay number of times the case should wait between scans after an end user closes the lid int 1 60 1 objecteventscantime the time in seconds for each scan during a getepclistcommand or during the daily system scan int 1 300 2 operationled enable the led to indicate operation state bool 0 1 0 pinginterval time in seconds between client initiated pings when using websockets a setting of 0 disables client pings int 0 3600 0 readerlogentryonfailure generate a logentryevent when communications to the internal rfid reader fails bool 0 1 1 regioncode the region determines the rfid frequency of operation string fcc securesocket use secure communications over https for the case bool 0 1 1 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 sensorreadingeventinterval the number of seconds between sending a sensorreadingevent 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 criticalbattery criticalbattery occurs whenever the percent of battery charge is below batterycritical the battery percentage will also be reported lowbattery lowbattery occurs whenever the percent of battery charge is below batterylow but above batterycritical the battery percentage will also be reported lowflashmemory lowflashmemory occurs when the mobile case has less than 25% flash memory lowmemory lowmemory occurs when the mobile case 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 because the case is not able to download the new firmware readexception readexception occurs when there is an issue performing an rf read scaninterruptionalarm scaninterruptionalarm occurs when someone interrupts a scan by opening the lid shutdown shutdown occurs when the case is signaled to shutdown startup startup occurs whenever a case is started up temperature temperature occurs when a temperature threshold set by sensoralogentryeventhightemp or sensoralogentryeventlowtemp has been reached temperaturerestore temperaturerestore occurs when an enclosure has gone back into normal temperature range wakereason occurs whenever the case boots up the message contains the reason why the case booted sensorreadingevents geolocation for the case (latitude, logitude, and range) is reported as part of a sensorreadingevent name description batterylevel the percent charge remaining of the battery connection the frequency standard the device communicated through lte, cdma, or gsm latitude the latitude where case is currently positioned in degrees longitude the longitude where case is currently positioned in degrees range the measure of error from the latitude/longitude point where case is currently positioned in meters signalstrength the cellular network signal strength where the case is currently positioned in db temperaturea the temperature reported on probe a in celsius