From a18ab748fd4936b9472b2f59f8c760b49e05fb87 Mon Sep 17 00:00:00 2001 From: Cossid <83468485+Cossid@users.noreply.github.com> Date: Thu, 22 Dec 2022 15:39:44 -0600 Subject: [PATCH] Add support for BP1658CJ LED driver (#4020) --- CODEOWNERS | 1 + esphome/components/bp1658cj/__init__.py | 44 +++++++++ esphome/components/bp1658cj/bp1658cj.cpp | 110 +++++++++++++++++++++++ esphome/components/bp1658cj/bp1658cj.h | 64 +++++++++++++ esphome/components/bp1658cj/output.py | 27 ++++++ tests/test1.yaml | 21 +++++ 6 files changed, 267 insertions(+) create mode 100644 esphome/components/bp1658cj/__init__.py create mode 100644 esphome/components/bp1658cj/bp1658cj.cpp create mode 100644 esphome/components/bp1658cj/bp1658cj.h create mode 100644 esphome/components/bp1658cj/output.py diff --git a/CODEOWNERS b/CODEOWNERS index 87e1951044..6f17bdaf68 100644 --- a/CODEOWNERS +++ b/CODEOWNERS @@ -41,6 +41,7 @@ esphome/components/ble_client/* @buxtronix esphome/components/bluetooth_proxy/* @jesserockz esphome/components/bme680_bsec/* @trvrnrth esphome/components/bmp3xx/* @martgras +esphome/components/bp1658cj/* @Cossid esphome/components/bp5758d/* @Cossid esphome/components/button/* @esphome/core esphome/components/canbus/* @danielschramm @mvturnho diff --git a/esphome/components/bp1658cj/__init__.py b/esphome/components/bp1658cj/__init__.py new file mode 100644 index 0000000000..8388b16df9 --- /dev/null +++ b/esphome/components/bp1658cj/__init__.py @@ -0,0 +1,44 @@ +import esphome.codegen as cg +import esphome.config_validation as cv +from esphome import pins +from esphome.const import ( + CONF_CLOCK_PIN, + CONF_DATA_PIN, + CONF_ID, +) + +CODEOWNERS = ["@Cossid"] +MULTI_CONF = True + +CONF_MAX_POWER_COLOR_CHANNELS = "max_power_color_channels" +CONF_MAX_POWER_WHITE_CHANNELS = "max_power_white_channels" + +AUTO_LOAD = ["output"] +bp1658cj_ns = cg.esphome_ns.namespace("bp1658cj") +BP1658CJ = bp1658cj_ns.class_("BP1658CJ", cg.Component) + +CONFIG_SCHEMA = cv.Schema( + { + cv.GenerateID(): cv.declare_id(BP1658CJ), + cv.Required(CONF_DATA_PIN): pins.gpio_output_pin_schema, + cv.Required(CONF_CLOCK_PIN): pins.gpio_output_pin_schema, + cv.Optional(CONF_MAX_POWER_COLOR_CHANNELS, default=2): cv.int_range( + min=0, max=15 + ), + cv.Optional(CONF_MAX_POWER_WHITE_CHANNELS, default=4): cv.int_range( + min=0, max=15 + ), + } +).extend(cv.COMPONENT_SCHEMA) + + +async def to_code(config): + var = cg.new_Pvariable(config[CONF_ID]) + await cg.register_component(var, config) + + data = await cg.gpio_pin_expression(config[CONF_DATA_PIN]) + cg.add(var.set_data_pin(data)) + clock = await cg.gpio_pin_expression(config[CONF_CLOCK_PIN]) + cg.add(var.set_clock_pin(clock)) + cg.add(var.set_max_power_color_channels(config[CONF_MAX_POWER_COLOR_CHANNELS])) + cg.add(var.set_max_power_white_channels(config[CONF_MAX_POWER_WHITE_CHANNELS])) diff --git a/esphome/components/bp1658cj/bp1658cj.cpp b/esphome/components/bp1658cj/bp1658cj.cpp new file mode 100644 index 0000000000..5b9e4a5a2c --- /dev/null +++ b/esphome/components/bp1658cj/bp1658cj.cpp @@ -0,0 +1,110 @@ +#include "bp1658cj.h" +#include "esphome/core/log.h" + +namespace esphome { +namespace bp1658cj { + +static const char *const TAG = "bp1658cj"; + +static const uint8_t BP1658CJ_MODEL_ID = 0x80; +static const uint8_t BP1658CJ_ADDR_STANDBY = 0x0; +static const uint8_t BP1658CJ_ADDR_START_3CH = 0x10; +static const uint8_t BP1658CJ_ADDR_START_2CH = 0x20; +static const uint8_t BP1658CJ_ADDR_START_5CH = 0x30; + +void BP1658CJ::setup() { + ESP_LOGCONFIG(TAG, "Setting up BP1658CJ Output Component..."); + this->data_pin_->setup(); + this->data_pin_->digital_write(false); + this->clock_pin_->setup(); + this->clock_pin_->digital_write(false); + this->pwm_amounts_.resize(5, 0); +} +void BP1658CJ::dump_config() { + ESP_LOGCONFIG(TAG, "BP1658CJ:"); + LOG_PIN(" Data Pin: ", this->data_pin_); + LOG_PIN(" Clock Pin: ", this->clock_pin_); + ESP_LOGCONFIG(TAG, " Color Channels Max Power: %u", this->max_power_color_channels_); + ESP_LOGCONFIG(TAG, " White Channels Max Power: %u", this->max_power_white_channels_); +} + +void BP1658CJ::loop() { + if (!this->update_) + return; + + uint8_t data[12]; + if (this->pwm_amounts_[0] == 0 && this->pwm_amounts_[1] == 0 && this->pwm_amounts_[2] == 0 && + this->pwm_amounts_[3] == 0 && this->pwm_amounts_[4] == 0) { + // Off / Sleep + data[0] = BP1658CJ_MODEL_ID + BP1658CJ_ADDR_STANDBY; + for (int i = 1; i < 12; i++) + data[i] = 0; + this->write_buffer_(data, 12); + } else if (this->pwm_amounts_[0] == 0 && this->pwm_amounts_[1] == 0 && this->pwm_amounts_[2] == 0 && + (this->pwm_amounts_[3] > 0 || this->pwm_amounts_[4] > 0)) { + // Only data on white channels + data[0] = BP1658CJ_MODEL_ID + BP1658CJ_ADDR_START_2CH; + data[1] = 0 << 4 | this->max_power_white_channels_; + for (int i = 2, j = 0; i < 12; i += 2, j++) { + data[i] = this->pwm_amounts_[j] & 0x1F; + data[i + 1] = (this->pwm_amounts_[j] >> 5) & 0x1F; + } + this->write_buffer_(data, 12); + } else if ((this->pwm_amounts_[0] > 0 || this->pwm_amounts_[1] > 0 || this->pwm_amounts_[2] > 0) && + this->pwm_amounts_[3] == 0 && this->pwm_amounts_[4] == 0) { + // Only data on RGB channels + data[0] = BP1658CJ_MODEL_ID + BP1658CJ_ADDR_START_3CH; + data[1] = this->max_power_color_channels_ << 4 | 0; + for (int i = 2, j = 0; i < 12; i += 2, j++) { + data[i] = this->pwm_amounts_[j] & 0x1F; + data[i + 1] = (this->pwm_amounts_[j] >> 5) & 0x1F; + } + this->write_buffer_(data, 12); + } else { + // All channels + data[0] = BP1658CJ_MODEL_ID + BP1658CJ_ADDR_START_5CH; + data[1] = this->max_power_color_channels_ << 4 | this->max_power_white_channels_; + for (int i = 2, j = 0; i < 12; i += 2, j++) { + data[i] = this->pwm_amounts_[j] & 0x1F; + data[i + 1] = (this->pwm_amounts_[j] >> 5) & 0x1F; + } + this->write_buffer_(data, 12); + } + + this->update_ = false; +} + +void BP1658CJ::set_channel_value_(uint8_t channel, uint16_t value) { + if (this->pwm_amounts_[channel] != value) { + this->update_ = true; + this->update_channel_ = channel; + } + this->pwm_amounts_[channel] = value; +} +void BP1658CJ::write_bit_(bool value) { + this->clock_pin_->digital_write(false); + this->data_pin_->digital_write(value); + this->clock_pin_->digital_write(true); +} + +void BP1658CJ::write_byte_(uint8_t data) { + for (uint8_t mask = 0x80; mask; mask >>= 1) { + this->write_bit_(data & mask); + } + this->clock_pin_->digital_write(false); + this->data_pin_->digital_write(true); + this->clock_pin_->digital_write(true); +} + +void BP1658CJ::write_buffer_(uint8_t *buffer, uint8_t size) { + this->data_pin_->digital_write(false); + for (uint32_t i = 0; i < size; i++) { + this->write_byte_(buffer[i]); + } + this->clock_pin_->digital_write(false); + this->clock_pin_->digital_write(true); + this->data_pin_->digital_write(true); +} + +} // namespace bp1658cj +} // namespace esphome diff --git a/esphome/components/bp1658cj/bp1658cj.h b/esphome/components/bp1658cj/bp1658cj.h new file mode 100644 index 0000000000..778f49b3e9 --- /dev/null +++ b/esphome/components/bp1658cj/bp1658cj.h @@ -0,0 +1,64 @@ +#pragma once + +#include "esphome/core/component.h" +#include "esphome/core/hal.h" +#include "esphome/components/output/float_output.h" +#include + +namespace esphome { +namespace bp1658cj { + +class BP1658CJ : public Component { + public: + class Channel; + + void set_data_pin(GPIOPin *data_pin) { data_pin_ = data_pin; } + void set_clock_pin(GPIOPin *clock_pin) { clock_pin_ = clock_pin; } + void set_max_power_color_channels(uint8_t max_power_color_channels) { + max_power_color_channels_ = max_power_color_channels; + } + void set_max_power_white_channels(uint8_t max_power_white_channels) { + max_power_white_channels_ = max_power_white_channels; + } + + void setup() override; + + void dump_config() override; + + float get_setup_priority() const override { return setup_priority::HARDWARE; } + + /// Send new values if they were updated. + void loop() override; + + class Channel : public output::FloatOutput { + public: + void set_parent(BP1658CJ *parent) { parent_ = parent; } + void set_channel(uint8_t channel) { channel_ = channel; } + + protected: + void write_state(float state) override { + auto amount = static_cast(state * 0x3FF); + this->parent_->set_channel_value_(this->channel_, amount); + } + + BP1658CJ *parent_; + uint8_t channel_; + }; + + protected: + void set_channel_value_(uint8_t channel, uint16_t value); + void write_bit_(bool value); + void write_byte_(uint8_t data); + void write_buffer_(uint8_t *buffer, uint8_t size); + + GPIOPin *data_pin_; + GPIOPin *clock_pin_; + uint8_t max_power_color_channels_{4}; + uint8_t max_power_white_channels_{6}; + uint8_t update_channel_; + std::vector pwm_amounts_; + bool update_{true}; +}; + +} // namespace bp1658cj +} // namespace esphome diff --git a/esphome/components/bp1658cj/output.py b/esphome/components/bp1658cj/output.py new file mode 100644 index 0000000000..3b89518621 --- /dev/null +++ b/esphome/components/bp1658cj/output.py @@ -0,0 +1,27 @@ +import esphome.codegen as cg +import esphome.config_validation as cv +from esphome.components import output +from esphome.const import CONF_CHANNEL, CONF_ID +from . import BP1658CJ + +DEPENDENCIES = ["bp1658cj"] + +Channel = BP1658CJ.class_("Channel", output.FloatOutput) + +CONF_BP1658CJ_ID = "bp1658cj_id" +CONFIG_SCHEMA = output.FLOAT_OUTPUT_SCHEMA.extend( + { + cv.GenerateID(CONF_BP1658CJ_ID): cv.use_id(BP1658CJ), + cv.Required(CONF_ID): cv.declare_id(Channel), + cv.Required(CONF_CHANNEL): cv.int_range(min=0, max=65535), + } +).extend(cv.COMPONENT_SCHEMA) + + +async def to_code(config): + var = cg.new_Pvariable(config[CONF_ID]) + await output.register_output(var, config) + + parent = await cg.get_variable(config[CONF_BP1658CJ_ID]) + cg.add(var.set_parent(parent)) + cg.add(var.set_channel(config[CONF_CHANNEL])) diff --git a/tests/test1.yaml b/tests/test1.yaml index 7453946594..51b34d9785 100644 --- a/tests/test1.yaml +++ b/tests/test1.yaml @@ -1465,6 +1465,12 @@ my9231: num_chips: 2 bit_depth: 16 +bp1658cj: + data_pin: GPIO3 + clock_pin: GPIO5 + max_power_color_channels: 4 + max_power_white_channels: 6 + bp5758d: data_pin: GPIO3 clock_pin: GPIO5 @@ -1630,6 +1636,21 @@ output: vref: internal gain: X2 power_down: gnd_500k + - platform: bp1658cj + id: bp1658cj_red + channel: 1 + - platform: bp1658cj + id: bp1658cj_green + channel: 2 + - platform: bp1658cj + id: bp1658cj_blue + channel: 0 + - platform: bp1658cj + id: bp1658cj_coldwhite + channel: 3 + - platform: bp1658cj + id: bp1658cj_warmwhite + channel: 4 - platform: bp5758d id: bp5758d_red channel: 2