#include <st25r.h>

Inheritance diagram for esphome::st25r::ST25R:

Public Types
enum	State : uint8_t { STATE_IDLE , STATE_FIELD_ON , STATE_WUPA , STATE_ANTICOL }

Public Member Functions
void	setup () override

void	dump_config () override

void	update () override

void	loop () override

void	set_reset_pin (GPIOPin *reset_pin)

void	set_irq_pin (InternalGPIOPin *irq_pin)

void	set_rf_power (uint8_t power)

template<typename F >
void	add_on_tag_callback (F &&callback)

template<typename F >
void	add_on_tag_removed_callback (F &&callback)

Public Member Functions inherited from esphome::PollingComponent
	PollingComponent ()

	PollingComponent (uint32_t update_interval)
	Initialize this polling component with the given update interval in ms.

void	set_update_interval (uint32_t update_interval)
	Manually set the update interval in ms for this polling object.

void	call_setup () override

virtual uint32_t	get_update_interval () const
	Get the update interval in ms of this sensor.

void	start_poller ()

void	stop_poller ()

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)

bool	status_comm_result (bool ok)
	Clears the warning when `ok`, else sets it with `message` (default "Communication failed"); returns `ok`.

bool	status_comm_result (bool ok, 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)

Public Member Functions inherited from esphome::nfc::Nfcc
void	register_listener (NfcTagListener *listener)

Protected Member Functions
virtual uint8_t	read_register (uint8_t reg)=0

virtual void	write_register (uint8_t reg, uint8_t value)=0

virtual void	write_command (uint8_t command)=0

virtual void	write_fifo (const uint8_t *data, size_t len)=0

virtual void	read_fifo (uint8_t *data, size_t len)=0

bool	reset_chip_ ()

void	pulse_reset_ ()

void	clear_irqs_ ()

void	write_register_table_ (const uint8_t(*table)[2], size_t count)

void	field_on_ ()

void	send_anticol_frame_ ()

bool	transceive_ex_ (const uint8_t data, size_t len, uint8_t resp, uint8_t resp_cap, uint8_t &resp_len, uint32_t timeout_ms)

void	process_state_ ()

void	finish_scan_ ()

void	finalize_scan_ ()

void	remove_tag_ ()

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.

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	isr (ST25R *arg)

Protected Attributes
GPIOPin *	reset_pin_ {nullptr}

InternalGPIOPin *	irq_pin_ {nullptr}

std::unique_ptr< nfc::NfcTag >	current_tag_

nfc::NfcTagUid	scan_uid_

uint32_t	last_state_change_ {0}

State	state_ {STATE_IDLE}

uint8_t	rf_power_ {15}

uint8_t	miss_count_ {0}

uint8_t	irq_status_ {0}

uint8_t	cascade_level_ {0}

bool	tag_found_this_scan_ {false}

volatile bool	irq_fired_ {false}

LazyCallbackManager< void(const std::string &, const nfc::NfcTag &)>	on_tag_callback_

LazyCallbackManager< void(const std::string &, const nfc::NfcTag &)>	on_tag_removed_callback_

Protected Attributes inherited from esphome::PollingComponent
uint32_t	update_interval_

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_

Protected Attributes inherited from esphome::nfc::Nfcc
StaticVector< NfcTagListener *, NFC_TAG_LISTENER_COUNT >	tag_listeners_

Static Protected Attributes
static constexpr uint8_t	MISS_THRESHOLD = 3

static constexpr uint32_t	FIELD_GUARD_MS = 10

static constexpr uint8_t	IRQ_RXE = 0x10

static constexpr uint8_t	IRQ_TXE = 0x08

static constexpr uint8_t	IRQ_COL = 0x04

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

Detailed Description

Definition at line 67 of file st25r.h.

Member Enumeration Documentation

◆ State

enum esphome::st25r::ST25R::State : uint8_t

Enumerator
STATE_IDLE
STATE_FIELD_ON
STATE_WUPA
STATE_ANTICOL

Definition at line 69 of file st25r.h.

Member Function Documentation

◆ add_on_tag_callback()

template<typename F >

void esphome::st25r::ST25R::add_on_tag_callback ( F && callback )

inline

Definition at line 85 of file st25r.h.

◆ add_on_tag_removed_callback()

template<typename F >

void esphome::st25r::ST25R::add_on_tag_removed_callback ( F && callback )

inline

Definition at line 86 of file st25r.h.

