Jetstream API
Device Types
Surface Read Point
6min
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 you can send the following commands to an rfid tray via jetstream name supported get device status docid 0r9xzn3hnqid911qs3wxg yes sync device credentials docid\ l7ik ra1wcy3phhm0fwqs no get all rfid tags docid 7onvtntdtfl9ptdal2nvo yes restart a device docid\ ww54y7kiqnfvyk8zyqakv yes 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 an rfid tray 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 antennatxpower the db transmit power of all of the antennas int 14 23 23 v4 7+ autoupdatefw firmware auto update enable bool 0 1 0 v4 9+ capturetime time in seconds before a tag that enters the field is reported int 1 120 5 v4 7+ commandpollinterval the number of minutes between polling for device commands in jetstream int 0 600 60 v4 7+ commsinterfacerestart the number of minutes after the unit loses communication with jetstream before the ethernet interface is restarted int 1 480 15 v4 9+ commsreboot number of minutes after the system loses communication that it will automatically reboot 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 7+ commstimeout time in seconds to wait for a reply from jetstream after sending an event or command response int 1 300 60 v4 7+ continuous set to true for continuous real time scanning set to false to poll the tray periodically for tags bool 0 1 1 v4 7+ 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 7+ dwelltime time in milliseconds that is spent on each antenna during continuous scanning int 50 5000 200 v4 7+ 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 7+ heartbeateventinterval the number of minutes between sending a heartbeatevent a setting of 0 will disable heartbeatevents int 0 600 60 v4 7+ inactivityinterval time in seconds communications will wait before re establishing a connection if there is no activity int 70 3600 300 v4 7+ 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 7+ jetstreamdeviceurl the url to which the tray sends jetstream messages string us device jetstreamrfid com v4 7+ 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 3 v4 9+ jetstreamwebsocketappendpoint the jetstream resource used to connect for websocket communications using '#' will disable websocket communications string /dwsliveconnection ashx v4 7+ logentrylevel the verbosity of the logs sent by the tray off error warning information string error v4 7+ logfilelevel the verbosity of the logs saved locally on the tray off error warning information verbose trace debug string debug v4 7+ 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 v4 7+ periodicagg activate or deactivate aggregate events for period scans bool 0 1 1 v4 9+ periodicobj activate or deactivate object events for period scans bool 0 1 0 v4 9+ periodicscaninterval dictates the time between the start of each periodic scan in seconds int 0 86400 0 v4 9+ periodicscantime length of the periodic scan in seconds int 0 60 5 v4 9+ readcountthreshold a tag must be seen greater than this number to be reported int 0 1000 0 v4 9+ readerlogentryonfailure generate a logentryevent when communications to the internal rfid reader fails bool 0 1 0 v4 7+ readernumantennas the number of antennas the tray is using int 1 4 4 v4 7+ removeevent sets whether an aggregate event "remove" is sent when a tag leaves the field of scanning bool 0 1 0 v4 7+ scanmode specifies whether the reader should scan in single or dual modes string single v4 9+ securesocket use secure communications over https for the tray bool 0 1 1 v4 7+ 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 7+ events the following are the jetstream events that may come into your queue directly from an rfid tray other events pertaining to, but not generated by, the rfid tray 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 by default, the rfid tray will only return "adds" in its aggregate events "removes" can be enabled by setting the removeevent config parameter to 1 passrfid parameter will always be blank, since the rfid tray does not have a pass reader commandcompletionevent docid\ sj1tshbqvf4fri6az1ywg yes 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 no statusevent docid\ wfpf7d 2jsp7uavkaqvmp yes logentryevents the list below are some potential logentryevent docid\ cclcl11t3bliaiko gtmh an rfid tray 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 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 rfid tray does not generate any sensorreadingevents