https://github.com/hansmi/wp2reg-luxws

Go code and Prometheus exporter for working with heat pump controllers from Alpha Innotec and other manufacturers.
https://github.com/hansmi/wp2reg-luxws

alpha-innotec golang innotec luxtronik luxtronik2 luxws nibe novelan prometheus-exporter wp2reg

Last synced: about 1 month ago
JSON representation

Go code and Prometheus exporter for working with heat pump controllers from Alpha Innotec and other manufacturers.

• Host: GitHub
• URL: https://github.com/hansmi/wp2reg-luxws
• Owner: hansmi
• License: bsd-3-clause
• Created: 2021-01-31T14:40:35.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2024-08-09T20:37:36.000Z (4 months ago)
• Last Synced: 2024-08-09T21:26:05.258Z (4 months ago)
• Topics: alpha-innotec, golang, innotec, luxtronik, luxtronik2, luxws, nibe, novelan, prometheus-exporter, wp2reg
• Language: Go
• Homepage:
• Size: 174 KB
• Stars: 4
• Watchers: 2
• Forks: 6
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# wp2reg-luxws

[![Latest release](https://img.shields.io/github/v/release/hansmi/wp2reg-luxws)][releases]

[![Release workflow](https://github.com/hansmi/wp2reg-luxws/actions/workflows/release.yaml/badge.svg)](https://github.com/hansmi/wp2reg-luxws/actions/workflows/release.yaml)

[![CI workflow](https://github.com/hansmi/wp2reg-luxws/actions/workflows/ci.yaml/badge.svg)](https://github.com/hansmi/wp2reg-luxws/actions/workflows/ci.yaml)

[![Go reference](https://pkg.go.dev/badge/github.com/hansmi/wp2reg-luxws.svg)](https://pkg.go.dev/github.com/hansmi/wp2reg-luxws)

A collection of [Go][golang] 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`](./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][golang] or

[GoReleaser][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

[golang]: https://golang.org/

[goreleaser]: https://goreleaser.com/

[releases]: https://github.com/hansmi/wp2reg-luxws/releases/latest

[websocket]: https://en.wikipedia.org/wiki/WebSocket