The HDMI-CEC bus on one GPIO pin. More...

#include <hdmi_cec.h>

Inheritance diagram for esphome::hdmi_cec::HDMICEC:

Public Member Functions
	HDMICEC (InternalGPIOPin *pin, uint8_t address)

void	setup () override

void	dump_config () override

void	loop () override

void	set_promiscuous_mode (bool promiscuous)

void	set_monitor_mode (bool monitor_mode)

template<typename F >
void	add_on_message_callback (F &&callback)
	Called with the initiator, the destination and the payload (opcode first) of every received frame; the payload is only valid during the call.

bool	send (uint8_t source, uint8_t destination, std::span< const uint8_t > payload)
	Queue a frame for transmission; false when the queue is full or in monitor mode.

bool	send (uint8_t destination, std::span< const uint8_t > payload)

bool	send (uint8_t destination, std::initializer_list< uint8_t > payload)
	For lambdas: id(cec).send(0x0, {0x44, 0x41});.

Public Member Functions inherited from esphome::Component
virtual float	get_setup_priority () const
	priority of setup().

float	get_actual_setup_priority () const

void	set_setup_priority (float priority)

void	call ()

virtual void	on_shutdown ()

virtual void	on_safe_shutdown ()

virtual bool	teardown ()
	Called during teardown to allow component to gracefully finish operations.

virtual void	on_powerdown ()
	Called after teardown is complete to power down hardware.

uint8_t	get_component_state () const

void	reset_to_construction_state ()
	Reset this component back to the construction state to allow setup to run again.

bool	is_in_loop_state () const
	Check if this component has completed setup and is in the loop state.

bool	is_idle () const
	Check if this component is idle.

void	mark_failed ()
	Mark this component as failed.

void	mark_failed (const LogString *message)

void	disable_loop ()
	Disable this component's loop.

void	enable_loop ()
	Enable this component's loop.

void	enable_loop_soon_any_context ()
	Thread and ISR-safe version of enable_loop() that can be called from any context.

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

void	status_set_warning (const char *message)

void	status_set_warning (const LogString *message)

void	status_set_error ()

void	status_set_error (const LogString *message)

void	status_clear_warning ()

