esphome::sprinkler Namespace Reference

Data Structures
class	ResumeOrStartAction
class	ShutdownAction
class	Sprinkler
class	SprinklerControllerNumber
class	SprinklerControllerSwitch
struct	SprinklerQueueItem
struct	SprinklerTimer
struct	SprinklerValve
class	SprinklerValveOperator
class	SprinklerValveRunRequest
class	StartSingleValveAction

Enumerations
enum	SprinklerState : uint8_t {   IDLE , STARTING , ACTIVE , STOPPING ,   BYPASS }
enum	SprinklerTimerIndex : uint8_t { TIMER_SM = 0 , TIMER_VALVE_SELECTION = 1 }
enum	SprinklerValveRunRequestOrigin : uint8_t { USER , CYCLE , QUEUE }

Functions
	ESPHOME_LOG_TAG (TAG, "sprinkler")
	PROGMEM_STRING_TABLE (SprinklerRequestOriginStrings, "USER", "CYCLE", "QUEUE", "UNKNOWN")
	PROGMEM_STRING_TABLE (SprinklerStateStrings, "IDLE", "STARTING", "ACTIVE", "STOPPING", "BYPASS", "UNKNOWN")

Variables
constexpr const char *	MIN_STR = "min"

Enumeration Type Documentation

SprinklerState

enum esphome::sprinkler::SprinklerState : uint8_t

Enumerator
IDLE
STARTING
ACTIVE
STOPPING
BYPASS

Definition at line 17 of file sprinkler.h.

SprinklerTimerIndex

enum esphome::sprinkler::SprinklerTimerIndex : uint8_t

Enumerator
TIMER_SM
TIMER_VALVE_SELECTION

Definition at line 26 of file sprinkler.h.

SprinklerValveRunRequestOrigin

enum esphome::sprinkler::SprinklerValveRunRequestOrigin : uint8_t

Enumerator
USER
CYCLE
QUEUE

Definition at line 31 of file sprinkler.h.

Function Documentation

ESPHOME_LOG_TAG()

esphome::sprinkler::ESPHOME_LOG_TAG	(	TAG	,
		"sprinkler"	)

PROGMEM_STRING_TABLE() [1/2]

esphome::sprinkler::PROGMEM_STRING_TABLE	(	SprinklerRequestOriginStrings	,
		"USER"	,
		"CYCLE"	,
		"QUEUE"	,
		"UNKNOWN"	)

PROGMEM_STRING_TABLE() [2/2]

esphome::sprinkler::PROGMEM_STRING_TABLE	(	SprinklerStateStrings	,
		"IDLE"	,
		"STARTING"	,
		"ACTIVE"	,
		"STOPPING"	,
		"BYPASS"	,
		"UNKNOWN"	)

Variable Documentation

MIN_STR

const char* esphome::sprinkler::MIN_STR = "min"

inlineconstexpr

Definition at line 15 of file sprinkler.h.