cyrilix/goupnp
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Fork github.com/huin/goupnp to add open-home support
134 Commits 2 Branches 2 Tags 573 KiB
Go 100%
e7fc2c5b62
Go to file
John Beisley e7fc2c5b62 Fix inconsistent indents in GUIDE.md examples.
2021-02-21 12:36:27 +00:00
cmd Add a command to display all SSDP discoveries on local network. 2020-05-16 11:58:37 +01:00
dcps Switch to generate code with go generate. 2018-10-13 15:04:17 +01:00
example Add another example showing getting byte transfer counts on igd2. 2015-12-09 21:46:17 +00:00
httpu Discover devices on all the host's capable network interfaces. 2020-05-16 11:59:03 +01:00
scpd Add SCPD.GetAction method. 2014-06-06 21:55:52 +01:00
soap Fix formatting of an error message. 2018-03-04 21:56:41 +00:00
ssdp Discover devices on all the host's capable network interfaces. 2020-05-16 11:59:03 +01:00
.gitignore Switch to generate code with go generate. 2018-10-13 15:04:17 +01:00
device.go Add correct spelling for RequestSCPD, mentioned in issue #23. 2018-03-04 21:55:55 +00:00
go.mod Discover devices on all the host's capable network interfaces. 2020-05-16 11:59:03 +01:00
go.sum Discover devices on all the host's capable network interfaces. 2020-05-16 11:59:03 +01:00
goupnp.go Discover devices on all the host's capable network interfaces. 2020-05-16 11:59:03 +01:00
goupnp.sublime-project Add Sublime Text project file. 2018-10-13 13:37:27 +01:00
GUIDE.md Fix inconsistent indents in GUIDE.md examples. 2021-02-21 12:36:27 +00:00
LICENSE Update email address. 2017-08-03 10:08:12 +01:00
network.go Changed due to review comments 2020-06-20 07:37:22 +01:00
README.md Add a guide for using internet gateway clients. 2021-02-21 12:34:13 +00:00
service_client.go Add support for discovery-free client creation in dcps packages. 2015-06-06 11:53:50 +01:00

README.md

goupnp is a UPnP client library for Go

Installation

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

Documentation

See GUIDE.md for a quick start on the most common use case for this library.

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.