Inheritance diagram for Supla::Sensor::ThermHygroMeter:

[legend]

Collaboration diagram for Supla::Sensor::ThermHygroMeter:

[legend]

Public Member Functions
void	setRefreshIntervalMs (int intervalMs)

void	onInit () override
	Third method called on element in SuplaDevice.begin()

void	onLoadConfig (SuplaDeviceClass *) override
	First method called on element in SuplaDevice.begin().

void	iterateAlways () override
	Method called on each SuplaDevice iteration.

void	fillChannelConfig (void channelConfig, int size, uint8_t configType) override

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

virtual double	getTemp ()

virtual double	getHumi ()

int16_t	getTempInt16 ()

int16_t	getHumiInt16 ()

Supla::ApplyConfigResult	applyChannelConfig (TSD_ChannelConfig *result, bool local) override

int16_t	getConfiguredTemperatureCorrection ()

int16_t	getConfiguredHumidityCorrection ()

void	applyCorrectionsAndStoreIt (int32_t temperatureCorrection, int32_t humidityCorrection, bool local=false)
	Apply temperature and humidity corrections and store them to Config.

void	setApplyCorrections (bool applyCorrections)
	Set whether correction should be applied or not.

void	setMinMaxAllowedTemperatureAdjustment (int32_t minMax)
	Set minimum and maximum allowed temperature adjustment.

void	setMinMaxAllowedHumidityAdjustment (int32_t minMax)
	Set minimum and maximum allowed humidity adjustment.

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	runAction (uint16_t event) const override

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

void	triggerSetChannelConfig (int configType=SUPLA_CONFIG_TYPE_DEFAULT)

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

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

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

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 int	handleCalcfgFromServer (TSD_DeviceCalCfgRequest *request)
	Handles CALCFG requests 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.

bool	setDefaultFunction (uint32_t defaultFunction)
	Sets default channel's function.

bool	setFunction (uint32_t newFunction)
	Sets channel's function.

virtual void	onFunctionChange (uint32_t currentFunction, uint32_t newFunction)
	Called when channel function changes.

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 ()

Protected Member Functions
int16_t	readCorrectionFromIndex (int index)

void	setCorrectionAtIndex (int32_t correction, int index)

virtual void	setTemperatureCorrection (int32_t correction)

virtual void	setHumidityCorrection (int32_t correction)

Protected Member Functions inherited from Supla::ElementWithChannelActions
virtual bool	setAndSaveFunction (uint32_t channelFunction)

virtual bool	loadFunctionFromConfig ()

virtual bool	saveConfigChangeFlag () const

virtual bool	loadConfigChangeFlag ()

void	clearChannelConfigChangedFlag ()

bool	iterateConfigExchange ()

int	getNextConfigType () const
	Returns the next config type to be sent.

Protected Attributes
uint32_t	lastReadTime = 0

uint16_t	refreshIntervalMs = 10000

int16_t	minMaxAllowedTemperatureAdjustment = 0
	Minimum and maximum allowed temperature adjustment in 0.1 degree C.

int16_t	minMaxAllowedHumidityAdjustment = 0
	Minimum and maximum allowed humidity adjustment in 0.1 RH.

bool	applyCorrections = true
	Whether correction should be applied by SD.

Protected Attributes inherited from Supla::ChannelElement
Channel	channel

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

uint8_t	setChannelConfigAttempts = 0

ConfigTypesBitmap	usedConfigTypes

ConfigTypesBitmap	receivedConfigTypes

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()

Supla::ApplyConfigResult Supla::Sensor::ThermHygroMeter::applyChannelConfig	(	TSD_ChannelConfig *	result,
		bool	local )

overridevirtual

Reimplemented from Supla::ElementWithChannelActions.

◆ applyCorrectionsAndStoreIt()

void Supla::Sensor::ThermHygroMeter::applyCorrectionsAndStoreIt	(	int32_t	temperatureCorrection,
		int32_t	humidityCorrection,
		bool	local = false )

Apply temperature and humidity corrections and store them to Config.

Parameters

temperatureCorrection	temperature correction in 0.1 degree
humidityCorrection	humidity correction in 0.1 %
local	true if correction should be applied locally and then config will be send to server

◆ fillChannelConfig()

