jsw/signcontrol
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update readme

Browse source
This commit is contained in:
Jurn Wubben 2025-08-05 14:12:07 +02:00
parent fd3df89d4e
commit 2e40e5db10
1 changed files with 23 additions and 24 deletions
Download patch file Download diff file Expand all files Collapse all files

47
README.md
View file

@ -57,18 +57,17 @@ zone2="x=10,y=10,width=10,height=10" --message zone1="Hello {scrolloff}"
### Flags ### Flags
- **--zone zonename=""**: See the heading zones below. - `--zone zonename=""`: See the heading zones below.
- **--message zonename=""**: string with formatting options (see heading below). - `--message zonename=""`: string with formatting options (see heading below).
- **--address**: IP Address - `--address`: IP Address
- **--priority**: The message priority determines how the new message will - `--priority`: The message priority determines how the new message will replace
replace an existing one. The default is PRI_OVERRIDE, but can also be an existing one. The default is PRI_OVERRIDE, but can also be PRI_FOLLOW,
PRI_FOLLOW, PRI_INTERRUPT, PRI_YIELD or PRI_ROUNDROBIN. PRI_INTERRUPT, PRI_YIELD or PRI_ROUNDROBIN.
- **--"activation_delay**: Message activation delay in milliseconds. Default - `--"activation_delay`: Message activation delay in milliseconds. Default is 0.
is 0. - `--display_delay`: Message display delay in milliseconds. Default is 0.
- **--display_delay**: Message display delay in milliseconds. Default is 0. - `--display_repeat`: Not really sure. The default is 0.
- **--display_repeat**: Not really sure. The default is 0. - `--ttl`: The message will self-destruct in x seconds. Default is 0.
- **--ttl**: The message will self-destruct in x seconds. Default is 0. - `sound_alarm`: If true, the sign will beep when the message is displayed.
- **sound_alarm**: If true, the sign will beep when the message is displayed.
### Message Formatting ### Message Formatting
@ -117,27 +116,27 @@ format:
--zone name="param1=0,param2=0" --zone name="param1=0,param2=0"
``` ```
- **x:** The X coordinate to start the zone, required. - `x:` The X coordinate to start the zone, required.
- **y:** The Y coordinate to start the zone, required. - `y:` The Y coordinate to start the zone, required.
- **width:** The zone width, required. - `width:` The zone width, required.
- **height:** The zone height, required. - `height:` The zone height, required.
- **scroll_speed:** The speed of scrolling text in the zone. The default is - `scroll_speed:` The speed of scrolling text in the zone. The default is
`SCROLL_MED`, but can also be `SCROLL_SLOW` or `SCROLL_FAST`. `SCROLL_MED`, but can also be `SCROLL_SLOW` or `SCROLL_FAST`.
- **pause_duration:** The duration in milliseconds of any pause sequences in the - `pause_duration:` The duration in milliseconds of any pause sequences in the
message text. message text.
- **volume:** The volume of beeps, notes, alarms, and other noises. Valid range - `volume:` The volume of beeps, notes, alarms, and other noises. Valid range is
is 0 (off) to 8 (deadly). Default is 4. 0 (off) to 8 (deadly). Default is 4.
- **default_font:** The default font. See 'Available Fonts' - `default_font:` The default font. See 'Available Fonts'
- **default_color:** The default color. Can be `COLOR_RED`, `COLOR_GREEN`, or - `default_color:` The default color. Can be `COLOR_RED`, `COLOR_GREEN`, or
`COLOR_YELLOW`. The default is red. `COLOR_YELLOW`. The default is red.
- **initial_text:** The text initially displayed in the zone. This is just "." - `initial_text:` The text initially displayed in the zone. This is just "." by
by default. default.