Jetstream API
Device Types

Read Point

7min
about read points are powerful rfid sensors that can be mounted almost anywhere to track rfid tags passing through the sensors range the most common configurations include doorway mounted portals that track the movement of tags in and out of the room, and ceiling or wall mounted portals that track the sighting of tags in a particular location model ts090 read point variations, ts087 directional read point when used in read point mode commands you can send the following commands to a read point via jetstream name supported get device status docid 0r9xzn3hnqid911qs3wxg yes sync device credentials docid\ l7ik ra1wcy3phhm0fwqs no get all rfid tags docid 7onvtntdtfl9ptdal2nvo no 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 defaults listed here are for an overhead install of the read point, where the desired behavior is to report any tags within its read range as 'seen' terso will provide different recommended defaults if the read point is wall mounted, installed at a dock door, being used to explicitly track item removal, or configured in some other novel way to suit your requirements and environment the following are the parameters that can be configured for a read point 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 antennarxsensitivity the db receive sensitivity of all of the antennas int 80 30 70 v4 7 2+ antennatxpower the db transmit power of all of the antennas int 15 32 23 v4 7 2+ autoupdate firmware auto update enable bool 0 1 0 v4 7 2+ capturetime time in seconds before a tag that enters the field is reported int 1 120 5 v4 7 2+ commandpollinterval the number of minutes between polling for device commands in jetstream int 0 600 60 v4 7 2+ commsreboot number of minutes after the system loses communication that it will automatically reboot int 10 1440 230 v4 7 2+ commsreconnectinterval time in seconds to wait before attempting to communicate with jetstream if there were any communication problems int 1 300 10 v4 7 2+ commstimeout time in seconds to wait for a reply from jetstream after sending an event or command response int 1 300 60 v4 7 2+ fieldofview only applies to ts087 when running as a read point with ts090, this parameter is ignored narrow wide narrow turns off the outside 3 antennas on each side wide turns on all antennas string wide v4 7 28+ heartbeateventinterval the number of minutes between sending a heartbeatevent a setting of 0 will disable heartbeatevents int 0 600 60 v4 7 2+ inactivityinterval time in seconds communications will wait before re establishing a connection if there is no activity int 70 3600 300 v4 7 2+ jetstreamdeviceurl the url to which the read point sends jetstream messages string us device jetstreamrfid com v4 7 2+ jetstreamwebsocketappendpoint the jetstream resource used to connect for websocket communications using '#' will disable websocket communications string /dwsliveconnection ashx v4 7 2+ logentrylevel the verbosity of the logs sent by the reader off error warning information string error v4 7 2+ logfilelevel the verbosity of the logs saved locally on the reader off error warning information verbose trace debug string debug v4 7 2+ objecteventhour the hour to perform the daily system scan as well as other system checks a value of 1 disables this feature int 1 23 0 v4 7 2+ readerlogentryonfailure generate a logentryevent when communications to the internal rfid reader fails bool 0 1 1 v4 7 2+ releasetime the time in seconds after a tag lease the field before the firmware releases it from the internal list this prevents tags that are sitting in the field from being reported more than once int 0 86400 60 v4 7 28+ removeevent sets whether an aggregate event "remove" is sent when a tag leaves the field of scanning bool 0 1 0 v4 7 2+ scanmode the rain standard scan mode to use single dual suppression single will suppress tags for about 1 second this mode should be used for large tag populations, especially if they remain in the field for for more than a few seconds dual reads tags all of the time this mode should be used for small tag populations that are moving through the field suppression will suppress tags for a longer period of time suppression only works with tags with certain impinj tag chips string dual v4 7 28+ securesocket use secure communications over https for the read point bool 0 1 1 v4 7 2+ versionsfileurl location of file listing current versions of firmware used to configure auto firmware update string http //firmware tersosolutions com/versions json v4 7 2+ events the following are the jetstream events that may come into your queue directly from a read point other events pertaining to, but not generated by, the read point 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 readpoint 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 read point 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 common, potential logentryevent docid\ cclcl11t3bliaiko gtmh a read point 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 read point has less than 25% flash memory lowmemory lowmemory occurs when the read point 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 read point is started up sensorreadingevents the read point does not generate any sensorreadingevents