Project Description
ManagedUPnP is a library built in .NET 4 using C# for Visual Studio 2010 Express.

It uses the Microsoft UPnP COM Implementation.

It provides these features as a fully Managed code set:
  • Easily discover services and / devices using synchronous or asynchronous methods.
  • Use the UPnPDiscovery component, by dropping it on a form for easy asynchronous discovery of devices and services.
  • Load the device service descriptions, to determine the actions / arguments, and state variables supported by a device into structured classes to determine service capabilities.
  • Dynamically query StateVariables and call service Actions.
  • Generate classes for individual devices / services in the C# or VB.NET language
  • Receive events when evented State Variables change on services
  • Generate a total hierarchical tree of services and device classes for a device in the C# or VB.NET language
  • Has built-in functionality for advanced logging, simply attach to event and enable logging to get logging information in your program

Please see the discussions for some simple examples of how to use the library, also, if there is anything you need help with, please post in the discussions.

Included with the solution is the Library Project (ManagedUPnP) and a demo project (ManagedUPnPTest). The demo project will enumerate all available UPnP devices and allow the user to execute actions or query state variables. Also, a simple console project is included which demonstrates how to query a UPnP enabled modem for the true external IP address of the WAN connection.

NOTE: If you get DisconnectedContext or ContextSwtichDeadlock MDAs while using this library do not be concerned, simply disable the MDAs while debugging, more information can be found here:

http://managedupnp.codeplex.com/discussions/276221

Two projects I have made with this library are:

UPnP Monitor - http://home.exetel.com.au/amurgshere/upnpmonitor.phtml
Hardware Monitor - http://home.exetel.com.au/amurgshere/hwmonitor.phtml

I have personally tested (or had others test) these pieces of UPnP enabled hardware / software with this library:

Vuze - torrent downloader (software)
UPnP enabled Samsung TVs - allows you to control TV remotely
Netgear DG834G ADSL Modem / Router
Windows Media Player
PS3 Media Server

History

Version 2.1 Changes
  • Added new overload for "DeviceServiceDescription" to Service extension methods - this will get the DeviceServiceDescription object for that service, one optional parameter of useCache can be specified
  • ManagedUPnPTest has new "Properties" tab added for Services and Descriptions which displays all XML properties for that device or service (and device service in the case of a service)
  • Added GetSCPDUrl, GetControlURL and GetEventSubURL to DeviceServiceDescription (these urls are full URLs that you can use to get the documents or post data to)

Version 2.0 Changes
  • Added an extra overload for Discovery.FindServices(ipAddressFamily, resolveNetworkInterfaces), this will find all services in a synchronous manner.
  • Better support for new Adapters, AdapterUnicastIPAddressInformations, AdapterIPAddresses, RootHostAddresses, and RootHostName Device properties with IPv6 (removed address type checking).
  • Added more parameter checking with Find Services and raises exceptions.

Version 1.9 Changes
  • Added Adapters, AdapterUnicastIPAddressInformations, AdapterIPAddresses, RootHostAddresses, and RootHostName properties to Device class
  • Added NIC Device IP Addresses to device info in ManagedUPnPTest application
  • Added Description support for all UPnP datatypes: bin.base64, number, uuid, bin.hex
  • All new data types also support to and from string conversions
  • ManagedUPnPTest application now supports the reading and entering of byte array types (bin.Base64)
  • New property added to data type information attribute - AllowEmpty, is true if array or string datatypes can be empty
  • Added AddressFamily and ResolveNetworkInterfaces properties to AutoDiscoverServices class
  • Updated ManagedUPnP test to display IP addresses of conencted interfaces utilising the InterfaceGuid where available (Windows Vista and above)
  • Other minor bug fixes

Version 1.8 Changes
  • Code generation now supports VB.NET generation
  • ManagedUPnPTest updated to support new VB.NET code generation
  • New class added to ManagedUPnP.Components - LogInterceptor - a GUI thread safe ManagedUPnP logging component
  • Added LogInterceptor example to ComponentsTest project
  • More examples added via XML comments
  • Other minor bug fixes

Version 1.7 Changes
  • XML Comments added to code generation for Devices and Services including Service Action parameter properties
  • New WindowsFirewall static class added - This class can check the Windows firewall settings and fix them under Windows XP
  • More comphensive XML comments in the code
  • Brings code inline with new CHM help file located in Documentation section (more documentation to come)
  • Many little bug fixes

Version 1.6 Changes
  • NOTE: None of these changes should break any of your code, I have done my very best to keep it backward compatible
  • Code generation for Devices and Services is now smarter - it will not create empty Regions
  • Code generation for Services now adds generic typed events for each "Evented" state variable - saves you doing the work
  • New classes added in ManagedUPnP.Components namespace, the UPnPDiscovery component allows extremely easy access to discovering Devices and Services from a windows forms application asynchronously, simply drop the component on your form, add the events and set the Active property to true. This component will automatically take into account for GUI Thread related issues. See the example project.
  • New demo Project added to solution - ComponentsTest - demonstrating the UPnPDiscovery component
  • ManagedUPnPTest project now defers code generation of Services and Devices until after you click the tab - this reduces lag
  • New conditional defines added to allow you to compile ManagedUPnP.DLL without certain namespaces, see ConditionalDefines.CS in the root of the ManagedUPnP project for more information.
  • Added more XML comments to Discovery class to make it easier to understand
  • Many little bug fixes
  • PLANNED FOR FUTURE VERSION: XML Comments in all generated class code. including extra information about parameters and state variables
  • PLANNED FOR FUTURE VERSION: Proper documentation - thanks Chloh for the review! :)


