ESPHome 2026.2.1
Loading...
Searching...
No Matches
Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes
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)
 
void add_on_finished_write_callback (std::function< void()> 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.
 
virtual 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)
 
virtual float get_loop_priority () const
 priority of loop().
 
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.
 
virtual void mark_failed ()
 Mark this component as failed.
 
 ESPDEPRECATED ("Use mark_failed(LOG_STR(\"static string literal\")) instead. Do NOT use .c_str() from temporary " "strings. Will stop working in 2026.6.0", "2025.12.0") void mark_failed(const char *message)
 
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 (const char *message=nullptr)
 
void status_set_warning (const LogString *message)
 
void status_set_error ()
 
 ESPDEPRECATED ("Use status_set_error(LOG_STR(\"static string literal\")) instead. Do NOT use .c_str() from temporary " "strings. Will stop working in 2026.6.0", "2025.12.0") void status_set_error(const char *message)
 
void status_set_error (const LogString *message)
 
void status_clear_warning ()
 
void status_clear_error ()
 
void status_momentary_warning (const char *name, uint32_t length=5000)
 Set warning status flag and automatically clear it after a timeout.
 
void status_momentary_error (const char *name, uint32_t length=5000)
 Set error status flag and automatically clear it after a timeout.
 
bool has_overridden_loop () const
 
void set_component_source (const LogString *source)
 Set where this component was loaded from for some debug messages.
 
const LogString * get_component_log_str () const
 Get the integration where this component was declared as a LogString for logging.
 
bool should_warn_of_blocking (uint32_t blocking_time)
 

Protected Types

enum  NfcTask { READ = 0 , CLEAN , FORMAT , WRITE }
 
enum  PN532Error { NONE = 0 , WAKEUP_FAILED , SAM_COMMAND_FAILED }
 

Protected Member Functions

void turn_off_rf_ ()
 
