Having Hozelock cloud controller kit intergration

Tad · July 5, 2018, 11:46am

There I was wanting to just water our gardens, but you want to water the world! How benevolent.

eveares · April 22, 2019, 5:21am

Not a home-assist user my self, however my hubs number/Letter format is LNNNLN.

There may be up to 10,314,424,798,490,500,000,000,000,000 combinations on the basis of 6^36, of course in reality a lot of combinations won’t exist such as all numbers or those less than 6 digits.

Regards: eveares.

martynjsimpson · April 25, 2019, 7:07pm

Thanks to @anthonyangel I wrote up everything I learnt about the Hozelock API and included more information form what he shared.

I was going to post it here but it got … long.

Hope it is helpful to some of you.

hijinx · May 1, 2019, 10:57am

Thanks - interesting read.
Personally I think it’s absolutely shocking that there is no forced TLS or any auth at all on their API.
Especially since @anthonyangel took the time to demonstrate that he could control their device.
Its extremely irresponsible.

HozeMats · May 21, 2019, 7:03pm

Has anyone found out how the traffic is between the hub and the server? Is it possible to create your own server?

Cheers

dinth · July 28, 2019, 5:49pm

Here’s a config code for sensors. I recon it could be done better using binary_sensor for some of the variables.
Im still working on sending commands to the controller.

[updated version - 29.07.2019]

sensors:
  - platform: rest
    resource: !secret hozelock_controller_0
    name: "Hozelock Back Garden Sprinkler"
    value_template: '{{ value_json["controller"]["name"] }}'
    json_attributes:
      - controller
- platform: template
    sensors:
      hozelock_back_garden_sprinkler_pause_starttime:
        friendly_name: "Pause start"
        value_template: '{{ ( state_attr("sensor.hozelock_back_garden_sprinkler", "controller")["pause"]["startTime"] | int / 1000 ) | int | timestamp_local }}' 
      hozelock_back_garden_sprinkler_pause_endtime:
        friendly_name: "Pause end"
        value_template: '{{ ( state_attr("sensor.hozelock_back_garden_sprinkler", "controller")["pause"]["endTime"] | int / 1000 ) | int | timestamp_local }}'
      hozelock_back_garden_sprinkler_pause_duration:
        friendly_name: "Pause duration"
        value_template: '{{ ( state_attr("sensor.hozelock_back_garden_sprinkler", "controller")["pause"]["duration"] | int / 60000 ) | int }}'
      hozelock_back_garden_sprinkler_adjustment_starttime:
        friendly_name: "Adjustment start"
        value_template: '{{ ( state_attr("sensor.hozelock_back_garden_sprinkler", "controller")["adjustment"]["startTime"] | int / 1000 ) | int | timestamp_local }}'
      hozelock_back_garden_sprinkler_adjustment_endtime:
        friendly_name: "Adjustment end"
        value_template: '{{ ( state_attr("sensor.hozelock_back_garden_sprinkler", "controller")["adjustment"]["endTime"] | int / 1000 ) | int | timestamp_local }}'
      hozelock_back_garden_sprinkler_adjustment_wateringadjustment:
        friendly_name: "Adjustment amount"
        value_template: '{{ state_attr("sensor.hozelock_back_garden_sprinkler", "controller")["adjustment"]["wateringAdjustment"] }}'
        unit_of_measurement: '%'
      hozelock_back_garden_sprinkler_waternowevent:
        friendly_name: "Water now event"
        value_template: '{{ state_attr("sensor.hozelock_back_garden_sprinkler", "controller")["waterNowEvent"] }}'
      hozelock_back_garden_sprinkler_currentwateringevent:
        friendly_name: "Current watering event"
        value_template: '{{ state_attr("sensor.hozelock_back_garden_sprinkler", "controller")["currentWateringEvent"] }}'
      hozelock_back_garden_sprinkler_nextwateringevent_starttime:
        friendly_name: "Next watering start"
        value_template: '{{ ( state_attr("sensor.hozelock_back_garden_sprinkler", "controller")["nextWateringEvent"]["startTime"] | int / 1000 ) | int | timestamp_local }}'
      hozelock_back_garden_sprinkler_nextwateringevent_endtime:
        friendly_name: "Next watering end"
        value_template: '{{ ( state_attr("sensor.hozelock_back_garden_sprinkler", "controller")["nextWateringEvent"]["endTime"] | int / 1000 ) | int | timestamp_local }}'
      hozelock_back_garden_sprinkler_nextwateringevent_duration:
        friendly_name: "Next watering duration"
        value_template: '{{ ( state_attr("sensor.hozelock_back_garden_sprinkler", "controller")["nextWateringEvent"]["duration"] | int / 60000 ) | int}}'
        unit_of_measurement: 'min'
      hozelock_back_garden_sprinkler_lastcommunicationwithserver:
        friendly_name: "Last communication"
        value_template: '{{ ( state_attr("sensor.hozelock_back_garden_sprinkler", "controller")["lastCommunicationWithServer"] | int / 1000 ) | int | timestamp_local }}'
      hozelock_back_garden_sprinkler_nextcommunicationwithserver:
        friendly_name: "Next communication"
        value_template: '{{ ( state_attr("sensor.hozelock_back_garden_sprinkler", "controller")["nextCommunicationWithServer"] | int / 1000 ) | int | timestamp_local }}'
      hozelock_back_garden_sprinkler_batterystatus:
        friendly_name: "Battery status"
        value_template: '{{ state_attr("sensor.hozelock_back_garden_sprinkler", "controller")["batteryStatus"] }}'
      hozelock_back_garden_sprinkler_signalstrength:
        friendly_name: "Signal strength"
        value_template: '{{ state_attr("sensor.hozelock_back_garden_sprinkler", "controller")["signalStrength"] }}'
      hozelock_back_garden_sprinkler_overridescheduleduration:
        friendly_name: "Override schedule duration"
        value_template: '{{ state_attr("sensor.hozelock_back_garden_sprinkler", "controller")["overrideScheduleDuration"] }}'

