#include <pn7160_spi.h>

Inheritance diagram for esphome::pn7160_spi::PN7160Spi:

Public Member Functions
void	setup () override

void	dump_config () override

Public Member Functions inherited from esphome::pn7160::PN7160
void	loop () override

void	set_dwl_req_pin (GPIOPin *dwl_req_pin)

void	set_irq_pin (GPIOPin *irq_pin)

void	set_ven_pin (GPIOPin *ven_pin)

void	set_wkup_req_pin (GPIOPin *wkup_req_pin)

void	set_tag_ttl (uint32_t ttl)

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

void	set_tag_emulation_message (const optional< std::string > &message, optional< bool > include_android_app_record)

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)

void	add_on_emulated_tag_scan_callback (std::function< void()> callback)

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

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

void	set_tag_write_message (optional< std::string > message, optional< bool > include_android_app_record)

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)

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.

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.

virtual void	mark_failed ()
	Mark this component as failed.

void	mark_failed (const char *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 (const char *message=nullptr)

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

Public Member Functions inherited from esphome::spi::SPIDevice< spi::BIT_ORDER_MSB_FIRST, spi::CLOCK_POLARITY_LOW, spi::CLOCK_PHASE_LEADING, spi::DATA_RATE_4MHZ >
	SPIDevice ()

	SPIDevice (SPIComponent parent, GPIOPin cs_pin)

void	spi_setup () override

void	spi_teardown () override

void	set_spi_parent (SPIComponent *parent)

void	set_cs_pin (GPIOPin *cs)

void	set_data_rate (uint32_t data_rate)

void	set_bit_order (SPIBitOrder order)

void	set_mode (SPIMode mode)

uint8_t	read_byte ()

void	read_array (uint8_t *data, size_t length)

void	write (uint16_t data, size_t num_bits)
	Write a single data item, up to 32 bits.

void	write_cmd_addr_data (size_t cmd_bits, uint32_t cmd, size_t addr_bits, uint32_t address, const uint8_t *data, size_t length, uint8_t bus_width=1)

void	write_byte (uint8_t data)

void	transfer_array (uint8_t *data, size_t length)
	Write the array data, replace with received data.

void	transfer_array (std::array< uint8_t, N > &data)

uint8_t	transfer_byte (uint8_t data)

void	write_byte16 (uint16_t data)
	Write 16 bit data.

void	write_array16 (const uint16_t *data, size_t length)
	Write an array of data as 16 bit values, byte-swapping if required.

void	enable ()

void	disable ()

void	write_array (const uint8_t *data, size_t length)

void	write_array (const std::array< uint8_t, N > &data)

void	write_array (const std::vector< uint8_t > &data)

Public Member Functions inherited from esphome::spi::SPIClient
	SPIClient (SPIBitOrder bit_order, SPIMode mode, uint32_t data_rate)

bool	spi_is_ready ()

void	set_release_device (bool release)

void	set_write_only (bool write_only)

Protected Member Functions
uint8_t	read_nfcc (nfc::NciMessage &rx, uint16_t timeout) override

uint8_t	write_nfcc (nfc::NciMessage &tx) override

Protected Member Functions inherited from esphome::pn7160::PN7160
uint8_t	reset_core_ (bool reset_config, bool power)

uint8_t	init_core_ ()

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_ (nfc::NfcTag &tag)

uint8_t	clean_endpoint_ (std::vector< uint8_t > &uid)

uint8_t	format_endpoint_ (std::vector< uint8_t > &uid)

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

std::unique_ptr< nfc::NfcTag >	build_tag_ (uint8_t mode_tech, const std::vector< uint8_t > &data)

optional< size_t >	find_tag_uid_ (const std::vector< uint8_t > &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::vector< uint8_t > &response, std::vector< uint8_t > &ndef_response)

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

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

uint8_t	write_mifare_classic_block_ (uint8_t block_num, std::vector< uint8_t > &data)

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

uint8_t	find_mifare_ultralight_ndef_ (const std::vector< 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, std::vector< uint8_t > &write_data)

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

uint8_t	clean_mifare_ultralight_ ()

Protected Member Functions inherited from esphome::Component
virtual void	call_loop ()

virtual void	call_setup ()

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 (const std::string &name, uint32_t interval, std::function< void()> &&f)
	Set an interval function with a unique name.

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 interval, std::function< void()> &&f)

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

