#include <canbus.h>

Inheritance diagram for esphome::canbus::CanbusTrigger:

Public Member Functions
	CanbusTrigger (Canbus *parent, const std::uint32_t can_id, const std::uint32_t can_id_mask, const bool use_extended_id)

void	set_remote_transmission_request (bool remote_transmission_request)

void	setup () override

Public Member Functions inherited from esphome::Trigger< std::vector< uint8_t >, uint32_t, bool >
void	trigger (Ts... x)
	Inform the parent automation that the event has triggered. More...

void	set_automation_parent (Automation< Ts... > *automation_parent)

void	stop_action ()
	Stop any action connected to this trigger. More...

bool	is_action_running ()
	Returns true if any action connected to this trigger is running. More...

Public Member Functions inherited from esphome::Component
virtual void	loop ()
	This method will be called repeatedly. More...

virtual void	dump_config ()

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 () const

bool	status_has_error () const

void	status_set_warning (const char *message="unspecified")

void	status_set_error (const char *message="unspecified")

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 Attributes
Canbus *	parent_

uint32_t	can_id_

uint32_t	can_id_mask_

bool	use_extended_id_

optional< bool >	remote_transmission_request_ {}

Protected Attributes inherited from esphome::Trigger< std::vector< uint8_t >, uint32_t, bool >
Automation< Ts... > *	automation_parent_

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}

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...

Detailed Description

Definition at line 137 of file canbus.h.

Constructor & Destructor Documentation

◆ CanbusTrigger()

esphome::canbus::CanbusTrigger::CanbusTrigger	(	Canbus *	parent,
		const std::uint32_t	can_id,
		const std::uint32_t	can_id_mask,
		const bool	use_extended_id
	)

inlineexplicit

Definition at line 141 of file canbus.h.

Member Function Documentation

◆ set_remote_transmission_request()

void esphome::canbus::CanbusTrigger::set_remote_transmission_request ( bool remote_transmission_request )

inline

Definition at line 145 of file canbus.h.

◆ setup()

void esphome::canbus::CanbusTrigger::setup ( )

inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 149 of file canbus.h.

Field Documentation

◆ can_id_

uint32_t esphome::canbus::CanbusTrigger::can_id_

protected

Definition at line 153 of file canbus.h.

◆ can_id_mask_

uint32_t esphome::canbus::CanbusTrigger::can_id_mask_

protected

Definition at line 154 of file canbus.h.

◆ parent_

Canbus* esphome::canbus::CanbusTrigger::parent_

protected

Definition at line 152 of file canbus.h.

◆ remote_transmission_request_

optional<bool> esphome::canbus::CanbusTrigger::remote_transmission_request_ {}

protected

Definition at line 156 of file canbus.h.

◆ use_extended_id_

bool esphome::canbus::CanbusTrigger::use_extended_id_

protected

Definition at line 155 of file canbus.h.

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

/opt/build/esphome/esphome/components/canbus/canbus.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CanbusTrigger()

Member Function Documentation

◆ set_remote_transmission_request()

◆ setup()

Field Documentation

◆ can_id_

◆ can_id_mask_

◆ parent_

◆ remote_transmission_request_

◆ use_extended_id_