binary_sensors:
- platform: template
    sensors:
      hozelock_back_garden_sprinkler_haswaternowevent:
        friendly_name: "Water now event"
        value_template: '{{ state_attr("sensor.hozelock_back_garden_sprinkler", "controller")["hasWaterNowEvent"] }}'
      hozelock_back_garden_sprinkler_ischildlockenabled:
        friendly_name: "Child lock"
        value_template: '{{ state_attr("sensor.hozelock_back_garden_sprinkler", "controller")["isChildlockEnabled"] }}'
      hozelock_back_garden_sprinkler_iswatering:
        friendly_name: "Watering now"
        value_template: '{{ state_attr("sensor.hozelock_back_garden_sprinkler", "controller")["isWatering"] }}'
      hozelock_back_garden_sprinkler_ispanelremoved:
        friendly_name: "Panel removed"
        value_template: '{{ state_attr("sensor.hozelock_back_garden_sprinkler", "controller")["isPanelRemoved"] }}'
      hozelock_back_garden_sprinkler_isadjusted:
        friendly_name: "Adjustment"
        value_template: '{{ state_attr("sensor.hozelock_back_garden_sprinkler", "controller")["isAdjusted"] }}'
      hozelock_back_garden_sprinkler_isscheduleuptodate:
        friendly_name: "Schedule up-to-date"
        value_template: '{{ state_attr("sensor.hozelock_back_garden_sprinkler", "controller")["isScheduleUpToDate"] }}'
      hozelock_back_garden_sprinkler_ispaused:
        friendly_name: "Paused"
        value_template: '{{ state_attr("sensor.hozelock_back_garden_sprinkler", "controller")["isPaused"] }}'
      hozelock_back_garden_sprinkler_nextwateringevent_enabled:
        friendly_name: "Next watering enabled"
        value_template: '{{ state_attr("sensor.hozelock_back_garden_sprinkler", "controller")["nextWateringEvent"]["enabled"] }}'

dinth · July 29, 2019, 4:58pm

And here’s a logic for rest_commands, please note, i havent tested all functions yet but they should work

