mirror of https://github.com/wpilibsuite/allwpilib synced 2026-06-21 01:01:43 +00:00

Files

Peter Johnson 8f1f64ffb6 Remove year from file copyright message (NFC) (#2972 )

Also update copyright to include "and other WPILib contributors" and clarify
license referral language to not be restricted to FIRST teams.

2020-12-26 14:12:05 -08:00

src

Remove year from file copyright message (NFC) (#2972 )

2020-12-26 14:12:05 -08:00

build.gradle

[sim] Add WebSocket extension (client/server) (#2589 )

2020-08-19 22:14:03 -07:00

CMakeLists.txt

[build] CMake: build sim extensions as shared libs (#2866 )

2020-11-15 22:50:30 -08:00

README.md

[sim] Various WebSockets fixes and enhancements (#2952 )

2020-12-23 15:54:11 -08:00

README.md

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".