#include <pn7150.h>

Inheritance diagram for esphome::pn7150::PN7150:

Public Member Functions
void	dump_config () override

Public Member Functions inherited from esphome::pn71xx::PN71xx
void	setup () override

void	dump_config () override

void	loop () override

void	set_irq_pin (GPIOPin *irq_pin)

void	set_ven_pin (GPIOPin *ven_pin)

void	set_tag_ttl (uint32_t ttl)

void	set_tag_emulation_message (const std::shared_ptr< nfc::NdefMessage > &message)

void	set_tag_emulation_message (const std::string &message, bool include_android_app_record=true)

void	set_tag_emulation_message (const char *message, bool include_android_app_record=true)

void	set_tag_emulation_off ()

void	set_tag_emulation_on ()

bool	tag_emulation_enabled ()

void	set_polling_off ()

void	set_polling_on ()

bool	polling_enabled ()

void	register_ontag_trigger (nfc::NfcOnTagTrigger *trig)

void	register_ontagremoved_trigger (nfc::NfcOnTagTrigger *trig)

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

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

bool	is_writing ()

void	read_mode ()

void	clean_mode ()

void	format_mode ()

void	write_mode ()

void	set_tag_write_message (std::shared_ptr< nfc::NdefMessage > message)

void	set_tag_write_message (const std::string &message, bool include_android_app_record=true)

uint8_t	set_test_mode (TestMode test_mode, const std::vector< uint8_t > &data, std::vector< uint8_t > &result)

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

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)

Protected Member Functions
uint8_t	verify_reset (nfc::NciMessage &rx, bool reset_config) override

uint8_t	process_init_response (nfc::NciMessage &rx) override

std::span< const uint8_t >	pmu_config () const override

std::span< const uint8_t >	listen_mode_routing_config () const override

Protected Member Functions inherited from esphome::pn71xx::PN71xx
uint8_t	reset_core_ (bool reset_config, bool power)

uint8_t	init_core_ ()

virtual void	prepare_reset ()
	Chip hooks Called before the NFCC is reset, e.g.

uint8_t	send_init_config_ ()

uint8_t	send_core_config_ ()

uint8_t	refresh_core_config_ ()

uint8_t	set_discover_map_ ()

uint8_t	set_listen_mode_routing_ ()

uint8_t	start_discovery_ ()

uint8_t	stop_discovery_ ()

uint8_t	deactivate_ (uint8_t type, uint16_t timeout=NFCC_DEFAULT_TIMEOUT)

void	select_endpoint_ ()

uint8_t	read_endpoint_data_ (uint8_t protocol, nfc::NfcTag &tag)

uint8_t	clean_endpoint_ (uint8_t protocol)

uint8_t	format_endpoint_ (uint8_t protocol)

uint8_t	write_endpoint_ (uint8_t protocol, nfc::NfcTagUid &uid, std::shared_ptr< nfc::NdefMessage > &message)

bool	parse_uid_ (uint8_t mode_tech, std::span< const uint8_t > rf_tech_params, nfc::NfcTagUid &uid)
	Reads the UID from the RF technology parameters of a discovery or activation notification.

std::unique_ptr< nfc::NfcTag >	build_tag_ (uint8_t protocol, const nfc::NfcTagUid &uid)

size_t	find_or_add_tag_ (uint8_t protocol, const nfc::NfcTagUid &uid)
	Finds a cached endpoint by UID, or caches a new one, evicting the entry seen longest ago if the cache is full.

optional< size_t >	find_tag_uid_ (const nfc::NfcTagUid &uid)

void	purge_old_tags_ ()

void	erase_tag_ (uint8_t tag_index)

void	nci_fsm_transition_ ()
	advance controller state as required

void	nci_fsm_set_state_ (NCIState new_state)
	set new controller state

bool	nci_fsm_set_error_state_ (NCIState new_state)
	setting controller to this state caused an error; returns true if too many errors/failures

void	process_message_ ()
	parse & process incoming messages from the NFCC

void	process_rf_intf_activated_oid_ (nfc::NciMessage &rx)

void	process_rf_discover_oid_ (nfc::NciMessage &rx)

void	process_rf_deactivate_oid_ (nfc::NciMessage &rx)

void	process_data_message_ (nfc::NciMessage &rx)

void	card_emu_t4t_get_response_ (std::span< const uint8_t > response, CardEmuResponse &ndef_response)

bool	card_emu_t4t_read_ndef_ (uint16_t offset, uint8_t length, CardEmuResponse &ndef_response)

uint8_t	transceive_ (nfc::NciMessage &tx, nfc::NciMessage &rx, uint16_t timeout=NFCC_DEFAULT_TIMEOUT, bool expect_notification=true)

virtual uint8_t	read_nfcc (nfc::NciMessage &rx, uint16_t timeout)=0

virtual uint8_t	write_nfcc (nfc::NciMessage &tx)=0

uint8_t	wait_for_irq_ (uint16_t timeout=NFCC_DEFAULT_TIMEOUT, bool pin_state=true)

