ScStw V2 protocol specification

This repository contains the public Protocol Buffer definitions and protocol documentation for the ScStw basestation V2.

The basestation exposes the same race data and commands over several interfaces. Start with the shared protocol documentation, then choose a transport:

• Protocol concepts and messages
• UDP
• WebSocket
• Bluetooth Low Energy

UDP and Bluetooth examples are available in the proto-examples repository.

The basestation also has a Settings protocol. It is intentionally not part of this public specification and is not supported for public use. Public clients must ignore Settings messages or characteristics as described in the transport-specific documentation.

Protocol Buffer files

• RaceState.proto: complete race and lane state
• Command.proto: commands accepted by the basestation
• SystemInfo.proto: firmware identity and version
• SocketMessage.proto: envelope used by UDP and WebSocket

All definitions use Protocol Buffers proto3 syntax and the ScStw package.

Migrating from the old proto repository

The public protocol definitions have moved from proto to proto-spec. To migrate an existing clone of the old repository, execute:

git remote set-url origin https://itsblue.dev/ScStw/proto-spec
git fetch origin
git switch main
git reset --hard origin/main
git clean -fd

The final two commands replace local content with the current main branch; save any local changes first.