#include <mcp2515.h>

Inheritance diagram for esphome::mcp2515::MCP2515:

Data Structures
struct	RxBnRegs

struct	TxBnRegs

Public Member Functions
	MCP2515 ()

void	set_mcp_clock (CanClock clock)

void	set_mcp_mode (const CanctrlReqopMode mode)

Public Member Functions inherited from esphome::canbus::Canbus
	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)

void	add_callback (std::function< void(uint32_t can_id, bool extended_id, bool rtr, const std::vector< uint8_t > &data)> callback)
	Add a callback to be called when a CAN message is received.

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

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.

void	mark_failed (const char *message)

bool	is_failed () const

bool	is_ready () const

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.

const char *	get_component_source () const
	Get the integration where this component was declared as a string.

bool	should_warn_of_blocking (uint32_t blocking_time)

Public Member Functions inherited from esphome::spi::SPIDevice< spi::BIT_ORDER_MSB_FIRST, spi::CLOCK_POLARITY_LOW, spi::CLOCK_PHASE_LEADING, spi::DATA_RATE_8MHZ >
	SPIDevice ()

	SPIDevice (SPIComponent parent, GPIOPin cs_pin)

void	spi_setup () override

void	spi_teardown () override

void	set_spi_parent (SPIComponent *parent)

void	set_cs_pin (GPIOPin *cs)

void	set_data_rate (uint32_t data_rate)

void	set_bit_order (SPIBitOrder order)

void	set_mode (SPIMode mode)

uint8_t	read_byte ()

void	read_array (uint8_t *data, size_t length)

void	write (uint16_t data, size_t num_bits)
	Write a single data item, up to 32 bits.

void	write_cmd_addr_data (size_t cmd_bits, uint32_t cmd, size_t addr_bits, uint32_t address, const uint8_t *data, size_t length, uint8_t bus_width=1)

void	write_byte (uint8_t data)

void	transfer_array (uint8_t *data, size_t length)
	Write the array data, replace with received data.

void	transfer_array (std::array< uint8_t, N > &data)

uint8_t	transfer_byte (uint8_t data)

void	write_byte16 (uint16_t data)
	Write 16 bit data.

void	write_array16 (const uint16_t *data, size_t length)
	Write an array of data as 16 bit values, byte-swapping if required.

void	enable ()

void	disable ()

void	write_array (const uint8_t *data, size_t length)

void	write_array (const std::array< uint8_t, N > &data)

void	write_array (const std::vector< uint8_t > &data)

Public Member Functions inherited from esphome::spi::SPIClient
	SPIClient (SPIBitOrder bit_order, SPIMode mode, uint32_t data_rate)

bool	spi_is_ready ()

Static Public Attributes
static const struct esphome::mcp2515::MCP2515::TxBnRegs	TXB [N_TXBUFFERS]

static const struct esphome::mcp2515::MCP2515::RxBnRegs	RXB [N_RXBUFFERS]

Protected Member Functions
bool	setup_internal () override

canbus::Error	set_mode_ (CanctrlReqopMode mode)

uint8_t	read_register_ (REGISTER reg)

void	read_registers_ (REGISTER reg, uint8_t values[], uint8_t n)

void	set_register_ (REGISTER reg, uint8_t value)

void	set_registers_ (REGISTER reg, uint8_t values[], uint8_t n)

void	modify_register_ (REGISTER reg, uint8_t mask, uint8_t data)

void	prepare_id_ (uint8_t *buffer, bool extended, uint32_t id)

canbus::Error	reset_ ()

canbus::Error	set_clk_out_ (CanClkOut divisor)

canbus::Error	set_bitrate_ (canbus::CanSpeed can_speed)

canbus::Error	set_bitrate_ (canbus::CanSpeed can_speed, CanClock can_clock)

canbus::Error	set_filter_mask_ (MASK mask, bool extended, uint32_t ul_data)

canbus::Error	set_filter_ (RXF num, bool extended, uint32_t ul_data)

canbus::Error	send_message_ (TXBn txbn, struct canbus::CanFrame *frame)

canbus::Error	send_message (struct canbus::CanFrame *frame) override

canbus::Error	read_message_ (RXBn rxbn, struct canbus::CanFrame *frame)

canbus::Error	read_message (struct canbus::CanFrame *frame) override

