ESPHome  2024.2.0
Public Member Functions
esphome::grove_tb6612fng::GroveMotorDriveTB6612FNG Class Reference

#include <grove_tb6612fng.h>

Inheritance diagram for esphome::grove_tb6612fng::GroveMotorDriveTB6612FNG:
esphome::Component esphome::i2c::I2CDevice

Public Member Functions

void setup () override
 
void dump_config () override
 
bool standby ()
 
bool not_standby ()
 
void set_i2c_addr (uint8_t addr)
 
void dc_motor_run (uint8_t channel, int16_t speed)
 
void dc_motor_brake (uint8_t channel)
 
void dc_motor_stop (uint8_t channel)
 
void stepper_run (StepperModeTypeT mode, int16_t steps, uint16_t rpm)
 
void stepper_stop ()
 
void stepper_keep_run (StepperModeTypeT mode, uint16_t rpm, bool is_cw)
 
- Public Member Functions inherited from esphome::Component
virtual void loop ()
 This method will be called repeatedly. More...
 
virtual float get_setup_priority () const
 priority of setup(). More...
 
float get_actual_setup_priority () const
 
void set_setup_priority (float priority)
 
virtual float get_loop_priority () const
 priority of loop(). More...
 
void call ()
 
virtual void on_shutdown ()
 
virtual void on_safe_shutdown ()
 
uint32_t get_component_state () const
 
virtual void mark_failed ()
 Mark this component as failed. More...
 
bool is_failed ()
 
bool is_ready ()
 
virtual bool can_proceed ()
 
bool status_has_warning ()
 
bool status_has_error ()
 
void status_set_warning ()
 
void status_set_error ()
 
void status_clear_warning ()
 
void status_clear_error ()
 
void status_momentary_warning (const std::string &name, uint32_t length=5000)
 
void status_momentary_error (const std::string &name, uint32_t length=5000)
 
bool has_overridden_loop () const
 
void set_component_source (const char *source)
 Set where this component was loaded from for some debug messages. More...
 
const char * get_component_source () const
 Get the integration where this component was declared as a string. More...
 
- Public Member Functions inherited from esphome::i2c::I2CDevice
 I2CDevice ()=default
 we use the C++ default constructor More...
 
void set_i2c_address (uint8_t address)
 We store the address of the device on the bus. More...
 
void set_i2c_bus (I2CBus *bus)
 we store the pointer to the I2CBus to use More...
 
I2CRegister reg (uint8_t a_register)
 calls the I2CRegister constructor More...
 
I2CRegister16 reg16 (uint16_t a_register)
 calls the I2CRegister16 constructor More...
 
ErrorCode read (uint8_t *data, size_t len)
 reads an array of bytes from the device using an I2CBus More...
 
ErrorCode read_register (uint8_t a_register, uint8_t *data, size_t len, bool stop=true)
 reads an array of bytes from a specific register in the I²C device More...
 
ErrorCode read_register16 (uint16_t a_register, uint8_t *data, size_t len, bool stop=true)
 reads an array of bytes from a specific register in the I²C device More...
 
ErrorCode write (const uint8_t *data, size_t len, bool stop=true)
 writes an array of bytes to a device using an I2CBus More...
 
ErrorCode write_register (uint8_t a_register, const uint8_t *data, size_t len, bool stop=true)
 writes an array of bytes to a specific register in the I²C device More...
 
ErrorCode write_register16 (uint16_t a_register, const uint8_t *data, size_t len, bool stop=true)
 write an array of bytes to a specific register in the I²C device More...
 
bool read_bytes (uint8_t a_register, uint8_t *data, uint8_t len)
 Compat APIs All methods below have been added for compatibility reasons. More...
 
bool read_bytes_raw (uint8_t *data, uint8_t len)
 
template<size_t N>
optional< std::array< uint8_t, N > > read_bytes (uint8_t a_register)
 
template<size_t N>
optional< std::array< uint8_t, N > > read_bytes_raw ()
 
bool read_bytes_16 (uint8_t a_register, uint16_t *data, uint8_t len)
 
bool read_byte (uint8_t a_register, uint8_t *data, bool stop=true)
 
optional< uint8_t > read_byte (uint8_t a_register)
 
bool read_byte_16 (uint8_t a_register, uint16_t *data)
 
bool write_bytes (uint8_t a_register, const uint8_t *data, uint8_t len, bool stop=true)
 
bool write_bytes (uint8_t a_register, const std::vector< uint8_t > &data)
 
template<size_t N>
bool write_bytes (uint8_t a_register, const std::array< uint8_t, N > &data)
 
