Skip to content

Latest commit

 

History

History
177 lines (128 loc) · 8.54 KB

README.md

File metadata and controls

177 lines (128 loc) · 8.54 KB
Raw

CircleCI Go Report Card Go Doc Release Coverage

ssl-game-controller

The game controller for matches in the RoboCup Small Size league, introduced at RoboCup 2019 as a replacement of the ssl-refbox.

Screenshot of Interface

Add your team name

If you are a new team, please add your team name to internal/app/engine/config.go.

Usage

If you just want to use this app, simply download the latest release binary. The binary is self-contained. No dependencies are required.

You can also use pre-build docker images:

docker pull robocupssl/ssl-game-controller
# Run GC with default configuration
docker run -p 8081:8081 robocupssl/ssl-game-controller -address :8081
# Mount local directories
docker run -p 8081:8081 \
  # Local config dir
  -v "$(pwd)"/config:/config \
  # Local data dir (current state)
  -v "$(pwd)"/data:/data \
  robocupssl/ssl-game-controller

The controller will generate a default config to config/ on the first start. Afterwards, you can change all settings there.

For example, if you want to add a new team name temporarily, you can add it to config/engine.yaml. If you want to add your team persistently, add it to defaultTeams in internal/app/engine/config.go and create a pull request on GitHub.

Runtime Requirements

  • No software dependencies (except for development, see below)
  • pre-build binaries: 64bit Linux, Windows, OSX
  • A reasonable Web-Browser (mostly tested on Chrome)

External Runtime Dependencies

ssl-vision - Receive Geometry packages for correct field dimensions.
If not available, make sure to configure the correct dimensions in config/ssl-game-controller.yaml.

tracker-source implementation that produces TrackerWrapperPacket - Get ball and robot positions.
Required for:

  • Check ball placement progress
  • Check for correct number of robots per team
  • Check if game can continue (ball and robots prepared)
  • Check for "no progress"
  • Check if keeper may be changed via team protocol

The TIGERs AutoRef and the ER-Force AutoRef are tracker-source implementations. If no tracker-source is available, the above features will not work.

Reference Clients

There are some reference clients:

Integration into your own framework

The game-controller is designed to be integrated into your own AI framework, if you do not want to implement your own controller for testing purposes.

Download the release binary from the Github release and run it from inside your framework. You can adapt the ssl-game-controller.yaml config file that is generated on first startup, like changing the default ports. Some parameters can also be passed via command line. Find the available parameters with the -h option. Make sure to use non-standard ports whenever possible to avoid any interference with a real field setup.

There are three modes that you can run the ssl-game-controller with:

  1. system (default): Use system time
  2. vision: Receive messages from ssl-vision and use the timestamps from these messages as the time source. This is mostly useful, when you produce your own ssl-vision frames from simulation.
  3. ci: Connect your software directly to the GC via TCP. You send the current timestamp and tracker packets and will receive the resulting referee message.

It is highly recommended using the ci mode when you integrate the GC with your own simulator. It has the following advantages:

  1. No multicast network traffic is required that might be published to your local network (make sure to unset network.publish-address)
  2. You have full control of the data flow. The GC will not do anything asynchronously in the background
  3. You define the time and thus the speed.
  4. You provide the ssl-vision tracking data directly.

If you use external simulators like grSim, you can consider using the vision mode instead. That way, the game-controller uses the time and speed of the simulator, even if it is not running in real time. You then still need to run a tracking-source implementation like an AutoRef if you require the additional features described in [External Runtime Dependencies](#External Runtime Dependencies).

When you enable ci mode, referee messages will still be published via multicast, unless the address is unset (set to an empty string). That way, you can still integrate an autoRef or other software. Have a look at Auto-referee CI for details on how to integrate the auto-referees in a CI way as well.

When the ci mode is enabled (via ssl-game-controller.yaml -> time-acquisition-mode), a TCP port is opened (default: 10009). The protocol is defined in proto/ssl_gc_ci.proto. You send CiInput messages and receive CiOutput messages. The protocol is the same as for the team-client. Each input will produce one or more outputs. This is, because some changes will generate multiple messages. CiOutput messages will also be pushed to the CI client for manual changes from the UI or UI API.

The GC requires some input data, see [External Runtime Dependencies](#External Runtime Dependencies). In the ci mode, you have to provide the geometry statically in config/ssl-game-controller.yaml or send it through CiInput. The ball and robot positions must be sent with the CiInput. It is sufficient to fill in the required fields and keep the optional empty.

A small sample test client for the ci mode can be found here: ssl-ci-test-client

If you can not use the ci mode, you can alternatively connect to the GC using the UI WebSocket API. The API is defined in proto/ssl_gc_api.proto and available at the path /api/control under the same port as the UI.

Examples

Development

Requirements

You need to install following dependencies first:

  • Go
  • Node

See .circleci/config.yml for compatible versions.

Frontend

See frontend/README.md

Build

Build and install all binaries:

make install

Run

go run cmd/ssl-game-controller/main.go

Test with autoRefs

To quickly run the GC together with autoRefs and other popular components, run:

docker compose up

Update generated protobuf code

Generate the code for the .proto files after you've changed anything in a .proto file with:

make proto