HomeWaterLeaksDetection
LeakDetectionConfig_t Struct Reference

#include <LeakDetectionConfig.h>

Public Member Functions

bool operator!= (const LeakDetectionConfig_t &other) const
 Compares two settings. More...
 

Public Attributes

time_t limitResetTime
 limit reset time e.g. 5 mins, 24h, .... More...
 
time_t limitActionTime
 limit action time (leak has been detected) More...
 
int limitPulseAction
 limit action in pulses More...
 
int bypassPin
 number of the bypass pin More...
 

Detailed Description

Author
silhavyj A17B0362P

This structure represents settings on a water leak detection algorithm. This template is used as both the normal and the alarm config. Not all the algorithms have to use all the parameters. For instance, the high-water leak detection algorithm doesn't use 'limitActionTime'.

Definition at line 17 of file LeakDetectionConfig.h.

Member Function Documentation

◆ operator!=()

bool LeakDetectionConfig_t::operator!= ( const LeakDetectionConfig_t other) const
inline

Compares two settings.

This method is used for settings comparison (so the same settings are not applied again, for example)

Parameters
otherthe other settings we compare these settings to
Returns
true if the settings are the same, false otherwise

Definition at line 30 of file LeakDetectionConfig.h.

30  {
31  return limitResetTime != other.limitResetTime ||
34  bypassPin != other.bypassPin;
35  }

References bypassPin, limitActionTime, limitPulseAction, and limitResetTime.

Member Data Documentation

◆ bypassPin

int LeakDetectionConfig_t::bypassPin

number of the bypass pin

Definition at line 21 of file LeakDetectionConfig.h.

Referenced by operator!=(), LowLeakDetection::update(), and HighLeakDetection::update().

◆ limitActionTime

time_t LeakDetectionConfig_t::limitActionTime

◆ limitPulseAction

◆ limitResetTime


The documentation for this struct was generated from the following file:
LeakDetectionConfig_t::limitResetTime
time_t limitResetTime
limit reset time e.g. 5 mins, 24h, ....
Definition: LeakDetectionConfig.h:18
LeakDetectionConfig_t::limitPulseAction
int limitPulseAction
limit action in pulses
Definition: LeakDetectionConfig.h:20
LeakDetectionConfig_t::bypassPin
int bypassPin
number of the bypass pin
Definition: LeakDetectionConfig.h:21
LeakDetectionConfig_t::limitActionTime
time_t limitActionTime
limit action time (leak has been detected)
Definition: LeakDetectionConfig.h:19