Jetstream API
Device Types
Directional Read Point
5min
about directional portals are powerful rfid sensor 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 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 no 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 name description data type min max default ageinterval time in seconds after a tag leaves the field that is reported as out of field int 1 60 3 antennatxpower the db transmit power of all of the antennas int 15 32 23 autoupdate firmware auto update enable bool 0 1 0 capturetime time in seconds before a tag that enters the field is reported int 3 60 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 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 fieldofview sets how scanner sets its range narrow wide string narrow heartbeateventinterval the number of minutes between sending a heartbeatevent int 0 600 60 inactivityinterval time in seconds communications will wait before re establishing a connection if there is no activity int 70 3600 300 jetstreamdeviceurl the url to which the directional portal sends jetstream messages string us device jetstreamrfid com jetstreamwebsocketappendpoint the jetstream resource used to connect for websocket communications using '#' will disable websocket communications string /dwsliveconnection ashx 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 logentrylevel the verbosity of the logs sent by the reader off error warning information verbose string error logfilelevel the verbosity of the logs saved locally on the reader 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 value of 1 disables this feature int 1 23 0 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 readerlogentryonfailure generate a logentryevent when communications to the internal rfid reader fails bool 0 1 0 readermode sets the mode that scanner searches for tags performance sensitivity not applicable when pointmode is "true" string performance 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 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 securesocket use secure communications over https for the reader bool 0 1 1 tagpopulation estimate of number of tags in the field of view at one time not applicable when pointmode is "true" int 1 1000 20 versionsfileurl location of file listing current versions of firmware used to configure auto firmware update string http //firmware tersosolutions com/versions json logentryevents the list below are some common, potential logentryevents a directional portal 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 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