EspTypes_CAN.h File Reference

ESP32 CAN type definitions for hardware abstraction. More...

#include "BaseCan.h"
#include "EspTypes_Base.h"
#include "HardwareTypes.h"
#include "McuSelect.h"

Include dependency graph for EspTypes_CAN.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	hf_can_filter_config_t
	CAN filter configuration structure. More...

Typedefs
using	hf_can_alert_callback_t = void (*)(uint32_t alerts, void* user_data)
	CAN alert callback function type.

Enumerations
enum class	hf_can_controller_id_t : uint8_t { HF_CAN_CONTROLLER_0 = 0 , HF_CAN_CONTROLLER_1 = 1 }
	CAN controller ID for ESP32 family. More...
enum class	hf_can_mode_t : uint8_t { HF_CAN_MODE_NORMAL = 0 , HF_CAN_MODE_NO_ACK = 1 , HF_CAN_MODE_LISTEN_ONLY = 2 }
	CAN operating mode mapping from ESP-IDF TWAI modes. More...
enum class	hf_can_operation_type_t : uint8_t {   HF_CAN_OP_SEND = 0 , HF_CAN_OP_RECEIVE = 1 , HF_CAN_OP_FILTER = 2 , HF_CAN_OP_ALERT = 3 ,   HF_CAN_OP_INIT = 4 , HF_CAN_OP_DEINIT = 5 , HF_CAN_OP_RESET = 6 , HF_CAN_OP_RECOVER = 7 }
	CAN operation types for statistics tracking. More...

Detailed Description

ESP32 CAN type definitions for hardware abstraction.

This header defines only the essential CAN-specific types and constants used by the EspCan implementation. It follows the same clean, minimal pattern as EspTypes_ADC.h, providing only necessary types without redundant or duplicate definitions.

Author

Nebiyu Tadesse

Date

2025

Copyright

HardFOC

Typedef Documentation

hf_can_alert_callback_t

using hf_can_alert_callback_t = void (*)(uint32_t alerts, void* user_data)

CAN alert callback function type.

Enumeration Type Documentation

hf_can_controller_id_t

enum class hf_can_controller_id_t : uint8_t

strong

CAN controller ID for ESP32 family.

Enumerator
HF_CAN_CONTROLLER_0	Primary CAN controller.
HF_CAN_CONTROLLER_1	Secondary CAN controller (ESP32 only)

hf_can_mode_t

enum class hf_can_mode_t : uint8_t

strong

CAN operating mode mapping from ESP-IDF TWAI modes.

Enumerator
HF_CAN_MODE_NORMAL	Normal operating mode.
HF_CAN_MODE_NO_ACK	No acknowledgment mode (self-test)
HF_CAN_MODE_LISTEN_ONLY	Listen-only mode (bus monitor)

hf_can_operation_type_t

enum class hf_can_operation_type_t : uint8_t

strong

CAN operation types for statistics tracking.

Enumerator
HF_CAN_OP_SEND	Send operation.
HF_CAN_OP_RECEIVE	Receive operation.
HF_CAN_OP_FILTER	Filter operation.
HF_CAN_OP_ALERT	Alert operation.
HF_CAN_OP_INIT	Initialization operation.
HF_CAN_OP_DEINIT	Deinitialization operation.
HF_CAN_OP_RESET	Reset operation.
HF_CAN_OP_RECOVER	Bus recovery operation.