HomeWaterLeaksDetection
LimitsDefinition.h File Reference
#include "DateTime.h"
#include "Setup.h"

Go to the source code of this file.

Macros

#define LITER_TO_PULSE(l)   ((int)(l) / SENSOR_PULSE_IN_LITERS)
 Converts liters to pulses. More...
 
#define PULSE_TO_LITER(p)   (p * SENSOR_PULSE_IN_LITERS)
 Converts pulses to liters. More...
 
#define UNUSED   0
 unused parameter More...
 
#define HIGH_LEAK_RESET_TIME   SEC_TO_MILLIS(10)
 high-water leak reset time More...
 
#define HIGH_LEAK_LIMIT_ACTION   LITER_TO_PULSE(300)
 high-water leak action (liters) More...
 
#define LOW_LEAK_RESET_TIME   SEC_TO_MILLIS(12)
 low-water leak reset time More...
 
#define LOW_LEAK_LIMIT_ACTION   SEC_TO_MILLIS(40)
 low-water like action time More...
 
#define TOTAL_LEAK_RESET_TIME   MIN_TO_MILLIS(5)
 total-water leak reset time
More...
 
#define TOTAL_LEAK_LIMIT_ACTION   LITER_TO_PULSE(400)
 total-water leak action (liters) More...
 
#define HIGH_LEAK_NORMAL_DEFAULT_CONFIG
 Passes the default high-water leak detection parameters to the constructor. More...
 
#define LOW_LEAK_NORMAL_DEFAULT_CONFIG
 Passes the default low-water leak detection parameters to the constructor. More...
 
#define TOTAL_LEAK_NORMAL_DEFAULT_CONFIG
 Passes the default total-water leak detection parameters to the constructor. More...
 

Macro Definition Documentation

◆ HIGH_LEAK_LIMIT_ACTION

#define HIGH_LEAK_LIMIT_ACTION   LITER_TO_PULSE(300)

high-water leak action (liters)

Definition at line 25 of file LimitsDefinition.h.

◆ HIGH_LEAK_NORMAL_DEFAULT_CONFIG

#define HIGH_LEAK_NORMAL_DEFAULT_CONFIG
Value:
UNUSED, \
HIGH_LEAK_LIMIT_ACTION, \
HIGH_BYPASS_PIN}

Passes the default high-water leak detection parameters to the constructor.

Definition at line 40 of file LimitsDefinition.h.

◆ HIGH_LEAK_RESET_TIME

#define HIGH_LEAK_RESET_TIME   SEC_TO_MILLIS(10)

high-water leak reset time

Definition at line 24 of file LimitsDefinition.h.

◆ LITER_TO_PULSE

#define LITER_TO_PULSE (   l)    ((int)(l) / SENSOR_PULSE_IN_LITERS)

Converts liters to pulses.

Parameters
lvalue in liters
Returns
number of pulses

Definition at line 13 of file LimitsDefinition.h.

◆ LOW_LEAK_LIMIT_ACTION

#define LOW_LEAK_LIMIT_ACTION   SEC_TO_MILLIS(40)

low-water like action time

Definition at line 30 of file LimitsDefinition.h.

◆ LOW_LEAK_NORMAL_DEFAULT_CONFIG

#define LOW_LEAK_NORMAL_DEFAULT_CONFIG
Value:
LOW_LEAK_LIMIT_ACTION, \
UNUSED, \
LOW_BYPASS_PIN}

Passes the default low-water leak detection parameters to the constructor.

Definition at line 47 of file LimitsDefinition.h.

◆ LOW_LEAK_RESET_TIME

#define LOW_LEAK_RESET_TIME   SEC_TO_MILLIS(12)

low-water leak reset time

Definition at line 29 of file LimitsDefinition.h.

◆ PULSE_TO_LITER

#define PULSE_TO_LITER (   p)    (p * SENSOR_PULSE_IN_LITERS)

Converts pulses to liters.

Parameters
pnumber of pulses
Returns
number of liters

Definition at line 18 of file LimitsDefinition.h.

◆ TOTAL_LEAK_LIMIT_ACTION

#define TOTAL_LEAK_LIMIT_ACTION   LITER_TO_PULSE(400)

total-water leak action (liters)

Definition at line 35 of file LimitsDefinition.h.

◆ TOTAL_LEAK_NORMAL_DEFAULT_CONFIG

#define TOTAL_LEAK_NORMAL_DEFAULT_CONFIG
Value:
UNUSED, \
TOTAL_LEAK_LIMIT_ACTION, \
TOTAL_BYPASS_PIN}

Passes the default total-water leak detection parameters to the constructor.

Definition at line 54 of file LimitsDefinition.h.

◆ TOTAL_LEAK_RESET_TIME

#define TOTAL_LEAK_RESET_TIME   MIN_TO_MILLIS(5)

total-water leak reset time

Definition at line 34 of file LimitsDefinition.h.

◆ UNUSED

#define UNUSED   0

unused parameter

Definition at line 20 of file LimitsDefinition.h.

HIGH_LEAK_RESET_TIME
#define HIGH_LEAK_RESET_TIME
high-water leak reset time
Definition: LimitsDefinition.h:23
TOTAL_LEAK_RESET_TIME
#define TOTAL_LEAK_RESET_TIME
total-water leak reset time
Definition: LimitsDefinition.h:33
LOW_LEAK_RESET_TIME
#define LOW_LEAK_RESET_TIME
low-water leak reset time
Definition: LimitsDefinition.h:28