ESPHome  2024.2.0
Public Member Functions | Protected Attributes
esphome::canbus::CanbusSendAction< Ts > Class Template Reference

#include <canbus.h>

Inheritance diagram for esphome::canbus::CanbusSendAction< Ts >:
esphome::Action< Ts... > esphome::Parented< Canbus >

Public Member Functions

void set_data_template (const std::function< std::vector< uint8_t >(Ts...)> func)
 
void set_data_static (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_remote_transmission_request (bool remote_transmission_request)
 
void play (Ts... x) override
 
- Public Member Functions inherited from esphome::Action< Ts... >
virtual void play_complex (Ts... x)
 
virtual void stop_complex ()
 
virtual bool is_running ()
 Check if this or any of the following actions are currently running. More...
 
int num_running_total ()
 The total number of actions that are currently running in this plus any of the following actions in the chain. More...
 
- Public Member Functions inherited from esphome::Parented< Canbus >
 Parented ()
 
 Parented (Canbus *parent)
 
Canbus * get_parent () const
 Get the parent of this object. More...
 
void set_parent (Canbus *parent)
 Set the parent of this object. More...
 

Protected Attributes

optional< uint32_t > can_id_ {}
 
optional< bool > use_extended_id_ {}
 
bool remote_transmission_request_ {false}
 
bool static_ {false}
 
std::function< std::vector< uint8_t >Ts...)> data_func_ {}
 
std::vector< uint8_t > data_static_ {}
 
- Protected Attributes inherited from esphome::Action< Ts... >
friend ActionList< Ts... >
 
Action< Ts... > * next_
 
int num_running_
 The number of instances of this sequence in the list of actions that is currently being executed. More...
 
- Protected Attributes inherited from esphome::Parented< Canbus >
Canbus * parent_
 

Additional Inherited Members

- Protected Member Functions inherited from esphome::Action< Ts... >
void play_next_ (Ts... x)
 
void play_next_tuple_ (const std::tuple< Ts... > &tuple, seq< S... >)
 
void play_next_tuple_ (const std::tuple< Ts... > &tuple)
 
virtual void stop ()
 
void stop_next_ ()
 
bool is_running_next_ ()
 

Detailed Description

template<typename... Ts>
class esphome::canbus::CanbusSendAction< Ts >

Definition at line 47 of file canbus.h.

Member Function Documentation

◆ play()

template<typename... Ts>
void esphome::canbus::CanbusSendAction< Ts >::play ( Ts...  x)
inlineoverridevirtual

Implements esphome::Action< Ts... >.

Definition at line 116 of file canbus.h.

◆ set_can_id()

template<typename... Ts>
void esphome::canbus::CanbusSendAction< Ts >::set_can_id ( uint32_t  can_id)
inline

Definition at line 108 of file canbus.h.

◆ set_data_static()

template<typename... Ts>
void esphome::canbus::CanbusSendAction< Ts >::set_data_static ( const std::vector< uint8_t > &  data)
inline

Definition at line 103 of file canbus.h.

◆ set_data_template()

template<typename... Ts>
void esphome::canbus::CanbusSendAction< Ts >::set_data_template ( const std::function< std::vector< uint8_t >(Ts...)>  func)
inline

Definition at line 99 of file canbus.h.

◆ set_remote_transmission_request()

template<typename... Ts>
void esphome::canbus::CanbusSendAction< Ts >::set_remote_transmission_request ( bool  remote_transmission_request)
inline

Definition at line 112 of file canbus.h.

◆ set_use_extended_id()

template<typename... Ts>
void esphome::canbus::CanbusSendAction< Ts >::set_use_extended_id ( bool  use_extended_id)
inline

Definition at line 110 of file canbus.h.

Field Documentation

◆ can_id_

template<typename... Ts>
optional<uint32_t> esphome::canbus::CanbusSendAction< Ts >::can_id_ {}
protected

Definition at line 129 of file canbus.h.

◆ data_func_

template<typename... Ts>
std::function<std::vector<uint8_t>Ts...)> esphome::canbus::CanbusSendAction< Ts >::data_func_ {}
protected

Definition at line 133 of file canbus.h.

◆ data_static_

template<typename... Ts>
std::vector<uint8_t> esphome::canbus::CanbusSendAction< Ts >::data_static_ {}
protected

Definition at line 134 of file canbus.h.

◆ remote_transmission_request_

template<typename... Ts>
bool esphome::canbus::CanbusSendAction< Ts >::remote_transmission_request_ {false}
protected

Definition at line 131 of file canbus.h.

◆ static_

template<typename... Ts>
bool esphome::canbus::CanbusSendAction< Ts >::static_ {false}
protected

Definition at line 132 of file canbus.h.

◆ use_extended_id_

template<typename... Ts>
optional<bool> esphome::canbus::CanbusSendAction< Ts >::use_extended_id_ {}
protected

Definition at line 130 of file canbus.h.


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