#include <pn532.h>

Inheritance diagram for esphome::pn532::PN532:

Public Member Functions
void	setup () override

void	dump_config () override

void	update () override

float	get_setup_priority () const override

void	loop () override

void	on_shutdown () 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. More...

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

void	call_setup () override

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

void	start_poller ()

void	stop_poller ()

Public Member Functions inherited from esphome::Component
float	get_actual_setup_priority () const

void	set_setup_priority (float priority)

virtual float	get_loop_priority () const
	priority of loop(). More...

void	call ()

virtual void	on_safe_shutdown ()

uint32_t	get_component_state () const

virtual void	mark_failed ()
	Mark this component as failed. More...

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="unspecified")

void	status_set_error (const char *message="unspecified")

void	status_clear_warning ()

void	status_clear_error ()

void	status_momentary_warning (const std::string &name, uint32_t length=5000)

void	status_momentary_error (const std::string &name, uint32_t length=5000)

bool	has_overridden_loop () const

void	set_component_source (const char *source)
	Set where this component was loaded from for some debug messages. More...

const char *	get_component_source () const
	Get the integration where this component was declared as a string. More...

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_ (std::vector< uint8_t > &uid)

bool	format_tag_ (std::vector< uint8_t > &uid)

bool	clean_tag_ (std::vector< uint8_t > &uid)

bool	write_tag_ (std::vector< uint8_t > &uid, nfc::NdefMessage *message)

