#include <sx1509.h>

Inheritance diagram for esphome::sx1509::SX1509Component:

Public Member Functions
	SX1509Component ()=default

void	setup () override

void	dump_config () override

float	get_setup_priority () const override

void	loop () override

bool	digital_read (uint8_t pin)

uint16_t	read_key_data ()

void	set_pin_value (uint8_t pin, uint8_t i_on)

void	pin_mode (uint8_t pin, gpio::Flags flags)

void	digital_write (uint8_t pin, bool bit_value)

uint32_t	get_clock ()

void	set_rows_cols (uint8_t rows, uint8_t cols)

void	set_sleep_time (uint16_t sleep_time)

void	set_scan_time (uint8_t scan_time)

void	set_debounce_time (uint8_t debounce_time=1)

void	register_keypad_binary_sensor (SX1509Processor *binary_sensor)

void	setup_led_driver (uint8_t pin)

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::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 Member Functions
void	setup_keypad_ ()

void	set_debounce_config_ (uint8_t config_value)

void	set_debounce_time_ (uint8_t time)

void	set_debounce_pin_ (uint8_t pin)

void	set_debounce_enable_ (uint8_t pin)

void	set_debounce_keypad_ (uint8_t time, uint8_t num_rows, uint8_t num_cols)

void	clock_ (uint8_t osc_source=2, uint8_t osc_pin_function=1, uint8_t osc_freq_out=0, uint8_t osc_divider=0)

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

Protected Attributes
uint32_t	clk_x_ = 2000000

uint8_t	frequency_ = 0

uint16_t	ddr_mask_ = 0x00

uint16_t	input_mask_ = 0x00

uint16_t	port_mask_ = 0x00

uint16_t	output_state_ = 0x00

bool	has_keypad_ = false

uint8_t	rows_ = 0

uint8_t	cols_ = 0

uint16_t	sleep_time_ = 128

uint8_t	scan_time_ = 1

uint8_t	debounce_time_ = 1

std::vector< SX1509Processor * >	keypad_binary_sensors_

uint32_t	last_loop_timestamp_ = 0

const uint32_t	min_loop_period_ = 15

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::i2c::I2CDevice
uint8_t	address_ {0x00}
	store the address of the device on the bus More...

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

Detailed Description

Definition at line 30 of file sx1509.h.

Constructor & Destructor Documentation

◆ SX1509Component()

esphome::sx1509::SX1509Component::SX1509Component ( )

default

Member Function Documentation

◆ clock_()

void esphome::sx1509::SX1509Component::clock_	(	uint8_t	osc_source = `2`,
		uint8_t	osc_pin_function = `1`,
		uint8_t	osc_freq_out = `0`,
		uint8_t	osc_divider = `0`
	)

protected

Definition at line 180 of file sx1509.cpp.

◆ digital_read()

bool esphome::sx1509::SX1509Component::digital_read ( uint8_t pin )

Definition at line 54 of file sx1509.cpp.

◆ digital_write()

void esphome::sx1509::SX1509Component::digital_write	(	uint8_t	pin,
		bool	bit_value
	)

Definition at line 65 of file sx1509.cpp.

◆ dump_config()

void esphome::sx1509::SX1509Component::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 35 of file sx1509.cpp.

◆ get_clock()

uint32_t esphome::sx1509::SX1509Component::get_clock ( )

inline

Definition at line 44 of file sx1509.h.

◆ get_setup_priority()

float esphome::sx1509::SX1509Component::get_setup_priority ( ) const

inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 36 of file sx1509.h.

◆ loop()

void esphome::sx1509::SX1509Component::loop ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 43 of file sx1509.cpp.

◆ pin_mode()

void esphome::sx1509::SX1509Component::pin_mode	(	uint8_t	pin,
		gpio::Flags	flags
	)

Definition at line 88 of file sx1509.cpp.

◆ read_key_data()

uint16_t esphome::sx1509::SX1509Component::read_key_data ( )

Definition at line 238 of file sx1509.cpp.

◆ register_keypad_binary_sensor()

void esphome::sx1509::SX1509Component::register_keypad_binary_sensor ( SX1509Processor * binary_sensor )

inline

Definition at line 53 of file sx1509.h.

◆ set_debounce_config_()

void esphome::sx1509::SX1509Component::set_debounce_config_ ( uint8_t config_value )

protected

Definition at line 244 of file sx1509.cpp.

◆ set_debounce_enable_()

void esphome::sx1509::SX1509Component::set_debounce_enable_ ( uint8_t pin )

protected

Definition at line 272 of file sx1509.cpp.

◆ set_debounce_keypad_()

void esphome::sx1509::SX1509Component::set_debounce_keypad_	(	uint8_t	time,
		uint8_t	num_rows,
		uint8_t	num_cols
	)

protected

Definition at line 281 of file sx1509.cpp.

◆ set_debounce_pin_()

void esphome::sx1509::SX1509Component::set_debounce_pin_ ( uint8_t pin )

protected

Definition at line 279 of file sx1509.cpp.

◆ set_debounce_time()

