home-assistant.io/source/_components/geniushub.markdown

title, description, logo, ha_category, ha_release, ha_iot_class

title	description	logo	ha_category	ha_release	ha_iot_class
Genius Hub	Instructions on how to integrate Genius Hub with Home Assistant.	geniushub.png	Climate Water Heater Sensor Binary Sensor	0.92	Local Polling

The geniushub integration links Home Assistant with your Genius Hub CH/DHW system, including its Zones, Devices, and Issues.

Currently, there is no support for Zone schedules.

It uses the geniushub client library.

Zones

Each Zone controlled by your Genius hub will be exposed as either a:

• Climate entity, for Radiator Zones, and
• Water Heater, for Hot Water Temperature Zones

Other Zone types, such as On / Off Zones, are not currently supported.

Each such entity will report back its mode, state, setpoint and current temperature; other properties are available via its attributes (see below). The Zone's mode can changed as below.

GH mode	HA Operation	HA Preset
Off	Off	N/A
Timer	Heat	None
Override	Heat	Boost
Footprint	Heat	Activity

Note that Footprint mode is only available to Radiator Zones that have room sensors.

Devices

If the Hub is directly polled using the v3 API (see below), then each Device controlled by your Genius hub will be exposed as either a:

• Sensor entity with a % battery, for any Device with a battery (e.g. a Genius Valve), or
• Binary Sensor entity with on/off state for any Device that is a switch (e.g. a Smart Plug)

Each such entity will report back its primary state; in addition, assigned_zone and last_comms (last communications time) are available via the entity's attributes.

Issues

There are three Sensor entities that will indicate the number of Errors, Warnings and Information issues.

Each such entity has a state attribute that will contain a list of any such issues which can be used in automations, etc. For example:

{% raw %}

- alias: GeniusHub Error Alerts
  trigger:
    platform: numeric_state
    entity_id: sensor.errors
    above: 0
  action:
  - service: notify.pushbullet_notifier
    data_template:
      title: "Genius Hub has errors"
      message: >-
        Genius Hub has the following {{ states('sensor.errors') }} errors:
        {{ state_attr('sensor.errors', 'error_list') }}

{% endraw %}

State Attributes

Other properties are available via each entity's state attributes. For example, in the case of Radiator Zones/Climate devices:

{
  "status": {
    "type": "radiator",
    "temperature": 19,
    "occupied": False,
    "override": {
      "duration": 0,
      "setpoint": 16
    }
  }
}

This data can be accessed in automations, etc. via a value template. For example:

{% raw %}

value_template: "{{ state_attr('water_heater.boiler_h_w', 'status').override.setpoint }}"

{% endraw %}

In the specific case of Radiator zones with room sensors:

{% raw %}

value_template: "{{ state_attr('climate.main_room', 'status').occupied }}"

{% endraw %}

Configuration

To set up this integration, add one of the following to your configuration.yaml file.

Option 1: hub token only

• requires a hub token obtained from my.geniushub.co.uk/tokens
• uses the v1 API - which is well-documented
• polls Heat Genius' own servers (so is slower, say ~5-10s response time)

# Example configuration.yaml entry, using a Hub Token
geniushub:
  token: GENIUS_HUB_TOKEN

Option 2: hub hostname/address with user credentials

• requires your username & password, as used with www.geniushub.co.uk/app
• uses the v3 API - unofficial, but there are additional features (e.g., battery levels)
• polls the hub directly (so is faster, say ~1s response time)

The hub does not have to be in the same network as HA.

# Example configuration.yaml entry, directly polling the Hub
geniushub:
  host: IP_ADDRESS
  username: GENIUS_HUB_USERNAME
  password: GENIUS_HUB_PASSWORD

{% configuration %} token: description: The Hub Token of the Genius Hub. required: true type: string host: description: The hostname/IP address of the Genius Hub. required: true type: string username: description: Your Genius Hub username. required: false type: string password: description: Your Genius Hub password. required: false type: string {% endconfiguration %}

Note that if a host is used instead of token, then the username and password are also required.