Inheritance diagram for Supla::Control::ManagedRollerShutter:

[legend]

Collaboration diagram for Supla::Control::ManagedRollerShutter:

[legend]

Public Member Functions
	ManagedRollerShutter (Supla::Io::IoPin pinUp, Supla::Io::IoPin pinDown, bool tiltFunctionsEnabled, Channel &externalChannel)
void	setRuntimeActive (bool active)
void	forceStopAndSwitchOff ()
void	forcePublishValue ()
bool	markCalibrationLostAfterRelayMode ()
void	loadEngineConfigOnly ()
void	purgeEngineConfigOnly ()
void	setupButtonActions (Button *button, bool upButton, bool asInternal)
int32_t	handleNewValueFromServer (TSD_SuplaChannelNewValue *newValue) override
	Handles "new value" request from server.
void	handleAction (int event, int action) override
void	iterateAlways () override
	Method called on each SuplaDevice iteration.
void	onTimer () override
	Method called on timer interupt.
void	close () override
void	open () override
void	stop () override
void	moveUp () override
void	moveDown () override
void	setTargetPosition (int newPosition, int newTilt=UNKNOWN_POSITION) override
Public Member Functions inherited from Supla::Control::RollerShutter
	RollerShutter (Supla::Io::Base *io, int pinUp, int pinDown, bool highIsOn=true, bool tiltFunctionsEnabled=false)
	Constructor.
	RollerShutter (int pinUp=-1, int pinDown=-1, bool highIsOn=true, bool tiltFunctionsEnabled=false)
	Constructor.
	RollerShutter (Supla::Io::IoPin pinUp, Supla::Io::IoPin pinDown, bool tiltFunctionsEnabled=false)
	Constructor.
void	onInit () override
	Third method called on element in SuplaDevice.begin().
void	onTimer () override
	Method called on timer interupt.
void	setPinUp (int pin)
void	setPinDown (int pin)
void	setTargetPosition (int newPosition, int newTilt=UNKNOWN_POSITION) override
Public Member Functions inherited from Supla::Control::RollerShutterInterface
	RollerShutterInterface (bool tiltFunctionsEnabled=false)
	Constructor.
virtual	~RollerShutterInterface ()
	Destructor.
	RollerShutterInterface (const RollerShutterInterface &)=delete
RollerShutterInterface &	operator= (const RollerShutterInterface &)=delete
void	addTiltFunctions ()
	Add tilt functions (facade blinds, vertical blinds) Changing of tilt functions will breake state storage.
bool	isTiltFunctionsSupported () const
	Check if tilt functions are supported.
bool	isTiltFunctionEnabled () const
	Check if tilt function is currently enabled.
bool	isTiltConfigured () const
	Check if tilting is configured (time and control modes are set and isTiltFunctionEnabled is true).
bool	isTopReached () const
	Check if top position (and tilt if applicable) is reached.
bool	isBottomReached () const
	Check if bottom position (and tilt if applicable) is reached.
int32_t	handleNewValueFromServer (TSD_SuplaChannelNewValue *newValue) override
	Handles "new value" request from server.
void	handleAction (int event, int action) override
int	handleCalcfgFromServer (TSD_DeviceCalCfgRequest *request) override
	Handles CALCFG requests from server.
Supla::ApplyConfigResult	applyChannelConfig (TSD_ChannelConfig *result, bool local=false) override
void	fillChannelConfig (void channelConfig, int size, uint8_t configType) override
void	fillSuplaChannelNewValue (TSD_SuplaChannelNewValue *value) override
	Fills TSD_SuplaChannelNewValue based on current state.
void	setCurrentPosition (int newPosition, int newTilt=UNKNOWN_POSITION)
	Set current roller shutter/facade blind position (and tilt) (0 = open; 100 = closed).
void	setNotCalibrated ()
void	setCalibrationOngoing (int calibrationTime=1)
void	setCalibrationFinished ()
int	getCurrentPosition () const
	Get current roller shutter position.
int	getCurrentTilt () const
	Get current tilt position.
int	getTargetPosition () const
	Get target roller shutter position.
int	getTargetTilt () const
	Get target tilt position.
int	getCurrentDirection () const
	Get current roller shutter movement direction.
void	configComfortUpValue (uint8_t position)
void	configComfortDownValue (uint8_t position)
void	configComfortUpTiltValue (uint8_t position)
void	configComfortDownTiltValue (uint8_t position)
void	onInit () override
	Third method called on element in SuplaDevice.begin().
void	onLoadConfig (SuplaDeviceClass *sdc) override
	First method called on element in SuplaDevice.begin().
void	saveConfig ()
void	onLoadState () override
	Second method called on element in SuplaDevice.begin().
void	onSaveState () override
	Method called periodically during SuplaDevice iteration.
void	purgeConfig () override
	Removes all configration data related to the element from Storage::Config.
void	iterateAlways () override
	Method called on each SuplaDevice iteration.
