mac.h

Go to the documentation of this file.

// Copyright (c) 2024 anabrid GmbH
// Contact: https://www.anabrid.com/licensing/
//
// SPDX-License-Identifier: MIT OR GPL-2.0-or-later
 
#pragma once
 
#ifdef ARDUINO
 
#include "utils/json.h"
#include <IPAddress.h>
 
#include <array>
#include <cstdint>
#include <list>
#include <string>
 
namespace utils {
 
 
struct MacAddress {
  uint8_t mac[6] = {0};
  void reset(); 
  operator std::string() const;
  bool fromString(const char *str);
 
  uint8_t &operator[](size_t i) { return mac[i]; }
 
  const uint8_t &operator[](size_t i) const { return mac[i]; }
 
  static MacAddress otp() {
    MacAddress mac;
    mac.reset();
    return mac;
  }
};
 
void convertFromJson(JsonVariantConst serialized_mac, MacAddress &mac);
void convertToJson(const MacAddress &mac, JsonVariant serialized_mac);
 
std::string toString(const MacAddress &mac, char sep = '-');
std::string toString(const std::array<uint8_t, 8> &eui64, char sep='-');
std::string toString(const IPAddress &ip);
 
bool valid(const MacAddress &mac); 
bool valid(const IPAddress &ip);   
 
struct IPAddressMask {
  IPAddress address;
  IPAddress mask;
  // TODO: fromString, toString, contains(IPAddress)
};
 
struct IPMaskList {
  std::list<IPAddressMask> list;
  boolean contains(IPAddress); // true if any contains
};
 
// TODO implement!
// Probably want to serialize as *compact* if it is eeprom facing not user facing
inline void convertFromJson(JsonVariantConst serialized_iplist, IPMaskList &iplist) {}
 
inline void convertToJson(const IPMaskList &iplist, JsonVariant serialized_iplist) {}
 
} // namespace utils
 
// must be defined in global namespace, where Arduinos IPAddress lives
void convertFromJson(JsonVariantConst ipjson, IPAddress &ip);
void convertToJson(const IPAddress &ip, JsonVariant ipjson);
 
#endif // ARDUINO