uint8_t	read_mifare_classic_tag_ (nfc::NfcTag &tag)

uint8_t	read_mifare_classic_block_ (uint8_t block_num, std::array< uint8_t, nfc::MIFARE_CLASSIC_BLOCK_SIZE > &data)

uint8_t	write_mifare_classic_block_ (uint8_t block_num, const uint8_t *data, size_t len)

uint8_t	auth_mifare_classic_block_ (uint8_t block_num, uint8_t key_num, const uint8_t *key)

uint8_t	sect_to_auth_ (uint8_t block_num)

uint8_t	format_mifare_classic_mifare_ ()

uint8_t	format_mifare_classic_ndef_ ()

uint8_t	write_mifare_classic_tag_ (const std::shared_ptr< nfc::NdefMessage > &message)

uint8_t	halt_mifare_classic_tag_ ()

uint8_t	read_mifare_ultralight_tag_ (nfc::NfcTag &tag)

uint8_t	read_mifare_ultralight_bytes_ (uint8_t start_page, uint16_t num_bytes, UltralightReadBuffer &data)

bool	is_mifare_ultralight_formatted_ (std::span< const uint8_t > page_3_to_6)

uint16_t	read_mifare_ultralight_capacity_ ()

uint8_t	find_mifare_ultralight_ndef_ (std::span< const uint8_t > page_3_to_6, uint8_t &message_length, uint8_t &message_start_index)

uint8_t	write_mifare_ultralight_page_ (uint8_t page_num, const uint8_t *write_data, size_t len)

uint8_t	write_mifare_ultralight_tag_ (nfc::NfcTagUid &uid, const std::shared_ptr< nfc::NdefMessage > &message)

uint8_t	clean_mifare_ultralight_ ()

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

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

Protected Types inherited from esphome::pn71xx::PN71xx
enum	NfcTask : uint8_t { EP_READ = 0 , EP_CLEAN , EP_FORMAT , EP_WRITE }

Protected Attributes inherited from esphome::pn71xx::PN71xx
LazyCallbackManager< void()>	on_emulated_tag_scan_callback_

LazyCallbackManager< void()>	on_finished_write_callback_

StaticVector< DiscoveredEndpoint, MAX_DISCOVERED_ENDPOINTS >	discovered_endpoint_

FixedVector< uint8_t >	card_emulation_ndef_

StaticVector< nfc::NfcOnTagTrigger *, PN71XX_ON_TAG_TRIGGER_COUNT >	triggers_ontag_

StaticVector< nfc::NfcOnTagTrigger *, PN71XX_ON_TAG_REMOVED_TRIGGER_COUNT >	triggers_ontagremoved_

std::shared_ptr< nfc::NdefMessage >	next_task_message_to_write_

GPIOPin *	irq_pin_ {nullptr}

GPIOPin *	ven_pin_ {nullptr}

uint32_t	last_nci_state_change_ {0}

uint32_t	tag_ttl_ {250}

NfcTask	next_task_ {EP_READ}

CardEmulationState	ce_state_ {CardEmulationState::CARD_EMU_IDLE}

NCIState	nci_state_ {NCIState::NFCC_RESET}

NCIState	nci_state_error_ {NCIState::NONE}

uint8_t	error_count_ {0}

uint8_t	selecting_endpoint_ {0}

bool	config_refresh_pending_ {false}

bool	core_config_is_solo_ {false}

bool	listening_enabled_ {false}

bool	polling_enabled_ {true}

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

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_

Detailed Description

Definition at line 24 of file pn7150.h.

Member Function Documentation

◆ dump_config()

void esphome::pn7150::PN7150::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Reimplemented in esphome::pn7150_i2c::PN7150I2C.

Definition at line 9 of file pn7150.cpp.

◆ listen_mode_routing_config()

std::span< const uint8_t > esphome::pn7150::PN7150::listen_mode_routing_config ( ) const

inlineoverrideprotectedvirtual

Implements esphome::pn71xx::PN71xx.

Definition at line 32 of file pn7150.h.

◆ pmu_config()

std::span< const uint8_t > esphome::pn7150::PN7150::pmu_config ( ) const

inlineoverrideprotectedvirtual

Implements esphome::pn71xx::PN71xx.

Definition at line 31 of file pn7150.h.

◆ process_init_response()

uint8_t esphome::pn7150::PN7150::process_init_response ( nfc::NciMessage & rx )

overrideprotectedvirtual

Implements esphome::pn71xx::PN71xx.

Definition at line 31 of file pn7150.cpp.

◆ verify_reset()

uint8_t esphome::pn7150::PN7150::verify_reset	(	nfc::NciMessage &	rx,
		bool	reset_config )

overrideprotectedvirtual

Implements esphome::pn71xx::PN71xx.

Definition at line 14 of file pn7150.cpp.

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

esphome/components/pn7150/pn7150.h
esphome/components/pn7150/pn7150.cpp

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ dump_config()

◆ listen_mode_routing_config()

◆ pmu_config()

◆ process_init_response()

◆ verify_reset()