bool	check_receive_ ()

bool	check_error_ ()

uint8_t	get_error_flags_ ()

void	clear_rx_n_ovr_flags_ ()

uint8_t	get_int_ ()

uint8_t	get_int_mask_ ()

void	clear_int_ ()

void	clear_tx_int_ ()

uint8_t	get_status_ ()

void	clear_rx_n_ovr_ ()

void	clear_merr_ ()

void	clear_errif_ ()

Protected Member Functions inherited from esphome::canbus::Canbus
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.

void	set_interval (uint32_t interval, std::function< void()> &&f)

bool	cancel_interval (const std::string &name)
	Cancel an interval function.

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.

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.

void	set_timeout (const std::string &name, uint32_t timeout, std::function< void()> &&f)
	Set a timeout function with a unique name.

void	set_timeout (uint32_t timeout, std::function< void()> &&f)

bool	cancel_timeout (const std::string &name)
	Cancel a timeout function.

void	defer (const std::string &name, std::function< void()> &&f)
	Defer a callback to the next loop() call.

void	defer (std::function< void()> &&f)
	Defer a callback to the next loop() call.

bool	cancel_defer (const std::string &name)
	Cancel a defer callback using the specified name, name must not be empty.

Protected Attributes
CanClock	mcp_clock_ {MCP_8MHZ}

CanctrlReqopMode	mcp_mode_ = CANCTRL_REQOP_NORMAL

Protected Attributes inherited from esphome::canbus::Canbus
std::vector< CanbusTrigger * >	triggers_ {}

uint32_t	can_id_

bool	use_extended_id_

CanSpeed	bit_rate_

CallbackManager< void(uint32_t can_id, bool extended_id, bool rtr, const std::vector< uint8_t > &data)>	callback_manager_ {}

Protected Attributes inherited from esphome::Component
uint32_t	component_state_ {0x0000}
	State of this component.

float	setup_priority_override_ {NAN}

const char *	component_source_ {nullptr}

uint32_t	warn_if_blocking_over_ {WARN_IF_BLOCKING_OVER_MS}

std::string	error_message_ {}

Protected Attributes inherited from esphome::spi::SPIClient
SPIBitOrder	bit_order_ {BIT_ORDER_MSB_FIRST}

SPIMode	mode_ {MODE0}

uint32_t	data_rate_ {1000000}

SPIComponent *	parent_ {nullptr}

GPIOPin *	cs_ {nullptr}

SPIDelegate *	delegate_ {SPIDelegate::NULL_DELEGATE}

Detailed Description

Definition at line 55 of file mcp2515.h.

Constructor & Destructor Documentation

◆ MCP2515()

esphome::mcp2515::MCP2515::MCP2515 ( )

inline

Definition at line 59 of file mcp2515.h.

Member Function Documentation

◆ check_error_()

bool esphome::mcp2515::MCP2515::check_error_ ( )

protected

Definition at line 326 of file mcp2515.cpp.

◆ check_receive_()

bool esphome::mcp2515::MCP2515::check_receive_ ( )

protected

Definition at line 321 of file mcp2515.cpp.

◆ clear_errif_()

void esphome::mcp2515::MCP2515::clear_errif_ ( )

protected

Definition at line 358 of file mcp2515.cpp.

◆ clear_int_()

void esphome::mcp2515::MCP2515::clear_int_ ( )

protected

Definition at line 337 of file mcp2515.cpp.

◆ clear_merr_()

void esphome::mcp2515::MCP2515::clear_merr_ ( )

protected

Definition at line 352 of file mcp2515.cpp.

◆ clear_rx_n_ovr_()

void esphome::mcp2515::MCP2515::clear_rx_n_ovr_ ( )

protected

Definition at line 343 of file mcp2515.cpp.

◆ clear_rx_n_ovr_flags_()

void esphome::mcp2515::MCP2515::clear_rx_n_ovr_flags_ ( )

protected

Definition at line 333 of file mcp2515.cpp.

◆ clear_tx_int_()

void esphome::mcp2515::MCP2515::clear_tx_int_ ( )

protected

Definition at line 341 of file mcp2515.cpp.

◆ get_error_flags_()

uint8_t esphome::mcp2515::MCP2515::get_error_flags_ ( )

protected

