From 7da7fc41c6053c65d6e5724cd4c46badb6b4c0f0 Mon Sep 17 00:00:00 2001 From: Michael Miller Date: Wed, 5 Apr 2023 17:11:00 -0700 Subject: [PATCH] Created NeoPixelSegmentBus object (markdown) --- NeoPixelSegmentBus-object.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 NeoPixelSegmentBus-object.md diff --git a/NeoPixelSegmentBus-object.md b/NeoPixelSegmentBus-object.md new file mode 100644 index 0000000..4ba1b82 --- /dev/null +++ b/NeoPixelSegmentBus-object.md @@ -0,0 +1,18 @@ + +See [NeoPixeBus object](https://github.com/Makuna/NeoPixelBus/wiki/NeoPixelBus-object) for more details on the general use of this object. +See [NeoPixelSegmentBus object API Reference](https://github.com/Makuna/NeoPixelBus/wiki/NeoPixelSegmentBus-object-API) for more details on the methods exposed. + +This object is provided to wrap up the concept of using three WS2811 3-element LED driver chips to drive a seven-segment LED module. + +This object differs from the normal NeoPixelBus by supporting several string drawing methods. + +Instead of using the normal color objects like RgbColor, you will be using the [SevenSegDigit](https://github.com/Makuna/NeoPixelBus/wiki/SevenSegDigit-object-API) to define what is displayed on an individual seven-segment LED module. + +Just like the normal NeoPixelObject, it must be constructed with a ["Feature"](https://github.com/Makuna/NeoPixelBus/wiki/NeoPixelBus-object#neo-features) and a ["Method"](https://github.com/Makuna/NeoPixelBus/wiki/NeoPixelBus-object#neo-methods) object that define which pixels you are using and how they are updated. One of the [Neo*SegmentFeatures](https://github.com/Makuna/NeoPixelBus/wiki/Neo-Features#neoabcdefgpssegmentfeature--sevensegmentfeature) should be used as the T_FEATURE with this object to correctly function. Further, a WS2811 Method should be selected, although if your specific hardware uses another chip it will function with almost any Method. +``` +NeoPixelBusLg strip(digitCount, pixelPin); +``` + +### [More on FEATUREs](https://github.com/Makuna/NeoPixelBus/wiki/T_COLOR_FEATURE) + +### [More on METHODs](https://github.com/Makuna/NeoPixelBus/wiki/T_METHOD)