A class for serial-in/parallel-out shift registers, like the 74HC595. More...

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

Inheritance diagram for ShiftRegisterOutBase< N >:

Collaboration diagram for ShiftRegisterOutBase< N >:

Public Types
using	Mutex = typename std::conditional< false, DefaultMutEx, EmptyMutex >::type

using	LockGuard = typename std::conditional< false, DefaultLockGuard< Mutex >, EmptyLockGuard< Mutex > >::type

Public Member Functions
void	pinMode (pin_t pin, PinMode_t mode) override __attribute__((deprecated))
	The pinMode function is not implemented because the mode is `OUTPUT` by definition. More...

void	pinModeBuffered (pin_t pin, PinMode_t mode) override __attribute__((deprecated))
	The pinMode function is not implemented because the mode is `OUTPUT` by definition. More...

void	digitalWrite (pin_t pin, PinStatus_t val) override
	Set the state of a given output pin. More...

void	digitalWriteBuffered (pin_t pin, PinStatus_t val) override
	Set the output of a given pin in the software buffer. More...

int	digitalRead (pin_t pin) override
	Get the current state of a given output pin. More...

int	digitalReadBuffered (pin_t pin) override
	Get the current state of a given output pin. More...

analog_t	analogRead (pin_t pin) override __attribute__((deprecated))
	The analogRead function is deprecated because a shift is always digital. More...

analog_t	analogReadBuffered (pin_t pin) override __attribute__((deprecated))
	The analogRead function is deprecated because a shift is always digital. More...

void	analogWrite (pin_t pin, analog_t val) override __attribute__((deprecated))
	The analogWrite function is not deprecated because a shift is always digital. More...

void	analogWriteBuffered (pin_t pin, analog_t val) override __attribute__((deprecated))
	The analogWrite function is not deprecated because a shift is always digital. More...

void	updateBufferedInputs () override
	Shift registers don't have an input buffer. More...

pin_t	red (pin_t id)
	Get the red output pin of the given LED. More...

Array< pin_t, N/3 >	redPins ()
	Get an array containing all pins with red LEDs. More...

pin_t	green (pin_t id)
	Get the green output pin of the given LED. More...

Array< pin_t, N/3 >	greenPins ()
	Get an array containing all pins with green LEDs. More...

pin_t	blue (pin_t id)
	Get the blue output pin of the given LED. More...

Array< pin_t, N/3 >	bluePins ()
	Get an array containing all pins with blue LEDs. More...

Array< pin_t, N >	pins () const
	Get an array containing all pins of the element. More...

virtual void	begin ()=0
	Initialize the extended IO element. More...

virtual void	updateBufferedOutputs ()=0
	Write the internal state to the physical outputs. More...

pin_t	pin (pin_t pin) const
	Get the extended IO pin number of a given physical pin of this extended IO element. More...

pin_t	operator[] (pin_t pin) const
	Get the extended IO pin number of a given physical pin of this extended IO element. More...

pin_t	getLength () const
	Get the number of pins this IO element has. More...

pin_t	getEnd () const
	Get the largest global extended IO pin number that belongs to this extended IO element. More...

pin_t	getStart () const
	Get the smallest global extended IO pin number that belongs to this extended IO element. More...

Static Public Member Functions
static constexpr uint16_t	length ()

static void	beginAll ()
	Initialize all extended IO elements. More...

static void	updateAllBufferedOutputs ()
	Write the internal states to the physical outputs for all extended IO elements. More...

static void	updateAllBufferedInputs ()
	Read the physical state into the input buffers for all extended IO elements. More...

static DoublyLinkedList< ExtendedIOElement > &	getAll ()
	Get the list of all Extended IO elements. More...

static Mutex &	getMutex ()

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. More...

Protected Attributes
const pin_t	latchPin

const BitOrder_t	bitOrder

BitArray< N >	buffer

bool	dirty = true

ExtendedIOElement *	next

ExtendedIOElement *	previous

Static Protected Attributes
static DoublyLinkedList< ExtendedIOElement >	updatables

static Mutex	mutex

Private Attributes
const pin_t	start

const pin_t	end

Static Private Attributes
static pin_t	offset = NUM_DIGITAL_PINS + NUM_ANALOG_INPUTS

Main initialization and updating methods
static void	applyToAll (const LockGuard &, void(Derived::*method)(Args &&...), Args &&... args)

