Oakrey.Network.Upnp 1.0.0

Oakrey.Network.Upnp

Overview

The "Upnp" project is a .NET 8 library that provides functionality for discovering and interacting with Universal Plug and Play (UPnP) devices. It enables developers to search for UPnP devices, retrieve their service descriptions, and parse device details using reactive programming principles.

Features

UPnP Device Discovery:

The UPnPSearchService class performs searches for UPnP devices using the SSDP protocol. Devices are discovered via multicast M-SEARCH requests sent through the MSearchSocket and MSearchEndPoint.

Service Descriptions:

The ServiceDescription class parses and encapsulates details from SSDP responses, such as location, server, and unique service name (USN). The SsdpDescription class parses XML-based device descriptions, extracting properties like device type, manufacturer, and model information.

Reactive Programming:

Implements IObservable<ServiceDescription> to notify subscribers about discovered devices in real-time.

Extensibility:

Provides methods to retrieve and parse detailed service descriptions (GetServiceDescription) and device description files (GetDescriptionFile).

Concurrency and Cancellation:

Supports cancellation of device searches using CancellationToken.

Integration with SSDP:

Leverages SSDP for device discovery and integrates with HTTP for retrieving device description files.

Installation

You can install the package via NuGet Package Manager, Package Manager Console or the .NET CLI.

NuGet Package Manager

1. Open your project in Visual Studio.
2. Navigate to Tools > NuGet Package Manager > Manage NuGet Packages for Solution....
3. Search for Oakrey.Network.Upnp and click Install.

.NET CLI

Run the following command in your terminal:

dotnet add package Oakrey.Network.Upnp

Package Manager Console

Run the following command in your Package Manager Console:

Install-Package Oakrey.Network.Upnp

Requirements

• .NET 8 or higher

Project Information

• Author: Oakrey
• Company: Oakrey
• License: MIT
• Repository: Git Repository
• Project URL: Project Website

Contributing

Contributions are welcome! Feel free to open issues or submit pull requests to improve the package.

License

This project is licensed under the MIT License. See the LICENSE file for details.