ESPHome 2026.11.0-dev
Loading...
Searching...
No Matches
esphome::pn532::PN532 Class Referenceabstract

#include <pn532.h>

Inheritance diagram for esphome::pn532::PN532:
esphome::PollingComponent esphome::Component esphome::pn532_i2c::PN532I2C esphome::pn532_spi::PN532Spi

Public Member Functions

void setup () override
 
void dump_config () 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)
 

Protected Types

enum  NfcTask : uint8_t { READ = 0 , CLEAN , FORMAT , WRITE }
 

Protected Member Functions

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)
 
virtual bool is_read_ready ()=0
 
virtual bool write_data (std::span< const uint8_t > data)=0
 
virtual bool read_data (PN532Frame &data, size_t len)=0
 Reads len frame bytes into data behind a leading status byte, so every bus presents the I2C layout.
 
virtual bool read_response (uint8_t command, PN532Frame &data)=0
 Reads the response to command; on success data holds only the bytes that follow the response code.
 
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_ ()
 

Protected Attributes

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_
 

Additional Inherited Members

- Data Fields inherited from esphome::Component
uint32_t length = 5000)
 

Detailed Description

Definition at line 65 of file pn532.h.

Member Enumeration Documentation

◆ NfcTask

enum esphome::pn532::PN532::NfcTask : uint8_t
protected
Enumerator
READ 
CLEAN 
FORMAT 
WRITE 

Definition at line 149 of file pn532.h.

Member Function Documentation

◆ add_on_finished_write_callback()

template<typename F >
void esphome::pn532::PN532::add_on_finished_write_callback ( F && callback)
inline

Definition at line 86 of file pn532.h.

◆ auth_mifare_classic_block_()

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

Definition at line 84 of file pn532_mifare_classic.cpp.

◆ clean_mifare_ultralight_()

bool esphome::pn532::PN532::clean_mifare_ultralight_ ( )
protected

Definition at line 175 of file pn532_mifare_ultralight.cpp.

◆ clean_mode()

void esphome::pn532::PN532::clean_mode ( )

Definition at line 396 of file pn532.cpp.

◆ clean_tag_()

bool esphome::pn532::PN532::clean_tag_ ( nfc::NfcTagUid & uid,
uint8_t tag_type )
protected

Definition at line 410 of file pn532.cpp.

◆ dump_config()

void esphome::pn532::PN532::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Reimplemented in esphome::pn532_i2c::PN532I2C, and esphome::pn532_spi::PN532Spi.

Definition at line 476 of file pn532.cpp.

◆ find_mifare_ultralight_ndef_()

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

Definition at line 112 of file pn532_mifare_ultralight.cpp.

◆ format_mifare_classic_mifare_()

bool esphome::pn532::PN532::format_mifare_classic_mifare_ ( nfc::NfcTagUid & uid)
protected

Definition at line 112 of file pn532_mifare_classic.cpp.

◆ format_mifare_classic_ndef_()

bool esphome::pn532::PN532::format_mifare_classic_ndef_ ( nfc::NfcTagUid & uid)
protected

Definition at line 147 of file pn532_mifare_classic.cpp.

◆ format_mode()

void esphome::pn532::PN532::format_mode ( )

Definition at line 400 of file pn532.cpp.

◆ format_tag_()

bool esphome::pn532::PN532::format_tag_ ( nfc::NfcTagUid & uid,
uint8_t tag_type )
protected

Definition at line 420 of file pn532.cpp.

◆ in_data_exchange_() [1/2]

bool esphome::pn532::PN532::in_data_exchange_ ( std::initializer_list< uint8_t > command,
PN532Frame & response )
inlineprotected

Definition at line 124 of file pn532.h.

◆ in_data_exchange_() [2/2]

bool esphome::pn532::PN532::in_data_exchange_ ( std::span< const uint8_t > command,
PN532Frame & response )
protected

Sends an InDataExchange command and reads the response; returns false unless the status byte reports success.

On success, response holds the data returned by the target, without the status byte.

Definition at line 440 of file pn532.cpp.

◆ is_mifare_ultralight_formatted_()

bool esphome::pn532::PN532::is_mifare_ultralight_formatted_ ( std::span< const uint8_t > page_3_to_6)
protected

Definition at line 95 of file pn532_mifare_ultralight.cpp.

◆ is_read_ready()