void Supla::Sensor::ThermHygroMeter::fillChannelConfig	(	void *	channelConfig,
		int *	size,
		uint8_t	configType )

overridevirtual

Reimplemented from Supla::ElementWithChannelActions.

◆ iterateAlways()

void Supla::Sensor::ThermHygroMeter::iterateAlways ( )

overridevirtual

Method called on each SuplaDevice iteration.

It should provide all actions that have to be executed periodically regardless of network state.

Reimplemented from Supla::Element.

Reimplemented in Supla::Sensor::ThermHygroPressMeter, Supla::Sensor::Thermometer, Supla::Sensor::ThermPressMeter, and Thermometer.

◆ onInit()

void Supla::Sensor::ThermHygroMeter::onInit ( )

overridevirtual

Third method called on element in SuplaDevice.begin()

Method called during SuplaDevice initialization. I.e. load initial state, initialize pins etc.

Reimplemented from Supla::Element.

Reimplemented in Supla::Sensor::Thermometer, Supla::Sensor::TMP102, and Thermometer.

◆ onLoadConfig()

void Supla::Sensor::ThermHygroMeter::onLoadConfig ( SuplaDeviceClass * sdc )

overridevirtual

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

Called only if Config Storage class is configured. Element should read its configration in this method.

Parameters

sdc

Reimplemented from Supla::Element.

◆ purgeConfig()

void Supla::Sensor::ThermHygroMeter::purgeConfig ( )

overridevirtual

Removes all configration data related to the element from Storage::Config.

Reimplemented from Supla::ElementWithChannelActions.

◆ setApplyCorrections()

void Supla::Sensor::ThermHygroMeter::setApplyCorrections ( bool applyCorrections )

Set whether correction should be applied or not.

By default temperature and humidity corrections are applied on Channel level, so raw value is read from sensor, then it is corrected and send to server. However correction may be applied by a sensor device itself. In this case, correciton is send to that device and value read from sensor is already corrected.

Parameters

applyCorrections true if correction should be applied by SD

◆ setMinMaxAllowedHumidityAdjustment()

void Supla::Sensor::ThermHygroMeter::setMinMaxAllowedHumidityAdjustment ( int32_t minMax )

Set minimum and maximum allowed humidity adjustment.

Value 0 means Cloud default +- 10.0.

Parameters

minMax minimum and maximum allowed humidity adjustment in 0.1 RH. Allowed range: 0 (default), 1..500 (0.1 .. 50.0). I.e. value 50 means +- 5.0 RH

◆ setMinMaxAllowedTemperatureAdjustment()

void Supla::Sensor::ThermHygroMeter::setMinMaxAllowedTemperatureAdjustment ( int32_t minMax )

Set minimum and maximum allowed temperature adjustment.

Value 0 means Cloud default +- 10.0.

Parameters

minMax minimum and maximum allowed temperature adjustment in 0.1 degree C. Allowed range: 0 (default), 1..200 (0.1 .. 20.0). I.e. value 50 means +- 5.0 degree C

Member Data Documentation

◆ minMaxAllowedHumidityAdjustment

int16_t Supla::Sensor::ThermHygroMeter::minMaxAllowedHumidityAdjustment = 0

protected

Minimum and maximum allowed humidity adjustment in 0.1 RH.

Value 0 means Cloud default +- 10.0.

◆ minMaxAllowedTemperatureAdjustment

int16_t Supla::Sensor::ThermHygroMeter::minMaxAllowedTemperatureAdjustment = 0

protected

Minimum and maximum allowed temperature adjustment in 0.1 degree C.

Value 0 means Cloud default +- 10.0.

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

src/supla/sensor/therm_hygro_meter.h
src/supla/sensor/therm_hygro_meter.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Member Function Documentation

◆ applyChannelConfig()

◆ applyCorrectionsAndStoreIt()

◆ fillChannelConfig()

◆ iterateAlways()

◆ onInit()

◆ onLoadConfig()

◆ purgeConfig()

◆ setApplyCorrections()

◆ setMinMaxAllowedHumidityAdjustment()

◆ setMinMaxAllowedTemperatureAdjustment()

Member Data Documentation

◆ minMaxAllowedHumidityAdjustment

◆ minMaxAllowedTemperatureAdjustment