ESPHome  2024.5.3
Public Member Functions | Protected Member Functions
esphome::pn7160_i2c::PN7160I2C Class Reference

#include <pn7160_i2c.h>

Inheritance diagram for esphome::pn7160_i2c::PN7160I2C:
esphome::pn7160::PN7160 esphome::i2c::I2CDevice esphome::nfc::Nfcc esphome::Component

Public Member Functions

void dump_config () override
 
- Public Member Functions inherited from esphome::pn7160::PN7160
void setup () override
 
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 ()
 
bool is_ready ()
 
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::i2c::I2CDevice
 I2CDevice ()=default
 we use the C++ default constructor More...
 
void set_i2c_address (uint8_t address)
 We store the address of the device on the bus. More...
 
void set_i2c_bus (I2CBus *bus)
 we store the pointer to the I2CBus to use More...
 
I2CRegister reg (uint8_t a_register)
 calls the I2CRegister constructor More...
 
I2CRegister16 reg16 (uint16_t a_register)
 calls the I2CRegister16 constructor More...
 
ErrorCode read (uint8_t *data, size_t len)
 reads an array of bytes from the device using an I2CBus More...
 
ErrorCode read_register (uint8_t a_register, uint8_t *data, size_t len, bool stop=true)
 reads an array of bytes from a specific register in the I²C device More...
 
ErrorCode read_register16 (uint16_t a_register, uint8_t *data, size_t len, bool stop=true)
 reads an array of bytes from a specific register in the I²C device More...
 
ErrorCode write (const uint8_t *data, size_t len, bool stop=true)
 writes an array of bytes to a device using an I2CBus More...
 
ErrorCode write_register (uint8_t a_register, const uint8_t *data, size_t len, bool stop=true)
 writes an array of bytes to a specific register in the I²C device More...
 
ErrorCode write_register16 (uint16_t a_register, const uint8_t *data, size_t len, bool stop=true)
 write an array of bytes to a specific register in the I²C device More...
 
bool read_bytes (uint8_t a_register, uint8_t *data, uint8_t len)
 Compat APIs All methods below have been added for compatibility reasons. More...
 
bool read_bytes_raw (uint8_t *data, uint8_t len)
 
template<size_t N>
optional< std::array< uint8_t, N > > read_bytes (uint8_t a_register)
 
template<size_t N>
optional< std::array< uint8_t, N > > read_bytes_raw ()
 
bool read_bytes_16 (uint8_t a_register, uint16_t *data, uint8_t len)
 
bool read_byte (uint8_t a_register, uint8_t *data, bool stop=true)
 
optional< uint8_t > read_byte (uint8_t a_register)
 
bool read_byte_16 (uint8_t a_register, uint16_t *data)
 
bool write_bytes (uint8_t a_register, const uint8_t *data, uint8_t len, bool stop=true)
 
bool write_bytes (uint8_t a_register, const std::vector< uint8_t > &data)
 
template<size_t N>
bool write_bytes (uint8_t a_register, const std::array< uint8_t, N > &data)
 
bool write_bytes_16 (uint8_t a_register, const uint16_t *data, uint8_t len)
 
bool write_byte (uint8_t a_register, uint8_t data, bool stop=true)
 
bool write_byte_16 (uint8_t a_register, uint16_t data)
 

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::i2c::I2CDevice
uint8_t address_ {0x00}
 store the address of the device on the bus More...
 
I2CBusbus_ {nullptr}
 pointer to I2CBus instance More...
 

Detailed Description

Definition at line 12 of file pn7160_i2c.h.

Member Function Documentation

◆ dump_config()

void esphome::pn7160_i2c::PN7160I2C::dump_config ( )
overridevirtual

Reimplemented from esphome::pn7160::PN7160.

Definition at line 43 of file pn7160_i2c.cpp.

◆ read_nfcc()

uint8_t esphome::pn7160_i2c::PN7160I2C::read_nfcc ( nfc::NciMessage rx,
uint16_t  timeout 
)
overrideprotectedvirtual

Implements esphome::pn7160::PN7160.

Definition at line 10 of file pn7160_i2c.cpp.

◆ write_nfcc()

uint8_t esphome::pn7160_i2c::PN7160I2C::write_nfcc ( nfc::NciMessage tx)
overrideprotectedvirtual

Implements esphome::pn7160::PN7160.

Definition at line 36 of file pn7160_i2c.cpp.


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