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
123 Commits 2 Branches 2 Tags 573 KiB
Go 100%
1395d14473
Go to file
Huin 1395d14473
Clarify code in HTTPUClient.Do. 
The previous code was misleading by returning the `err` variable rather than an explicit `nil`. This code path was actually the success path. Functionally it was correct as that specific scoping of `err` could only be `nil` if that line of code was reached.
2018-04-15 22:51:57 +01:00
cmd Add correct spelling for RequestSCPD, mentioned in issue #23. 2018-03-04 21:55:55 +00:00
dcps Use totalBytesHack for intergateway2 too 2017-11-09 16:41:07 -05:00
example Add another example showing getting byte transfer counts on igd2. 2015-12-09 21:46:17 +00:00
gotasks Use totalBytesHack for intergateway2 too 2017-11-09 16:41:07 -05:00
httpu Clarify code in HTTPUClient.Do. 2018-04-15 22:51:57 +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 Allow SSDP search results from inexact searches. 2018-03-15 19:13:24 +00:00
.gitignore Update specgen to download DCP XML specs and process them individually. 2015-06-07 09:02:49 +01:00
device.go Add correct spelling for RequestSCPD, mentioned in issue #23. 2018-03-04 21:55:55 +00:00
goupnp.go Minor comment fix that could mislead. 2015-06-06 11:04:25 +01:00
LICENSE Update email address. 2017-08-03 10:08:12 +01:00
README.md Reformat part of README to improve GoDoc links. 2016-12-24 10:40:35 +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

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. Install gotasks: go get -u github.com/jingweno/gotask
  2. Change to the gotasks directory: cd gotasks
  3. Run specgen task: gotask specgen

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 gotasks/specgen_task.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.