bool	cancel_interval (const char *name)

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.

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.

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

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 timeout, std::function< void()> &&f)

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

bool	cancel_timeout (const char *name)

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

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.

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

Additional Inherited Members
Protected Types inherited from esphome::pn7160::PN7160
enum	NfcTask : uint8_t { EP_READ = 0 , EP_CLEAN , EP_FORMAT , EP_WRITE }

Protected Attributes inherited from esphome::pn7160::PN7160
enum esphome::pn7160::PN7160::NfcTask	EP_READ

bool	config_refresh_pending_ {false}

bool	core_config_is_solo_ {false}

bool	listening_enabled_ {false}

bool	polling_enabled_ {true}

uint8_t	error_count_ {0}

uint8_t	fail_count_ {0}

uint32_t	last_nci_state_change_ {0}

uint8_t	selecting_endpoint_ {0}

uint32_t	tag_ttl_ {250}

GPIOPin *	dwl_req_pin_ {nullptr}

GPIOPin *	irq_pin_ {nullptr}

GPIOPin *	ven_pin_ {nullptr}

GPIOPin *	wkup_req_pin_ {nullptr}

CallbackManager< void()>	on_emulated_tag_scan_callback_

CallbackManager< void()>	on_finished_write_callback_

std::vector< DiscoveredEndpoint >	discovered_endpoint_

CardEmulationState	ce_state_ {CardEmulationState::CARD_EMU_IDLE}

NCIState	nci_state_ {NCIState::NFCC_RESET}

NCIState	nci_state_error_ {NCIState::NONE}

std::shared_ptr< nfc::NdefMessage >	card_emulation_message_

std::shared_ptr< nfc::NdefMessage >	next_task_message_to_write_

std::vector< nfc::NfcOnTagTrigger * >	triggers_ontag_

std::vector< nfc::NfcOnTagTrigger * >	triggers_ontagremoved_

Protected Attributes inherited from esphome::nfc::Nfcc
std::vector< NfcTagListener * >	tag_listeners_

Protected Attributes inherited from esphome::Component
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.

Protected Attributes inherited from esphome::spi::SPIClient
SPIBitOrder	bit_order_ {BIT_ORDER_MSB_FIRST}

SPIMode	mode_ {MODE0}

uint32_t	data_rate_ {1000000}

SPIComponent *	parent_ {nullptr}

GPIOPin *	cs_ {nullptr}

bool	release_device_ {false}

bool	write_only_ {false}

SPIDelegate *	delegate_ {SPIDelegate::NULL_DELEGATE}

Detailed Description

Definition at line 16 of file pn7160_spi.h.

Member Function Documentation

◆ dump_config()

void esphome::pn7160_spi::PN7160Spi::dump_config ( )

overridevirtual

Reimplemented from esphome::pn7160::PN7160.

Definition at line 48 of file pn7160_spi.cpp.

◆ read_nfcc()

uint8_t esphome::pn7160_spi::PN7160Spi::read_nfcc	(	nfc::NciMessage &	rx,
		uint16_t	timeout )

overrideprotectedvirtual

Implements esphome::pn7160::PN7160.

Definition at line 15 of file pn7160_spi.cpp.

◆ setup()

void esphome::pn7160_spi::PN7160Spi::setup ( )

overridevirtual

Reimplemented from esphome::pn7160::PN7160.

Definition at line 9 of file pn7160_spi.cpp.

◆ write_nfcc()

uint8_t esphome::pn7160_spi::PN7160Spi::write_nfcc ( nfc::NciMessage & tx )

overrideprotectedvirtual

Implements esphome::pn7160::PN7160.

Definition at line 40 of file pn7160_spi.cpp.

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

esphome/components/pn7160_spi/pn7160_spi.h
esphome/components/pn7160_spi/pn7160_spi.cpp

Public Member Functions