A Unfolded Circle Remote Two Integration Library in Go

⚠️ DISCLAIMER This is Work in Progress and might not yet be functional.

This Unfolded Circle Remote Two integration driver written in Go implements is written as generic as possible to be used with any kind of device to control.

Currently this repository implements a driver for the following devices:

DeCONZ
Shelly
Tasmota

Intergrations implemented using this library:

Denon Audio/Video Reveiver

Device / Clients

Generic Client

The generic client is not functional. You need to implement your own Client for the device you want to control

Deconz

Run with ucrt deconz

This client currently implements Light entities for discovered DeCONZ Lights and Groups and Sensor entitites for selected DeCONZ sensors.

Shelly

Run with ucrt shelly

This client currently implements Switch entities for discovered Shelly Devices. It uses MQTT to discover and control Shelly devices.

Tasmota

Run with ucrt tasmota

This client currently implements Switch entities and Light entities It uses MQTT to discover and control Tasmota devices.

Currently on the following Sonoff device types are supported

0 Sonoff Basic results in a Switch entity
4 RGBW results in a Light entity

Note The light entity does not really suport RGBW. So currently, as a somehow working workaround, when setting the brithness is set to 0, the entity changes between RGB & W Settings.

How to use

Unfolder Circle Remote Two integration

Usage:
  ucrt-amd64 [command]

Available Commands:
  completion  Generate the autocompletion script for the specified shell
  deconz      Start Deconz Ingegration
  help        Help about any command
  shelly      Start Shelly Ingegration
  tasmota     Start Tasmota Ingegration

Flags:
      --debug                         Enable debug log level
      --disableMDNS                   Disable integration advertisement via mDNS
  -h, --help                          help for ucrt-amd64
  -l, --listenPort int                the port this integration is listening for websocket connection from the remote (default 8080)
      --registration                  Enable driver registration on the Remote Two instead of mDNS advertisement
      --registrationPin string        Pin of the RemoteTwo for driver registration
      --registrationUsername string   Username of the RemoteTwo for driver registration (default "web-configurator")
      --remoteTwoIP string            IP Address of your Remote Two instance (disables Remote Two discovery)
      --remoteTwoPort int             Port of your Remote Two instance (disables Remote Two discovery) (default 80)
      --ucconfighome string           Configuration directory to save the user configuration from the driver setup (default "./ucconfig/")
      --websocketPath string          path where this integration is available for websocket connections (default "/ws")

Use "ucrt-amd64 [command] --help" for more information about a command.

As a Container

You can start the Integration as a container by using the released container images:

Example to start the DenonAVR Integration:

docker run ghcr.io/splattner/goucrt:v0.1.7 denonavr

To keep the setup data persistet mount a volume to /app/ucconfig:

docker run -v ./localdir:/app/ucconfig ghcr.io/splattner/goucrt:v0.1.7 denonavr

For the mDNS adventisement to work correctly I suggest starting the integration in the host network. And you can set your websocket listening port with the environment variable UC_INTEGRATION_LISTEN_PORT:

docker run --net=host -e UC_INTEGRATION_LISTEN_PORT=10000 -v ./localdir:/app/ucconfig ghcr.io/splattner/goucrt:v0.1.7 denonavr

Configuration

Environment Variables

The following environment variables exist in addition to the configuration file:

Variable	Values	Description
UC_CONFIG_HOME	directory path	Configuration directory to save the user configuration from the driver setup. Default: `./ucconfig/`
UC_DISABLE_MDNS_PUBLISH	`true` / `false`	Disables mDNS service advertisement. Default: `false`
UC_INTEGRATION_LISTEN_PORT	`int`	The port this integration is listening for websocket connection from the remote. Default: `8080`
UC_INTEGRATION_WEBSOCKET_PATH	`string`	Path where this integration is available for websocket connections. Default: `/ws`
UC_RT_HOST	`string`	IP Address of your Remote Two instance (disables Remote Two discovery via mDNS for registration)
UC_RT_PORT	`int`	Port of your Remote Two instance (disables Remote Two discovery via mDNS for registration)
UC_ENABLE_REGISTRATION	`string`	Enable driver registration on the Remote Two instead of mDNS advertisement. Default: `false`
UC_REGISTRATION_USERNAME	`string`	Username of the RemoteTwo for driver registration. Default: `web-configurator`
UC_REGISTRATION_PIN	`string`	Pin of the RemoteTwo for driver registration

Development

The generic client is in pgk/client/client.go. In order to implement your own client, you have to implement the following functions:

// Client specific functions
// Initialize the client
// Here you can add entities if they are already known
initFunc func()
// Called by RemoteTwo when the integration is added and setup started
setupFunc      func()
// Handles connect/disconnect calls from RemoteTwo
clientLoopFunc func()

See Denon Client Example in in pkg/client/denonavrclient.go

Todo's

Implement all available entities
Handle command calls
Allow for attribute changes
Allow for driver regisration
- Make it more robust
Allow for driver authentication with token/header
Documentation, how to use, how to implement your own device
probably way more

How to Build and Run

# in cmd/ucrt
go get -u
go build .

Docker

docker build -f build/Dockerfile -t  ghcr.io/splattner/goucrt:latest

Verifying

Checksum

Checksums

wget https://github.com/splattner/goucrt/releases/download/v0.1.3/goucrt_0.1.3_checksums.txt
cosign verify-blob \
  --certificate-identity 'https://github.com/splattner/goucrt/.github/workflows/release.yaml@refs/tags/v0.1.3' \
  --certificate-oidc-issuer 'https://token.actions.githubusercontent.com' \
  --cert https://github.com/splattner/goucrt/releases/download/v0.1.3/goucrt_0.1.3_checksums.txt.pem \
  --signature https://github.com/splattner/goucrt/releases/download/v0.1.3/goucrt_0.1.3_checksums.txt.sig \
  ./goucrt_0.1.3_checksums.txt

You can then download any file you want from the release, and verify it with, for example:

wget https://github.com/splattner/goucrt/releases/download/v0.1.3/goucrt_0.1.3_linux_amd64.tar.gz.sbom
wget https://github.com/splattner/goucrt/releases/download/v0.1.3/goucrt_0.1.3_linux_amd64.tar.gz
sha256sum --ignore-missing -c checksums.txt

And both should say "OK".

You can then inspect the .sbom file to see the entire dependency tree of the binary.

Docker image

cosign verify ghcr.io/splattner/goucrt:v0.1.3 --certificate-identity 'https://github.com/splattner/goucrt/.github/workflows/release.yaml@refs/tags/v0.1.3' --certificate-oidc-issuer 'https://token.actions.githubusercontent.com'

License

This project is licensed under the Mozilla Public License 2.0. See the LICENSE file for details.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

README.md

README.md

A Unfolded Circle Remote Two Integration Library in Go

Device / Clients

Generic Client

Deconz

Shelly

Tasmota

How to use

As a Container

Configuration

Environment Variables

Development

Todo's

How to Build and Run

Docker

Verifying

Checksum

Checksums

Docker image

License

Files

README.md

Latest commit

History

README.md

File metadata and controls

A Unfolded Circle Remote Two Integration Library in Go

Device / Clients

Generic Client

Deconz

Shelly

Tasmota

How to use

As a Container

Configuration

Environment Variables

Development

Todo's

How to Build and Run

Docker

Verifying

Checksum

Checksums

Docker image

License