vexide-simulator-protocol
| Crates.io | vexide-simulator-protocol |
| lib.rs | vexide-simulator-protocol |
| version | 0.2.0 |
| created_at | 2024-05-27 21:39:54.736529+00 |
| updated_at | 2024-06-08 03:40:48.745588+00 |
| description | JSON-based protocol enabling communication between VEX robot simulators and user-facing frontends |
| homepage | https://vexide.dev |
| repository | https://github.com/vexide/simulator-protocol |
| max_upload_size | |
| id | 1253802 |
| size | 16,331 |
(doinkythederp)
documentation
README
Vexide Simulator Protocol
The Vexide Simulator Protocol enables communication between VEX robot simulators and user-facing frontends using a JSON-based protocol.
The code executor and frontend communicate over a stream in newline-delimited JSON format.
The backend sends Events which represent a change in simulator state.
These are used by the frontend to correctly display the state of the simulated program.
The frontend sends Commands to the code executor to control the robot code environment, simulating changes in robot hardware (like controller input and LCD touch events) or competition phase.
The full protocol is documented at https://internals.vexide.dev/simulators/protocol.