#include <AH/Hardware/ExtendedInputOutput/SPIShiftRegisterOut.hpp>

Detailed Description

template<uint16_t N, class SPIDriver = decltype(SPI) &>
class AH::SPIShiftRegisterOut< N, SPIDriver >

A class for serial-in/parallel-out shift registers, like the 74HC595 that are connected to the SPI bus.

Template Parameters

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.
SPIDriver	The SPI class to use. Usually, the default is fine.

Examples: Custom-USB-MIDI-Backend.ino, and Keyboard-Matrix-BCD.ino.

Definition at line 28 of file SPIShiftRegisterOut.hpp.

Inheritance diagram for SPIShiftRegisterOut< N, SPIDriver >:

Collaboration diagram for SPIShiftRegisterOut< N, SPIDriver >:

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
	SPIShiftRegisterOut (SPIDriver spi, pin_t latchPin=SS, BitOrder_t bitOrder=MSBFIRST)
	Create a new SPIShiftRegisterOut object with a given bit order, and a given number of outputs.

void	begin () override
	Initialize the shift register.

void	updateBufferedOutputs () override
	Write the state buffer to the physical outputs.

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.

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.

Public Attributes
SPISettings	settings {SPI_MAX_SPEED, this->bitOrder, SPI_MODE0}

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
SPIDriver	spi

const pin_t	start

const pin_t	end

Static Private Attributes
static pin_t	offset = NUM_DIGITAL_PINS + NUM_ANALOG_INPUTS

Constructor & Destructor Documentation

◆ SPIShiftRegisterOut()

template<uint16_t N, class SPIDriver = decltype(SPI) &>

SPIShiftRegisterOut	(	SPIDriver	spi,
		pin_t	latchPin = SS,
		BitOrder_t	bitOrder = MSBFIRST )

Create a new SPIShiftRegisterOut object with a given bit order, and a given number of outputs.

Multiple shift registers can be cascaded by connecting the serial output of the first one to the input of the second one:

SCK   >───────────┬──────────────────────┬───────── ⋯
          ┏━━━━━━━┷━━━━━━━┓      ┏━━━━━━━┷━━━━━━━┓ 
          ┃     SH_CP     ┃      ┃     SH_CP     ┃ 
MOSI  >───┨ DS        Q7S ┠──────┨ DS        Q7S ┠─ ⋯
          ┃     ST_CP     ┃      ┃     ST_CP     ┃ 
          ┗━━━━━━━┯━━━━━━━┛      ┗━━━━━━━┯━━━━━━━┛ 
CS    >───────────┴──────────────────────┴───────── ⋯

Parameters

spi	The SPI interface to use.
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).

Member Function Documentation

◆ begin()

template<uint16_t N, class SPIDriver = decltype(SPI) &>

void begin ( )

overridevirtual

Initialize the shift register.

Setup the SPI interface, set the CS pin to output mode, and set all shift register outputs to LOW.

Implements ExtendedIOElement.

Examples: 1.AnalogReadSerial.ino, 2.DigitalReadSerial.ino, 3.FilteredAnalogReadSerial.ino, Custom-MIDI-Output-Element-Bankable.ino, Custom-MIDI-Output-Element.ino, Custom-USB-MIDI-Backend.ino, Keyboard-Matrix-BCD.ino, and Toggle-LEDs.ino.

◆ updateBufferedOutputs()

template<uint16_t N, class SPIDriver = decltype(SPI) &>

void updateBufferedOutputs ( )

overridevirtual

Write the state buffer to the physical outputs.

Implements ExtendedIOElement.

◆ pinMode()

template<uint16_t N>

void pinMode	(	pin_int_t	pin,
		PinMode_t	mode )

inlineoverridevirtualinherited

The pinMode function is not implemented because the mode is OUTPUT by definition.

Reimplemented from ExtendedIOElement.

Examples: 2.DigitalReadSerial.ino.

Definition at line 43 of file ShiftRegisterOutBase.hpp.

◆ pinModeBuffered()

template<uint16_t N>

void pinModeBuffered	(	pin_int_t	pin,
		PinMode_t	mode )

inlineoverridevirtualinherited

The pinMode function is not implemented because the mode is OUTPUT by definition.

Implements ExtendedIOElement.

Definition at line 52 of file ShiftRegisterOutBase.hpp.

◆ digitalWrite()

template<uint16_t N>

void digitalWrite	(	pin_int_t	pin,
		PinStatus_t	val )

overridevirtualinherited

Set the state of a given output pin.

Parameters

pin	The shift register pin to set.
val	The value to set the pin to. (Either `HIGH` (1) or `LOW` (0))

Reimplemented from ExtendedIOElement.

Examples: Toggle-LEDs.ino.

◆ digitalWriteBuffered()

template<uint16_t N>

void digitalWriteBuffered	(	pin_int_t	pin,
		PinStatus_t	val )

overridevirtualinherited

Set the output of a given pin in the software buffer.

The buffer is written to the ExtIO device when updateBufferedOutputs is called.

Parameters

pin	The shift register pin to set.
val	The value to set the pin to. (Either `HIGH` (1) or `LOW` (0))

