#include <hydreon_rgxx.h>

Inheritance diagram for esphome::hydreon_rgxx::HydreonRGxxComponent:

Public Member Functions
void	set_sensor (sensor::Sensor *sensor, int index)

void	set_too_cold_sensor (binary_sensor::BinarySensor *sensor)

void	set_lens_bad_sensor (binary_sensor::BinarySensor *sensor)

void	set_em_sat_sensor (binary_sensor::BinarySensor *sensor)

void	set_model (RGModel model)

void	set_resolution (RG15Resolution resolution)

void	set_request_temperature (bool b)

void	update () override
	Schedule data readings. More...

void	loop () override
	Read data once available. More...

void	setup () override
	Setup the sensor and test for a connection. More...

void	dump_config () override

float	get_setup_priority () const override

void	set_disable_led (bool disable_led)

Public Member Functions inherited from esphome::PollingComponent
	PollingComponent ()

	PollingComponent (uint32_t update_interval)
	Initialize this polling component with the given update interval in ms. More...

virtual void	set_update_interval (uint32_t update_interval)
	Manually set the update interval in ms for this polling object. More...

void	call_setup () override

virtual uint32_t	get_update_interval () const
	Get the update interval in ms of this sensor. More...

void	start_poller ()

void	stop_poller ()

Public Member Functions inherited from esphome::Component
float	get_actual_setup_priority () const

void	set_setup_priority (float priority)

virtual float	get_loop_priority () const
	priority of loop(). More...

void	call ()

virtual void	on_shutdown ()

virtual void	on_safe_shutdown ()

uint32_t	get_component_state () const

virtual void	mark_failed ()
	Mark this component as failed. More...

void	mark_failed (const char *message)

bool	is_failed () const

bool	is_ready () const

virtual bool	can_proceed ()

bool	status_has_warning () const

bool	status_has_error () const

void	status_set_warning (const char *message="unspecified")

void	status_set_error (const char *message="unspecified")

void	status_clear_warning ()

void	status_clear_error ()

void	status_momentary_warning (const std::string &name, uint32_t length=5000)

void	status_momentary_error (const std::string &name, uint32_t length=5000)

bool	has_overridden_loop () const

void	set_component_source (const char *source)
	Set where this component was loaded from for some debug messages. More...

const char *	get_component_source () const
	Get the integration where this component was declared as a string. More...

Public Member Functions inherited from esphome::uart::UARTDevice
	UARTDevice ()=default

	UARTDevice (UARTComponent *parent)

void	set_uart_parent (UARTComponent *parent)

void	write_byte (uint8_t data)

void	write_array (const uint8_t *data, size_t len)

void	write_array (const std::vector< uint8_t > &data)

template<size_t N>
void	write_array (const std::array< uint8_t, N > &data)

void	write_str (const char *str)

bool	read_byte (uint8_t *data)

bool	peek_byte (uint8_t *data)

bool	read_array (uint8_t *data, size_t len)

template<size_t N>
optional< std::array< uint8_t, N > >	read_array ()

int	available ()

void	flush ()

int	read ()

size_t	write (uint8_t data)

int	peek ()

void	check_uart_settings (uint32_t baud_rate, uint8_t stop_bits=1, UARTParityOptions parity=UART_CONFIG_PARITY_NONE, uint8_t data_bits=8)
	Check that the configuration of the UART bus matches the provided values and otherwise print a warning. More...

Protected Member Functions
void	process_line_ ()

void	schedule_reboot_ ()
	Communication with the sensor is asynchronous. More...

bool	buffer_starts_with_ (const std::string &prefix)

bool	buffer_starts_with_ (const char *prefix)

int	num_sensors_missing_ ()

Protected Member Functions inherited from esphome::Component
virtual void	call_loop ()

virtual void	call_dump_config ()

void	set_interval (const std::string &name, uint32_t interval, std::function< void()> &&f)
	Set an interval function with a unique name. More...

void	set_interval (uint32_t interval, std::function< void()> &&f)

bool	cancel_interval (const std::string &name)
	Cancel an interval function. More...

void	set_retry (const std::string &name, uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult(uint8_t)> &&f, float backoff_increase_factor=1.0f)
	Set an retry function with a unique name. More...

void	set_retry (uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult(uint8_t)> &&f, float backoff_increase_factor=1.0f)

bool	cancel_retry (const std::string &name)
	Cancel a retry function. More...

void	set_timeout (const std::string &name, uint32_t timeout, std::function< void()> &&f)
	Set a timeout function with a unique name. More...

void	set_timeout (uint32_t timeout, std::function< void()> &&f)

bool	cancel_timeout (const std::string &name)
	Cancel a timeout function. More...

void	defer (const std::string &name, std::function< void()> &&f)
	Defer a callback to the next loop() call. More...

void	defer (std::function< void()> &&f)
	Defer a callback to the next loop() call. More...

bool	cancel_defer (const std::string &name)
	Cancel a defer callback using the specified name, name must not be empty. More...