virtual bool esphome::pn532::PN532::is_read_ready ( )
protectedpure virtual

◆ is_writing()

bool esphome::pn532::PN532::is_writing ( )
inline

Definition at line 90 of file pn532.h.

◆ loop()

void esphome::pn532::PN532::loop ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 121 of file pn532.cpp.

◆ mifare_read_()

bool esphome::pn532::PN532::mifare_read_ ( uint8_t address,
MifareReadData & data )
protected

Sends MIFARE READ for address and returns the 16 bytes the tag answers with.

Definition at line 459 of file pn532.cpp.

◆ on_powerdown()

void esphome::pn532::PN532::on_powerdown ( )
inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 74 of file pn532.h.

◆ powerdown()

bool esphome::pn532::PN532::powerdown ( )

Definition at line 78 of file pn532.cpp.

◆ read_ack_()

bool esphome::pn532::PN532::read_ack_ ( )
protected

Definition at line 297 of file pn532.cpp.

◆ read_data()

virtual bool esphome::pn532::PN532::read_data ( PN532Frame & data,
size_t len )
protectedpure virtual

Reads len frame bytes into data behind a leading status byte, so every bus presents the I2C layout.

Implemented in esphome::pn532_i2c::PN532I2C, and esphome::pn532_spi::PN532Spi.

◆ read_mifare_classic_block_()

bool esphome::pn532::PN532::read_mifare_classic_block_ ( uint8_t block_num,
MifareReadData & data )
protected

Definition at line 74 of file pn532_mifare_classic.cpp.

◆ read_mifare_classic_tag_()

std::unique_ptr< nfc::NfcTag > esphome::pn532::PN532::read_mifare_classic_tag_ ( nfc::NfcTagUid & uid)
protected

Definition at line 13 of file pn532_mifare_classic.cpp.

◆ read_mifare_ultralight_bytes_()

bool esphome::pn532::PN532::read_mifare_ultralight_bytes_ ( uint8_t start_page,
std::span< uint8_t > data )
protected

Fills data with the bytes from start_page onward.

Definition at line 75 of file pn532_mifare_ultralight.cpp.

◆ read_mifare_ultralight_capacity_()

uint16_t esphome::pn532::PN532::read_mifare_ultralight_capacity_ ( )
protected

Definition at line 103 of file pn532_mifare_ultralight.cpp.

◆ read_mifare_ultralight_tag_()

std::unique_ptr< nfc::NfcTag > esphome::pn532::PN532::read_mifare_ultralight_tag_ ( nfc::NfcTagUid & uid)
protected

Definition at line 13 of file pn532_mifare_ultralight.cpp.

◆ read_mode()

void esphome::pn532::PN532::read_mode ( )

Definition at line 392 of file pn532.cpp.

◆ read_ready_()

enum PN532ReadReady esphome::pn532::PN532::read_ready_ ( bool block)
protected

Definition at line 326 of file pn532.cpp.

◆ read_response()

virtual bool esphome::pn532::PN532::read_response ( uint8_t command,
PN532Frame & data )
protectedpure virtual

Reads the response to command; on success data holds only the bytes that follow the response code.

Implemented in esphome::pn532_i2c::PN532I2C, and esphome::pn532_spi::PN532Spi.

◆ read_tag_()

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

Definition at line 380 of file pn532.cpp.

◆ register_ontag_trigger()

void esphome::pn532::PN532::register_ontag_trigger ( nfc::NfcOnTagTrigger * trig)
inline

Definition at line 80 of file pn532.h.

◆ register_ontagremoved_trigger()

void esphome::pn532::PN532::register_ontagremoved_trigger ( nfc::NfcOnTagTrigger * trig)
inline

Definition at line 83 of file pn532.h.

◆ register_tag()

void esphome::pn532::PN532::register_tag ( PN532BinarySensor * tag)
inline

Definition at line 77 of file pn532.h.

◆ send_ack_()

void esphome::pn532::PN532::send_ack_ ( )
protected

Definition at line 313 of file pn532.cpp.

◆ send_nack_()

void esphome::pn532::PN532::send_nack_ ( )
protected

Definition at line 319 of file pn532.cpp.

◆ setup()

void esphome::pn532::PN532::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Reimplemented in esphome::pn532_spi::PN532Spi.

Definition at line 19 of file pn532.cpp.

◆ turn_off_rf_()

