c_InputCommon Class Reference

#include <InputCommon.hpp>

Inheritance diagram for c_InputCommon:

Public Member Functions
	c_InputCommon (c_InputMgr::e_InputChannelIds NewInputChannelId, c_InputMgr::e_InputType NewChannelType, uint32_t BufferSize)
	< Start up the driver and put it into a safe mode
virtual	~c_InputCommon ()
virtual void	Begin ()=0
	set up the operating environment based on the current config (or defaults)
virtual bool	SetConfig (ArduinoJson::JsonObject &jsonConfig)=0
	Set a new config in the driver.
virtual void	GetConfig (ArduinoJson::JsonObject &jsonConfig)=0
	Get the current config used by the driver.
virtual void	GetStatus (JsonObject &jsonStatus)=0
virtual void	Process (void)=0
	Call from loop(), renders Input data.
virtual void	GetDriverName (String &sDriverName)=0
	get the name for the instantiated driver
virtual void	SetBufferInfo (uint32_t BufferSize)=0
virtual void	SetOperationalState (bool ActiveFlag)
virtual void	NetworkStateChanged (bool IsConnected)
virtual bool	isShutDownRebootNeeded ()
virtual void	ProcessButtonActions (c_ExternalInput::InputValue_t value)
virtual void	ClearStatistics (void)
virtual void	SetBlankTimerIsRunning (bool value)
c_InputMgr::e_InputChannelIds	GetInputChannelId ()
c_InputMgr::e_InputType	GetInputType ()

Protected Attributes
bool	HasBeenInitialized = false
uint32_t	InputDataBufferSize = 0
bool	IsInputChannelActive = true
bool	IsBlankTimerRunning = false
c_InputMgr::e_InputChannelIds	InputChannelId = c_InputMgr::e_InputChannelIds::InputChannelId_ALL
c_InputMgr::e_InputType	ChannelType = c_InputMgr::e_InputType::InputType_Disabled

Constructor & Destructor Documentation

c_InputCommon()

c_InputCommon::c_InputCommon	(	c_InputMgr::e_InputChannelIds	NewInputChannelId,
		c_InputMgr::e_InputType	NewChannelType,
		uint32_t	BufferSize )

< Start up the driver and put it into a safe mode

~c_InputCommon()

c_InputCommon::~c_InputCommon ( )

virtual

Here is the call graph for this function:

Member Function Documentation

Begin()

virtual void c_InputCommon::Begin ( )

pure virtual

set up the operating environment based on the current config (or defaults)

Implemented in c_InputAlexa, c_InputArtnet, c_InputDDP, c_InputDisabled, c_InputE131, c_InputEffectEngine, c_InputFPPRemote, and c_InputMQTT.

ClearStatistics()

void c_InputCommon::ClearStatistics ( void )

virtual

Reimplemented in c_InputArtnet, c_InputDDP, c_InputE131, c_InputFPPRemote, and c_InputMQTT.

GetConfig()

virtual void c_InputCommon::GetConfig ( ArduinoJson::JsonObject & jsonConfig )

pure virtual

Get the current config used by the driver.

GetDriverName()

virtual void c_InputCommon::GetDriverName ( String & sDriverName )

pure virtual

get the name for the instantiated driver

Implemented in c_InputAlexa, c_InputArtnet, c_InputDDP, c_InputDisabled, c_InputE131, c_InputEffectEngine, c_InputFPPRemote, and c_InputMQTT.

GetInputChannelId()

c_InputMgr::e_InputChannelIds c_InputCommon::GetInputChannelId ( )

inline

Here is the caller graph for this function:

GetInputType()

c_InputMgr::e_InputType c_InputCommon::GetInputType ( )

inline

GetStatus()

virtual void c_InputCommon::GetStatus ( JsonObject & jsonStatus )

pure virtual

Implemented in c_InputAlexa, c_InputArtnet, c_InputDDP, c_InputDisabled, c_InputE131, c_InputEffectEngine, c_InputFPPRemote, and c_InputMQTT.

isShutDownRebootNeeded()

virtual bool c_InputCommon::isShutDownRebootNeeded ( )

inlinevirtual

Reimplemented in c_InputArtnet, c_InputDDP, and c_InputE131.

NetworkStateChanged()

virtual void c_InputCommon::NetworkStateChanged ( bool IsConnected )

inlinevirtual

Reimplemented in c_InputArtnet, c_InputDDP, c_InputE131, and c_InputMQTT.

Process()

virtual void c_InputCommon::Process ( void )

pure virtual

Call from loop(), renders Input data.

Implemented in c_InputAlexa, c_InputArtnet, c_InputDDP, c_InputDisabled, c_InputE131, c_InputEffectEngine, c_InputFPPRemote, and c_InputMQTT.

ProcessButtonActions()

virtual void c_InputCommon::ProcessButtonActions ( c_ExternalInput::InputValue_t value )

inlinevirtual

Reimplemented in c_InputEffectEngine, and c_InputFPPRemote.

SetBlankTimerIsRunning()

virtual void c_InputCommon::SetBlankTimerIsRunning ( bool value )

inlinevirtual

Reimplemented in c_InputFPPRemote.

Here is the caller graph for this function:

SetBufferInfo()

virtual void c_InputCommon::SetBufferInfo ( uint32_t BufferSize )

pure virtual

Implemented in c_InputAlexa, c_InputArtnet, c_InputDDP, c_InputDisabled, c_InputE131, c_InputEffectEngine, c_InputFPPRemote, and c_InputMQTT.

SetConfig()

virtual bool c_InputCommon::SetConfig ( ArduinoJson::JsonObject & jsonConfig )

pure virtual

Set a new config in the driver.

SetOperationalState()

virtual void c_InputCommon::SetOperationalState ( bool ActiveFlag )

inlinevirtual

Reimplemented in c_InputFPPRemote.

Here is the caller graph for this function:

Member Data Documentation

ChannelType

c_InputMgr::e_InputType c_InputCommon::ChannelType = c_InputMgr::e_InputType::InputType_Disabled

protected

HasBeenInitialized

bool c_InputCommon::HasBeenInitialized = false

protected

InputChannelId

c_InputMgr::e_InputChannelIds c_InputCommon::InputChannelId = c_InputMgr::e_InputChannelIds::InputChannelId_ALL

protected

InputDataBufferSize

uint32_t c_InputCommon::InputDataBufferSize = 0

protected

IsBlankTimerRunning

bool c_InputCommon::IsBlankTimerRunning = false

protected

IsInputChannelActive

bool c_InputCommon::IsInputChannelActive = true

protected

---

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

• /github/workspace/include/input/InputCommon.hpp
• /github/workspace/src/input/InputCommon.cpp