◆ clear_irqs_()

void esphome::st25r::ST25R::clear_irqs_ ( )

protected

Definition at line 100 of file st25r.cpp.

◆ dump_config()

void esphome::st25r::ST25R::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Reimplemented in esphome::st25r_spi::ST25RSpi.

Definition at line 382 of file st25r.cpp.

◆ field_on_()

void esphome::st25r::ST25R::field_on_ ( )

protected

Definition at line 373 of file st25r.cpp.

◆ finalize_scan_()

void esphome::st25r::ST25R::finalize_scan_ ( )

protected

Definition at line 274 of file st25r.cpp.

◆ finish_scan_()

void esphome::st25r::ST25R::finish_scan_ ( )

protected

Definition at line 266 of file st25r.cpp.

◆ isr()

void IRAM_ATTR esphome::st25r::ST25R::isr ( ST25R * arg )

staticprotected

Definition at line 41 of file st25r.cpp.

◆ loop()

void esphome::st25r::ST25R::loop ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 74 of file st25r.cpp.

◆ process_state_()

void esphome::st25r::ST25R::process_state_ ( )

protected

Definition at line 153 of file st25r.cpp.

◆ pulse_reset_()

void esphome::st25r::ST25R::pulse_reset_ ( )

protected

Definition at line 93 of file st25r.cpp.

◆ read_fifo()

virtual void esphome::st25r::ST25R::read_fifo	(	uint8_t *	data,
		size_t	len )

protectedpure virtual

Implemented in esphome::st25r_spi::ST25RSpi.

◆ read_register()

virtual uint8_t esphome::st25r::ST25R::read_register ( uint8_t reg )

protectedpure virtual

Implemented in esphome::st25r_spi::ST25RSpi.

◆ remove_tag_()

void esphome::st25r::ST25R::remove_tag_ ( )

protected

Definition at line 303 of file st25r.cpp.

◆ reset_chip_()

bool esphome::st25r::ST25R::reset_chip_ ( )

protected

Definition at line 316 of file st25r.cpp.

◆ send_anticol_frame_()

void esphome::st25r::ST25R::send_anticol_frame_ ( )

protected

Definition at line 362 of file st25r.cpp.

◆ set_irq_pin()

void esphome::st25r::ST25R::set_irq_pin ( InternalGPIOPin * irq_pin )

inline

Definition at line 82 of file st25r.h.

◆ set_reset_pin()

void esphome::st25r::ST25R::set_reset_pin ( GPIOPin * reset_pin )

inline

Definition at line 81 of file st25r.h.

◆ set_rf_power()

void esphome::st25r::ST25R::set_rf_power ( uint8_t power )

inline

Definition at line 83 of file st25r.h.

◆ setup()

void esphome::st25r::ST25R::setup ( )

overridevirtual

Reimplemented from esphome::Component.

Reimplemented in esphome::st25r_spi::ST25RSpi.

Definition at line 46 of file st25r.cpp.

◆ transceive_ex_()

bool esphome::st25r::ST25R::transceive_ex_	(	const uint8_t *	data,
		size_t	len,
		uint8_t *	resp,
		uint8_t	resp_cap,
		uint8_t &	resp_len,
		uint32_t	timeout_ms )

protected

Definition at line 112 of file st25r.cpp.

◆ update()

void esphome::st25r::ST25R::update ( )

overridevirtual

Implements esphome::PollingComponent.

Definition at line 61 of file st25r.cpp.

◆ write_command()

virtual void esphome::st25r::ST25R::write_command ( uint8_t command )

protectedpure virtual

Implemented in esphome::st25r_spi::ST25RSpi.

◆ write_fifo()

virtual void esphome::st25r::ST25R::write_fifo	(	const uint8_t *	data,
		size_t	len )

protectedpure virtual

Implemented in esphome::st25r_spi::ST25RSpi.

◆ write_register()

virtual void esphome::st25r::ST25R::write_register	(	uint8_t	reg,
		uint8_t	value )

protectedpure virtual

Implemented in esphome::st25r_spi::ST25RSpi.

◆ write_register_table_()

void esphome::st25r::ST25R::write_register_table_	(	const uint8_t(*)	table[2],
		size_t	count )

protected

Definition at line 107 of file st25r.cpp.

Field Documentation

◆ cascade_level_

uint8_t esphome::st25r::ST25R::cascade_level_ {0}

protected

Definition at line 130 of file st25r.h.

