binary_base.h

// SPDX-FileCopyrightText: AC SOFTWARE SP. Z O.O.
// SPDX-License-Identifier: GPL-2.0-or-later
 
#ifndef SRC_SUPLA_SENSOR_BINARY_BASE_H_
#define SRC_SUPLA_SENSOR_BINARY_BASE_H_
 
#include <supla/channels/binary_sensor_channel.h>
#include <supla/element_with_channel_actions.h>
 
class SuplaDeviceClass;
 
namespace Supla {
 
namespace Sensor {
 
#pragma pack(push, 1)
struct BinarySensorConfig {
  union {
    uint8_t reserved[32];
    struct {
      uint16_t timeoutDs;  // 1 ds -> 0.1 s; 0 - not used; range 1..36000
      uint16_t filteringTimeMs;  // 0 - not used; > 0 - filtering time
      uint8_t sensitivity;       // 0 - not used; 1..101 -> 0..100 %;
                                     // value 1 is 0% -> off
      uint8_t localAlarmIndication;  // 0 - not used,
                                     // 1 - local alarm indication disabled,
                                     // 2 - local alarm indication enabled
    };
  };
 
  BinarySensorConfig() : reserved{} {}
};
#pragma pack(pop)
 
class BinaryBase : public ElementWithChannelActions {
 public:
  BinaryBase();
  virtual ~BinaryBase();
  virtual bool getValue() = 0;
  void iterateAlways() override;
  Channel *getChannel() override;
  const Channel *getChannel() const override;
  void onLoadConfig(SuplaDeviceClass *) override;
  Supla::ApplyConfigResult applyChannelConfig(TSD_ChannelConfig *config,
                                              bool local = false) override;
 
  bool isServerInvertLogic() const;
 
  bool setServerInvertLogic(bool invertLogic, bool local = true);
 
  void setTurnActionSyncOnStartup(bool enabled = true);
 
  uint16_t getTimeoutDs() const;
 
  bool setTimeoutDs(uint16_t timeoutDs, bool local = true);
 
  uint16_t getFilteringTimeMs() const;
 
  bool setFilteringTimeMs(uint16_t filteringTimeMs, bool local = true);
 
  uint8_t getSensitivity() const;
 
  bool setSensitivity(uint8_t sensitivity, bool local = true);
 
  uint8_t getLocalAlarmIndication() const;
 
  bool setLocalAlarmIndication(uint8_t localAlarmIndication,
                               bool local = true);
 
  void setReadIntervalMs(uint32_t intervalMs);
 
  void purgeConfig() override;
 
  void fillChannelConfig(void *channelConfig,
                         int *size,
                         uint8_t configType) override;
 
 protected:
  void beginInitialChannelValueRead();
  void setInitialChannelValue(bool value);
  void notifyInputStateChangeCandidate();
  void setChannelValueQuietly(bool value);
  void saveConfig();
  void printConfig();
  void printConfig(const TChannelConfig_BinarySensor *serverConfig);
 
  enum class LocalActionState : uint8_t {
    LoadingConfig,
    Initializing,
    StartupSync,
    Runtime,
  };
 
  uint32_t lastReadTime = 0;
  uint32_t readIntervalMs = 100;
  uint32_t startupSyncStartTimeMs = 0;
  LocalActionState localActionState = LocalActionState::LoadingConfig;
  bool turnActionSyncOnStartup = false;
  bool initialStateCandidatePending = false;
  bool inputStateCandidatePending = false;
  BinarySensorChannel channel;
  BinarySensorConfig config;
};
 
}  // namespace Sensor
}  // namespace Supla
 
 
#endif  // SRC_SUPLA_SENSOR_BINARY_BASE_H_