Upstream/esphome
1
0
Fork 0
mirror of https://github.com/esphome/esphome.git synced 2024-12-18 15:57:58 +01:00
Code Issues Projects Releases Wiki Activity

Fix PN532 SPI communication (#1511)

Browse Source
This commit is contained in:
Jesse Hills 2021-02-06 11:02:20 +13:00 committed by GitHub
parent bccaa78a90
commit b351cd94d7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
8 changed files with 203 additions and 103 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

100
esphome/components/pn532/pn532.cpp
View File

@ -22,7 +22,7 @@ void PN532::setup() {
} }
std::vector<uint8_t> version_data; std::vector<uint8_t> version_data;
if (!this->read_response_(PN532_COMMAND_VERSION_DATA, version_data)) { if (!this->read_response(PN532_COMMAND_VERSION_DATA, version_data)) {
ESP_LOGE(TAG, "Error getting version"); ESP_LOGE(TAG, "Error getting version");
this->mark_failed(); this->mark_failed();
return; return;
@ -42,7 +42,7 @@ void PN532::setup() {
} }
std::vector<uint8_t> wakeup_result; std::vector<uint8_t> wakeup_result;
if (!this->read_response_(PN532_COMMAND_SAMCONFIGURATION, wakeup_result)) { if (!this->read_response(PN532_COMMAND_SAMCONFIGURATION, wakeup_result)) {
this->error_code_ = WAKEUP_FAILED; this->error_code_ = WAKEUP_FAILED;
this->mark_failed(); this->mark_failed();
return; return;
@ -62,7 +62,7 @@ void PN532::setup() {
} }
std::vector<uint8_t> sam_result; std::vector<uint8_t> sam_result;
if (!this->read_response_(PN532_COMMAND_SAMCONFIGURATION, sam_result)) { if (!this->read_response(PN532_COMMAND_SAMCONFIGURATION, sam_result)) {
ESP_LOGV(TAG, "Invalid SAM result: (%u)", sam_result.size()); // NOLINT ESP_LOGV(TAG, "Invalid SAM result: (%u)", sam_result.size()); // NOLINT
for (uint8_t dat : sam_result) { for (uint8_t dat : sam_result) {
ESP_LOGV(TAG, " 0x%02X", dat); ESP_LOGV(TAG, " 0x%02X", dat);
@ -97,7 +97,7 @@ void PN532::loop() {
return; return;
std::vector<uint8_t> read; std::vector<uint8_t> read;
bool success = this->read_response_(PN532_COMMAND_INLISTPASSIVETARGET, read); bool success = this->read_response(PN532_COMMAND_INLISTPASSIVETARGET, read);
this->requested_read_ = false; this->requested_read_ = false;
@ -230,7 +230,7 @@ bool PN532::write_command_(const std::vector<uint8_t> &data) {
} }
bool PN532::read_ack_() { bool PN532::read_ack_() {
ESP_LOGVV(TAG, "Reading ACK..."); ESP_LOGV(TAG, "Reading ACK...");
std::vector<uint8_t> data; std::vector<uint8_t> data;
if (!this->read_data(data, 6)) { if (!this->read_data(data, 6)) {
@ -241,96 +241,18 @@ bool PN532::read_ack_() {
data[2] == 0x00 && // start of packet data[2] == 0x00 && // start of packet
data[3] == 0xFF && data[4] == 0x00 && // ACK packet code data[3] == 0xFF && data[4] == 0x00 && // ACK packet code
data[5] == 0xFF && data[6] == 0x00); // postamble data[5] == 0xFF && data[6] == 0x00); // postamble
ESP_LOGVV(TAG, "ACK valid: %s", YESNO(matches)); ESP_LOGV(TAG, "ACK valid: %s", YESNO(matches));
return matches; return matches;
} }
bool PN532::read_response_(uint8_t command, std::vector<uint8_t> &data) { void PN532::send_nack_() {
ESP_LOGV(TAG, "Reading response"); ESP_LOGV(TAG, "Sending NACK for retransmit");
uint8_t len = this->read_response_length_(); this->write_data({0x00, 0x00, 0xFF, 0xFF, 0x00, 0x00});
if (len == 0) { delay(10);
return false;
}
ESP_LOGV(TAG, "Reading response of length %d", len);
if (!this->read_data(data, 6 + len + 2)) {
ESP_LOGD(TAG, "No response data");
return false;
}
if (data[1] != 0x00 && data[2] != 0x00 && data[3] != 0xFF) {
// invalid packet
ESP_LOGV(TAG, "read data invalid preamble!");
return false;
}
bool valid_header = (static_cast<uint8_t>(data[4] + data[5]) == 0 && // LCS, len + lcs = 0
data[6] == 0xD5 && // TFI - frame from PN532 to system controller
data[7] == command + 1); // Correct command response
if (!valid_header) {
ESP_LOGV(TAG, "read data invalid header!");
return false;
}
data.erase(data.begin(), data.begin() + 6); // Remove headers
uint8_t checksum = 0;
for (int i = 0; i < len + 1; i++) {
uint8_t dat = data[i];
checksum += dat;
}
checksum = ~checksum + 1;
if (data[len + 1] != checksum) {
ESP_LOGV(TAG, "read data invalid checksum! %02X != %02X", data[len], checksum);
return false;
}
if (data[len + 2] != 0x00) {
ESP_LOGV(TAG, "read data invalid postamble!");
return false;
}
data.erase(data.begin(), data.begin() + 2); // Remove TFI and command code
data.erase(data.end() - 2, data.end()); // Remove checksum and postamble
return true;
}
uint8_t PN532::read_response_length_() {
std::vector<uint8_t> data;
if (!this->read_data(data, 6)) {
return 0;
}
if (data[1] != 0x00 && data[2] != 0x00 && data[3] != 0xFF) {
// invalid packet
ESP_LOGV(TAG, "read data invalid preamble!");
return 0;
}
bool valid_header = (static_cast<uint8_t>(data[4] + data[5]) == 0 && // LCS, len + lcs = 0
data[6] == 0xD5); // TFI - frame from PN532 to system controller
if (!valid_header) {
ESP_LOGV(TAG, "read data invalid header!");
return 0;
}
this->write_data({0x00, 0x00, 0xFF, 0xFF, 0x00, 0x00}); // NACK - Retransmit last message
// full length of message, including TFI
uint8_t full_len = data[4];
// length of data, excluding TFI
uint8_t len = full_len - 1;
if (full_len == 0)
len = 0;
return len;
} }
void PN532::turn_off_rf_() { void PN532::turn_off_rf_() {
ESP_LOGVV(TAG, "Turning RF field OFF"); ESP_LOGV(TAG, "Turning RF field OFF");
this->write_command_({ this->write_command_({
PN532_COMMAND_RFCONFIGURATION, PN532_COMMAND_RFCONFIGURATION,
0x01, // RF Field 0x01, // RF Field

4
esphome/components/pn532/pn532.h
View File

@ -46,12 +46,12 @@ class PN532 : public PollingComponent {
protected: protected:
void turn_off_rf_(); void turn_off_rf_();
bool write_command_(const std::vector<uint8_t> &data); bool write_command_(const std::vector<uint8_t> &data);
bool read_response_(uint8_t command, std::vector<uint8_t> &data);
bool read_ack_(); bool read_ack_();
uint8_t read_response_length_(); void send_nack_();
virtual bool write_data(const std::vector<uint8_t> &data) = 0; virtual bool write_data(const std::vector<uint8_t> &data) = 0;
virtual bool read_data(std::vector<uint8_t> &data, uint8_t len) = 0; virtual bool read_data(std::vector<uint8_t> &data, uint8_t len) = 0;
virtual bool read_response(uint8_t command, std::vector<uint8_t> &data) = 0;
nfc::NfcTag *read_tag_(std::vector<uint8_t> &uid); nfc::NfcTag *read_tag_(std::vector<uint8_t> &uid);

6
esphome/components/pn532/pn532_mifare_classic.cpp
View File

@ -64,7 +64,7 @@ bool PN532::read_mifare_classic_block_(uint8_t block_num, std::vector<uint8_t> &
return false; return false;
} }
if (!this->read_response_(PN532_COMMAND_INDATAEXCHANGE, data) || data[0] != 0x00) { if (!this->read_response(PN532_COMMAND_INDATAEXCHANGE, data) || data[0] != 0x00) {
return false; return false;
} }
data.erase(data.begin()); data.erase(data.begin());
@ -89,7 +89,7 @@ bool PN532::auth_mifare_classic_block_(std::vector<uint8_t> &uid, uint8_t block_
} }
std::vector<uint8_t> response; std::vector<uint8_t> response;
if (!this->read_response_(PN532_COMMAND_INDATAEXCHANGE, response) || response[0] != 0x00) { if (!this->read_response(PN532_COMMAND_INDATAEXCHANGE, response) || response[0] != 0x00) {
ESP_LOGE(TAG, "Authentication failed - Block 0x%02x", block_num); ESP_LOGE(TAG, "Authentication failed - Block 0x%02x", block_num);
return false; return false;
} }
@ -194,7 +194,7 @@ bool PN532::write_mifare_classic_block_(uint8_t block_num, std::vector<uint8_t>
} }
std::vector<uint8_t> response; std::vector<uint8_t> response;
if (!this->read_response_(PN532_COMMAND_INDATAEXCHANGE, response)) { if (!this->read_response(PN532_COMMAND_INDATAEXCHANGE, response)) {
ESP_LOGE(TAG, "Error writing block %d", block_num); ESP_LOGE(TAG, "Error writing block %d", block_num);
return false; return false;
} }

4
esphome/components/pn532/pn532_mifare_ultralight.cpp
View File

@ -52,7 +52,7 @@ bool PN532::read_mifare_ultralight_page_(uint8_t page_num, std::vector<uint8_t>
return false; return false;
} }
if (!this->read_response_(PN532_COMMAND_INDATAEXCHANGE, data) || data[0] != 0x00) { if (!this->read_response(PN532_COMMAND_INDATAEXCHANGE, data) || data[0] != 0x00) {
return false; return false;
} }
data.erase(data.begin()); data.erase(data.begin());
@ -168,7 +168,7 @@ bool PN532::write_mifare_ultralight_page_(uint8_t page_num, std::vector<uint8_t>
} }
std::vector<uint8_t> response; std::vector<uint8_t> response;
if (!this->read_response_(PN532_COMMAND_INDATAEXCHANGE, response)) { if (!this->read_response(PN532_COMMAND_INDATAEXCHANGE, response)) {
ESP_LOGE(TAG, "Error writing page %d", page_num); ESP_LOGE(TAG, "Error writing page %d", page_num);
return false; return false;
} }

84
esphome/components/pn532_i2c/pn532_i2c.cpp
View File

@ -36,6 +36,90 @@ bool PN532I2C::read_data(std::vector<uint8_t> &data, uint8_t len) {
return true; return true;
} }
bool PN532I2C::read_response(uint8_t command, std::vector<uint8_t> &data) {
ESP_LOGV(TAG, "Reading response");
uint8_t len = this->read_response_length_();
if (len == 0) {
return false;
}
ESP_LOGV(TAG, "Reading response of length %d", len);
if (!this->read_data(data, 6 + len + 2)) {
ESP_LOGD(TAG, "No response data");
return false;
}
if (data[1] != 0x00 && data[2] != 0x00 && data[3] != 0xFF) {
// invalid packet
ESP_LOGV(TAG, "read data invalid preamble!");
return false;
}
bool valid_header = (static_cast<uint8_t>(data[4] + data[5]) == 0 && // LCS, len + lcs = 0
data[6] == 0xD5 && // TFI - frame from PN532 to system controller
data[7] == command + 1); // Correct command response
if (!valid_header) {
ESP_LOGV(TAG, "read data invalid header!");
return false;
}
data.erase(data.begin(), data.begin() + 6); // Remove headers
uint8_t checksum = 0;
for (int i = 0; i < len + 1; i++) {
uint8_t dat = data[i];
checksum += dat;
}
checksum = ~checksum + 1;
if (data[len + 1] != checksum) {
ESP_LOGV(TAG, "read data invalid checksum! %02X != %02X", data[len], checksum);
return false;
}
if (data[len + 2] != 0x00) {
ESP_LOGV(TAG, "read data invalid postamble!");
return false;
}
data.erase(data.begin(), data.begin() + 2); // Remove TFI and command code
data.erase(data.end() - 2, data.end()); // Remove checksum and postamble
return true;
}
uint8_t PN532I2C::read_response_length_() {
std::vector<uint8_t> data;
if (!this->read_data(data, 6)) {
return 0;
}
if (data[1] != 0x00 && data[2] != 0x00 && data[3] != 0xFF) {
// invalid packet
ESP_LOGV(TAG, "read data invalid preamble!");
return 0;
}
bool valid_header = (static_cast<uint8_t>(data[4] + data[5]) == 0 && // LCS, len + lcs = 0
data[6] == 0xD5); // TFI - frame from PN532 to system controller
if (!valid_header) {
ESP_LOGV(TAG, "read data invalid header!");
return 0;
}
this->send_nack_();
// full length of message, including TFI
uint8_t full_len = data[4];
// length of data, excluding TFI
uint8_t len = full_len - 1;
if (full_len == 0)
len = 0;
return len;
}
void PN532I2C::dump_config() { void PN532I2C::dump_config() {
PN532::dump_config(); PN532::dump_config();
LOG_I2C_DEVICE(this); LOG_I2C_DEVICE(this);

2
esphome/components/pn532_i2c/pn532_i2c.h
View File

@ -14,6 +14,8 @@ class PN532I2C : public pn532::PN532, public i2c::I2CDevice {
protected: protected:
bool write_data(const std::vector<uint8_t> &data) 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_data(std::vector<uint8_t> &data, uint8_t len) override;
bool read_response(uint8_t command, std::vector<uint8_t> &data) override;
uint8_t read_response_length_();
}; };
} // namespace pn532_i2c } // namespace pn532_i2c

105
esphome/components/pn532_spi/pn532_spi.cpp
View File

@ -26,7 +26,7 @@ bool PN532Spi::write_data(const std::vector<uint8_t> &data) {
delay(2); delay(2);
// First byte, communication mode: Write data // First byte, communication mode: Write data
this->write_byte(0x01); this->write_byte(0x01);
ESP_LOGV(TAG, "Writing data: %s", hexencode(data).c_str());
this->write_array(data.data(), data.size()); this->write_array(data.data(), data.size());
this->disable(); this->disable();
@ -34,31 +34,122 @@ bool PN532Spi::write_data(const std::vector<uint8_t> &data) {
} }
bool PN532Spi::read_data(std::vector<uint8_t> &data, uint8_t len) { bool PN532Spi::read_data(std::vector<uint8_t> &data, uint8_t len) {
this->enable(); ESP_LOGV(TAG, "Waiting for ready byte...");
// First byte, communication mode: Read state
this->write_byte(0x02);
uint32_t start_time = millis(); uint32_t start_time = millis();
while (true) { while (true) {
if (this->read_byte() & 0x01) this->enable();
// First byte, communication mode: Read state
this->write_byte(0x02);
bool ready = this->read_byte() == 0x01;
this->disable();
if (ready)
break; break;
ESP_LOGV(TAG, "Not ready yet...");
if (millis() - start_time > 100) { if (millis() - start_time > 100) {
this->disable();
ESP_LOGV(TAG, "Timed out waiting for readiness from PN532!"); ESP_LOGV(TAG, "Timed out waiting for readiness from PN532!");
return false; return false;
} }
yield();
} }
// Read data (transmission from the PN532 to the host) // Read data (transmission from the PN532 to the host)
this->enable();
delay(2);
this->write_byte(0x03); this->write_byte(0x03);
ESP_LOGV(TAG, "Reading data...");
data.resize(len); data.resize(len);
this->read_array(data.data(), len); this->read_array(data.data(), len);
this->disable(); this->disable();
data.insert(data.begin(), 0x01); data.insert(data.begin(), 0x01);
ESP_LOGV(TAG, "Read data: %s", hexencode(data).c_str());
return true; return true;
}; }
bool PN532Spi::read_response(uint8_t command, std::vector<uint8_t> &data) {
ESP_LOGV(TAG, "Reading response");
uint32_t start_time = millis();
while (true) {
this->enable();
// First byte, communication mode: Read state
this->write_byte(0x02);
bool ready = this->read_byte() == 0x01;
this->disable();
if (ready)
break;
ESP_LOGV(TAG, "Not ready yet...");
if (millis() - start_time > 100) {
ESP_LOGV(TAG, "Timed out waiting for readiness from PN532!");
return false;
}
yield();
}
this->enable();
delay(2);
this->write_byte(0x03);
std::vector<uint8_t> header(7);
this->read_array(header.data(), 7);
ESP_LOGV(TAG, "Header data: %s", hexencode(header).c_str());
if (header[0] != 0x00 && header[1] != 0x00 && header[2] != 0xFF) {
// invalid packet
ESP_LOGV(TAG, "read data invalid preamble!");
return false;
}
bool valid_header = (static_cast<uint8_t>(header[3] + header[4]) == 0 && // LCS, len + lcs = 0
header[5] == 0xD5 && // TFI - frame from PN532 to system controller
header[6] == command + 1); // Correct command response
if (!valid_header) {
ESP_LOGV(TAG, "read data invalid header!");
return false;
}
// full length of message, including command response
uint8_t full_len = header[3];
// length of data, excluding command response
uint8_t len = full_len - 1;
if (full_len == 0)
len = 0;
ESP_LOGV(TAG, "Reading response of length %d", len);
data.resize(len + 1);
this->read_array(data.data(), len + 1);
this->disable();
ESP_LOGV(TAG, "Response data: %s", hexencode(data).c_str());
uint8_t checksum = header[5] + header[6]; // TFI + Command response code
for (int i = 0; i < len - 1; i++) {
uint8_t dat = data[i];
checksum += dat;
}
checksum = ~checksum + 1;
if (data[len - 1] != checksum) {
ESP_LOGV(TAG, "read data invalid checksum! %02X != %02X", data[len - 1], checksum);
return false;
}
if (data[len] != 0x00) {
ESP_LOGV(TAG, "read data invalid postamble!");
return false;
}
data.erase(data.end() - 2, data.end()); // Remove checksum and postamble
return true;
}
void PN532Spi::dump_config() { void PN532Spi::dump_config() {
PN532::dump_config(); PN532::dump_config();

1
esphome/components/pn532_spi/pn532_spi.h
View File

@ -18,6 +18,7 @@ class PN532Spi : public pn532::PN532,
protected: protected:
bool write_data(const std::vector<uint8_t> &data) 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_data(std::vector<uint8_t> &data, uint8_t len) override;
bool read_response(uint8_t command, std::vector<uint8_t> &data) override;
}; };
} // namespace pn532_spi } // namespace pn532_spi