4#ifndef SRC_SUPLA_SENSOR_GENERAL_PURPOSE_CHANNEL_BASE_H_
5#define SRC_SUPLA_SENSOR_GENERAL_PURPOSE_CHANNEL_BASE_H_
7#include <supla/channel_element.h>
12class MeasurementDriver;
27 int32_t multiplier = 0;
29 uint8_t precision = 0;
30 uint8_t noSpaceBeforeValue = 0;
31 uint8_t noSpaceAfterValue = 0;
32 uint8_t keepHistory = 0;
33 uint8_t chartType = 0;
34 uint16_t refreshIntervalMs = 0;
35 char unitBeforeValue[SUPLA_GENERAL_PURPOSE_UNIT_SIZE] = {};
36 char unitAfterValue[SUPLA_GENERAL_PURPOSE_UNIT_SIZE] = {};
49 bool addMemoryVariableDriver =
true);
89 virtual void setValue(
const double &value);
122 bool local)
override;
132 uint8_t configType)
override;
361 void setChartType(uint8_t chartType,
bool local =
true);
447 virtual void setChannelRefreshIntervalMs(uint16_t intervalMs);
450 uint16_t defaultRefreshIntervalMs = 5000;
451 uint16_t refreshIntervalMs = 5000;
452 uint32_t lastReadTime = 0;
453 bool deleteDriver =
false;
454 bool initDone =
false;
456 int32_t defaultValueDivider = 0;
457 int32_t defaultValueMultiplier = 0;
458 int64_t defaultValueAdded = 0;
459 uint8_t defaultValuePrecision = 0;
461 char defaultUnitBeforeValue[SUPLA_GENERAL_PURPOSE_UNIT_SIZE] = {};
463 char defaultUnitAfterValue[SUPLA_GENERAL_PURPOSE_UNIT_SIZE] = {};
465 GPMCommonConfig commonConfig = {};
Definition SuplaDevice.h:167
Definition channel_element.h:15
Base class for General Purpose Measurement (GPM/KPOP) and General Purpose Meter (GPM/KLOP)
Definition general_purpose_channel_base.h:22
void getDefaultUnitAfterValue(char unit[SUPLA_GENERAL_PURPOSE_UNIT_SIZE])
Returns default unit which is displayed after value.
Definition general_purpose_channel_base.cpp:229
Supla::ApplyConfigResult applyChannelConfig(TSD_ChannelConfig *result, bool local) override
Applies new Channel Config (i.e.
Definition general_purpose_channel_base.cpp:432
uint8_t getValuePrecision() const
Returns precision (number of decimal places)
Definition general_purpose_channel_base.cpp:249
void setValueMultiplier(int32_t multiplier, bool local=true)
Sets value multiplier.
Definition general_purpose_channel_base.cpp:331
void setDefaultValueAdded(int64_t added)
Sets default value added.
Definition general_purpose_channel_base.cpp:174
void setChartType(uint8_t chartType, bool local=true)
Sets chart type.
Definition general_purpose_channel_base.cpp:423
void setValueAdded(int64_t added, bool local=true)
Sets value added.
Definition general_purpose_channel_base.cpp:341
void onInit() override
Supla::Element::onInit() - called by SuplaDeviceClass::begin() during initialization.
Definition general_purpose_channel_base.cpp:147
int64_t getDefaultValueAdded() const
Returns default value added.
Definition general_purpose_channel_base.cpp:213
void getDefaultUnitBeforeValue(char unit[SUPLA_GENERAL_PURPOSE_UNIT_SIZE])
Returns default unit which is displayed before value.
Definition general_purpose_channel_base.cpp:221
void setNoSpaceAfterValue(uint8_t noSpaceAfterValue, bool local=true)
Sets no space after value.
Definition general_purpose_channel_base.cpp:403
int32_t getDefaultValueMultiplier() const
Returns default value multiplier.
Definition general_purpose_channel_base.cpp:209
void setDefaultUnitBeforeValue(const char *unit)
Sets default unit which is displayed before value.
Definition general_purpose_channel_base.cpp:187
GeneralPurposeChannelBase(MeasurementDriver *driver=nullptr, bool addMemoryVariableDriver=true)
Constructor.
Definition general_purpose_channel_base.cpp:20
void setKeepHistory(uint8_t keepHistory, bool local=true)
Sets keep history flag.
Definition general_purpose_channel_base.cpp:413
void getUnitAfterValue(char unit[SUPLA_GENERAL_PURPOSE_UNIT_SIZE]) const
Returns unit which is displayed after value.
Definition general_purpose_channel_base.cpp:263
double getCalculatedValue()
Returns calculated value, which is result of the following operations:
Definition general_purpose_channel_base.cpp:40
int64_t getValueAdded() const
Returns value added.
Definition general_purpose_channel_base.cpp:245
void setDefaultUnitAfterValue(const char *unit)
Sets default unit which is displayed after value.
Definition general_purpose_channel_base.cpp:196
uint8_t getNoSpaceAfterValue() const
Returns no space after value.
Definition general_purpose_channel_base.cpp:275
void iterateAlways() override
Supla::Element::iterateAlways() - called by SuplaDeviceClass::iterate()
Definition general_purpose_channel_base.cpp:155
void onLoadConfig(SuplaDeviceClass *sdc) override
Supla::Element::onLoadConfig() - called by SuplaDeviceClass::loadConfig() during initialization.
Definition general_purpose_channel_base.cpp:102
void setDefaultValueDivider(int32_t divider)
Sets default value divider.
Definition general_purpose_channel_base.cpp:162
uint8_t getChartType() const
Returns chart type.
Definition general_purpose_channel_base.cpp:283
uint8_t getKeepHistory() const
Returns keep history flag.
Definition general_purpose_channel_base.cpp:279
void fillChannelConfig(void *channelConfig, int *size, uint8_t configType) override
Fills Channel Config.
Definition general_purpose_channel_base.cpp:483
uint8_t getNoSpaceBeforeValue() const
Returns no space before value.
Definition general_purpose_channel_base.cpp:271
void getFormattedValue(char *result, int maxSize)
Returns formatted value as char array (including units, precision, etc.)
Definition general_purpose_channel_base.cpp:59
void setRefreshIntervalMs(int32_t intervalMs, bool local=true)
Sets refresh interval in milliseconds.
Definition general_purpose_channel_base.cpp:304
int32_t getValueDivider() const
Returns value divider.
Definition general_purpose_channel_base.cpp:237
int32_t getDefaultValueDivider() const
Returns default value divider.
Definition general_purpose_channel_base.cpp:205
void getUnitBeforeValue(char unit[SUPLA_GENERAL_PURPOSE_UNIT_SIZE]) const
Returns unit which is displayed before value.
Definition general_purpose_channel_base.cpp:253
void setUnitAfterValue(const char *unit, bool local=true)
Sets unit which is displayed after value.
Definition general_purpose_channel_base.cpp:377
void setValueDivider(int32_t divider, bool local=true)
Sets value divider.
Definition general_purpose_channel_base.cpp:322
void setUnitBeforeValue(const char *unit, bool local=true)
Sets unit which is displayed before value.
Definition general_purpose_channel_base.cpp:360
virtual ~GeneralPurposeChannelBase()
Destructor.
Definition general_purpose_channel_base.cpp:32
virtual void setValue(const double &value)
Method used to set new value for channel with driver which accepts MeasurementDriver::setValue() meth...
Definition general_purpose_channel_base.cpp:547
void setDefaultValuePrecision(uint8_t precision)
Sets default precision (number of decimal places)
Definition general_purpose_channel_base.cpp:181
int32_t getValueMultiplier() const
Returns value multiplier.
Definition general_purpose_channel_base.cpp:241
void setNoSpaceBeforeValue(uint8_t noSpaceBeforeValue, bool local=true)
Sets no space before value.
Definition general_purpose_channel_base.cpp:393
void setDefaultRefreshIntervalMs(int32_t intervalMs)
Sets default refresh interval in milliseconds.
Definition general_purpose_channel_base.cpp:553
void setDefaultValueMultiplier(int32_t multiplier)
Sets default value multiplier.
Definition general_purpose_channel_base.cpp:168
void setValuePrecision(uint8_t precision, bool local=true)
Sets precision.
Definition general_purpose_channel_base.cpp:350
uint16_t getRefreshIntervalMs() const
Returns refresh interval in milliseconds.
Definition general_purpose_channel_base.cpp:287
virtual double getValue()
Method used to obtain new value for channel.
Definition general_purpose_channel_base.cpp:140
uint8_t getDefaultValuePrecision() const
Returns default precision (number of decimal places)
Definition general_purpose_channel_base.cpp:217
Definition measurement_driver.h:9
Definition general_purpose_channel_base.h:25