Last modified 2 years ago Last modified on 31/03/17 14:55:16

RCLL Referee Box Configuration

The refbox supports several configuration values that are stored in the cfg/config.yaml file in YAML format. YAML is a structured document format. For the configuration, especially note that the indentation is crucial. The document forms a tree where values are addressed by paths. Especially network related parameters might need to be changed.

YAML Example

A simple excerpt of the configuration file is used to explain the YAML structure.

    level: debug
    general: refbox.log

This defines two configuration values. One has the path /llsfrb/log/level and the value is debug. The second is /llsfrb/log/general with the value refbox.log. The types of the values are implicitly determined to be one of unsigned integer, signed integer, float, boolean (true or false) or string (in that detection order).

Configuration Values

PathTypeDefault ValueDescription
levelstringdebuglog level, one of debug, info, warn, error
generalstringrefbox.loglog file for general log messages
clipsstringclips.logLog output of the CLIPS system
gamestringgame.logGame relevant messages, e.g. points awarded
enableboolfalsetrue to enable SPS/PLC support, false to run without
hoststring!ipv4 or IP address of the SPS/PLC
portunsigned int!tcp-port 502TCP port on the SPS/PLC for modbus access
test-lightsboolfalseLight pattern to test signals on startup?
timer-intervalunsigned int40Period in milliseconds in which CLIPS is triggered
mainstringrefboxThe main file to load
debugboolfalseEnable CLIPS debugging, i.e. watching of facts and rules
debug-levelunsigned int2debug levels: 0 ~ none, 1 ~ minimal, 2 ~ more, 3 ~ maximum
unwatch-factslist of strings[time, rfid-input, signal, gamestate]Fact templates not to watch if debugging is enabled
unwatch-ruleslist of strings[retract-time, rfid-input-cleanup, net-send-beacon,
update-gametime, update-last-time, net-send-GameState,
net-send-OrderInfo, net-send-MachineInfo, net-send-PuckInfo,
net-send-RobotInfo, exploration-send-MachineReportInfo]
Rules not to watch if debugging is enabled
server-portunsigned int!tcp-port 4444TCP port the refbox listens on for controller connections.
peer-hoststring!ipv4 communication broadcast address. You will most likely need to change this.
peer-portunsigned int!udp-port 4444peer communication UDP port. If peer-send-port or peer-recv-port are not set the refbox will listen on and send to this port
peer-send-portunsigned int!udp-port 4444If set in combination with peer-recv-port the refbox will send broadcast data to this UDP port.
peer-recv-portunsigned int !udp-port 4445If set in combination with peer-send-port the refbox will list for broadcast data on this UDP port.

Further Information

For more information of the configuration file please read about the Fawkes configuration, which is using the same format and library.