discovery.hpp

Go to the documentation of this file.

#pragma once
 
 
#include <esphome/api/bytes.hpp>
 
#include <chrono>
#include <cstdint>
#include <map>
#include <string>
#include <vector>
 
namespace esphome::api {
 
struct DiscoveredDevice {
    std::string name;
    std::string hostname;
    std::string address;
    std::uint16_t port = 6053;
 
    // Common TXT metadata (also available verbatim in `properties`).
    std::string mac;
    std::string version;
    std::string friendly_name;
    std::string platform;
    std::string board;
    std::string network;
    std::string project_name;
    std::string project_version;
 
    bool requires_encryption = false;
    bool supports_encryption = false;
 
    std::map<std::string, std::string> properties;
 
    [[nodiscard]] std::string connect_host() const {
        return address.empty() ? hostname : address;
    }
};
 
class Discovery {
public:
    static std::vector<DiscoveredDevice>
    scan(std::chrono::milliseconds timeout = std::chrono::milliseconds(2000));
};
 
std::vector<DiscoveredDevice> parse_mdns_packets(const std::vector<ByteBuffer>& packets);
 
}  // namespace esphome::api