c_OutputDisabled Class Reference

#include <OutputDisabled.hpp>

Inheritance diagram for c_OutputDisabled:

Collaboration diagram for c_OutputDisabled:

Public Member Functions
	c_OutputDisabled (c_OutputMgr::e_OutputChannelIds OutputChannelId, gpio_num_t outputGpio, uart_port_t uart, c_OutputMgr::e_OutputType outputType)
virtual	~c_OutputDisabled ()
void	Begin ()
	set up the operating environment based on the current config (or defaults)
bool	SetConfig (ArduinoJson::JsonObject &jsonConfig)
	Set a new config in the driver.
void	GetConfig (ArduinoJson::JsonObject &jsonConfig)
	Get the current config used by the driver.
void	GetStatus (ArduinoJson::JsonObject &jsonConfig)
uint32_t	Poll ()
	Call from loop(), renders output data.
void	GetDriverName (String &sDriverName)
	get the name for the instantiated driver
uint32_t	GetNumOutputBufferBytesNeeded ()
uint32_t	GetNumOutputBufferChannelsServiced ()
Public Member Functions inherited from c_OutputCommon
	c_OutputCommon (c_OutputMgr::e_OutputChannelIds OutputChannelId, gpio_num_t outputGpio, uart_port_t uart, c_OutputMgr::e_OutputType outputType)
	< Start up the driver and put it into a safe mode
virtual	~c_OutputCommon ()
OID_t	GetOutputChannelId ()
	return the output channel number
uint8_t *	GetBufferAddress ()
	Get the address of the buffer into which the E1.31 handler will stuff data.
uint32_t	GetBufferUsedSize ()
	Get the address of the buffer into which the E1.31 handler will stuff data.
gpio_num_t	GetOutputGpio ()
OTYPE_t	GetOutputType ()
	Have the instance report its type.
virtual void	BaseGetStatus (ArduinoJson::JsonObject &jsonStatus)
void	SetOutputBufferAddress (uint8_t *pNewOutputBuffer)
virtual void	SetOutputBufferSize (uint32_t NewOutputBufferSize)
virtual void	PauseOutput (bool NewState)
virtual void	ClearBuffer ()
virtual void	WriteChannelData (uint32_t StartChannelId, uint32_t ChannelCount, byte *pSourceData)
virtual void	ReadChannelData (uint32_t StartChannelId, uint32_t ChannelCount, byte *pTargetData)
virtual bool	ValidateGpio (gpio_num_t ConsoleTxGpio, gpio_num_t ConsoleRxGpio)
virtual bool	DriverIsSendingIntensityData ()
virtual uint32_t	GetFrameTimeMs ()
bool	IsPaused ()

Additional Inherited Members
Public Types inherited from c_OutputCommon
typedef c_OutputMgr::e_OutputChannelIds	OID_t
typedef c_OutputMgr::e_OutputType	OTYPE_t
Protected Member Functions inherited from c_OutputCommon
virtual void	ReportNewFrame ()
bool	canRefresh ()
Protected Attributes inherited from c_OutputCommon
gpio_num_t	DataPin = gpio_num_t (-1)
uart_port_t	UartId = uart_port_t (-1)
OTYPE_t	OutputType = OTYPE_t::OutputType_Disabled
OID_t	OutputChannelId = OID_t::OutputChannelId_End
bool	HasBeenInitialized = false
uint32_t	FrameDurationInMicroSec = 25000
uint32_t	ActualFrameDurationMicroSec = 50000
uint8_t *	pOutputBuffer = nullptr
uint32_t	OutputBufferSize = 0
uint32_t	FrameCount = 0
bool	Paused = false

Constructor & Destructor Documentation

c_OutputDisabled()

c_OutputDisabled::c_OutputDisabled	(	c_OutputMgr::e_OutputChannelIds	OutputChannelId,
		gpio_num_t	outputGpio,
		uart_port_t	uart,
		c_OutputMgr::e_OutputType	outputType )

~c_OutputDisabled()

c_OutputDisabled::~c_OutputDisabled ( )

virtual

Member Function Documentation

Begin()

void c_OutputDisabled::Begin ( )

virtual

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

Reimplemented from c_OutputCommon.

GetConfig()

void c_OutputDisabled::GetConfig ( ArduinoJson::JsonObject & jsonConfig )

virtual

Get the current config used by the driver.

Reimplemented from c_OutputCommon.

GetDriverName()

void c_OutputDisabled::GetDriverName ( String & sDriverName )

inlinevirtual

get the name for the instantiated driver

Implements c_OutputCommon.

GetNumOutputBufferBytesNeeded()

uint32_t c_OutputDisabled::GetNumOutputBufferBytesNeeded ( )

inlinevirtual

Implements c_OutputCommon.

GetNumOutputBufferChannelsServiced()

uint32_t c_OutputDisabled::GetNumOutputBufferChannelsServiced ( )

inlinevirtual

Implements c_OutputCommon.

GetStatus()

void c_OutputDisabled::GetStatus ( ArduinoJson::JsonObject & jsonConfig )

inlinevirtual

Implements c_OutputCommon.

Poll()

uint32_t c_OutputDisabled::Poll ( )

virtual

Call from loop(), renders output data.

Implements c_OutputCommon.

SetConfig()

bool c_OutputDisabled::SetConfig ( ArduinoJson::JsonObject & jsonConfig )

virtual

Set a new config in the driver.

Reimplemented from c_OutputCommon.

---

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

• /github/workspace/include/output/OutputDisabled.hpp
• /github/workspace/src/output/OutputDisabled.cpp