c_InputArtnet Class Reference

#include <InputArtnet.hpp>

Inheritance diagram for c_InputArtnet:

Collaboration diagram for c_InputArtnet:

Classes
struct	Universe_t

Public Member Functions
	c_InputArtnet (c_InputMgr::e_InputChannelIds NewInputChannelId, c_InputMgr::e_InputType NewChannelType, uint32_t BufferSize)
virtual	~c_InputArtnet ()
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	GetDriverName (String &sDriverName)
	get the name for the instantiated driver
void	SetBufferInfo (uint32_t BufferSize)
void	NetworkStateChanged (bool IsConnected)
bool	isShutDownRebootNeeded ()
virtual void	Process ()
	Call from loop(), renders Input data.
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	SetUpArtnet ()
void	validateConfiguration ()
void	NetworkStateChanged (bool IsConnected, bool RebootAllowed)
void	SetBufferTranslation ()
void	onDmxFrame (uint16_t CurrentUniverseId, uint32_t length, uint8_t sequence, uint8_t *data, IPAddress remoteIP)
void	onDmxPoll (IPAddress broadcastIP)

Private Attributes
Artnet *	pArtnet = nullptr
uint16_t	startUniverse = 1
	JSON configuration parameters.
uint16_t	LastUniverse = 1
	Last Universe to listen for.
uint16_t	ChannelsPerUniverse = UNIVERSE_MAX
	Universe boundary limit.
uint16_t	FirstUniverseChannelOffset = 1
	Channel to start listening at - 1 based.
uint32_t	num_packets = 0
uint32_t	packet_errors = 0
uint32_t	PollCounter = 0
uint8_t	lastData = 255
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_InputArtnet()

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

~c_InputArtnet()

c_InputArtnet::~c_InputArtnet ( )

virtual

Member Function Documentation

Begin()

void c_InputArtnet::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_InputArtnet::GetConfig

(

JsonObject &

jsonConfig

)

Get the current config used by the driver.

Here is the caller graph for this function:

GetDriverName()

void c_InputArtnet::GetDriverName ( String & sDriverName )

inlinevirtual

get the name for the instantiated driver

Implements c_InputCommon.

GetStatus()

void c_InputArtnet::GetStatus ( JsonObject & jsonStatus )

virtual

Implements c_InputCommon.

isShutDownRebootNeeded()

bool c_InputArtnet::isShutDownRebootNeeded ( )

inlinevirtual

Reimplemented from c_InputCommon.

NetworkStateChanged() [1/2]

void c_InputArtnet::NetworkStateChanged ( bool IsConnected )

virtual

Reimplemented from c_InputCommon.

Here is the call graph for this function:

NetworkStateChanged() [2/2]

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

private

Here is the call graph for this function:

Here is the caller graph for this function:

onDmxFrame()

void c_InputArtnet::onDmxFrame ( uint16_t CurrentUniverseId, uint32_t length, uint8_t sequence, uint8_t * data, IPAddress remoteIP )

private

Here is the call graph for this function:

Here is the caller graph for this function:

onDmxPoll()

void c_InputArtnet::onDmxPoll ( IPAddress broadcastIP )

private

Here is the caller graph for this function:

Process()

virtual void c_InputArtnet::Process ( void )

inlinevirtual

Call from loop(), renders Input data.

Implements c_InputCommon.

SetBufferInfo()

void c_InputArtnet::SetBufferInfo ( uint32_t BufferSize )

virtual

Implements c_InputCommon.

Here is the call graph for this function:

SetBufferTranslation()

void c_InputArtnet::SetBufferTranslation ( )

private

Here is the caller graph for this function:

SetConfig()

bool c_InputArtnet::SetConfig

(

JsonObject &

jsonConfig

)

Set a new config in the driver.

Here is the call graph for this function:

SetUpArtnet()

void c_InputArtnet::SetUpArtnet ( )

private

Here is the call graph for this function:

Here is the caller graph for this function:

validateConfiguration()

void c_InputArtnet::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_InputArtnet::channel_count = 0

private

from sketch globals

Number of channels. Derived from output module configuration.

ChannelsPerUniverse

uint16_t c_InputArtnet::ChannelsPerUniverse = UNIVERSE_MAX

private

Universe boundary limit.

ConfigFileName

const char c_InputArtnet::ConfigFileName[]

staticprivate

FirstUniverseChannelOffset

uint16_t c_InputArtnet::FirstUniverseChannelOffset = 1

private

Channel to start listening at - 1 based.

lastData

uint8_t c_InputArtnet::lastData = 255

private

LastUniverse

uint16_t c_InputArtnet::LastUniverse = 1

private

Last Universe to listen for.

MAX_NUM_UNIVERSES

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

staticprivate

num_packets

uint32_t c_InputArtnet::num_packets = 0

private

packet_errors

uint32_t c_InputArtnet::packet_errors = 0

private

pArtnet

Artnet* c_InputArtnet::pArtnet = nullptr

private

PollCounter

uint32_t c_InputArtnet::PollCounter = 0

private

startUniverse

uint16_t c_InputArtnet::startUniverse = 1

private

JSON configuration parameters.

Universe to listen for

UNIVERSE_MAX

const uint16_t c_InputArtnet::UNIVERSE_MAX = 512

staticprivate

UniverseArray

Universe_t c_InputArtnet::UniverseArray[MAX_NUM_UNIVERSES]

private

---

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

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