Files
allwpilib/simulation/halsim_ws_server
Tyler Veness 5ab54ff760 Replace wpi::raw_istream with wpi::MemoryBuffer (#5675)
Instances of wpi::raw_istream were left that are reading incrementally
from file descriptors like USB devices.
2023-09-21 23:20:09 -07:00
..

HAL WebSockets Server

This is an extension that provides a server version of a WebSockets API for transmitting robot hardware interface state over a network. See the Robot Hardware Interface WebSockets API specification for more details on the protocol.

Configuration

The WebSockets server has a number of configuration options available through environment variables.

HALSIMWS_SYSROOT: The local directory to serve non-websocket HTTP content from (e.g. HTML files) starting from /. Defaults to the sim subdirectory of the current working directory.

HALSIMWS_USERROOT: The local directory to serve non-websocket HTTP content from (e.g. HTML files) starting from /user/. Defaults to the sim/user subdirectory of the current working directory.

HALSIMWS_PORT: The port number to listen at. Defaults to 3300.

HALSIMWS_URI: The URI path to use for WebSockets connections. Defaults to "/wpilibws".