Jetstream API
Device Types
Surface Read Point
5min
about rfid surface read points are used to track inventory and transactions its sleek, rugged form factor and ease of install allow it to be used in a wide variety of environments where a rfid read point is desired common applications include tracking two bin kanban systems for consumable inventory, or as a check in/check out station to learn more, visit https //www tersosolutions com/products/surface read point/ https //www tersosolutions com/products/surface read point/ model ts082 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 yes restart a device docid 9jcownfudipbznnnryfr0 yes 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 antennatxpower the db transmit power of all of the antennas int 15 23 23 autoupdate firmware auto update enable bool 0 1 0 capturetime time in seconds before a tag that enters the field is reported int 1 120 5 commandpollinterval the number of minutes between polling for device commands in jetstream int 0 600 60 commsreboot number of minutes after the system loses communication that it will automatically reboot int 10 1440 230 commsreconnectinterval time in seconds to wait before attempting to communicate with jetstream if there were any communication problems int 1 300 10 commstimeout time in seconds to wait for a reply from jetstream after sending an event or command response int 1 300 60 continuous set to true for continuous real time scanning set to false to poll the tray periodically for tags bool 0 1 1 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 dwelltime time in milliseconds that is spent on each antenna during continuous scanning int 50 5000 200 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 tray 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 logentrylevel the verbosity of the logs sent by the tray off error warning information verbose string error logfilelevel the verbosity of the logs saved locally on the tray off error warning information verbose trace debug string debug 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 tray 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 5 readerlogentryonfailure generate a logentryevent when communications to the internal rfid reader fails bool 0 1 0 readernumantennas the number of antennas the tray is using int 1 4 4 removeevent sets whether an aggregate even "remove" is sent when a tag leave the field of scanning bool 0 1 0 searchmode mode of scanner set to 1 for dual target mode to be used by continuous scanning set to 1 for dual target or 2 for single target when continuous is set to false for polling int 1 2 1 securesocket use secure communications over https for the tray bool 0 1 1 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 versionsfileurl location of file listing current versions of firmware used to configure auto firmware update string http //firmware tersosolutions com/versions json http //firmware tersosolutions com/versions json logentryevents the list below are some common, potential logentryevents a tray 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 lowflashmemory lowflashmemory occurs when the tray has less than 25% flash memory lowmemory lowmemory occurs when the tray 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 startup startup occurs whenever the tray is started up sensorreadingevents the tray does not generate any sensorreadingevents