Jetstream API
Device Types
Directional Read Point
6min
about directional portals 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 sightings of tags in a particular location to learn more, visit https //www tersosolutions com/products/rfid directional read point/ https //www tersosolutions com/products/rfid directional read point/ model ts087 directional read point (when used in directional mode) when used in read point mode use "read point" device type commands you can send the following commands to a directional portal 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 you can specify the following parameters for you directional portal 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 ageinterval time in seconds after a tag leaves the field that is reported as out of field int 1 60 3 v4 7+ antennatxpower the db transmit power of all of the antennas int 15 30 25 v4 7+ autoupdate firmware auto update enable bool 0 1 0 v4 7+ capturetime time in seconds before a tag that enters the field is reported int 3 60 5 v4 7+ commandpollinterval the number of minutes between polling for device commands in jetstream int 0 600 60 v4 7+ 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+ directionflag used to reverse the direction that an "add" or "remove" is reported in aggregate event not applicable when pointmode is "true" bool 0 1 0 v4 7+ fieldofview sets how scanner sets its range narrow wide string narrow v4 7+ finalsector when tags are expected to be left in the field of view, this is the sector where they will be 0 2 3 0 is off or tags are not expected to be left in field 2 is the end of device with the led on the case 3 is the opposite side int 0 3 0 v7 4 25+ heartbeateventinterval the number of minutes between sending a heartbeatevent 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+ jetstreamdeviceurl the url to which the directional portal sends jetstream messages string us device jetstreamrfid com v4 7+ jetstreamwebsocketappendpoint the jetstream resource used to connect for websocket communications using '#' will disable websocket communications string /dwsliveconnection ashx v4 7+ lingertime time in seconds that a tag can "linger" under scanner before it is reported used to help with excessive reporting when a tag is directly under scanner and is picked up going back and forth not applicable when pointmode is "true" int 0 300 30 v4 7+ logentrylevel the verbosity of the logs sent by the reader off error warning information string error v4 7+ logfilelevel the verbosity of the logs saved locally on the reader off error warning information verbose trace debug string off v4 7+ loitertime when finalsector is 2 or 3, this is the time in seconds before a tag will be reported once it enters final sector int 0 60 0 v4 7 25+ 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+ pointmode when set to true, the device will send events when tags are simply in field of view when set to false the device will send directional information bool 0 1 0 v4 7+ readerlogentryonfailure generate a logentryevent when communications to the internal rfid reader fails bool 0 1 1 v4 7+ readermode sets the mode that scanner searches for tags performance sensitivity not applicable when pointmode is "true" string performance v4 7+ removeevent sets whether an aggregate event "remove" is sent when a tag leaves the field of scanning not applicable when pointmode is "false" bool 0 1 0 v4 7+ samesectorlogentry if set to true, the device will report that a tag exited the field in the same direction as it entered not applicable when pointmode is "true" bool 0 1 0 v4 7+ securesocket use secure communications over https for the reader bool 0 1 1 v4 7+ tagpopulation estimate of number of tags in the field of view at one time not applicable when pointmode is "true" int 1 1000 20 v4 7+ versionsfileurl location of file listing current versions of firmware used to configure auto firmware update string http //firmware tersosolutions com/versions json v4 7+ events the following are the jetstream events that may come into your queue directly from a directional portal other events pertaining to, but not generated by, the directional portal 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 pointmode config parameter to 1 the directional interpretation of add and remove in the aggregateevents can be flipped via the directionflag config parameter passrfid parameter will always be blank, since the directional portal 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 disabled by default, these can be enabled by setting the pointmode config parameter to 1 this will disable aggregateevents sensorreadingevent docid\ rgpeiorzuhkz9iqamwxmp no statusevent docid\ wfpf7d 2jsp7uavkaqvmp yes logentryevents the list below are some common, potential logentryevent docid\ cclcl11t3bliaiko gtmh a directional portal 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 directional portal has less than 25% flash memory lowmemory lowmemory occurs when the directional portal 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 directional portal is started up sensorreadingevents the directional portal does not generate any sensorreadingevents