binary_base.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_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 alarmMuted;  // 0 - not used, 1 - alarm is muted,
                           // 2 - alarm is not muted
    };
  };
 
  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);

  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 getAlarmMuted() const;

  bool setAlarmMuted(uint8_t alarmMuted, bool local = true);

  void setReadIntervalMs(uint32_t intervalMs);

  void purgeConfig() override;

  void fillChannelConfig(void *channelConfig,
                         int *size,
                         uint8_t configType) override;
 
 protected:
  void saveConfig();
  void printConfig();
  void printConfig(const TChannelConfig_BinarySensor *serverConfig);
  uint32_t lastReadTime = 0;
  uint32_t readIntervalMs = 100;
  BinarySensorChannel channel;
  BinarySensorConfig config;
};
 
}  // namespace Sensor
}  // namespace Supla
 
 
#endif  // SRC_SUPLA_SENSOR_BINARY_BASE_H_