Inheritance diagram for Supla::Control::RGBWBase:

[legend]

Collaboration diagram for Supla::Control::RGBWBase:

[legend]

Public Types
enum	ButtonControlType : uint8_t { BUTTON_FOR_RGBW , BUTTON_FOR_RGB , BUTTON_FOR_W , BUTTON_NOT_USED }

enum class	AutoIterateMode : uint8_t { OFF , DIMMER , RGB , ALL }

Public Member Functions
virtual void	setRGBWValueOnDevice (uint32_t red, uint32_t green, uint32_t blue, uint32_t colorBrightness, uint32_t brightness)=0

virtual void	setRGBW (int red, int green, int blue, int colorBrightness, int brightness, bool toggle=false, bool instant=false)

int32_t	handleNewValueFromServer (TSD_SuplaChannelNewValue *newValue) override
	Handles "new value" request from server.

virtual void	turnOn ()

virtual void	turnOff ()

virtual void	toggle ()

bool	isOn ()

bool	isOnW ()

bool	isOnRGB ()

void	handleAction (int event, int action) override

void	setStep (int step)

void	setDefaultDimmedBrightness (int dimmedBrightness)

void	setFadeEffectTime (int timeMs)

void	setMinIterationBrightness (uint8_t minBright)

void	setMinMaxIterationDelay (uint16_t delayMs)

void	onInit () override
	Third method called on element in SuplaDevice.begin()

void	iterateAlways () override
	Method called on each SuplaDevice iteration.

void	onFastTimer () override
	Method called on fast timer interupt.

void	onLoadState () override
	Second method called on element in SuplaDevice.begin().

void	onSaveState () override
	Method called periodically during SuplaDevice iteration.

void	onLoadConfig (SuplaDeviceClass *) override
	First method called on element in SuplaDevice.begin().

void	attach (Supla::Control::Button *)

void	fillSuplaChannelNewValue (TSD_SuplaChannelNewValue *value) override
	Fills TSD_SuplaChannelNewValue based on current state.

virtual RGBWBase &	setDefaultStateOn ()

virtual RGBWBase &	setDefaultStateOff ()

virtual RGBWBase &	setDefaultStateRestore ()

virtual RGBWBase &	setBrightnessLimits (int min, int max)

virtual RGBWBase &	setColorBrightnessLimits (int min, int max)

void	setBrightnessAdjuster (BrightnessAdjuster *adjuster)

int	getCurrentDimmerBrightness () const

int	getCurrentRGBBrightness () const

void	setMaxHwValue (int newMaxHwValue)

Public Member Functions inherited from Supla::ChannelElement
	ChannelElement (int channelNumber=-1)

Channel *	getChannel () override

const Channel *	getChannel () const override
	Returns pointer to main channel.

Public Member Functions inherited from Supla::ElementWithChannelActions
void	addAction (uint16_t action, ActionHandler &client, uint16_t event, bool alwaysEnabled=false) override

void	addAction (uint16_t action, ActionHandler *client, uint16_t event, bool alwaysEnabled=false) override

virtual void	addAction (uint16_t action, ActionHandler &client, Supla::Condition *condition, bool alwaysEnabled=false)

virtual void	addAction (uint16_t action, ActionHandler client, Supla::Condition condition, bool alwaysEnabled=false)

bool	isEventAlreadyUsed (uint16_t event, bool ignoreAlwaysEnabled) override

void	onRegistered (Supla::Protocol::SuplaSrpc *suplaSrpc) override
	Method called each time when device successfully registers to Supla server.

bool	iterateConnected () override
	Method called on each SuplaDevice iteration when device is connected and registered to Supla server or other protocol.

void	handleChannelConfigFinished () override
	Handles "channel config finished" message from server.

uint8_t	handleChannelConfig (TSD_ChannelConfig *result, bool local) override
	Handles "set channel config" request from server.

void	handleSetChannelConfigResult (TSDS_SetChannelConfigResult *result) override
	Handles "set channel config" reply from server.

void	purgeConfig () override
	Removes all configration data related to the element from Storage::Config.

void	clearChannelConfigChangedFlag ()

void	runAction (uint16_t event) const override

virtual bool	setAndSaveFunction (_supla_int_t channelFunction)

virtual bool	loadFunctionFromConfig ()

virtual bool	saveConfigChangeFlag ()

virtual bool	loadConfigChangeFlag ()

bool	isAnyUpdatePending () override
	Returns true if any update is pending.

virtual uint8_t	applyChannelConfig (TSD_ChannelConfig *result, bool local)

virtual void	fillChannelConfig (void channelConfig, int size)

virtual void	fillChannelOcrConfig (void channelConfig, int size)

void	triggerSetChannelConfig ()

Public Member Functions inherited from Supla::Element
Element *	next ()
	Returns next Element from the list.

virtual bool	iterateConnected (void *ptr)
	deprecated

virtual void	onTimer ()
	Method called on timer interupt.

