From 35572a361cfc8b1d94de82bb26e1c10c22d9812d Mon Sep 17 00:00:00 2001 From: Michael Miller Date: Wed, 5 Apr 2023 11:21:25 -0700 Subject: [PATCH] Updated SevenSegDigit object API (markdown) --- SevenSegDigit-object-API.md | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) diff --git a/SevenSegDigit-object-API.md b/SevenSegDigit-object-API.md index c6df4a6..44d26f5 100644 --- a/SevenSegDigit-object-API.md +++ b/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]; -``` \ No newline at end of file +``` + +## references: +[enum LedSegment](https://github.com/Makuna/NeoPixelBus/wiki/LedSegment-enum). \ No newline at end of file