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.

NameSupported
Get Device StatusYes
Sync Device CredentialsNo
Get All RFID TagsNo
Restart a DeviceYes
Lockdown a DeviceNo
Unlock a Device’s DoorNo
Get Device Config ParametersYes
Set Device Config ParametersYes

ConfigParameters

The defaults listed here are for an overhead install of the read point, where the desired behavior is to report any tags within it's 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, follow this guide. Terso Support can also manage these configuration settings for you.

NameDescriptionData TypeMinMaxDefaultFirmware
AntennaRxSensitivityThe dB receive sensitivity of all of the antennas.Int-80-30-70v4.7.2+
AntennaTxPowerThe dB transmit power of all of the antennas.Int153223v4.7.2+
AutoUpdateFirmware auto update enable.Bool010v4.7.2+
CaptureTimeTime in seconds before a tag that enters the field is reported.Int11205v4.7.2+
CommandPollIntervalThe number of minutes between polling for device commands in Jetstream.Int060060v4.7.2+
CommsRebootNumber of minutes after the system loses communication that it will automatically reboot.Int101440230v4.7.2+
CommsReconnectIntervalTime in seconds to wait before attempting to communicate with Jetstream if there were any communication problems.Int130010v4.7.2+
CommsTimeoutTime in seconds to wait for a reply from Jetstream after sending an event or command response.Int130060v4.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--Widev4.7.28+
HeartbeatEventIntervalThe number of minutes between sending a HeartbeatEvent. A setting of 0 will disable HeartbeatEvents.Int060060v4.7.2+
InactivityIntervalTime in seconds communications will wait before re-establishing a connection if there is no activity.Int703600300v4.7.2+
JetstreamDeviceUrlThe URL to which the read point sends Jetstream messages.String--us-device.jetstreamrfid.comv4.7.2+
JetstreamWebsocketAppEndpointThe Jetstream resource used to connect for WebSocket communications. Using '#' will disable WebSocket communications.String--/dwsliveconnection.ashxv4.7.2+
LogEntryLevelThe verbosity of the logs sent by the reader
  • Off
  • Error
  • Warning
  • Information
String--Errorv4.7.2+
LogFileLevelThe verbosity of the logs saved locally on the reader
  • Off
  • Error
  • Warning
  • Information
  • Verbose
  • Trace
  • Debug
String--Debugv4.7.2+
ObjectEventHourThe hour to perform the daily system scan as well as other system checks. A value of -1 disables this feature.Int-1230v4.7.2+
ReaderLogEntryOnFailureGenerate a LogEntryEvent when communications to the internal RFID reader fails.Bool011v4.7.2+
ReleaseTimeThe 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.Int08640060v4.7.28+
RemoveEventSets whether an aggregate event "remove" is sent when a tag leaves the field of scanning.Bool010v4.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--Dualv4.7.28+
SecureSocketUse secure communications over HTTPS for the read point.Bool011v4.7.2+
VersionsFileUrlLocation of file listing current versions of firmware. Used to configure auto firmware update.String--http://firmware.tersosolutions.com/versions.jsonv4.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 to see a complete list of which events are from a device and which come from the Jetstream application.

Name

Supported

Notes

AggregateEventYesBy default, the readpoint will only return "Adds" in it's 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.
CommandCompletionEventYes
HeartbeatEventYesThese can be disabled by setting the HeartbeatEventInterval Config Parameter to 0.
LogEntryEventYesThese 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.
ObjectEventYesThese can be disabled by setting the ObjectEventHour Config Parameter to -1.
SensorReadingEventNo
StatusEventYes

LogEntryEvents

The list below are some common, potential LogEntryEvents 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.

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

SensorReadingEvents

The Read Point does not generate any SensorReadingEvents.