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
145 Commits 2 Branches 2 Tags 573 KiB
Go 100%
72ec887a3d
Go to file
humboldt_xie 72ec887a3d fix SetURLBase URL contain colon str unused
2021-09-08 08:10:00 +01:00
cmd Add *Ctx methods for calling SOAP methods. 2021-07-11 14:53:32 +01:00
dcps Add *Ctx methods for calling SOAP methods. 2021-07-11 14:53:32 +01:00
example Fix trivial go vet problems. 2021-07-04 10:59:33 +01: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 Add method SOAPCliet.PerformActionCtx. 2021-07-11 14:15:35 +01:00
ssdp Fix #41 - collisions with same USN as multiple locations. 2021-06-26 17:01:14 +01:00
.gitignore Switch to generate code with go generate. 2018-10-13 15:04:17 +01:00
device.go fix SetURLBase URL contain colon str unused 2021-09-08 08:10:00 +01:00
go.mod Remove direct dependency on charset reader 2021-06-19 23:10:24 +01:00
go.sum Remove direct dependency on charset reader 2021-06-19 23:10:24 +01:00
goupnp.go Fix #41 - collisions with same USN as multiple locations. 2021-06-26 17:01:14 +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 localIPv4MCastAddrs if（net.FlagUp == 0 ）continue 2021-03-10 17:45:57 +00:00
README.md Remove direct dependency on charset reader 2021-06-19 23:10:24 +01: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.

Migrating due to Breaking Changes

  • #40 introduced a breaking change to handling non-utf8 encodings, but removes a heavy dependency on golang.org/x/net with charset encodings. If this breaks your usage of this library, you can return to the old behavior by modifying the exported variable and importing the package yourself:
import (
  "golang.org/x/net/html/charset"
  "github.com/huin/goupnp"
)

func init() {
  // should be modified before goupnp libraries are in use.
  goupnp.CharsetReaderFault = charset.NewReaderLabel
}