Definition at line 331 of file mcp2515.cpp.

◆ get_int_()

uint8_t esphome::mcp2515::MCP2515::get_int_ ( )

protected

Definition at line 335 of file mcp2515.cpp.

◆ get_int_mask_()

uint8_t esphome::mcp2515::MCP2515::get_int_mask_ ( )

protected

Definition at line 339 of file mcp2515.cpp.

◆ get_status_()

uint8_t esphome::mcp2515::MCP2515::get_status_ ( )

protected

Definition at line 107 of file mcp2515.cpp.

◆ modify_register_()

void esphome::mcp2515::MCP2515::modify_register_	(	REGISTER	reg,
		uint8_t	mask,
		uint8_t	data )

protected

Definition at line 98 of file mcp2515.cpp.

◆ prepare_id_()

void esphome::mcp2515::MCP2515::prepare_id_	(	uint8_t *	buffer,
		bool	extended,
		uint32_t	id )

protected

Definition at line 149 of file mcp2515.cpp.

◆ read_message()

canbus::Error esphome::mcp2515::MCP2515::read_message ( struct canbus::CanFrame * frame )

overrideprotectedvirtual

Reimplemented from esphome::canbus::Canbus.

Definition at line 306 of file mcp2515.cpp.

◆ read_message_()

canbus::Error esphome::mcp2515::MCP2515::read_message_	(	RXBn	rxbn,
		struct canbus::CanFrame *	frame )

protected

Definition at line 264 of file mcp2515.cpp.

◆ read_register_()

uint8_t esphome::mcp2515::MCP2515::read_register_ ( REGISTER reg )

protected

Definition at line 57 of file mcp2515.cpp.

◆ read_registers_()

void esphome::mcp2515::MCP2515::read_registers_	(	REGISTER	reg,
		uint8_t	values[],
		uint8_t	n )

protected

Definition at line 67 of file mcp2515.cpp.

◆ reset_()

canbus::Error esphome::mcp2515::MCP2515::reset_ ( )

protected

Definition at line 30 of file mcp2515.cpp.

◆ send_message()

canbus::Error esphome::mcp2515::MCP2515::send_message ( struct canbus::CanFrame * frame )

overrideprotectedvirtual

Reimplemented from esphome::canbus::Canbus.

Definition at line 247 of file mcp2515.cpp.

◆ send_message_()

canbus::Error esphome::mcp2515::MCP2515::send_message_	(	TXBn	txbn,
		struct canbus::CanFrame *	frame )

protected

Definition at line 232 of file mcp2515.cpp.

◆ set_bitrate_() [1/2]

canbus::Error esphome::mcp2515::MCP2515::set_bitrate_ ( canbus::CanSpeed can_speed )

protected

Definition at line 364 of file mcp2515.cpp.

◆ set_bitrate_() [2/2]

canbus::Error esphome::mcp2515::MCP2515::set_bitrate_	(	canbus::CanSpeed	can_speed,
		CanClock	can_clock )

protected

Definition at line 366 of file mcp2515.cpp.

◆ set_clk_out_()

canbus::Error esphome::mcp2515::MCP2515::set_clk_out_ ( CanClkOut divisor )

protected

Definition at line 128 of file mcp2515.cpp.

◆ set_filter_()

canbus::Error esphome::mcp2515::MCP2515::set_filter_	(	RXF	num,
		bool	extended,
		uint32_t	ul_data )

protected

Definition at line 194 of file mcp2515.cpp.

◆ set_filter_mask_()

canbus::Error esphome::mcp2515::MCP2515::set_filter_mask_	(	MASK	mask,
		bool	extended,
		uint32_t	ul_data )

protected

Definition at line 168 of file mcp2515.cpp.

◆ set_mcp_clock()

void esphome::mcp2515::MCP2515::set_mcp_clock ( CanClock clock )

inline

Definition at line 60 of file mcp2515.h.

◆ set_mcp_mode()

void esphome::mcp2515::MCP2515::set_mcp_mode ( const CanctrlReqopMode mode )

inline

Definition at line 61 of file mcp2515.h.

◆ set_mode_()

canbus::Error esphome::mcp2515::MCP2515::set_mode_ ( CanctrlReqopMode mode )

protected

Definition at line 116 of file mcp2515.cpp.

