WifiEspNowBroadcast.setKey

refs #5

library.properties

@@ -1,9 +1,9 @@
 name=WifiEspNow
-version=0.0.20201226
+version=0.0.20210821
 author=Junxiao Shi
 maintainer=Junxiao Shi
 sentence=ESP-NOW for ESP8266 and ESP32.
 paragraph=This library supports ESP-NOW, a connectionless WiFi communication protocol defined by Espressif. It contains a simple wrapper of ESP-NOW functions, as well as a custom pseudo broadcast protocol.
 category=Communication
-url=https://yoursunny.com
+url=https://wifiespnow.yoursunny.dev/
 architectures=esp8266,esp32

src/WifiEspNow.cpp

@@ -13,8 +13,6 @@
 
 WifiEspNowClass WifiEspNow;
 
-WifiEspNowClass::WifiEspNowClass() = default;
-
 bool
 WifiEspNowClass::begin()
 {

src/WifiEspNow.h

@@ -40,8 +40,6 @@ enum class WifiEspNowSendStatus : uint8_t {
 class WifiEspNowClass
 {
 public:
-  WifiEspNowClass();
-
   /**
    * @brief Initialize ESP-NOW.
    * @return whether success.

src/WifiEspNowBroadcast.cpp

@@ -10,7 +10,7 @@
 #error "This library supports ESP8266 and ESP32 only."
 #endif
 
-#define WIFIESPNOW_DEBUG
+// #define WIFIESPNOW_DEBUG
 #ifdef WIFIESPNOW_DEBUG
 #define LOG(...)                                                                                   \
   do {                                                                                             \
@@ -25,10 +25,6 @@
 
 WifiEspNowBroadcastClass WifiEspNowBroadcast;
 
-WifiEspNowBroadcastClass::WifiEspNowBroadcastClass()
-  : m_isScanning(false)
-{}
-
 bool
 WifiEspNowBroadcastClass::begin(const char* ssid, int channel, int scanFreq)
 {
@@ -67,6 +63,19 @@ WifiEspNowBroadcastClass::loop()
 #endif
 }
 
+bool
+WifiEspNowBroadcastClass::setKey(const uint8_t primary[WIFIESPNOW_KEYLEN],
+                                 const uint8_t peer[WIFIESPNOW_KEYLEN])
+{
+  if (peer == nullptr) {
+    m_hasPeerKey = false;
+    return true;
+  }
+  m_hasPeerKey = true;
+  std::copy_n(peer, WIFIESPNOW_KEYLEN, m_peerKey);
+  return WifiEspNow.setPrimaryKey(primary);
+}
+
 void
 WifiEspNowBroadcastClass::scan()
 {
@@ -180,7 +189,7 @@ WifiEspNowBroadcastClass::processScan()
   FOREACH_AP([&](const uint8_t* mac, uint8_t channel) {
     LOG("processScan addPeer(%02x:%02x:%02x:%02x:%02x:%02x)", mac[0], mac[1], mac[2], mac[3],
         mac[4], mac[5]);
-    WifiEspNow.addPeer(mac, channel);
+    WifiEspNow.addPeer(mac, channel, m_hasPeerKey ? m_peerKey : nullptr);
   });
 
   DELETE_APS;

src/WifiEspNowBroadcast.h

@@ -8,8 +8,6 @@
 class WifiEspNowBroadcastClass
 {
 public:
-  WifiEspNowBroadcastClass();
-
   /**
    * @brief Initialize ESP-NOW with pseudo broadcast.
    * @param ssid AP SSID to announce and find peers.
@@ -32,6 +30,16 @@ class WifiEspNowBroadcastClass
   void
   loop();
 
+  /**
+   * @brief Set encryption keys.
+   * @param primary primary key, also known as KOK or PMK.
+   * @param peer peer key, also known as LMK; nullptr to disable encryption.
+   *             The same peer key is applied to every discovered peer.
+   * @return whether success.
+   */
+  bool
+  setKey(const uint8_t primary[WIFIESPNOW_KEYLEN], const uint8_t peer[WIFIESPNOW_KEYLEN] = nullptr);
+
   /**
    * @brief Set receive callback.
    * @param cb the callback.
@@ -73,9 +81,11 @@ class WifiEspNowBroadcastClass
 
 private:
   String m_ssid;
-  int m_scanFreq;
-  unsigned long m_nextScan;
-  bool m_isScanning;
+  uint8_t m_peerKey[WIFIESPNOW_KEYLEN];
+  int m_scanFreq = 0;
+  unsigned long m_nextScan = 0;
+  bool m_isScanning = false;
+  bool m_hasPeerKey = false;
 };
 
 /**