uint32_t	getClosingTimeMs () const
uint32_t	getOpeningTimeMs () const
uint32_t	getTiltingTimeMs () const
uint32_t	getTiltControlType () const
void	attach (Supla::Control::Button up, Supla::Control::Button down)
void	attach (Supla::Control::Button *button, bool upButton, bool asInternal)
virtual void	triggerCalibration ()
void	setCalibrationNeeded ()
bool	isCalibrationRequested () const
bool	isCalibrated () const
void	setRsConfigMotorUpsideDownEnabled (bool enable)
	Enable/disable motor upside down configuration option.
void	setRsConfigButtonsUpsideDownEnabled (bool enable)
	Enable/disable buttons upside down configuration option.
void	setRsConfigTimeMarginEnabled (bool enable)
	Enable/disable time margin configuration option.
void	setRsConfigMotorUpsideDownValue (uint8_t value)
	Set motor upside down value.
void	setRsConfigButtonsUpsideDownValue (uint8_t value)
	Set buttons upside down value.
void	setRsConfigTimeMarginValue (int8_t value)
	Set time margin value.
uint8_t	getMotorUpsideDown () const
uint8_t	getButtonsUpsideDown () const
int8_t	getTimeMargin () const
virtual bool	inMove ()
virtual bool	isCalibrationInProgress () const
void	startCalibration (uint32_t timeMs)
void	stopCalibration ()
bool	isCalibrationFailed () const
bool	isCalibrationLost () const
bool	isMotorProblem () const
bool	isFunctionSupported (int32_t channelFunction) const
bool	isAutoCalibrationSupported () const
void	setOpenCloseTime (uint32_t newClosingTimeMs, uint32_t newOpeningTimeMs)
void	setTiltingTime (uint32_t newTiltingTimeMs, bool local=true)
void	setTiltControlType (uint8_t newTiltControlType, bool local=true)
void	setCalibrationFailed (bool value)
void	setCalibrationLost (bool value)
void	setMotorProblem (bool value)
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
	ElementWithChannelActions (ElementMode mode=ElementMode::Registered)
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, uint16_t event, Supla::Condition *condition, bool alwaysEnabled=false)
	Adds a conditional local action for a specific event.
virtual void	addAction (uint16_t action, ActionHandler client, uint16_t event, Supla::Condition condition, bool alwaysEnabled=false)
	Pointer variant of addAction(action, client, event, condition).
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	runAction (uint16_t event) const override
bool	isAnyUpdatePending () const override
	Returns true if any update is pending.
void	triggerSetChannelConfig (int configType=SUPLA_CONFIG_TYPE_DEFAULT)
Public Member Functions inherited from Supla::Element
	Element (ElementMode mode=ElementMode::Registered)
Element *	next ()
	Returns next Element from the list.
virtual bool	isStateStorageMigrationNeeded () const
	Method called after onInit() to check if state storage migration is needed.
virtual bool	iterateConnected (void *ptr)
	deprecated
virtual void	onFastTimer ()
	Method called on fast 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 bool	getRemainingCountdownTimerSec (uint32_t *remainingSec) const
	Returns active countdown timer remaining time in seconds.
virtual void	handleGetChannelState (TDSC_ChannelState *channelState)
	Handles "get channel state (i)" request from server.
virtual uint32_t	getCalcfgPendingTimeoutMs (TSD_DeviceCalCfgRequest *request) const
	Returns timeout in milliseconds for CALCFG requests that become pending.
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 ()
const Channel *	getChannelByChannelNumber (int channelNumber) const
	Returns pointer to the channel matching channelNumber.
Channel *	getChannelByChannelNumber (int channelNumber)
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.
bool	setDefaultFunction (uint32_t defaultFunction)
	Sets default channel's function.
bool	setFunction (uint32_t newFunction)
	Sets channel's function.
virtual void	onFunctionChange (uint32_t currentFunction, uint32_t newFunction)
	Called when channel function changes.
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 ()

Additional Inherited Members
Static Public Member Functions inherited from Supla::Control::RollerShutterInterface
static void	setRsStorageSaveDelay (int delayMs)
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	DeleteAction (const LocalAction trigger, const ActionHandler client, uint16_t event, uint16_t action)
static void	NullifyActionsHandledBy (const ActionHandler *client)
static ActionHandlerClient *	getClientListPtr ()
Protected Member Functions inherited from Supla::Control::RollerShutter
	RollerShutter (Supla::Io::IoPin pinUp, Supla::Io::IoPin pinDown, bool tiltFunctionsEnabled, Supla::Channel &externalChannel, ElementMode mode)
virtual void	stopMovement ()
virtual void	relayDownOn ()
virtual void	relayUpOn ()
virtual void	relayDownOff ()
virtual void	relayUpOff ()
virtual void	startClosing ()
virtual void	startOpening ()
virtual void	switchOffRelays ()
void	calculateCurrentPositionAndTilt ()
void	initGpio (const Supla::Io::IoPin &pin)
Protected Member Functions inherited from Supla::Control::RollerShutterInterface
	RollerShutterInterface (bool tiltFunctionsEnabled, Supla::Channel &externalChannel, ElementMode mode)
void	loadRollerShutterConfigOnly ()
void	purgeRollerShutterConfigOnly ()
void	setupButtonActions (Supla::Control::Button *button, bool upButton, bool asInternal)
	Configure additional buttons for roller shutter.
