Historia

Frank dbe8554724 code spell checking - part3 (usermods) if you can spell Fahrenheit, you can't spell Celsius. And vice versa :-)		2023-12-14 03:52:06 +01:00
..
readme.md	code spell checking - part3 (usermods)	2023-12-14 03:52:06 +01:00
usermod_v2_seven_segment_display.h	code spell checking - part3 (usermods)	2023-12-14 03:52:06 +01:00

readme.md

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. Enables 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.

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)

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.

           -------
         /   A   /          0 - EDCGFAB
        / F     / B         1 - EDCBAFG
       /       /            2 - GCDEFAB
       -------              3 - GBAFEDC
     /   G   /              4 - FABGEDC
    / E     / C             5 - FABCDEG
   /       /
   -------
      D

Version

20211009 - Initial release