Directional Portal

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.

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.tersosolutions.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 setting of -1 will disable ObjectEvents. 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. 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

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.