#async #upnp #networking #protocols

rupnp

An asynchronous library for finding UPnP control points, performing actions on them and reading their service descriptions

10 releases (2 stable)

1.1.1 Feb 21, 2022
1.1.0 Feb 17, 2022
1.0.0 Dec 23, 2020
0.1.7 Nov 11, 2020
0.1.5 Apr 27, 2020

#1302 in Network programming

Download history 78/week @ 2022-06-09 91/week @ 2022-06-16 57/week @ 2022-06-23 110/week @ 2022-06-30 80/week @ 2022-07-07 57/week @ 2022-07-14 104/week @ 2022-07-21 120/week @ 2022-07-28 116/week @ 2022-08-04 97/week @ 2022-08-11 121/week @ 2022-08-18 140/week @ 2022-08-25 67/week @ 2022-09-01 120/week @ 2022-09-08 80/week @ 2022-09-15 75/week @ 2022-09-22

357 downloads per month
Used in 4 crates (3 directly)

MIT/Apache

50KB
1K SLoC

GitHub last commit Crates.io

rupnp

An asynchronous library for finding UPnP control points, performing actions on them and reading their service descriptions. UPnP stand for Universal Plug and Play and is widely used for routers, WiFi-enabled speakers and media servers.

Spec: http://rupnp.org/specs/arch/UPnP-arch-DeviceArchitecture-v2.0.pdf

Example usage:

The following code searches for devices that have a RenderingControl service and print their names along with their current volume.

use futures::prelude::*;
use std::time::Duration;
use rupnp::ssdp::{SearchTarget, URN};

const RENDERING_CONTROL: URN = URN::service("schemas-upnp-org", "RenderingControl", 1);

#[tokio::main]
async fn main() -> Result<(), rupnp::Error> {
    let search_target = SearchTarget::URN(RENDERING_CONTROL);
    let devices = rupnp::discover(&search_target, Duration::from_secs(3)).await?;
    pin_utils::pin_mut!(devices);

    while let Some(device) = devices.try_next().await? {
        let service = device
            .find_service(&RENDERING_CONTROL)
            .expect("searched for RenderingControl, got something else");

        let args = "<InstanceID>0</InstanceID><Channel>Master</Channel>";
        let response = service.action(device.url(), "GetVolume", args).await?;

        let volume = response.get("CurrentVolume").unwrap();

        println!("'{}' is at volume {}", device.friendly_name(), volume);
    }

    Ok(())
}

License

Licensed under either of

at your option.

Contribution

Please use rustfmt before any pull requests.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Dependencies

~5–10MB
~165K SLoC