rest_command: 
  hozelock_waternow:
    url: 'https://hoz3.com/restful/support/hubs/{{ hub_id }}/controllers/actions/waterNow'
    method: POST
    payload: '{"controllerIDs":[{{ controller_id }}],"duration":{{ duration }}}'
    content_type:  'application/json'

  hozelock_pause:
    url: 'https://hoz3.com/restful/support/hubs/{{ hub_id }}/controllers/actions/pause'
    method: POST
    payload: '{"controllerIDs":[{{ controller_id }}],"duration":{{ duration }}}'
    content_type:  'application/json'

  hozelock_unpause:
    url: 'https://hoz3.com/restful/support/hubs/{{ hub_id }}/controllers/actions/unpause'
    method: POST
    payload: '{"controllerIDs":[{{ controller_id }}]}'
    content_type:  'application/json'

  hozelock_adjust:
    url: 'https://hoz3.com/restful/support/hubs/{{ hub_id }}/controllers/actions/adjust'
    method: POST
    payload: '{"controllerIDs":[{{ controler_id }}],"duration":{{ duration }},"wateringAdjustment":{{ percentage }}}'
    content_type:  'application/json'

  hozelock_unadjust:
    url: 'https://hoz3.com/restful/support/hubs/{{ hub_id }}/controllers/actions/unadjust'
    method: POST
    payload: '{"controllerIDs":[{{ controller_id }}]}'
    content_type:  'application/json'

  hozelock_stopwatering:
    url: 'https://hoz3.com/restful/support/hubs/{{ hub_id }}/controllers/actions/stopWatering'
    method: POST
    payload: '{"controllerIDs":[{{ controller_id }}]}'
    content_type:  'application/json'

l_o_k_i · August 29, 2019, 12:05am

