Add support for Grove tb6612 fng

CODEOWNERS

@@ -100,6 +100,7 @@ esphome/components/gp8403/* @jesserockz
 esphome/components/gpio/* @esphome/core
 esphome/components/gps/* @coogle
 esphome/components/graph/* @synco
+esphome/components/grove_i2c_motor/* @max246
 esphome/components/growatt_solar/* @leeuwte
 esphome/components/haier/* @Yarikx
 esphome/components/havells_solar/* @sourabhjaiswal

esphome/components/grove_i2c_motor/__init__.py

@@ -0,0 +1,151 @@
+import esphome.codegen as cg
+import esphome.config_validation as cv
+from esphome import automation
+
+from esphome.const import (
+    CONF_ID,
+    CONF_CHANNEL,
+    CONF_SPEED,
+    CONF_DIRECTION,
+    CONF_ADDRESS,
+)
+
+DEPENDENCIES = ["i2c"]
+
+CODEOWNERS = ["@max246"]
+
+grove_i2c_motor_ns = cg.esphome_ns.namespace("grove_i2c_motor")
+GROVE_TB6612FNG = grove_i2c_motor_ns.class_("GroveMotorDriveTB6612FNG", cg.Component)
+GROVETB6612FNGMotorRunAction = grove_i2c_motor_ns.class_(
+    "GROVETB6612FNGMotorRunAction", automation.Action
+)
+GROVETB6612FNGMotorBrakeAction = grove_i2c_motor_ns.class_(
+    "GROVETB6612FNGMotorBrakeAction", automation.Action
+)
+GROVETB6612FNGMotorStopAction = grove_i2c_motor_ns.class_(
+    "GROVETB6612FNGMotorStopAction", automation.Action
+)
+GROVETB6612FNGMotorStandbyAction = grove_i2c_motor_ns.class_(
+    "GROVETB6612FNGMotorStandbyAction", automation.Action
+)
+GROVETB6612FNGMotorNoStandbyAction = grove_i2c_motor_ns.class_(
+    "GROVETB6612FNGMotorNoStandbyAction", automation.Action
+)
+
+DIRECTION_TYPE = {
+    "FORWARD": 1,
+    "BACKWARD": 2,
+}
+
+CONFIG_SCHEMA = cv.Schema(
+    {
+        cv.Required(CONF_ID): cv.declare_id(GROVE_TB6612FNG),
+        cv.Optional(CONF_ADDRESS, default=0x14): cv.i2c_address,
+    }
+).extend(cv.COMPONENT_SCHEMA)
+
+
+async def to_code(config):
+    var = cg.new_Pvariable(config[CONF_ID])
+    await cg.register_component(var, config)
+
+    cg.add(var.set_address(config[CONF_ADDRESS]))
+
+    return var
+
+
+@automation.register_action(
+    "grove_i2c_motor.motor_run",
+    GROVETB6612FNGMotorRunAction,
+    cv.Schema(
+        {
+            cv.Required(CONF_ID): cv.use_id(GROVE_TB6612FNG),
+            cv.Required(CONF_CHANNEL): cv.int_range(min=0, max=1),
+            cv.Required(CONF_SPEED): cv.int_range(min=0, max=255),
+            cv.Required(CONF_DIRECTION): cv.enum(DIRECTION_TYPE, upper=True),
+        }
+    ),
+)
+async def grove_i2c_motor_run_to_code(config, action_id, template_arg, args):
+    paren = await cg.get_variable(config[CONF_ID])
+    var = cg.new_Pvariable(action_id, template_arg, paren)
+
+    template_channel = await cg.templatable(config[CONF_CHANNEL], args, int)
+    template_speed = await cg.templatable(config[CONF_SPEED], args, cg.uint16)
+    template_speed = (
+        template_speed if config[CONF_DIRECTION] == "FORWARD" else -template_speed
+    )
+    cg.add(var.set_chl(template_channel))
+    cg.add(var.set_speed(template_speed))
+    return var
+
+
+@automation.register_action(
+    "grove_i2c_motor.motor_break",
+    GROVETB6612FNGMotorBrakeAction,
+    cv.Schema(
+        {
+            cv.Required(CONF_ID): cv.use_id(GROVE_TB6612FNG),
+            cv.Required(CONF_CHANNEL): cv.int_range(min=0, max=1),
+        }
+    ),
+)
+async def grove_i2c_motor_break_to_code(config, action_id, template_arg, args):
+    paren = await cg.get_variable(config[CONF_ID])
+    var = cg.new_Pvariable(action_id, template_arg, paren)
+
+    template_channel = await cg.templatable(config[CONF_CHANNEL], args, int)
+    cg.add(var.set_chl(template_channel))
+    return var
+
+
+@automation.register_action(
+    "grove_i2c_motor.motor_stop",
+    GROVETB6612FNGMotorStopAction,
+    cv.Schema(
+        {
+            cv.Required(CONF_ID): cv.use_id(GROVE_TB6612FNG),
+            cv.Required(CONF_CHANNEL): cv.int_range(min=0, max=1),
+        }
+    ),
+)
+async def grove_i2c_motor_stop_to_code(config, action_id, template_arg, args):
+    paren = await cg.get_variable(config[CONF_ID])
+    var = cg.new_Pvariable(action_id, template_arg, paren)
+
+    template_channel = await cg.templatable(config[CONF_CHANNEL], args, int)
+    cg.add(var.set_chl(template_channel))
+    return var
+
+
+@automation.register_action(
+    "grove_i2c_motor.standby",
+    GROVETB6612FNGMotorStandbyAction,
+    cv.Schema(
+        {
+            cv.Required(CONF_ID): cv.use_id(GROVE_TB6612FNG),
+        }
+    ),
+)
+async def grove_i2c_motor_standby_to_code(config, action_id, template_arg, args):
+    paren = await cg.get_variable(config[CONF_ID])
+    var = cg.new_Pvariable(action_id, template_arg, paren)
+
+    return var
+
+
+@automation.register_action(
+    "grove_i2c_motor.no_standby",
+    GROVETB6612FNGMotorNoStandbyAction,
+    cv.Schema(
+        {
+            cv.Required(CONF_ID): cv.use_id(GROVE_TB6612FNG),
+        }
+    ),
+)
+async def grove_i2c_motor_no_standby_to_code(config, action_id, template_arg, args):
+    paren = await cg.get_variable(config[CONF_ID])
+    var = cg.new_Pvariable(action_id, template_arg, paren)
+
+    cg.add_library("https://github.com/Seeed-Studio/Grove_Motor_Driver_TB6612FNG", None)
+    return var

esphome/components/grove_i2c_motor/grove_i2c_motor.cpp

@@ -0,0 +1,85 @@
+#include "grove_i2c_motor.h"
+#include "esphome/core/log.h"
+#include "esphome/core/hal.h"
+
+namespace esphome {
+namespace grove_i2c_motor {
+
+static const char *const TAG = "GroveMotorDriveTB6612FNG";
+
+void GroveMotorDriveTB6612FNG::dump_config() {
+  ESP_LOGCONFIG(TAG, "GroveMotorDriveTB6612FNG:");
+  ESP_LOGCONFIG(TAG, "  Address: 0x%02X", this->address);
+}
+
+void GroveMotorDriveTB6612FNG::setup() {
+  ESP_LOGCONFIG(TAG, "Setting up Grove Motor Drive TB6612FNG ...");
+
+  motor->init(this->address);
+}
+
+void GroveMotorDriveTB6612FNG::standby() { motor->standby(); }
+
+void GroveMotorDriveTB6612FNG::not_standby() { motor->notStandby(); }
+
+void GroveMotorDriveTB6612FNG::set_i2c_addr(uint8_t addr) { motor->setI2cAddr(addr); }
+
+void GroveMotorDriveTB6612FNG::dc_motor_run(uint8_t chl, int16_t speed) {
+  motor_channel_type_t channel;
+  if (chl == 0)
+    channel = MOTOR_CHA;
+  else
+    channel = MOTOR_CHB;
+  motor->dcMotorRun(channel, speed);
+}
+
+void GroveMotorDriveTB6612FNG::dc_motor_brake(uint8_t chl) {
+  motor_channel_type_t channel;
+  if (chl == 0)
+    channel = MOTOR_CHA;
+  else
+    channel = MOTOR_CHB;
+  motor->dcMotorBrake(channel);
+}
+
+void GroveMotorDriveTB6612FNG::dc_motor_stop(uint8_t chl) {
+  motor_channel_type_t channel;
+  if (chl == 0)
+    channel = MOTOR_CHA;
+  else
+    channel = MOTOR_CHB;
+  motor->dcMotorStop(channel);
+}
+
+void GroveMotorDriveTB6612FNG::stepper_run(int mode, int16_t steps, uint16_t rpm) {
+  stepper_mode_type_t mode_type;
+
+  if (mode == 0)
+    mode_type = FULL_STEP;
+  else if (mode == 1)
+    mode_type = WAVE_DRIVE;
+  else if (mode == 2)
+    mode_type = HALF_STEP;
+  else
+    mode_type = MICRO_STEPPING;
+  motor->stepperRun(mode_type, steps, rpm);
+}
+
+void GroveMotorDriveTB6612FNG::stepper_stop() { motor->stepperStop(); }
+
+void GroveMotorDriveTB6612FNG::stepper_keep_run(int mode, uint16_t rpm, bool is_cw) {
+  stepper_mode_type_t mode_type;
+
+  if (mode == 0)
+    mode_type = FULL_STEP;
+  else if (mode == 1)
+    mode_type = WAVE_DRIVE;
+  else if (mode == 2)
+    mode_type = HALF_STEP;
+  else
+    mode_type = MICRO_STEPPING;
+  motor->stepperKeepRun(mode_type, rpm, is_cw);
+}
+
+}  // namespace grove_i2c_motor
+}  // namespace esphome

esphome/components/grove_i2c_motor/grove_i2c_motor.h

@@ -0,0 +1,99 @@
+#pragma once
+
+#include "esphome/core/component.h"
+#include "esphome/core/hal.h"
+#include "esphome/core/automation.h"
+
+#include "Grove_Motor_Driver_TB6612FNG.h"
+
+namespace esphome {
+namespace grove_i2c_motor {
+
+class GroveMotorDriveTB6612FNG : public Component {
+ public:
+  void setup() override;
+  void dump_config() override;
+
+  void standby();
+
+  void not_standby();
+
+  void set_i2c_addr(uint8_t addr);
+
+  void dc_motor_run(uint8_t chl, int16_t speed);
+
+  void dc_motor_brake(uint8_t chl);
+
+  void dc_motor_stop(uint8_t chl);
+
+  void stepper_run(int mode, int16_t steps, uint16_t rpm);
+
+  void stepper_stop();
+
+  void stepper_keep_run(int mode, uint16_t rpm, bool is_cw);
+  void set_address(uint8_t addr) { this->address = addr; }
+
+  MotorDriver *motor{nullptr};
+  uint8_t address;
+};
+
+template<typename... Ts> class GROVETB6612FNGMotorRunAction : public Action<Ts...> {
+ public:
+  GROVETB6612FNGMotorRunAction(GroveMotorDriveTB6612FNG *motor) : motor_(motor) {}
+  TEMPLATABLE_VALUE(uint8_t, chl)
+  TEMPLATABLE_VALUE(uint16_t, speed)
+
+  void play(Ts... x) override {
+    auto chl = this->chl_.value(x...);
+    auto speed = this->speed_.value(x...);
+    this->motor_->dc_motor_run(chl, speed);
+  }
+
+ protected:
+  GroveMotorDriveTB6612FNG *motor_;
+};
+
+template<typename... Ts> class GROVETB6612FNGMotorBrakeAction : public Action<Ts...> {
+ public:
+  GROVETB6612FNGMotorBrakeAction(GroveMotorDriveTB6612FNG *motor) : motor_(motor) {}
+  TEMPLATABLE_VALUE(uint8_t, chl)
+
+  void play(Ts... x) override { this->motor_->dc_motor_brake(this->chl_.value(x...)); }
+
+ protected:
+  GroveMotorDriveTB6612FNG *motor_;
+};
+
+template<typename... Ts> class GROVETB6612FNGMotorStopAction : public Action<Ts...> {
+ public:
+  GROVETB6612FNGMotorStopAction(GroveMotorDriveTB6612FNG *motor) : motor_(motor) {}
+  TEMPLATABLE_VALUE(uint8_t, chl)
+
+  void play(Ts... x) override { this->motor_->dc_motor_stop(this->chl_.value(x...)); }
+
+ protected:
+  GroveMotorDriveTB6612FNG *motor_;
+};
+
+template<typename... Ts> class GROVETB6612FNGMotorStandbyAction : public Action<Ts...> {
+ public:
+  GROVETB6612FNGMotorStandbyAction(GroveMotorDriveTB6612FNG *motor) : motor_(motor) {}
+
+  void play(Ts... x) override { this->motor_->standby(); }
+
+ protected:
+  GroveMotorDriveTB6612FNG *motor_;
+};
+
+template<typename... Ts> class GROVETB6612FNGMotorNoStandbyAction : public Action<Ts...> {
+ public:
+  GROVETB6612FNGMotorNoStandbyAction(GroveMotorDriveTB6612FNG *motor) : motor_(motor) {}
+
+  void play(Ts... x) override { this->motor_->not_standby(); }
+
+ protected:
+  GroveMotorDriveTB6612FNG *motor_;
+};
+
+}  // namespace grove_i2c_motor
+}  // namespace esphome

platformio.ini

@@ -54,17 +54,18 @@
 extends = common
 lib_deps =
     ${common.lib_deps}
-    SPI                                                   ; spi (Arduino built-in)
-    Wire                                                  ; i2c (Arduino built-int)
-    ottowinter/AsyncMqttClient-esphome@0.8.6              ; mqtt
-    esphome/ESPAsyncWebServer-esphome@2.1.0               ; web_server_base
-    fastled/FastLED@3.3.2                                 ; fastled_base
-    mikalhart/TinyGPSPlus@1.0.2                           ; gps
-    freekode/TM1651@1.0.1                                 ; tm1651
-    glmnet/Dsmr@0.5                                       ; dsmr
-    rweather/Crypto@0.4.0                                 ; dsmr
-    dudanov/MideaUART@1.1.8                               ; midea
-    tonia/HeatpumpIR@1.0.20                               ; heatpumpir
+    SPI                                                           ; spi (Arduino built-in)
+    Wire                                                          ; i2c (Arduino built-int)
+    ottowinter/AsyncMqttClient-esphome@0.8.6                      ; mqtt
+    esphome/ESPAsyncWebServer-esphome@2.1.0                       ; web_server_base
+    fastled/FastLED@3.3.2                                         ; fastled_base
+    mikalhart/TinyGPSPlus@1.0.2                                   ; gps
+    freekode/TM1651@1.0.1                                         ; tm1651
+    glmnet/Dsmr@0.5                                               ; dsmr
+    rweather/Crypto@0.4.0                                         ; dsmr
+    dudanov/MideaUART@1.1.8                                       ; midea
+    tonia/HeatpumpIR@1.0.20                                       ; heatpumpir
+    https://github.com/Seeed-Studio/Grove_Motor_Driver_TB6612FNG  ; TB6612FNG 
 build_flags =
     ${common.build_flags}
     -DUSE_ARDUINO

tests/test3.1.yaml

@@ -600,3 +600,8 @@ cd74hc4067:
 
 adc128s102:
   cs_pin: GPIO12
+
+grove_i2c_motor:
+  id: test_motor
+  name: motor_outside
+  address: 0x14

tests/test3.yaml

@@ -1171,3 +1171,5 @@ daly_bms:
 qr_code:
   - id: homepage_qr
     value: https://esphome.io/index.html
+
+