Implements ExtendedIOElement.

◆ digitalRead()

template<uint16_t N>

PinStatus_t digitalRead ( pin_int_t pin )

overridevirtualinherited

Get the current state of a given output pin.

Parameters

pin	The shift register pin to read from.

Return values

0	The state of the pin is `LOW`.
1	The state of the pin is `HIGH`.

Reimplemented from ExtendedIOElement.

◆ digitalReadBuffered()

template<uint16_t N>

PinStatus_t digitalReadBuffered ( pin_int_t pin )

inlineoverridevirtualinherited

Get the current state of a given output pin.

Parameters

pin	The shift register pin to read from.

Return values

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.

◆ analogRead()

template<uint16_t N>

analog_t analogRead ( pin_int_t pin )

inlineoverridevirtualinherited

The analogRead function is deprecated because a shift is always digital.

Parameters

pin	The shift register pin to read from.

Return values

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.

◆ analogReadBuffered()

template<uint16_t N>

analog_t analogReadBuffered ( pin_int_t pin )

inlineoverridevirtualinherited

The analogRead function is deprecated because a shift is always digital.

Parameters

pin	The shift register pin to read from.

Return values

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.

◆ analogWrite()

template<uint16_t N>

void analogWrite	(	pin_int_t	pin,
		analog_t	val )

inlineoverridevirtualinherited

The analogWrite function is not deprecated because a shift is always digital.

Parameters

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.

◆ analogWriteBuffered()

template<uint16_t N>

void analogWriteBuffered	(	pin_int_t	pin,
		analog_t	val )

inlineoverridevirtualinherited

The analogWrite function is not deprecated because a shift is always digital.

Parameters

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.

◆ updateBufferedInputs()

template<uint16_t N>

void updateBufferedInputs ( )

inlineoverridevirtualinherited

Shift registers don't have an input buffer.

Implements ExtendedIOElement.

Definition at line 144 of file ShiftRegisterOutBase.hpp.

◆ red()

template<uint16_t N>

pin_t red ( pin_int_t id )

inherited

Get the red output pin of the given LED.

Parameters

id	The zero-based LED number.

◆ redPins()

template<uint16_t N>

Array< pin_t, N/3 > redPins ( )

inherited

Get an array containing all pins with red LEDs.

◆ green()

template<uint16_t N>

pin_t green ( pin_int_t id )

inherited

Get the green output pin of the given LED.

Parameters

id	The zero-based LED number.

◆ greenPins()

template<uint16_t N>

Array< pin_t, N/3 > greenPins ( )

inherited

Get an array containing all pins with green LEDs.

◆ blue()

template<uint16_t N>

pin_t blue ( pin_int_t id )

inherited

Get the blue output pin of the given LED.

Parameters

id	The zero-based LED number.

◆ bluePins()

template<uint16_t N>

Array< pin_t, N/3 > bluePins ( )

inherited

Get an array containing all pins with blue LEDs.

◆ pins()

template<uint16_t N>

Array< pin_t, N > pins ( ) const

inlineinherited

Get an array containing all pins of the element.

Definition at line 24 of file StaticSizeExtendedIOElement.hpp.

◆ length()

template<uint16_t N>

static constexpr uint16_t length ( )

inlinestaticconstexprinherited

Examples: Toggle-LEDs.ino.

Definition at line 28 of file StaticSizeExtendedIOElement.hpp.

◆ beginAll()

void beginAll ( )

staticinherited

Initialize all extended IO elements.

Definition at line 17 of file ExtendedIOElement.cpp.

◆ updateAllBufferedOutputs()

void updateAllBufferedOutputs ( )

staticinherited

Write the internal states to the physical outputs for all extended IO elements.

Definition at line 21 of file ExtendedIOElement.cpp.

◆ updateAllBufferedInputs()

void updateAllBufferedInputs ( )

staticinherited

Read the physical state into the input buffers for all extended IO elements.

Definition at line 25 of file ExtendedIOElement.cpp.

◆ pin()

pin_t pin ( pin_int_t pin ) const

inherited

Get the extended IO pin number of a given physical pin of this extended IO element.

Parameters

pin	The zero-based physical pin number of this IO element.

Returns: The global, unique extended IO pin number for the given pin.

Definition at line 29 of file ExtendedIOElement.cpp.

◆ operator[]()

pin_t operator[] ( pin_int_t pin ) const

inherited

Get the extended IO pin number of a given physical pin of this extended IO element.

It is alias for ExtendedIOElement::pin.

Parameters

pin	The zero-based physical pin number of this IO element.

Returns: The global, unique extended IO pin number for the given pin.

Definition at line 45 of file ExtendedIOElement.cpp.

◆ getLength()

pin_int_t getLength ( ) const

inherited

Get the number of pins this IO element has.

Returns: The number of pins this IO element has.

Definition at line 47 of file ExtendedIOElement.cpp.

◆ getEnd()

pin_t getEnd ( ) const

inherited

Get the largest global extended IO pin number that belongs to this extended IO element.

