Jetstream API
Device Types

Mobile Case

7min
about rfid mobile cases are jetstream enabled devices used to transport, protect, and track field or mobile inventory these devices not only support many standard 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 you can send the following commands to a mobile case via jetstream note that the mobile case is only on after being shut, or during its nightly scan, so commands may take up to 24 hours to complete, even when the mobile case is healthy name supported get device status docid 0r9xzn3hnqid911qs3wxg no sync device credentials docid\ l7ik ra1wcy3phhm0fwqs no get all rfid tags docid 7onvtntdtfl9ptdal2nvo no restart a device docid\ ww54y7kiqnfvyk8zyqakv no lockdown a device docid\ vboyeohcjlpy 7zr afgz no unlock a device's door docid 1 ro5cpawezhguxfhofai no 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 no set configuration values for a device docid\ ime76bwc91dxcc4gvdyz8 yes configparameters the following are the parameters that can be configured for a mobile case 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 aggregateeventscancount number of times the case should scan after an end user closes the lid int 1 100 2 v4 7+ aggregateeventscandelay number of seconds the case should wait between scans after an end user closes the lid int 1 60 1 v4 7+ aggregateeventscantime the time of each individual scan in seconds after an end user closes the lid int 1 300 2 v4 7+ antennatxpower the db transmit power of all antennas int 10 23 23 v4 7+ 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 v4 7+ batteryled enable the led to indicate battery level bool 0 1 0 v4 7+ 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 v4 7+ commsreconnectinterval time in seconds to wait before attempting to communicate with jetstream if there were any communication problems int 0 60 10 v4 7+ commstimeout time in seconds to wait for a reply from jetstream after sending an event or command response int 0 60 10 v4 7+ connectretries number of times to retry connecting to the cellular network int 1 5 3 v4 7+ jetstreamdeviceurl the url to which the case sends jetstream messages string us device jetstreamrfid com v4 7+ 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+ lidclosedshutdowntime the number of seconds to wait after the lid is closed before automatically shutting down to conserve power int 1 600 30 v4 7+ lidopentimelimit the number of seconds to wait while the lid remains open before automatically shutting down to conserve power int 1 600 300 v4 7+ locationservice use location based services for the case the geolocation of the case will be sent in a sensorreadingevent bool 0 1 1 v4 7+ logentrylevel the verbosity of the logs sent by the case off error warning information string off information error v4 7+ logfilelevel the verbosity of the logs saved locally on the case off error warning information verbose trace debug string off debug off v4 7+ objecteventhour the hour to perform the daily system scan as well as other system checks int 1 23 0 v4 7+ objecteventonly when true, all scans are reported as objectevent otherwise, lid open/close report as aggregateevents bool 0 1 0 v4 7+ objecteventscancount the number of times to scan during a getepclistcommand or during the daily system scan int 1 100 2 v4 7+ objecteventscandelay number of times the case should wait between scans after an end user closes the lid int 1 60 1 v4 7+ objecteventscantime the time in seconds for each scan during a getepclistcommand or during the daily system scan int 1 300 2 v4 7+ operationled enable the led to indicate operation state bool 0 1 0 v4 7+ rangelimit when the range received from the location service is greater than this number, it will disconnect the cell, and reconnect for 2 retries if it does not get below the range specified, "na" will be returned in the sensorreadingevent int 0 9999 5000 v4 8+ readerlogentryonfailure generate a logentryevent when communications to the internal rfid reader fails bool 0 1 1 v4 7+ regioncode the region determines the rfid frequency of operation string fcc v4 8+ securesocket use secure communications over https for the case bool 0 1 1 v4 7+ sensoralogentryeventhightemp high temperature threshold in celsius for probe a to send a logentryevent int 100 100 100 v4 7+ sensoralogentryeventlowtemp low temperature threshold in celsius for probe a to send a logentryevent int 100 100 100 v4 7+ sensorreadingeventinterval the number of minutes between sending a sensorreadingevent int 0 1440 60 v4 7+ tempoffset the offset, in degrees celsius, to apply to the temperature readings from temperature probe a int 100 100 0 v4 8+ tempsensor the event that triggers a temperature reading none the device will never take or report temperature lid the device will record and report temperature every time the lid is closed string none lid none v4 7+ events the following are the jetstream events that may come into your queue directly from a mobile case other events pertaining to, but not generated by, the mobile case 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 these can be disabled by setting the objecteventonly config parameter to 1, which will result in a complete objectevent scan being taken every time the mobile case is closed, instead of an aggregate event passrfid parameter will always be blank, since the mobile case does have have a pass reader commandcompletionevent docid\ sj1tshbqvf4fri6az1ywg yes heartbeatevent docid\ g o0yv1ty07c7b ce rdw no heartbeatevents are unavailable for mobile cases in order to extend battery life 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 logentryevents the list below are some common, potential logentryevent docid\ cclcl11t3bliaiko gtmh a mobile case 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 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 mobile 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 case 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