#include <pn532_i2c.h>

Inheritance diagram for esphome::pn532_i2c::PN532I2C:

Public Member Functions
void	dump_config () override

Public Member Functions inherited from esphome::pn532::PN532
void	setup () override

void	update () override

void	loop () override

void	on_powerdown () override

void	register_tag (PN532BinarySensor *tag)

void	register_ontag_trigger (nfc::NfcOnTagTrigger *trig)

void	register_ontagremoved_trigger (nfc::NfcOnTagTrigger *trig)

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 (nfc::NdefMessage *message)

bool	powerdown ()

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.

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::i2c::I2CDevice
	I2CDevice ()=default
	we use the C++ default constructor

void	set_i2c_address (uint8_t address)
	We store the address of the device on the bus.

uint8_t	get_i2c_address () const
	Returns the I2C address of the object.

void	set_i2c_bus (I2CBus *bus)
	we store the pointer to the I2CBus to use

I2CRegister	reg (uint8_t a_register)
	calls the I2CRegister constructor

I2CRegister16	reg16 (uint16_t a_register)
	calls the I2CRegister16 constructor

ErrorCode	read (uint8_t *data, size_t len) const
	reads an array of bytes from the device using an I2CBus

ErrorCode	read_register (uint8_t a_register, uint8_t *data, size_t len)
	reads an array of bytes from a specific register in the I²C device

ErrorCode	read_register16 (uint16_t a_register, uint8_t *data, size_t len)
	reads an array of bytes from a specific register in the I²C device

ErrorCode	write (const uint8_t *data, size_t len) const
	writes an array of bytes to a device using an I2CBus

ErrorCode	write_read (const uint8_t write_data, size_t write_len, uint8_t read_data, size_t read_len) const
	writes an array of bytes to a device, then reads an array, as a single transaction

ErrorCode	write_register (uint8_t a_register, const uint8_t *data, size_t len) const
	writes an array of bytes to a specific register in the I²C device

ErrorCode	write_register16 (uint16_t a_register, const uint8_t *data, size_t len) const
	write an array of bytes to a specific register in the I²C device

bool	write_registers (const I2CRegValue *table, size_t count) const
	Write each register and value of `table` in order, stopping at the first failure.

template<size_t N>
bool	write_registers (const I2CRegValue(&table)[N]) const

bool	check_chip_id (Component *component, uint8_t a_register, uint8_t expected, uint8_t mask=0xFF)
	Read the 8-bit ID at `a_register` and accept it when it matches `expected` in the bits set in `mask`.

bool	read_bytes (uint8_t a_register, uint8_t *data, uint8_t len)
	Compat APIs All methods below have been added for compatibility reasons.

bool	read_bytes_raw (uint8_t *data, uint8_t len) const

template<size_t N>
optional< std::array< uint8_t, N > >	read_bytes (uint8_t a_register)

template<size_t N>
optional< std::array< uint8_t, N > >	read_bytes_raw ()

bool	read_bytes_16 (uint8_t a_register, uint16_t *data, uint8_t len)

bool	read_byte (uint8_t a_register, uint8_t *data)

optional< uint8_t >	read_byte (uint8_t a_register)

bool	read_byte_16 (uint8_t a_register, uint16_t *data)

bool	read_bytes_16_le (uint8_t a_register, uint16_t *data, uint8_t len)
	Read len 16-bit values stored least significant byte first; no conversion is compiled on little-endian hosts.

bool	read_bytes_16_le (uint8_t a_register, int16_t *data, uint8_t len)

bool	read_byte_16_le (uint8_t a_register, uint16_t *data)
	Read a 16-bit value stored least significant byte first.

bool	write_bytes (uint8_t a_register, const uint8_t *data, uint8_t len) const

bool	write_bytes (uint8_t a_register, const std::vector< uint8_t > &data) const

template<size_t N>
bool	write_bytes (uint8_t a_register, const std::array< uint8_t, N > &data)

bool	write_bytes_16 (uint8_t a_register, const uint16_t *data, uint8_t len) const

bool	write_byte (uint8_t a_register, uint8_t data) const

bool	write_byte_16 (uint8_t a_register, uint16_t data) const

bool	write_byte_16_le (uint8_t a_register, uint16_t data) const
	Write a 16-bit value least significant byte first.

bool	update_register (uint8_t a_register, uint8_t mask, uint8_t value)
	Read a register, replace the bits in `mask` with those of `value` and write it back.

Protected Member Functions
bool	is_read_ready () override

bool	write_data (std::span< const uint8_t > data) override

bool	read_data (pn532::PN532Frame &data, size_t len) override

bool	read_response (uint8_t command, pn532::PN532Frame &data) override

uint8_t	read_response_length_ ()

Protected Member Functions inherited from esphome::pn532::PN532
void	turn_off_rf_ ()

bool	write_command_ (std::span< const uint8_t > data)

bool	write_command_ (std::initializer_list< uint8_t > data)

bool	read_ack_ ()

void	send_ack_ ()

void	send_nack_ ()

enum PN532ReadReady	read_ready_ (bool block)

std::unique_ptr< nfc::NfcTag >	read_tag_ (nfc::NfcTagUid &uid, uint8_t tag_type)