static void	applyToAll (void(Derived::*method)(Args &&...), Args &&... args)

Enabling and disabling updatables
void	enable (const LockGuard &lock)
	Enable this updatable: insert it into the linked list of instances, so it gets updated automatically. More...

void	enable ()
	Enable this updatable: insert it into the linked list of instances, so it gets updated automatically. More...

void	disable (const LockGuard &lock)
	Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically. More...

void	disable ()
	Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically. More...

bool	isEnabled (const LockGuard &) const
	Check if this updatable is enabled. More...

bool	isEnabled ()
	Check if this updatable is enabled. More...

void	moveDown (const LockGuard &)
	Move down this element in the list. More...

void	moveDown ()
	Move down this element in the list. More...

static void	enable (UpdatableCRTP *element)
	Enable this updatable: insert it into the linked list of instances, so it gets updated automatically. More...

static void	enable (UpdatableCRTP &element)
	Enable this updatable: insert it into the linked list of instances, so it gets updated automatically. More...

static void	enable (U(&array)[N])
	Enable this updatable: insert it into the linked list of instances, so it gets updated automatically. More...

static void	disable (UpdatableCRTP *element)
	Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically. More...

static void	disable (UpdatableCRTP &element)
	Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically. More...

static void	disable (U(&array)[N])
	Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically. More...

Detailed Description

template<uint8_t N>
class AH::ShiftRegisterOutBase< N >

A class for serial-in/parallel-out shift registers, like the 74HC595.

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.

Definition at line 26 of file ShiftRegisterOutBase.hpp.

Member Typedef Documentation

◆ Mutex

using Mutex = typename std::conditional<false , DefaultMutEx, EmptyMutex>::type

inherited

Definition at line 36 of file Updatable.hpp.

◆ LockGuard

using LockGuard = typename std::conditional<false , DefaultLockGuard<Mutex>, EmptyLockGuard<Mutex> >::type

inherited

Definition at line 38 of file Updatable.hpp.

Constructor & Destructor Documentation

◆ ShiftRegisterOutBase()

ShiftRegisterOutBase	(	pin_t	latchPin,
		BitOrder_t	bitOrder
	)

protected

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

Parameters

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).

Definition at line 8 of file ShiftRegisterOutBase.ipp.

Member Function Documentation

◆ pinMode()

void pinMode	(	pin_t	pin,
		PinMode_t	mode
	)

inlineoverridevirtual

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

Reimplemented from ExtendedIOElement.

Definition at line 46 of file ShiftRegisterOutBase.hpp.

◆ pinModeBuffered()

void pinModeBuffered	(	pin_t	pin,
		PinMode_t	mode
	)

inlineoverridevirtual

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

Implements ExtendedIOElement.

Definition at line 55 of file ShiftRegisterOutBase.hpp.

◆ digitalWrite()

void digitalWrite	(	pin_t	pin,
		PinStatus_t	val
	)

overridevirtual

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.

Definition at line 13 of file ShiftRegisterOutBase.ipp.

◆ digitalWriteBuffered()

void digitalWriteBuffered	(	pin_t	pin,
		PinStatus_t	val
	)

overridevirtual

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.

Definition at line 20 of file ShiftRegisterOutBase.ipp.

◆ digitalRead()

int digitalRead ( pin_t pin )

overridevirtual

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.

Definition at line 26 of file ShiftRegisterOutBase.ipp.

◆ digitalReadBuffered()

int digitalReadBuffered ( pin_t pin )

inlineoverridevirtual

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 95 of file ShiftRegisterOutBase.hpp.

◆ analogRead()

analog_t analogRead ( pin_t pin )

inlineoverridevirtual

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 109 of file ShiftRegisterOutBase.hpp.

◆ analogReadBuffered()

analog_t analogReadBuffered ( pin_t pin )

inlineoverridevirtual

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 116 of file ShiftRegisterOutBase.hpp.

◆ analogWrite()

void analogWrite	(	pin_t	pin,
		analog_t	val
	)

inlineoverridevirtual

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 131 of file ShiftRegisterOutBase.hpp.

◆ analogWriteBuffered()

void analogWriteBuffered	(	pin_t	pin,
		analog_t	val
	)

inlineoverridevirtual

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 139 of file ShiftRegisterOutBase.hpp.

◆ updateBufferedInputs()