bool write_bytes_16 (uint8_t a_register, const uint16_t *data, uint8_t len)
 
bool write_byte (uint8_t a_register, uint8_t data, bool stop=true)
 
bool write_byte_16 (uint8_t a_register, uint16_t data)
 

Additional Inherited Members

- Protected Member Functions inherited from esphome::Component
virtual void call_loop ()
 
virtual void call_setup ()
 
virtual void call_dump_config ()
 
void set_interval (const std::string &name, uint32_t interval, std::function< void()> &&f)
 Set an interval function with a unique name. More...
 
void set_interval (uint32_t interval, std::function< void()> &&f)
 
bool cancel_interval (const std::string &name)
 Cancel an interval function. More...
 
void set_retry (const std::string &name, uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult(uint8_t)> &&f, float backoff_increase_factor=1.0f)
 Set an retry function with a unique name. More...
 
void set_retry (uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult(uint8_t)> &&f, float backoff_increase_factor=1.0f)
 
bool cancel_retry (const std::string &name)
 Cancel a retry function. More...
 
void set_timeout (const std::string &name, uint32_t timeout, std::function< void()> &&f)
 Set a timeout function with a unique name. More...
 
void set_timeout (uint32_t timeout, std::function< void()> &&f)
 
bool cancel_timeout (const std::string &name)
 Cancel a timeout function. More...
 
void defer (const std::string &name, std::function< void()> &&f)
 Defer a callback to the next loop() call. More...
 
void defer (std::function< void()> &&f)
 Defer a callback to the next loop() call. More...
 
bool cancel_defer (const std::string &name)
 Cancel a defer callback using the specified name, name must not be empty. More...
 
- Protected Attributes inherited from esphome::Component
uint32_t component_state_ {0x0000}
 State of this component. More...
 
float setup_priority_override_ {NAN}
 
const char * component_source_ {nullptr}
 
- Protected Attributes inherited from esphome::i2c::I2CDevice
uint8_t address_ {0x00}
 store the address of the device on the bus More...
 
I2CBusbus_ {nullptr}
 pointer to I2CBus instance More...
 

Detailed Description

Definition at line 51 of file grove_tb6612fng.h.

Member Function Documentation

◆ dc_motor_brake()

void esphome::grove_tb6612fng::GroveMotorDriveTB6612FNG::dc_motor_brake ( uint8_t  channel)

Definition at line 91 of file grove_tb6612fng.cpp.

◆ dc_motor_run()

void esphome::grove_tb6612fng::GroveMotorDriveTB6612FNG::dc_motor_run ( uint8_t  channel,
int16_t  speed 
)

Definition at line 66 of file grove_tb6612fng.cpp.

◆ dc_motor_stop()

void esphome::grove_tb6612fng::GroveMotorDriveTB6612FNG::dc_motor_stop ( uint8_t  channel)

Definition at line 99 of file grove_tb6612fng.cpp.

◆ dump_config()

void esphome::grove_tb6612fng::GroveMotorDriveTB6612FNG::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 21 of file grove_tb6612fng.cpp.

◆ not_standby()

bool esphome::grove_tb6612fng::GroveMotorDriveTB6612FNG::not_standby ( )

Definition at line 44 of file grove_tb6612fng.cpp.

◆ set_i2c_addr()

void esphome::grove_tb6612fng::GroveMotorDriveTB6612FNG::set_i2c_addr ( uint8_t  addr)

Definition at line 54 of file grove_tb6612fng.cpp.

◆ setup()

void esphome::grove_tb6612fng::GroveMotorDriveTB6612FNG::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 26 of file grove_tb6612fng.cpp.

◆ standby()

bool esphome::grove_tb6612fng::GroveMotorDriveTB6612FNG::standby ( )

Definition at line 34 of file grove_tb6612fng.cpp.

◆ stepper_keep_run()

void esphome::grove_tb6612fng::GroveMotorDriveTB6612FNG::stepper_keep_run ( StepperModeTypeT  mode,
uint16_t  rpm,
bool  is_cw 
)

Definition at line 150 of file grove_tb6612fng.cpp.

◆ stepper_run()

void esphome::grove_tb6612fng::GroveMotorDriveTB6612FNG::stepper_run ( StepperModeTypeT  mode,
int16_t  steps,
uint16_t  rpm 
)

Definition at line 107 of file grove_tb6612fng.cpp.

◆ stepper_stop()

void esphome::grove_tb6612fng::GroveMotorDriveTB6612FNG::stepper_stop ( )

Definition at line 142 of file grove_tb6612fng.cpp.


The documentation for this class was generated from the following files: