#include <at581x.h>

Inheritance diagram for esphome::at581x::AT581XComponent:

Public Member Functions
void	set_rf_power_switch (switch_::Switch *s)

void	setup () override

void	dump_config () override

void	set_sensing_distance (int distance)

void	set_rf_mode (bool enabled)

void	set_frequency (int frequency)

void	set_poweron_selfcheck_time (int value)

void	set_protect_time (int value)

void	set_trigger_base (int value)

void	set_trigger_keep (int value)

void	set_stage_gain (int value)

void	set_power_consumption (int value)

bool	i2c_write_config ()

bool	reset_hardware_frontend ()

bool	i2c_write_reg (uint8_t addr, uint8_t data)

bool	i2c_write_reg (uint8_t addr, uint32_t data)

bool	i2c_write_reg (uint8_t addr, uint16_t data)

bool	i2c_read_reg (uint8_t addr, uint8_t &data)

Public Member Functions inherited from esphome::Component
virtual void	loop ()
	This method will be called repeatedly. More...

virtual float	get_setup_priority () const
	priority of setup(). More...

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...

bool	is_failed ()

bool	is_ready ()

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::i2c::I2CDevice
	I2CDevice ()=default
	we use the C++ default constructor More...

void	set_i2c_address (uint8_t address)
	We store the address of the device on the bus. More...

void	set_i2c_bus (I2CBus *bus)
	we store the pointer to the I2CBus to use More...

I2CRegister	reg (uint8_t a_register)
	calls the I2CRegister constructor More...

I2CRegister16	reg16 (uint16_t a_register)
	calls the I2CRegister16 constructor More...

ErrorCode	read (uint8_t *data, size_t len)
	reads an array of bytes from the device using an I2CBus More...

ErrorCode	read_register (uint8_t a_register, uint8_t *data, size_t len, bool stop=true)
	reads an array of bytes from a specific register in the I²C device More...

ErrorCode	read_register16 (uint16_t a_register, uint8_t *data, size_t len, bool stop=true)
	reads an array of bytes from a specific register in the I²C device More...

ErrorCode	write (const uint8_t *data, size_t len, bool stop=true)
	writes an array of bytes to a device using an I2CBus More...

ErrorCode	write_register (uint8_t a_register, const uint8_t *data, size_t len, bool stop=true)
	writes an array of bytes to a specific register in the I²C device More...

ErrorCode	write_register16 (uint16_t a_register, const uint8_t *data, size_t len, bool stop=true)
	write an array of bytes to a specific register in the I²C device More...

bool	read_bytes (uint8_t a_register, uint8_t *data, uint8_t len)
	Compat APIs All methods below have been added for compatibility reasons. More...

bool	read_bytes_raw (uint8_t *data, uint8_t len)

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

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

bool	read_bytes_16 (uint8_t a_register, uint16_t *data, uint8_t len)

bool	read_byte (uint8_t a_register, uint8_t *data, bool stop=true)

optional< uint8_t >	read_byte (uint8_t a_register)

bool	read_byte_16 (uint8_t a_register, uint16_t *data)

bool	write_bytes (uint8_t a_register, const uint8_t *data, uint8_t len, bool stop=true)

bool	write_bytes (uint8_t a_register, const std::vector< uint8_t > &data)

template<size_t N>
bool	write_bytes (uint8_t a_register, const std::array< uint8_t, N > &data)

bool	write_bytes_16 (uint8_t a_register, const uint16_t *data, uint8_t len)

bool	write_byte (uint8_t a_register, uint8_t data, bool stop=true)

bool	write_byte_16 (uint8_t a_register, uint16_t data)

Protected Attributes
switch_::Switch *	rf_power_switch_ {nullptr}

int	freq_

int	self_check_time_ms_

int	protect_time_ms_

int	trigger_base_time_ms_

int	trigger_keep_time_ms_

int	delta_

int	gain_

int	power_

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}

Protected Attributes inherited from esphome::i2c::I2CDevice
uint8_t	address_ {0x00}
	store the address of the device on the bus More...

I2CBus *	bus_ {nullptr}
	pointer to I2CBus instance More...

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

virtual void	call_setup ()

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...

Detailed Description

Definition at line 16 of file at581x.h.

Member Function Documentation

◆ dump_config()

void esphome::at581x::AT581XComponent::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 75 of file at581x.cpp.

◆ i2c_read_reg()

bool esphome::at581x::AT581XComponent::i2c_read_reg	(	uint8_t	addr,
		uint8_t &	data
	)

Definition at line 70 of file at581x.cpp.

◆ i2c_write_config()

bool esphome::at581x::AT581XComponent::i2c_write_config ( )

Definition at line 77 of file at581x.cpp.

◆ i2c_write_reg() [1/3]

bool esphome::at581x::AT581XComponent::i2c_write_reg	(	uint8_t	addr,
		uint8_t	data
	)