void esphome::sx1509::SX1509Component::set_debounce_time ( uint8_t debounce_time = 1 )

inline

Definition at line 52 of file sx1509.h.

◆ set_debounce_time_()

void esphome::sx1509::SX1509Component::set_debounce_time_ ( uint8_t time )

protected

Definition at line 258 of file sx1509.cpp.

◆ set_pin_value()

void esphome::sx1509::SX1509Component::set_pin_value	(	uint8_t	pin,
		uint8_t	i_on
	)

inline

Definition at line 41 of file sx1509.h.

◆ set_rows_cols()

void esphome::sx1509::SX1509Component::set_rows_cols	(	uint8_t	rows,
		uint8_t	cols
	)

inline

Definition at line 45 of file sx1509.h.

◆ set_scan_time()

void esphome::sx1509::SX1509Component::set_scan_time ( uint8_t scan_time )

inline

Definition at line 51 of file sx1509.h.

◆ set_sleep_time()

void esphome::sx1509::SX1509Component::set_sleep_time ( uint16_t sleep_time )

inline

Definition at line 50 of file sx1509.h.

◆ setup()

void esphome::sx1509::SX1509Component::setup ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 10 of file sx1509.cpp.

◆ setup_keypad_()

void esphome::sx1509::SX1509Component::setup_keypad_ ( )

protected

Definition at line 198 of file sx1509.cpp.

◆ setup_led_driver()

void esphome::sx1509::SX1509Component::setup_led_driver ( uint8_t pin )

Definition at line 148 of file sx1509.cpp.

Field Documentation

◆ clk_x_

uint32_t esphome::sx1509::SX1509Component::clk_x_ = 2000000

protected

Definition at line 59 of file sx1509.h.

◆ cols_

uint8_t esphome::sx1509::SX1509Component::cols_ = 0

protected

Definition at line 67 of file sx1509.h.

◆ ddr_mask_

uint16_t esphome::sx1509::SX1509Component::ddr_mask_ = 0x00

protected

Definition at line 61 of file sx1509.h.

◆ debounce_time_

uint8_t esphome::sx1509::SX1509Component::debounce_time_ = 1

protected

Definition at line 70 of file sx1509.h.

◆ frequency_

uint8_t esphome::sx1509::SX1509Component::frequency_ = 0

protected

Definition at line 60 of file sx1509.h.

◆ has_keypad_

bool esphome::sx1509::SX1509Component::has_keypad_ = false

protected

Definition at line 65 of file sx1509.h.

◆ input_mask_

uint16_t esphome::sx1509::SX1509Component::input_mask_ = 0x00

protected

Definition at line 62 of file sx1509.h.

◆ keypad_binary_sensors_

std::vector<SX1509Processor *> esphome::sx1509::SX1509Component::keypad_binary_sensors_

protected

Definition at line 71 of file sx1509.h.

◆ last_loop_timestamp_

uint32_t esphome::sx1509::SX1509Component::last_loop_timestamp_ = 0

protected

Definition at line 73 of file sx1509.h.

◆ min_loop_period_

const uint32_t esphome::sx1509::SX1509Component::min_loop_period_ = 15

protected

Definition at line 74 of file sx1509.h.

◆ output_state_

uint16_t esphome::sx1509::SX1509Component::output_state_ = 0x00

protected

Definition at line 64 of file sx1509.h.

◆ port_mask_

uint16_t esphome::sx1509::SX1509Component::port_mask_ = 0x00

protected

Definition at line 63 of file sx1509.h.

◆ rows_

uint8_t esphome::sx1509::SX1509Component::rows_ = 0

protected

Definition at line 66 of file sx1509.h.

◆ scan_time_

uint8_t esphome::sx1509::SX1509Component::scan_time_ = 1

protected

Definition at line 69 of file sx1509.h.

◆ sleep_time_

uint16_t esphome::sx1509::SX1509Component::sleep_time_ = 128

protected

Definition at line 68 of file sx1509.h.

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SX1509Component()

Member Function Documentation

◆ clock_()

◆ digital_read()

◆ digital_write()

◆ dump_config()

◆ get_clock()

◆ get_setup_priority()

◆ loop()

◆ pin_mode()

◆ read_key_data()

◆ register_keypad_binary_sensor()

◆ set_debounce_config_()

◆ set_debounce_enable_()

◆ set_debounce_keypad_()

◆ set_debounce_pin_()

◆ set_debounce_time()

◆ set_debounce_time_()

◆ set_pin_value()

◆ set_rows_cols()

◆ set_scan_time()

◆ set_sleep_time()

◆ setup()

◆ setup_keypad_()

◆ setup_led_driver()

Field Documentation

◆ clk_x_

◆ cols_

◆ ddr_mask_

◆ debounce_time_

◆ frequency_

◆ has_keypad_

◆ input_mask_

◆ keypad_binary_sensors_

◆ last_loop_timestamp_

◆ min_loop_period_

◆ output_state_

◆ port_mask_

◆ rows_

◆ scan_time_

◆ sleep_time_