supla-device
Loading...
Searching...
No Matches
Supla::Sensor::SHT3x Class Reference
Inheritance diagram for Supla::Sensor::SHT3x:
Collaboration diagram for Supla::Sensor::SHT3x:

Public Member Functions

 SHT3x (int8_t address=0x44)
 
double getTemp () override
 
double getHumi () override
 
void onInit () override
 Third method called on element in SuplaDevice.begin()
 
- Public Member Functions inherited from Supla::Sensor::ThermHygroMeter
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) override
 
void purgeConfig () override
 Removes all configration data related to the element from Storage::Config.
 
int16_t getTempInt16 ()
 
int16_t getHumiInt16 ()
 
uint8_t 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)
 
ChannelgetChannel () override
 
const ChannelgetChannel () 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 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
Elementnext ()
 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 ChannelgetSecondaryChannel () const
 Returns pointer to secondary channel.
 
virtual ChannelgetSecondaryChannel ()
 
virtual void generateKey (char *output, const char *key) const
 Generates key used for Config.
 
ElementdisableChannelState ()
 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 ActionHandlerClientgetHandlerForFirstClient (uint16_t event)
 
virtual ActionHandlerClientgetHandlerForClient (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 Attributes

int8_t address
 
double temperature = TEMPERATURE_NOT_AVAILABLE
 
double humidity = HUMIDITY_NOT_AVAILABLE
 
int8_t retryCount = 0
 
::ClosedCube_SHT31D sht
 
- Protected Attributes inherited from Supla::Sensor::ThermHygroMeter
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
 
bool configFinishedReceived = false
 
uint8_t setChannelConfigAttempts = 0
 
- Protected Attributes inherited from Supla::Element
ElementnextPtr = nullptr
 

Additional Inherited Members

- Static Public Member Functions inherited from Supla::Element
static Elementbegin ()
 Returns first Element (based on creation order)
 
static Elementlast ()
 Returns last Element (based on creation order)
 
static ElementgetElementByChannelNumber (int channelNumber)
 Returns Element by channel number.
 
static ElementgetOwnerOfSubDeviceId (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 ActionHandlerClientgetClientListPtr ()
 
- Protected Member Functions inherited from Supla::Sensor::ThermHygroMeter
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 hasOcrConfig () const
 
virtual bool isOcrConfigMissing () const
 
virtual void clearOcrConfig ()
 
- Static Protected Attributes inherited from Supla::Element
static ElementfirstPtr = nullptr
 
static bool invalidatePtr = false
 

Member Function Documentation

◆ getHumi()

double Supla::Sensor::SHT3x::getHumi ( )
inlineoverridevirtual

Reimplemented from Supla::Sensor::ThermHygroMeter.

◆ getTemp()

double Supla::Sensor::SHT3x::getTemp ( )
inlineoverridevirtual

Reimplemented from Supla::Sensor::ThermHygroMeter.

◆ onInit()

void Supla::Sensor::SHT3x::onInit ( )
inlineoverridevirtual

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.


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