I have successfully implemented GeyserWise in Home Assistant version 2023.5.4, on a Raspberry Pi 3 model B.
I try to detail a quick (and relatively) easy way that I have used to integrate the GeyserWise API to HA using REST. I don’t claim to be any Home Assistant specialist, as I have only used HA for the last two evenings. I suppose there are better ways to do this, but could not find any step-by-step instructions online, so decided to record what I have done in case it is of benefit to somebody else.
Always best to first backup your device before making any changes.
Some background and basics:
The REST Sensor is used to interrogate the GeyserWise Cloud API for data regarding the geyser, e.g. the temperature reading, heating element status, etc.
The REST Command is used to change settings via the GeyserWise Cloud API that are effected on the geyser, e.g. setting the element to ‘ON’ or ‘OFF’ via a switch or button.
You may need SAMBA to edit files on your HA implementation (unless you have another method to do so). SAMBA can be installed from Settings → Add-On library. There are many resources on the forum, also on YouTube, so I do not think it necessary to go into much detail regarding SAMBA.
Step 1: Get your GeyserWise API Key
You will need to get your API Key, which is approx. 84 character alphanumeric code, from GeyserWise via email.
Once you have the API Key, you will need to find your Unit Id. Copy the following URL but replace the <API Key> text with the API Key that you have received. Paste the URL in your normal web browser to find your Unit ID:
https://geyserwiseonline.com/AutomationService/api/unit/GetUnitList?apiKey=<API Key>
The web response should look something like this (I have two geysers):
{"units":[{"UnitId":"1111","UnitName":"00000012345","UnitLocation":"Kids Bathroom","TimeLogged":"2023-06-02 00:48"},{"UnitId":"2222","UnitName":"00000067890","UnitLocation":"Main Bathroom","TimeLogged":"2023-06-02 20:48"}],"Exception":""}
The example above shows the following two Unit IDs: 1111 and 2222, screenshot below:
You should now have your <API Key> and <Unit ID> for your specific geyser/s.
Step 2: Update configuration.yaml file with the REST configuration
If you have Samba installed, you can find the configuration.yaml file in the following directory:
\\<Home Assistant IP Address>\config\configuration.yaml
The configuration.yaml file can be opened and the configuration lines for the REST Sensor and REST Command can inserted according to the example below. Observe the tabs/spaces used to keep correct indenting.
Example configuration file for a single geyser:
# Loads default set of integrations. Do not remove.
default_config:
# Load frontend themes from the themes folder
frontend:
themes: !include_dir_merge_named themes
# Text to speech
tts:
- platform: google_translate
# -------- REST Configuration for GeyserWise starts --- Copy from HERE --------
rest:
- resource: https://geyserwiseonline.com/AutomationService/api/unit/GetUnitStatus?apiKey=<API Key>&unitid=<Unit ID 1>
sensor:
- name: "Geyser1 Element"
unique_id: geyser1_element
force_update: true
value_template: "{{ value_json.Element }}"
json_attributes:
- Element
- name: "Geyser1 Temperature"
unique_id: geyser1_temperature
force_update: true
value_template: "{{ value_json.Temperature }}"
json_attributes:
- Temperature
rest_command:
geyser1_switch_on:
url: "https://geyserwiseonline.com/AutomationService/api/unit/SetElement?apiKey=<API Key>&unitid=<Unit ID 1>&Uniton=true"
geyser1_switch_off:
url: "https://geyserwiseonline.com/AutomationService/api/unit/SetElement?apiKey=<API Key>&unitid=<Unit ID 1>&Uniton=false"
switch:
- platform: template
switches:
geyser1:
unique_id: geyser1_element_switch
value_template: "{{ is_state('sensor.geyser1_element', 'on') }}"
turn_on:
service: rest_command.geyser1_switch_on
turn_off:
service: rest_command.geyser1_switch_off
# -------- REST Configuration for GeyserWise ends --- Copy up to HERE --------
automation: !include automations.yaml
script: !include scripts.yaml
scene: !include scenes.yaml
Configuration example for two geysers:
# Loads default set of integrations. Do not remove.
default_config:
# Load frontend themes from the themes folder
frontend:
themes: !include_dir_merge_named themes
# Text to speech
tts:
- platform: google_translate
# -------- REST Configuration for GeyserWise starts HERE --------
rest:
- resource: https://geyserwiseonline.com/AutomationService/api/unit/GetUnitStatus?apiKey=<API Key>&unitid=<Unit ID 1>
sensor:
- name: "Geyser1 Element"
unique_id: geyser1_element
force_update: true
value_template: "{{ value_json.Element }}"
json_attributes:
- Element
- name: "Geyser1 Temperature"
unique_id: geyser1_temperature
force_update: true
value_template: "{{ value_json.Temperature }}"
json_attributes:
- Temperature
- resource: https://geyserwiseonline.com/AutomationService/api/unit/GetUnitStatus?apiKey=<API Key>&unitid=<Unit ID 2>
sensor:
- name: "Geyser2 Element"
unique_id: geyser2_element
force_update: true
value_template: "{{ value_json.Element }}"
json_attributes:
- Element
- name: "Geyser2 Temperature"
unique_id: geyser2_temperature
force_update: true
value_template: "{{ value_json.Temperature }}"
json_attributes:
- Temperature
rest_command:
geyser1_switch_on:
url: "https://geyserwiseonline.com/AutomationService/api/unit/SetElement?apiKey=<API Key>&unitid=<Unit ID 1>&Uniton=true"
geyser1_switch_off:
url: "https://geyserwiseonline.com/AutomationService/api/unit/SetElement?apiKey=<API Key>&unitid=<Unit ID 1>&Uniton=false"
geyser2_switch_on:
url: "https://geyserwiseonline.com/AutomationService/api/unit/SetElement?apiKey=<API Key>&unitid=<Unit ID 2>&Uniton=true"
geyser2_switch_off:
url: "https://geyserwiseonline.com/AutomationService/api/unit/SetElement?apiKey=<API Key>&unitid=<Unit ID 2>&Uniton=false"
switch:
- platform: template
switches:
geyser1:
unique_id: geyser1_element_switch
value_template: "{{ is_state('sensor.geyser1_element', 'on') }}"
turn_on:
service: rest_command.geyser1_switch_on
turn_off:
service: rest_command.geyser1_switch_off
geyser2:
unique_id: geyser2_element_switch
value_template: "{{ is_state('sensor.geyser2_element', 'on') }}"
turn_on:
service: rest_command.geyser2_switch_on
turn_off:
service: rest_command.geyser2_switch_off
# -------- REST Configuration for GeyserWise ends HERE --------
automation: !include automations.yaml
script: !include scripts.yaml
scene: !include scenes.yaml
Save the file and restart Home Assistant, go to: Settings → Menu (top righthand of the window) → Restart Home Assistant
Thanks to GeyserWise for providing the REST sensor and command lines that I have used and modified in the above examples.
3. Enable the GeyserWise ‘Entities’ in HA
Go to: Settings → Devices & Services → Entities
Find the geyser entities by typing ‘geyser’ into the search bar, example below:
Select the appropriate geyser template(s), element(s) and temperature entities. Select ‘ENABLE SELECTED’:
4. Add gauges and switches to your dashboard
Using your ‘Overview’ dashboard, or any other custom dashboard, select ‘Edit Dashboard’ then click on ‘+ Add Card’.
Choose the ‘Grid’ Card and select ‘Show Code Editor’.
Copy / Paste the following code over (observe the tabs/spaces used to keep correct indenting):
For a single geyser:
square: false
type: grid
cards:
- type: gauge
entity: sensor.geyser1_temperature
name: Geyser Temperature
unit: °C
min: 0
needle: true
severity:
green: 0
yellow: 40
red: 50
max: 80
- type: entities
entities:
- entity: sensor.geyser1_element
name: Geyser Status
icon: mdi:heat-wave
secondary_info: none
- entity: switch.geyser1
name: Element Switch
icon: mdi:power
show_header_toggle: false
state_color: true
title: GeyserWise
columns: 1
For two geysers:
square: false
type: grid
cards:
- type: gauge
entity: sensor.geyser2_temperature
name: Main Geyser Temp
unit: °C
min: 0
needle: true
severity:
green: 0
yellow: 40
red: 50
max: 80
- type: gauge
entity: sensor.geyser1_temperature
name: Kids Geyser Temp
unit: °C
min: 0
needle: true
severity:
green: 0
yellow: 40
red: 50
max: 80
- type: entities
entities:
- entity: sensor.geyser1_element
name: Kids Geyser Status
icon: mdi:heat-wave
secondary_info: none
- entity: switch.geyser1
name: Kids Element Switch
icon: mdi:power
- entity: sensor.geyser2_element
name: Main Geyser Status
icon: mdi:heat-wave
- entity: switch.geyser2
name: Main Element Switch
icon: mdi:power
show_header_toggle: false
state_color: true
title: GeyserWise
columns: 1
… and save.
You should see the newly created dashboard card, looking something like this:
5. Additional Information
The element status can be:
- On = The element is currently on and heating the water
- Off = The element is currently off (and the timer is in a deactivated state)
- Standby = The element is currently off (and the timer is in an activated state) but the element will switch on again automatically when the water temperature drops (until the timer changes to a deactivated state).
A list of the GeyserWise http API actions, if you need them:
- GetUnitList
- GetUnitStatus
- SetElement
- SetHolidayMode
- SetTestPump
- SetTemperatureBlocks
- SetSolarOrDual
- SetAntifreeze
- SetTimerControls
(I would rather not mess with some of these actions, as they require you to send JSON formatted data)
Typical data received from GetUnitStatus (REST ‘Sensor’ data):
- Element (Status of the heater elements, as above; On/Off/Standby)
- Temperature (of the geyser)
- TimeLogged
- CollectorTemperature (of the solar collector)
- HolidayMode
- TestPump (when the pump cycles the water between the collector and geyser)
- AntiFreeze
- Solar
- TemperatureBlock1
- TemperatureBlock2
- TemperatureBlock3
- TemperatureBlock4
- Timer1OnWeek
- Timer2OnWeek
- Timer3OnWeek
- Timer4OnWeek
- Timer1OnWeekEnd
- Timer2OnWeekEnd
- Timer3OnWeekEnd
- Timer4OnWeekEnd
- Timer1OffWeek
- Timer2OffWeek
- Timer3OffWeek
- Timer4OffWeek
- Timer1OffWeekEnd
- Timer2OffWeekEnd
- Timer3OffWeekEnd
- Timer4OffWeekEnd
6. Conclusion
Everything should work now.
One slight inconvenience is that the on/off button bounces. So when the geyser element is switched on, it will momentarily bounce back off and then on again. I suppose one can add automation or python scripts to delay the button/switch update, but, except for this slight inconvenience, the interface seems to be quite responsive and convenient to use.
Note: I am not associated with GeyserWise in any way and provide this information as a log of my own experience.
