API Access

The Reader Box can be interfaced using the serial cable (optional) or a standard SSH client.

115200, 8 N 1

Username: root
Password: rfid4ever_vr

Use the IP address/hostname provided on the Reader Box and the default username and password to SSH into the unit.

SSH <IP Address> -p 2222

Once logged on, Telnet to localhost on port 2020 to communicate with the Reader driver.

telnet localhost 2020

The Reader Box will send a Banner with Version Information and Session value, as soon as a client is connected. From then onwards, the Client can issue any of the commands described in the Command Set section below. After each command the unit will respond with an ACK or NACK.

Commands are executed on receipt of ASCII CR, LF, or CRLF combination. All responses from the unit begin with an echo of the sent command, a semicolon; and then either “ACK” or “NACK” depending on if the command was received and completed correctly. The command response ends with the system prompt: [CR][LF]>[space]. Commands are not case-sensitive. For example:

get build[CR][LF]
get build;ACK,r672
>

Additionally, asynchronous events that are not the result of commands, such as I/O events, heartbeat messages, or RFID tag read events, will come in without any interaction from the application. These have a special format that is defined in the Events section.