aruna::sensor::Water Class Reference

#include <Water.h>

Inheritance diagram for aruna::sensor::Water:

Collaboration diagram for aruna::sensor::Water:

Public Member Functions
	Water ()
	Water sensor. More...
virtual err_t	get_water_level (uint16_t &water_level_in_mm)=0
	Get water level in millimeters of the sensor. More...
err_t	is_wet (bool &water_detected)
	Is water detected at the sensor? More...
sis::status_t *	update_status () override
	Perform check to see if system is secure and return updated status. More...
void	set_sis_status_location (char *location)
	Set the location of the sensor. More...
Public Member Functions inherited from aruna::sis::Performer
	Performer ()
	Performs check to see if the system is in a secure state. More...
	~Performer ()
void	set_update (bool do_update)
	Use to pauze and resume the update process. More...

Private Attributes
water_status_t	status = *new water_status_t()

Additional Inherited Members
Public Attributes inherited from aruna::sis::Performer
uint32_t	update_ms = 500
	update frequency More...
Protected Member Functions inherited from aruna::sis::Performer
void	update_handler ()
Static Protected Member Functions inherited from aruna::sis::Performer
static void *	_update_handler (void *_this)
Protected Attributes inherited from aruna::sis::Performer
pthread_t	thread
pthread_cond_t	do_update_con
pthread_mutex_t	do_update_mut
log::channel_t *	log
char	log_tag [10] = "SIS perf"
bool	do_update = false
bool	interrupt_based = false

Detailed Description

Definition at line 40 of file Water.h.

Constructor & Destructor Documentation

Water()

Water::Water

(

)

Water sensor.

Definition at line 11 of file Water.cpp.

             : status() {
    status.water_level_mm = 0;
    status.level = level_t::NOTIFY;
//    update description
    status.update_description(status.water_level_mm);
}

Here is the call graph for this function:

Member Function Documentation

get_water_level()

virtual err_t aruna::sensor::Water::get_water_level ( uint16_t &  water_level_in_mm )

pure virtual

Get water level in millimeters of the sensor.

Parameters

water_level_in_mm

buffer to store water level in

Returns

err_t::OK if water level could be retrieved

Implemented in aruna::sensor::Rain40x16.

Here is the caller graph for this function:

is_wet()

aruna::err_t Water::is_wet

(

bool &

water_detected

)

Is water detected at the sensor?

Parameters

water_detected

store result

Returns

error retrieving wetness of sensor

Definition at line 18 of file Water.cpp.

                                             {
    err_t e;
    uint16_t i;
    e = get_water_level(i);
    water_detected = i != 0;
    return e;
}

Here is the call graph for this function:

set_sis_status_location()

void Water::set_sis_status_location

(

char *

location

)

Set the location of the sensor.

Usefull for SIS status reports.

Parameters

location

7 char long location.

Definition at line 38 of file Water.cpp.

                                                  {
    strcpy(status.location, location);
}

update_status()

status_t * Water::update_status ( )

overridevirtual

Perform check to see if system is secure and return updated status.

Returns

status_t pointer

Implements aruna::sis::Performer.

Definition at line 26 of file Water.cpp.

                               {
    uint16_t mm;
    err_t e;
    e = get_water_level(mm);
    if ((uint8_t) e)
        log->error("Error retrieving water level: %s", err_to_char.at(e));
    status.water_level_mm = mm;
    status.level = mm ? level_t::CRITICAL : level_t::NOTIFY;
    status.update_description(mm);
    return &status;
}

Here is the call graph for this function:

Member Data Documentation

status

water_status_t aruna::sensor::Water::status = *new water_status_t()

private

Definition at line 42 of file Water.h.

---

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

• include/aruna/sensor/Water.h
• src/sensor/Water.cpp