|
|
| VirtualRelay (_supla_int_t functions=(0xFF ^ SUPLA_BIT_FUNC_CONTROLLINGTHEROLLERSHUTTER)) |
| void | turnOn (_supla_int_t duration=0) override |
| void | turnOff (_supla_int_t duration=0) override |
| bool | isOn () override |
|
| Relay (Supla::Io::Base *io, int pin, bool highIsOn=true, _supla_int_t functions=(0xFF ^ SUPLA_BIT_FUNC_CONTROLLINGTHEROLLERSHUTTER)) |
|
| Relay (int pin, bool highIsOn=true, _supla_int_t functions=(0xFF ^ SUPLA_BIT_FUNC_CONTROLLINGTHEROLLERSHUTTER)) |
|
virtual Relay & | setDefaultStateOn () |
|
virtual Relay & | setDefaultStateOff () |
|
virtual Relay & | setDefaultStateRestore () |
|
virtual Relay & | keepTurnOnDuration (bool keep=true) |
|
virtual uint8_t | pinOnValue () |
|
virtual uint8_t | pinOffValue () |
|
virtual void | toggle (_supla_int_t duration=0) |
|
void | attach (Supla::Control::Button *) |
| void | handleAction (int event, int action) override |
| void | onLoadConfig (SuplaDeviceClass *sdc) override |
| | First method called on element in SuplaDevice.begin().
|
| void | purgeConfig () override |
| | Removes all configration data related to the element from Storage::Config.
|
| void | onInit () override |
| | Third method called on element in SuplaDevice.begin().
|
| void | onLoadState () override |
| | Second method called on element in SuplaDevice.begin().
|
| void | onSaveState () override |
| | Method called periodically during SuplaDevice iteration.
|
| void | iterateAlways () override |
| | Method called on each SuplaDevice iteration.
|
| bool | iterateConnected () override |
| | Method called on each SuplaDevice iteration when device is connected and registered to Supla server or other protocol.
|
| int32_t | handleNewValueFromServer (TSD_SuplaChannelNewValue *newValue) override |
| | Handles "new value" request from server.
|
| void | onRegistered (Supla::Protocol::SuplaSrpc *suplaSrpc) override |
| | Method called each time when device successfully registers to Supla 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.
|
|
unsigned _supla_int_t | getStoredTurnOnDurationMs () |
|
void | setStoredTurnOnDurationMs (uint32_t durationMs) |
|
bool | isStaircaseFunction (uint32_t functionToCheck=0) const |
|
bool | isImpulseFunction (uint32_t functionToCheck=0) const |
|
void | disableCountdownTimerFunction () |
|
void | enableCountdownTimerFunction () |
|
bool | isCountdownTimerFunctionEnabled () const |
|
void | setMinimumAllowedDurationMs (uint32_t durationMs) |
|
bool | isDefaultRelatedMeterChannelSet () const |
|
uint32_t | getCurrentValueFromMeter () const |
|
void | setDefaultRelatedMeterChannelNo (int channelNo) |
|
void | setTurnOffWhenEmptyAggregator (bool turnOff) |
| void | setOvercurrentThreshold (uint32_t value) |
| | Set overcurrent threshold.
|
| uint32_t | getOvercurrentThreshold () const |
| | Get overcurrent threshold.
|
| void | setOvercurrentMaxAllowed (uint32_t value) |
| | Set overcurrent max level allowed.
|
| uint32_t | getOvercurrentMaxAllowed () const |
| | Get overcurrent max level allowed.
|
| void | setDefaultStaircaseDurationMs (uint16_t durationMs) |
| | Set default duration for staircase timer function.
|
| void | setDefaultImpulseDurationMs (uint16_t durationMs) |
| | Set default duration for impulse functions (controlling gate, door etc.).
|
| bool | setAndSaveFunction (uint32_t channelFunction) override |
| void | setRestartTimerOnToggle (bool restart) |
| | Set restart timer on toggle for staircase and impulse functions.
|
| bool | isRestartTimerOnToggle () const |
| | Get restart timer on toggle for staircase and impulse functions.
|
|
bool | isFullyInitialized () const |
|
void | enableCyclicMode (uint32_t turnOnTimeMs, uint32_t turnOffTimeMs) |
|
void | disableCyclicMode () |
|
bool | isCyclicMode () const |
|
| ChannelElement (int channelNumber=-1) |
| Channel * | getChannel () override |
| const Channel * | getChannel () const override |
| | Returns pointer to main channel.
|
| 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 | 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) |
| 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 | onTimer () |
| | Method called on timer interupt.
|
| 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 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.
|
| 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.
|
|
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 () |
1.16.1