bistable_relay.h

// SPDX-FileCopyrightText: AC SOFTWARE SP. Z O.O.
// SPDX-License-Identifier: GPL-2.0-or-later
 
/* BistableRelay
 * This class can be used to controll bistable relay.
 * Supla device will send short impulses (<0.5 s) on GPIO to toggle bistable
 * relay state.
 * Device does not have knowledge about the status of bistable relay, so it
 * has to be read on a different GPIO (statusPin)
 * This class can work without statusPin information, but Supla will lose
 * information about status of bistable relay.
 */
 
#ifndef SRC_SUPLA_CONTROL_BISTABLE_RELAY_H_
#define SRC_SUPLA_CONTROL_BISTABLE_RELAY_H_
 
#include <supla-common/proto.h>
#include <stdint.h>
 
#include "../io.h"
#include "relay.h"
 
namespace Supla {
namespace Io {
struct IoPin;
}
 
namespace Control {
class BistableRelay : public Relay {
 public:
  BistableRelay(int pin,
                int statusPin = -1,
                bool statusPullUp = true,
                bool statusHighIsOn = true,
                bool highIsOn = true,
                _supla_int_t functions =
                    (0xFF ^ SUPLA_BIT_FUNC_CONTROLLINGTHEROLLERSHUTTER));
 
  BistableRelay(Supla::Io::IoPin outputPin,
                Supla::Io::IoPin statusPin = {},
                _supla_int_t functions =
                    (0xFF ^ SUPLA_BIT_FUNC_CONTROLLINGTHEROLLERSHUTTER));
 
  BistableRelay(Supla::Io::Base *io,
                int pin,
                int statusPin = -1,
                bool statusPullUp = true,
                bool statusHighIsOn = true,
                bool highIsOn = true,
                _supla_int_t functions =
                    (0xFF ^ SUPLA_BIT_FUNC_CONTROLLINGTHEROLLERSHUTTER));
 
  BistableRelay(Supla::Io::Base *ioOut,
                Supla::Io::Base *ioState,
                int pin,
                int statusPin = -1,
                bool statusPullUp = true,
                bool statusHighIsOn = true,
                bool highIsOn = true,
                _supla_int_t functions =
                    (0xFF ^ SUPLA_BIT_FUNC_CONTROLLINGTHEROLLERSHUTTER));
 
  void onInit() override;
  void iterateAlways() override;
  int32_t handleNewValueFromServer(TSD_SuplaChannelNewValue *newValue) override;
  void turnOn(_supla_int_t duration = 0) override;
  void turnOff(_supla_int_t duration = 0) override;
  void toggle(_supla_int_t duration = 0) override;
  void handleAction(int event, int action) override;
 
  bool isOn() override;
  bool isStatusUnknown();
 
 protected:
  bool canUseWeeklySchedule() const override;
  bool applyWeeklyScheduleState(bool on) override;
  void internalToggle();
 
  uint32_t disarmTimeMs = 0;
  uint32_t lastReadTime = 0;
 
  Supla::Io::IoPin statusInputPin;
  bool busy = false;
  bool lastCommandTurnOn = false;
};
 
};  // namespace Control
};  // namespace Supla
 
#endif  // SRC_SUPLA_CONTROL_BISTABLE_RELAY_H_