Makuna/NeoPixelBus
1
0
Fork 1
mirror of https://github.com/Makuna/NeoPixelBus.git synced 2025-08-07 04:44:26 +02:00
Code Issues Packages Projects Releases Wiki Activity

Updated SevenSegDigit object API (markdown)

Michael Miller
2023-04-05 11:21:25 -07:00
parent a101c4a4cf
commit 35572a361c
1 changed files with 16 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
SevenSegDigit-object-API.md

@@ -1,7 +1,18 @@
SevenSegDigit represents a color object that is represented by A, B, C, D, E, F, G, decimal, and special component values; which represent the names of the segments of a seven segment display.
## Properties
There is one property that represent the component values of the segments. The values in each location range from 0 to 255. Black or off would 0 and white or full on would be 255. The index can be addressed by [LedSegment enum](https://github.com/Makuna/NeoPixelBus/wiki/LedSegment-enum)`.
There is one property that represent the component values of the segments. The values in each location range from 0 to 255. Black or off would 0 and white or full on would be 255. The index can be addressed by the [enum LedSegment](## "enum LedSegment {
LedSegment_A,
LedSegment_B,
LedSegment_C,
LedSegment_D,
LedSegment_E,
LedSegment_F,
LedSegment_G,
LedSegment_Decimal, // maybe jumpered to alternate custom segment
LedSegment_Custom // generally not used but maybe connected to a custom segment
}").
```
uint8_t Segment[Count];
```
@@ -90,4 +101,7 @@ This is a static function, which means you need to call it scoped to the object
The index operator allows accessing the segments with an index directly on the object. There are both read only and read write versions.
```
uint8_t decimalBrightness = digit[LedSegment_Decimal];
```
```
## references:
[enum LedSegment](https://github.com/Makuna/NeoPixelBus/wiki/LedSegment-enum).