wolfmqttbridge

command module
v0.0.0-...-abe7717 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 2, 2020 License: GPL-3.0 Imports: 16 Imported by: 0

README

wolfmqttbridge Build Status

WOLF Smartset MQTT Bridge (for home-assistant)

It periodically fetches current state information from https://www.wolf-smartset.com and publishes this to MQTT - in a way that works with https://www.home-assistant.io.

When enabled in Home-Assitant (or you are using HASS.IO the Mosquitto broker add-on) entities are auto-configured using MQTT discovery.

This works with my Wolf CFS20 and a Wolflink Pro, everything else may work or not.

Update rate defaults to 20 seconds (which I hope is acceptable since the Wolf-Smartset web-clients polls data every 10 seconds)

What works

  • Talk to Wolf-Smartset.com portal (re-engineered API, if there is a spec for this I would be interested)
  • Emit auto-confguration MQTT messages for home-assistant

What does not work

  • Only one device supported (it takes the first device found in the portal)
  • No direct connect to bridge in the local network - I could not find a spec for this interface
  • This is currently read-only

Running

For running this on the command-line try --help-long

To support running in a bare container, most args can be passed in as Environment variables, the following variables are mandatory:

  • WOLF_USER - your userid at https://www.wolf-smartset.com
  • WOLF_PW - password for your user at https://www.wolf-smartset.com
  • BROKER - address of the MQTT Broker to use, if you are running this as container under hass.io and use the Mosquitto broker add-on this is tcp://core-mosquitto:1883
  • BROKER_USER - username for the MQTT broker (when using hass.io mosquitto a valid hass.io user works)
  • BROKER_PW - password for the MQTT broker ( " " )

To run this as container on hass.io, use e.g. the Portainer add-on and configure a new container:

  • Image: kgbvax/wolfmqttbridge:latest
  • ENV: Define the variables listed abover
  • Network: Add this to the "hassio" network
  • Restart Policy: On Failure / 5 (recommended)
  • Resources: As you like should work with 64MB and some tiny CPU

MQTT Topics

  • Topics for values are auto-generated like this: wolf/<Value-Name>/state The root topic can be overwritten using WOLF_MQTT_ROOT_TOPIC environment or --rootTopic. Value-Name is the value as it appears on the GUI, (with spaces removed). Payload is the raw value (as string)
  • Default topic for home-assistant MQTT discovery is homeassistant (which is HA's default). This can be changed with HA_DISCO_TOPIC or --haDiscoTopic

Documentation

The Go Gopher

There is no documentation for this package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL