Home-IoT/esphome
1
0
Fork 0
mirror of https://github.com/esphome/esphome.git synced 2024-12-01 03:04:12 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

cleanup the code

Browse source
This commit is contained in:
NP v/d Spek 2024-09-30 02:52:25 +02:00
parent 562181147d
commit f5ef38b948
2 changed files with 47 additions and 66 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

78
esphome/components/espnow/espnow.cpp
View file

@ -8,7 +8,6 @@
#include "esp_random.h" #include "esp_random.h"
#include "esp_wifi.h" #include "esp_wifi.h"
#include "esp_crc.h"
#include "esp_now.h" #include "esp_now.h"
#include "esp_event.h" #include "esp_event.h"
@ -46,10 +45,11 @@ void ESPNowComponent::dump_config() {
} }
void ESPNowComponent::show_packet(const std::string &title, const ESPNowPacket &packet) { void ESPNowComponent::show_packet(const std::string &title, const ESPNowPacket &packet) {
ESP_LOGVV(TAG, "%s Peer: packet: 0x%12llx M:%s H:%cx%cx%c P:%c%c%c 0x%02x S:%02x C:ox%02x~0x%02x S:%02d V:%s", ESP_LOGV(TAG,
"test", packet.peer, packet.content_at(0), packet.content_at(1), packet.content_at(2), packet.content_at(3), "%s packet. Peer: 0x%12llx Header: %c%c%c Protocol: 0x%02x%02x%02x%02x Sequents: %02x Size: %2d Valid: %s",
packet.content_at(4), packet.content_at(5), packet.content_at(6), packet.content_at(7), packet.crc(), title.c_str(), packet.peer, packet.content_at(0), packet.content_at(1), packet.content_at(2),
packet.calc_crc(), packet.content_size() packet.is_valid() ? "Yes" : "No"); packet.content_at(3), packet.content_at(4), packet.content_at(5), packet.content_at(6), packet.content_at(7),
packet.content_size(), packet.is_valid() ? "Yes" : "No");
} }
bool ESPNowComponent::validate_channel_(uint8_t channel) { bool ESPNowComponent::validate_channel_(uint8_t channel) {
@ -102,12 +102,13 @@ void ESPNowComponent::setup() {
this->mark_failed(); this->mark_failed();
return; return;
} }
if (this->use_sent_check_) {
err = esp_now_register_send_cb(ESPNowComponent::on_data_sent); err = esp_now_register_send_cb(ESPNowComponent::on_data_sent);
if (err != ESP_OK) { if (err != ESP_OK) {
ESP_LOGE(TAG, "esp_now_register_send_cb failed: %s", esp_err_to_name(err)); ESP_LOGE(TAG, "esp_now_register_send_cb failed: %s", esp_err_to_name(err));
this->mark_failed(); this->mark_failed();
return; return;
}
} }
esp_wifi_get_mac(WIFI_IF_STA, (uint8_t *) &this->own_peer_address_); esp_wifi_get_mac(WIFI_IF_STA, (uint8_t *) &this->own_peer_address_);
@ -232,35 +233,35 @@ void ESPNowComponent::on_data_received(const uint8_t *addr, const uint8_t *data,
} else { } else {
packet.timestamp = millis(); packet.timestamp = millis();
} }
/// this->show_packet("Receive", *packet); ESPNowComponent::static_->show_packet("Receive", packet);
if (packet.is_valid()) { if (packet.is_valid()) {
xQueueSendToBack(ESPNowComponent::static_->receive_queue_, (void *) &packet, 10); xQueueSendToBack(ESPNowComponent::static_->receive_queue_, (void *) &packet, 10);
} else { } else {
ESP_LOGE(TAG, "Invalid ESP-NOW packet received (CRC)"); ESP_LOGE(TAG, "Invalid ESP-NOW packet received.");
} }
} }
bool ESPNowComponent::send(ESPNowPacket packet) { bool ESPNowComponent::send(ESPNowPacket packet) {
uint8_t *mac = packet.peer_as_bytes(); uint8_t *mac = packet.peer_as_bytes();
// this->show_packet("Write", packet); this->show_packet("Prepare to send", packet);
if (this->is_failed()) { if (this->is_failed()) {
ESP_LOGE(TAG, "Cannot send espnow packet, espnow failed to setup"); ESP_LOGE(TAG, "Cannot send espnow packet, espnow failed to setup");
} else if (this->send_queue_full()) { } else if (this->send_queue_full()) {
ESP_LOGE(TAG, "Send Buffer Out of Memory."); ESP_LOGE(TAG, "Send Buffer Out of Memory.");
} else if (!esp_now_is_peer_exist(mac)) { } else if (!esp_now_is_peer_exist(mac)) {
ESP_LOGW(TAG, "Peer not registered: 0x%12llx.", packet.peer); ESP_LOGE(TAG, "Peer not registered: 0x%12llx.", packet.peer);
} else if (!packet.is_valid()) { } else if (!packet.is_valid()) {
ESP_LOGW(TAG, "Packet is invalid. maybe you need to ::calc_crc(). the packat before writing."); ESP_LOGE(TAG, "This Packet is invalid: 0x%012llx (%d.%d)", packet.peer, packet.sequents(), packet.attempts);
} else if (this->use_sent_check_) { } else if (this->use_sent_check_) {
ESP_LOGD(TAG, "Place 0x%12llx (%d.%d) into send buffer. Used: %d of %d", packet.peer, packet.sequents(), ESP_LOGV(TAG, "Placing 0x%012llx (%d.%d) into send buffer. Used: %d of %d", packet.peer, packet.sequents(),
packet.attempts, this->send_queue_used(), SEND_BUFFER_SIZE); packet.attempts, this->send_queue_used(), SEND_BUFFER_SIZE);
xQueueSendToBack(this->send_queue_, (void *) &packet, 10); xQueueSendToBack(this->send_queue_, (void *) &packet, 10);
return true; return true;
} else { } else {
esp_err_t err = esp_now_send((uint8_t *) &mac, packet.content_as_bytes(), packet.content_size()); esp_err_t err = esp_now_send((uint8_t *) &mac, packet.content_as_bytes(), packet.content_size());
ESP_LOGD(TAG, "Sended 0x%12llx (%d.%d) directly%s.", packet.peer, packet.sequents(), packet.attempts, ESP_LOGD(TAG, "Sended 0x%012llx (%d.%d) directly%s.", packet.peer, packet.sequents(), packet.attempts,
(err == ESP_OK) ? "" : " FAILED"); (err == ESP_OK) ? "" : " FAILED");
this->call_on_sent_(packet, err == ESP_OK); this->call_on_sent_(packet, err == ESP_OK);
@ -275,7 +276,8 @@ void ESPNowComponent::runner() {
for (;;) { for (;;) {
if (xQueueReceive(this->receive_queue_, (void *) &packet, (TickType_t) 1) == pdTRUE) { if (xQueueReceive(this->receive_queue_, (void *) &packet, (TickType_t) 1) == pdTRUE) {
uint8_t *mac = packet.peer_as_bytes(); uint8_t *mac = packet.peer_as_bytes();
ESP_LOGD(TAG, "Handling received packet from 0x%12llx (%d.%d).", packet.peer, packet.sequents(), packet.attempts); ESP_LOGD(TAG, "Handling received packet from 0x%012llx (%d.%d).", packet.peer, packet.sequents(),
packet.attempts);
if (esp_now_is_peer_exist(mac)) { if (esp_now_is_peer_exist(mac)) {
this->call_on_receive_(packet); this->call_on_receive_(packet);
@ -287,17 +289,14 @@ void ESPNowComponent::runner() {
} }
} }
if (xQueueReceive(this->send_queue_, (void *) &packet, (TickType_t) 1) == pdTRUE) { if (xQueueReceive(this->send_queue_, (void *) &packet, (TickType_t) 1) == pdTRUE) {
ESP_LOGD(TAG, "Handling send packet for 0x%12llx (%d.%d).", packet.peer, packet.sequents(), packet.attempts);
if (packet.attempts > MAX_NUMBER_OF_RETRYS) { if (packet.attempts > MAX_NUMBER_OF_RETRYS) {
ESP_LOGE(TAG, "Dropped 0x%12llx (0x%04x.%d). To many send retries", packet.peer, packet.sequents(), ESP_LOGE(TAG, "Dropped 0x%012llx (%d.%d). To many send retries.", packet.peer, packet.sequents(),
packet.attempts); packet.attempts);
this->unlock(); this->unlock();
continue; continue;
} else if (this->is_locked()) { } else if (this->is_locked()) {
if (millis() - packet.timestamp > 1000) { if (millis() - packet.timestamp > this->conformation_timeout_) {
ESP_LOGW(TAG, "TimeOut 0x%12llx (0x%04x.%d).", packet.peer, packet.sequents(), packet.attempts); ESP_LOGW(TAG, "TimeOut 0x%012llx (%d.%d).", packet.peer, packet.sequents(), packet.attempts);
packet.retry();
this->unlock(); this->unlock();
} }
} else { } else {
@ -309,10 +308,10 @@ void ESPNowComponent::runner() {
esp_err_t err = esp_now_send(mac, packet.content_as_bytes(), packet.content_size()); esp_err_t err = esp_now_send(mac, packet.content_as_bytes(), packet.content_size());
if (err == ESP_OK) { if (err == ESP_OK) {
ESP_LOGV(TAG, "Sended 0x%12llx (%d.%d). Wait for conformation.", packet.peer, packet.sequents(), ESP_LOGD(TAG, "Sended 0x%012llx (%d.%d) from buffer. Wait for conformation.", packet.peer, packet.sequents(),
packet.attempts); packet.attempts);
} else { } else {
ESP_LOGE(TAG, "Sending 0x%12llx (%d.%d) FAILED. B: %d.", packet.peer, packet.sequents(), packet.attempts, ESP_LOGE(TAG, "Sending 0x%012llx (%d.%d) FAILED. B: %d.", packet.peer, packet.sequents(), packet.attempts,
this->send_queue_used()); this->send_queue_used());
this->unlock(); this->unlock();
} }
@ -327,20 +326,21 @@ void ESPNowComponent::on_data_sent(const uint8_t *mac_addr, esp_now_send_status_
return; return;
} }
ESPNowPacket packet; // NOLINT ESPNowPacket packet; // NOLINT
uint64_t mac64 = (uint64_t) *mac_addr; uint64_t mac64 = 0;
memcpy((void *) &mac64, (void *) mac_addr, 6);
if (xQueuePeek(ESPNowComponent::static_->send_queue_, (void *) &packet, 10 / portTICK_PERIOD_MS) == pdTRUE) { if (xQueuePeek(ESPNowComponent::static_->send_queue_, (void *) &packet, 10 / portTICK_PERIOD_MS) == pdTRUE) {
if (status != ESP_OK) { if (packet.peer != mac64) {
ESP_LOGE(TAG, "sent packet failed (0x%04x.%d)", packet.sequents(), packet.attempts); ESP_LOGE(TAG, " Invalid mac address. Expected: 0x%012llx (%d.%d) got: 0x%012llx", packet.peer, packet.sequents(),
} else if (packet.peer != mac64) { packet.attempts, mac64);
ESP_LOGE(TAG, " Invalid mac address. (0x%04x.%d) expected: 0x%12llx got: 0x%12llx", packet.sequents(),
packet.attempts, packet.peer, mac64);
} else {
ESP_LOGV(TAG, "Confirm sent (0x%04x.%d)", packet.sequents(), packet.attempts);
ESPNowComponent::static_->call_on_sent_(packet, true);
xQueueReceive(ESPNowComponent::static_->send_queue_, (void *) &packet, 10 / portTICK_PERIOD_MS);
return; return;
} else if (status == ESP_OK) {
ESP_LOGV(TAG, "Confirm packet sent 0x%012llx (%d.%d)", packet.peer, packet.sequents(), packet.attempts);
xQueueReceive(ESPNowComponent::static_->send_queue_, (void *) &packet, 10 / portTICK_PERIOD_MS);
} else {
ESP_LOGE(TAG, "Sent packet failed for 0x%012llx (%d.%d)", packet.peer, packet.sequents(), packet.attempts);
} }
ESPNowComponent::static_->call_on_sent_(packet, false); ESPNowComponent::static_->call_on_sent_(packet, status == ESP_OK);
ESPNowComponent::static_->unlock(); ESPNowComponent::static_->unlock();
} }
} }
@ -350,7 +350,7 @@ void ESPNowComponent::on_data_sent(const uint8_t *mac_addr, esp_now_send_status_
bool ESPNowProtocol::send(uint64_t peer, const uint8_t *data, uint8_t len) { bool ESPNowProtocol::send(uint64_t peer, const uint8_t *data, uint8_t len) {
ESPNowPacket packet(peer, data, len, this->get_protocol_component_id()); // NOLINT ESPNowPacket packet(peer, data, len, this->get_protocol_component_id()); // NOLINT
packet.sequents(this->get_next_sequents()); packet.sequents(this->get_next_sequents());
ESP_LOGD(TAG, "Created packet to Send for 0x%12llx (%d.%d) directly.", packet.peer, packet.sequents(), ESP_LOGV(TAG, "Created packet to Send for 0x%12llx (%d.%d) directly.", packet.peer, packet.sequents(),
packet.attempts); packet.attempts);
return this->parent_->send(packet); return this->parent_->send(packet);

35
esphome/components/espnow/espnow.h
View file

@ -8,7 +8,6 @@
#include "esphome/core/bytebuffer.h" #include "esphome/core/bytebuffer.h"
#include <esp_now.h> #include <esp_now.h>
#include <esp_crc.h>
#include <array> #include <array>
#include <memory> #include <memory>
@ -27,7 +26,7 @@ static const uint8_t ESPNOW_DATA_PROTOCOL = 0x03;
static const uint8_t ESPNOW_DATA_PACKET = 0x07; static const uint8_t ESPNOW_DATA_PACKET = 0x07;
static const uint8_t ESPNOW_DATA_CONTENT = 0x08; static const uint8_t ESPNOW_DATA_CONTENT = 0x08;
static const uint8_t MAX_ESPNOW_DATA_SIZE = 240; static const uint8_t MAX_ESPNOW_DATA_SIZE = 241;
static const uint8_t MAX_NUMBER_OF_RETRYS = 5; static const uint8_t MAX_NUMBER_OF_RETRYS = 5;
@ -46,7 +45,6 @@ struct ESPNowPacket {
uint8_t header[3]{'N', '0', 'w'}; uint8_t header[3]{'N', '0', 'w'};
uint32_t protocol{0}; uint32_t protocol{0};
uint8_t sequents{0}; uint8_t sequents{0};
uint8_t crc{0};
} __attribute__((packed)) prefix; } __attribute__((packed)) prefix;
uint8_t payload[MAX_ESPNOW_DATA_SIZE + 1]{0}; uint8_t payload[MAX_ESPNOW_DATA_SIZE + 1]{0};
} __attribute__((packed)) content; } __attribute__((packed)) content;
@ -63,7 +61,6 @@ struct ESPNowPacket {
this->protocol(protocol); this->protocol(protocol);
this->size = size; this->size = size;
std::memcpy(this->payload_as_bytes(), data, size); std::memcpy(this->payload_as_bytes(), data, size);
this->calc_crc();
} }
// Load received packet's. // Load received packet's.
ESPNowPacket(uint64_t peer, const uint8_t *data, uint8_t size) ESPHOME_ALWAYS_INLINE { ESPNowPacket(uint64_t peer, const uint8_t *data, uint8_t size) ESPHOME_ALWAYS_INLINE {
@ -86,16 +83,10 @@ struct ESPNowPacket {
uint8_t content_size() const { return ((*this).prefix_size() + (*this).size); } uint8_t content_size() const { return ((*this).prefix_size() + (*this).size); }
inline uint32_t protocol() const { return this->content.prefix.protocol; } inline uint32_t protocol() const { return this->content.prefix.protocol; }
inline void protocol(uint32_t protocol) ESPHOME_ALWAYS_INLINE { inline void protocol(uint32_t protocol) ESPHOME_ALWAYS_INLINE { this->content.prefix.protocol = protocol; }
this->content.prefix.protocol = protocol;
this->calc_crc();
}
uint8_t sequents() const { return (*this).content.prefix.sequents; } uint8_t sequents() const { return (*this).content.prefix.sequents; }
inline void sequents(uint8_t sequents) ESPHOME_ALWAYS_INLINE { inline void sequents(uint8_t sequents) ESPHOME_ALWAYS_INLINE { this->content.prefix.sequents = sequents; }
this->content.prefix.sequents = sequents;
this->calc_crc();
}
inline uint8_t *content_as_bytes() const { return (uint8_t *) &(this->content); } inline uint8_t *content_as_bytes() const { return (uint8_t *) &(this->content); }
inline uint8_t *payload_as_bytes() const { return (uint8_t *) &(this->content.payload); } inline uint8_t *payload_as_bytes() const { return (uint8_t *) &(this->content.payload); }
@ -104,24 +95,12 @@ struct ESPNowPacket {
return *(((uint8_t *) &this->content) + pos); return *(((uint8_t *) &this->content) + pos);
} }
inline uint8_t crc() const { return this->content.prefix.crc; }
inline void crc(uint8_t crc) { this->content.prefix.crc = crc; }
void calc_crc() {
this->content.prefix.crc = 0;
uint8_t crc = esp_crc8_le(0, this->peer_as_bytes(), 6);
this->content.prefix.crc = esp_crc8_le(crc, (const uint8_t *) this->content_as_bytes(), this->content_size());
}
inline void retry() ESPHOME_ALWAYS_INLINE { attempts++; } inline void retry() ESPHOME_ALWAYS_INLINE { attempts++; }
inline bool is_valid() {
uint16_t tmp_crc = crc(); inline bool is_valid() const {
this->calc_crc();
bool valid = (memcmp((const void *) this->content_as_bytes(), (const void *) &TRANSPORT_HEADER, 3) == 0); bool valid = (memcmp((const void *) this->content_as_bytes(), (const void *) &TRANSPORT_HEADER, 3) == 0);
valid &= (this->protocol() != 0); valid &= (this->protocol() != 0);
valid &= (this->crc() == tmp_crc); return true; // valid;
this->crc(tmp_crc);
return valid;
} }
}; };
@ -256,6 +235,8 @@ class ESPNowComponent : public Component {
TaskHandle_t espnow_task_handle_{nullptr}; TaskHandle_t espnow_task_handle_{nullptr};
bool task_running_{false}; bool task_running_{false};
uint32_t conformation_timeout_{5000};
static ESPNowComponent *static_; // NOLINT static ESPNowComponent *static_; // NOLINT
}; };