Hi @dinth
Can you explain how your code works because I tried it but everything is unknown (I can see the json values in my web browser when I go to http://hoz3.com/restful/support/hubs/xxxxxx)

@martynjsimpson
How can we use your API in home assistant?

dinth · August 29, 2019, 4:42am

There’s not much code above, just some sensor templates.
Are you getting any warnings in the log? Does the config validates in your HA?
Is the rest sensor unknown too?

l_o_k_i · August 29, 2019, 6:51am

I understand that everything depends on the rest sensor, but i get an unknown state. I’ve got no warnings in the log and the config validates in HA.

Do I need to change soething besides hozelock_controller_0 value ?
Can you explain value_template and json_attributes of the rest sensor ?

l_o_k_i · August 29, 2019, 7:46am

OK, got it: I was using http://hoz3.com/restful/support/hubs/xxxxxx for hozelock_conyroller_0 value but apparently we must use http://hoz3.com/restful/support/hubs/xxxxxx/controllers/0 instead. It was not obvious in your post

Simtras · September 12, 2019, 11:20am

Hi, could you make a clumsy guide?
I’m starting with the house assistant and it’s hard for me to follow the steps.
I would appreciate it very much and surely more people like me too.

l_o_k_i · September 16, 2019, 10:56am

add in your configuration.yaml file a section with Michal’s sensors code
add in your secrets.yaml file this:

hozelock_controller_0: https://hoz3.com/restful/support/hubs/XXXXX/controllers/0

replace XXXXX with your hub ID

Tell me if you want also to send commands, I will show you how I do it with the waternow command

Simtras · September 17, 2019, 1:02pm

thanks for answering.

I have copied Michal´s sensors code

platform: rest + platform: template sensors + binary_sensors

I have also copied everything in rest_command:

I have copied all this in configuration.yaml

then create secrets.yaml and copy the line

it is right ?

l_o_k_i · September 17, 2019, 3:06pm

YOU should tell me if it’s right by clicking on Check config (left menu/Configuration/Server control) before restarting Home assistant and by testing

If you want to use the commands hozelock_waternow, hozelock_stopwatering, hozelock_pause and hozelock_unpause, you must add:

in configuration.yaml:

input_number:
  hozelock_duration:
    name: Duration
    min: 1
    max: 60
    step: 1
    icon: mdi:clock-outline
    unit_of_measurement: "min"
  hozelock_duration_pause:
    name: Duration
    min: 1
    max: 14
    step: 1
    icon: mdi:clock-outline
    unit_of_measurement: "days"

in scripts.yaml:

hozelock_waternow:
  alias: Hozelock water now
  sequence:
    - service: rest_command.hozelock_waternow
      data_template:
        hub_id: !secret hozelock_hub_id
        controller_id: 0
        duration: "{{ states('input_number.hozelock_duration') | int * 60000 }}"
hozelock_stopwatering:
  alias: Hozelock stop watering
  sequence:
    - service: rest_command.hozelock_waternow
      data_template:
        hub_id: !secret hozelock_hub_id
        controller_id: 0
hozelock_pause:
  alias: Hozelock pause
  sequence:
    - service: rest_command.hozelock_pause
      data_template:
        hub_id: !secret hozelock_hub_id
        controller_id: 0
        duration: "{{ states('input_number.hozelock_duration_pause') }}"
hozelock_unpause:
  alias: Hozelock unpause
  sequence:
    - service: rest_command.hozelock_unpause
      data_template:
        hub_id: !secret hozelock_hub_id
        controller_id: 0

in secrets.yaml:

hozelock_hub_id: XXXXXX

replace XXXXXX with your hub id

I don’t use the others commands for now

Use the scripts to run the commands

Simtras · September 18, 2019, 8:15pm

good evening.
yes, when I copied everything Michal´s sensors code in configuration.yaml I got errors at these points.

—— —— —
end of the stream or a document separator is expected at line 46, column 1:
- platform: template
  ^

platform: template
sensors:
hozelock_back_garden_sprinkler_pause_starttime:
friendly_name: “Pause start”

2.——— ——— ————

bad indentation of a mapping entry at line 101, column 12:
sensors:
^

platform: template
sensors:

I put them this way and then it has given me ok
but the following error has come outbinary_sensors:

platform: template
sensors:
hozelock_back_garden_sprinkler_pause_starttime:

binary_sensors:

platform: template
sensors:

Component error: binary_sensors - Integration binary_sensors not found. Component error: sensors - Integration sensors not found.
22:10 components/hassio/init.py (ERROR)Log Details (ERROR)
Wed Sep 18 2019 22:10:23 GMT+0200 (CEST)
Component error: binary_sensors - Integration binary_sensors not found.
Component error: sensors - Integration sensors not found.

I’m sorry for not being able to explain myself better.

l_o_k_i · September 19, 2019, 11:00am

There’s an indentation problem in Michal’s code. You’re missing 2 spaces before “- platform: template”. Change it so it looks like this:

sensor:
  - platform: rest
    resource: !secret hozelock_controller_0
    name: "Hozelock Back Garden Sprinkler"
    value_template: '{{ value_json["controller"]["name"] }}'
    json_attributes:
      - controller
  - platform: template
    sensors:
      hozelock_back_garden_sprinkler_pause_starttime:
        friendly_name: "Pause start"
etc...

For the binary sensors, add 2 spaces before “- platform: template” :

binary_sensor:
  - platform: template
    sensors:
      hozelock_back_garden_sprinkler_haswaternowevent:
        friendly_name: "Water now event"
etc...

Simtras · September 19, 2019, 2:47pm

Hello good afternoon.
It doesn’t work, this is the error:

2019-09-19 16:42:09 ERROR (MainThread) [homeassistant.components.hassio] Component error: sensors - Integration sensors not found.
Component error: binary_sensors - Integration binary_sensors not found.
2019-09-19 16:44:25 ERROR (MainThread) [homeassistant.components.hassio] Component error: sensors - Integration sensors not found.
Component error: binary_sensors - Integration binary_sensors not foun

l_o_k_i · September 19, 2019, 7:31pm

There must be something wrong with the indentation in your code. Good indentation is very important

fxcoolby · September 25, 2019, 7:46pm

This I think has to do with the new update. I updated to 99.02 and tried to clean up my config file putting things in separate files to make the code cleaner the same code with the same format that was been working for past 6 month now spits out this very same error. The only difference is that I cut it from my main config file and put it in a separate file.