ESPHome  2024.11.1
Public Member Functions | Protected Member Functions
esphome::pn7160_spi::PN7160Spi Class Reference

#include <pn7160_spi.h>

Inheritance diagram for esphome::pn7160_spi::PN7160Spi:
esphome::pn7160::PN7160 esphome::spi::SPIDevice< spi::BIT_ORDER_MSB_FIRST, spi::CLOCK_POLARITY_LOW, spi::CLOCK_PHASE_LEADING, spi::DATA_RATE_4MHZ > esphome::nfc::Nfcc esphome::Component esphome::spi::SPIClient

Public Member Functions

void setup () override
 
void dump_config () override
 
- Public Member Functions inherited from esphome::pn7160::PN7160
float get_setup_priority () const override
 
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
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_shutdown ()
 
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...
 
- 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. More...
 
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. More...
 
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. More...
 
void write_array16 (const uint16_t *data, size_t length)
 Write an array of data as 16 bit values, byte-swapping if required. More...
 
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 ()
 

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::NfcTagbuild_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 More...
 
void nci_fsm_set_state_ (NCIState new_state)
 set new controller state More...
 
bool nci_fsm_set_error_state_ (NCIState new_state)
 setting controller to this state caused an error; returns true if too many errors/failures More...
 
void process_message_ ()
 parse & process incoming messages from the NFCC More...
 
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_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...
 

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}
 
GPIOPindwl_req_pin_ {nullptr}
 
GPIOPinirq_pin_ {nullptr}
 
GPIOPinven_pin_ {nullptr}
 
GPIOPinwkup_req_pin_ {nullptr}
 
CallbackManager< void()> on_emulated_tag_scan_callback_
 
CallbackManager< void()> on_finished_write_callback_
 
std::vector< DiscoveredEndpointdiscovered_endpoint_
 
CardEmulationState ce_state_ {CardEmulationState::CARD_EMU_IDLE}
 
NCIState nci_state_ {NCIState::NFCC_RESET}
 
NCIState nci_state_error_ {NCIState::NONE}
 
std::shared_ptr< nfc::NdefMessagecard_emulation_message_
 
std::shared_ptr< nfc::NdefMessagenext_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
uint32_t component_state_ {0x0000}
 State of this component. More...
 
float setup_priority_override_ {NAN}
 
const char * component_source_ {nullptr}
 
- Protected Attributes inherited from esphome::spi::SPIClient
SPIBitOrder bit_order_ {BIT_ORDER_MSB_FIRST}
 
SPIMode mode_ {MODE0}
 
uint32_t data_rate_ {1000000}
 
SPIComponentparent_ {nullptr}
 
GPIOPincs_ {nullptr}
 
SPIDelegatedelegate_ {nullptr}
 

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: