145 lines
4.7 KiB
C++
145 lines
4.7 KiB
C++
#ifndef _QUICK_ESPNOW_ESP8266_h
|
|
#define _QUICK_ESPNOW_ESP8266_h
|
|
#ifdef ESP8266
|
|
|
|
#include "Arduino.h"
|
|
#include "Comms_hal.h"
|
|
|
|
#include <espnow.h>
|
|
#include <ESP8266WiFi.h>
|
|
#include "RingBuffer.h"
|
|
// Disable debug dependency if debug level is 0
|
|
#if DEBUG_LEVEL > 0
|
|
#include <QuickDebug.h>
|
|
constexpr auto QESPNOW_TAG = "QESPNOW";
|
|
#else // DEBUG_LEVEL
|
|
#define DEBUG_ERROR(...)
|
|
#define DEBUG_INFO(...)
|
|
#define DEBUG_VERBOSE(...)
|
|
#define DEBUG_WARN(...)
|
|
#define DEBUG_DBG(...)
|
|
#endif
|
|
|
|
//#define MEAS_TPUT
|
|
|
|
static const uint8_t ESPNOW_BROADCAST_ADDRESS[] = { 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF };
|
|
static const uint8_t MIN_WIFI_CHANNEL = 0;
|
|
static const uint8_t MAX_WIFI_CHANNEL = 14;
|
|
static const uint8_t CURRENT_WIFI_CHANNEL = 255;
|
|
static const size_t ESPNOW_MAX_MESSAGE_LENGTH = 255; ///< @brief Maximum message length
|
|
static const uint8_t ESPNOW_ADDR_LEN = 6; ///< @brief Address length
|
|
static const uint8_t ESPNOW_QUEUE_SIZE = 3; ///< @brief Queue size
|
|
static const int TASK_PERIOD = 10; ///< @brief Rx and Tx tasks period
|
|
#ifdef MEAS_TPUT
|
|
static const time_t MEAS_TP_EVERY_MS = 10000; ///< @brief Measurement time period
|
|
#endif // MEAS_TPUT
|
|
|
|
#define ESP_NOW_ETH_ALEN 6
|
|
#define ESP_NOW_MAX_DATA_LEN 250
|
|
#define WIFI_IF_STA STATION_IF
|
|
#define WIFI_IF_AP SOFTAP_IF
|
|
|
|
typedef enum {
|
|
ESP_NOW_SEND_SUCCESS = 0, /**< Send ESPNOW data successfully */
|
|
ESP_NOW_SEND_FAIL, /**< Send ESPNOW data fail */
|
|
} esp_now_send_status_t;
|
|
|
|
typedef struct {
|
|
uint16_t frame_head;
|
|
uint16_t duration;
|
|
uint8_t destination_address[6];
|
|
uint8_t source_address[6];
|
|
uint8_t broadcast_address[6];
|
|
uint16_t sequence_control;
|
|
|
|
uint8_t category_code;
|
|
uint8_t organization_identifier[3]; // 0x18fe34
|
|
uint8_t random_values[4];
|
|
struct {
|
|
uint8_t element_id; // 0xdd
|
|
uint8_t lenght; //
|
|
uint8_t organization_identifier[3]; // 0x18fe34
|
|
uint8_t type; // 4
|
|
uint8_t version;
|
|
uint8_t body[0];
|
|
} vendor_specific_content;
|
|
} __attribute__ ((packed)) espnow_frame_format_t;
|
|
|
|
typedef struct {
|
|
uint8_t dstAddress[ESPNOW_ADDR_LEN]; /**< Message topic*/
|
|
uint8_t payload[ESPNOW_MAX_MESSAGE_LENGTH]; /**< Message payload*/
|
|
size_t payload_len; /**< Payload length*/
|
|
} comms_tx_queue_item_t;
|
|
|
|
typedef struct {
|
|
uint8_t srcAddress[ESPNOW_ADDR_LEN]; /**< Source Address */
|
|
uint8_t dstAddress[ESPNOW_ADDR_LEN]; /**< Destination Address */
|
|
uint8_t payload[ESPNOW_MAX_MESSAGE_LENGTH]; /**< Message payload */
|
|
size_t payload_len; /**< Payload length */
|
|
int8_t rssi; /**< RSSI */
|
|
} comms_rx_queue_item_t;
|
|
|
|
class QuickEspNow : public Comms_halClass {
|
|
public:
|
|
QuickEspNow () :
|
|
tx_queue (ESPNOW_QUEUE_SIZE), rx_queue (ESPNOW_QUEUE_SIZE) {}
|
|
bool begin (uint8_t channel = 255, uint32_t interface = 0, bool synchronousSend = true) override;
|
|
void stop () override;
|
|
comms_send_error_t send (const uint8_t* dstAddress, const uint8_t* payload, size_t payload_len) override;
|
|
comms_send_error_t sendBcast (const uint8_t* payload, size_t payload_len) {
|
|
return send (ESPNOW_BROADCAST_ADDRESS, payload, payload_len);
|
|
}
|
|
void onDataRcvd (comms_hal_rcvd_data dataRcvd) override;
|
|
void onDataSent (comms_hal_sent_data sentResult) override;
|
|
uint8_t getAddressLength () override { return ESPNOW_ADDR_LEN; }
|
|
uint8_t getMaxMessageLength () override { return ESPNOW_MAX_MESSAGE_LENGTH; }
|
|
void enableTransmit (bool enable) override;
|
|
bool setChannel (uint8_t channel);
|
|
bool readyToSendData ();
|
|
|
|
protected:
|
|
uint8_t wifi_if;
|
|
ETSTimer espnowTxTask;
|
|
ETSTimer espnowRxTask;
|
|
#ifdef MEAS_TPUT
|
|
ETSTimer dataTPTimer;
|
|
unsigned long txDataSent = 0;
|
|
unsigned long rxDataReceived = 0;
|
|
unsigned long txDataDropped = 0;
|
|
time_t lastDataTPMeas = 0;
|
|
float txDataTP = 0;
|
|
float rxDataTP = 0;
|
|
float txDroppedDataRatio = 0;
|
|
|
|
static void tp_timer_cb (void* param);
|
|
void calculateDataTP ();
|
|
#endif // MEAS_TPUT
|
|
|
|
bool readyToSend = true;
|
|
|
|
bool waitingForConfirmation = false;
|
|
bool synchronousSend = false;
|
|
uint8_t sentStatus;
|
|
int queueSize = ESPNOW_QUEUE_SIZE;
|
|
|
|
RingBuffer<comms_tx_queue_item_t> tx_queue;
|
|
RingBuffer<comms_rx_queue_item_t> rx_queue;
|
|
//uint8_t channel;
|
|
bool followWiFiChannel = false;
|
|
|
|
bool initComms ();
|
|
static void espnowTxTask_cb (void* param);
|
|
static void espnowRxTask_cb (void* param);
|
|
int32_t sendEspNowMessage (comms_tx_queue_item_t* message);
|
|
void espnowTxHandle ();
|
|
void espnowRxHandle ();
|
|
|
|
|
|
static void ICACHE_FLASH_ATTR rx_cb (uint8_t* mac_addr, uint8_t* data, uint8_t len);
|
|
static void ICACHE_FLASH_ATTR tx_cb (uint8_t* mac_addr, uint8_t status);
|
|
};
|
|
|
|
extern QuickEspNow quickEspNow;
|
|
|
|
#endif // ESP8266
|
|
#endif // _QUICK_ESPNOW_ESP8266_h
|