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/.

Model: TS087

Commands

ConfigParameters

NameDescriptionData TypeMinMaxDefaultFirmware
AgeIntervalTime in seconds after a tag leaves the field that is reported as out of field.Int1603v4.7+
AntennaTxPowerThe dB transmit power of all of the antennas.Int153025v4.7+
AutoUpdateFirmware auto update enable.Bool010v4.7+
CaptureTimeTime in seconds before a tag that enters the field is reported.Int3605v4.7+
CommandPollIntervalThe number of minutes between polling for device commands in Jetstream.Int060060v4.7+
CommsRebootNumber of minutes after the system loses communication that it will automatically reboot.Int101440230v4.7+
CommsReconnectIntervalTime in seconds to wait before attempting to communicate with Jetstream if there were any communication problems.Int130010v4.7+
CommsTimeoutTime in seconds to wait for a reply from Jetstream after sending an event or command response.Int130060v4.7+
DirectionFlagUsed to reverse the direction that an "add" or "remove" is reported in aggregate event. Not applicable when PointMode is "true".Bool010v4.7+
FieldOfViewSets how scanner sets its range
  • Narrow
  • Wide
String--Narrowv4.7+
HeartbeatEventIntervalThe number of minutes between sending a HeartbeatEvent.Int060060v4.7+
InactivityIntervalTime in seconds communications will wait before re-establishing a connection if there is no activity.Int703600300v4.7+
JetstreamDeviceUrlThe URL to which the directional portal sends Jetstream messages.String--us-device.jetstreamrfid.comv4.7+
JetstreamWebsocketAppEndpointThe Jetstream resource used to connect for WebSocket communications. Using '#' will disable WebSocket communications.String--/dwsliveconnection.ashxv4.7+
LingerTimeTime 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".Int030030v4.7+
LogEntryLevelThe verbosity of the logs sent by the reader
  • Off
  • Error
  • Warning
  • Information
String--Errorv4.7+
LogFileLevelThe verbosity of the logs saved locally on the reader
  • Off
  • Error
  • Warning
  • Information
  • Verbose
  • Trace
  • Debug
String--Offv4.7+
ObjectEventHourThe hour to perform the daily system scan as well as other system checks. A value of -1 disables this feature.Int-1230v4.7+
PointModeWhen 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.Bool010v4.7+
ReaderLogEntryOnFailureGenerate a LogEntryEvent when communications to the internal RFID reader fails.Bool011v4.7+
ReaderModeSets the mode that scanner searches for tags
  • Performance
  • Sensitivity
Not applicable when PointMode is "true".
String--Performancev4.7+
RemoveEventSets whether an aggregate event "remove" is sent when a tag leaves the field of scanning. Not applicable when PointMode is "false".Bool010v4.7+
SameSectorLogEntryIf 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".Bool010v4.7+
SecureSocketUse secure communications over HTTPS for the reader.Bool011v4.7+
TagPopulationEstimate of number of tags in the field of view at one time. Not applicable when PointMode is "true".Int1100020v4.7+
VersionsFileUrlLocation of file listing current versions of firmware. Used to configure auto firmware update.String--http://firmware.tersosolutions.com/versions.jsonv4.7+

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.

NameDescription
LowFlashMemoryLowFlashMemory occurs when the directional portal has less than 25% flash memory.
LowMemoryLowMemory 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%.
NewFirmwareDownloadErrorNewFirmwareDownloadError occurs when a request to upgrade firmware fails.
ReadExceptionReadException occurs when there is an issue performing an RFID scan.
StartupStartup occurs whenever the directional portal is started up.

SensorReadingEvents

The Directional Portal does not generate any SensorReadingEvents.