bool write_command_ (const std::vector< 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 (const std::vector< uint8_t > &data)=0
 
virtual bool read_data (std::vector< uint8_t > &data, uint8_t len)=0
 
virtual bool read_response (uint8_t command, std::vector< uint8_t > &data)=0
 
std::unique_ptr< nfc::NfcTag > read_tag_ (nfc::NfcTagUid &uid)
 
bool format_tag_ (nfc::NfcTagUid &uid)
 
bool clean_tag_ (nfc::NfcTagUid &uid)
 
bool write_tag_ (nfc::NfcTagUid &uid, nfc::NdefMessage *message)
 
std::unique_ptr< nfc::NfcTag > read_mifare_classic_tag_ (nfc::NfcTagUid &uid)
 
bool read_mifare_classic_block_ (uint8_t block_num, std::vector< uint8_t > &data)
 
bool write_mifare_classic_block_ (uint8_t block_num, std::vector< 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, uint16_t num_bytes, std::vector< uint8_t > &data)
 
bool is_mifare_ultralight_formatted_ (const std::vector< uint8_t > &page_3_to_6)
 
uint16_t read_mifare_ultralight_capacity_ ()
 
bool find_mifare_ultralight_ndef_ (const std::vector< uint8_t > &page_3_to_6, uint8_t &message_length, uint8_t &message_start_index)
 
bool write_mifare_ultralight_page_ (uint8_t page_num, std::vector< 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
virtual void call_loop ()
 
virtual void call_dump_config ()
 
void set_component_state_ (uint8_t state)
 Helper to set component state (clears state bits and sets new state)
 
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 (uint32_t id)
 
bool cancel_interval (InternalSchedulerID id)
 
ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std ESPDEPRECATED ("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const char *name
 
 ESPDEPRECATED ("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(uint32_t id
 
 ESPDEPRECATED ("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(uint32_t initial_wait_time
 
ESPDEPRECATED("cancel_retry is deprecated and will be removed in 2026.8.0.", "2026.2.0") bool cancel_retry(const std ESPDEPRECATED ("cancel_retry is deprecated and will be removed in 2026.8.0.", "2026.2.0") bool cancel_retry(const char *name)
 
 ESPDEPRECATED ("cancel_retry is deprecated and will be removed in 2026.8.0.", "2026.2.0") bool cancel_retry(uint32_t id)
 
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 (uint32_t id)
 
bool cancel_timeout (InternalSchedulerID id)
 
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 (uint32_t id)
 

Protected Attributes

bool updates_enabled_ {true}
 
bool requested_read_ {false}
 
std::vector< PN532BinarySensor * > binary_sensors_
 
std::vector< nfc::NfcOnTagTrigger * > triggers_ontag_
 
std::vector< nfc::NfcOnTagTrigger * > triggers_ontagremoved_
 
nfc::NfcTagUid current_uid_
 
nfc::NdefMessage * next_task_message_to_write_
 
uint32_t rd_start_time_ {0}
 
enum esphome::pn532::PN532::NfcTask READ
 
enum esphome::pn532::PN532::PN532Error NONE
 
CallbackManager< void()> on_finished_write_callback_
 
- Protected Attributes inherited from esphome::PollingComponent
uint32_t update_interval_
 
- Protected Attributes inherited from esphome::Component
ESPDEPRECATED("Use const char* or uint32_t overload instead. Removed in 2026.7.0", "2026.1.0") void set_interval(const std voi set_interval )(const char *name, uint32_t interval, std::function< void()> &&f)
 Set an interval function with a unique name.
 
ESPDEPRECATED("Use const char* or uint32_t overload instead. Removed in 2026.7.0", "2026.1.0") bool cancel_interval(const std boo cancel_interval )(const char *name)
 Cancel an interval function.
 
ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std uint32_t initial_wait_time
 
ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std uint32_t uint8_t max_attempts
 
ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std uint32_t uint8_t std::function< RetryResult(uint8_t)> && f
 
ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std uint32_t uint8_t std::function< RetryResult(uint8_t)> float backoff_increase_factor = 1.0f)
 
uint32_t initial_wait_time
 
uint32_t uint8_t max_attempts
 
uint32_t uint8_t std::function< RetryResult(uint8_t)> && f
 
uint32_t uint8_t std::function< RetryResult(uint8_t)> float backoff_increase_factor = 1.0f)
 
uint8_t max_attempts
 
uint8_t std::function< RetryResult(uint8_t)> && f
 
uint8_t std::function< RetryResult(uint8_t)> float backoff_increase_factor = 1.0f)
 
ESPDEPRECATED("Use const char* or uint32_t overload instead. Removed in 2026.7.0", "2026.1.0") void set_timeout(const std voi set_timeout )(const char *name, uint32_t timeout, std::function< void()> &&f)
 Set a timeout function with a unique name.
 
ESPDEPRECATED("Use const char* or uint32_t overload instead. Removed in 2026.7.0", "2026.1.0") bool cancel_timeout(const std boo cancel_timeout )(const char *name)
 Cancel a timeout function.
 
ESPDEPRECATED("Use const char* overload instead. Removed in 2026.7.0", "2026.1.0") void defer(const std voi defer )(const char *name, std::function< void()> &&f)
 Defer a callback to the next loop() call.
 
ESPDEPRECATED("Use const char* overload instead. Removed in 2026.7.0", "2026.1.0") bool cancel_defer(const std boo cancel_defer )(const char *name)
 Cancel a defer callback using the specified name, name must not be empty.
 
const LogString * component_source_ {nullptr}
 
uint16_t warn_if_blocking_over_ {WARN_IF_BLOCKING_OVER_MS}
 Warn if blocked for this many ms (max 65.5s)
 
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 Bits 5-7: Unused - reserved for future expansion.
 
volatile bool pending_enable_loop_ {false}
 ISR-safe flag for enable_loop_soon_any_context.
 

Detailed Description

Definition at line 31 of file pn532.h.

Member Enumeration Documentation

◆ NfcTask

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

Definition at line 104 of file pn532.h.

◆ PN532Error

enum esphome::pn532::PN532::PN532Error
protected
Enumerator
NONE 
WAKEUP_FAILED 
SAM_COMMAND_FAILED 

Definition at line 110 of file pn532.h.

Member Function Documentation

◆ add_on_finished_write_callback()

void esphome::pn532::PN532::add_on_finished_write_callback ( std::function< void()> callback)
inline

Definition at line 46 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 85 of file pn532_mifare_classic.cpp.

◆ clean_mifare_ultralight_()

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

Definition at line 156 of file pn532_mifare_ultralight.cpp.

◆ clean_mode()

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

Definition at line 382 of file pn532.cpp.

◆ clean_tag_()

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

Definition at line 396 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 429 of file pn532.cpp.

◆ find_mifare_ultralight_ndef_()

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

Definition at line 97 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 108 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 143 of file pn532_mifare_classic.cpp.

◆ format_mode()

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

Definition at line 386 of file pn532.cpp.

◆ format_tag_()

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

Definition at line 407 of file pn532.cpp.

◆ is_mifare_ultralight_formatted_()

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

Definition at line 80 of file pn532_mifare_ultralight.cpp.

◆ is_read_ready()

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

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

◆ is_writing()

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

Definition at line 50 of file pn532.h.

◆ loop()

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

Reimplemented from esphome::Component.

Definition at line 126 of file pn532.cpp.

◆ on_powerdown()

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

Reimplemented from esphome::Component.

Definition at line 40 of file pn532.h.

◆ powerdown()

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

Definition at line 84 of file pn532.cpp.

◆ read_ack_()

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

Definition at line 284 of file pn532.cpp.

◆ read_data()

virtual bool esphome::pn532::PN532::read_data ( std::vector< uint8_t > & data,
uint8_t len )
protectedpure virtual

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,
std::vector< uint8_t > & data )
protected

Definition at line 65 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 11 of file pn532_mifare_classic.cpp.

◆ read_mifare_ultralight_bytes_()

bool esphome::pn532::PN532::read_mifare_ultralight_bytes_ ( uint8_t start_page,
uint16_t num_bytes,
std::vector< uint8_t > & data )
protected

Definition at line 49 of file pn532_mifare_ultralight.cpp.

◆ read_mifare_ultralight_capacity_()

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

Definition at line 88 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 11 of file pn532_mifare_ultralight.cpp.

◆ read_mode()

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

Definition at line 378 of file pn532.cpp.

◆ read_ready_()

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

Definition at line 311 of file pn532.cpp.

◆ read_response()

virtual bool esphome::pn532::PN532::read_response ( uint8_t command,
std::vector< uint8_t > & data )
protectedpure virtual

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

Definition at line 361 of file pn532.cpp.

◆ register_ontag_trigger()

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

Definition at line 43 of file pn532.h.

◆ register_ontagremoved_trigger()

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

Definition at line 44 of file pn532.h.

◆ register_tag()

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

Definition at line 42 of file pn532.h.

◆ send_ack_()

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

Definition at line 300 of file pn532.cpp.

◆ send_nack_()

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

Definition at line 305 of file pn532.cpp.

◆ setup()

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

Reimplemented from esphome::Component.

Reimplemented in esphome::pn532_spi::PN532Spi.

Definition at line 17 of file pn532.cpp.

◆ turn_off_rf_()

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

Definition at line 352 of file pn532.cpp.

◆ update()

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

Implements esphome::PollingComponent.

Definition at line 106 of file pn532.cpp.

◆ write_command_()

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

Definition at line 247 of file pn532.cpp.

◆ write_data()

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

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

◆ write_mifare_classic_block_()

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

Definition at line 196 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 218 of file pn532_mifare_classic.cpp.

◆ write_mifare_ultralight_page_()

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

Definition at line 170 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 117 of file pn532_mifare_ultralight.cpp.

◆ write_mode()

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

Definition at line 390 of file pn532.cpp.

◆ write_tag_()

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

Definition at line 418 of file pn532.cpp.

Field Documentation

◆ binary_sensors_

std::vector<PN532BinarySensor *> esphome::pn532::PN532::binary_sensors_
protected

Definition at line 97 of file pn532.h.

◆ current_uid_

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

Definition at line 100 of file pn532.h.

◆ next_task_message_to_write_

nfc::NdefMessage* esphome::pn532::PN532::next_task_message_to_write_
protected

Definition at line 101 of file pn532.h.

◆ NONE

enum esphome::pn532::PN532::PN532Error esphome::pn532::PN532::NONE
protected

◆ on_finished_write_callback_

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

Definition at line 115 of file pn532.h.

◆ rd_start_time_

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

Definition at line 102 of file pn532.h.

◆ READ

enum esphome::pn532::PN532::NfcTask esphome::pn532::PN532::READ
protected

◆ requested_read_

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

Definition at line 96 of file pn532.h.

◆ triggers_ontag_

std::vector<nfc::NfcOnTagTrigger *> esphome::pn532::PN532::triggers_ontag_
protected

Definition at line 98 of file pn532.h.

◆ triggers_ontagremoved_

std::vector<nfc::NfcOnTagTrigger *> esphome::pn532::PN532::triggers_ontagremoved_
protected

Definition at line 99 of file pn532.h.

◆ updates_enabled_

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

Definition at line 95 of file pn532.h.

The documentation for this class was generated from the following files:
Generated by doxygen 1.12.0