9278656124
[why] The importing application may have some specific security requrirements that necessitate a change to the http.Client or http.Transport used when fetching the xml from the UPnp server. For example, the importing application may want to restrict localhost calls which could be made by an attack server on the local network. [how] Create a global HTTPClient which defaults to http.DefaultClient. This allows the importing application to modify this global if it wishes to make changes to the http.Client/http.Transport used when fetching the xml from the UPnP server. |
||
|---|---|---|
| cmd | ||
| dcps | ||
| example | ||
| httpu | ||
| scpd | ||
| soap | ||
| ssdp | ||
| v2alpha | ||
| .gitignore | ||
| device.go | ||
| go.mod | ||
| go.sum | ||
| go.work | ||
| goupnp.go | ||
| goupnp.sublime-project | ||
| GUIDE.md | ||
| LICENSE | ||
| Makefile | ||
| network.go | ||
| README.md | ||
| service_client.go | ||
| workspace.code-workspace | ||
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):
av1 - Client for UPnP Device Control Protocol MediaServer v1 and MediaRenderer v1.- internetgateway1 - Client for UPnP Device Control Protocol Internet Gateway Device v1.
- internetgateway2 - Client for UPnP Device Control Protocol Internet Gateway Device v2.
Core components:
- (goupnp) core library - contains datastructures and utilities typically used by the implemented DCPs.
- httpu HTTPU implementation, underlies SSDP.
- ssdp SSDP client implementation (simple service discovery protocol) - used to discover UPnP services on a network.
- soap SOAP client implementation (simple object access protocol) - used to communicate with discovered services.
Regenerating dcps generated source code:
-
Build code generator:
go get -u github.com/huin/goupnp/cmd/goupnpdcpgen -
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/netwith 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
}
v2alpha
The v2alpha subdirectory contains experimental work on a version 2 API. The plan is to eventually
create a v2 subdirectory with a stable version of the version 2 API. The v1 API will stay where
it currently is.
NOTE:
v2alphawill be deleted one day, so don't rely on it always existing.v2alphawill have API breaking changes, even with itself.