Fork github.com/huin/goupnp to add open-home support
Go to file
John Beisley 01b23aa7e6 Replace Fixed14_4Float with a integer version.
This type avoids loss of precision, and is likely what was
intended by having 14.4 fixed point.

Conversions to/from float64 are provided.
2022-03-24 19:46:39 +00:00
cmd Consolidate V1 SOAP type data into the SOAP package. 2022-03-24 19:46:39 +00:00
dcps Consolidate V1 SOAP type data into the SOAP package. 2022-03-24 19:46:39 +00:00
example Fix trivial go vet problems. 2021-07-04 10:59:33 +01:00
httpu #48: Add local address information 2022-03-22 09:50:46 +00:00
scpd Reorder items in generated source files. 2022-03-13 09:02:29 +00:00
soap Consolidate V1 SOAP type data into the SOAP package. 2022-03-24 19:46:39 +00:00
ssdp Fix #41 - collisions with same USN as multiple locations. 2021-06-26 17:01:14 +01:00
v2 Replace Fixed14_4Float with a integer version. 2022-03-24 19:46:39 +00:00
.gitignore add support for Open Connectivity Foundation DCPs 2022-03-22 18:18:01 +00:00
device.go fix SetURLBase URL contain colon str unused 2021-09-08 08:10:00 +01:00
go.mod Reorder items in generated source files. 2022-03-13 09:02:29 +00:00
go.sum add support for Open Connectivity Foundation DCPs 2022-03-22 18:18:01 +00:00
goupnp.go #48: Add local address information 2022-03-22 09:50:46 +00:00
goupnp.sublime-project
GUIDE.md
LICENSE
Makefile add support for Open Connectivity Foundation DCPs 2022-03-22 18:18:01 +00: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 #48: Add local address information 2022-03-22 09:50:46 +00:00
workspace.code-workspace Add top level folder to workspace. 2022-03-24 19:46:39 +00:00

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
}