ESPHome 2025.6.3
Loading...
Searching...
No Matches
sx1509.h
Go to the documentation of this file.
1#pragma once
2
6#include "esphome/core/hal.h"
7#include "sx1509_gpio_pin.h"
8#include "sx1509_registers.h"
9
10#include <vector>
11
12namespace esphome {
13namespace sx1509 {
14
15// These are used for clock config:
16const uint8_t INTERNAL_CLOCK_2MHZ = 2;
17const uint8_t EXTERNAL_CLOCK = 1;
18const uint8_t SOFTWARE_RESET = 0;
19const uint8_t HARDWARE_RESET = 1;
20
24
25// for all components that implement the process(uint16_t data )
27 public:
28 virtual void process(uint16_t data){};
29};
30
31class SX1509KeyTrigger : public Trigger<uint8_t> {};
32
34 public:
35 SX1509Component() = default;
36
37 void setup() override;
38 void dump_config() override;
39 float get_setup_priority() const override { return setup_priority::HARDWARE; }
40 void loop() override;
41
42 bool digital_read(uint8_t pin);
43 uint16_t read_key_data();
44 void set_pin_value(uint8_t pin, uint8_t i_on) { this->write_byte(REG_I_ON[pin], i_on); };
45 void pin_mode(uint8_t pin, gpio::Flags flags);
46 void digital_write(uint8_t pin, bool bit_value);
47 uint32_t get_clock() { return this->clk_x_; };
48 void set_rows_cols(uint8_t rows, uint8_t cols) {
49 this->rows_ = rows;
50 this->cols_ = cols;
51 this->has_keypad_ = true;
52 };
53 void set_keys(std::string keys) { this->keys_ = std::move(keys); };
54 void set_sleep_time(uint16_t sleep_time) { this->sleep_time_ = sleep_time; };
55 void set_scan_time(uint8_t scan_time) { this->scan_time_ = scan_time; };
56 void set_debounce_time(uint8_t debounce_time = 1) { this->debounce_time_ = debounce_time; };
58 this->keypad_binary_sensors_.push_back(binary_sensor);
59 }
60 void register_key_trigger(SX1509KeyTrigger *trig) { this->key_triggers_.push_back(trig); };
61 void setup_led_driver(uint8_t pin);
62
63 protected:
64 uint32_t clk_x_ = 2000000;
65 uint8_t frequency_ = 0;
66 uint16_t ddr_mask_ = 0x00;
67 uint16_t input_mask_ = 0x00;
68 uint16_t port_mask_ = 0x00;
69 uint16_t output_state_ = 0x00;
70 bool has_keypad_ = false;
71 uint8_t rows_ = 0;
72 uint8_t cols_ = 0;
73 std::string keys_;
74 uint16_t sleep_time_ = 128;
75 uint8_t scan_time_ = 1;
76 uint8_t debounce_time_ = 1;
77 uint8_t last_key_ = 0;
78 std::vector<SX1509Processor *> keypad_binary_sensors_;
79 std::vector<SX1509KeyTrigger *> key_triggers_;
80
82 const uint32_t min_loop_period_ = 15; // ms
83
84 void setup_keypad_();
85 void set_debounce_config_(uint8_t config_value);
86 void set_debounce_time_(uint8_t time);
87 void set_debounce_pin_(uint8_t pin);
88 void set_debounce_enable_(uint8_t pin);
89 void set_debounce_keypad_(uint8_t time, uint8_t num_rows, uint8_t num_cols);
90 void clock_(uint8_t osc_source = 2, uint8_t osc_pin_function = 1, uint8_t osc_freq_out = 0, uint8_t osc_divider = 0);
91};
92
93} // namespace sx1509
94} // namespace esphome
This Class provides the methods to read/write bytes from/to an i2c device.
Definition i2c.h:133
bool write_byte(uint8_t a_register, uint8_t data, bool stop=true)
Definition i2c.h:266
interface for components that provide keypresses
float get_setup_priority() const override
Definition sx1509.h:39
void register_keypad_binary_sensor(SX1509Processor *binary_sensor)
Definition sx1509.h:57
void clock_(uint8_t osc_source=2, uint8_t osc_pin_function=1, uint8_t osc_freq_out=0, uint8_t osc_divider=0)
Definition sx1509.cpp:204
void set_sleep_time(uint16_t sleep_time)
Definition sx1509.h:54
void set_keys(std::string keys)
Definition sx1509.h:53
void set_scan_time(uint8_t scan_time)
Definition sx1509.h:55
void register_key_trigger(SX1509KeyTrigger *trig)
Definition sx1509.h:60
bool digital_read(uint8_t pin)
Definition sx1509.cpp:78
void set_debounce_pin_(uint8_t pin)
Definition sx1509.cpp:303
void set_debounce_config_(uint8_t config_value)
Definition sx1509.cpp:268
void digital_write(uint8_t pin, bool bit_value)
Definition sx1509.cpp:89
void set_rows_cols(uint8_t rows, uint8_t cols)
Definition sx1509.h:48
std::vector< SX1509KeyTrigger * > key_triggers_
Definition sx1509.h:79
void set_debounce_time_(uint8_t time)
Definition sx1509.cpp:282
void set_debounce_keypad_(uint8_t time, uint8_t num_rows, uint8_t num_cols)
Definition sx1509.cpp:305
void pin_mode(uint8_t pin, gpio::Flags flags)
Definition sx1509.cpp:112
std::vector< SX1509Processor * > keypad_binary_sensors_
Definition sx1509.h:78
void set_debounce_time(uint8_t debounce_time=1)
Definition sx1509.h:56
void setup_led_driver(uint8_t pin)
Definition sx1509.cpp:172
void set_debounce_enable_(uint8_t pin)
Definition sx1509.cpp:296
void set_pin_value(uint8_t pin, uint8_t i_on)
Definition sx1509.h:44
const uint32_t min_loop_period_
Definition sx1509.h:82
virtual void process(uint16_t data)
Definition sx1509.h:28
const float HARDWARE
For components that deal with hardware and are very important like GPIO switch.
Definition component.cpp:19
const uint8_t REG_I_ON_15
const uint8_t EXTERNAL_CLOCK
Definition sx1509.h:17
const uint8_t REG_I_ON_12
const uint8_t REG_I_ON_2
const uint8_t REG_I_ON_4
const uint8_t REG_I_ON_5
const uint8_t HARDWARE_RESET
Definition sx1509.h:19
const uint8_t SOFTWARE_RESET
Definition sx1509.h:18
const uint8_t REG_I_ON_9
const uint8_t REG_I_ON_6
const uint8_t REG_I_ON_13
const uint8_t REG_I_ON_3
const uint8_t REG_I_ON_14
const uint8_t REG_I_ON[16]
Definition sx1509.h:21
const uint8_t REG_I_ON_1
const uint8_t REG_I_ON_10
const uint8_t REG_I_ON_11
const uint8_t INTERNAL_CLOCK_2MHZ
Definition sx1509.h:16
const uint8_t REG_I_ON_7
const uint8_t REG_I_ON_0
const uint8_t REG_I_ON_8
Providing packet encoding functions for exchanging data with a remote host.
Definition a01nyub.cpp:7