#include <InputE131.hpp>

Inheritance diagram for c_InputE131:

Collaboration diagram for c_InputE131:

[legend]

Classes
struct	Universe_t

Public Member Functions
	c_InputE131 (c_InputMgr::e_InputChannelIds NewInputChannelId, c_InputMgr::e_InputType NewChannelType, uint32_t BufferSize)

virtual	~c_InputE131 ()

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)

void	NetworkStateChanged (bool IsConnected)

bool	isShutDownRebootNeeded ()

void	ProcessIncomingE131Data (e131_packet_t *)

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	ProcessButtonActions (c_ExternalInput::InputValue_t value)

c_InputMgr::e_InputChannelIds	GetInputChannelId ()

c_InputMgr::e_InputType	GetInputType ()

Private Member Functions
void	validateConfiguration ()

void	NetworkStateChanged (bool IsConnected, bool RebootAllowed)

void	SetBufferTranslation ()

Private Attributes
ESPAsyncE131 *	e131 = nullptr
	ESPAsyncE131.

uint16_t	startUniverse = 1
	JSON configuration parameters.

uint16_t	LastUniverse = 1
	Last Universe to listen for.

uint16_t	ChannelsPerUniverse = 512
	Universe boundary limit.

uint16_t	FirstUniverseChannelOffset = 1
	Channel to start listening at - 1 based.

ESPAsyncE131PortId	PortId = E131_DEFAULT_PORT

bool	ESPAsyncE131Initialized = false

uint16_t	channel_count = 0
	from sketch globals

Universe_t	UniverseArray [MAX_NUM_UNIVERSES]

Static Private Attributes
static const uint16_t	UNIVERSE_MAX = 512

static const char	ConfigFileName []

static const uint8_t	MAX_NUM_UNIVERSES = (OM_MAX_NUM_CHANNELS / UNIVERSE_MAX) + 1

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_InputE131()

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

◆ ~c_InputE131()

c_InputE131::~c_InputE131 ( )

virtual

Member Function Documentation

◆ Begin()

void c_InputE131::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:

Here is the caller graph for this function:

◆ GetConfig()

void c_InputE131::GetConfig ( JsonObject & jsonConfig )

Get the current config used by the driver.

Here is the caller graph for this function:

◆ GetDriverName()

void c_InputE131::GetDriverName ( String & sDriverName )

inlinevirtual

get the name for the instantiated driver

Implements c_InputCommon.

◆ GetStatus()

void c_InputE131::GetStatus ( JsonObject & jsonStatus )

virtual

Implements c_InputCommon.

◆ isShutDownRebootNeeded()

bool c_InputE131::isShutDownRebootNeeded ( )

inlinevirtual

Reimplemented from c_InputCommon.

◆ NetworkStateChanged() [1/2]

void c_InputE131::NetworkStateChanged ( bool IsConnected )

virtual

Reimplemented from c_InputCommon.

Here is the call graph for this function:

◆ NetworkStateChanged() [2/2]

void c_InputE131::NetworkStateChanged	(	bool	IsConnected,
		bool	RebootAllowed )

private

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Process()

void c_InputE131::Process ( )

virtual

Call from loop(), renders Input data.

Implements c_InputCommon.

◆ ProcessIncomingE131Data()

void c_InputE131::ProcessIncomingE131Data ( e131_packet_t * packet )

Here is the call graph for this function:

◆ SetBufferInfo()

void c_InputE131::SetBufferInfo ( uint32_t BufferSize )

virtual

Implements c_InputCommon.

Here is the call graph for this function:

◆ SetBufferTranslation()

void c_InputE131::SetBufferTranslation ( )

private

Here is the caller graph for this function:

◆ SetConfig()

bool c_InputE131::SetConfig ( JsonObject & jsonConfig )

Set a new config in the driver.

Here is the call graph for this function:

◆ validateConfiguration()

void c_InputE131::validateConfiguration ( )

private

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ channel_count

uint16_t c_InputE131::channel_count = 0

private

from sketch globals

Number of channels. Derived from output module configuration.

◆ ChannelsPerUniverse

uint16_t c_InputE131::ChannelsPerUniverse = 512

private

Universe boundary limit.

◆ ConfigFileName

const char c_InputE131::ConfigFileName[]

staticprivate

◆ e131

ESPAsyncE131* c_InputE131::e131 = nullptr

private

ESPAsyncE131.

◆ ESPAsyncE131Initialized

bool c_InputE131::ESPAsyncE131Initialized = false

private

◆ FirstUniverseChannelOffset

uint16_t c_InputE131::FirstUniverseChannelOffset = 1

private

Channel to start listening at - 1 based.

◆ LastUniverse

uint16_t c_InputE131::LastUniverse = 1

private

Last Universe to listen for.

◆ MAX_NUM_UNIVERSES

const uint8_t c_InputE131::MAX_NUM_UNIVERSES = (OM_MAX_NUM_CHANNELS / UNIVERSE_MAX) + 1

staticprivate

◆ PortId

ESPAsyncE131PortId c_InputE131::PortId = E131_DEFAULT_PORT

private

◆ startUniverse

uint16_t c_InputE131::startUniverse = 1

private

JSON configuration parameters.

Universe to listen for

◆ UNIVERSE_MAX

const uint16_t c_InputE131::UNIVERSE_MAX = 512

staticprivate

◆ UniverseArray

Universe_t c_InputE131::UniverseArray[MAX_NUM_UNIVERSES]

private

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

/github/workspace/include/input/InputE131.hpp
/github/workspace/src/input/InputE131.cpp

Classes

Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ c_InputE131()

◆ ~c_InputE131()

Member Function Documentation

◆ Begin()

◆ GetConfig()

◆ GetDriverName()

◆ GetStatus()

◆ isShutDownRebootNeeded()

◆ NetworkStateChanged() [1/2]

◆ NetworkStateChanged() [2/2]

◆ Process()

◆ ProcessIncomingE131Data()

◆ SetBufferInfo()

◆ SetBufferTranslation()

◆ SetConfig()

◆ validateConfiguration()

Member Data Documentation

◆ channel_count

◆ ChannelsPerUniverse

◆ ConfigFileName

◆ e131

◆ ESPAsyncE131Initialized

◆ FirstUniverseChannelOffset

◆ LastUniverse

◆ MAX_NUM_UNIVERSES

◆ PortId

◆ startUniverse

◆ UNIVERSE_MAX

◆ UniverseArray