◆ set_register_()

void esphome::mcp2515::MCP2515::set_register_	(	REGISTER	reg,
		uint8_t	value )

protected

Definition at line 79 of file mcp2515.cpp.

◆ set_registers_()

void esphome::mcp2515::MCP2515::set_registers_	(	REGISTER	reg,
		uint8_t	values[],
		uint8_t	n )

protected

Definition at line 87 of file mcp2515.cpp.

◆ setup_internal()

bool esphome::mcp2515::MCP2515::setup_internal ( )

overrideprotectedvirtual

Reimplemented from esphome::canbus::Canbus.

Definition at line 16 of file mcp2515.cpp.

Field Documentation

◆ mcp_clock_

CanClock esphome::mcp2515::MCP2515::mcp_clock_ {MCP_8MHZ}

protected

Definition at line 76 of file mcp2515.h.

◆ mcp_mode_

CanctrlReqopMode esphome::mcp2515::MCP2515::mcp_mode_ = CANCTRL_REQOP_NORMAL

protected

Definition at line 77 of file mcp2515.h.

◆ RXB

const struct MCP2515::RxBnRegs esphome::mcp2515::MCP2515::RXB

static

Initial value:

= {{MCP_RXB0CTRL, MCP_RXB0SIDH, MCP_RXB0DATA, CANINTF_RX0IF},

{MCP_RXB1CTRL, MCP_RXB1SIDH, MCP_RXB1DATA, CANINTF_RX1IF}}

esphome::mcp2515::CANINTF_RX1IF

@ CANINTF_RX1IF

Definition mcp2515.h:30

esphome::mcp2515::CANINTF_RX0IF

@ CANINTF_RX0IF

Definition mcp2515.h:29

esphome::mcp2515::MCP_RXB1SIDH

@ MCP_RXB1SIDH

Definition mcp2515_defs.h:120

esphome::mcp2515::MCP_RXB0SIDH

@ MCP_RXB0SIDH

Definition mcp2515_defs.h:113

esphome::mcp2515::MCP_RXB0DATA

@ MCP_RXB0DATA

Definition mcp2515_defs.h:118

esphome::mcp2515::MCP_RXB1CTRL

@ MCP_RXB1CTRL

Definition mcp2515_defs.h:119

esphome::mcp2515::MCP_RXB0CTRL

@ MCP_RXB0CTRL

Definition mcp2515_defs.h:112

esphome::mcp2515::MCP_RXB1DATA

@ MCP_RXB1DATA

Definition mcp2515_defs.h:125

Definition at line 13 of file mcp2515.cpp.

◆ TXB

const struct MCP2515::TxBnRegs esphome::mcp2515::MCP2515::TXB

static

Initial value:

= {{MCP_TXB0CTRL, MCP_TXB0SIDH, MCP_TXB0DATA},
                                                            {MCP_TXB1CTRL, MCP_TXB1SIDH, MCP_TXB1DATA},
                                                            {MCP_TXB2CTRL, MCP_TXB2SIDH, MCP_TXB2DATA}}

Definition at line 9 of file mcp2515.cpp.

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

esphome/components/mcp2515/mcp2515.h
esphome/components/mcp2515/mcp2515.cpp

Data Structures

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ MCP2515()

Member Function Documentation

◆ check_error_()

◆ check_receive_()

◆ clear_errif_()

◆ clear_int_()

◆ clear_merr_()

◆ clear_rx_n_ovr_()

◆ clear_rx_n_ovr_flags_()

◆ clear_tx_int_()

◆ get_error_flags_()

◆ get_int_()

◆ get_int_mask_()

◆ get_status_()

◆ modify_register_()

◆ prepare_id_()

◆ read_message()

◆ read_message_()

◆ read_register_()

◆ read_registers_()

◆ reset_()

◆ send_message()

◆ send_message_()

◆ set_bitrate_() [1/2]

◆ set_bitrate_() [2/2]

◆ set_clk_out_()

◆ set_filter_()

◆ set_filter_mask_()

◆ set_mcp_clock()

◆ set_mcp_mode()

◆ set_mode_()

◆ set_register_()

◆ set_registers_()

◆ setup_internal()

Field Documentation

◆ mcp_clock_

◆ mcp_mode_

◆ RXB

◆ TXB