bool	lastDirectionWasOpen () const
bool	lastDirectionWasClose () const
bool	isTimeSettingAvailable () const
bool	getCalibrate () const
void	setCalibrate (bool value)
void	printConfig () const
uint32_t	getTimeMarginValue (uint32_t fullTime) const
Protected Member Functions inherited from Supla::ChannelElement
	ChannelElement (Channel &externalChannel, ElementMode mode)
Protected Member Functions inherited from Supla::ElementWithChannelActions
virtual bool	setAndSaveFunction (uint32_t channelFunction)
virtual bool	loadFunctionFromConfig ()
virtual bool	saveConfigChangeFlag () const
virtual bool	loadConfigChangeFlag ()
void	clearChannelConfigChangedFlag ()
bool	iterateConfigExchange ()
int	getNextConfigType () const
	Returns the next config type to be sent.
Protected Attributes inherited from Supla::Control::RollerShutter
Supla::Io::IoPin	pinUp
Supla::Io::IoPin	pinDown
uint32_t	lastMovementStartTime = 0
uint32_t	doNothingTime = 0
uint32_t	operationTimeoutMs = 0
Protected Attributes inherited from Supla::Control::RollerShutterInterface
uint8_t	flags = 0
uint8_t	comfortDownValue = 20
uint8_t	comfortUpValue = 80
uint8_t	comfortUpTiltValue = 0
uint8_t	comfortDownTiltValue = 100
Directions	currentDirection = Directions::STOP_DIR
Directions	lastDirection = Directions::STOP_DIR
int16_t	currentPosition
int16_t	currentTilt
int8_t	targetPosition = STOP_POSITION
int8_t	targetTilt = UNKNOWN_POSITION
int16_t	lastPositionBeforeMovement = UNKNOWN_POSITION
int16_t	lastTiltBeforeMovement = UNKNOWN_POSITION
bool	newTargetPositionAvailable = false
RollerShutterConfig	rsConfig
TiltConfig	tiltConfig
ButtonListElement *	buttonList = nullptr
uint32_t	closingTimeMs = 0
uint32_t	openingTimeMs = 0
uint32_t	calibrationTime = 0
uint32_t	lastUpdateTime = 0
Protected Attributes inherited from Supla::ChannelElement
unsigned char	ownedChannelStorage [sizeof(Channel)] = {}
Channel &	channel
bool	ownsChannel = false
Protected Attributes inherited from Supla::ElementWithChannelActions
Supla::ChannelConfigState	channelConfigState
uint8_t	setChannelConfigAttempts = 0
ConfigTypesBitmap	usedConfigTypes
ConfigTypesBitmap	receivedConfigTypes
Protected Attributes inherited from Supla::Element
bool	registeredElement = true
Element *	nextPtr = nullptr
Static Protected Attributes inherited from Supla::Control::RollerShutterInterface
static int16_t	rsStorageSaveDelay = 5000
Static Protected Attributes inherited from Supla::Element
static Element *	firstPtr = nullptr
static bool	invalidatePtr = false

Member Function Documentation

◆ close()

void Supla::Control::ManagedRollerShutter::close ( )

overridevirtual

Reimplemented from Supla::Control::RollerShutterInterface.

◆ handleAction()

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

overridevirtual

Implements Supla::ActionHandler.

◆ handleNewValueFromServer()

int32_t Supla::Control::ManagedRollerShutter::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::ManagedRollerShutter::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.

◆ moveDown()

void Supla::Control::ManagedRollerShutter::moveDown ( )

overridevirtual

Reimplemented from Supla::Control::RollerShutterInterface.

◆ moveUp()

void Supla::Control::ManagedRollerShutter::moveUp ( )

overridevirtual

Reimplemented from Supla::Control::RollerShutterInterface.

◆ onTimer()

void Supla::Control::ManagedRollerShutter::onTimer ( )

overridevirtual

Method called on timer interupt.

It should provide all actions that have to be executed periodically regardless of other SuplaDevice activities. It is usually called every 10 ms.

Reimplemented from Supla::Element.

◆ open()

void Supla::Control::ManagedRollerShutter::open ( )

overridevirtual

Reimplemented from Supla::Control::RollerShutterInterface.

◆ setTargetPosition()

void Supla::Control::ManagedRollerShutter::setTargetPosition	(	int	newPosition,
		int	newTilt = UNKNOWN_POSITION )

overridevirtual

Reimplemented from Supla::Control::RollerShutterInterface.

◆ stop()

void Supla::Control::ManagedRollerShutter::stop ( )

overridevirtual

Reimplemented from Supla::Control::RollerShutterInterface.

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

src/supla/control/relay_roller_shutter_pair.h
src/supla/control/relay_roller_shutter_pair.cpp

Public Member Functions

Additional Inherited Members

Member Function Documentation

◆ close()

◆ handleAction()

◆ handleNewValueFromServer()

◆ iterateAlways()

◆ moveDown()

◆ moveUp()

◆ onTimer()

◆ open()

◆ setTargetPosition()

◆ stop()