Skip to content

Latest commit

 

History

History
49 lines (34 loc) · 1.9 KB

README.md

File metadata and controls

49 lines (34 loc) · 1.9 KB
Raw

wp2reg-luxws

Latest release Release workflow CI workflow Go reference

A collection of Go packages for working with the Lux_WS protocol used for remote control in Luxtronik 2.x heat pump controllers manufactured and/or deployed by the following companies:

  • Alpha Innotec
  • NIBE
  • Novelan
  • possibly other companies and/or brands

The websocket-based protocol was introduced in firmware version 3.81. The code was developed and tested using wp2reg version 3.85.6.

Prometheus exporter

The primary purpose of this code is to export all informational values for consumption by Prometheus. See the luxws-exporter directory for details.

Installation

Pre-built binaries are provided for all releases:

  • Binary archives for Linux, Windows and Mac OS (.tar.gz, .zip)
  • Debian/Ubuntu (.deb)
  • RHEL/Fedora (.rpm)

Installation from the source code

It's also possible to produce custom builds directly using Go or GoReleaser.

With Go 1.16 or later the following command installs luxws-exporter system-wide into /usr/local/bin/:

go build -o luxws-exporter/luxws-exporter ./luxws-exporter && \
  sudo install -t /usr/local/bin -m 0755 luxws-exporter/luxws-exporter