ESPHome  2024.11.1
Public Member Functions | Protected Member Functions
esphome::pn532_spi::PN532Spi Class Reference

#include <pn532_spi.h>

Inheritance diagram for esphome::pn532_spi::PN532Spi:
esphome::pn532::PN532 esphome::spi::SPIDevice< spi::BIT_ORDER_LSB_FIRST, spi::CLOCK_POLARITY_LOW, spi::CLOCK_PHASE_LEADING, spi::DATA_RATE_1MHZ > esphome::PollingComponent esphome::spi::SPIClient esphome::Component

Public Member Functions

void setup () override
 
void dump_config () override
 
- Public Member Functions inherited from esphome::pn532::PN532
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...
 
- Public Member Functions inherited from esphome::spi::SPIDevice< spi::BIT_ORDER_LSB_FIRST, spi::CLOCK_POLARITY_LOW, spi::CLOCK_PHASE_LEADING, spi::DATA_RATE_1MHZ >
 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

bool is_read_ready () override
 
bool write_data (const std::vector< uint8_t > &data) override
 
bool read_data (std::vector< uint8_t > &data, uint8_t len) override
 
bool read_response (uint8_t command, std::vector< uint8_t > &data) override
 
- Protected Member Functions inherited from esphome::pn532::PN532
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)
 
std::unique_ptr< nfc::NfcTagread_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::NfcTagread_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::NfcTagread_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...
 

Additional Inherited Members

- Protected Types inherited from esphome::pn532::PN532
enum  NfcTask { READ = 0, CLEAN, FORMAT, WRITE }
 
enum  PN532Error { NONE = 0, WAKEUP_FAILED, SAM_COMMAND_FAILED }
 
- Protected Attributes inherited from esphome::pn532::PN532
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::NdefMessagenext_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}
 
- 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 12 of file pn532_spi.h.

Member Function Documentation

◆ dump_config()

void esphome::pn532_spi::PN532Spi::dump_config ( )
overridevirtual

Reimplemented from esphome::pn532::PN532.

Definition at line 132 of file pn532_spi.cpp.

◆ is_read_ready()

bool esphome::pn532_spi::PN532Spi::is_read_ready ( )
overrideprotectedvirtual

Implements esphome::pn532::PN532.

Definition at line 24 of file pn532_spi.cpp.

◆ read_data()

bool esphome::pn532_spi::PN532Spi::read_data ( std::vector< uint8_t > &  data,
uint8_t  len 
)
overrideprotectedvirtual

Implements esphome::pn532::PN532.

Definition at line 44 of file pn532_spi.cpp.

◆ read_response()

bool esphome::pn532_spi::PN532Spi::read_response ( uint8_t  command,
std::vector< uint8_t > &  data 
)
overrideprotectedvirtual

Implements esphome::pn532::PN532.

Definition at line 64 of file pn532_spi.cpp.

◆ setup()

void esphome::pn532_spi::PN532Spi::setup ( )
overridevirtual

Reimplemented from esphome::pn532::PN532.

Definition at line 14 of file pn532_spi.cpp.

◆ write_data()

bool esphome::pn532_spi::PN532Spi::write_data ( const std::vector< uint8_t > &  data)
overrideprotectedvirtual

Implements esphome::pn532::PN532.

Definition at line 32 of file pn532_spi.cpp.


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