Version 1.5 Changes
  • Fixed problem with generating service classes with default Services namespace (ManagedUPnP.Services was being confused with local namespace)

Version 1.4 Changes
  • Added Logging static class to ManagedUPnP namespace, simply use Logging.Enabled = true, and Logging.LogLines += to enable a verbose UPnP log for runtime debugging. This is great for Devices off site which have incorrect Or malformed XML.
  • Added Log box to ManagedUPnPTest project
  • Added Verbose Log option to ExternalIPAdress project (/V)
  • Added extra static functions to Service class code generation to get all services for the type and return array of class objects
  • Other minor enhancements (nothing that should break your code).

Version 1.1 Changes
  • Fixed problem with ServiceDescriptionCache where it wasnt using the RootDevice for the caching resulting in issues when using the cache (thanks to tbau from Whirlpool.net.au for his help with testing).
  • Other minor enhancements (nothing that should break your code).

Version 1.0 Changes
  • Now out of beta!
  • ArgumentsDescription list used to use a dictionary for its items, however, dictionaries are not garunteed to preserve order, the arguments must stay in order so they are accessible in the order that they need to be provided in the action calls, this has now been changed and this dictionary uses a OrderedIndexedDictionary instead.
  • Other minor changes (nothinn to break dependent code).

Version 0.93b Changes
  • ManagedUPnP namespace no longer needs the ManagedUPnP.Descriptions namespace to compile, this means you can include ManagedUPnP into your project but exclude the entire Descriptions (and CodeGEn) folder if you dont need it (Code generation still needs the descriptions namespace however). All functions are still provided as extension methods within the Descriptions namespace, so no other code should need to be changed, just your using clause.
  • All description related functions have been moved to ManagedUPnP.Descriptions as Extension Methods (so you may need to add using ManagedUPnP.Descriptions to some classes that you have written)
  • AutoDiscoveryServices status notifications have changed - COMDeviceNetworkInterfaceGuid and FullRootDeviceDescription have been replaced with DeviceFound - Use ((Device)data).InterfaceGuidAvailable and ((Device)data).InterfaceGuid to get the network interface guid if available, and use ((Device)data).RootDescriptionCache.Cache[ldDevice].ToStringWithFullServices() to get the root description. This is to prevent the description from being loaded unless necessary.
  • All description objects now have access to their Parent (Parent proeprty) description object as a polymorphic reference of type Description, a new protected method has been added to the description base class to get a certain generation of parent (see GetParentFrom). All constructors for the descriptions now require a parent to be passed, this can be null if no parent is valid. This change should not require any changes to dependent code unless you have created your own description objects (which should be very rare).
  • The ArgumentDescription object now has a new property: RelatedStateVariableDescription, which will get the actual related state variable description object if the state variable information is available.
  • The Discovery.FindServicesAsync incorrectly passed false for the resolveNetworkInterfaces parameter, this has been fixed by adding the parameter in and passing it to the FindDevicesAsync function call.
  • Demonstration apps updated where applicable for any changes.

Version 0.92b Changes
  • More static functions added to Discovery class to enable Async searching using delegate callback with timeout / number of devices (searching for Devices or Services is provided) see Discovery.FindDevicesAsync and Discovery.FindServicesAsync, of course the Discovery class can still be instantiated to use events.
  • Included with this download is the ExternalIPAddress console application, it demonstrates how to use ManagedUPnP to write a console application to show the user their external IP address on a UPnP enabled modem / router.

Version 0.91b
  • Contains the ability to fully generate classes for Devices and Services, whether it be generating them as standalone classes, or generating an entire tree of a device, the demonstration application has been updated as well to provide access to these features from a user interface.
  • Minor bug fixes with some devices which have malformed XML descriptions
  • Other minor bug fixes in the library and testing application
  • More functions added to Devices, and Device for finding devices by Type and / ModelName
  • Other enhancements (nothing that should break your code).

Version 0.9b
  • Initial release contains ability to discover services / devices
  • Easily get service and device descriptions to determine capabilities (as a structured class set)
  • Demo project included to provided user ability to navigate all UPnP devices and execute actions or query state variables

Please post bugs / suggestions in the discussions area.

Windows XP (runtime setup)

For windows XP users, you will need to turn on the Windows UPnP device discovery network component, to do this follow these instructions:
  • Select Start - Settings - Control Panel
  • Network Connections
  • In the menus select Advanced - Optional Networking Components...
  • Select Networking Services
  • Click Details
  • Place check mark next to "Internet Gateway Device Discovery and Control Client"
  • Click OK
  • Click next until complete

setting.PNG

Screenshots

DeviceInfo.PNG

DeviceCode.PNG

DeviceRecursiveCode.PNG

ServiceActionIn.PNG

ServiceActionOut.PNG

Last edited Oct 4 at 4:12 PM by TheToid, version 45