UPnP Library: Library for discovering and invoking UPnP devices.

Version: 1:0

UPnP Library: Library for discovering and invoking UPnP devices.

Edward Blake

License: MIT Web: http://github.com/edwardlblake/rkt-upnp

(require (planet edwardlblake/upnp:1:0))

1 Introduction

This is a Racket library for discovering, accessing and invoking UPnP services.

This UPnP library currently only implements the client side, that is the service consumer.

2 How it works

First you must initiate a search with upnp-discovery which will begin to collect service advertisements via UDP, when you are ready you can search for a UPnP service by service ID or type. Finally you create a "service wrapper" from a UPnP service.

(define d (upnp-discovery))

(define s (upnp-search-service-srvid d "urn:upnp-org:serviceId:WANIPConn1"))

(define c (upnp-make-service-wrapper s))

With the service wrapper, you can create functions that wrap SOAP request calls to the UPnP service:

(define get-external-ip

(c "GetExternalIPAddress" '("NewExternalIPAddress")))

(define add-port-mapping

(c "AddPortMapping" '()

"NewRemoteHost" "NewExternalPort" "NewProtocol"

"NewInternalPort" "NewInternalClient" "NewEnabled"

"NewPortMappingDescription" "NewLeaseDuration"))

And then use (get-external-ip) to get the external ip, or use (add-port-mapping ...) with the parameters.

3 Known Issues

At this moment, this library seems to work fine to grab an IP address on my personal router :). This library is relatively new, so certain things might not work quite right or might not work at all with different brands of routers, other networking equipment and anything else that might provide UPnP services.

4 History

PLaneT 1:0 — 2012-11-16
Initial release.

5 Legal

Copyright (c) 2012 Edward L. Blake Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.