The reader’s command port allows you to query and set advanced reader configuration options from an Ethernet or Wi-Fi connected computer. The command port is accessed using the Telnet protocol and connecting to the reader’s IP Address (default=192.168.0.101) and command port (default=port 9999).
The command port can also be accessed using the micro USB cable when the data switch is in data mode. Simply send the commands below to the com port and the reader will execute them in the same was as if they had been sent to the network command port.
Trident TinyScore can preform most tasks below.
It is recommended that command port commands should be sent programmatically from your sports timing software as manually typing the commands & parameters is very error prone.
All command port commands must be terminated with a <CR><LF>
combination. The reader will respond with the appropriate response as detailed below. Malformed commands will be responded with “CMD UNHANDLED”.
Below are the available command port commands:
SET DATE
Description: Set the reader date & time
Syntax: $SETDATE:<date><CR><LF>
<date>
is in the format YYMMDDHHMMSS, YY=Year, MM=Month, DD=Day, HH=Hours, MM=Minutes, SS=Seconds
Example: $SETDATE:150831131700
Response: DATE:Mon Aug 31 2015 13:17:00
Note: this command sets the time at the moment it is received. For best synchronization, the host which is going to send this command should ready the command for the next second, and then wait until the clock ticks over to that second and immediately send the command. Eg. if the host time is 13:45:23, ready a set date command to set the time to 13:45:24, and as soon as the host clock ticks over to 13:45:24 then send the command at that time.
GET DATE
Description: Retrieve the reader’s current date & time
Syntax: $GETDATE<CR><LF>
Example: $GETDATE
Response: DATE:Mon Aug 31 2015 13:17:00
GET DATE V2 (since Firmware v0.140)
Description: Retrieve the reader’s current date & time with milliseconds
Syntax: $GETDATEV2<CR><LF>
Example: $GETDATEV2
Response: DATE:Mon Aug 31 2015 13:17:00.324
CLEAR HISTORY
Description: Clear the reader’s tag message history files
Syntax: $CLEARHISTORY<CR><LF>
Example: $CLEARHISTORY
Response: HISTORY CLEARED
INSERT MARKER
Description: Insert a timestamp and a text marker string into the Raw, Filtered and Status logs. This marker is not streamed via TCP ports.
Syntax: $IM:<text><CR><LF>
<text>
is the alphanumeric text message inserted into the logs
Example: $IM:Race Now Started
Response: MARKER INSERTED
TUNE REQUEST
Description: Tells the reader to tune all mats
Syntax: $TUNENOW<CR><LF>
Example: $TUNENOW
Response: $TUNE COMMENCED
PASSTHROUGH COMMAND
Description: Sends a command to another module inside or connected to the reader, currently the Transmitters (if attached), external clock (if attached), and power monitor can be targeted. For specific passthrough commands, please contact Trident.
Syntax: $PT_CMD,<dst>,<command><CR><LF>
<dst>
Destination Device, can be TX1, TX2, TX3, TX4, CLK, PM
<command>
Command to pass through to the device
Example: $PT_CMD,TX3,$TXSTATUS
Response: PT_CMD – OK
or PT_CMD - Failed, <reason>
DELAYED PASSTHROUGH COMMAND
Description: Like the passthrough command but delay sending until a particular time.
Syntax: $PT_CMD_DUE,<dst>,<date>,<command><CR><LF>
<dst>
Destination Device, can be TX1, TX2, TX3, TX4, CLK, PM
<command>
Command to pass through to the device
<date>
Date to send the message in YYMMDDHHMMSS
Example: $PT_CMD_DUE,TX3,160926125500,$TXSTATUS
Response: PT_CMD – OK
or PT_CMD - Failed, <reason>
SET TRANSMITTER POWER
Description: Set the transmit power for the DF mats
Syntax: $SETTXPOWER <power><CR><LF>
<power>
Number 1-32
Example: $SETTXPOWER 21
Response: $SETTXPOWER power set to 21
GET TRANSMITTER POWER
Description: Get the current transmit power for the DF mats
Syntax: $GETTXPOWER<CR><LF>
Example: $GETTXPOWER
Response: $GETTXPOWER power set to 21
SET UHF TRANSMITTER POWER
Description: Set the transmit power for the the UHF antennas in dBm
Syntax: $SETUHFPOWER <power><CR><LF>
<power>
Number 1-33dBm
Example: $SETUHFPOWER 30
Response: $SETUHFPOWER power set to 30
GET UHF TRANSMITTER POWER
Description: Get the current transmit power for the UHF antennas in dBm
Syntax: $GETUHFPOWER<CR><LF>
Example: $GETUHFPOWER
Response: $GETUHFPOWER power set to 30
GET READER PARAMETER
Description: Query the current setting of a reader parameter
Syntax: $GETPARAM <param><CR><LF>
<param>
A parameter number like P00
or parameter name like System name
, see configuration options
Example: $GETPARAM system name
Response: $GETPARAM system name=TimeMachine
SET READER PARAMETER
Description: Temporarily set a reader parameter until next system reset.
Syntax: $SETPARAM <param>=<value><CR><LF>
<param>
A parameter number like P00
or parameter name like System name
, see configuration options.
<value>
The value to assign to the parameter.
NOTE: Not all parameters support being set during run time, some can only be set via config.ini. Please see configuration options for more details.
Example: $SETPARAM system name=START LINE!
Response: $SETPARAM system name=START LINE! OK
(or $SETPARAM <param>=<value> <error message>
)
SOFT SYSTEM RESET
Description: Perform a software reset of the system. All parameters are reloaded from config.ini.
Syntax: $RESET_S<CR><LF>
Example: $RESET_S
Response: None.
HARD SYSTEM RESET
Description: Perform a hard power reset of the system. This is similar to the soft reset except that power is cycled to all components of the system (including mats).
Note: this command has no effect in custom installations where the mainboard is being used without the power monitor board.
Syntax: $RESET_H<CR><LF>
Example: $RESET_H
Response: SYSTEM RESET IMMINENT - WATCHDOG DISABLED
REPLAY FILTERED LOG FILE
Description: This command can be used in order to replay filtered.log to the network port (port 10001 by default).
Once the replay has finished, the reader transitions back to live filtered reporting automatically.
Syntax:
$REPLAY<CR><LF>
– replay all available filtered.log
$REPLAY <YYMMDDHHMMSS><CR><LF>
– replay from given date and time
$REPLAY <HH:MM[:SS]><CR><LF>
– replay from given time within the last 24 hours, with optional seconds
$REPLAY stop<CR><LF>
– stop replay immediately
Note: When aborting replay using the stop
command, any tags received since starting the replay (even though they have been written to filtered.log file) will not be sent out of the filtered port, so take care if you abort the replay that you don’t miss out on tags. If tags were missed, use the replay command again to replay them.
GET READER MAC ADDRESS
Description: Query the Ethernet MAC address of the reader. This value can be used as a unique identifier for the reader.
Syntax: $GETREADERMAC<CR><LF>
Example: $GETREADERMAC
Response: $GETREADERMAC OK 70B3D573EFFF
GET READER UNIQUE IDENTIFIER
Description: Query the reader UID (unique identifier). This number is used during locking/unlocking of certain features of the reader. If a unique ID is needed for managing reader boxes or tag database etc, we recommend using the MAC address instead.
Syntax: $GETREADERUID<CR><LF>
Example: $GETREADERUID
Response: $GETREADERUID 01ABCDEF