supla-device
Loading...
Searching...
No Matches
virtual_binary.h
1// SPDX-FileCopyrightText: AC SOFTWARE SP. Z O.O.
2// SPDX-License-Identifier: GPL-2.0-or-later
3
4#ifndef SRC_SUPLA_SENSOR_VIRTUAL_BINARY_H_
5#define SRC_SUPLA_SENSOR_VIRTUAL_BINARY_H_
6
7#include <supla/sensor/binary_base.h>
8
9#include "../action_handler.h"
10
11namespace Supla {
12namespace Sensor {
21class VirtualBinary : public BinaryBase, public ActionHandler {
22 public:
23 explicit VirtualBinary(bool keepStateInStorage = false);
24 bool getValue() override;
25 void onInit() override;
26 void iterateAlways() override;
27 void handleAction(int event, int action) override;
28 void onLoadState() override;
29 void onSaveState() override;
30
32 void set();
34 void clear();
36 void toggle();
44 void setUseConfiguredTimeout(bool useConfiguredTimeout);
45
52 void setKeepStateInStorage(bool);
53
54 protected:
55 void setLogicalState(bool logicalState, bool fromTimeout = false);
56
57 bool state = false;
58 bool keepStateInStorage = false;
59 uint32_t stateChangeTimeMs = 0;
60 bool clearedByTimeout = false;
61 bool useConfiguredTimeout = true;
62};
63
64}; // namespace Sensor
65}; // namespace Supla
66
67#endif // SRC_SUPLA_SENSOR_VIRTUAL_BINARY_H_
Definition action_handler.h:8
Definition binary_base.h:35
Virtual binary sensor with explicit logical state control.
Definition virtual_binary.h:21
void set()
Sets the logical state to ON.
Definition virtual_binary.cpp:81
void setUseConfiguredTimeout(bool useConfiguredTimeout)
Enables or disables timeout auto-application from the configured channel timeout value.
Definition virtual_binary.cpp:21
void clear()
Sets the logical state to OFF.
Definition virtual_binary.cpp:87
void onSaveState() override
Method called periodically during SuplaDevice iteration.
Definition virtual_binary.cpp:48
void toggle()
Toggles the logical state.
Definition virtual_binary.cpp:93
void setKeepStateInStorage(bool)
Configures whether the logical state should be persisted in storage.
Definition virtual_binary.cpp:17
void iterateAlways() override
Method called on each SuplaDevice iteration.
Definition virtual_binary.cpp:35
void onLoadState() override
Second method called on element in SuplaDevice.begin().
Definition virtual_binary.cpp:54
void onInit() override
Third method called on element in SuplaDevice.begin()
Definition virtual_binary.cpp:29