bool	format_tag_ (nfc::NfcTagUid &uid, uint8_t tag_type)

bool	clean_tag_ (nfc::NfcTagUid &uid, uint8_t tag_type)

bool	write_tag_ (nfc::NfcTagUid &uid, uint8_t tag_type, nfc::NdefMessage *message)

bool	in_data_exchange_ (std::span< const uint8_t > command, PN532Frame &response)
	Sends an InDataExchange command and reads the response; returns false unless the status byte reports success.

bool	in_data_exchange_ (std::initializer_list< uint8_t > command, PN532Frame &response)

bool	mifare_read_ (uint8_t address, MifareReadData &data)
	Sends MIFARE READ for `address` and returns the 16 bytes the tag answers with.

std::unique_ptr< nfc::NfcTag >	read_mifare_classic_tag_ (nfc::NfcTagUid &uid)

bool	read_mifare_classic_block_ (uint8_t block_num, MifareReadData &data)

bool	write_mifare_classic_block_ (uint8_t block_num, std::span< const uint8_t > data)

bool	auth_mifare_classic_block_ (nfc::NfcTagUid &uid, uint8_t block_num, uint8_t key_num, const uint8_t *key)

bool	format_mifare_classic_mifare_ (nfc::NfcTagUid &uid)

bool	format_mifare_classic_ndef_ (nfc::NfcTagUid &uid)

bool	write_mifare_classic_tag_ (nfc::NfcTagUid &uid, nfc::NdefMessage *message)

std::unique_ptr< nfc::NfcTag >	read_mifare_ultralight_tag_ (nfc::NfcTagUid &uid)

bool	read_mifare_ultralight_bytes_ (uint8_t start_page, std::span< uint8_t > data)
	Fills `data` with the bytes from `start_page` onward.

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

uint16_t	read_mifare_ultralight_capacity_ ()

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

bool	write_mifare_ultralight_page_ (uint8_t page_num, std::span< const uint8_t > write_data)

bool	write_mifare_ultralight_tag_ (nfc::NfcTagUid &uid, nfc::NdefMessage *message)

bool	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.

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::pn532::PN532
enum	NfcTask : uint8_t { READ = 0 , CLEAN , FORMAT , WRITE }

Protected Attributes inherited from esphome::pn532::PN532
LazyCallbackManager< void()>	on_finished_write_callback_

StaticVector< PN532BinarySensor *, PN532_BINARY_SENSOR_COUNT >	binary_sensors_

StaticVector< nfc::NfcOnTagTrigger *, PN532_ON_TAG_TRIGGER_COUNT >	triggers_ontag_

StaticVector< nfc::NfcOnTagTrigger *, PN532_ON_TAG_REMOVED_TRIGGER_COUNT >	triggers_ontagremoved_

std::unique_ptr< nfc::NdefMessage >	next_task_message_to_write_

nfc::NfcTagUid	current_uid_

uint32_t	rd_start_time_ {0}

PN532ReadReady	rd_ready_ {WOULDBLOCK}

NfcTask	next_task_ {READ}

bool	rd_started_ {false}

bool	updates_enabled_ {true}

bool	requested_read_ {false}

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::i2c::I2CDevice
I2CBus *	bus_ {nullptr}
	pointer to I2CBus instance

uint8_t	address_ {0x00}
	store the address of the device on the bus

Detailed Description

Definition at line 11 of file pn532_i2c.h.

Member Function Documentation

◆ dump_config()

void esphome::pn532_i2c::PN532I2C::dump_config ( )

overridevirtual

Reimplemented from esphome::pn532::PN532.

Definition at line 124 of file pn532_i2c.cpp.

◆ is_read_ready()

bool esphome::pn532_i2c::PN532I2C::is_read_ready ( )

overrideprotectedvirtual

Implements esphome::pn532::PN532.

Definition at line 16 of file pn532_i2c.cpp.

◆ read_data()

bool esphome::pn532_i2c::PN532I2C::read_data	(	pn532::PN532Frame &	data,
		size_t	len )

overrideprotectedvirtual

Implements esphome::pn532::PN532.

Definition at line 29 of file pn532_i2c.cpp.

◆ read_response()

bool esphome::pn532_i2c::PN532I2C::read_response	(	uint8_t	command,
		pn532::PN532Frame &	data )

overrideprotectedvirtual

Implements esphome::pn532::PN532.

Definition at line 44 of file pn532_i2c.cpp.

◆ read_response_length_()

uint8_t esphome::pn532_i2c::PN532I2C::read_response_length_ ( )

protected

Definition at line 93 of file pn532_i2c.cpp.

◆ write_data()

bool esphome::pn532_i2c::PN532I2C::write_data ( std::span< const uint8_t > data )

overrideprotectedvirtual

Implements esphome::pn532::PN532.

Definition at line 25 of file pn532_i2c.cpp.

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

esphome/components/pn532_i2c/pn532_i2c.h
esphome/components/pn532_i2c/pn532_i2c.cpp

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ dump_config()

◆ is_read_ready()

◆ read_data()

◆ read_response()

◆ read_response_length_()

◆ write_data()