Input channel events

A comprehensive event class for efficient, maintainable working with input channels. More...

Collaboration diagram for Input channel events:

Namespaces
namespace	qOS::input
	Input Interfaces.

Classes
class	qOS::input::channel
class	qOS::input::digitalChannel
	A digital input-channel object. More...
class	qOS::input::analogChannel
	An analog input-channel object. More...
class	qOS::input::watcher
	The digital input-channel watcher class. More...

Typedefs
using	qOS::input::digitalValue_t
using	qOS::input::analogValue_t
using	qOS::input::digitalReaderFcn_t
	A pointer to the wrapper function that reads the specific digital input-channel.
using	qOS::input::analogReaderFcn_t
	A pointer to the wrapper function that reads the specific analog input-channel.
using	qOS::input::eventCallback_t
	A pointer to the input-channel event callback.

Enumerations
enum class	qOS::input::event {   qOS::input::event::NONE , qOS::input::event::EXCEPTION , qOS::input::event::ON_CHANGE , qOS::input::event::FALLING_EDGE ,   qOS::input::event::RISING_EDGE , qOS::input::event::PULSATION_DOUBLE , qOS::input::event::PULSATION_TRIPLE , qOS::input::event::PULSATION_MULTI ,   qOS::input::event::HIGH_THRESHOLD , qOS::input::event::LOW_THRESHOLD , qOS::input::event::IN_BAND , qOS::input::event::STEADY_IN_HIGH ,   qOS::input::event::STEADY_IN_LOW , qOS::input::event::STEADY_IN_BAND , qOS::input::event::DELTA , qOS::input::event::STEP_UP ,   qOS::input::event::STEP_DOWN }
	An enum with all the possible events that can be detected by the watcher class for a specified input-channel. More...
enum class	qOS::input::type { qOS::input::type::DIGITAL_CHANNEL , qOS::input::type::ANALOG_CHANNEL }
	An enum class to define the types of input channels. More...

Detailed Description

A comprehensive event class for efficient, maintainable working with input channels.

Typedef Documentation

analogReaderFcn_t

using qOS::input::analogReaderFcn_t

A pointer to the wrapper function that reads the specific analog input-channel.

Prototype:

analogValue_t readerFcn( uint8_t channelNumber ) 

analogValue_t

using qOS::input::analogValue_t

digitalReaderFcn_t

using qOS::input::digitalReaderFcn_t

A pointer to the wrapper function that reads the specific digital input-channel.

Prototype:

digitalValue_t readerFcn( uint8_t channelNumber ) 

digitalValue_t

using qOS::input::digitalValue_t

eventCallback_t

using qOS::input::eventCallback_t

A pointer to the input-channel event callback.

Prototype:

void xCallback( input::channel& c ) 

Enumeration Type Documentation

event

enum class qOS::input::event

strong

An enum with all the possible events that can be detected by the watcher class for a specified input-channel.

Enumerator
NONE
EXCEPTION	Error due a bad reading or channel configuration .
ON_CHANGE	Event on any input-channel change when crossing the thresholds
FALLING_EDGE	Event on falling-edge( high to low ) of the digital input-channel
RISING_EDGE	Event on rising-edge( low to high ) of the digital input-channel
PULSATION_DOUBLE	Event when the digital input is pulsated two times within the interval
PULSATION_TRIPLE	Event when the digital input is pulsated three times within the interval
PULSATION_MULTI	Event when the digital input is pulsated more than three times within the interval
HIGH_THRESHOLD	Event when the analog input-channel reading is above the high threshold
LOW_THRESHOLD	Event when the analog input-channel reading is below the low threshold
IN_BAND	Event when the analog input-channel reading enters the band defined by the low-high thresholds
STEADY_IN_HIGH	Event when the input-channel has been kept on high (or above the high threshold) for the specified time .
STEADY_IN_LOW	Event when the input-channel has been kept on low (or below the low threshold) for the specified time .
STEADY_IN_BAND	Event when the analog input-channel has remained within the band for the specified time .
DELTA	Event when the difference of the last and latest reading of an analog input channel is greater than the defined delta
STEP_UP	Event on step reading of the analog-input channel
STEP_DOWN	Event on step reading of the analog-input channel

type

enum class qOS::input::type

strong

An enum class to define the types of input channels.

Enumerator
DIGITAL_CHANNEL	Digital input channel.
ANALOG_CHANNEL	Analog input channel.