Jetstream API
Device Types

Read Point

5min

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

Document image


Commands

ConfigParameters

Name

Description

Data Type

Min

Max

Default

Name

Description

Data Type

Min

Max

Default

AntennaTxPower

The dB transmit power of all of the antennas.

Int

15

32

23

AntennaRxSensitivity

The dB receive sensitivity of all of the antennas.

Int

-80

-30

-70

AutoUpdate

Firmware auto update enable.

Bool

0

1

0

CaptureTime

Time in seconds before a tag that enters the field is reported.

Int

1

120

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

HeartbeatEventInterval

The number of minutes between sending a HeartbeatEvent. A setting of 0 will disable HeartbeatEvents.

Int

0

600

60

InactivityInterval

Time in seconds communications will wait before re-establishing a connection if there is no activity.

Int

0

3600

300

JetstreamDeviceUrl

The URL to which the read point sends Jetstream messages.

String

-

-

JetstreamWebsocketAppEndpoint

The Jetstream resource used to connect for WebSocket communications. Using '#' will disable WebSocket communications.

String

-

-

/dwsliveconnection.ashx

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

NumAntennas

Number of antennas active for reader.

Int

1

4

1

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

ReaderLogEntryOnFailure

Generate a LogEntryEvent when communications to the internal RFID reader fails.

Bool

0

1

0

RemoveEvent

Sets whether an aggregate event "remove" is sent when a tag leaves the field of scanning.

Bool

0

1

0

SecureSocket

Use secure communications over HTTPS for the read point.

Bool

0

1

1

VersionsFileUrl

Location of file listing current versions of firmware. Used to configure auto firmware update.

String

-

-

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 in use determines which LogEntryEvents are sent to Jetstream.

Name

Description

LowFlashMemory

LowFlashMemory occurs when the read point has less than 25% flash memory.

LowMemory

LowMemory 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%.

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 read point is started up.

SensorReadingEvents

The Read Point does not generate any SensorReadingEvents.