std::unique_ptr< nfc::NfcTag >	read_mifare_classic_tag_ (std::vector< uint8_t > &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_ (std::vector< uint8_t > &uid, uint8_t block_num, uint8_t key_num, const uint8_t *key)

bool	format_mifare_classic_mifare_ (std::vector< uint8_t > &uid)

bool	format_mifare_classic_ndef_ (std::vector< uint8_t > &uid)

bool	write_mifare_classic_tag_ (std::vector< uint8_t > &uid, nfc::NdefMessage *message)

std::unique_ptr< nfc::NfcTag >	read_mifare_ultralight_tag_ (std::vector< uint8_t > &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_ (std::vector< uint8_t > &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_interval (const std::string &name, uint32_t interval, std::function< void()> &&f)
	Set an interval function with a unique name. More...

void	set_interval (uint32_t interval, std::function< void()> &&f)

bool	cancel_interval (const std::string &name)
	Cancel an interval function. More...

void	set_retry (const std::string &name, uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult(uint8_t)> &&f, float backoff_increase_factor=1.0f)
	Set an retry function with a unique name. More...

void	set_retry (uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult(uint8_t)> &&f, float backoff_increase_factor=1.0f)

bool	cancel_retry (const std::string &name)
	Cancel a retry function. More...

void	set_timeout (const std::string &name, uint32_t timeout, std::function< void()> &&f)
	Set a timeout function with a unique name. More...

void	set_timeout (uint32_t timeout, std::function< void()> &&f)

bool	cancel_timeout (const std::string &name)
	Cancel a timeout function. More...

void	defer (const std::string &name, std::function< void()> &&f)
	Defer a callback to the next loop() call. More...

void	defer (std::function< void()> &&f)
	Defer a callback to the next loop() call. More...

bool	cancel_defer (const std::string &name)
	Cancel a defer callback using the specified name, name must not be empty. More...

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_

std::vector< uint8_t >	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
uint32_t	component_state_ {0x0000}
	State of this component. More...

float	setup_priority_override_ {NAN}

const char *	component_source_ {nullptr}

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 105 of file pn532.h.

◆ PN532Error

enum esphome::pn532::PN532::PN532Error

protected

Enumerator
NONE
WAKEUP_FAILED
SAM_COMMAND_FAILED

Definition at line 111 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 47 of file pn532.h.

◆ auth_mifare_classic_block_()

bool esphome::pn532::PN532::auth_mifare_classic_block_	(	std::vector< uint8_t > &	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 155 of file pn532_mifare_ultralight.cpp.

◆ clean_mode()

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

Definition at line 381 of file pn532.cpp.

◆ clean_tag_()

bool esphome::pn532::PN532::clean_tag_ ( std::vector< uint8_t > & uid )

protected

Definition at line 395 of file pn532.cpp.

◆ dump_config()

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

overridevirtual

Reimplemented from esphome::Component.

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

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

◆ format_mifare_classic_mifare_()

bool esphome::pn532::PN532::format_mifare_classic_mifare_ ( std::vector< uint8_t > & uid )

protected

Definition at line 108 of file pn532_mifare_classic.cpp.

◆ format_mifare_classic_ndef_()

bool esphome::pn532::PN532::format_mifare_classic_ndef_ ( std::vector< uint8_t > & uid )

protected

Definition at line 143 of file pn532_mifare_classic.cpp.

◆ format_mode()

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

Definition at line 385 of file pn532.cpp.

◆ format_tag_()

bool esphome::pn532::PN532::format_tag_ ( std::vector< uint8_t > & uid )

protected

Definition at line 406 of file pn532.cpp.

◆ get_setup_priority()

float esphome::pn532::PN532::get_setup_priority ( ) const

overridevirtual

Reimplemented from esphome::Component.

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

◆ is_read_ready()

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

protectedpure virtual

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

◆ is_writing()

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

inline

Definition at line 51 of file pn532.h.

◆ loop()

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

overridevirtual

Reimplemented from esphome::Component.

Definition at line 126 of file pn532.cpp.

◆ on_shutdown()

void esphome::pn532::PN532::on_shutdown ( )

inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 41 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 283 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_spi::PN532Spi, and esphome::pn532_i2c::PN532I2C.

◆ 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_ ( std::vector< uint8_t > & 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 87 of file pn532_mifare_ultralight.cpp.

◆ read_mifare_ultralight_tag_()

std::unique_ptr< nfc::NfcTag > esphome::pn532::PN532::read_mifare_ultralight_tag_ ( std::vector< uint8_t > & uid )

protected

Definition at line 11 of file pn532_mifare_ultralight.cpp.

◆ read_mode()

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

Definition at line 377 of file pn532.cpp.

◆ read_ready_()

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

protected

Definition at line 310 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_spi::PN532Spi, and esphome::pn532_i2c::PN532I2C.

◆ read_tag_()

std::unique_ptr< nfc::NfcTag > esphome::pn532::PN532::read_tag_ ( std::vector< uint8_t > & uid )

protected

Definition at line 360 of file pn532.cpp.

◆ register_ontag_trigger()

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

inline

Definition at line 44 of file pn532.h.

◆ register_ontagremoved_trigger()

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

inline

Definition at line 45 of file pn532.h.

◆ register_tag()

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

inline

Definition at line 43 of file pn532.h.

◆ send_ack_()

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

protected

Definition at line 299 of file pn532.cpp.

◆ send_nack_()

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

protected

Definition at line 304 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 351 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 246 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_spi::PN532Spi, and esphome::pn532_i2c::PN532I2C.

◆ 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_	(	std::vector< uint8_t > &	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 169 of file pn532_mifare_ultralight.cpp.

◆ write_mifare_ultralight_tag_()

bool esphome::pn532::PN532::write_mifare_ultralight_tag_	(	std::vector< uint8_t > &	uid,
		nfc::NdefMessage *	message
	)

protected

Definition at line 116 of file pn532_mifare_ultralight.cpp.

◆ write_mode()

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

Definition at line 389 of file pn532.cpp.

◆ write_tag_()

bool esphome::pn532::PN532::write_tag_	(	std::vector< uint8_t > &	uid,
		nfc::NdefMessage *	message
	)

protected

Definition at line 417 of file pn532.cpp.

Field Documentation

◆ binary_sensors_

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

protected

Definition at line 98 of file pn532.h.

◆ current_uid_

std::vector<uint8_t> esphome::pn532::PN532::current_uid_

protected

Definition at line 101 of file pn532.h.

◆ next_task_message_to_write_

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

protected

Definition at line 102 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 116 of file pn532.h.

◆ rd_start_time_

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

protected

Definition at line 103 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 97 of file pn532.h.

◆ triggers_ontag_

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

protected

Definition at line 99 of file pn532.h.

◆ triggers_ontagremoved_

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

protected

Definition at line 100 of file pn532.h.

◆ updates_enabled_

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

protected

Definition at line 96 of file pn532.h.

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

/opt/build/esphome/esphome/components/pn532/pn532.h
/opt/build/esphome/esphome/components/pn532/pn532.cpp
/opt/build/esphome/esphome/components/pn532/pn532_mifare_classic.cpp
/opt/build/esphome/esphome/components/pn532/pn532_mifare_ultralight.cpp

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ NfcTask

◆ PN532Error

Member Function Documentation

◆ add_on_finished_write_callback()

◆ auth_mifare_classic_block_()

◆ clean_mifare_ultralight_()

◆ clean_mode()

◆ clean_tag_()

◆ dump_config()

◆ find_mifare_ultralight_ndef_()

◆ format_mifare_classic_mifare_()

◆ format_mifare_classic_ndef_()

◆ format_mode()

◆ format_tag_()

◆ get_setup_priority()

◆ is_mifare_ultralight_formatted_()

◆ is_read_ready()

◆ is_writing()

◆ loop()

◆ on_shutdown()

◆ powerdown()

◆ read_ack_()

◆ read_data()

◆ read_mifare_classic_block_()

◆ read_mifare_classic_tag_()

◆ read_mifare_ultralight_bytes_()

◆ read_mifare_ultralight_capacity_()

◆ read_mifare_ultralight_tag_()

◆ read_mode()

◆ read_ready_()

◆ read_response()

◆ read_tag_()

◆ register_ontag_trigger()

◆ register_ontagremoved_trigger()

◆ register_tag()

◆ send_ack_()

◆ send_nack_()

◆ setup()

◆ turn_off_rf_()

◆ update()

◆ write_command_()

◆ write_data()

◆ write_mifare_classic_block_()

◆ write_mifare_classic_tag_()

◆ write_mifare_ultralight_page_()

◆ write_mifare_ultralight_tag_()

◆ write_mode()

◆ write_tag_()

Field Documentation

◆ binary_sensors_

◆ current_uid_

◆ next_task_message_to_write_

◆ NONE

◆ on_finished_write_callback_

◆ rd_start_time_

◆ READ

◆ requested_read_

◆ triggers_ontag_

◆ triggers_ontagremoved_

◆ updates_enabled_