ESP_NOW_HR Library

Overview

This library helps initialize the ESP-NOW protocol, utilizing all its important tools. It addresses common issues that may be overlooked. If you are unfamiliar with the ESP-NOW protocol and its applications, this library provides the guidance you need to use it to its fullest potential.

Table of Contents

• Installation
• Usage
• Examples
• Changelog
• Warnings
• License

Installation

To install the ESP_NOW_HR library, follow these steps:

1. Download the latest release from the releases page.
2. Open the Arduino IDE.
3. Go to Sketch > Include Library > Add .Zip library...
4. Search for "QuickESPNow-main" and click Open.

Usage

1. Include the library in your sketch: #include <esp_now_HR.h>
2. Initialize an ESP_NOW_HR object with desired communication parameters.
3. Note that the Serial.begin() must always be called for the library to work before the object initialization.
4. Call the begin() method to start the protocol.
5. Call the appropriate addPeer() method to give the information of the peer.

#include <QuickESPNow.h>

#define PEERS 3

uint8_t MAC[MAC_LENGTH] = {/*Your MAC adress*/};
uint8_t PEERS_MAC[PEERS][MAC_LENGTH] = {
    {/*Your peers MAC adress*/},
    {/*Your peers MAC adress*/},
    {/*Your peers MAC adress*/}
    };

// Initialize ESP_NOW_HR object
QuickESPNow myesp(SENDER, PEERS, MAC);

void setup() {
    Serial.begin(115200);
    
    // Initialize ESP-NOW
    myesp.begin();

    myesp.addPeer(0, PEERS_MAC[0], 0, WIFI_IF_STA);
    myesp.addPeer(1, PEERS_MAC[1], 0, WIFI_IF_STA);
    myesp.addPeer(2, PEERS_MAC[2], 0, WIFI_IF_STA);

    // Check for initialization errors
    myesp.FAIL_CHECK();
}

void loop() {
    // Your code here
}

Examples

SENDER EXAMPLE

#include "QuickESPNow.h"


uint8_t MACS[4][MAC_LENGTH] = {
  {0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA},
  {0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAB},
  {0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAC},
  {0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAD}
};

uint8_t Senders_MAC[MAC_LENGTH] = {0xCA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA};

QuickESPNow my_esp(SENDER, 4, Senders_MAC);

void setup() {
  Serial.begin(115200);

  my_esp.begin();
  my_esp.addPeer(0, MACS[0], 0, WIFI_IF_STA);
  my_esp.addPeer(1, MACS[1], 0, WIFI_IF_STA);
  my_esp.addPeer(2, MACS[2], 0, WIFI_IF_STA);
  my_esp.addPeer(3, MACS[3], 0, WIFI_IF_STA);
  my_esp.FAIL_CHECK();
}

void loop() {
  my_esp.Send(0, 1);\\ sends to esp that was assigned id:0 in the addPeer method
  delay(1000);
  my_esp.Send(1, 1);
  delay(1000);
  my_esp.Send(2, 1);
  delay(1000);
  my_esp.Send(3, 1);
  delay(1000);
  my_esp.Send(2, 1);
  delay(1000);
  my_esp.Send(1, 1);
  delay(1000);
  my_esp.Send(0, 1);
  delay(1000);
  my_esp.Send(3, 5);
  delay(5000);
}

RECIEVER CODE

#include "QuickESPNow.h"

#define ID 3

int timer = 5;
int led = 0;

uint8_t MACS[4][MAC_LENGTH] = {
  {0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA},
  {0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAB},
  {0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAC},
  {0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAD}
};

uint8_t senders_MAC[MAC_LENGTH] = {0xFF, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA};

QuickESPNow my_esp(RECEIVER, 1, MACS[ID]);

void setup() {
  Serial.begin(115200);
  pinMode(led, OUTPUT);

  my_esp.begin();
  my_esp.addPeer(0, senders_MAC, 0, WIFI_IF_STA);
  my_esp.FAIL_CHECK();
  // my_esp.FAIL_CHECK();
}

void loop() {
  if(my_esp.available()){
    timer = my_esp.read<int>();
  }

  if(timer > 0){
    digitalWrite(led, HIGH);
    sleep(timer);
    digitalWrite(led, LOW);
    timer = 0;
  }
}

Changelog

Enhancements

• Improved Peer Management: Fixed issues with adding multiple peers, ensuring stable and reliable communication.
• Generic Send Function: Refactored the Send function to be more flexible, allowing any data type to be sent using a single function (Send) instead of separate functions for each type.
• Custom Queue Implementation: Introduced a dynamic message queue for storing messages, and optimizing memory usage.
• User-defined Callbacks: Added functionality for users to set their own custom data send and receive functions, increasing flexibility.
• Encryption Enhancements: Fixed encryption problems and added support for both PMK and LMK keys to improve security.
• Support for AP and STA Modes: Enhanced the class to support both Station (STA) and Access Point (AP) modes, which were previously limited to STA only.
• Channel Communication Fixes: Correctly implemented message sending across different channels, not just channel 1.
• Board Support: Added esp32 2.0.27 board version compatibility together with the 3.x.x board versions.
• Sending Types: Introduced custom struct message communication.

Bug Fixes

• Resolved issues with sending messages to peers on channels other than channel 1.
• Fixed encryption issues to ensure proper data security.
• Fixed the unknown variable type sending

Warnings

This library can only work with these board versions of the esp32 board manager in arduino:

• 3.x.x
• 2.0.17

License

MIT License

Copyright (c) 2024 HYPERION ROBOTICS

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

The author of this software shall not be held liable for any damages, liabilities, or legal consequences arising from the use, misuse, or inability to use the software.