Struct Client 

pub struct Client { /* private fields */ }

Client for discovering ESPHome devices using mDNS. This client allows you to discover devices on the local network that are running ESPHome and have the mDNS service enabled.

Requires the discovery feature to be enabled.

Usage:

use esphome_client::discovery::Client;

#[tokio::main]
async fn main() {
    let mut discovery_results = Client::default().discover().expect("Results");
    while let Ok(device) = discovery_results.next().await {   
        println!("Discovered device: {device:?}");
    }
}

Implementations

impl Client

pub fn with_interface_ip(self, addr: IpAddr) -> Self

Set the interface ip to discover devices on. If not set, it will use the all interfaces.

pub fn with_interface(self, interface: &str) -> Self

Set the interface name to discover devices on. If not set, it will use the all interfaces.

pub fn with_service_name(self, service_name: impl Into<String>) -> Self

Set the service name to filter devices by. If not set, it will default to _esphomelib._tcp.local.

pub const fn with_interval(self, interval: Duration) -> Self

Set custom ip check interval. Defaults to the default interval of the mdns-sd crate.

pub fn discover(self) -> Result<ResultStream, Error>

Initialize the discovery client and start discovering devices.

Errors

Will return Error if discovery cannot be started due to initialization issues,

Trait Implementations

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Client

fn default() -> Client

Returns the “default value” for a type.