void updateBufferedInputs ( )

inlineoverridevirtual

Shift registers don't have an input buffer.

Implements ExtendedIOElement.

Definition at line 147 of file ShiftRegisterOutBase.hpp.

◆ red()

pin_t red ( pin_t id )

Get the red output pin of the given LED.

Parameters

id	The zero-based LED number.

Definition at line 42 of file ShiftRegisterOutBase.ipp.

◆ redPins()

Array< pin_t, N/3 > redPins

Get an array containing all pins with red LEDs.

Definition at line 47 of file ShiftRegisterOutBase.ipp.

◆ green()

pin_t green ( pin_t id )

Get the green output pin of the given LED.

Parameters

id	The zero-based LED number.

Definition at line 31 of file ShiftRegisterOutBase.ipp.

◆ greenPins()

Array< pin_t, N/3 > greenPins

Get an array containing all pins with green LEDs.

Definition at line 36 of file ShiftRegisterOutBase.ipp.

◆ blue()

pin_t blue ( pin_t id )

Get the blue output pin of the given LED.

Parameters

id	The zero-based LED number.

Definition at line 53 of file ShiftRegisterOutBase.ipp.

◆ bluePins()

Array< pin_t, N/3 > bluePins

Get an array containing all pins with blue LEDs.

Definition at line 58 of file ShiftRegisterOutBase.ipp.

◆ pins()

Array<pin_t, N> pins ( ) const

inlineinherited

Get an array containing all pins of the element.

Definition at line 27 of file StaticSizeExtendedIOElement.hpp.

◆ length()

static constexpr uint16_t length ( )

inlinestaticconstexprinherited

Definition at line 31 of file StaticSizeExtendedIOElement.hpp.

◆ begin()

virtual void begin ( )

pure virtualinherited

Initialize the extended IO element.

Implemented in SPIShiftRegisterOut< N >, ShiftRegisterOut< N >, MAX7219< NumChips >, and AnalogMultiplex< N >.

◆ beginAll()

void beginAll ( )

staticinherited

Initialize all extended IO elements.

Definition at line 20 of file ExtendedIOElement.cpp.

◆ updateBufferedOutputs()

virtual void updateBufferedOutputs ( )

pure virtualinherited

Write the internal state to the physical outputs.

Implemented in SPIShiftRegisterOut< N >, ShiftRegisterOut< N >, MAX7219< NumChips >, and AnalogMultiplex< N >.

◆ updateAllBufferedOutputs()

void updateAllBufferedOutputs ( )

staticinherited

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

Definition at line 24 of file ExtendedIOElement.cpp.

◆ updateAllBufferedInputs()

void updateAllBufferedInputs ( )

staticinherited

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

Definition at line 28 of file ExtendedIOElement.cpp.

◆ pin()

pin_t pin ( pin_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 32 of file ExtendedIOElement.cpp.

◆ operator[]()

pin_t operator[] ( pin_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 47 of file ExtendedIOElement.cpp.

◆ getLength()

pin_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 49 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 51 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 53 of file ExtendedIOElement.cpp.

◆ getAll()

DoublyLinkedList< ExtendedIOElement > & getAll ( )

staticinherited

Get the list of all Extended IO elements.

Definition at line 55 of file ExtendedIOElement.cpp.

◆ getMutex()

static Mutex& getMutex ( )

inlinestaticinherited

Definition at line 79 of file Updatable.hpp.

◆ applyToAll() [1/2]

static void applyToAll	(	const LockGuard &	,
		void(Derived::*)(Args &&...)	method,
		Args &&...	args
	)

inlinestaticinherited

Definition at line 85 of file Updatable.hpp.

◆ applyToAll() [2/2]

static void applyToAll	(	void(Derived::*)(Args &&...)	method,
		Args &&...	args
	)

inlinestaticinherited

Definition at line 93 of file Updatable.hpp.

◆ enable() [1/5]

void enable ( const LockGuard & lock )

inlineinherited

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

Definition at line 106 of file Updatable.hpp.

◆ enable() [2/5]

void enable ( )

inlineinherited

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

Definition at line 115 of file Updatable.hpp.

◆ enable() [3/5]

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 144 of file Updatable.hpp.

◆ enable() [4/5]

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 146 of file Updatable.hpp.

◆ enable() [5/5]

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 149 of file Updatable.hpp.