Supla::Control::BistableRollerShutter Class Reference

Inheritance diagram for Supla::Control::BistableRollerShutter:

Collaboration diagram for Supla::Control::BistableRollerShutter:

Public Member Functions
	BistableRollerShutter (Supla::Io *io, int pinUp, int pinDown, bool highIsOn=true)
	BistableRollerShutter (int pinUp, int pinDown, bool highIsOn=true)
void	onTimer () override
	Method called on timer interupt.
Public Member Functions inherited from Supla::Control::RollerShutter
	RollerShutter (Supla::Io *io, int pinUp, int pinDown, bool highIsOn=true)
	RollerShutter (int pinUp, int pinDown, bool highIsOn=true)
void	onInit () override
	Third method called on element in SuplaDevice.begin()
void	onTimer () override
	Method called on timer interupt.
Public Member Functions inherited from Supla::Control::RollerShutterInterface
	RollerShutterInterface (const RollerShutterInterface &)=delete
RollerShutterInterface &	operator= (const RollerShutterInterface &)=delete
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.
uint8_t	applyChannelConfig (TSD_ChannelConfig *result, bool local=false) override
void	fillChannelConfig (void *channelConfig, int *size) override
void	fillSuplaChannelNewValue (TSD_SuplaChannelNewValue *value) override
	Fills TSD_SuplaChannelNewValue based on current state.
virtual void	close ()
virtual void	open ()
virtual void	stop ()
virtual void	moveUp ()
virtual void	moveDown ()
virtual void	setTargetPosition (int newPosition)
void	setCurrentPosition (int newPosition)
void	setNotCalibrated ()
void	setCalibrationOngoing (int calibrationTime=1)
void	setCalibrationFinished ()
int	getCurrentPosition () const
int	getTargetPosition () const
int	getCurrentDirection () const
void	configComfortUpValue (uint8_t position)
void	configComfortDownValue (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
void	attach (Supla::Control::Button *up, Supla::Control::Button *down)
virtual void	triggerCalibration ()
void	setCalibrationNeeded ()
bool	isCalibrationRequested () const
bool	isCalibrated () const
void	setRsConfigMotorUpsideDownEnabled (bool enable)
void	setRsConfigButtonsUpsideDownEnabled (bool enable)
void	setRsConfigTimeMarginEnabled (bool enable)
void	setRsConfigMotorUpsideDownValue (uint8_t value)
void	setRsConfigButtonsUpsideDownValue (uint8_t value)
void	setRsConfigTimeMarginValue (int8_t value)
uint8_t	getMotorUpsideDown () const
uint8_t	getButtonsUpsideDown () const
int8_t	getTimeMargin () const
virtual bool	inMove ()
virtual bool	isCalibrationInProgress () const
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	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
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	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 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	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 void	handleGetChannelState (TDSC_ChannelState *channelState)
	Handles "get channel state (i)" request 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
void	stopMovement () override
void	relayDownOn () override
void	relayUpOn () override
void	relayUpOff () override
void	relayDownOff () override
Protected Member Functions inherited from Supla::Control::RollerShutter
virtual void	startClosing ()
virtual void	startOpening ()
virtual void	switchOffRelays ()
Protected Member Functions inherited from Supla::Control::RollerShutterInterface
bool	lastDirectionWasOpen () const
bool	lastDirectionWasClose () const
bool	isTimeSettingAvailable () const
bool	getCalibrate () const
void	setCalibrate (bool value)
void	printConfig () const
void	setupButtonActions ()
uint32_t	getTimeMarginValue (uint32_t fullTime) const
Protected Member Functions inherited from Supla::ElementWithChannelActions
virtual bool	hasOcrConfig () const
virtual bool	isOcrConfigMissing () const
virtual void	clearOcrConfig ()

Protected Attributes
bool	activeBiRelay = false
uint32_t	toggleTime = 0
Protected Attributes inherited from Supla::Control::RollerShutter
int16_t	pinUp = -1
int16_t	pinDown = -1
uint32_t	lastMovementStartTime = 0
uint32_t	doNothingTime = 0
Supla::Io *	io = nullptr
uint32_t	operationTimeoutMs = 0
bool	highIsOn = true
Protected Attributes inherited from Supla::Control::RollerShutterInterface
uint8_t	flags = 0
uint8_t	comfortDownValue = 20
uint8_t	comfortUpValue = 80
Directions	currentDirection = Directions::STOP_DIR
Directions	lastDirection = Directions::STOP_DIR
int8_t	currentPosition = UNKNOWN_POSITION
int8_t	targetPosition = STOP_POSITION
int8_t	lastPositionBeforeMovement = UNKNOWN_POSITION
bool	newTargetPositionAvailable = false
RollerShutterConfig	rsConfig
Supla::Control::Button *	upButton = nullptr
Supla::Control::Button *	downButton = nullptr
uint32_t	closingTimeMs = 0
uint32_t	openingTimeMs = 0
uint32_t	calibrationTime = 0
uint32_t	lastUpdateTime = 0
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::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	NullifyActionsHandledBy (const ActionHandler *client)
static ActionHandlerClient *	getClientListPtr ()
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

onTimer()

void Supla::Control::BistableRollerShutter::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.

relayDownOff()

void Supla::Control::BistableRollerShutter::relayDownOff ( )

overrideprotectedvirtual

Reimplemented from Supla::Control::RollerShutter.

relayDownOn()

void Supla::Control::BistableRollerShutter::relayDownOn ( )

overrideprotectedvirtual

Reimplemented from Supla::Control::RollerShutter.

relayUpOff()

void Supla::Control::BistableRollerShutter::relayUpOff ( )

overrideprotectedvirtual

Reimplemented from Supla::Control::RollerShutter.

relayUpOn()

void Supla::Control::BistableRollerShutter::relayUpOn ( )

overrideprotectedvirtual

Reimplemented from Supla::Control::RollerShutter.

stopMovement()

void Supla::Control::BistableRollerShutter::stopMovement ( )

overrideprotectedvirtual

Reimplemented from Supla::Control::RollerShutter.

---

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

• src/supla/control/bistable_roller_shutter.h
• src/supla/control/bistable_roller_shutter.cpp