ScStw/proto
2
0
Fork 0
Code Activity

Chore: update comments

Browse source
This commit is contained in:
Dorian Zedler 2024-11-26 20:45:28 +01:00
parent 752771a144
commit 593513bdbd
Signed by: dorian
GPG key ID: 989DE36109AFA354
1 changed files with 18 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

33
Settings.proto
View file

@ -9,13 +9,14 @@ message SoundSettings {
} }
message SecuritySettings { message SecuritySettings {
// If set to true, the bluetooth interface won't be initialized on startup // If set to true, the bluetooth interface won't be initialized on startup.
// This can only be changed over a web socket connection to avoid lockout // This can only be changed over a web socket connection to avoid lockout.
// At least one lane must be enabled. Otherwise, the first lane will be // To be effective, the settings must be stored as default and device must be
// enabled! // rebooted!
bool disableBluetooth = 1; bool disableBluetooth = 1;
// If set to true, the default settings can't be set via bluetooth // If set to true, the default settings can't be set via bluetooth.
// This can only be changed over a web socket connection to avoid lockout.
bool disallowToSetDefaultViaBluetooth = 2; bool disallowToSetDefaultViaBluetooth = 2;
} }
@ -50,18 +51,20 @@ message StartProcedure {
message LaneSettings { message LaneSettings {
reserved 1; // Deprecated "letter" reserved 1; // Deprecated "letter"
// If set to true, the lane won't be usable and won't show up in the UI // If set to true, the lane won't be usable and won't show up in the UI.
// Can be used if there is only a single lane in the gym // Can be used if there is only a single lane in the gym.
// At least one lane must be enabled. Otherwise, the first lane will be
// enabled!
bool disabled = 2; bool disabled = 2;
} }
message AbortAfterFalseStart {} message AbortAfterFalseStart {}
message ContinueAfterFalseStart { message ContinueAfterFalseStart {
// This time will be assumed as the reaction time when calculating the final // This time will be assumed as the reaction time when calculating the final
// time // time.
uint32 assumedReactionTime = 1; uint32 assumedReactionTime = 1;
// If set to true, there will be no false start tone and the normal tone will // If set to true, there will be no false start tone and the normal tone will
// continue Also, the indicator of wildcard lanes will continue as normal // continue. Also, the indicator of wildcard lanes will continue as normal.
bool continueStartSequenceAfterFalseStart = 2; bool continueStartSequenceAfterFalseStart = 2;
} }
@ -78,21 +81,21 @@ message FalseStartSettings {
} }
message IndicatorSettings { message IndicatorSettings {
// Software brightness control, between 0 and 254 // Software brightness control, between 0 and 254.
uint32 brightness = 1; uint32 brightness = 1;
// If set to true, the indicator will stop blinkng as soon as the false start // If set to true, the indicator will stop blinkng as soon as the false start
// sound stops (when a false start exists and race is in FINISHED_MUTED // sound stops (when a false start exists and race is in FINISHED_MUTED
// state). Otherwise, it will continue blinking until the race is reset // state). Otherwise, it will continue blinking until the race is reset.
bool turnOffWhenFalseStartSoundIsMuted = 2; bool turnOffWhenFalseStartSoundIsMuted = 2;
// If set to true, the indicator will trun off when race is IDLE state. // If set to true, the indicator will trun off when race is IDLE state.
// Otherwise, it will be red // Otherwise, it will be red.
bool turnOffWhenIdle = 3; bool turnOffWhenIdle = 3;
} }
message TrainingClassicRaceMode { message TrainingClassicRaceMode {
StartProcedure startProcedure = 1; StartProcedure startProcedure = 1;
// The number of lanes cannot be changed by the client // The number of lanes cannot be changed by the client.
repeated LaneSettings lanes = 2; repeated LaneSettings lanes = 2;
FalseStartSettings falseStartSettings = 3; FalseStartSettings falseStartSettings = 3;
IndicatorSettings indicatorSettings = 4; IndicatorSettings indicatorSettings = 4;
@ -108,11 +111,11 @@ message TimerMode {
} }
message Settings { message Settings {
// if the settings are stored as default in the flash memory // if the settings are stored as default in the flash memory.
bool default = 1; bool default = 1;
// DEPRECATED, just kept for compatibility, use TimerMode instead! // DEPRECATED, just kept for compatibility, use TimerMode instead!
// Will be ignored when TimerMode is set // Will be ignored when TimerMode is set.
TrainingClassicRaceMode race = 2 [ deprecated = true ]; TrainingClassicRaceMode race = 2 [ deprecated = true ];
SoundSettings sound = 3; SoundSettings sound = 3;