void	status_clear_error ()

	ESPDEPRECATED ("Use status_momentary_warning() without a name. Removed in 2027.5.0", "2026.11.0") void status_momentary_warning(const char *name

void	status_momentary_warning (uint32_t length=5000)
	Set warning status flag and clear it after `length` ms.

void	status_momentary_warning (const LogString *message, uint32_t length=5000)

	ESPDEPRECATED ("Use status_momentary_error() without a name. Removed in 2027.5.0", "2026.11.0") void status_momentary_error(const char *name

void	status_momentary_error (uint32_t length=5000)
	Set error status flag and clear it after `length` ms.

void	status_momentary_error (const LogString *message, uint32_t length=5000)

bool	has_overridden_loop () const

const LogString *	get_component_log_str () const ESPHOME_ALWAYS_INLINE
	Get the integration where this component was declared as a LogString for logging.

bool	should_warn_of_blocking (uint32_t blocking_time, uint32_t &threshold_ms_out)

Protected Types
enum class	ReceiverState : uint8_t { RECEIVER_STATE_IDLE , RECEIVER_STATE_RECEIVING_BYTE , RECEIVER_STATE_WAITING_FOR_EOM , RECEIVER_STATE_WAITING_FOR_ACK }

Protected Member Functions
void	gpio_isr_ ()

void	reset_receiver_ ()

void	send_ack_ ()
	Pull the line low for the acknowledge bit of a frame addressed to us.

bool	setup_ack_timer_ ()

void	start_ack_timer_ ()

void	transmit_message_ ()

void	finish_attempt_ (bool sent_ok)
	Keep the frame for another attempt, or drop it once the attempts are used up.

bool	transmit_frame_ (const Frame *frame)
	Drive the frame onto the line; false when another initiator sent at the same time.

bool	send_start_bit_ ()

bool	send_bit_ (bool bit_value)
	Send one bit; false when a logical 1 found the line held low by another initiator.

ESPHOME_ALWAYS_INLINE void	set_pin_input_high_ ()

ESPHOME_ALWAYS_INLINE void	set_pin_output_low_ ()

Protected Member Functions inherited from esphome::Component
friend	void::setup ()

friend	void::original_setup ()

void	set_component_source_ (uint8_t index)
	Set where this component was loaded from for some debug messages.

virtual void	call_setup ()

void	call_dump_config_ ()

void	enable_loop_slow_path_ ()

void	set_component_state_ (uint8_t state)
	Helper to set component state (clears state bits and sets new state)

bool	set_status_flag_ (uint8_t flag)
	Helper to set a status LED flag on both this component and the app.

bool	set_error_flag_ (const LogString *message)
	Set the error flag and log it; true when it was not set before.

void	set_interval (const char *name, uint32_t interval, std::function< void()> &&f)
	Set an interval function with a const char* name.

void	set_interval (uint32_t id, uint32_t interval, std::function< void()> &&f)
	Set an interval function with a numeric ID (zero heap allocation).

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

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

bool	cancel_interval (const char *name)
	Cancel an interval function.

bool	cancel_interval (uint32_t id)

bool	cancel_interval (InternalSchedulerID id)

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

void	set_timeout (uint32_t id, uint32_t timeout, std::function< void()> &&f)
	Set a timeout function with a numeric ID (zero heap allocation).

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

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

bool	cancel_timeout (const char *name)
	Cancel a timeout function.

bool	cancel_timeout (uint32_t id)

bool	cancel_timeout (InternalSchedulerID id)

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

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

void	defer (uint32_t id, std::function< void()> &&f)
	Defer a callback with a numeric ID (zero heap allocation)

bool	cancel_defer (const char *name)
	Cancel a defer callback using the specified name, name must not be empty.

bool	cancel_defer (uint32_t id)

void	status_clear_warning_slow_path_ ()

void	status_clear_error_slow_path_ ()

Static Protected Member Functions
static void	gpio_isr_s (HDMICEC *self)

static bool	ack_timer_isr_s (gptimer_handle_t timer, const gptimer_alarm_event_data_t edata, void arg)

static void	ack_timer_isr_s ()

static void	ack_timer_isr_s (uint alarm_num)

Protected Attributes
FrameRingBuffer< QUEUE_SIZE >	frames_queue_

uint8_t	recv_bit_counter_ {0}

uint8_t	recv_byte_ {0}

FrameRingBuffer< QUEUE_SIZE >	send_queue_

uint8_t	transmit_attempts_ {0}

uint8_t	reported_dropped_frames_ {0}

StaticCallbackManager< HDMI_CEC_MESSAGE_CALLBACK_COUNT, void(uint8_t, uint8_t, std::span< const uint8_t >)>	message_callbacks_

InternalGPIOPin *	pin_

ISRInternalGPIOPin	isr_pin_

gptimer_handle_t	ack_timer_ {nullptr}

int	ack_alarm_ {-1}

std::atomic< uint32_t >	last_edge_us_ {0}

Frame *	recv_frame_ {nullptr}

uint32_t	last_falling_edge_us_ {0}

uint32_t	last_attempt_us_ {0}

uint16_t	required_idle_period_ {0}

std::atomic< bool >	eom_received_ {false}

std::atomic< uint8_t >	dropped_frames_ {0}

uint8_t	n_bytes_received_ {0}

uint8_t	n_acks_received_ {0}

bool	transmitting_ {false}

uint8_t	recv_header_ {0}

uint8_t	recv_length_ {0}

ReceiverState	receiver_state_ {ReceiverState::RECEIVER_STATE_IDLE}

bool	recv_eom_ {false}

bool	recv_ack_queued_ {false}

bool	prev_pin_level_ {true}

uint8_t	address_

bool	promiscuous_mode_ {false}

bool	monitor_mode_ {false}

Protected Attributes inherited from esphome::Component
uint8_t	component_source_index_ {0}
	Index into component source PROGMEM lookup table (0 = not set)

uint8_t	warn_if_blocking_over_ {WARN_IF_BLOCKING_OVER_CS}
	Warn threshold in centiseconds (max 2550ms)

uint8_t	component_state_ {0x00}
	State of this component - each bit has a purpose: Bits 0-2: Component state (0x00=CONSTRUCTION, 0x01=SETUP, 0x02=LOOP, 0x03=FAILED, 0x04=LOOP_DONE) Bit 3: STATUS_LED_WARNING Bit 4: STATUS_LED_ERROR Bit 5: Has overridden loop() (set at registration time) Bits 6-7: Unused - reserved for future expansion.

volatile bool	pending_enable_loop_ {false}
	ISR-safe flag for enable_loop_soon_any_context.

ComponentRuntimeStats	runtime_stats_

Static Protected Attributes
static constexpr size_t	QUEUE_SIZE = 4

Additional Inherited Members
Data Fields inherited from esphome::Component
uint32_t	length = 5000)

Detailed Description

The HDMI-CEC bus on one GPIO pin.

The receive interrupt decodes the edges of every frame, including those this device sends, and queues complete frames for loop(); loop() runs the on_message automations and transmits queued frames, one blocking bit-banged attempt per pass.

Definition at line 97 of file hdmi_cec.h.

Member Enumeration Documentation

◆ ReceiverState

enum class esphome::hdmi_cec::HDMICEC::ReceiverState : uint8_t

strongprotected

Enumerator
RECEIVER_STATE_IDLE
RECEIVER_STATE_RECEIVING_BYTE
RECEIVER_STATE_WAITING_FOR_EOM
RECEIVER_STATE_WAITING_FOR_ACK

Definition at line 125 of file hdmi_cec.h.

Constructor & Destructor Documentation

◆ HDMICEC()

esphome::hdmi_cec::HDMICEC::HDMICEC	(	InternalGPIOPin *	pin,
		uint8_t	address )

inline

Definition at line 99 of file hdmi_cec.h.

Member Function Documentation

◆ ack_timer_isr_s() [1/3]

void IRAM_ATTR esphome::hdmi_cec::HDMICEC::ack_timer_isr_s ( )

staticprotected

Definition at line 304 of file hdmi_cec.cpp.

◆ ack_timer_isr_s() [2/3]

bool IRAM_ATTR esphome::hdmi_cec::HDMICEC::ack_timer_isr_s	(	gptimer_handle_t	timer,
		const gptimer_alarm_event_data_t *	edata,
		void *	arg )

staticprotected

Definition at line 284 of file hdmi_cec.cpp.

◆ ack_timer_isr_s() [3/3]

void IRAM_ATTR esphome::hdmi_cec::HDMICEC::ack_timer_isr_s ( uint alarm_num )

staticprotected

Definition at line 321 of file hdmi_cec.cpp.

◆ add_on_message_callback()

template<typename F >

void esphome::hdmi_cec::HDMICEC::add_on_message_callback ( F && callback )

inline

Called with the initiator, the destination and the payload (opcode first) of every received frame; the payload is only valid during the call.

Definition at line 109 of file hdmi_cec.h.

◆ dump_config()

void esphome::hdmi_cec::HDMICEC::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 58 of file hdmi_cec.cpp.

◆ finish_attempt_()

void esphome::hdmi_cec::HDMICEC::finish_attempt_ ( bool sent_ok )

protected

Keep the frame for another attempt, or drop it once the attempts are used up.

Definition at line 181 of file hdmi_cec.cpp.

◆ gpio_isr_()

void IRAM_ATTR esphome::hdmi_cec::HDMICEC::gpio_isr_ ( )

protected

Definition at line 335 of file hdmi_cec.cpp.

◆ gpio_isr_s()

void IRAM_ATTR esphome::hdmi_cec::HDMICEC::gpio_isr_s ( HDMICEC * self )

staticprotected

Definition at line 333 of file hdmi_cec.cpp.

◆ loop()

void esphome::hdmi_cec::HDMICEC::loop ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 68 of file hdmi_cec.cpp.

◆ reset_receiver_()

void IRAM_ATTR esphome::hdmi_cec::HDMICEC::reset_receiver_ ( )

protected

Definition at line 442 of file hdmi_cec.cpp.

◆ send() [1/3]

bool esphome::hdmi_cec::HDMICEC::send	(	uint8_t	destination,
		std::initializer_list< uint8_t >	payload )

inline

For lambdas: id(cec).send(0x0, {0x44, 0x41});.

Definition at line 120 of file hdmi_cec.h.

◆ send() [2/3]

bool esphome::hdmi_cec::HDMICEC::send	(	uint8_t	destination,
		std::span< const uint8_t >	payload )

inline

Definition at line 116 of file hdmi_cec.h.

◆ send() [3/3]

bool esphome::hdmi_cec::HDMICEC::send	(	uint8_t	source,
		uint8_t	destination,
		std::span< const uint8_t >	payload )

Queue a frame for transmission; false when the queue is full or in monitor mode.

Definition at line 96 of file hdmi_cec.cpp.

◆ send_ack_()

void IRAM_ATTR esphome::hdmi_cec::HDMICEC::send_ack_ ( )

protected

Pull the line low for the acknowledge bit of a frame addressed to us.

Definition at line 258 of file hdmi_cec.cpp.

◆ send_bit_()

bool esphome::hdmi_cec::HDMICEC::send_bit_ ( bool bit_value )

protected

Send one bit; false when a logical 1 found the line held low by another initiator.

Definition at line 236 of file hdmi_cec.cpp.

◆ send_start_bit_()

bool esphome::hdmi_cec::HDMICEC::send_start_bit_ ( )

protected

Definition at line 217 of file hdmi_cec.cpp.

◆ set_monitor_mode()

void esphome::hdmi_cec::HDMICEC::set_monitor_mode ( bool monitor_mode )

inline

Definition at line 105 of file hdmi_cec.h.

◆ set_pin_input_high_()

ESPHOME_ALWAYS_INLINE void esphome::hdmi_cec::HDMICEC::set_pin_input_high_ ( )

inlineprotected

Definition at line 162 of file hdmi_cec.h.

◆ set_pin_output_low_()

ESPHOME_ALWAYS_INLINE void esphome::hdmi_cec::HDMICEC::set_pin_output_low_ ( )

inlineprotected

Definition at line 163 of file hdmi_cec.h.

◆ set_promiscuous_mode()

void esphome::hdmi_cec::HDMICEC::set_promiscuous_mode ( bool promiscuous )

inline

Definition at line 104 of file hdmi_cec.h.

◆ setup()

void esphome::hdmi_cec::HDMICEC::setup ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 42 of file hdmi_cec.cpp.

◆ setup_ack_timer_()

bool esphome::hdmi_cec::HDMICEC::setup_ack_timer_ ( )

protected

Definition at line 265 of file hdmi_cec.cpp.

◆ start_ack_timer_()

void IRAM_ATTR esphome::hdmi_cec::HDMICEC::start_ack_timer_ ( )

protected

Definition at line 282 of file hdmi_cec.cpp.

◆ transmit_frame_()

bool esphome::hdmi_cec::HDMICEC::transmit_frame_ ( const Frame * frame )

protected

Drive the frame onto the line; false when another initiator sent at the same time.

Definition at line 193 of file hdmi_cec.cpp.

◆ transmit_message_()

void esphome::hdmi_cec::HDMICEC::transmit_message_ ( )

protected

Definition at line 121 of file hdmi_cec.cpp.

Field Documentation

◆ ack_alarm_

int esphome::hdmi_cec::HDMICEC::ack_alarm_ {-1}

protected

Definition at line 186 of file hdmi_cec.h.

◆ ack_timer_

gptimer_handle_t esphome::hdmi_cec::HDMICEC::ack_timer_ {nullptr}

protected

Definition at line 183 of file hdmi_cec.h.

◆ address_

uint8_t esphome::hdmi_cec::HDMICEC::address_

protected

Definition at line 213 of file hdmi_cec.h.

◆ dropped_frames_

std::atomic<uint8_t> esphome::hdmi_cec::HDMICEC::dropped_frames_ {0}

protected

Definition at line 200 of file hdmi_cec.h.

◆ eom_received_

std::atomic<bool> esphome::hdmi_cec::HDMICEC::eom_received_ {false}

protected

Definition at line 199 of file hdmi_cec.h.

◆ frames_queue_

FrameRingBuffer<QUEUE_SIZE> esphome::hdmi_cec::HDMICEC::frames_queue_

protected

Definition at line 170 of file hdmi_cec.h.

◆ isr_pin_

ISRInternalGPIOPin esphome::hdmi_cec::HDMICEC::isr_pin_

protected

Definition at line 181 of file hdmi_cec.h.

◆ last_attempt_us_

uint32_t esphome::hdmi_cec::HDMICEC::last_attempt_us_ {0}

protected

Definition at line 193 of file hdmi_cec.h.

◆ last_edge_us_

std::atomic<uint32_t> esphome::hdmi_cec::HDMICEC::last_edge_us_ {0}

protected

Definition at line 190 of file hdmi_cec.h.

◆ last_falling_edge_us_

uint32_t esphome::hdmi_cec::HDMICEC::last_falling_edge_us_ {0}

protected

Definition at line 192 of file hdmi_cec.h.

◆ message_callbacks_

StaticCallbackManager<HDMI_CEC_MESSAGE_CALLBACK_COUNT, void(uint8_t, uint8_t, std::span<const uint8_t>)> esphome::hdmi_cec::HDMICEC::message_callbacks_

protected

Definition at line 178 of file hdmi_cec.h.

◆ monitor_mode_

bool esphome::hdmi_cec::HDMICEC::monitor_mode_ {false}

protected

Definition at line 215 of file hdmi_cec.h.

◆ n_acks_received_

uint8_t esphome::hdmi_cec::HDMICEC::n_acks_received_ {0}

protected

Definition at line 202 of file hdmi_cec.h.

◆ n_bytes_received_

uint8_t esphome::hdmi_cec::HDMICEC::n_bytes_received_ {0}

protected

Definition at line 201 of file hdmi_cec.h.

◆ pin_

InternalGPIOPin* esphome::hdmi_cec::HDMICEC::pin_

protected

Definition at line 180 of file hdmi_cec.h.

◆ prev_pin_level_

bool esphome::hdmi_cec::HDMICEC::prev_pin_level_ {true}

protected

Definition at line 211 of file hdmi_cec.h.

◆ promiscuous_mode_

bool esphome::hdmi_cec::HDMICEC::promiscuous_mode_ {false}

protected

Definition at line 214 of file hdmi_cec.h.

◆ QUEUE_SIZE

size_t esphome::hdmi_cec::HDMICEC::QUEUE_SIZE = 4

staticconstexprprotected

Definition at line 168 of file hdmi_cec.h.

◆ receiver_state_

ReceiverState esphome::hdmi_cec::HDMICEC::receiver_state_ {ReceiverState::RECEIVER_STATE_IDLE}

protected

Definition at line 208 of file hdmi_cec.h.

◆ recv_ack_queued_

bool esphome::hdmi_cec::HDMICEC::recv_ack_queued_ {false}

protected

Definition at line 210 of file hdmi_cec.h.

◆ recv_bit_counter_

uint8_t esphome::hdmi_cec::HDMICEC::recv_bit_counter_ {0}

protected

Definition at line 171 of file hdmi_cec.h.

◆ recv_byte_

uint8_t esphome::hdmi_cec::HDMICEC::recv_byte_ {0}

protected

Definition at line 172 of file hdmi_cec.h.

◆ recv_eom_

bool esphome::hdmi_cec::HDMICEC::recv_eom_ {false}

protected

Definition at line 209 of file hdmi_cec.h.

◆ recv_frame_

Frame* esphome::hdmi_cec::HDMICEC::recv_frame_ {nullptr}

protected

Definition at line 191 of file hdmi_cec.h.

◆ recv_header_

uint8_t esphome::hdmi_cec::HDMICEC::recv_header_ {0}

protected

Definition at line 206 of file hdmi_cec.h.

◆ recv_length_

uint8_t esphome::hdmi_cec::HDMICEC::recv_length_ {0}

protected

Definition at line 207 of file hdmi_cec.h.

◆ reported_dropped_frames_

uint8_t esphome::hdmi_cec::HDMICEC::reported_dropped_frames_ {0}

protected

Definition at line 175 of file hdmi_cec.h.

◆ required_idle_period_

uint16_t esphome::hdmi_cec::HDMICEC::required_idle_period_ {0}

protected

Definition at line 194 of file hdmi_cec.h.

◆ send_queue_

FrameRingBuffer<QUEUE_SIZE> esphome::hdmi_cec::HDMICEC::send_queue_

protected

Definition at line 173 of file hdmi_cec.h.

◆ transmit_attempts_

uint8_t esphome::hdmi_cec::HDMICEC::transmit_attempts_ {0}

protected

Definition at line 174 of file hdmi_cec.h.

◆ transmitting_

bool esphome::hdmi_cec::HDMICEC::transmitting_ {false}

protected

Definition at line 203 of file hdmi_cec.h.

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

esphome/components/hdmi_cec/hdmi_cec.h
esphome/components/hdmi_cec/hdmi_cec.cpp

Public Member Functions

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ ReceiverState

Constructor & Destructor Documentation

◆ HDMICEC()

Member Function Documentation

◆ ack_timer_isr_s() [1/3]

◆ ack_timer_isr_s() [2/3]

◆ ack_timer_isr_s() [3/3]

◆ add_on_message_callback()

◆ dump_config()

◆ finish_attempt_()

◆ gpio_isr_()

◆ gpio_isr_s()

◆ loop()

◆ reset_receiver_()

◆ send() [1/3]

◆ send() [2/3]

◆ send() [3/3]

◆ send_ack_()

◆ send_bit_()

◆ send_start_bit_()

◆ set_monitor_mode()

◆ set_pin_input_high_()

◆ set_pin_output_low_()

◆ set_promiscuous_mode()

◆ setup()

◆ setup_ack_timer_()

◆ start_ack_timer_()

◆ transmit_frame_()

◆ transmit_message_()

Field Documentation

◆ ack_alarm_

◆ ack_timer_

◆ address_

◆ dropped_frames_

◆ eom_received_

◆ frames_queue_

◆ isr_pin_

◆ last_attempt_us_

◆ last_edge_us_

◆ last_falling_edge_us_

◆ message_callbacks_

◆ monitor_mode_

◆ n_acks_received_

◆ n_bytes_received_

◆ pin_

◆ prev_pin_level_

◆ promiscuous_mode_

◆ QUEUE_SIZE

◆ receiver_state_

◆ recv_ack_queued_

◆ recv_bit_counter_

◆ recv_byte_

◆ recv_eom_

◆ recv_frame_

◆ recv_header_

◆ recv_length_

◆ reported_dropped_frames_

◆ required_idle_period_

◆ send_queue_

◆ transmit_attempts_

◆ transmitting_