valve_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_CONTROL_VALVE_BASE_H_
#define SRC_SUPLA_CONTROL_VALVE_BASE_H_
 
#include <supla/channel_element.h>
#include <supla-common/proto.h>
#include <supla/action_handler.h>
 
namespace Supla {
namespace Control {
 
#define SUPLA_VALVE_SENSOR_MAX 20
 
#pragma pack(push, 1)
struct ValveConfig {
  ValveConfig();
  uint8_t sensorData[SUPLA_VALVE_SENSOR_MAX];
  uint8_t closeValveOnFloodType = 0;  // SUPLA_VALVE_CLOSE_ON_FLOOD_TYPE_*
  uint8_t reserved[31] = {};
};
#pragma pack(pop)

class ValveBase : public ChannelElement, public ActionHandler {
 public:
  explicit ValveBase(bool openClose = true);
 
  void onInit() override;
  void iterateAlways() override;
  void onLoadConfig(SuplaDeviceClass *) override;
  void onLoadState() override;
  void onSaveState() override;
  Supla::ApplyConfigResult applyChannelConfig(TSD_ChannelConfig *result,
                                              bool local = false) override;
  void fillChannelConfig(void *channelConfig,
                         int *size,
                         uint8_t configType) override;
  int32_t handleNewValueFromServer(TSD_SuplaChannelNewValue *newValue) override;
  void purgeConfig() override;

  void handleAction(int event, int action) override;

  void openValve();

  void closeValve();

  void setValve(uint8_t openLevel);
 

  bool isFloodDetected();

  void printConfig() const;

  void saveConfig(bool local = true);

  virtual void setValueOnDevice(uint8_t openLevel);

  virtual uint8_t getValueOpenStateFromDevice();

  bool addSensor(uint8_t channelNumber);

  bool removeSensor(uint8_t channelNumber);

  void setIgnoreManuallyOpenedTimeMs(uint32_t timeMs);

  void setDefaultCloseValveOnFloodType(uint8_t type);
 
 protected:
  ValveConfig config = {};
  uint32_t lastSensorsCheckTimestamp = 0;
  uint32_t lastUpdateTimestamp = 0;
  uint32_t lastCmdTimestamp = 0;
  uint32_t ignoreManuallyOpenedTimeMs = 30000;
  uint8_t lastOpenLevelState = 0;
  uint8_t defaultCloseValveOnFloodType = SUPLA_VALVE_CLOSE_ON_FLOOD_TYPE_NONE;
  bool previousSensorState[SUPLA_VALVE_SENSOR_MAX] = {};
};
 
};  // namespace Control
};  // namespace Supla
 
#endif  // SRC_SUPLA_CONTROL_VALVE_BASE_H_