Setting and getting config parameters

In order to get/set a config parameter, the host can use these commands:

GETCONFIG;<GROUP>;<SETTING>[;PARAMETERS]<CrLf>
SETCONFIG;<GROUP>;<SETTING>;<PARAMETERS><CrLf> 

Valid <GROUP>s are:

GENERAL

various general settings

NETWORK

network settings

DETECTION

detection menu settings

ACTIVE

configuration regarding the active extension

CLIENTMODE

client mode settings

UPLOAD

configuration of the upload functionality

If the decoder cannot parse the parameters or the parameters are invalid, it responds with

SETCONFIG;<GROUP>;<SETTING>;ERROR

Protocol version

Available since protocol version 1.5

General

Valid <SETTING>s are:

Setting Description

 

Since
protocol
version

 

BOXNAME   

You can give the Decoder a name. The name will be stored and available after reboot.

Set <PARAMETERS>

<NAME>

Desired name

Get response

GETCONFIG;GENERAL;BOXNAME;<Name>;<DeviceId>

Where <Name> is the name of the box and <DeviceId> the ID of the decoder.

1.5

TIMEZONE

Select a different time zone.

Set <PARAMETERS>

<ZONE>

Desired time zone

Note that if the decoder is currently active, it will not change the time zone and respond with:

SETCONFIG;GENERAL;TIMEZONE;OPERATIONMODE 

Get response

GETCONFIG;GENERAL;TIMEZONE;<ZONE>

Where <ZONE> is the currently active time zone. A list of valid time zones is attached.

1.9

STANDBY

You can schedule standby and resume times. This is for permanent installations only.

Set <PARAMETERS>

<Enabled> 1 for True, 0 for False

<Standby>

Daily time to go to standby (hh:mm)

<Resume> Daily time to resume from standby (hh:mm)

Get response

GETCONFIG;GENERAL;STANDBY;<Standby>;<Resume>

Where <Standby> is the time of day (hh:mm) the decoder should go to standby and <Resume> the wake-up time.

2.5

Network

Valid <SETTING>s are:

TCPIP

Set/get the TCP/IP settings.

Set <PARAMETERS> (separated by ;)

[<Interface>] Either ETHERNET OR WIFI.

<Type>

Either DHCP or STATIC.

[<IP>]

Desired IP address, if <Type> == STATIC

[<Netmask>]

Desired net mask, if <Type> == STATIC

[<Gateway>]

Desired gateway address, if <Type> == STATIC

[<Nameserver>]

Desired name server address, if <Type> == STATIC

Set response

SETCONFIG;NETWORK;[Interface;]TCPIP;<Type>[;<ConfiguredIP>;<ConfiguredNetmask>;<ConfiguredGateway>;<ConfiguredNameserver>]

Get response

GETCONFIG;NETWORK;[Interface;]TCPIP;<Type>[;<ConfiguredIP>;<ConfiguredNetmask>;<ConfiguredGateway>;<ConfiguredNameserver>];<ActualIP>;<ActualNetmask>;<ActualGateway>;<ActualNameserver>

Where parameters prefixed with Configured are the configured values. The values prefixed with Actual are the actual settings used by the decoder. If Interface is omitted it defaults to Ethernet. The parameter is available since protocol version 2.1.

Note
When changing the network settings, all TCP/IP connections may be dropped even if the call does not result in an IP address change.

Detection

Valid <SETTING>s are:

SettingDescription
Since
protocol
version

DEADTIME

Dead time (for how long a single transponder is ignored after a detection).

Set <PARAMETERS>

<Time>

Desired dead time in ms (0 - 9999)

Set response

SETCONFIG;DETECTION;DEADTIME;<Time>

Get response

GETCONFIG;DETECTION;DEADTIME;<Time>
1.9

REACTIONTIME

Reaction time (for how long a single passive transponder is observed to determine the measured time).

Set <PARAMETERS>

<Time>

Desired reaction time in ms (0 - 9999)

Set response

SETCONFIG;DETECTION;REACTIONTIME;<Time>

Get response

GETCONFIG;DETECTION;REACTIONTIME;<Time>
1.9

NOTIFICATION

Whether to beep, blink or do both whenever a detection occurs.

Set <PARAMETERS>

<Value>

One of either BEEP+BLINK, BEEP OR BLINK

Set response

SETCONFIG;DETECTION;NOTIFICATION;<Value>

Get response

GETCONFIG;DETECTION;NOTIFICATION;<Value>
1.9

Active

Valid <SETTING>s are:

Setting Description Since
protocol
version

POWER

Loop power of the active extension.

 

Set <PARAMETERS>

<Power>

Desired power (1 - 100)

Set response

SETCONFIG;ACTIVE;POWER;<SelectedPower>[;<ActualPower>]
 

Get response

GETCONFIG;ACTIVE;POWER;<SelectedPower>[;<ActualPower>]

