development/api/espnow__peer__store_8hpp_source.html

#pragma once


#include "espnow_security.hpp"

#include <cstdint>


namespace PeerStore {


void Init(SecuritySettings& sec,

          const uint8_t* preconfigured_mac = nullptr,

          DeviceType preconfigured_type = DeviceType::Unknown,

          const char* preconfigured_name = nullptr) noexcept;


bool AddPeer(SecuritySettings& sec, const uint8_t mac[6],

             DeviceType type, const char* name) noexcept;


bool RemovePeer(SecuritySettings& sec, const uint8_t mac[6]) noexcept;


bool IsPeerApproved(const SecuritySettings& sec, const uint8_t mac[6]) noexcept;


const ApprovedPeer* GetPeer(const SecuritySettings& sec, const uint8_t mac[6]) noexcept;


bool GetFirstPeerOfType(const SecuritySettings& sec, DeviceType type,

                        uint8_t mac_out[6]) noexcept;


void Save(const SecuritySettings& sec) noexcept;


size_t GetPeerCount(const SecuritySettings& sec) noexcept;


void ClearAll(SecuritySettings& sec) noexcept;


void LogPeers(const SecuritySettings& sec) noexcept;


} // namespace PeerStore


espnow_security.hpp
ESP-NOW security and pairing protocol definitions.

DeviceType
DeviceType
Device type identifiers for mutual verification.
Definition espnow_security.hpp:140

DeviceType::Unknown
@ Unknown

PeerStore
Definition espnow_peer_store.hpp:14

PeerStore::ClearAll
void ClearAll(SecuritySettings &sec) noexcept
Clear all approved peers (factory reset).
Definition espnow_peer_store.cpp:279

PeerStore::Save
void Save(const SecuritySettings &sec) noexcept
Save the current peer list to NVS.
Definition espnow_peer_store.cpp:230

PeerStore::IsPeerApproved
bool IsPeerApproved(const SecuritySettings &sec, const uint8_t mac[6]) noexcept
Check if a MAC address is in the approved peer list.
Definition espnow_peer_store.cpp:173

PeerStore::RemovePeer
bool RemovePeer(SecuritySettings &sec, const uint8_t mac[6]) noexcept
Remove a peer by MAC address.
Definition espnow_peer_store.cpp:158

PeerStore::GetPeerCount
size_t GetPeerCount(const SecuritySettings &sec) noexcept
Get the number of valid approved peers.
Definition espnow_peer_store.cpp:262

PeerStore::GetFirstPeerOfType
bool GetFirstPeerOfType(const SecuritySettings &sec, DeviceType type, uint8_t mac_out[6]) noexcept
Get the first valid peer MAC of a specific device type.
Definition espnow_peer_store.cpp:210

PeerStore::GetPeer
const ApprovedPeer * GetPeer(const SecuritySettings &sec, const uint8_t mac[6]) noexcept
Get peer information by MAC address.
Definition espnow_peer_store.cpp:194

PeerStore::LogPeers
void LogPeers(const SecuritySettings &sec) noexcept
Log all approved peers (for debugging).
Definition espnow_peer_store.cpp:289

PeerStore::Init
void Init(SecuritySettings &sec, const uint8_t *preconfigured_mac=nullptr, DeviceType preconfigured_type=DeviceType::Unknown, const char *preconfigured_name=nullptr) noexcept
Initialize peer storage and load approved peers from NVS.
Definition espnow_peer_store.cpp:32

PeerStore::AddPeer
bool AddPeer(SecuritySettings &sec, const uint8_t mac[6], DeviceType type, const char *name) noexcept
Add a new approved peer to storage.
Definition espnow_peer_store.cpp:110

ApprovedPeer
Information about an approved (paired) peer.
Definition espnow_security.hpp:240

SecuritySettings
Security settings stored in NVS.
Definition espnow_security.hpp:251