Definition at line 49 of file ExtendedIOElement.cpp.

◆ getStart()

pin_t getStart ( ) const

inherited

Get the smallest global extended IO pin number that belongs to this extended IO element.

Definition at line 51 of file ExtendedIOElement.cpp.

◆ getAll()

DoublyLinkedList< ExtendedIOElement > & getAll ( )

staticinherited

Get the list of all Extended IO elements.

Definition at line 53 of file ExtendedIOElement.cpp.

◆ enable() [1/4]

void enable ( )

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.

◆ enable() [2/4]

static void enable ( UpdatableCRTP< ExtendedIOElement > * element )

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.

◆ enable() [3/4]

static void enable ( UpdatableCRTP< ExtendedIOElement > & element )

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() [4/4]

static void enable ( U(&) array[N] )

inlinestaticinherited

Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.

Definition at line 130 of file Updatable.hpp.

◆ disable() [1/4]

void disable ( )

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.

◆ disable() [2/4]

static void disable ( UpdatableCRTP< ExtendedIOElement > * element )

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.

◆ disable() [3/4]

static void disable ( UpdatableCRTP< ExtendedIOElement > & element )

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() [4/4]

static void disable ( U(&) array[N] )

inlinestaticinherited

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.

◆ isEnabled()

bool isEnabled ( ) const

inlineinherited

Check if this updatable is enabled.

Note: Assumes that the updatable is not added to a different linked list by the user.

Definition at line 120 of file Updatable.hpp.

◆ moveDown()

void moveDown ( )

inlineinherited

Move down this element in the list.

Definition at line 147 of file Updatable.hpp.

Member Data Documentation

◆ spi

template<uint16_t N, class SPIDriver = decltype(SPI) &>

SPIDriver spi

private

Definition at line 72 of file SPIShiftRegisterOut.hpp.

◆ settings

template<uint16_t N, class SPIDriver = decltype(SPI) &>

SPISettings settings {SPI_MAX_SPEED, this->bitOrder, SPI_MODE0}

Definition at line 75 of file SPIShiftRegisterOut.hpp.

◆ latchPin

template<uint16_t N>

const pin_t latchPin

protectedinherited

Definition at line 186 of file ShiftRegisterOutBase.hpp.

◆ bitOrder

template<uint16_t N>

const BitOrder_t bitOrder

protectedinherited

Definition at line 187 of file ShiftRegisterOutBase.hpp.

◆ buffer

template<uint16_t N>

BitArray<N> buffer

protectedinherited

Definition at line 189 of file ShiftRegisterOutBase.hpp.

◆ dirty

template<uint16_t N>

bool dirty = true

protectedinherited

Definition at line 190 of file ShiftRegisterOutBase.hpp.

◆ start

const pin_t start

privateinherited

Definition at line 265 of file ExtendedIOElement.hpp.

◆ end

const pin_t end

privateinherited

Definition at line 266 of file ExtendedIOElement.hpp.

◆ offset

pin_t offset = NUM_DIGITAL_PINS + NUM_ANALOG_INPUTS

staticprivateinherited

Definition at line 267 of file ExtendedIOElement.hpp.

◆ updatables

DoublyLinkedList< ExtendedIOElement > updatables

staticprotectedinherited

Definition at line 152 of file Updatable.hpp.

◆ next

template<class Node >

Node* next = nullptr

protectedinherited

Definition at line 320 of file LinkedList.hpp.

◆ previous

template<class Node >

Node* previous = nullptr

protectedinherited

Definition at line 321 of file LinkedList.hpp.

The documentation for this class was generated from the following file:

SPIShiftRegisterOut.hpp

Detailed Description

Enabling and disabling updatables

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Attributes

Static Protected Attributes

Private Attributes

Static Private Attributes

Constructor & Destructor Documentation

◆ SPIShiftRegisterOut()

Member Function Documentation

◆ begin()

◆ updateBufferedOutputs()

◆ pinMode()

◆ pinModeBuffered()

◆ digitalWrite()

◆ digitalWriteBuffered()

◆ digitalRead()

◆ digitalReadBuffered()

◆ analogRead()

◆ analogReadBuffered()

◆ analogWrite()

◆ analogWriteBuffered()

◆ updateBufferedInputs()

◆ red()

◆ redPins()

◆ green()

◆ greenPins()

◆ blue()

◆ bluePins()

◆ pins()

◆ length()

◆ beginAll()

◆ updateAllBufferedOutputs()

◆ updateAllBufferedInputs()

◆ pin()

◆ operator[]()

◆ getLength()

◆ getEnd()

◆ getStart()

◆ getAll()

◆ enable() [1/4]

◆ enable() [2/4]

◆ enable() [3/4]

◆ enable() [4/4]

◆ disable() [1/4]

◆ disable() [2/4]

◆ disable() [3/4]

◆ disable() [4/4]

◆ isEnabled()

◆ moveDown()

Member Data Documentation

◆ spi

◆ settings

◆ latchPin

◆ bitOrder

◆ buffer

◆ dirty

◆ start

◆ end

◆ offset

◆ updatables

◆ next

◆ previous