Inheritance diagram for Supla::Sensor::GeneralPurposeMeter:

[legend]

Collaboration diagram for Supla::Sensor::GeneralPurposeMeter:

[legend]

Classes
struct	GPMMeterSpecificConfig

Public Member Functions
	GeneralPurposeMeter (MeasurementDriver *driver=nullptr, bool addMemoryVariableDriver=true)

void	onLoadConfig (SuplaDeviceClass *sdc) override
	Supla::Element::onLoadConfig() - called by SuplaDeviceClass::loadConfig() during initialization.

uint8_t	applyChannelConfig (TSD_ChannelConfig *result, bool local) override
	Applies new Channel Config (i.e.

void	fillChannelConfig (void channelConfig, int size) override
	Fills Channel Config.

void	handleAction (int event, int action) override

int	handleCalcfgFromServer (TSD_DeviceCalCfgRequest *request) override
	Handles CALCFG requests from server.

void	onLoadState () override
	Second method called on element in SuplaDevice.begin().

void	onSaveState () override
	Method called periodically during SuplaDevice iteration.

void	setCounter (double newValue)

void	incCounter (double incrementBy=0)

void	decCounter (double decrementBy=0)

void	setValueStep (double newValueStep)

void	setResetToValue (double newResetToValue)

void	setCounterResetSupportFlag (bool support)

void	setKeepStateInStorage (bool keep)

uint8_t	getCounterType () const

uint8_t	getIncludeValueAddedInHistory () const

uint8_t	getFillMissingData () const

void	setCounterType (uint8_t counterType, bool local=true)

void	setIncludeValueAddedInHistory (uint8_t includeValueAddedInHistory, bool local=true)

void	setFillMissingData (uint8_t fillMissingData, bool local=true)

Public Member Functions inherited from Supla::Sensor::GeneralPurposeChannelBase
	GeneralPurposeChannelBase (MeasurementDriver *driver=nullptr, bool addMemoryVariableDriver=true)
	Constructor.

virtual	~GeneralPurposeChannelBase ()
	Destructor.

double	getCalculatedValue ()
	Returns calculated value, which is result of the following operations:

void	getFormattedValue (char *result, int maxSize)
	Returns formatted value as char array (including units, precision, etc.)

virtual double	getValue ()
	Method used to obtain new value for channel.

virtual void	setValue (const double &value)
	Method used to set new value for channel with driver which accepts MeasurementDriver::setValue() method.

void	onInit () override
	Supla::Element::onInit() - called by SuplaDeviceClass::begin() during initialization.

void	iterateAlways () override
	Supla::Element::iterateAlways() - called by SuplaDeviceClass::iterate()

void	setDefaultValueDivider (int32_t divider)
	Sets default value divider.

void	setDefaultValueMultiplier (int32_t multiplier)
	Sets default value multiplier.

void	setDefaultValueAdded (int64_t added)
	Sets default value added.

void	setDefaultValuePrecision (uint8_t precision)
	Sets default precision (number of decimal places)

void	setDefaultUnitBeforeValue (const char *unit)
	Sets default unit which is displayed before value.

void	setDefaultUnitAfterValue (const char *unit)
	Sets default unit which is displayed after value.

int32_t	getDefaultValueDivider () const
	Returns default value divider.

int32_t	getDefaultValueMultiplier () const
	Returns default value multiplier.

int64_t	getDefaultValueAdded () const
	Returns default value added.

uint8_t	getDefaultValuePrecision () const
	Returns default precision (number of decimal places)

void	getDefaultUnitBeforeValue (char unit[SUPLA_GENERAL_PURPOSE_UNIT_SIZE])
	Returns default unit which is displayed before value.

void	getDefaultUnitAfterValue (char unit[SUPLA_GENERAL_PURPOSE_UNIT_SIZE])
	Returns default unit which is displayed after value.

void	setRefreshIntervalMs (int32_t intervalMs, bool local=true)
	Sets refresh interval in milliseconds.

void	setValueDivider (int32_t divider, bool local=true)
	Sets value divider.

void	setValueMultiplier (int32_t multiplier, bool local=true)
	Sets value multiplier.

void	setValueAdded (int64_t added, bool local=true)
	Sets value added.

void	setValuePrecision (uint8_t precision, bool local=true)
	Sets precision.

void	setUnitBeforeValue (const char *unit, bool local=true)
	Sets unit which is displayed before value.

void	setUnitAfterValue (const char *unit, bool local=true)
	Sets unit which is displayed after value.

void	setNoSpaceBeforeValue (uint8_t noSpaceBeforeValue, bool local=true)
	Sets no space before value.

void	setNoSpaceAfterValue (uint8_t noSpaceAfterValue, bool local=true)
	Sets no space after value.

void	setKeepHistory (uint8_t keepHistory, bool local=true)
	Sets keep history flag.

void	setChartType (uint8_t chartType, bool local=true)
	Sets chart type.

uint16_t	getRefreshIntervalMs () const
	Returns refresh interval in milliseconds.

int32_t	getValueDivider () const
	Returns value divider.

int32_t	getValueMultiplier () const
	Returns value multiplier.

int64_t	getValueAdded () const
	Returns value added.

uint8_t	getValuePrecision () const
	Returns precision (number of decimal places)

void	getUnitBeforeValue (char unit[SUPLA_GENERAL_PURPOSE_UNIT_SIZE]) const
	Returns unit which is displayed before value.

void	getUnitAfterValue (char unit[SUPLA_GENERAL_PURPOSE_UNIT_SIZE]) const
	Returns unit which is displayed after value.

uint8_t	getNoSpaceBeforeValue () const
	Returns no space before value.

uint8_t	getNoSpaceAfterValue () const
	Returns no space after value.

uint8_t	getKeepHistory () const
	Returns keep history flag.

uint8_t	getChartType () const
	Returns chart type.

Public Member Functions inherited from Supla::ChannelElement
	ChannelElement (int channelNumber=-1)

Channel *	getChannel () override

const Channel *	getChannel () const override
	Returns pointer to main channel.

Public Member Functions inherited from Supla::ElementWithChannelActions
void	addAction (uint16_t action, ActionHandler &client, uint16_t event, bool alwaysEnabled=false) override

void	addAction (uint16_t action, ActionHandler *client, uint16_t event, bool alwaysEnabled=false) override

virtual void	addAction (uint16_t action, ActionHandler &client, Supla::Condition *condition, bool alwaysEnabled=false)

virtual void	addAction (uint16_t action, ActionHandler client, Supla::Condition condition, bool alwaysEnabled=false)

bool	isEventAlreadyUsed (uint16_t event, bool ignoreAlwaysEnabled) override

void	onRegistered (Supla::Protocol::SuplaSrpc *suplaSrpc) override
	Method called each time when device successfully registers to Supla server.

bool	iterateConnected () override
	Method called on each SuplaDevice iteration when device is connected and registered to Supla server or other protocol.

void	handleChannelConfigFinished () override
	Handles "channel config finished" message from server.

uint8_t	handleChannelConfig (TSD_ChannelConfig *result, bool local) override
	Handles "set channel config" request from server.

void	handleSetChannelConfigResult (TSDS_SetChannelConfigResult *result) override
	Handles "set channel config" reply from server.

void	purgeConfig () override
	Removes all configration data related to the element from Storage::Config.

void	clearChannelConfigChangedFlag ()

void	runAction (uint16_t event) const override

virtual bool	setAndSaveFunction (_supla_int_t channelFunction)

virtual bool	loadFunctionFromConfig ()

virtual bool	saveConfigChangeFlag ()

virtual bool	loadConfigChangeFlag ()

bool	isAnyUpdatePending () override
	Returns true if any update is pending.

virtual void	fillChannelOcrConfig (void channelConfig, int size)

void	triggerSetChannelConfig ()

Public Member Functions inherited from Supla::Element
Element *	next ()
	Returns next Element from the list.

virtual bool	iterateConnected (void *ptr)
	deprecated

virtual void	onTimer ()
	Method called on timer interupt.

virtual void	onFastTimer ()
	Method called on fast timer interupt.

virtual void	onSoftReset ()
	Method called when device soft restart is triggered.

virtual void	onDeviceConfigChange (uint64_t fieldBit)
	Method called when device config is changed.

virtual int32_t	handleNewValueFromServer (TSD_SuplaChannelNewValue *newValue)
	Handles "new value" request from server.

virtual void	fillSuplaChannelNewValue (TSD_SuplaChannelNewValue *value)
	Fills TSD_SuplaChannelNewValue based on current state.

virtual void	handleGetChannelState (TDSC_ChannelState *channelState)
	Handles "get channel state (i)" request from server.

virtual uint8_t	handleWeeklySchedule (TSD_ChannelConfig *newWeeklySchedule, bool altSchedule=false, bool local=false)
	Handles "set channel config" with "weekly schedule" type request from server.

int	getChannelNumber () const
	Returns channel number.

int	getSecondaryChannelNumber () const
	Returns secondary channel number.

virtual bool	isOwnerOfSubDeviceId (int subDeviceId) const
	Returns true if element is owner of subDeviceId.

virtual const Channel *	getSecondaryChannel () const
	Returns pointer to secondary channel.

virtual Channel *	getSecondaryChannel ()

virtual void	generateKey (char output, const char key) const
	Generates key used for Config.

Element &	disableChannelState ()
	Disables channel state (i) function.

bool	isChannelStateEnabled () const
	Returns true if channel state (i) function is enabled.

void	setInitialCaption (const char *caption, bool secondaryChannel=false)
	Sets initial caption.

void	setDefaultFunction (int32_t defaultFunction)
	Sets default channel's function.

Public Member Functions inherited from Supla::LocalAction
virtual ActionHandlerClient *	getHandlerForFirstClient (uint16_t event)

virtual ActionHandlerClient *	getHandlerForClient (ActionHandler *client, uint16_t event)

virtual void	disableOtherClients (const ActionHandler &client, uint16_t event)

virtual void	enableOtherClients (const ActionHandler &client, uint16_t event)

virtual void	disableOtherClients (const ActionHandler *client, uint16_t event)

virtual void	enableOtherClients (const ActionHandler *client, uint16_t event)

virtual void	disableAction (int32_t action, ActionHandler *client, int32_t event)

virtual void	enableAction (int32_t action, ActionHandler *client, int32_t event)

virtual bool	disableActionsInConfigMode ()

Public Member Functions inherited from Supla::ActionHandler
virtual void	activateAction (int action)

virtual bool	deleteClient ()

virtual ActionHandler *	getRealClient ()

Protected Member Functions
void	saveMeterSpecificConfig ()

Protected Member Functions inherited from Supla::Sensor::GeneralPurposeChannelBase
void	saveConfig ()

virtual void	setChannelRefreshIntervalMs (uint16_t intervalMs)

Protected Member Functions inherited from Supla::ElementWithChannelActions
virtual bool	hasOcrConfig () const

virtual bool	isOcrConfigMissing () const

virtual void	clearOcrConfig ()

Protected Attributes
double	valueStep = 1

double	resetToValue = 0

bool	isCounterResetSupported = true

bool	keepStateInStorage = false

GPMMeterSpecificConfig	meterSpecificConfig = {}

Protected Attributes inherited from Supla::Sensor::GeneralPurposeChannelBase
MeasurementDriver *	driver = nullptr

uint16_t	refreshIntervalMs = 5000

uint32_t	lastReadTime = 0

bool	deleteDriver = false

int32_t	defaultValueDivider = 0

int32_t	defaultValueMultiplier = 0

int64_t	defaultValueAdded = 0

uint8_t	defaultValuePrecision = 0

char	defaultUnitBeforeValue [SUPLA_GENERAL_PURPOSE_UNIT_SIZE] = {}

char	defaultUnitAfterValue [SUPLA_GENERAL_PURPOSE_UNIT_SIZE] = {}

GPMCommonConfig	commonConfig = {}

Protected Attributes inherited from Supla::ChannelElement
Channel	channel

Protected Attributes inherited from Supla::ElementWithChannelActions
Supla::ChannelConfigState	channelConfigState

bool	configFinishedReceived = false

uint8_t	setChannelConfigAttempts = 0

Protected Attributes inherited from Supla::Element
Element *	nextPtr = nullptr

Additional Inherited Members
Static Public Member Functions inherited from Supla::Element
static Element *	begin ()
	Returns first Element (based on creation order)

static Element *	last ()
	Returns last Element (based on creation order)

static Element *	getElementByChannelNumber (int channelNumber)
	Returns Element by channel number.

static Element *	getOwnerOfSubDeviceId (int subDeviceId)
	Returns Element which owns given subDeviceId.

static bool	IsAnyUpdatePending ()
	Checks if any element has pending update for remote server.

static void	NotifyElementsAboutConfigChange (uint64_t fieldBit)
	Notifies all elements about device config change.

static bool	IsInvalidPtrSet ()
	When "invalid pointer" is set, previously obtained Element pointer may be invalid.

static void	ClearInvalidPtr ()
	Clears "invalid pointer" flag.

Static Public Member Functions inherited from Supla::LocalAction
static void	DeleteActionsHandledBy (const ActionHandler *client)

static void	DeleteActionsTriggeredBy (const LocalAction *action)

static void	NullifyActionsHandledBy (const ActionHandler *client)

static ActionHandlerClient *	getClientListPtr ()

Static Protected Attributes inherited from Supla::Element
static Element *	firstPtr = nullptr

static bool	invalidatePtr = false

Member Function Documentation

◆ applyChannelConfig()

uint8_t GeneralPurposeMeter::applyChannelConfig	(	TSD_ChannelConfig *	result,
		bool	local )

overridevirtual

Applies new Channel Config (i.e.

received from Supla Server)

Parameters

result	pointer to TSD_ChannelConfig which should contain TChannelConfig_GeneralPurposeMeasurement or TChannelConfig_GeneralPurposeMeter class with configuration.
local	set to true if method is called locally by device. Use false if method is called as a result of Supla Server message.

Returns: result of operation (see proto.h SUPLA_CONFIG_RESULT_*)

Reimplemented from Supla::Sensor::GeneralPurposeChannelBase.

◆ fillChannelConfig()

void GeneralPurposeMeter::fillChannelConfig	(	void *	channelConfig,
		int *	size )

overridevirtual

Fills Channel Config.

Parameters

channelConfig	pointer to TSD_ChannelConfig to be filled.
size	written config size is stored here.

Reimplemented from Supla::Sensor::GeneralPurposeChannelBase.

◆ handleAction()

void GeneralPurposeMeter::handleAction	(	int	event,
		int	action )

overridevirtual

Implements Supla::ActionHandler.

◆ handleCalcfgFromServer()

int GeneralPurposeMeter::handleCalcfgFromServer ( TSD_DeviceCalCfgRequest * request )

overridevirtual

Handles CALCFG requests from server.

Parameters

request

Returns: SUPLA_CALCFG_RESULT_* (see proto.h)

Reimplemented from Supla::Element.

◆ onLoadConfig()

void GeneralPurposeMeter::onLoadConfig ( SuplaDeviceClass * sdc )

overridevirtual

Supla::Element::onLoadConfig() - called by SuplaDeviceClass::loadConfig() during initialization.

Parameters

sdc	pointer to SuplaDeviceClass

Reimplemented from Supla::Sensor::GeneralPurposeChannelBase.

◆ onLoadState()

void GeneralPurposeMeter::onLoadState ( )

overridevirtual

Second method called on element in SuplaDevice.begin().

Method called during state Storage initialization (i.e. read from EEPROM, FRAM). Called only if Storage class is configured.

Reimplemented from Supla::Element.

◆ onSaveState()

void GeneralPurposeMeter::onSaveState ( )

overridevirtual

Method called periodically during SuplaDevice iteration.

It should provide state saving for this elemnet to Storage

Reimplemented from Supla::Element.

The documentation for this class was generated from the following files:

src/supla/sensor/general_purpose_meter.h
src/supla/sensor/general_purpose_meter.cpp

Classes

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Member Function Documentation

◆ applyChannelConfig()

◆ fillChannelConfig()

◆ handleAction()

◆ handleCalcfgFromServer()

◆ onLoadConfig()

◆ onLoadState()

◆ onSaveState()