esphome::sprinkler::SprinklerValveRunRequest Class Reference

#include <sprinkler.h>

Public Member Functions
	SprinklerValveRunRequest ()
	SprinklerValveRunRequest (size_t valve_number, uint32_t run_duration, SprinklerValveOperator *valve_op)
bool	has_request ()
bool	has_valve_operator ()
void	set_request_from (SprinklerValveRunRequestOrigin origin)
void	set_run_duration (uint32_t run_duration)
void	set_valve (size_t valve_number)
void	set_valve_operator (SprinklerValveOperator *valve_op)
void	reset ()
uint32_t	run_duration ()
size_t	valve ()
optional< size_t >	valve_as_opt ()
SprinklerValveOperator *	valve_operator ()
SprinklerValveRunRequestOrigin	request_is_from ()

Protected Attributes
bool	has_valve_ {false}
size_t	valve_number_ {0}
uint32_t	run_duration_ {0}
SprinklerValveOperator *	valve_op_ {nullptr}
SprinklerValveRunRequestOrigin	origin_ {USER}

Detailed Description

Definition at line 180 of file sprinkler.h.

Constructor & Destructor Documentation

SprinklerValveRunRequest() [1/2]

esphome::sprinkler::SprinklerValveRunRequest::SprinklerValveRunRequest

(

)

Definition at line 346 of file sprinkler.cpp.

SprinklerValveRunRequest() [2/2]

esphome::sprinkler::SprinklerValveRunRequest::SprinklerValveRunRequest	(	size_t	valve_number,
		uint32_t	run_duration,
		SprinklerValveOperator *	valve_op )

Definition at line 347 of file sprinkler.cpp.

Member Function Documentation

has_request()

bool esphome::sprinkler::SprinklerValveRunRequest::has_request

(

)

Definition at line 351 of file sprinkler.cpp.

has_valve_operator()

bool esphome::sprinkler::SprinklerValveRunRequest::has_valve_operator

(

)

Definition at line 352 of file sprinkler.cpp.

request_is_from()

SprinklerValveRunRequestOrigin esphome::sprinkler::SprinklerValveRunRequest::request_is_from

(

)

Definition at line 391 of file sprinkler.cpp.

reset()

void esphome::sprinkler::SprinklerValveRunRequest::reset

(

)

Definition at line 371 of file sprinkler.cpp.

run_duration()

uint32_t esphome::sprinkler::SprinklerValveRunRequest::run_duration

(

)

Definition at line 378 of file sprinkler.cpp.

set_request_from()

void esphome::sprinkler::SprinklerValveRunRequest::set_request_from

(

SprinklerValveRunRequestOrigin

origin

)

Definition at line 354 of file sprinkler.cpp.

set_run_duration()

void esphome::sprinkler::SprinklerValveRunRequest::set_run_duration

(

uint32_t

run_duration

)

Definition at line 356 of file sprinkler.cpp.

set_valve()

void esphome::sprinkler::SprinklerValveRunRequest::set_valve

(

size_t

valve_number

)

Definition at line 358 of file sprinkler.cpp.

set_valve_operator()

void esphome::sprinkler::SprinklerValveRunRequest::set_valve_operator

(

SprinklerValveOperator *

valve_op

)

Definition at line 365 of file sprinkler.cpp.

valve()

size_t esphome::sprinkler::SprinklerValveRunRequest::valve

(

)

Definition at line 380 of file sprinkler.cpp.

valve_as_opt()

optional< size_t > esphome::sprinkler::SprinklerValveRunRequest::valve_as_opt

(

)

Definition at line 382 of file sprinkler.cpp.

valve_operator()

SprinklerValveOperator * esphome::sprinkler::SprinklerValveRunRequest::valve_operator

(

)

Definition at line 389 of file sprinkler.cpp.

Field Documentation

has_valve_

bool esphome::sprinkler::SprinklerValveRunRequest::has_valve_ {false}

protected

Definition at line 198 of file sprinkler.h.

origin_

SprinklerValveRunRequestOrigin esphome::sprinkler::SprinklerValveRunRequest::origin_ {USER}

protected

Definition at line 202 of file sprinkler.h.

run_duration_

uint32_t esphome::sprinkler::SprinklerValveRunRequest::run_duration_ {0}

protected

Definition at line 200 of file sprinkler.h.

valve_number_

size_t esphome::sprinkler::SprinklerValveRunRequest::valve_number_ {0}

protected

Definition at line 199 of file sprinkler.h.

valve_op_

SprinklerValveOperator* esphome::sprinkler::SprinklerValveRunRequest::valve_op_ {nullptr}

protected

Definition at line 201 of file sprinkler.h.

---

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

• esphome/components/sprinkler/sprinkler.h
• esphome/components/sprinkler/sprinkler.cpp