#include <AH/Hardware/ExtendedInputOutput/ShiftRegisterOutBase.hpp>
A class for serial-in/parallel-out shift registers, like the 74HC595.
N | The number of bits in total. Usually, shift registers (e.g. the 74HC595) have eight bits per chip, so length = 8 * k where k is the number of cascaded chips. |
Definition at line 23 of file ShiftRegisterOutBase.hpp.
Enabling and disabling updatables | |
void | enable () |
Enable this updatable: insert it into the linked list of instances, so it gets updated automatically. | |
void | disable () |
Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically. | |
bool | isEnabled () const |
Check if this updatable is enabled. | |
void | moveDown () |
Move down this element in the list. | |
static void | enable (UpdatableCRTP *element) |
Enable this updatable: insert it into the linked list of instances, so it gets updated automatically. | |
static void | enable (UpdatableCRTP &element) |
Enable this updatable: insert it into the linked list of instances, so it gets updated automatically. | |
static void | enable (U(&array)[N]) |
Enable this updatable: insert it into the linked list of instances, so it gets updated automatically. | |
static void | disable (UpdatableCRTP *element) |
Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically. | |
static void | disable (UpdatableCRTP &element) |
Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically. | |
static void | disable (U(&array)[N]) |
Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically. | |
Public Member Functions | |
void | pinMode (pin_int_t pin, PinMode_t mode) override __attribute__((deprecated)) |
The pinMode function is not implemented because the mode is OUTPUT by definition. | |
void | pinModeBuffered (pin_int_t pin, PinMode_t mode) override __attribute__((deprecated)) |
The pinMode function is not implemented because the mode is OUTPUT by definition. | |
void | digitalWrite (pin_int_t pin, PinStatus_t val) override |
Set the state of a given output pin. | |
void | digitalWriteBuffered (pin_int_t pin, PinStatus_t val) override |
Set the output of a given pin in the software buffer. | |
PinStatus_t | digitalRead (pin_int_t pin) override |
Get the current state of a given output pin. | |
PinStatus_t | digitalReadBuffered (pin_int_t pin) override |
Get the current state of a given output pin. | |
analog_t | analogRead (pin_int_t pin) override __attribute__((deprecated)) |
The analogRead function is deprecated because a shift is always digital. | |
analog_t | analogReadBuffered (pin_int_t pin) override __attribute__((deprecated)) |
The analogRead function is deprecated because a shift is always digital. | |
void | analogWrite (pin_int_t pin, analog_t val) override __attribute__((deprecated)) |
The analogWrite function is not deprecated because a shift is always digital. | |
void | analogWriteBuffered (pin_int_t pin, analog_t val) override __attribute__((deprecated)) |
The analogWrite function is not deprecated because a shift is always digital. | |
void | updateBufferedInputs () override |
Shift registers don't have an input buffer. | |
pin_t | red (pin_int_t id) |
Get the red output pin of the given LED. | |
Array< pin_t, N/3 > | redPins () |
Get an array containing all pins with red LEDs. | |
pin_t | green (pin_int_t id) |
Get the green output pin of the given LED. | |
Array< pin_t, N/3 > | greenPins () |
Get an array containing all pins with green LEDs. | |
pin_t | blue (pin_int_t id) |
Get the blue output pin of the given LED. | |
Array< pin_t, N/3 > | bluePins () |
Get an array containing all pins with blue LEDs. | |
Array< pin_t, N > | pins () const |
Get an array containing all pins of the element. | |
virtual void | begin ()=0 |
Initialize the extended IO element. | |
virtual void | updateBufferedOutputs ()=0 |
Write the internal state to the physical outputs. | |
pin_t | pin (pin_int_t pin) const |
Get the extended IO pin number of a given physical pin of this extended IO element. | |
pin_t | operator[] (pin_int_t pin) const |
Get the extended IO pin number of a given physical pin of this extended IO element. | |
pin_int_t | getLength () const |
Get the number of pins this IO element has. | |
pin_t | getEnd () const |
Get the largest global extended IO pin number that belongs to this extended IO element. | |
pin_t | getStart () const |
Get the smallest global extended IO pin number that belongs to this extended IO element. | |
Static Public Member Functions | |
static constexpr uint16_t | length () |
static void | beginAll () |
Initialize all extended IO elements. | |
static void | updateAllBufferedOutputs () |
Write the internal states to the physical outputs for all extended IO elements. | |
static void | updateAllBufferedInputs () |
Read the physical state into the input buffers for all extended IO elements. | |
static DoublyLinkedList< ExtendedIOElement > & | getAll () |
Get the list of all Extended IO elements. | |
Protected Member Functions | |
ShiftRegisterOutBase (pin_t latchPin, BitOrder_t bitOrder) | |
Create a new ShiftRegisterOutBase object with a given bit order, and a given number of outputs. | |
Protected Attributes | |
const pin_t | latchPin |
const BitOrder_t | bitOrder |
BitArray< N > | buffer |
bool | dirty = true |
Node * | next = nullptr |
Node * | previous = nullptr |
Static Protected Attributes | |
static DoublyLinkedList< ExtendedIOElement > | updatables |
Private Attributes | |
const pin_t | start |
const pin_t | end |
Static Private Attributes | |
static pin_t | offset = NUM_DIGITAL_PINS + NUM_ANALOG_INPUTS |
|
protected |
Create a new ShiftRegisterOutBase object with a given bit order, and a given number of outputs.
latchPin | The digital output pin connected to the latch pin (ST_CP or RCLK) of the shift register. |
bitOrder | Either MSBFIRST (most significant bit first) or LSBFIRST (least significant bit first). |
The pinMode function is not implemented because the mode is OUTPUT
by definition.
Reimplemented from ExtendedIOElement.
Definition at line 43 of file ShiftRegisterOutBase.hpp.
The pinMode function is not implemented because the mode is OUTPUT
by definition.
Implements ExtendedIOElement.
Definition at line 52 of file ShiftRegisterOutBase.hpp.
|
overridevirtual |
Set the state of a given output pin.
pin | The shift register pin to set. |
val | The value to set the pin to. (Either HIGH (1) or LOW (0)) |
Reimplemented from ExtendedIOElement.
|
overridevirtual |
Set the output of a given pin in the software buffer.
The buffer is written to the ExtIO device when updateBufferedOutputs is called.
pin | The shift register pin to set. |
val | The value to set the pin to. (Either HIGH (1) or LOW (0)) |
Implements ExtendedIOElement.
|
overridevirtual |
Get the current state of a given output pin.
pin | The shift register pin to read from. |
0 | The state of the pin is LOW . |
1 | The state of the pin is HIGH . |
Reimplemented from ExtendedIOElement.
|
inlineoverridevirtual |
Get the current state of a given output pin.
pin | The shift register pin to read from. |
0 | The state of the pin is LOW . |
1 | The state of the pin is HIGH . |
Implements ExtendedIOElement.
Definition at line 92 of file ShiftRegisterOutBase.hpp.
The analogRead function is deprecated because a shift is always digital.
pin | The shift register pin to read from. |
0 | The state of the pin is LOW . |
1023 | The state of the pin is HIGH . |
Reimplemented from ExtendedIOElement.
Definition at line 106 of file ShiftRegisterOutBase.hpp.
The analogRead function is deprecated because a shift is always digital.
pin | The shift register pin to read from. |
0 | The state of the pin is LOW . |
1023 | The state of the pin is HIGH . |
Implements ExtendedIOElement.
Definition at line 113 of file ShiftRegisterOutBase.hpp.
The analogWrite function is not deprecated because a shift is always digital.
pin | The shift register pin to set. |
val | The value to set the pin to. A value greater or equal to 0x80 will set the pin to a HIGH state, a value less than 0x80 will set the pin to a LOW state. |
Reimplemented from ExtendedIOElement.
Definition at line 128 of file ShiftRegisterOutBase.hpp.
The analogWrite function is not deprecated because a shift is always digital.
pin | The shift register pin to set. |
val | The value to set the pin to. A value greater or equal to 0x80 will set the pin to a HIGH state, a value less than 0x80 will set the pin to a LOW state. |
Implements ExtendedIOElement.
Definition at line 136 of file ShiftRegisterOutBase.hpp.
Shift registers don't have an input buffer.
Implements ExtendedIOElement.
Definition at line 144 of file ShiftRegisterOutBase.hpp.
Get the red output pin of the given LED.
id | The zero-based LED number. |
Get an array containing all pins with red LEDs.
Get the green output pin of the given LED.
id | The zero-based LED number. |
Get an array containing all pins with green LEDs.
Get the blue output pin of the given LED.
id | The zero-based LED number. |
Get an array containing all pins with blue LEDs.
Get an array containing all pins of the element.
Definition at line 24 of file StaticSizeExtendedIOElement.hpp.
Definition at line 28 of file StaticSizeExtendedIOElement.hpp.
Initialize the extended IO element.
Implemented in MAX7219< NumChips, SPIDriver >, MCP23017< WireType >, ShiftRegisterOut< N >, and SPIShiftRegisterOut< N, SPIDriver >.
|
staticinherited |
Initialize all extended IO elements.
Definition at line 17 of file ExtendedIOElement.cpp.
Write the internal state to the physical outputs.
Implemented in MAX7219< NumChips, SPIDriver >, MCP23017< WireType >, ShiftRegisterOut< N >, and SPIShiftRegisterOut< N, SPIDriver >.
|
staticinherited |
Write the internal states to the physical outputs for all extended IO elements.
Definition at line 21 of file ExtendedIOElement.cpp.
|
staticinherited |
Read the physical state into the input buffers for all extended IO elements.
Definition at line 25 of file ExtendedIOElement.cpp.
Get the extended IO pin number of a given physical pin of this extended IO element.
pin | The zero-based physical pin number of this IO element. |
Definition at line 29 of file ExtendedIOElement.cpp.
Get the extended IO pin number of a given physical pin of this extended IO element.
It is alias for ExtendedIOElement::pin
.
pin | The zero-based physical pin number of this IO element. |
Definition at line 45 of file ExtendedIOElement.cpp.
|
inherited |
Get the number of pins this IO element has.
Definition at line 47 of file ExtendedIOElement.cpp.
|
inherited |
Get the largest global extended IO pin number that belongs to this extended IO element.
Definition at line 49 of file ExtendedIOElement.cpp.
|
inherited |
Get the smallest global extended IO pin number that belongs to this extended IO element.
Definition at line 51 of file ExtendedIOElement.cpp.
|
staticinherited |
Get the list of all Extended IO elements.
Definition at line 53 of file ExtendedIOElement.cpp.
|
inlineinherited |
Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.
Definition at line 96 of file Updatable.hpp.
|
inlinestaticinherited |
Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.
Definition at line 125 of file Updatable.hpp.
|
inlinestaticinherited |
Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.
Definition at line 127 of file Updatable.hpp.
Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.
Definition at line 130 of file Updatable.hpp.
|
inlineinherited |
Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.
Definition at line 106 of file Updatable.hpp.
|
inlinestaticinherited |
Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.
Definition at line 136 of file Updatable.hpp.
|
inlinestaticinherited |
Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.
Definition at line 138 of file Updatable.hpp.
Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.
Definition at line 141 of file Updatable.hpp.
|
inlineinherited |
Check if this updatable is enabled.
Definition at line 120 of file Updatable.hpp.
|
inlineinherited |
Move down this element in the list.
Definition at line 147 of file Updatable.hpp.
Definition at line 186 of file ShiftRegisterOutBase.hpp.
|
protected |
Definition at line 187 of file ShiftRegisterOutBase.hpp.
Definition at line 189 of file ShiftRegisterOutBase.hpp.
Definition at line 190 of file ShiftRegisterOutBase.hpp.
Definition at line 265 of file ExtendedIOElement.hpp.
Definition at line 266 of file ExtendedIOElement.hpp.
|
staticprivateinherited |
Definition at line 267 of file ExtendedIOElement.hpp.
|
staticprotectedinherited |
Definition at line 152 of file Updatable.hpp.
Definition at line 320 of file LinkedList.hpp.
Definition at line 321 of file LinkedList.hpp.