ESPHome  2022.11.4
Public Member Functions | Protected Member Functions | Protected Attributes
esphome::canbus::Canbus Class Reference

#include <canbus.h>

Inheritance diagram for esphome::canbus::Canbus:
esphome::Component esphome::esp32_can::ESP32Can

Public Member Functions

 Canbus ()
 
void setup () override
 
void dump_config () override
 
float get_setup_priority () const override
 
void loop () override
 
void send_data (uint32_t can_id, bool use_extended_id, bool remote_transmission_request, const std::vector< uint8_t > &data)
 
void send_data (uint32_t can_id, bool use_extended_id, const std::vector< uint8_t > &data)
 
void set_can_id (uint32_t can_id)
 
void set_use_extended_id (bool use_extended_id)
 
void set_bitrate (CanSpeed bit_rate)
 
void add_trigger (CanbusTrigger *trigger)
 
- Public Member Functions inherited from esphome::Component
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 ()
 
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...
 

Protected Member Functions

virtual bool setup_internal ()
 
virtual Error send_message (struct CanFrame *frame)
 
virtual Error read_message (struct CanFrame *frame)
 
- 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()> &&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()> &&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

std::vector< CanbusTrigger * > triggers_ {}
 
uint32_t can_id_
 
bool use_extended_id_
 
CanSpeed bit_rate_
 
- 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}
 

Detailed Description

Definition at line 57 of file canbus.h.

Constructor & Destructor Documentation

◆ Canbus()

esphome::canbus::Canbus::Canbus ( )
inline

Definition at line 59 of file canbus.h.

Member Function Documentation

◆ add_trigger()

void esphome::canbus::Canbus::add_trigger ( CanbusTrigger trigger)

Definition at line 50 of file canbus.cpp.

◆ dump_config()

void esphome::canbus::Canbus::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 17 of file canbus.cpp.

◆ get_setup_priority()

float esphome::canbus::Canbus::get_setup_priority ( ) const
inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 62 of file canbus.h.

◆ loop()

void esphome::canbus::Canbus::loop ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 59 of file canbus.cpp.

◆ read_message()

virtual Error esphome::canbus::Canbus::read_message ( struct CanFrame frame)
protectedvirtual

Reimplemented in esphome::esp32_can::ESP32Can.

◆ send_data() [1/2]

void esphome::canbus::Canbus::send_data ( uint32_t  can_id,
bool  use_extended_id,
bool  remote_transmission_request,
const std::vector< uint8_t > &  data 
)

Definition at line 25 of file canbus.cpp.

◆ send_data() [2/2]

void esphome::canbus::Canbus::send_data ( uint32_t  can_id,
bool  use_extended_id,
const std::vector< uint8_t > &  data 
)
inline

Definition at line 67 of file canbus.h.

◆ send_message()

virtual Error esphome::canbus::Canbus::send_message ( struct CanFrame frame)
protectedvirtual

Reimplemented in esphome::esp32_can::ESP32Can.

◆ set_bitrate()

void esphome::canbus::Canbus::set_bitrate ( CanSpeed  bit_rate)
inline

Definition at line 73 of file canbus.h.

◆ set_can_id()

void esphome::canbus::Canbus::set_can_id ( uint32_t  can_id)
inline

Definition at line 71 of file canbus.h.

◆ set_use_extended_id()

void esphome::canbus::Canbus::set_use_extended_id ( bool  use_extended_id)
inline

Definition at line 72 of file canbus.h.

◆ setup()

void esphome::canbus::Canbus::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 9 of file canbus.cpp.

◆ setup_internal()

virtual bool esphome::canbus::Canbus::setup_internal ( )
protectedvirtual

Reimplemented in esphome::esp32_can::ESP32Can.

Field Documentation

◆ bit_rate_

CanSpeed esphome::canbus::Canbus::bit_rate_
protected

Definition at line 82 of file canbus.h.

◆ can_id_

uint32_t esphome::canbus::Canbus::can_id_
protected

Definition at line 80 of file canbus.h.

◆ triggers_

std::vector<CanbusTrigger *> esphome::canbus::Canbus::triggers_ {}
protected

Definition at line 79 of file canbus.h.

◆ use_extended_id_

bool esphome::canbus::Canbus::use_extended_id_
protected

Definition at line 81 of file canbus.h.


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