virtual void	onSoftReset ()
	Method called when device soft restart is triggered.

virtual void	onDeviceConfigChange (uint64_t fieldBit)
	Method called when device config is changed.

virtual void	handleGetChannelState (TDSC_ChannelState *channelState)
	Handles "get channel state (i)" request from server.

virtual int	handleCalcfgFromServer (TSD_DeviceCalCfgRequest *request)
	Handles CALCFG requests from server.

virtual uint8_t	handleWeeklySchedule (TSD_ChannelConfig *newWeeklySchedule, bool altSchedule=false, bool local=false)
	Handles "set channel config" with "weekly schedule" type request from server.

int	getChannelNumber () const
	Returns channel number.

int	getSecondaryChannelNumber () const
	Returns secondary channel number.

virtual bool	isOwnerOfSubDeviceId (int subDeviceId) const
	Returns true if element is owner of subDeviceId.

virtual const Channel *	getSecondaryChannel () const
	Returns pointer to secondary channel.

virtual Channel *	getSecondaryChannel ()

virtual void	generateKey (char output, const char key) const
	Generates key used for Config.

Element &	disableChannelState ()
	Disables channel state (i) function.

bool	isChannelStateEnabled () const
	Returns true if channel state (i) function is enabled.

void	setInitialCaption (const char *caption, bool secondaryChannel=false)
	Sets initial caption.

void	setDefaultFunction (int32_t defaultFunction)
	Sets default channel's function.

Public Member Functions inherited from Supla::LocalAction
virtual ActionHandlerClient *	getHandlerForFirstClient (uint16_t event)

virtual ActionHandlerClient *	getHandlerForClient (ActionHandler *client, uint16_t event)

virtual void	disableOtherClients (const ActionHandler &client, uint16_t event)

virtual void	enableOtherClients (const ActionHandler &client, uint16_t event)

virtual void	disableOtherClients (const ActionHandler *client, uint16_t event)

virtual void	enableOtherClients (const ActionHandler *client, uint16_t event)

virtual void	disableAction (int32_t action, ActionHandler *client, int32_t event)

virtual void	enableAction (int32_t action, ActionHandler *client, int32_t event)

virtual bool	disableActionsInConfigMode ()

Public Member Functions inherited from Supla::ActionHandler
virtual void	activateAction (int action)

virtual bool	deleteClient ()

virtual ActionHandler *	getRealClient ()

Protected Member Functions
uint8_t	addWithLimit (int value, int addition, int limit=255)

virtual void	iterateDimmerRGBW (int rgbStep, int wStep)

int	adjustBrightness (int value)

int	getStep (int step, int target, int current, int distance) const

bool	calculateAndUpdate (int targetValue, uint16_t hwValue, int distance, uint32_t lastChangeMs) const

Protected Member Functions inherited from Supla::ElementWithChannelActions
virtual bool	hasOcrConfig () const

virtual bool	isOcrConfigMissing () const

virtual void	clearOcrConfig ()

Protected Attributes
bool	valueChanged = true

uint8_t	buttonStep = 10

uint8_t	curRed = 0

uint8_t	curGreen = 255

uint8_t	curBlue = 0

uint8_t	curColorBrightness = 0

uint8_t	curBrightness = 0

uint8_t	lastColorBrightness = 100

uint8_t	lastBrightness = 100

uint8_t	defaultDimmedBrightness = 20

bool	dimIterationDirection = false

bool	resetDisance = false

bool	instant = false

int8_t	stateOnInit = RGBW_STATE_ON_INIT_RESTORE

uint8_t	minIterationBrightness = 1

enum ButtonControlType	buttonControlType = BUTTON_FOR_RGBW

enum AutoIterateMode	autoIterateMode = AutoIterateMode::OFF

uint16_t	maxHwValue = 1023

uint16_t	hwRed = 0

uint16_t	hwGreen = 0

uint16_t	hwBlue = 0

uint16_t	hwColorBrightness = 0

uint16_t	hwBrightness = 0

uint16_t	minBrightness = 1

uint16_t	maxBrightness = 1023

uint16_t	minColorBrightness = 1

uint16_t	maxColorBrightness = 1023

uint16_t	redDistance = 0

uint16_t	greenDistance = 0

uint16_t	blueDistance = 0

uint16_t	colorBrightnessDistance = 0

uint16_t	brightnessDistance = 0

uint16_t	minMaxIterationDelay = 750

uint16_t	fadeEffect = 500

uint32_t	lastTick = 0

uint32_t	lastChangeRedMs = 0

uint32_t	lastChangeGreenMs = 0

uint32_t	lastChangeBlueMs = 0

uint32_t	lastChangeColorBrightnessMs = 0

uint32_t	lastChangeBrightnessMs = 0

uint32_t	lastMsgReceivedMs = 0

uint32_t	lastIterateDimmerTimestamp = 0

