c_InputAlexa Class Reference

#include <InputAlexa.h>

Inheritance diagram for c_InputAlexa:

Collaboration diagram for c_InputAlexa:

Public Member Functions
	c_InputAlexa (c_InputMgr::e_InputChannelIds NewInputChannelId, c_InputMgr::e_InputType NewChannelType, uint32_t BufferSize)
virtual	~c_InputAlexa ()
void	Begin ()
	set up the operating environment based on the current config (or defaults)
bool	SetConfig (JsonObject &jsonConfig)
	Set a new config in the driver.
void	GetConfig (JsonObject &jsonConfig)
	Get the current config used by the driver.
void	GetStatus (JsonObject &jsonStatus)
void	Process ()
	Call from loop(), renders Input data.
void	GetDriverName (String &sDriverName)
	get the name for the instantiated driver
void	SetBufferInfo (uint32_t BufferSize)
Public Member Functions inherited from 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
virtual	~c_InputCommon ()
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	SetOperationalState (bool ActiveFlag)
virtual void	NetworkStateChanged (bool IsConnected)
virtual bool	isShutDownRebootNeeded ()
virtual void	ProcessButtonActions (c_ExternalInput::InputValue_t value)
c_InputMgr::e_InputChannelIds	GetInputChannelId ()
c_InputMgr::e_InputType	GetInputType ()

Private Member Functions
void	validateConfiguration ()
void	onMessage (EspalexaDevice *pDevice)
void	load ()
	Load configuration from File System.
void	save ()
	Save configuration to File System.

Private Attributes
Ticker	mqttTicker
c_InputCommon *	pEffectsEngine = nullptr
const char *	ON = "ON"
const char *	OFF = "OFF"
bool	stateOn = false

Additional Inherited Members
Protected Attributes inherited from c_InputCommon
bool	HasBeenInitialized = false
uint32_t	InputDataBufferSize = 0
bool	IsInputChannelActive = true
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_InputAlexa()

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

~c_InputAlexa()

c_InputAlexa::~c_InputAlexa ( )

virtual

Here is the call graph for this function:

Member Function Documentation

Begin()

void c_InputAlexa::Begin ( )

virtual

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

Implements c_InputCommon.

Here is the call graph for this function:

GetConfig()

void c_InputAlexa::GetConfig

(

JsonObject &

jsonConfig

)

Get the current config used by the driver.

GetDriverName()

void c_InputAlexa::GetDriverName ( String & sDriverName )

inlinevirtual

get the name for the instantiated driver

Implements c_InputCommon.

GetStatus()

void c_InputAlexa::GetStatus ( JsonObject & jsonStatus )

virtual

Implements c_InputCommon.

load()

void c_InputAlexa::load ( )

private

Load configuration from File System.

onMessage()

void c_InputAlexa::onMessage ( EspalexaDevice * pDevice )

private

Here is the call graph for this function:

Here is the caller graph for this function:

Process()

void c_InputAlexa::Process ( )

virtual

Call from loop(), renders Input data.

Implements c_InputCommon.

Here is the call graph for this function:

save()

void c_InputAlexa::save ( )

private

Save configuration to File System.

SetBufferInfo()

void c_InputAlexa::SetBufferInfo ( uint32_t BufferSize )

virtual

Implements c_InputCommon.

Here is the call graph for this function:

SetConfig()

bool c_InputAlexa::SetConfig

(

JsonObject &

jsonConfig

)

Set a new config in the driver.

validateConfiguration()

void c_InputAlexa::validateConfiguration ( )

private

Member Data Documentation

mqttTicker

Ticker c_InputAlexa::mqttTicker

private

OFF

const char* c_InputAlexa::OFF = "OFF"

private

ON

const char* c_InputAlexa::ON = "ON"

private

pEffectsEngine

c_InputCommon* c_InputAlexa::pEffectsEngine = nullptr

private

stateOn

bool c_InputAlexa::stateOn = false

private

---

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

• /github/workspace/include/input/InputAlexa.h
• /github/workspace/src/input/InputAlexa.cpp