8caeddde15
A lot of spelling corrections. Now repo will sound like educated person :) Co-authored-by: Bill Thomson <bt@kattt.org>
56 lines
2.2 KiB
Markdown
56 lines
2.2 KiB
Markdown
# Seven Segment Display
|
|
|
|
Uses the overlay feature to create a configurable seven segment display.
|
|
This has only been tested on a single configuration. Colon support has _not_ been tested.
|
|
|
|
## Installation
|
|
|
|
Add the compile-time option `-D USERMOD_SEVEN_SEGMENT` to your `platformio.ini` (or `platformio_override.ini`) or use `#define USERMOD_SEVEN_SEGMENT` in `my_config.h`.
|
|
|
|
## Settings
|
|
Settings can be controlled via both the usermod setting page and through MQTT with a raw payload.
|
|
##### Example
|
|
Topic ```<mqttDeviceTopic||mqttGroupTopic>/sevenSeg/perSegment/set```
|
|
Payload ```3```
|
|
#### perSegment -- ssLEDPerSegment
|
|
The number of individual LEDs per segment. 7 segments per digit.
|
|
#### perPeriod -- ssLEDPerPeriod
|
|
The number of individual LEDs per period. A ':' (colon) has two periods.
|
|
#### startIdx -- ssStartLED
|
|
Index of the LED the display starts at. Enabless a seven segment display to be in the middle of a string.
|
|
#### timeEnable -- ssTimeEnabled
|
|
When true, when displayMask is configured for a time output and no message is set, the time will be displayed.
|
|
#### scrollSpd -- ssScrollSpeed
|
|
Time, in milliseconds, between message shifts when the length of displayMsg exceeds the length of the displayMask.
|
|
#### displayMask -- ssDisplayMask
|
|
This should represent the configuration of the physical display.
|
|
<pre>
|
|
HH - 0-23. hh - 1-12, kk - 1-24 hours
|
|
MM or mm - 0-59 minutes
|
|
SS or ss = 0-59 seconds
|
|
: for a colon
|
|
All others for alpha numeric, (will be blank when displaying time)
|
|
</pre>
|
|
##### Example
|
|
```HHMMSS ```
|
|
```hh:MM:SS ```
|
|
#### displayMsg -- ssDisplayMessage
|
|
Message to be displayed. If the message length exceeds the length of displayMask, the message will scroll at scrollSpd. To 'remove' a message or revert back to time, if timeEnabled is true, set the message to '~'.
|
|
#### displayCfg -- ssDisplayConfig
|
|
The order your LEDs are configured in. All segments in the display need to be wired the same way.
|
|
<pre>
|
|
-------
|
|
/ A / 0 - EDCGFAB
|
|
/ F / B 1 - EDCBAFG
|
|
/ / 2 - GCDEFAB
|
|
------- 3 - GBAFEDC
|
|
/ G / 4 - FABGEDC
|
|
/ E / C 5 - FABCDEG
|
|
/ /
|
|
-------
|
|
D
|
|
</pre>
|
|
|
|
## Version
|
|
20211009 - Initial release
|