uint32_t	iterationDelayTimestamp = 0

uint32_t	lastAutoIterateStartTimestamp = 0

BrightnessAdjuster *	brightnessAdjuster = nullptr

Supla::Control::Button *	attachedButton = nullptr

Protected Attributes inherited from Supla::ChannelElement
Channel	channel

Protected Attributes inherited from Supla::ElementWithChannelActions
Supla::ChannelConfigState	channelConfigState

bool	configFinishedReceived = false

uint8_t	setChannelConfigAttempts = 0

Protected Attributes inherited from Supla::Element
Element *	nextPtr = nullptr

Additional Inherited Members
Static Public Member Functions inherited from Supla::Element
static Element *	begin ()
	Returns first Element (based on creation order)

static Element *	last ()
	Returns last Element (based on creation order)

static Element *	getElementByChannelNumber (int channelNumber)
	Returns Element by channel number.

static Element *	getOwnerOfSubDeviceId (int subDeviceId)
	Returns Element which owns given subDeviceId.

static bool	IsAnyUpdatePending ()
	Checks if any element has pending update for remote server.

static void	NotifyElementsAboutConfigChange (uint64_t fieldBit)
	Notifies all elements about device config change.

static bool	IsInvalidPtrSet ()
	When "invalid pointer" is set, previously obtained Element pointer may be invalid.

static void	ClearInvalidPtr ()
	Clears "invalid pointer" flag.

Static Public Member Functions inherited from Supla::LocalAction
static void	DeleteActionsHandledBy (const ActionHandler *client)

static void	DeleteActionsTriggeredBy (const LocalAction *action)

static void	NullifyActionsHandledBy (const ActionHandler *client)

static ActionHandlerClient *	getClientListPtr ()

Static Protected Attributes inherited from Supla::Element
static Element *	firstPtr = nullptr

static bool	invalidatePtr = false

Member Function Documentation

◆ fillSuplaChannelNewValue()

void Supla::Control::RGBWBase::fillSuplaChannelNewValue ( TSD_SuplaChannelNewValue * value )

overridevirtual

Fills TSD_SuplaChannelNewValue based on current state.

Parameters

value pointer to TSD_SuplaChannelNewValue which should be filled

Reimplemented from Supla::Element.

◆ handleAction()

void Supla::Control::RGBWBase::handleAction	(	int	event,
		int	action )

overridevirtual

Implements Supla::ActionHandler.

◆ handleNewValueFromServer()

int32_t Supla::Control::RGBWBase::handleNewValueFromServer ( TSD_SuplaChannelNewValue * newValue )

overridevirtual

Handles "new value" request from server.

Parameters

newValue pointer to TSD_SuplaChannelNewValue

Returns: -1 - don't send reply to server 0 - success==false 1 - success==true

Reimplemented from Supla::Element.

◆ iterateAlways()

void Supla::Control::RGBWBase::iterateAlways ( )

overridevirtual

Method called on each SuplaDevice iteration.

It should provide all actions that have to be executed periodically regardless of network state.

Reimplemented from Supla::Element.

◆ onFastTimer()

void Supla::Control::RGBWBase::onFastTimer ( )

overridevirtual

Method called on fast timer interupt.

It should provide all actions that have to be executed periodically regardless of other SuplaDevice activities. It is usually called every 1 ms (or 0.5 ms for Arduino Mega).

Reimplemented from Supla::Element.

◆ onInit()

void Supla::Control::RGBWBase::onInit ( )

overridevirtual

Third method called on element in SuplaDevice.begin()

Method called during SuplaDevice initialization. I.e. load initial state, initialize pins etc.

Reimplemented from Supla::Element.

Reimplemented in Supla::Control::RGBWLeds.

◆ onLoadConfig()

void Supla::Control::RGBWBase::onLoadConfig ( SuplaDeviceClass * sdc )

overridevirtual

First method called on element in SuplaDevice.begin().

Called only if Config Storage class is configured. Element should read its configration in this method.

Parameters

sdc

Reimplemented from Supla::Element.

◆ onLoadState()

void Supla::Control::RGBWBase::onLoadState ( )

overridevirtual

Second method called on element in SuplaDevice.begin().

Method called during state Storage initialization (i.e. read from EEPROM, FRAM). Called only if Storage class is configured.

Reimplemented from Supla::Element.

◆ onSaveState()

void Supla::Control::RGBWBase::onSaveState ( )

overridevirtual

Method called periodically during SuplaDevice iteration.

It should provide state saving for this elemnet to Storage

Reimplemented from Supla::Element.

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

src/supla/control/rgbw_base.h
src/supla/control/rgbw_base.cpp

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Member Function Documentation

◆ fillSuplaChannelNewValue()

◆ handleAction()

◆ handleNewValueFromServer()

◆ iterateAlways()

◆ onFastTimer()

◆ onInit()

◆ onLoadConfig()

◆ onLoadState()

◆ onSaveState()