Definition at line 57 of file at581x.cpp.

◆ i2c_write_reg() [2/3]

bool esphome::at581x::AT581XComponent::i2c_write_reg	(	uint8_t	addr,
		uint32_t	data
	)

Definition at line 60 of file at581x.cpp.

◆ i2c_write_reg() [3/3]

bool esphome::at581x::AT581XComponent::i2c_write_reg	(	uint8_t	addr,
		uint16_t	data
	)

Definition at line 66 of file at581x.cpp.

◆ reset_hardware_frontend()

bool esphome::at581x::AT581XComponent::reset_hardware_frontend ( )

Definition at line 176 of file at581x.cpp.

◆ set_frequency()

void esphome::at581x::AT581XComponent::set_frequency ( int frequency )

inline

Definition at line 35 of file at581x.h.

◆ set_power_consumption()

void esphome::at581x::AT581XComponent::set_power_consumption ( int value )

inline

Definition at line 41 of file at581x.h.

◆ set_poweron_selfcheck_time()

void esphome::at581x::AT581XComponent::set_poweron_selfcheck_time ( int value )

inline

Definition at line 36 of file at581x.h.

◆ set_protect_time()

void esphome::at581x::AT581XComponent::set_protect_time ( int value )

inline

Definition at line 37 of file at581x.h.

◆ set_rf_mode()

void esphome::at581x::AT581XComponent::set_rf_mode ( bool enabled )

Definition at line 184 of file at581x.cpp.

◆ set_rf_power_switch()

void esphome::at581x::AT581XComponent::set_rf_power_switch ( switch_::Switch * s )

inline

Definition at line 22 of file at581x.h.

◆ set_sensing_distance()

void esphome::at581x::AT581XComponent::set_sensing_distance ( int distance )

inline

Definition at line 32 of file at581x.h.

◆ set_stage_gain()

void esphome::at581x::AT581XComponent::set_stage_gain ( int value )

inline

Definition at line 40 of file at581x.h.

◆ set_trigger_base()

void esphome::at581x::AT581XComponent::set_trigger_base ( int value )

inline

Definition at line 38 of file at581x.h.

◆ set_trigger_keep()

void esphome::at581x::AT581XComponent::set_trigger_keep ( int value )

inline

Definition at line 39 of file at581x.h.

◆ setup()

void esphome::at581x::AT581XComponent::setup ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 74 of file at581x.cpp.

Field Documentation

◆ delta_

int esphome::at581x::AT581XComponent::delta_

protected

Delta value: 0 ~ 1023, the larger the value, the shorter the distance

Definition at line 56 of file at581x.h.

◆ freq_

int esphome::at581x::AT581XComponent::freq_

protected

Definition at line 51 of file at581x.h.

◆ gain_

int esphome::at581x::AT581XComponent::gain_

protected

Default: 9dB

Definition at line 57 of file at581x.h.

◆ power_

int esphome::at581x::AT581XComponent::power_

protected

In µA

Definition at line 58 of file at581x.h.

◆ protect_time_ms_

int esphome::at581x::AT581XComponent::protect_time_ms_

protected

Protection time, recommended 1000 ms

Definition at line 53 of file at581x.h.

◆ rf_power_switch_

switch_::Switch* esphome::at581x::AT581XComponent::rf_power_switch_ {nullptr}

protected

Definition at line 19 of file at581x.h.

◆ self_check_time_ms_

int esphome::at581x::AT581XComponent::self_check_time_ms_

protected

Power-on self-test time, range: 0 ~ 65536 ms

Definition at line 52 of file at581x.h.

◆ trigger_base_time_ms_

int esphome::at581x::AT581XComponent::trigger_base_time_ms_

protected

Default: 500 ms

Definition at line 54 of file at581x.h.

◆ trigger_keep_time_ms_

int esphome::at581x::AT581XComponent::trigger_keep_time_ms_

protected

Total trig time = TRIGGER_BASE_TIME + DEF_TRIGGER_KEEP_TIME, minimum: 1

Definition at line 55 of file at581x.h.

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

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

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ dump_config()

◆ i2c_read_reg()

◆ i2c_write_config()

◆ i2c_write_reg() [1/3]

◆ i2c_write_reg() [2/3]

◆ i2c_write_reg() [3/3]

◆ reset_hardware_frontend()

◆ set_frequency()

◆ set_power_consumption()

◆ set_poweron_selfcheck_time()

◆ set_protect_time()

◆ set_rf_mode()

◆ set_rf_power_switch()

◆ set_sensing_distance()

◆ set_stage_gain()

◆ set_trigger_base()

◆ set_trigger_keep()

◆ setup()

Field Documentation

◆ delta_

◆ freq_

◆ gain_

◆ power_

◆ protect_time_ms_

◆ rf_power_switch_

◆ self_check_time_ms_

◆ trigger_base_time_ms_

◆ trigger_keep_time_ms_