From 5c758f57424a3c578d99753a95181019a82c1454 Mon Sep 17 00:00:00 2001 From: doinkythederp Date: Thu, 9 May 2024 11:41:12 -0700 Subject: [PATCH] docs: add log level info --- src/simulators/protocol.md | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/src/simulators/protocol.md b/src/simulators/protocol.md index d3f9926..2c819de 100644 --- a/src/simulators/protocol.md +++ b/src/simulators/protocol.md @@ -47,7 +47,7 @@ Events are sent from the simulator backend to the frontend to describe simulator - override: boolean - `VEXLinkDisconnect`: Tell the VEXLink server that the VEXLink connection has been terminated. Fields: - port: [SmartPort](#smartport). - + ## Commands Commands are sent from the frontend to the backend and signal for specific actions to be performed. @@ -123,7 +123,7 @@ WIP An enum representing the state of a device. Every time the state of a device on any port changes, this enum will be sent. ``DeviceStatus`` variants: -- ``Motor``: The state of the motor has changed. +- ``Motor``: The state of the motor has changed. ``Motor`` fields: - velocity: float in radians per second. - reversed: boolean @@ -135,7 +135,7 @@ Every time the state of a device on any port changes, this enum will be sent. - voltage: float in Volts. - gearset: [``MotorGearSet``](#motorgearset) - brake_mode: [``MotorBrakeMode``](#motorbrakemode) - + ### MotorGearSet Represents the gearset of a smart motor device. @@ -201,6 +201,15 @@ A struct that represents an rgb8 color. - g: 8 bit integer - b: 8 bit integer +### LogLevel + +An enum representing the importance of a log message. +Variants: +- `Trace`: jumptable calls and other verbose messages +- `Info`: non-critical informational messages +- `Warn`: possible issues or errors that do not directly affect the simulation +- `Error`: issues and errors that degrade the simulation + ## Notes - Rust implementation available at .