Protected Attributes
sensor::Sensor *	sensors_ [NUM_SENSORS] = {nullptr}

binary_sensor::BinarySensor *	too_cold_sensor_ {nullptr}

binary_sensor::BinarySensor *	lens_bad_sensor_ {nullptr}

binary_sensor::BinarySensor *	em_sat_sensor_ {nullptr}

int16_t	boot_count_ = 0

int16_t	no_response_count_ = 0

std::string	buffer_

RGModel	model_ = RG9

RG15Resolution	resolution_ = FORCE_HIGH

int	sw_version_ = 0

bool	too_cold_ = false

bool	lens_bad_ = false

bool	em_sat_ = false

bool	request_temperature_ = false

bool	disable_led_ = false

int	sensors_received_ = -1

Protected Attributes inherited from esphome::PollingComponent
uint32_t	update_interval_

Protected Attributes inherited from esphome::Component
uint32_t	component_state_ {0x0000}
	State of this component. More...

float	setup_priority_override_ {NAN}

const char *	component_source_ {nullptr}

std::string	error_message_ {}

Protected Attributes inherited from esphome::uart::UARTDevice
UARTComponent *	parent_ {nullptr}

Detailed Description

Definition at line 36 of file hydreon_rgxx.h.

Member Function Documentation

◆ buffer_starts_with_() [1/2]

bool esphome::hydreon_rgxx::HydreonRGxxComponent::buffer_starts_with_ ( const std::string & prefix )

protected

Definition at line 160 of file hydreon_rgxx.cpp.

◆ buffer_starts_with_() [2/2]

bool esphome::hydreon_rgxx::HydreonRGxxComponent::buffer_starts_with_ ( const char * prefix )

protected

Definition at line 164 of file hydreon_rgxx.cpp.

◆ dump_config()

void esphome::hydreon_rgxx::HydreonRGxxComponent::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 14 of file hydreon_rgxx.cpp.

◆ get_setup_priority()

float esphome::hydreon_rgxx::HydreonRGxxComponent::get_setup_priority ( ) const

overridevirtual

Reimplemented from esphome::Component.

Definition at line 292 of file hydreon_rgxx.cpp.

◆ loop()

void esphome::hydreon_rgxx::HydreonRGxxComponent::loop ( )

overridevirtual

Read data once available.

Reimplemented from esphome::Component.

Definition at line 112 of file hydreon_rgxx.cpp.

◆ num_sensors_missing_()

int esphome::hydreon_rgxx::HydreonRGxxComponent::num_sensors_missing_ ( )

protected

Definition at line 49 of file hydreon_rgxx.cpp.

◆ process_line_()

void esphome::hydreon_rgxx::HydreonRGxxComponent::process_line_ ( )

protected

Definition at line 166 of file hydreon_rgxx.cpp.

◆ schedule_reboot_()

void esphome::hydreon_rgxx::HydreonRGxxComponent::schedule_reboot_ ( )

protected

Communication with the sensor is asynchronous.

We send requests and let esphome continue doing its thing. Once we have received a complete line, we process it.

Catching communication failures is done in two layers:

We check if all requested data has been received before we send out the next request. If data keeps missing, we escalate.
Request the sensor to reboot. We retry based on a timeout. If the sensor does not respond after several boot attempts, we give up.

Definition at line 140 of file hydreon_rgxx.cpp.

◆ set_disable_led()

void esphome::hydreon_rgxx::HydreonRGxxComponent::set_disable_led ( bool disable_led )

inline

Definition at line 58 of file hydreon_rgxx.h.

◆ set_em_sat_sensor()

void esphome::hydreon_rgxx::HydreonRGxxComponent::set_em_sat_sensor ( binary_sensor::BinarySensor * sensor )

inline

Definition at line 42 of file hydreon_rgxx.h.

◆ set_lens_bad_sensor()

void esphome::hydreon_rgxx::HydreonRGxxComponent::set_lens_bad_sensor ( binary_sensor::BinarySensor * sensor )

inline

Definition at line 41 of file hydreon_rgxx.h.

◆ set_model()

void esphome::hydreon_rgxx::HydreonRGxxComponent::set_model ( RGModel model )

inline

Definition at line 44 of file hydreon_rgxx.h.

◆ set_request_temperature()

void esphome::hydreon_rgxx::HydreonRGxxComponent::set_request_temperature ( bool b )

inline

Definition at line 46 of file hydreon_rgxx.h.

◆ set_resolution()

void esphome::hydreon_rgxx::HydreonRGxxComponent::set_resolution ( RG15Resolution resolution )

inline

Definition at line 45 of file hydreon_rgxx.h.

◆ set_sensor()

void esphome::hydreon_rgxx::HydreonRGxxComponent::set_sensor	(	sensor::Sensor *	sensor,
		int	index
	)

inline

Definition at line 38 of file hydreon_rgxx.h.

◆ set_too_cold_sensor()