Where <SelectedPower> is the power that should be configured and <ActualPower> the power that the active extension has actually set (only available if active extension is connected).

 

CHANNEL

Selected channel.

 

Set <PARAMETERS>

<Channel>

Desired channel (1 - 8 or AUTO)

Set response

SETCONFIG;ACTIVE;CHANNEL;<SelectedChannel>[;<ActualChannel>]

Get response

GETCONFIG;ACTIVE;CHANNEL;<SelectedChannel>[;<ActualChannel>]

Where <SelectedChannel> is the channel that should be configured and <ActualChannel> the channel that the active extension has actually set (only available if active extension is connected).

 

LOOPID

Selected loop id.

 

Set <PARAMETERS>

<LoopId>

Desired channel (1 - 8 or AUTO)

Set response

SETCONFIG;ACTIVE;LOOPID;<SelectedLoopId>[;<ActualLoopId>]

Get response

GETCONFIG;ACTIVE;LOOPID;<SelectedLoopId>[;<ActualLoopId>]

Where <SelectedLoopId> is the loop id that should be configured and <ActualLoopId> the loop id that the active extension has actually set (only available if active extension is connected).

 

V1LEGACYMODE

Selected V1 legacy mode.

 

Set <PARAMETERS>

<Mode>

Desired mode. (Either OFF, AUTO or ON). Note that the GETCONFIG call might also return UNKNOWN.

Set response

SETCONFIG;ACTIVE;V1LEGACYMODE;<SelectedMode>[;<ActualMode>]

Get response

GETCONFIG;ACTIVE;V1LEGACYMODE;<SelectedMode>[;<ActualMode>]

Where <SelectedMode> is the mode that should be configured and <ActualMode> the mode that the currently active (only available if active extension is connected). Note: If the latter is not up to date, call GETCONFIG a few seconds after SETCONFIG to get the updated actual value.

2.9

Client Mode

Valid <SETTING>s are:

HOST;<HostNum>

Set/get host entry <HostNum> (1 -> 10).

Set <PARAMETERS> (separated by ;)

<Configure>

1, if the host should be configured, 0 if the host should be marked as not configured

<Host>

Name or IP of host to connect to

<Port>

Port to connect to

<KeepAlive>

Time in seconds, after the decoder reestablishes the connection, if no command was received

<AutoStart>

Automatically establish connection after boot

Set response

SETCONFIG;CLIENTMODE;HOST;<HostNum>;<Configure>;<Host>;<Port>;<KeepAlive>;<AutoStart>    

Get response

GETCONFIG;CLIENTMODE;HOST;<HostNum>;<Configure>;<Host>;<Port>;<KeepAlive>;<AutoStart>;<IsConnected>

Where <IsConnected> is 1, if the connection is currently established, 0 otherwise.

USEUPLOADGPRSSETTINGS

Specifies whether the decoder should use the upload connection settings when connecting to a host. This can be used to use establish a GPRS connection.

Set <PARAMETERS>

<UseSettings>

1, if upload settings should be used, 0 (default) otherwise

Set response

SETCONFIG;CLIENTMODE;USEUPLOADGPRSSETTINGS;<UseSettings>

Get response

GETCONFIG;CLIENTMODE;USEUPLOADGPRSSETTINGS;<UseSettings>

Upload

Valid <SETTING>s are:

Setting Description Since version

CONNECTION

Specify how the connection should be established when uploading data through HTTP/TCP.

Set <PARAMETERS>

<Value>

ETHERNET if you want to use an Ethernet connection)
GPRS_AUTO if you want to upload the data using GPRS in autoconfigure mode)
GPRS_MANUAL if GPRS should be used using the manual configuration)

 
CUSTNO

 

Specify which RACE RESULT customer number should be used when uploading data through HTTP/TCP.

Set <PARAMETERS>

 

 
<CustNo> Desired customer number.

Set response

SETCONFIG;UPLOAD;CUSTNO;12345

 

Get response

GETCONFIG;UPLOAD;CUSTNO;12345
2.1

UHF

Valid <SETTING>s are:

Setting Description Since version

FREQUENCY;<FrequencyIndex>

<PARAMETERS> (separated by ;)

<FrequencyIndex>

As described in GETSTATUS

<Caption>

Caption of frequency as displayed on the decoder screen

<MinFrequency>

Minimal frequency of the selected range in KHz

<MaxFrequency>

Maximum frequency of the selected range in KHz

Set response

SETCONFIG;UHF;FREQUENCY;<FrequencyIndex>

Get response

GETCONFIG;UHF;FREQUENCY;<FrequencyIndex>;<Caption>;<MinFrequency>;<MaxFrequency>

Note that the frequency change will be applied in the background. Until settings are applied the GETCONFIG call will return the previously active values. When getting the frequency and the region does not support setting the frequency, -1 is returned for <FrequencyIndex> and an empty string for <Caption>.

2.7