internals::inputs::validate Namespace Reference

Validation of user-defined input hardware. More...

Functions
template<typename GPIOtype >
void	reserve (const std::vector< GPIOtype > &collection)
	Reserve a collection of GPIO pins.
void	buttonMatrix (const ButtonMatrix &matrix)
	Validate a button matrix.
template<typename PinTags >
void	analogMultiplexer (const OutputGPIOCollection &selectors, const AnalogMultiplexerGroup< PinTags > chips)
	Validate a group of analog multiplexers.
void	shiftRegisterChain (OutputGPIO loadPin, OutputGPIO nextPin, InputGPIO inputPin, const ShiftRegisterChain &chain)
	Validate a chain of PISO shift registers.
template<typename PinTags >
void	GPIOExpander (const GPIOExpanderChip< PinTags > &chip)
	Validate a GPIO expander.
void	rotaryEncoder (InputGPIO dtPin, InputGPIO clkPin, InputNumber cw, InputNumber ccw)
	Validate a rotary encoder.
void	button (InputGPIO pin, InputNumber inputNumber)
	Validate a single button.
void	codedRotarySwitch (const RotaryCodedSwitch &spec, const InputGPIOCollection &inputs)
	Validate a coded rotary switch.

Detailed Description

Validation of user-defined input hardware.

Function Documentation

analogMultiplexer()

template<typename PinTags >

void internals::inputs::validate::analogMultiplexer	(	const OutputGPIOCollection &	selectors,
		const AnalogMultiplexerGroup< PinTags >	chips )

Validate a group of analog multiplexers.

Template Parameters

PinTags

Pin tags

Parameters

selectors	Collection of selector pins
chips	Collections of chips

Definition at line 83 of file InputValidation.hpp.

button()

void internals::inputs::validate::button	(	InputGPIO	pin,
		InputNumber	inputNumber )

Validate a single button.

Parameters

pin	Input pin
inputNumber	Input number

Definition at line 167 of file InputValidation.hpp.

buttonMatrix()

void internals::inputs::validate::buttonMatrix

(

const ButtonMatrix &

matrix

)

Validate a button matrix.

Parameters

matrix

Button matrix to validate

Definition at line 52 of file InputValidation.hpp.

codedRotarySwitch()

void internals::inputs::validate::codedRotarySwitch	(	const RotaryCodedSwitch &	spec,
		const InputGPIOCollection &	inputs )

Validate a coded rotary switch.

Parameters

spec	Specification of input numbers attached to the rotary switch
inputs	Collection of input pins.

Definition at line 181 of file InputValidation.hpp.

GPIOExpander()

template<typename PinTags >

void internals::inputs::validate::GPIOExpander

(

const GPIOExpanderChip< PinTags > &

chip

)

Validate a GPIO expander.

Template Parameters

PinTags

Pin tags

Parameters

chip	Chip instance

Definition at line 127 of file InputValidation.hpp.

reserve()

template<typename GPIOtype >

void internals::inputs::validate::reserve

(

const std::vector< GPIOtype > &

collection

)

Reserve a collection of GPIO pins.

Template Parameters

GPIOtype

GPIO or subtype

Parameters

collection

Pins to reserve

Definition at line 41 of file InputValidation.hpp.

rotaryEncoder()

void internals::inputs::validate::rotaryEncoder	(	InputGPIO	dtPin,
		InputGPIO	clkPin,
		InputNumber	cw,
		InputNumber	ccw )

Validate a rotary encoder.

Parameters

dtPin	DT pin
clkPin	CLK pin
cw	Input number for clockwise rotation
ccw	Input number for counter-clockwise rotation

Definition at line 144 of file InputValidation.hpp.

shiftRegisterChain()

void internals::inputs::validate::shiftRegisterChain	(	OutputGPIO	loadPin,
		OutputGPIO	nextPin,
		InputGPIO	inputPin,
		const ShiftRegisterChain &	chain )

Validate a chain of PISO shift registers.

Parameters

loadPin	Output GPIO attached to LOAD
nextPin	Output GPIO attached to NEXT
inputPin	Input GPIO pin
chain	Collection of chips

Definition at line 101 of file InputValidation.hpp.