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

Files

Tyler Veness 5f651df5d5 [build] Clean up Gradle configs (#5685 )

Putting an early exit if statement at the top instead of wrapping the
whole file contents unbreaks unit test configs, as was discovered for
SysId. It reduces nesting as well.

Unused plugins were removed from the beginnings of files as well.

2023-09-27 21:45:25 -07:00

src

[json] Add forward definition header (#5676 )

2023-09-22 13:01:27 -07:00

build.gradle

[build] Clean up Gradle configs (#5685 )

2023-09-27 21:45:25 -07:00

CMakeLists.txt

[build] cmake: Use default install location on windows for dlls (#5580 )

2023-09-17 16:17:32 -07: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".