void esphome::hydreon_rgxx::HydreonRGxxComponent::set_too_cold_sensor ( binary_sensor::BinarySensor * sensor )

inline

Definition at line 40 of file hydreon_rgxx.h.

◆ setup()

void esphome::hydreon_rgxx::HydreonRGxxComponent::setup ( )

overridevirtual

Setup the sensor and test for a connection.

Reimplemented from esphome::Component.

Definition at line 41 of file hydreon_rgxx.cpp.

◆ update()

void esphome::hydreon_rgxx::HydreonRGxxComponent::update ( )

overridevirtual

Schedule data readings.

Implements esphome::PollingComponent.

Definition at line 66 of file hydreon_rgxx.cpp.

Field Documentation

◆ boot_count_

int16_t esphome::hydreon_rgxx::HydreonRGxxComponent::boot_count_ = 0

protected

Definition at line 74 of file hydreon_rgxx.h.

◆ buffer_

std::string esphome::hydreon_rgxx::HydreonRGxxComponent::buffer_

protected

Definition at line 76 of file hydreon_rgxx.h.

◆ disable_led_

bool esphome::hydreon_rgxx::HydreonRGxxComponent::disable_led_ = false

protected

Definition at line 86 of file hydreon_rgxx.h.

◆ em_sat_

bool esphome::hydreon_rgxx::HydreonRGxxComponent::em_sat_ = false

protected

Definition at line 84 of file hydreon_rgxx.h.

◆ em_sat_sensor_

binary_sensor::BinarySensor* esphome::hydreon_rgxx::HydreonRGxxComponent::em_sat_sensor_ {nullptr}

protected

Definition at line 71 of file hydreon_rgxx.h.

◆ lens_bad_

bool esphome::hydreon_rgxx::HydreonRGxxComponent::lens_bad_ = false

protected

Definition at line 83 of file hydreon_rgxx.h.

◆ lens_bad_sensor_

binary_sensor::BinarySensor* esphome::hydreon_rgxx::HydreonRGxxComponent::lens_bad_sensor_ {nullptr}

protected

Definition at line 70 of file hydreon_rgxx.h.

◆ model_

RGModel esphome::hydreon_rgxx::HydreonRGxxComponent::model_ = RG9

protected

Definition at line 78 of file hydreon_rgxx.h.

◆ no_response_count_

int16_t esphome::hydreon_rgxx::HydreonRGxxComponent::no_response_count_ = 0

protected

Definition at line 75 of file hydreon_rgxx.h.

◆ request_temperature_

bool esphome::hydreon_rgxx::HydreonRGxxComponent::request_temperature_ = false

protected

Definition at line 85 of file hydreon_rgxx.h.

◆ resolution_

RG15Resolution esphome::hydreon_rgxx::HydreonRGxxComponent::resolution_ = FORCE_HIGH

protected

Definition at line 79 of file hydreon_rgxx.h.

◆ sensors_

sensor::Sensor* esphome::hydreon_rgxx::HydreonRGxxComponent::sensors_[NUM_SENSORS] = {nullptr}

protected

Definition at line 67 of file hydreon_rgxx.h.

◆ sensors_received_

int esphome::hydreon_rgxx::HydreonRGxxComponent::sensors_received_ = -1

protected

Definition at line 89 of file hydreon_rgxx.h.

◆ sw_version_

int esphome::hydreon_rgxx::HydreonRGxxComponent::sw_version_ = 0

protected

Definition at line 81 of file hydreon_rgxx.h.

◆ too_cold_

bool esphome::hydreon_rgxx::HydreonRGxxComponent::too_cold_ = false

protected

Definition at line 82 of file hydreon_rgxx.h.

◆ too_cold_sensor_

binary_sensor::BinarySensor* esphome::hydreon_rgxx::HydreonRGxxComponent::too_cold_sensor_ {nullptr}

protected

Definition at line 69 of file hydreon_rgxx.h.

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

/opt/build/esphome/esphome/components/hydreon_rgxx/hydreon_rgxx.h
/opt/build/esphome/esphome/components/hydreon_rgxx/hydreon_rgxx.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ buffer_starts_with_() [1/2]

◆ buffer_starts_with_() [2/2]

◆ dump_config()

◆ get_setup_priority()

◆ loop()

◆ num_sensors_missing_()

◆ process_line_()

◆ schedule_reboot_()

◆ set_disable_led()

◆ set_em_sat_sensor()

◆ set_lens_bad_sensor()

◆ set_model()

◆ set_request_temperature()

◆ set_resolution()

◆ set_sensor()

◆ set_too_cold_sensor()

◆ setup()

◆ update()

Field Documentation

◆ boot_count_

◆ buffer_

◆ disable_led_

◆ em_sat_

◆ em_sat_sensor_

◆ lens_bad_

◆ lens_bad_sensor_

◆ model_

◆ no_response_count_

◆ request_temperature_

◆ resolution_

◆ sensors_

◆ sensors_received_

◆ sw_version_

◆ too_cold_

◆ too_cold_sensor_