From c0a4e07e5a35e561dce4623b56ac2e6722d42a0d Mon Sep 17 00:00:00 2001 From: Steve Rodgers Date: Wed, 21 Dec 2022 21:39:25 -0800 Subject: [PATCH] Add Pca9554 component (#4192) --- CODEOWNERS | 1 + esphome/components/pca9554/__init__.py | 76 +++++++++++++++++ esphome/components/pca9554/pca9554.cpp | 112 +++++++++++++++++++++++++ esphome/components/pca9554/pca9554.h | 64 ++++++++++++++ tests/test1.yaml | 19 +++++ 5 files changed, 272 insertions(+) create mode 100644 esphome/components/pca9554/__init__.py create mode 100644 esphome/components/pca9554/pca9554.cpp create mode 100644 esphome/components/pca9554/pca9554.h diff --git a/CODEOWNERS b/CODEOWNERS index d30060fe3b..3fa7fd169a 100644 --- a/CODEOWNERS +++ b/CODEOWNERS @@ -164,6 +164,7 @@ esphome/components/nfc/* @jesserockz esphome/components/number/* @esphome/core esphome/components/ota/* @esphome/core esphome/components/output/* @esphome/core +esphome/components/pca9554/* @hwstar esphome/components/pid/* @OttoWinter esphome/components/pipsolar/* @andreashergert1984 esphome/components/pm1006/* @habbie diff --git a/esphome/components/pca9554/__init__.py b/esphome/components/pca9554/__init__.py new file mode 100644 index 0000000000..76d6ddaf32 --- /dev/null +++ b/esphome/components/pca9554/__init__.py @@ -0,0 +1,76 @@ +import esphome.codegen as cg +import esphome.config_validation as cv +from esphome import pins +from esphome.components import i2c +from esphome.const import ( + CONF_ID, + CONF_INPUT, + CONF_NUMBER, + CONF_MODE, + CONF_INVERTED, + CONF_OUTPUT, +) + +CODEOWNERS = ["@hwstar"] +DEPENDENCIES = ["i2c"] +MULTI_CONF = True +pca9554_ns = cg.esphome_ns.namespace("pca9554") + +PCA9554Component = pca9554_ns.class_("PCA9554Component", cg.Component, i2c.I2CDevice) +PCA9554GPIOPin = pca9554_ns.class_( + "PCA9554GPIOPin", cg.GPIOPin, cg.Parented.template(PCA9554Component) +) + +CONF_PCA9554 = "pca9554" +CONFIG_SCHEMA = ( + cv.Schema({cv.Required(CONF_ID): cv.declare_id(PCA9554Component)}) + .extend(cv.COMPONENT_SCHEMA) + .extend( + i2c.i2c_device_schema(0x20) + ) # Note: 0x20 for the non-A part. The PCA9554A parts start at addess 0x38 +) + + +async def to_code(config): + var = cg.new_Pvariable(config[CONF_ID]) + await cg.register_component(var, config) + await i2c.register_i2c_device(var, config) + + +def validate_mode(value): + if not (value[CONF_INPUT] or value[CONF_OUTPUT]): + raise cv.Invalid("Mode must be either input or output") + if value[CONF_INPUT] and value[CONF_OUTPUT]: + raise cv.Invalid("Mode must be either input or output") + return value + + +PCA9554_PIN_SCHEMA = cv.All( + { + cv.GenerateID(): cv.declare_id(PCA9554GPIOPin), + cv.Required(CONF_PCA9554): cv.use_id(PCA9554Component), + cv.Required(CONF_NUMBER): cv.int_range(min=0, max=8), + cv.Optional(CONF_MODE, default={}): cv.All( + { + cv.Optional(CONF_INPUT, default=False): cv.boolean, + cv.Optional(CONF_OUTPUT, default=False): cv.boolean, + }, + validate_mode, + ), + cv.Optional(CONF_INVERTED, default=False): cv.boolean, + } +) + + +@pins.PIN_SCHEMA_REGISTRY.register("pca9554", PCA9554_PIN_SCHEMA) +async def pca9554_pin_to_code(config): + var = cg.new_Pvariable(config[CONF_ID]) + parent = await cg.get_variable(config[CONF_PCA9554]) + + cg.add(var.set_parent(parent)) + + num = config[CONF_NUMBER] + cg.add(var.set_pin(num)) + cg.add(var.set_inverted(config[CONF_INVERTED])) + cg.add(var.set_flags(pins.gpio_flags_expr(config[CONF_MODE]))) + return var diff --git a/esphome/components/pca9554/pca9554.cpp b/esphome/components/pca9554/pca9554.cpp new file mode 100644 index 0000000000..39093fcf54 --- /dev/null +++ b/esphome/components/pca9554/pca9554.cpp @@ -0,0 +1,112 @@ +#include "pca9554.h" +#include "esphome/core/log.h" + +namespace esphome { +namespace pca9554 { + +const uint8_t INPUT_REG = 0; +const uint8_t OUTPUT_REG = 1; +const uint8_t INVERT_REG = 2; +const uint8_t CONFIG_REG = 3; + +static const char *const TAG = "pca9554"; + +void PCA9554Component::setup() { + ESP_LOGCONFIG(TAG, "Setting up PCA9554/PCA9554A..."); + // Test to see if device exists + if (!this->read_inputs_()) { + ESP_LOGE(TAG, "PCA9554 not available under 0x%02X", this->address_); + this->mark_failed(); + return; + } + + // No polarity inversion + this->write_register_(INVERT_REG, 0); + // All inputs at initialization + this->config_mask_ = 0; + // Invert mask as the part sees a 1 as an input + this->write_register_(CONFIG_REG, ~this->config_mask_); + // All ouputs low + this->output_mask_ = 0; + this->write_register_(OUTPUT_REG, this->output_mask_); + // Read the inputs + this->read_inputs_(); + ESP_LOGD(TAG, "Initialization complete. Warning: %d, Error: %d", this->status_has_warning(), + this->status_has_error()); +} +void PCA9554Component::dump_config() { + ESP_LOGCONFIG(TAG, "PCA9554:"); + LOG_I2C_DEVICE(this) + if (this->is_failed()) { + ESP_LOGE(TAG, "Communication with PCA9554 failed!"); + } +} + +bool PCA9554Component::digital_read(uint8_t pin) { + this->read_inputs_(); + return this->input_mask_ & (1 << pin); +} + +void PCA9554Component::digital_write(uint8_t pin, bool value) { + if (value) { + this->output_mask_ |= (1 << pin); + } else { + this->output_mask_ &= ~(1 << pin); + } + this->write_register_(OUTPUT_REG, this->output_mask_); +} + +void PCA9554Component::pin_mode(uint8_t pin, gpio::Flags flags) { + if (flags == gpio::FLAG_INPUT) { + // Clear mode mask bit + this->config_mask_ &= ~(1 << pin); + } else if (flags == gpio::FLAG_OUTPUT) { + // Set mode mask bit + this->config_mask_ |= 1 << pin; + } + this->write_register_(CONFIG_REG, ~this->config_mask_); +} + +bool PCA9554Component::read_inputs_() { + uint8_t inputs; + + if (this->is_failed()) { + ESP_LOGD(TAG, "Device marked failed"); + return false; + } + + if ((this->last_error_ = this->read_register(INPUT_REG, &inputs, 1, true)) != esphome::i2c::ERROR_OK) { + this->status_set_warning(); + ESP_LOGE(TAG, "read_register_(): I2C I/O error: %d", (int) this->last_error_); + return false; + } + this->status_clear_warning(); + this->input_mask_ = inputs; + return true; +} + +bool PCA9554Component::write_register_(uint8_t reg, uint8_t value) { + if ((this->last_error_ = this->write_register(reg, &value, 1, true)) != esphome::i2c::ERROR_OK) { + this->status_set_warning(); + ESP_LOGE(TAG, "write_register_(): I2C I/O error: %d", (int) this->last_error_); + return false; + } + + this->status_clear_warning(); + return true; +} + +float PCA9554Component::get_setup_priority() const { return setup_priority::IO; } + +void PCA9554GPIOPin::setup() { pin_mode(flags_); } +void PCA9554GPIOPin::pin_mode(gpio::Flags flags) { this->parent_->pin_mode(this->pin_, flags); } +bool PCA9554GPIOPin::digital_read() { return this->parent_->digital_read(this->pin_) != this->inverted_; } +void PCA9554GPIOPin::digital_write(bool value) { this->parent_->digital_write(this->pin_, value != this->inverted_); } +std::string PCA9554GPIOPin::dump_summary() const { + char buffer[32]; + snprintf(buffer, sizeof(buffer), "%u via PCA9554", pin_); + return buffer; +} + +} // namespace pca9554 +} // namespace esphome diff --git a/esphome/components/pca9554/pca9554.h b/esphome/components/pca9554/pca9554.h new file mode 100644 index 0000000000..d1bfc36bec --- /dev/null +++ b/esphome/components/pca9554/pca9554.h @@ -0,0 +1,64 @@ +#pragma once + +#include "esphome/core/component.h" +#include "esphome/core/hal.h" +#include "esphome/components/i2c/i2c.h" + +namespace esphome { +namespace pca9554 { + +class PCA9554Component : public Component, public i2c::I2CDevice { + public: + PCA9554Component() = default; + + /// Check i2c availability and setup masks + void setup() override; + /// Helper function to read the value of a pin. + bool digital_read(uint8_t pin); + /// Helper function to write the value of a pin. + void digital_write(uint8_t pin, bool value); + /// Helper function to set the pin mode of a pin. + void pin_mode(uint8_t pin, gpio::Flags flags); + + float get_setup_priority() const override; + + void dump_config() override; + + protected: + bool read_inputs_(); + + bool write_register_(uint8_t reg, uint8_t value); + + /// Mask for the pin config - 1 means OUTPUT, 0 means INPUT + uint8_t config_mask_{0x00}; + /// The mask to write as output state - 1 means HIGH, 0 means LOW + uint8_t output_mask_{0x00}; + /// The state of the actual input pin states - 1 means HIGH, 0 means LOW + uint8_t input_mask_{0x00}; + /// Storage for last I2C error seen + esphome::i2c::ErrorCode last_error_; +}; + +/// Helper class to expose a PCA9554 pin as an internal input GPIO pin. +class PCA9554GPIOPin : public GPIOPin { + public: + void setup() override; + void pin_mode(gpio::Flags flags) override; + bool digital_read() override; + void digital_write(bool value) override; + std::string dump_summary() const override; + + void set_parent(PCA9554Component *parent) { parent_ = parent; } + void set_pin(uint8_t pin) { pin_ = pin; } + void set_inverted(bool inverted) { inverted_ = inverted; } + void set_flags(gpio::Flags flags) { flags_ = flags; } + + protected: + PCA9554Component *parent_; + uint8_t pin_; + bool inverted_; + gpio::Flags flags_; +}; + +} // namespace pca9554 +} // namespace esphome diff --git a/tests/test1.yaml b/tests/test1.yaml index 88cdb43fca..b8951c9817 100644 --- a/tests/test1.yaml +++ b/tests/test1.yaml @@ -1341,6 +1341,13 @@ binary_sensor: number: 1 mode: INPUT inverted: true + - platform: gpio + name: PCA9554 binary sensor + pin: + pca9554: pca9554_hub + number: 1 + mode: INPUT + inverted: true - platform: gpio name: MCP21 binary sensor pin: @@ -1537,6 +1544,13 @@ output: number: 0 mode: OUTPUT inverted: false + - platform: gpio + id: id26 + pin: + pca9554: pca9554_hub + number: 0 + mode: OUTPUT + inverted: false - platform: gpio id: id22 pin: @@ -2716,6 +2730,11 @@ pcf8574: pcf8575: false i2c_id: i2c_bus +pca9554: + - id: pca9554_hub + address: 0x3F + i2c_id: i2c_bus + mcp23017: - id: mcp23017_hub open_drain_interrupt: true