action_trigger.h

/*
 Copyright (C) AC SOFTWARE SP. Z O.O.
 
 This program is free software; you can redistribute it and/or
 modify it under the terms of the GNU General Public License
 as published by the Free Software Foundation; either version 2
 of the License, or (at your option) any later version.
 
 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU General Public License for more details.
 
 You should have received a copy of the GNU General Public License
 along with this program; if not, write to the Free Software
 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
*/
 
#ifndef SRC_SUPLA_CONTROL_ACTION_TRIGGER_H_
#define SRC_SUPLA_CONTROL_ACTION_TRIGGER_H_
 
#include <stdint.h>
 
#include <supla/action_handler.h>
#include <supla/actions.h>
#include <supla/at_channel.h>
#include <supla/element.h>
 
namespace Supla {
 
namespace Protocol {
class SuplaSrpc;
}
 
enum ActionHandlingType : uint8_t {
  ActionHandlingType_RelayOnSuplaServer = 0,
  ActionHandlingType_PublishAllDisableNone = 1,
  ActionHandlingType_PublishAllDisableAll = 2
};
 
namespace Control {
 
class Button;
 
class ActionTrigger : public Element, public ActionHandler {
 public:
  ActionTrigger();
  virtual ~ActionTrigger();
 
  // Use below methods to attach button instance to ActionTrigger.
  // It will automatically register to all supported button actions
  // during onInit() call on action trigger instance.
  void attach(Supla::Control::Button *);
  void attach(Supla::Control::Button &);
 
  // Makes AT channel related to other channel, so Supla Cloud will not
  // list AT as a separate channel, but it will be extending i.e. Relay
  // channel.
  void setRelatedChannel(Element *);
  void setRelatedChannel(Channel *);
  void setRelatedChannel(Element &);
  void setRelatedChannel(Channel &);
 
  void handleAction(int event, int action) override;
  void activateAction(int action) override;
  Supla::Channel *getChannel() override;
  const Supla::Channel *getChannel() const override;
  void onInit() override;
  void onRegistered(Supla::Protocol::SuplaSrpc *suplaSrpc = nullptr) override;
  uint8_t handleChannelConfig(TSD_ChannelConfig *result,
                              bool local = false) override;
  void onLoadConfig(SuplaDeviceClass *) override;
  void onLoadState() override;
  void onSaveState() override;
 
  void rebuildForAttachedButton();
  void disableATCapability(uint32_t capToDisable);
  void enableStateStorage();
 
  static int actionTriggerCapToButtonEvent(uint32_t actionCap);
  static int actionTriggerCapToActionId(uint32_t actionCap);
  static int getActionTriggerCap(int action);
 
  bool isAnyActionEnabledOnServer() const;
 
  void setAlwaysUseOnClick1();
 
  void enable();
  void disable();
 
 protected:
  void addActionToButtonAndDisableIt(int event, int action);
  void parseActiveActionsFromServer();
 
  Supla::Control::Button *attachedButton = nullptr;
  Supla::ActionHandlerClient *localHandlerForEnabledAt = nullptr;
  Supla::ActionHandlerClient *localHandlerForDisabledAt = nullptr;
  Supla::ActionHandler *localHandlerClient = nullptr;
  uint16_t localHandlerAction = 0;
  uint32_t activeActionsFromServer = 0;
  uint32_t disablesLocalOperation = 0;
  uint32_t disabledCapabilities = 0;
 
  Supla::AtChannel channel;
 
  ActionHandlingType actionHandlingType = ActionHandlingType_RelayOnSuplaServer;
  bool storageEnabled = false;
  bool alwaysUseOnClick1 = false;
  bool enabled = true;
  bool localHandlerSwitchConfigured = false;
};
 
}  // namespace Control
}  // namespace Supla
 
#endif  // SRC_SUPLA_CONTROL_ACTION_TRIGGER_H_