ESPHome 2026.6.0-dev
Loading...
Searching...
No Matches
nfc.cpp
Go to the documentation of this file.
1#include "nfc.h"
2#include <cstdio>
4#include "esphome/core/log.h"
5
6namespace esphome::nfc {
7
8static const char *const TAG = "nfc";
9
10char *format_uid_to(char *buffer, std::span<const uint8_t> uid) {
11 return format_hex_pretty_to(buffer, FORMAT_UID_BUFFER_SIZE, uid.data(), uid.size(), '-');
12}
13
14char *format_bytes_to(char *buffer, std::span<const uint8_t> bytes) {
15 return format_hex_pretty_to(buffer, FORMAT_BYTES_BUFFER_SIZE, bytes.data(), bytes.size(), ' ');
16}
17
18uint8_t guess_tag_type(uint8_t uid_length) {
19 if (uid_length == 4) {
20 return TAG_TYPE_MIFARE_CLASSIC;
21 } else {
22 return TAG_TYPE_2;
23 }
24}
25
26int8_t get_mifare_classic_ndef_start_index(std::vector<uint8_t> &data) {
27 for (uint8_t i = 0; i < MIFARE_CLASSIC_BLOCK_SIZE; i++) {
28 if (data[i] == 0x00) {
29 // Do nothing, skip
30 } else if (data[i] == 0x03) {
31 return i;
32 } else {
33 return -2;
34 }
35 }
36 return -1;
37}
38
39bool decode_mifare_classic_tlv(std::vector<uint8_t> &data, uint32_t &message_length, uint8_t &message_start_index) {
40 if (data.size() < MIFARE_CLASSIC_BLOCK_SIZE) {
41 ESP_LOGE(TAG, "Error, data too short for NDEF detection.");
42 return false;
43 }
45 if (i < 0 || data[i] != 0x03) {
46 ESP_LOGE(TAG, "Error, Can't decode message length.");
47 return false;
48 }
49 uint8_t idx = static_cast<uint8_t>(i);
50 if (idx + 4 <= data.size() && data[idx + 1] == 0xFF) {
51 message_length = ((0xFF & data[idx + 2]) << 8) | (0xFF & data[idx + 3]);
52 message_start_index = idx + MIFARE_CLASSIC_LONG_TLV_SIZE;
53 } else if (idx + 2 <= data.size()) {
54 message_length = data[idx + 1];
55 message_start_index = idx + MIFARE_CLASSIC_SHORT_TLV_SIZE;
56 } else {
57 ESP_LOGE(TAG, "Error, TLV data too short.");
58 return false;
59 }
60 return true;
61}
62
64 uint32_t buffer_size = message_length + 2 + 1;
65 if (buffer_size % MIFARE_ULTRALIGHT_READ_SIZE != 0)
66 buffer_size = ((buffer_size / MIFARE_ULTRALIGHT_READ_SIZE) + 1) * MIFARE_ULTRALIGHT_READ_SIZE;
67 return buffer_size;
68}
69
71 uint32_t buffer_size = message_length;
72 if (message_length < 255) {
73 buffer_size += MIFARE_CLASSIC_SHORT_TLV_SIZE + 1;
74 } else {
75 buffer_size += MIFARE_CLASSIC_LONG_TLV_SIZE + 1;
76 }
77 if (buffer_size % MIFARE_CLASSIC_BLOCK_SIZE != 0) {
78 buffer_size = ((buffer_size / MIFARE_CLASSIC_BLOCK_SIZE) + 1) * MIFARE_CLASSIC_BLOCK_SIZE;
79 }
80 return buffer_size;
81}
82
83bool mifare_classic_is_first_block(uint8_t block_num) {
84 if (block_num < MIFARE_CLASSIC_BLOCKS_PER_SECT_LOW * MIFARE_CLASSIC_16BLOCK_SECT_START) {
85 return (block_num % MIFARE_CLASSIC_BLOCKS_PER_SECT_LOW == 0);
86 } else {
87 return (block_num % MIFARE_CLASSIC_BLOCKS_PER_SECT_HIGH == 0);
88 }
89}
90
91bool mifare_classic_is_trailer_block(uint8_t block_num) {
92 if (block_num < MIFARE_CLASSIC_BLOCKS_PER_SECT_LOW * MIFARE_CLASSIC_16BLOCK_SECT_START) {
93 return ((block_num + 1) % MIFARE_CLASSIC_BLOCKS_PER_SECT_LOW == 0);
94 } else {
95 return ((block_num + 1) % MIFARE_CLASSIC_BLOCKS_PER_SECT_HIGH == 0);
96 }
97}
98
99} // namespace esphome::nfc
bool decode_mifare_classic_tlv(std::vector< uint8_t > &data, uint32_t &message_length, uint8_t &message_start_index)
Definition nfc.cpp:39
char * format_bytes_to(char *buffer, std::span< const uint8_t > bytes)
Format bytes to buffer with ' ' separator (e.g., "04 11 22 33"). Returns buffer for inline use.
Definition nfc.cpp:14
uint32_t get_mifare_ultralight_buffer_size(uint32_t message_length)
Definition nfc.cpp:63
char * format_uid_to(char *buffer, std::span< const uint8_t > uid)
Format UID to buffer with '-' separator (e.g., "04-11-22-33"). Returns buffer for inline use.
Definition nfc.cpp:10
uint8_t guess_tag_type(uint8_t uid_length)
Definition nfc.cpp:18
bool mifare_classic_is_trailer_block(uint8_t block_num)
Definition nfc.cpp:91
uint32_t get_mifare_classic_buffer_size(uint32_t message_length)
Definition nfc.cpp:70
int8_t get_mifare_classic_ndef_start_index(std::vector< uint8_t > &data)
Definition nfc.cpp:26
bool mifare_classic_is_first_block(uint8_t block_num)
Definition nfc.cpp:83
char * format_hex_pretty_to(char *buffer, size_t buffer_size, const uint8_t *data, size_t length, char separator)
Format byte array as uppercase hex to buffer (base implementation).
Definition helpers.cpp:340
static void uint32_t