Usermod seven segment display reloaded - add more options so it can be used on many different projects #4585
Conversation
**Configurable Settings** - Introduced preprocessor macros for configuration: - `umSSDR_ENABLED` – enable/disable the usermod. - `umSSDR_ENABLE_AUTO_BRIGHTNESS` – control auto brightness. - `umSSDR_BRIGHTNESS_MIN` and `umSSDR_BRIGHTNESS_MAX` – set brightness range. - `umSSDR_INVERT_AUTO_BRIGHTNESS` – invert the brightness mapping. - `umSSDR_LUX_MIN` and `umSSDR_LUX_MAX` – define the sensor lux range. - `umSSDR_INVERTED`, `umSSDR_COLONBLINK`, and `umSSDR_LEADING_ZERO` – adjust display settings. - `umSSDR_DISPLAY_MASK` and related strings (`umSSDR_HOURS`, `umSSDR_MINUTES`, `umSSDR_SECONDS`, `umSSDR_COLONS`, `umSSDR_LIGHT`, `umSSDR_DAYS`, `umSSDR_MONTHS`, `umSSDR_YEARS`) – configure the physical layout. - The numbers array (`umSSDRNumbers`) can now be overridden via the macro `umSSDR_NUMBERS`. **New Variables and Adjustments** - Added new runtime variables: - `umSSDRInvertAutoBrightness` – controls inversion of the brightness mapping. - `umSSDRLuxMin` and `umSSDRLuxMax` – sensor lux thresholds. - `umSSDRLight` – a string to represent a Light LED in the display. - Grouped configuration values together for clarity. **Display Functionality Enhancements** - In `_overlaySevenSegmentDraw()`, added a new case `'L'` to handle the Light LED, calling `_showElements()` for `umSSDRLight`. - Modified logic in `_showElements()` for consistent handling of digit elements and improved ordering when populating the time array. **MQTT Publishing and Connection Updates** - Updated `_publishMQTTint_P()` and `_publishMQTTstr_P()` to check for a connected MQTT state using `WLED_MQTT_CONNECTED` (wrapped in `#ifndef WLED_DISABLE_MQTT`). - Adjusted `onMqttConnect()` to return early if `umSSDRDisplayTime` is disabled, avoiding unnecessary MQTT subscriptions. - Extended MQTT state updates in `_updateMQTT()` to include the new parameters (lux limits, auto brightness inversion, and Light LED). **Brightness Adjustment and Sensor Handling** - Refactored the `loop()` function to: - Combine sensor handling for both photoresistor and BH1750. - Introduce a new flag (`disableUmLedControl`) for external control over LED updates. - Implement conditional brightness mapping that inverts the brightness curve if `umSSDRInvertAutoBrightness` is set. - Use a unified sensor reading variable (`lux`) updated from whichever sensor is available. **Additional Public API** - Added the public method `disableOutputFunction(bool state)` to allow external control over LED output (disable/enable). **JSON API and Configuration Updates** - Enhanced `addToJsonInfo()` by: - Adding a nested array to indicate if the module is disabled. - Including new parameters such as "Auto Brightness inverted" along with existing display settings. - Updated `_addJSONObject()` and `readFromConfig()` to incorporate new parameters (lux values, auto brightness inversion, and Light LED) into the state and configuration JSON objects.
WalkthroughThe update focuses on enhancing the documentation and refactoring the configuration code for the Seven Segment Display Reloaded usermod. The README now features a structured table of compile-time parameters, clearer settings descriptions with LED configuration examples, and a new public function. In parallel, the header file has been refactored to replace runtime configuration variables with preprocessor definitions and static constants, while adjustments to MQTT publishing and JSON configuration handling improve brightness and lux parameter management. Changes
✨ Finishing Touches
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🔭 Outside diff range comments (1)
usermods/seven_segment_display_reloaded/usermod_seven_segment_reloaded.h (1)
355-364:⚠️ Potential issuePotential array-out-of-bounds in LED loops.
Usingi <= umSSDRLengthwill access an invalid index wheniequalsumSSDRLength. To avoid undefined behavior, the loop condition should be< umSSDRLength.-for(int i = 0; i <= umSSDRLength; i++) { +for(int i = 0; i < umSSDRLength; i++) {-for(int i = 0; i <= umSSDRLength; i++) { +for(int i = 0; i < umSSDRLength; i++) {(Adjust in both loops at lines 355 and 363)
🧹 Nitpick comments (9)
usermods/seven_segment_display_reloaded/readme.md (9)
11-12: Cross-referencing prerequisites.
Providing direct links to the required sensor usermods (SN_Photoresistor/BH1750_V2) is helpful. Consider explicitly stating the minimum supported version of each sensor usermod, if any constraints apply.
39-40: Override for LED segment mapping.
Highlighting the macroumSSDR_NUMBERSearly is beneficial. Consider providing a short code snippet or direct example here on how to override the segment array, so that new users can see how to integrate custom mappings.
52-52: Comma usage for compound sentence.
A comma before “and” can improve readability: “inverted mode in which the background is lit**,** and the digits are off (black).”- Enables the inverted mode in which the background is lit and the digits are off (black). + Enables the inverted mode in which the background is lit, and the digits are off (black).🧰 Tools
🪛 LanguageTool
[uncategorized] ~52-~52: Use a comma before “and” if it connects two independent clauses (unless they are closely connected and short).
Context: ...rted mode in which the background is lit and the digits are off (black). - **Colon-...(COMMA_COMPOUND_SENTENCE_2)
67-70: Missing determiners in lux-limits descriptions.
For better grammar, insert “the” before “minimum/maximum brightness.”- When the lux value is at or below this level, the display brightness is set to minimum brightness. Default is 0 lux. + When the lux value is at or below this level, the display brightness is set to the minimum brightness. Default is 0 lux.- When the lux value is at or above this level, the display brightness is set to maximum brightness. Default is 1000 lux. + When the lux value is at or above this level, the display brightness is set to the maximum brightness. Default is 1000 lux.🧰 Tools
🪛 LanguageTool
[uncategorized] ~67-~67: A determiner appears to be missing. Consider inserting it.
Context: ...tness is set to the minimum brightness. Default is0lux. - lux-max Defines ...(AI_EN_LECTOR_MISSING_DETERMINER)
[uncategorized] ~70-~70: A determiner appears to be missing. Consider inserting it.
Context: ...tness is set to the maximum brightness. Default is1000lux. - **invert-auto-brightn...(AI_EN_LECTOR_MISSING_DETERMINER)
104-104: Specify a language for fenced code blocks.
Modern markdown linting rules prefer language specification to enable syntax highlighting and consistency.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
104-104: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
164-164: Heading style mismatch.
Use a consistent heading style (e.g.,## My Title) instead of setext style to satisfy markdown linter rules.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
164-164: Heading style
Expected: atx; Actual: setext(MD003, heading-style)
164-164: Trailing punctuation in heading
Punctuation: ':'(MD026, no-trailing-punctuation)
200-200: Horizontal rule style.
Change---to a consistent style like--------------------------------if you follow the linter’s convention or any internal guideline.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
200-200: Horizontal rule style
Expected: --------------------------------; Actual: ---(MD035, hr-style)
206-206: Repeated heading with trailing punctuation.
Use a unique heading text and avoid trailing punctuation (e.g., “Projects” instead of “Projects:”), for lint rule compliance.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
206-206: Heading style
Expected: atx; Actual: setext(MD003, heading-style)
206-206: Multiple headings with the same content
null(MD024, no-duplicate-heading)
206-206: Trailing punctuation in heading
Punctuation: ':'(MD026, no-trailing-punctuation)
209-209: Fenced code blocks lacking language specification.
Add a language identifier for improved readability, e.g.,c++ orbash.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
209-209: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
usermods/seven_segment_display_reloaded/readme.md(1 hunks)usermods/seven_segment_display_reloaded/usermod_seven_segment_reloaded.h(18 hunks)
🧰 Additional context used
🪛 LanguageTool
usermods/seven_segment_display_reloaded/readme.md
[uncategorized] ~52-~52: Use a comma before “and” if it connects two independent clauses (unless they are closely connected and short).
Context: ...rted mode in which the background is lit and the digits are off (black). - **Colon-...
(COMMA_COMPOUND_SENTENCE_2)
[uncategorized] ~67-~67: A determiner appears to be missing. Consider inserting it.
Context: ...tness is set to the minimum brightness. Default is 0 lux. - lux-max Defines ...
(AI_EN_LECTOR_MISSING_DETERMINER)
[uncategorized] ~70-~70: A determiner appears to be missing. Consider inserting it.
Context: ...tness is set to the maximum brightness. Default is 1000 lux. - **invert-auto-brightn...
(AI_EN_LECTOR_MISSING_DETERMINER)
🪛 markdownlint-cli2 (0.17.2)
usermods/seven_segment_display_reloaded/readme.md
104-104: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
164-164: Heading style
Expected: atx; Actual: setext
(MD003, heading-style)
164-164: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
167-167: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
200-200: Horizontal rule style
Expected: --------------------------------; Actual: ---
(MD035, hr-style)
206-206: Heading style
Expected: atx; Actual: setext
(MD003, heading-style)
206-206: Multiple headings with the same content
null
(MD024, no-duplicate-heading)
206-206: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
209-209: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
🔇 Additional comments (11)
usermods/seven_segment_display_reloaded/readme.md (3)
3-4: Documentation clarity improved.
The newly added lines clarify the usermod’s purpose and reference the original overlay-based approach. This helps users grasp the display’s configurability more easily.
13-38: Structured table of compile-time parameters.
This table neatly summarizes the available parameters, their defaults, and purpose. The format is clear and significantly enhances user reference.
44-45: Clarified external control methods.
Stating that settings can be controlled via the usermod settings page, MQTT, or JSON is concise and informative. Good job!usermods/seven_segment_display_reloaded/usermod_seven_segment_reloaded.h (8)
19-40: Compile-time definitions for configurability.
Defining these macros for default values is an excellent approach for flexible builds. They improve maintainability and make user overrides straightforward.
247-252: New light indicator logic.
The condition checks ensure that you only display the light indicator segment once. This is consistent with how colons are handled. The logic is clear and correct.
375-385: MQTT publishing logic
The checkif (WLED_MQTT_CONNECTED && mqtt != NULL)is good for avoiding null pointer issues. The approach of building topic strings frommqttDeviceTopiclooks correct and consistent.
435-457: Comprehensive MQTT updates
Updating all relevant settings upon connection is a solid approach for ensuring synchronization. Good practice.
467-471: JSON include for brightness fields
StoringminBrightness,maxBrightness,luxMin,luxMax, andinvert-auto-brightnessin JSON is consistent with the design. This ensures the usermod’s dynamic behavior is captured accurately.
642-645: MQTT subscription gating
Skipping subscription if the display is disabled avoids unnecessary overhead. Nicely done.
668-691: Topic prefix checks
This code carefully trims off the prefix/wledSS/and checks the trailing/set. Good approach for structured MQTT commands.
752-761: String literals for new brightness-related parameters
Defining these PROGMEM constants ensures minimal RAM usage on embedded systems, which is a best practice for microcontrollers.
|
@derqurps please have a look. |
There was a problem hiding this comment.
@KrX3D Thank you for extending the function and the documentation of the usermod.
I added a couple of small suggestions. The only thing that i don't understand, is what the option "LED-Numbers-Light" is doing or what it is for :)
Thanks again!
usermods/seven_segment_display_reloaded/usermod_seven_segment_reloaded.h
Outdated
Show resolved
Hide resolved
usermods/seven_segment_display_reloaded/usermod_seven_segment_reloaded.h
Show resolved
Hide resolved
Co-authored-by: Roman Reitschmied <derqurps@users.noreply.github.com>
Co-authored-by: Roman Reitschmied <derqurps@users.noreply.github.com>
…reloaded.h Co-authored-by: Roman Reitschmied <derqurps@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 0
🔭 Outside diff range comments (2)
usermods/seven_segment_display_reloaded/usermod_seven_segment_reloaded.h (2)
359-359:⚠️ Potential issuePotential buffer overflow in _setMaskToLeds
The loop should use
<instead of<=to avoid accessing an out-of-bounds element at indexumSSDRLength.- for(int i = 0; i <= umSSDRLength; i++) { + for(int i = 0; i < umSSDRLength; i++) {
367-367:⚠️ Potential issuePotential buffer overflow in _setAllFalse
Similar to the previous issue, the loop should use
<instead of<=to avoid accessing an out-of-bounds element.- for(int i = 0; i <= umSSDRLength; i++) { + for(int i = 0; i < umSSDRLength; i++) {
🧹 Nitpick comments (9)
usermods/seven_segment_display_reloaded/readme.md (8)
76-87: Clear display mask documentationThe detailed explanation of the display mask characters is very helpful. Consider adding a brief example showing what a display would look like with a particular mask (e.g., "H:m" displays "14:35").
116-118: Missing comma in LED definitions sectionThere should be a comma after "In this example" for better readability.
-An example would be 1,3,6-8,23,30-32. In this example the LEDs with the numbers 1,3,6,7,8,23,30,31 and 32 would make up a Segment. +An example would be 1,3,6-8,23,30-32. In this example, the LEDs with the numbers 1,3,6,7,8,23,30,31 and 32 would make up a Segment.🧰 Tools
🪛 LanguageTool
[typographical] ~117-~117: It appears that a comma is missing.
Context: ...mple would be 1,3,6-8,23,30-32. In this example the LEDs with the numbers 1,3,6,7,8,23,...(DURING_THAT_TIME_COMMA)
157-158: Good documentation of new public functionThe documentation clearly explains the purpose of the new function
disableOutputFunction(bool state). Consider adding a brief example of how to call this function from other code.
104-114: Specify language for code blockThe fenced code block should have a language specified for better syntax highlighting.
-``` +```ascii < A > /\ /\ F B \/ \/ < G > /\ /\ E C \/ \/ < D >🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
104-104: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
169-196: Specify language for code blockThe fenced code block should have a language specified for better syntax highlighting.
-``` +```c #define USERMOD_SSDR #define umSSDR_ENABLED true // Enable SSDR usermod #define umSSDR_ENABLE_AUTO_BRIGHTNESS false // Enable auto brightness (requires USERMOD_SN_PHOTORESISTOR) #define umSSDR_INVERTED false // Inverted display #define umSSDR_COLONBLINK true // Colon blink enabled #define umSSDR_LEADING_ZERO false // Leading zero disabled #define umSSDR_DISPLAY_MASK "H:mL" // Display mask for time format // Segment definitions for hours, minutes, seconds, colons, light, days, months, and years #define umSSDR_HOURS "135-143;126-134;162-170;171-179;180-188;144-152;153-161:198-206;189-197;225-233;234-242;243-251;207-215;216-224" #define umSSDR_MINUTES "9-17;0-8;36-44;45-53;54-62;18-26;27-35:72-80;63-71;99-107;108-116;117-125;81-89;90-98" #define umSSDR_SECONDS "" #define umSSDR_COLONS "266-275" // Segment range for colons #define umSSDR_LIGHT "252-265" // Segment range for light indicator (added for this project) #define umSSDR_DAYS "" // Reserved for days if needed #define umSSDR_MONTHS "" // Reserved for months if needed #define umSSDR_YEARS "" // Reserved for years if needed #define umSSDR_INVERT_AUTO_BRIGHTNESS true #define umSSDR_LUX_MIN 50 #define umSSDR_LUX_MAX 1000 // Brightness limits #define umSSDR_BRIGHTNESS_MIN 0 // Minimum brightness #define umSSDR_BRIGHTNESS_MAX 128 // Maximum brightness🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
169-169: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
211-250: Specify language for code blockThe fenced code block should have a language specified for better syntax highlighting.
-``` +```c #define umSSDR_ENABLED true // Enable SSDR usermod #define umSSDR_ENABLE_AUTO_BRIGHTNESS false // Enable auto brightness (requires USERMOD_SN_PHOTORESISTOR) #define umSSDR_INVERTED false // Inverted display #define umSSDR_COLONBLINK false // Colon blink disabled #define umSSDR_LEADING_ZERO true // Leading zero enabled #define umSSDR_DISPLAY_MASK "H:m:s" // Display mask for time format // Segment definitions for hours, minutes, seconds, colons, light, days, months, and years #define umSSDR_HOURS "20,30;21,31;22,32;23,33;24,34;25,35;26,36;27,37;28,38;29,39:0,10;1,11;2,12;3,13;4,14;5,15;6,16;7,17;8,18;9,19" #define umSSDR_MINUTES "60,70;61,71;62,72;63,73;64,74;65,75;66,76;67,77;68,78;69,79:40,50;41,51;42,52;43,53;44,54;45,55;46,56;47,57;48,58;49,59" #define umSSDR_SECONDS "100,110;101,111;102,112;103,113;104,114;105,115;106,116;107,117;108,118;109,119:80,90;81,91;82,92;83,93;84,94;85,95;86,96;87,97;88,98;89,99" #define umSSDR_COLONS "" // No colon segment mapping needed #define umSSDR_LIGHT "" // No light indicator defined #define umSSDR_DAYS "" // Reserved for days if needed #define umSSDR_MONTHS "" // Reserved for months if needed #define umSSDR_YEARS "" // Reserved for years if needed #define umSSDR_INVERT_AUTO_BRIGHTNESS true #define umSSDR_LUX_MIN 50 #define umSSDR_LUX_MAX 1000 // Brightness limits #define umSSDR_BRIGHTNESS_MIN 0 // Minimum brightness #define umSSDR_BRIGHTNESS_MAX 128 // Maximum brightness #define umSSDR_NUMBERS { \ { 0, 0, 0, 0, 0, 1, 0, 0, 0, 0 }, /* 0 */ \ { 1, 0, 0, 0, 0, 0, 0, 0, 0, 0 }, /* 1 */ \ { 0, 0, 0, 0, 0, 0, 1, 0, 0, 0 }, /* 2 */ \ { 0, 1, 0, 0, 0, 0, 0, 0, 0, 0 }, /* 3 */ \ { 0, 0, 0, 0, 0, 0, 0, 1, 0, 0 }, /* 4 */ \ { 0, 0, 1, 0, 0, 0, 0, 0, 0, 0 }, /* 5 */ \ { 0, 0, 0, 0, 0, 0, 0, 0, 1, 0 }, /* 6 */ \ { 0, 0, 0, 1, 0, 0, 0, 0, 0, 0 }, /* 7 */ \ { 0, 0, 0, 0, 0, 0, 0, 0, 0, 1 }, /* 8 */ \ { 0, 0, 0, 0, 1, 0, 0, 0, 0, 0 }, /* 9 */ \ { 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 } /* Blank */ \ }🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
211-211: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
254-255: Missing comma in textThere should be a comma after "For example" for better readability.
-For example the Lazy 7 Quick build edition has the following settings - depending on the orientation. +For example, the Lazy 7 Quick build edition has the following settings - depending on the orientation.🧰 Tools
🪛 LanguageTool
[uncategorized] ~254-~254: A comma might be missing here.
Context: ...nstructables.com/member/parallyze/) For example the Lazy 7 Quick build edition has the ...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
52-52: Missing comma in textFor better readability, consider adding a comma between clauses in this sentence.
-Enables the inverted mode in which the background is lit and the digits are off (black). +Enables the inverted mode in which the background is lit, and the digits are off (black).🧰 Tools
🪛 LanguageTool
[uncategorized] ~52-~52: Possible missing comma found.
Context: ...- inverted Enables the inverted mode in which the background is lit and the ...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~52-~52: Use a comma before “and” if it connects two independent clauses (unless they are closely connected and short).
Context: ...rted mode in which the background is lit and the digits are off (black). - **Colon-...(COMMA_COMPOUND_SENTENCE_2)
usermods/seven_segment_display_reloaded/usermod_seven_segment_reloaded.h (1)
712-730: Improve code readability by aligning the operatorsConsider aligning the binary OR operators for better readability.
- umSSDRDisplayTime = (top[FPSTR(_str_timeEnabled)] | umSSDRDisplayTime); - umSSDREnableLDR = (top[FPSTR(_str_ldrEnabled)] | umSSDREnableLDR); + umSSDRDisplayTime = (top[FPSTR(_str_timeEnabled)] | umSSDRDisplayTime); + umSSDREnableLDR = (top[FPSTR(_str_ldrEnabled)] | umSSDREnableLDR);
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
usermods/seven_segment_display_reloaded/readme.md(1 hunks)usermods/seven_segment_display_reloaded/usermod_seven_segment_reloaded.h(18 hunks)
🧰 Additional context used
🪛 LanguageTool
usermods/seven_segment_display_reloaded/readme.md
[uncategorized] ~52-~52: Possible missing comma found.
Context: ...- inverted Enables the inverted mode in which the background is lit and the ...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~52-~52: Use a comma before “and” if it connects two independent clauses (unless they are closely connected and short).
Context: ...rted mode in which the background is lit and the digits are off (black). - **Colon-...
(COMMA_COMPOUND_SENTENCE_2)
[uncategorized] ~67-~67: A determiner appears to be missing. Consider inserting it.
Context: ...tness is set to the minimum brightness. Default is 0 lux. - lux-max Defines ...
(AI_EN_LECTOR_MISSING_DETERMINER)
[uncategorized] ~70-~70: A determiner appears to be missing. Consider inserting it.
Context: ...tness is set to the maximum brightness. Default is 1000 lux. - **invert-auto-brightn...
(AI_EN_LECTOR_MISSING_DETERMINER)
[typographical] ~117-~117: It appears that a comma is missing.
Context: ...mple would be 1,3,6-8,23,30-32. In this example the LEDs with the numbers 1,3,6,7,8,23,...
(DURING_THAT_TIME_COMMA)
[uncategorized] ~254-~254: A comma might be missing here.
Context: ...nstructables.com/member/parallyze/) For example the Lazy 7 Quick build edition has the ...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
🪛 markdownlint-cli2 (0.17.2)
usermods/seven_segment_display_reloaded/readme.md
104-104: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
166-166: Heading style
Expected: atx; Actual: setext
(MD003, heading-style)
166-166: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
169-169: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
202-202: Horizontal rule style
Expected: --------------------------------; Actual: ---
(MD035, hr-style)
208-208: Heading style
Expected: atx; Actual: setext
(MD003, heading-style)
208-208: Multiple headings with the same content
null
(MD024, no-duplicate-heading)
208-208: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
211-211: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
🔇 Additional comments (24)
usermods/seven_segment_display_reloaded/readme.md (6)
13-38: Great addition of compile-time parameters documentationThis structured table significantly improves the documentation by clearly documenting all available compile-time parameters with their default values and descriptions. It makes the usermod much more accessible to new users while providing a quick reference for experienced developers.
46-47: Well-organized settings sectionThe reorganization of the settings section with clear headings and descriptions improves readability and maintainability.
60-75: Enhanced documentation for auto-brightness featuresThe detailed explanation of auto-brightness parameters is excellent. The documentation now clearly explains how lux values are mapped to brightness and how the inversion works.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~67-~67: A determiner appears to be missing. Consider inserting it.
Context: ...tness is set to the minimum brightness. Default is0lux. - lux-max Defines ...(AI_EN_LECTOR_MISSING_DETERMINER)
[uncategorized] ~70-~70: A determiner appears to be missing. Consider inserting it.
Context: ...tness is set to the maximum brightness. Default is1000lux. - **invert-auto-brightn...(AI_EN_LECTOR_MISSING_DETERMINER)
120-151: Excellent LED definition examplesThe detailed examples showing how to define segments for digits is very helpful. The breakdown of each segment with explanations makes it much clearer for users to understand how to configure their own displays.
237-249: Nice addition of number array override supportThe inclusion of the
umSSDR_NUMBERSexample demonstrates how to customize the segment mapping for different display types. This significantly increases the versatility of the usermod.
253-265: Helpful real-world project exampleIncluding specific configurations for the Lazy Clock project is very useful. This provides a great starting point for users working with similar hardware.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~254-~254: A comma might be missing here.
Context: ...nstructables.com/member/parallyze/) For example the Lazy 7 Quick build edition has the ...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
usermods/seven_segment_display_reloaded/usermod_seven_segment_reloaded.h (18)
19-59: Great refactoring to use preprocessor definitionsExcellent conversion from runtime variables to preprocessor definitions. This approach allows for better compile-time optimization and makes the code more configurable through
my_config.h. The default values are sensible and align with the documentation in the readme.
71-75: Well-documented Light LED optionThe detailed comment explaining the Light LED option is very helpful for understanding its purpose and usage.
83-113: Good separation of segment definitions as preprocessor macrosUsing preprocessor definitions for all segment configurations makes the code more flexible and easier to customize for different projects.
115-143: Smart conditional definition of segment number arrayThe conditional compilation of the segment number array allows for custom mapping while providing sensible defaults. This makes the code much more versatile for different hardware configurations.
145-163: Good initialization from preprocessor definitionsThe initialization of runtime variables from preprocessor definitions ensures consistent initial state while allowing for runtime changes through the JSON API.
251-256: Well-implemented Light LED caseThe addition of a 'L' case for handling light segments is well implemented with a check to prevent duplicate calls to _showElements.
285-285: Fixed digit order in time arrayCorrect update to the array value - ensures that the blank digit (10) is used for the leading zero case.
290-290: Fixed digit order in time arrayCorrect update to the array value - ensures that 0 is used when not removing leading zero.
377-401: Improved MQTT publishing with connection checksThe addition of connection state checks before MQTT publishing prevents unnecessary operations when MQTT is not connected. The proper preprocessor guards are also important for builds where MQTT is disabled.
443-447: Added new parameters to MQTT publicationThe addition of brightness and lux parameters to MQTT publication ensures that all configuration options are properly synchronized between WLED and MQTT clients.
471-475: Added new parameters to JSON objectThe addition of brightness and lux parameters to the JSON object ensures that all configuration options are properly exposed through the JSON API.
522-544: Improved auto-brightness handling with inversion supportThe enhanced auto-brightness logic now properly handles both sensor types and includes an inversion option for the brightness mapping. The validation of lux values ensures that mapping only occurs with valid sensor readings.
558-560: Added external control of LED outputThe addition of the
disableUmLedControlcheck in thehandleOverlayDrawmethod enables external control of the LED output.
564-566: Added useful public method for external controlThe
disableOutputFunctionmethod provides a clean API for other code to control the LED output of this usermod, enhancing its integration capabilities.
578-601: Enhanced JSON info with more detailed informationThe improved JSON info section now includes more comprehensive information about the usermod's state, making it easier for users to understand the current configuration.
626-642: Complete JSON configuration handlingThe JSON configuration handling now includes all configuration parameters, ensuring that users can fully configure the usermod through the JSON API.
647-667: Improved MQTT connection handlingThe addition of a check for
umSSDRDisplayTimebefore subscribing to MQTT topics prevents unnecessary subscriptions when the usermod is disabled. The proper connection check also ensures that MQTT operations only occur when connected.
672-695: Added MQTT message handling with guardsThe MQTT message handling now includes proper guards for disabled builds and checks the usermod's enabled state before processing messages.
Changelog for UsermodSSDR Update
Configurable Settings
umSSDR_ENABLED– enable/disable the usermod.umSSDR_ENABLE_AUTO_BRIGHTNESS– control auto brightness.umSSDR_BRIGHTNESS_MINandumSSDR_BRIGHTNESS_MAX– set brightness range.umSSDR_INVERT_AUTO_BRIGHTNESS– invert the brightness mapping.umSSDR_LUX_MINandumSSDR_LUX_MAX– define the sensor lux range.umSSDR_INVERTED,umSSDR_COLONBLINK, andumSSDR_LEADING_ZERO– adjust display settings.umSSDR_DISPLAY_MASKand related strings (umSSDR_HOURS,umSSDR_MINUTES,umSSDR_SECONDS,umSSDR_COLONS,umSSDR_LIGHT,umSSDR_DAYS,umSSDR_MONTHS,umSSDR_YEARS) – configure the physical layout.umSSDRNumbers) can now be overridden via the macroumSSDR_NUMBERS.New Variables and Adjustments
umSSDRInvertAutoBrightness– controls inversion of the brightness mapping.umSSDRLuxMinandumSSDRLuxMax– sensor lux thresholds.umSSDRLight– a string to represent a Light LED in the display.Display Functionality Enhancements
_overlaySevenSegmentDraw(), added a new case'L'to handle the Light LED, calling_showElements()forumSSDRLight._showElements()for consistent handling of digit elements and improved ordering when populating the time array.MQTT Publishing and Connection Updates
_publishMQTTint_P()and_publishMQTTstr_P()to check for a connected MQTT state usingWLED_MQTT_CONNECTED(wrapped in#ifndef WLED_DISABLE_MQTT).onMqttConnect()to return early ifumSSDRDisplayTimeis disabled, avoiding unnecessary MQTT subscriptions._updateMQTT()to include the new parameters (lux limits, auto brightness inversion, and Light LED).Brightness Adjustment and Sensor Handling
loop()function to:disableUmLedControl) for external control over LED updates.umSSDRInvertAutoBrightnessis set.lux) updated from whichever sensor is available.Additional Public API
disableOutputFunction(bool state)to allow external control over LED output (disable/enable).JSON API and Configuration Updates
addToJsonInfo()by:_addJSONObject()andreadFromConfig()to incorporate new parameters (lux values, auto brightness inversion, and Light LED) into the state and configuration JSON objects.With these modifications, the SSDR usermod becomes even more versatile, allowing it to be used on a wide variety of segment clocks and projects.
Look at the readme -> ## Additional Projects
Summary by CodeRabbit
New Features
Documentation