void esphome::pn532::PN532::turn_off_rf_ ( )
protected

Definition at line 371 of file pn532.cpp.

◆ update()

void esphome::pn532::PN532::update ( )
overridevirtual

Implements esphome::PollingComponent.

Definition at line 100 of file pn532.cpp.

◆ write_command_() [1/2]

bool esphome::pn532::PN532::write_command_ ( std::initializer_list< uint8_t > data)
inlineprotected

Definition at line 101 of file pn532.h.

◆ write_command_() [2/2]

bool esphome::pn532::PN532::write_command_ ( std::span< const uint8_t > data)
protected

Definition at line 257 of file pn532.cpp.

◆ write_data()

virtual bool esphome::pn532::PN532::write_data ( std::span< const uint8_t > data)
protectedpure virtual

◆ write_mifare_classic_block_()

bool esphome::pn532::PN532::write_mifare_classic_block_ ( uint8_t block_num,
std::span< const uint8_t > data )
protected

Definition at line 207 of file pn532_mifare_classic.cpp.

◆ write_mifare_classic_tag_()

bool esphome::pn532::PN532::write_mifare_classic_tag_ ( nfc::NfcTagUid & uid,
nfc::NdefMessage * message )
protected

Definition at line 227 of file pn532_mifare_classic.cpp.

◆ write_mifare_ultralight_page_()

bool esphome::pn532::PN532::write_mifare_ultralight_page_ ( uint8_t page_num,
std::span< const uint8_t > write_data )
protected

Definition at line 189 of file pn532_mifare_ultralight.cpp.

◆ write_mifare_ultralight_tag_()

bool esphome::pn532::PN532::write_mifare_ultralight_tag_ ( nfc::NfcTagUid & uid,
nfc::NdefMessage * message )
protected

Definition at line 147 of file pn532_mifare_ultralight.cpp.

◆ write_mode()

void esphome::pn532::PN532::write_mode ( nfc::NdefMessage * message)

Definition at line 404 of file pn532.cpp.

◆ write_tag_()

bool esphome::pn532::PN532::write_tag_ ( nfc::NfcTagUid & uid,
uint8_t tag_type,
nfc::NdefMessage * message )
protected

Definition at line 430 of file pn532.cpp.

Field Documentation

◆ binary_sensors_

StaticVector<PN532BinarySensor *, PN532_BINARY_SENSOR_COUNT> esphome::pn532::PN532::binary_sensors_
protected

Definition at line 159 of file pn532.h.

◆ current_uid_

nfc::NfcTagUid esphome::pn532::PN532::current_uid_
protected

Definition at line 168 of file pn532.h.

◆ next_task_

NfcTask esphome::pn532::PN532::next_task_ {READ}
protected

Definition at line 171 of file pn532.h.

◆ next_task_message_to_write_

std::unique_ptr<nfc::NdefMessage> esphome::pn532::PN532::next_task_message_to_write_
protected

Definition at line 167 of file pn532.h.

◆ on_finished_write_callback_

LazyCallbackManager<void()> esphome::pn532::PN532::on_finished_write_callback_
protected

Definition at line 157 of file pn532.h.

◆ rd_ready_

PN532ReadReady esphome::pn532::PN532::rd_ready_ {WOULDBLOCK}
protected

Definition at line 170 of file pn532.h.

◆ rd_start_time_

uint32_t esphome::pn532::PN532::rd_start_time_ {0}
protected

Definition at line 169 of file pn532.h.

◆ rd_started_

bool esphome::pn532::PN532::rd_started_ {false}
protected

Definition at line 172 of file pn532.h.

◆ requested_read_

bool esphome::pn532::PN532::requested_read_ {false}
protected

Definition at line 174 of file pn532.h.

◆ triggers_ontag_

StaticVector<nfc::NfcOnTagTrigger *, PN532_ON_TAG_TRIGGER_COUNT> esphome::pn532::PN532::triggers_ontag_
protected

Definition at line 162 of file pn532.h.

◆ triggers_ontagremoved_

StaticVector<nfc::NfcOnTagTrigger *, PN532_ON_TAG_REMOVED_TRIGGER_COUNT> esphome::pn532::PN532::triggers_ontagremoved_
protected

Definition at line 165 of file pn532.h.

◆ updates_enabled_

bool esphome::pn532::PN532::updates_enabled_ {true}
protected

Definition at line 173 of file pn532.h.


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