Larusso / rust-upnp

Rust crate providing basic UPnP protocol implementations

Crate upnp-rs

A Rust crate providing basic Universal Plug and Play (UPnP) protocol implementations.

Implements the core protocols of the UPnP Device Architecture (UDA), specifically the discovery protocol for control points to search for, and devices to notify of, device and service availability.

UPnP technology allows devices to connect seamlessly and to simplify network implementation in the home and corporate environments — Open Connectivity Foundation.

Usage

Add the following to your Cargo.toml; currently this crate has no optional features.

upnp-rs = "0.1"

API

The main client interface is the discovery module that provides search and notify capabilities. Over time the description module will be completed for the parsing and generation of device description messages. The following diagram shows the basic structure of the library with the two API modules relying on implementations of HTTPMU/HTTPU and SOAP respectively.

,--------, discover ,--------,     advertise     ,--------,
|        |--------->| disco. |<------------------|        |
| Client |          '--------'                   | Server |
|  API   | understand   :    ,--------, describe |  API   |
|        |------------------>| descr. |<---------|        |
'--------'              :    '--------'          '--------'
                        :         :
                        :         V
                        :    ,--------,
                        :    |  SOAP  |
                        :    '--------'
                        :         :
                        V         :
                    ,--------,    :
                    | HTTPMU |    :
                    '--------'    :
                        :         :
                        V         V              TCP/UDP
    ,---------------------------------------------------,

Example

use upnp_rs::SpecVersion;
use upnp_rs::ssdp::search::*;

let mut options = Options::default_for(SpecVersion::V10);
options.search_target = SearchTarget::RootDevices;

match search_once(options) {
    Ok(responses) => {
        println!("search returned {} results.", responses.len());
        for (index, response) in responses.iter().enumerate() {
            println!("{}: {:#?}", index, response);
        }
    }
    Err(error) => {
        println!("search failed with error: {:#?}", error);
    }
}

Command-Line

The command-line tool upnp can be used to perform basic operations using the SSDP API. Primarily these are used for testing, but the search command can be used for general purpose discovery.

The general form of the command is network-options command command-options, as shown below.

USAGE
    upnp [-v|--verbose]+ [--interface=] [--ip-version=] COMMAND

COMMANDS
    search [-s|--search-target=] [-d|--domain=] [-w|--max-wait=]

• interface this is the name of a local network interface such as en0.
• ip-version denotes that the client should only use IP version 4 or 6.
• search-target denotes the scope of the search, valid values are all, root, device:id, device-type:id, or service-type:id,
• domain a domain to use for device/service types other than the default schemas-upnp-org.
• max-wait the wait time for replies, sent to devices to prevent message flooding.

Changes

Version 0.1.0

• Ability to issue multicast non-caching search command, with parsed results.
• Ability to send multicast device notifications.
• Command-line tool upnp to issue test commands.

TODO

1. Finish parsing search results.
2. Support listening for notifications.
3. Support fetching device details.
4. Support for sending notifications.