Skip to content
UPnP client library for Go (#golang)
Go
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
cmd
dcps
example Add another example showing getting byte transfer counts on igd2. Dec 9, 2015
httpu Clarify code in HTTPUClient.Do. Apr 15, 2018
scpd
soap Fix formatting of an error message. Mar 4, 2018
ssdp Allow SSDP search results from inexact searches. Mar 15, 2018
.gitignore
LICENSE
README.md Switch to generate code with `go generate`. Oct 13, 2018
device.go Add correct spelling for RequestSCPD, mentioned in issue #23. Mar 4, 2018
go.mod Switch to generate code with `go generate`. Oct 13, 2018
go.sum Switch to generate code with `go generate`. Oct 13, 2018
goupnp.go Minor comment fix that could mislead. Jun 6, 2015
goupnp.sublime-project Add Sublime Text project file. Oct 13, 2018
service_client.go Add support for discovery-free client creation in dcps packages. Jun 6, 2015

README.md

goupnp is a UPnP client library for Go

Installation

Run go get -u github.com/huin/goupnp.

Documentation

Supported DCPs (you probably want to start with one of these):

  • GoDoc av1 - Client for UPnP Device Control Protocol MediaServer v1 and MediaRenderer v1.
  • GoDoc internetgateway1 - Client for UPnP Device Control Protocol Internet Gateway Device v1.
  • GoDoc internetgateway2 - Client for UPnP Device Control Protocol Internet Gateway Device v2.

Core components:

  • GoDoc (goupnp) core library - contains datastructures and utilities typically used by the implemented DCPs.
  • GoDoc httpu HTTPU implementation, underlies SSDP.
  • GoDoc ssdp SSDP client implementation (simple service discovery protocol) - used to discover UPnP services on a network.
  • GoDoc soap SOAP client implementation (simple object access protocol) - used to communicate with discovered services.

Regenerating dcps generated source code:

  1. Build code generator:

    go get -u github.com/huin/goupnp/cmd/goupnpdcpgen

  2. Regenerate the code:

    go generate ./...

Supporting additional UPnP devices and services:

Supporting additional services is, in the trivial case, simply a matter of adding the service to the dcpMetadata whitelist in cmd/goupnpdcpgen/metadata.go, regenerating the source code (see above), and committing that source code.

However, it would be helpful if anyone needing such a service could test the service against the service they have, and then reporting any trouble encountered as an issue on this project. If it just works, then please report at least minimal working functionality as an issue, and optionally contribute the metadata upstream.

You can’t perform that action at this time.