Surface Read Point
About
RFID Surface Read Points are used to track inventory and transactions. It's sleek, rugged form factor and ease of install allow it to be used in a wide variety of environments where a RFID read point is desired. Common applications include tracking two-bin kanban systems for consumable inventory, or as a check-in/check-out station. To learn more, visit https://www.tersosolutions.com/products/surface-read-point/.
Model: TS082
Commands
You can send the following commands to an RFID Tray via Jetstream.
ConfigParameters
The following are the parameters that can be configured for an RFID Tray 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.
| Name | Description | Data Type | Min | Max | Default | Firmware |
|---|---|---|---|---|---|---|
| AntennaTxPower | The dB transmit power of all of the antennas. | Int | 14 | 23 | 23 | 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 | 1 | 120 | 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+ |
| Continuous | Set to true for continuous real-time scanning. Set to false to poll the tray periodically for tags. | Bool | 0 | 1 | 1 | v4.7+ |
| DNS | The DNS to be used in a static LAN environment. When set to '0.0.0.0', the DHCP assigned DNS server is used instead. | IP Address | 0.0.0.0 | 255.255.255.255 | 0.0.0.0 | v4.7+ |
| DwellTime | Time in milliseconds that is spent on each antenna during continuous scanning. | Int | 50 | 5000 | 200 | v4.7+ |
| Gateway | The gateway address to be used in a static LAN environment. When set to '0.0.0.0', the DHCP assigned Gateway address is used instead. | IP Address | 0.0.0.0 | 255.255.255.255 | 0.0.0.0 | v4.7+ |
| HeartbeatEventInterval | The number of minutes between sending a HeartbeatEvent. A setting of 0 will disable HeartbeatEvents. | 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+ |
| IP | The IP address to be used in a static LAN environment. When set to '0.0.0.0', the DHCP assigned IP address is used instead. | IP Address | 0.0.0.0 | 255.255.255.255 | 0.0.0.0 | v4.7+ |
| JetstreamDeviceUrl | The URL to which the tray 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+ |
| LogEntryLevel | The verbosity of the logs sent by the tray
| String | - | - | Error | v4.7+ |
| LogFileLevel | The verbosity of the logs saved locally on the tray
| String | - | - | Debug | v4.7+ |
| 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 | v4.7+ |
| ObjectEventScanCount | The number of times to scan during a GetEPCListCommand or during the daily system scan. | Int | 1 | 100 | 2 | v4.7+ |
| ObjectEventScanDelay | Number of seconds the tray should wait between scans. | Int | 1 | 60 | 1 | v4.7+ |
| ObjectEventScanTime | The time in seconds for each scan during a GetEPCListCommand or during the daily system scan. | Int | 1 | 300 | 5 | v4.7+ |
| ReaderLogEntryOnFailure | Generate a LogEntryEvent when communications to the internal RFID reader fails. | Bool | 0 | 1 | 0 | v4.7+ |
| ReaderNumAntennas | The number of antennas the tray is using. | Int | 1 | 4 | 4 | v4.7+ |
| RemoveEvent | Sets whether an aggregate event "remove" is sent when a tag leaves the field of scanning. | Bool | 0 | 1 | 0 | v4.7+ |
| SearchMode | Mode of scanner. Set to 1 for dual target mode to be used by continuous scanning. Set to 1 for dual target or 2 for single target when continuous is set to false for polling. | Int | 1 | 2 | 1 | v4.7+ |
| SecureSocket | Use secure communications over HTTPS for the tray. | Bool | 0 | 1 | 1 | v4.7+ |
| Subnet | The subnet address to be used in a static LAN environment. When set to '0.0.0.0', the DHCP assigned subnet is used instead. | IP Address | 0.0.0.0 | 255.255.255.255 | 0.0.0.0 | 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 an RFID Tray. Other events pertaining to, but not generated by, the RFID Tray 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 |
|---|---|---|
| AggregateEvent | Yes | By default, the RFID Tray 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 RFID Tray does not have a pass reader. |
| CommandCompletionEvent | Yes | |
| HeartbeatEvent | Yes | These can be disabled by setting the HeartbeatEventInterval Config Parameter to 0. |
| LogEntryEvent | 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 | Yes | These can be disabled by setting the ObjectEventHour Config Parameter to -1. |
| SensorReadingEvent | No | |
| StatusEvent | Yes |
LogEntryEvents
The list below are some potential LogEntryEvents an RFID Tray 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 tray has less than 25% flash memory. |
| LowMemory | LowMemory occurs when the tray 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 tray is started up. |
SensorReadingEvents
The RFID Tray does not generate any SensorReadingEvents.