Skip to content

Latest commit

 

History

History
173 lines (139 loc) · 5.57 KB

README.md

File metadata and controls

173 lines (139 loc) · 5.57 KB
Raw

Wiren Board - Home Assistant geteway

Gateway to connect Wiren Board to Home Assistant with MQTT discovery.

  • All devices connected to WirenBoard should be added to HomeAssistant automatically.
  • You don't need to write manually configuration for each sensor/switch/etc...
  • You don't need manually configure MQTT bridge. All needed messages between Wiren Board and Home Assistant will be forwarded by the gateway.
  • Device availability is also tracked based on meta/error properties

Installation and configuration

Requirements

  • Linux
  • Python >= 3.6

NOTE: wb-hass-gw CAN'T be installed directly to Wiren Board, because there is Python 3.5 on it.

Installing:

cd /opt
git clone https://github.com/Hacker-CB/wb-hass-gw
cd wb-hass-gw
virtualenv -p python3 .venv
source .venv/bin/activate
pip install -r requirements.txt

Configuring wb-hass-gw

wirenboard:
  broker_host: [YOUR HASS INSTANCE]

homeassistant:
  broker_host: 127.0.0.1
  topic_prefix: my_wirneboard/
  entity_prefix: WB 1

Configuring Home Assistant

mqtt:
  broker_host: [YOUR MQTT BROKER]  # Remove if you want to use builtin-in MQTT broker 
  discovery: true
  birth_message:
    topic: 'hass/status'
    payload: 'online'
  will_message:
    topic: 'hass/status'
    payload: 'offline'

NOTE: birth_message/will_message are needed to resend all devices after Home Assistant restarts. (like in zigbe2mqtt)

Run

python wb-hass-gw.py -c /etc/wb-hass-gw.yaml

Full config with default values

general:
  loglevel: INFO # One of DEBUG/INFO/WARNING/ERROR/FATAL

wirenboard:
  broker_host:
  broker_port: 1883
  username:
  password:
  client_id: 'wb-hass-gw'
  topic_prefix: ''

homeassistant:
  broker_host:
  broker_port: 1883
  username:
  password:
  client_id: 'wb-hass-gw'
  topic_prefix:
  entity_prefix: ''
  discovery_topic: 'homeassistant'
  status_topic: 'hass/status'
  status_payload_online: 'online'
  status_payload_offline: 'offline'
  debounce:
    sensor: 1000 # (ms) debounce for sensors to prevent HA from flood
  subscribe_qos: 0
  publish_availability:
    qos: 0
    retain: True
    publish_delay: 1.0
  publish_config:
    qos: 0
    retain: False
    publish_delay: 1.0
  publish_state:
    qos: 0
    retain: True
  inverse: # Unique ID of the boolean entitis to inverse (switch/binary_sensor)
    - wb1_wb_mr6c_28_k1
  
  # Entity/device splitting 
  # Can be useful for changing location for each entity in HA
  split_devices: 
    - wb1_wb_mr6c_53 # Represent all device entities as separate device
  split_entities:
    - wb1_wb_mr6c_53_k1 # Represent entity as separate device
  
  ignore_availability: False # Do not publish availability topic

Supported Wiren Board controls

All Wiren Board types are documented Wiren Board MQTT Conventions

Generic types

Wiren Board Home Assistant
switch switch
switch(read_only) binary_sensor
alarm binary_sensor
pushbutton binary_sensor
range -
range(read_only) sensor
rgb -
text sensor
value sensor

Special types

Wiren Board Home Assistant
temperature sensor
rel_humidity sensor
atmospheric_pressure sensor
rainfall sensor
wind_speed sensor
power sensor
power_consumption sensor
voltage sensor
water_flow sensor
water_consumption sensor
resistance sensor
concentration sensor
heat_power sensor
heat_energy sensor

Additional types

Types which are not part of the Wiren Board, but can be added with custom templates for wb-mqtt-serial)

Wiren Board Home Assistant Units
current sensor A

TODO

  • Add support for range
  • Add support for rgb
  • Need to delete entities after they will be disappeared in Wiren Board.
  • Add device information if available (version, serial)
  • Handle wirenboard disconnect

Known issues

  • There is no built-in entity to represent Wiren Board range type as editable entity. I have tried to use cover and light for it, but it not looked nice. Suggestions are welcome.