ESPHome 2025.10.0-dev
Loading...
Searching...
No Matches
pca6416a.cpp
Go to the documentation of this file.
1#include "pca6416a.h"
2#include "esphome/core/log.h"
3
4namespace esphome {
5namespace pca6416a {
6
23
24static const char *const TAG = "pca6416a";
25
27 // Test to see if device exists
28 uint8_t value;
29 if (!this->read_register_(PCA6416A_INPUT0, &value)) {
30 ESP_LOGE(TAG, "PCA6416A not available under 0x%02X", this->address_);
31 this->mark_failed();
32 return;
33 }
34
35 // Test to see if the device supports pull-up resistors
36 if (this->read_register(PCAL6416A_PULL_EN0, &value, 1) == i2c::ERROR_OK) {
37 this->has_pullup_ = true;
38 }
39
40 // No polarity inversion
43 // Set all pins to input
46 // Read current output register state
49
50 ESP_LOGD(TAG, "Initialization complete. Warning: %d, Error: %d", this->status_has_warning(),
51 this->status_has_error());
52}
53
55 // Invalidate cache at the start of each loop
56 this->reset_pin_cache_();
57}
58
60 if (this->has_pullup_) {
61 ESP_LOGCONFIG(TAG, "PCAL6416A:");
62 } else {
63 ESP_LOGCONFIG(TAG, "PCA6416A:");
64 }
65 LOG_I2C_DEVICE(this)
66 if (this->is_failed()) {
67 ESP_LOGE(TAG, ESP_LOG_MSG_COMM_FAIL);
68 }
69}
70
72 uint8_t reg_addr = pin < 8 ? PCA6416A_INPUT0 : PCA6416A_INPUT1;
73 uint8_t value = 0;
74 if (!this->read_register_(reg_addr, &value)) {
75 return false;
76 }
77
78 // Update the appropriate part of input_mask_
79 if (pin < 8) {
80 this->input_mask_ = (this->input_mask_ & 0xFF00) | value;
81 } else {
82 this->input_mask_ = (this->input_mask_ & 0x00FF) | (uint16_t(value) << 8);
83 }
84 return true;
85}
86
87bool PCA6416AComponent::digital_read_cache(uint8_t pin) { return this->input_mask_ & (1 << pin); }
88
89void PCA6416AComponent::digital_write_hw(uint8_t pin, bool value) {
90 uint8_t reg_addr = pin < 8 ? PCA6416A_OUTPUT0 : PCA6416A_OUTPUT1;
91 this->update_register_(pin, value, reg_addr);
92}
93
95 uint8_t io_dir = pin < 8 ? PCA6416A_CONFIG0 : PCA6416A_CONFIG1;
96 uint8_t pull_en = pin < 8 ? PCAL6416A_PULL_EN0 : PCAL6416A_PULL_EN1;
97 uint8_t pull_dir = pin < 8 ? PCAL6416A_PULL_DIR0 : PCAL6416A_PULL_DIR1;
98 if (flags == gpio::FLAG_INPUT) {
99 this->update_register_(pin, true, io_dir);
100 if (has_pullup_) {
101 this->update_register_(pin, true, pull_dir);
102 this->update_register_(pin, false, pull_en);
103 }
104 } else if (flags == (gpio::FLAG_INPUT | gpio::FLAG_PULLUP)) {
105 this->update_register_(pin, true, io_dir);
106 if (has_pullup_) {
107 this->update_register_(pin, true, pull_dir);
108 this->update_register_(pin, true, pull_en);
109 } else {
110 ESP_LOGW(TAG, "Your PCA6416A does not support pull-up resistors");
111 }
112 } else if (flags == gpio::FLAG_OUTPUT) {
113 this->update_register_(pin, false, io_dir);
114 }
115}
116
117bool PCA6416AComponent::read_register_(uint8_t reg, uint8_t *value) {
118 if (this->is_failed()) {
119 ESP_LOGD(TAG, "Device marked failed");
120 return false;
121 }
122
123 this->last_error_ = this->read_register(reg, value, 1);
124 if (this->last_error_ != i2c::ERROR_OK) {
125 this->status_set_warning();
126 ESP_LOGE(TAG, "read_register_(): I2C I/O error: %d", (int) this->last_error_);
127 return false;
128 }
129
130 this->status_clear_warning();
131 return true;
132}
133
134bool PCA6416AComponent::write_register_(uint8_t reg, uint8_t value) {
135 if (this->is_failed()) {
136 ESP_LOGD(TAG, "Device marked failed");
137 return false;
138 }
139
140 this->last_error_ = this->write_register(reg, &value, 1);
141 if (this->last_error_ != i2c::ERROR_OK) {
142 this->status_set_warning();
143 ESP_LOGE(TAG, "write_register_(): I2C I/O error: %d", (int) this->last_error_);
144 return false;
145 }
146
147 this->status_clear_warning();
148 return true;
149}
150
151void PCA6416AComponent::update_register_(uint8_t pin, bool pin_value, uint8_t reg_addr) {
152 uint8_t bit = pin % 8;
153 uint8_t reg_value = 0;
154 if (reg_addr == PCA6416A_OUTPUT0) {
155 reg_value = this->output_0_;
156 } else if (reg_addr == PCA6416A_OUTPUT1) {
157 reg_value = this->output_1_;
158 } else {
159 this->read_register_(reg_addr, &reg_value);
160 }
161
162 if (pin_value) {
163 reg_value |= 1 << bit;
164 } else {
165 reg_value &= ~(1 << bit);
166 }
167
168 this->write_register_(reg_addr, reg_value);
169
170 if (reg_addr == PCA6416A_OUTPUT0) {
171 this->output_0_ = reg_value;
172 } else if (reg_addr == PCA6416A_OUTPUT1) {
173 this->output_1_ = reg_value;
174 }
175}
176
178
181bool PCA6416AGPIOPin::digital_read() { return this->parent_->digital_read(this->pin_) != this->inverted_; }
182void PCA6416AGPIOPin::digital_write(bool value) { this->parent_->digital_write(this->pin_, value != this->inverted_); }
183std::string PCA6416AGPIOPin::dump_summary() const {
184 char buffer[32];
185 snprintf(buffer, sizeof(buffer), "%u via PCA6416A", pin_);
186 return buffer;
187}
188
189} // namespace pca6416a
190} // namespace esphome
virtual void mark_failed()
Mark this component as failed.
bool is_failed() const
void status_set_warning(const char *message=nullptr)
bool status_has_warning() const
bool status_has_error() const
void status_clear_warning()
bool digital_read(P pin)
Read the state of the given pin.
Definition cached_gpio.h:34
ErrorCode write_register(uint8_t a_register, const uint8_t *data, size_t len) const
writes an array of bytes to a specific register in the I²C device
Definition i2c.cpp:41
uint8_t address_
store the address of the device on the bus
Definition i2c.h:302
ErrorCode read_register(uint8_t a_register, uint8_t *data, size_t len)
reads an array of bytes from a specific register in the I²C device
Definition i2c.cpp:32
void digital_write_hw(uint8_t pin, bool value) override
Definition pca6416a.cpp:89
bool write_register_(uint8_t reg, uint8_t value)
Definition pca6416a.cpp:134
bool read_register_(uint8_t reg, uint8_t *value)
Definition pca6416a.cpp:117
esphome::i2c::ErrorCode last_error_
Storage for last I2C error seen.
Definition pca6416a.h:43
void update_register_(uint8_t pin, bool pin_value, uint8_t reg_addr)
Definition pca6416a.cpp:151
uint16_t input_mask_
Cache for input values (16-bit combined for both banks)
Definition pca6416a.h:41
bool has_pullup_
Only the PCAL6416A has pull-up resistors.
Definition pca6416a.h:45
void pin_mode(uint8_t pin, gpio::Flags flags)
Helper function to set the pin mode of a pin.
Definition pca6416a.cpp:94
void setup() override
Check i2c availability and setup masks.
Definition pca6416a.cpp:26
float get_setup_priority() const override
Definition pca6416a.cpp:177
bool digital_read_hw(uint8_t pin) override
Definition pca6416a.cpp:71
bool digital_read_cache(uint8_t pin) override
Definition pca6416a.cpp:87
uint8_t output_0_
The mask to write as output state - 1 means HIGH, 0 means LOW.
Definition pca6416a.h:38
void digital_write(bool value) override
Definition pca6416a.cpp:182
PCA6416AComponent * parent_
Definition pca6416a.h:65
std::string dump_summary() const override
Definition pca6416a.cpp:183
void pin_mode(gpio::Flags flags) override
Definition pca6416a.cpp:180
uint16_t flags
@ FLAG_OUTPUT
Definition gpio.h:19
@ FLAG_PULLUP
Definition gpio.h:21
@ FLAG_INPUT
Definition gpio.h:18
@ ERROR_OK
No error found during execution of method.
Definition i2c_bus.h:33
const float IO
For components that represent GPIO pins like PCF8573.
Definition component.cpp:47
Providing packet encoding functions for exchanging data with a remote host.
Definition a01nyub.cpp:7