◆ current_tag_

std::unique_ptr<nfc::NfcTag> esphome::st25r::ST25R::current_tag_

protected

Definition at line 123 of file st25r.h.

◆ FIELD_GUARD_MS

uint32_t esphome::st25r::ST25R::FIELD_GUARD_MS = 10

staticconstexprprotected

Definition at line 116 of file st25r.h.

◆ IRQ_COL

uint8_t esphome::st25r::ST25R::IRQ_COL = 0x04

staticconstexprprotected

Definition at line 121 of file st25r.h.

◆ irq_fired_

volatile bool esphome::st25r::ST25R::irq_fired_ {false}

protected

Definition at line 132 of file st25r.h.

◆ irq_pin_

InternalGPIOPin* esphome::st25r::ST25R::irq_pin_ {nullptr}

protected

Definition at line 112 of file st25r.h.

◆ IRQ_RXE

uint8_t esphome::st25r::ST25R::IRQ_RXE = 0x10

staticconstexprprotected

Definition at line 119 of file st25r.h.

◆ irq_status_

uint8_t esphome::st25r::ST25R::irq_status_ {0}

protected

Definition at line 129 of file st25r.h.

◆ IRQ_TXE

uint8_t esphome::st25r::ST25R::IRQ_TXE = 0x08

staticconstexprprotected

Definition at line 120 of file st25r.h.

◆ last_state_change_

uint32_t esphome::st25r::ST25R::last_state_change_ {0}

protected

Definition at line 125 of file st25r.h.

◆ miss_count_

uint8_t esphome::st25r::ST25R::miss_count_ {0}

protected

Definition at line 128 of file st25r.h.

◆ MISS_THRESHOLD

uint8_t esphome::st25r::ST25R::MISS_THRESHOLD = 3

staticconstexprprotected

Definition at line 115 of file st25r.h.

◆ on_tag_callback_

LazyCallbackManager<void(const std::string &, const nfc::NfcTag &)> esphome::st25r::ST25R::on_tag_callback_

protected

Definition at line 134 of file st25r.h.

◆ on_tag_removed_callback_

LazyCallbackManager<void(const std::string &, const nfc::NfcTag &)> esphome::st25r::ST25R::on_tag_removed_callback_

protected

Definition at line 135 of file st25r.h.

◆ reset_pin_

GPIOPin* esphome::st25r::ST25R::reset_pin_ {nullptr}

protected

Definition at line 111 of file st25r.h.

◆ rf_power_

uint8_t esphome::st25r::ST25R::rf_power_ {15}

protected

Definition at line 127 of file st25r.h.

◆ scan_uid_

nfc::NfcTagUid esphome::st25r::ST25R::scan_uid_

protected

Definition at line 124 of file st25r.h.

◆ state_

State esphome::st25r::ST25R::state_ {STATE_IDLE}

protected

Definition at line 126 of file st25r.h.

◆ tag_found_this_scan_

bool esphome::st25r::ST25R::tag_found_this_scan_ {false}

protected

Definition at line 131 of file st25r.h.

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

esphome/components/st25r/st25r.h
esphome/components/st25r/st25r.cpp

Public Types

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ State

Member Function Documentation

◆ add_on_tag_callback()

◆ add_on_tag_removed_callback()

◆ clear_irqs_()

◆ dump_config()

◆ field_on_()

◆ finalize_scan_()

◆ finish_scan_()

◆ isr()

◆ loop()

◆ process_state_()

◆ pulse_reset_()

◆ read_fifo()

◆ read_register()

◆ remove_tag_()

◆ reset_chip_()

◆ send_anticol_frame_()

◆ set_irq_pin()

◆ set_reset_pin()

◆ set_rf_power()

◆ setup()

◆ transceive_ex_()

◆ update()

◆ write_command()

◆ write_fifo()

◆ write_register()

◆ write_register_table_()

Field Documentation

◆ cascade_level_

◆ current_tag_

◆ FIELD_GUARD_MS

◆ IRQ_COL

◆ irq_fired_

◆ irq_pin_

◆ IRQ_RXE

◆ irq_status_

◆ IRQ_TXE

◆ last_state_change_

◆ miss_count_

◆ MISS_THRESHOLD

◆ on_tag_callback_

◆ on_tag_removed_callback_

◆ reset_pin_

◆ rf_power_

◆ scan_uid_

◆ state_

◆ tag_found_this_scan_