Awesome

Irrigation Unlimited

• 1. Introduction
• 2. Features
• 3. Structure
• 4. Installation
  • 4.1. Install from HACS
  • 4.2. Manual installation
• 5. Configuration
  • 5.1. Controller Objects
  • 5.2. All Zone Objects
  • 5.3. Zone Objects
  • 5.4. Zone Show Object
  • 5.5. Schedule Objects
    • 5.5.1 Sun Event
    • 5.5.2 Crontab
    • 5.5.3 Every n Days
  • 5.6. Sequence Objects
  • 5.7. Sequence Zone Objects
  • 5.8. History Object
    • 5.8.1. Long term statistics (LTS)
  • 5.9. Clock Object
  • 5.10. Check Back Object
  • 5.11. User Object
• 6. Configuration examples
  • 6.1. Minimal configuration
  • 6.2. Sun event example
  • 6.3. Sequence example
  • 6.4. Simple water saving / eco mode example
  • 6.5. Every hour on the hour
  • 6.6. Seasonal watering
  • 6.7. Finish at sunrise
  • 6.8. Tips
• 7. Services
  • 7.1. Services enable, disable and toggle
  • 7.2. Services pause and resume
  • 7.3. Service suspend
  • 7.4. Service cancel
  • 7.5. Service manual_run
  • 7.6. Service adjust_time
  • 7.7. Service load_schedule
  • 7.8. Service reload
  • 7.9. Service call access roadmap
• 8. Frontend
  • 8.1. Generic Cards
  • 8.2. Timeline
  • 8.3. Frontend Requirements
  • 8.4. Manual run card
  • 8.5. Enable-disable card
  • 8.6. Pause-resume button
• 9. Automation
  • 9.1. ESPHome
  • 9.2. HAsmartirrigation
  • 9.3. Overnight watering
• 10. Notifications
  • 10.1. Events
    • 10.1.1. irrigation_unlimited_start, irrigation_unlimited_finish
    • 10.1.2. irrigation_unlimited_switch_error, irrigation_unlimited_sync_error
• 11. Troubleshooting
  • 11.1. Requirements
  • 11.2. HA Configuration
  • 11.3. Community Forum
  • 11.4. Logging
  • 11.5. Last but not least
• 12. Notes
• 13. Snake case
• 14. Parameter Types
  • 14.1 Irrigation Unlimited Entities
  • 14.2 Duration (Time Period)
  • 14.3 Switch entities
  • 14.4 Templating
  • 14.5 Sequence
  • 14.6 Zones
  • 14.7 Time (Time of Day)
• 15. Contributions are welcome
• 16. Credits

1. Introduction

This integration is for irrigation systems large and small. It can offer some complex arrangements without large and messy scripts. This integration will complement many other irrigation projects.

Home Assistant makes automating switches easy with the built in tools available. So why this project? You have a system in place but now you have extended it to have a number of zones. You don't want all the zones on at once because of water pressure issues. Maybe you would like each zone to have a number of schedules say a morning and evening watering. What about water restrictions that limit irrigation systems to certain days of the week or days in the month, odd or even for example. Perhaps you would like different schedules for winter and summer. Now you would like to adjust the times based on weather conditions, past, present or future. Let's turn a zone or even a controller off for system maintenance. Starting to sound more like your system? Finally what's going on now and what's up next.

Each controller has an associated (master) sensor which shows on/off status and other attributes. The master will be on when any of its zones are on. The master sensor can have a pre and post amble period to activate or warm up the system like charge up a pump, enable WiFi or turn on a master valve. The master sensor has a number of service calls available to enable/disable all the zones it controls.

Zones also have an associated sensor which, like the master, shows on/off status and various attributes. Zones sensors have service calls that can enable/disable and provide manual runs. Also adjust run times in automation scripts using information from integrations that collect weather data like OpenWeatherMap, BOM, weatherunderground and many others. Go crazy with projects like HAsmartirrigation. Easily integrate probes and sensors from ESPHome for real-time adjustments. Examples provided below.

View and control your system with the Irrigation Unlimited companion card. A compact card where you can monitor upcoming schedules along with irrigation history.

2. Features

1. Unlimited controllers.
2. Unlimited zones.
3. Unlimited schedules. Schedule by absolute time or sun events (sunrise/sunset). Select by days of the week (mon/tue/wed...). Select by days in the month (1/2/3.../odd/even). Select by months in the year (jan/feb/mar...). Use cron expressions. Overlapped schedules.
4. Unlimited sequences. Operate zones one at a time in a particular order with a delay in between. A 'playlist' for your zones.
5. Suitable for indoor (greenhouse, hothouse, undercover areas) and outdoor (gardens, lawns, crops).
6. Hardware independent. Use your own switches/valve controllers.
7. Software independent. Pure play python.

*Practical limitations will depend on your hardware.

3. Structure

Irrigation Unlimited is comprised of controllers, zones and schedules in a tree like formation. Each controller has one or more zones and each zone has one or more schedules. Controllers and zones will have a binary sensor associated with each one so they can be integrated with Home Assistant.

└── Irrigation Unlimited
  └── Controller 1 -> binary_sensor.irrigation_unlimited_c1_m
    └── Zone 1 -> binary_sensor.irrigation_unlimited_c1_z1
      └── Schedule 1
      └── Schedule 2
          ...
      └── Schedule N
    └── Zone 2 -> binary_sensor.irrigation_unlimited_c1_z2
        ...
    └── Zone N -> binary_sensor.irrigation_unlimited_c1_zN
        ...
    └── Sequence 1
      └── Schedule 1
      └── Schedule 2
        ...
      └── Schedule N
      └── Zone 1
      └── Zone 2
        ...
      └── Zone N
    └── Sequence 2
      ...
    └── Sequence N
  └── Controller 2 -> binary_sensor.irrigation_unlimited_c2_m
      ...
  └── Controller N -> binary_sensor.irrigation_unlimited_cN_m
      ...

Controllers and zones can specify an entity such as a switch or light, basically anything that turns on or off the system can control it. This is the irrigation valve. If this does not go far enough for your purposes then track the state of the binary sensors in an automation and do your own thing like run a script or scene.

This component will set up the following platforms.

A binary sensor is associated with each controller and zone. Controller or master sensors are named binary_sensor.irrigation_unlimited_cN_m and zone sensors binary_sensor.irrigation_unlimited_cN_zN. These sensors show the state of the master or child zones. Attributes show additional information like current schedule and next run time and duration.

4. Installation

HACS is the recommended method for installation. If you are having difficulties then please see the troubleshooting guide

4.1. Install from HACS

1. Just search for Irrigation Unlimited integration in HACS and install it.
2. Add Irrigation Unlimited to your configuration.yaml file. See configuration examples below.
3. Restart Home Assistant.

4.2. Manual installation

1. Using the tool of choice open the directory (folder) for your HA configuration (where you find configuration.yaml).
2. If you do not have a custom_components directory (folder) there, you need to create it.
3. In the custom_components directory (folder) create a new folder called irrigation_unlimited.
4. Download all the files from the custom_components/irrigation_unlimited/ directory (folder) in this repository.
5. Place the files you downloaded in the new directory (folder) you created.
6. Restart Home Assistant
7. In the HA UI go to "Configuration" -> "Integrations" click "+" and search for "Irrigation"

Using your HA configuration directory (folder) as a starting point you should now also have this:

custom_components/irrigation_unlimited/__init__.py
custom_components/irrigation_unlimited/binary_sensor.py
custom_components/irrigation_unlimited/const.py
custom_components/irrigation_unlimited/entity.py
custom_components/irrigation_unlimited/history.py
custom_components/irrigation_unlimited/irrigation_unlimited.py
custom_components/irrigation_unlimited/manifest.json
custom_components/irrigation_unlimited/schema.py
custom_components/irrigation_unlimited/service.py
custom_components/irrigation_unlimited/services.yaml

5. Configuration

Configuration is done by yaml. Note: The configuration can be reloaded without restarting HA. See below for details and limitations.

5.1. Controller Objects

This is the controller or master object and manages a collection of zones. There must be at least one controller in the system. The controller state reflects the state of its zones. The controller will be on if any of its zones are on and off when all zones are off.

5.2. All Zone Objects

This object is useful when the same settings are required for each zone. It is simply a shorthand or a more concise way to specify the same settings for each zone. The parameter becomes a default which can be overridden in the actual zone.

5.3. Zone Objects

The zone object manages a collection of schedules. There must be at least one zone for each controller.

5.4. Zone Show Object

These are various options to reveal attributes on the zone entity (only one for now).

5.5. Schedule Objects

Schedules are future events, not dates for example Mondays at sunrise.

The schedule can have the commencement or completion fixed to a time or event with the anchor parameter. Any adjustments to the duration will alter the start time if finish is specified or the completion time if start is specified. Note: If anchoring to finish and the schedule can not complete before the specified time then the run will defer to the following day. This is an important consideration if adjusting run times dynamically as it may lead to a 'skipping' situation. Ensure there is sufficient time to complete the run when making adjustments. See here for more information on adjusting runs times.

The parameters weekday, day, month and from/until are date filters. If not specified then all dates qualify.

* from and until are mutually inclusive.

5.5.1 Sun Event

Leave the time value in the Schedule Objects blank and add the following object. An optional before or after time can be specified.

5.5.2 Crontab

Leave the time value in the Schedule Objects blank and add the following object.

5.5.3 Every n Days

Set the day value in the Schedule Objects to a dictionary with the following keys.

5.6. Sequence Objects

Sequences allow zones to run one at a time in a particular order with a delay in between. This is a type of watering 'playlist'. If a delay is specified and a pump or master valve is operated by the controller then consider the postamble setting in the Controller Object. Set this to the largest delay to prevent pump on/off operations.

Sequences directly descend from a controller and are loosely connected to a zone entity via the zone_id parameter. The zone_id may point to one or many (a list) zone entities. A zone may be referenced more than once in a sequence.

└── Irrigation Unlimited
      └──> Controller
            ├──> Zones
            │     ├──> Zone 1 <────┐
            │     ├──> Zone 2 <────┤
            │     │     ...        │
            │     └──> Zone N <────┤
            └──> Sequence          │
                  ├──> zone_id >───┤
                  ├──> zone_id >───┤
                  │      ...       │
                  └──> zone_id >───┘

5.7. Sequence Zone Objects

The sequence zone is a reference to the actual zone defined in the Zone Objects. Ensure the zone_id's match between this object and the zone object. The zone may appear more than once in the case of a split run.

Special note for schedules and the duration parameter contained within when used with sequences. Each zone in the sequence will be proportionally adjusted to fit the specified duration. For example, if 3 zones were to each run for 10, 20 and 30 minutes respectively (total 1 hour) and the schedule.duration parameter specified 30 minutes then each zone would be adjusted to 5, 10 and 15 minutes. Likewise if schedule.duration specified 1.5 hours then the zones would be 15, 30 and 45 minutes. Some variation may occur due to rounding of the times to the system boundaries (granularity). This parameter influences the durations specified in the sequence and sequence zone objects.

5.8. History Object

The timeline and total_today attributes use history information. This information is read and cached by the history module.

5.8.1. Long term statistics (LTS)

History is typically purged after 10 days. If you wish to retain the total_today data beyond this period then setup a Long-Term Statistic sensor. See here for an example. For more information see Long-Term Statistics

5.9. Clock Object

This object controls the internal clock mode.

5.10. Check Back Object

This is used to check the state of the physical switch concurs with the state of the controller or zone. An out of sync can occur due to transmission or communications problems especially with protcols like WiFi, Zigbee or ZWave. The check back will report discrepancies and attempt to resync the switch. Should the resync fail a message will be logged and an event fired. The event can be use for notifications such as an email or phone alert. For more information see Notifications

5.11. User Object

The user object is available on the controller, all_zone and zone objects. It is basically a pass through of arbitrary static user defined data. Elements are prefixed and presented as attributes in the entities.

* name should be in snake_case style.

Here is an example:

controllers:
   - name: "Test controller 1"
     user:
       area: My Farm
       picture: /my_pic.jpg
     all_zones_config:
       user:
         actuator: KNX 6.1
     zones:
       - name: "Zone 1"
         user:
           area: Eastern Pastures
           flow_rate_gallon_per_minute: 25
           picture: /my_pic.jpg
           gps: 42.746635,-75.770045
       - name: "Zone 2"

Thus, the controller and zone present the following attributes:

#Controller 'Test controller 1':
binary_sensor.irrigation_unlimited_c1_m.user_area = 'My Farm'
binary_sensor.irrigation_unlimited_c1_m.user_picture = '/my_pic.jpg'

#Zone 1:
binary_sensor.irrigation_unlimited_c1_z1.user_actuator = 'KNX 6.1' #this is inherited from all_zones_config
binary_sensor.irrigation_unlimited_c1_z1.user_area = 'Eastern Pastures'
binary_sensor.irrigation_unlimited_c1_z1.user_flow_rate_gallon_per_minute = '25'
binary_sensor.irrigation_unlimited_c1_z1.user_picture = '/my_pic.jpg'
binary_sensor.irrigation_unlimited_c1_z1.user_gps = '42.746635,-75.770045'

#Zone 2:
binary_sensor.irrigation_unlimited_c1_z2.user_actuator = 'KNX 6.1' #this is inherited from all_zones_config

The user defined static data available as attribute may help to customize cards or to present additional data on cards, in particular via the functionality within [entity-multiple-row](type: custom:multiple-entity-row). This feature maybe further developed and extended to the sequence: object over time.

6. Configuration examples

6.1. Minimal configuration

# Example configuration.yaml entry
irrigation_unlimited:
  controllers:
    zones:
      entity_id: "switch.my_switch"
      schedules:
        - time: "06:00"
          duration: "00:20"

6.2. Sun event example

# Example configuration.yaml entry
# Run 20 minutes before sunrise for 30 minutes
irrigation_unlimited:
  controllers:
    zones:
      entity_id: "switch.my_switch_1"
      schedules:
        - name: "Before sunrise"
          time:
            sun: "sunrise"
            before: "00:20"
          duration: "00:30"

6.3. Sequence example

# Example configuration.yaml entry
irrigation_unlimited:
  controllers:
    zones:
      - name: "Front lawn"
        entity_id: "switch.my_switch_1"
      - name: "Vege patch"
        entity_id: "switch.my_switch_2"
      - name: "Flower bed"
        entity_id: "switch.my_switch_3"
    sequences:
      - delay: "00:01"
        schedules:
          - name: "Sunrise"
            time:
              sun: "sunrise"
          - name: "After sunset"
            time:
              sun: "sunset"
              after: "00:30"
        zones:
          - zone_id: 1
            duration: "00:10"
          - zone_id: 2
            duration: "00:02"
          - zone_id: 3
            duration: "00:01"

6.4. Simple water saving / eco mode example

# Example water saver. Run for 5 min on 2 off repeat 3 times
irrigation_unlimited:
  controllers:
    zones:
      - entity_id: "switch.my_switch_1"
    sequences:
      - duration: "00:05"
        delay: "00:02"
        repeat: 3
        schedules:
          - time: "05:00"
        zones:
          - zone_id: 1

6.5. Every hour on the hour

# Example to run for 5 min every hour on the hour from 5am to 5pm
irrigation_unlimited:
  controllers:
    zones:
      - entity_id: "switch.my_switch_1"
    sequences:
      - name: "On the hour from 5am to 5pm"
        duration: "00:05"
        delay: "00:55"
        repeat: 12
        schedules:
          - time: "05:00"
        zones:
          - zone_id: 1

Similar to above but using the cron scheduler.

# Example to run for 5 min every hour on the hour from 5am to 5pm
irrigation_unlimited:
  controllers:
    zones:
      - entity_id: "switch.my_switch_1"
    sequences:
      - name: "On the hour from 5am to 5pm"
        duration: "00:05"
        schedules:
          - time:
              cron: "0 5-17 * * *"
        zones:
          - zone_id: 1

6.6. Seasonal watering

# Run 15 min 3 times a week in summer, 10 min once a week in winter and twice a week in spring/autumn
irrigation_unlimited:
  controllers:
    zones:
      - entity_id: "switch.my_switch_1"
        schedules:
          - time: "05:30"
            duration: "00:15"
            weekday: [mon, wed, fri]
            month: [dec, jan, feb]
          - time: "05:30"
            duration: "00:10"
            weekday: [sun]
            month: [jun, jul, aug]
          - time: "05:30"
            duration: "00:12"
            weekday: [mon, thu]
            month: [mar, apr, may, sep, oct, nov]

This is similar to the above but using sequences in a 3 zone system. Each zone runs for 12 minutes for a total of 36 min (plus delays). In Summer the total duration is extended to 45 minutes and winter reduced to 30 minutes. When using the duration parameter in the Schedule it relates to the total duration of the sequence, each zone is adjusted accordingly.

irrigation_unlimited:
  controllers:
    zones:
      - entity_id: "switch.my_switch_1"
      - entity_id: "switch.my_switch_2"
      - entity_id: "switch.my_switch_3"
    sequences:
      - name: "Run 1"
        duration: "00:12"
        delay: "00:01"
        schedules:
          - name: "Summer"
            time: "05:30"
            weekday: [mon, wed, fri]
            month: [dec, jan, feb]
            duration: "00:45"
          - name: "Winter"
            time: "05:30"
            weekday: [sun]
            month: [jun, jul, aug]
            duration: "00:30"
          - name: "Spring and Autumn"
            time: "05:30"
            weekday: [mon, thu]
            month: [mar, apr, may, sep, oct, nov]
        zones:
          - zone_id: 1
          - zone_id: 2
          - zone_id: 3

Just in case this does not go far enough then create three sequences with one schedule each. This will allow complete control over all aspects of the sequence including which zones to run, order, durations, delays, repeats etc. Still want more then create a sequence for each month of the year. This example reverses the order in Spring/Autumn for no good reason and excludes a zone in Winter.

irrigation_unlimited:
  controllers:
    zones:
      - entity_id: "switch.my_switch_1"
      - entity_id: "switch.my_switch_2"
      - entity_id: "switch.my_switch_3"
    sequences:
      - name: "Summer"
        duration: "00:15"
        delay: "00:01"
        schedules:
          - time: "05:30"
            weekday: [mon, wed, fri]
            month: [dec, jan, feb]
        zones:
          - zone_id: 1
          - zone_id: 2
          - zone_id: 3
      - name: "Winter"
        duration: "00:10"
        delay: "00:01"
        schedules:
          - time: "07:30"
            weekday: [sun]
            month: [jun, jul, aug]
        zones:
          - zone_id: 1
          - zone_id: 3
      - name: "Spring and Autumn"
        duration: "00:12"
        delay: "00:01"
        schedules:
          - time: "06:30"
            weekday: [mon, thu]
            month: [mar, apr, may, sep, oct, nov]
        zones:
          - zone_id: 3
          - zone_id: 2
          - zone_id: 1

6.7. Finish at sunrise

# Finish a watering run 10 minutes before sunrise
irrigation_unlimited:
  controllers:
    zones:
      - entity_id: "switch.my_switch_1"
      - entity_id: "switch.my_switch_2"
      - entity_id: "switch.my_switch_3"
      - entity_id: "switch.my_switch_4"
    sequences:
      - name: "My watering run"
        duration: "00:30"
        delay: "00:01"
        schedules:
          - name: "Before dawn"
            time:
              sun: "sunrise"
              before: "00:10"
            anchor: finish
        zones:
          - zone_id: 1
          - zone_id: 2
          - zone_id: 3
          - zone_id: 4

For a more comprehensive example refer to here.

6.8. Tips

1. Schedules can not only have a day of week (mon, wed, fri) but also a month of year (jan, feb, mar). This allows the setup of seasonal watering schedules. For example run every day in summer and twice a week in winter. Setup a different schedule for each month of the year using this filter.

2. Use sequences to setup a water saving or eco mode. Eco mode uses small cycles with a delay to allow the water to soak in and minimise run off. Run all the zones for half the time and then repeat.

3. No need to restart HA after changing the configuration.yaml file. Go to Configuration -> Server Controls -> YAML configuration and reloading and press 'RELOAD IRRIGATION UNLIMITED'.

4. After setting up configuration.yaml, the operation can be controlled via service calls as shown below. Perform manual runs, adjust watering times, cancel running schedules and enable/disable zones from a frontend

7. Services

The binary sensor associated with each controller and zone provide several services. These sensors offer the following services:

• enable
• disable
• toggle
• suspend
• cancel
• manual_run
• adjust_time
• load_schedule

If a controller sensor is targetted then it will effect all its children zones.

7.1. Services enable, disable and toggle

Enables/disables/toggles the controller, zone, sequence or sequence zone respectively.

7.2. Services pause and resume

Pauses/resumes a sequence. This service call "stops the clock" when paused so to speak and "continues to run it" upon resume.

This is particularly helpful in a use case scenario where a main water supply is used for both irrigation and ie filling a domestic cold water tank at the same time. If the water pressure is only sufficient for either irrigaton or tank filling, this service call allows to pause the irrigation whilst a tank is filled, and then resumes irrigation without interrupting the time allocated to the sequences or zones thereof.

There is an example for a pause-resume button that targets all sequences within all controllers creating a globla pause and resume button.

7.3. Service suspend

Suspend operation of a controller, zone, sequence or sequence zone for a period of time. This is like a temporary disable that will automatically reset.

* Must have one and only one of for, until or reset.

7.4. Service cancel

Cancels the current running schedule.

7.5. Service manual_run

Turn on the controller or zone for a period of time. When a sequence is specified each zone's duration will be auto adjusted as a proportion of the original sequence. Zone times are calculated and rounded to the nearest time boundary. This means the total run time may vary from the specified time.

7.6. Service adjust_time

Adjust the run times. Calling this service will override any previous adjustment i.e. it will not make adjustments on adjustments. For example, if the scheduled duration is 30 minutes calling percent: 150 will make it 45 minutes then calling percent 200 will make it 60 minutes. When a sequence is specified each zone's duration will be auto adjusted as a proportion of the original sequence.

A schedule anchored to a start time will alter the completion time. Likewise a schedule anchored to a finish time will change the commencement time. In this situation ensure there is enough time in the current day for the schedule to complete or it will be deferred to the following day. Adjustments must be made before the scheduled start time. Running schedules will be not affected.

Tip: Use forecast and observation data collected by weather integrations in automations to adjust the run times. See below for more information.

* Must have one and only one of actual, percentage, increase, decrease or reset.

7.7. Service load_schedule

Reload a schedule. This will allow an edit to an existing schedule. All fields are optional except the schedule_id. If a field is specified then it is overwritten otherwise it is left untouched. This service does NOT save the new schedule in the event of a reload or HA restart, it will revert to the original configuration.

7.8. Service reload

Reload the YAML configuration file. Do not add or delete controllers or zones, they will not work because of the associated entities which are created on startup. This may be addressed in a future release, however, suggested work around is to set enabled to false to effectively disable/delete. All other settings can be changed including schedules. You will find the control in Configuration -> Server Controls -> YAML configuration reloading. Note: since version 2021.10.0 all settings can be changed including new controllers and zones.

7.9. Service call access roadmap

A reminder that sequences directly descend from a controller. Therefore service calls that manipulate a sequence should address the parent controller. An entity_id of a zone when trying to adjust a sequence will most likely not have the desired effect.

The combination of three key parameters entity_id, sequence_id and zones will target the various sections of the configuration.

• entity_id: This will be either the controller or zone entity.
• sequence_id: This is the position number of the sequence under the controller. sequence_id: 1 is the first, 2 is the second and so on. As a shortcut, sequence_id will alter all sequences.
• zones: This is the position number of the zone reference under the sequence. zones: 1 is the first, 2 is the second and so on. As a shortcut, zones: 0 will alter all zone references in the sequence. May also take a list zones: [1,3,5]

The following is a valid irrigation unlimited configuration. It shows how various points can be changed using the service calls above. Example numbers have the nomenclature C.Z.S.R = Controller.Zone.Sequence.zoneReference. If Z is zero then the entity_id must be the controller/master i.e. binary_sensor.irrigation_unlimited_cN_m. If Z is not zero then then entity_id is the zone i.e. binary_sensor.irrigation_unlimited_cN_zN.

irrigation_unlimited:
  controllers:
    - name: "Controller 1"
      enabled: true # <= See example 1.0
      zones:
        - name: "Controller 1, Zone 1"
          enabled: true # <= See example 1.1
          - schedules:
              - time: "04:00"
                duration: "00:10" # <= See example 1.1.1
        - name: "Controller 1, Zone 2"
          enabled: true # <= See example 1.2
          - schedules:
              - time: "05:00"
                duration: "00:10" # <= See example 1.2.1
      sequences:
        - name: "Controller 1, Sequence 1"
          enabled: true # <= See example 1.0.1e
          schedules:
            - time: "06:00"
              duration: "01:00" # <= See example 1.0.1
          zones:
            - zone_id: [1, 2] # This is controller 1, sequence 1, zone reference 1
              enabled: true # <= See example 1.0.1.1e
              duration: "00:10" # <= See example 1.0.1.1
            - zone_id: 2  # This is controller 1, sequence 1, zone reference 2
              enabled: true # <= See example 1.0.1.2e
              duration: "00:10" # <= See example 1.0.1.2
        - name: "Controller 1, Sequence 2"
          enabled: true # <= See example 1.0.2e
          schedules:
            - time: "07:00"
              duration: "01:00" # <= See example 1.0.2
          zones:
            - zone_id: 1 # This is controller 1, sequence 2, zone reference 1
              enabled: true # <= See example 1.0.2.1e
              duration: "00:10" # <= See example 1.0.2.1
    - name: "Controller 2"
      enabled: true # <= See example 2.0
      zones:
        - name: "Controller 2, Zone 1"
          enabled: true # <= See example 2.1
        - name: "Controller 2, Zone 2"
          enabled: true # <= See example 2.2
      sequences:
        - name: "Controller 2, Sequence 1"
          enabled: true # <= See example 2.0.1e
          schedules:
            - time: "09:00"
              duration: "01:00" # <= See example 2.0.1
          zones:
            - zone_id: 1 # This is controller 2, sequence 1, zone reference 1
              enabled: true # <= See example 2.0.1.1e
              duration: "00:10" # <= See example 2.0.1.1
            - zone_id: 2 # This is controller 2, sequence 1, zone reference 2
              enabled: true # <= See example 2.0.1.2e
              duration: "00:10" # <= See example 2.0.1.2
        - name: "Controller 2, Sequence 2"
          enabled: true # <= See example 2.0.2e
          schedules:
            - time: "09:00"
              duration: "01:00" # <= See example 2.0.2
          zones:
            - zone_id: 1 # This is controller 2, sequence 2, zone reference 1
              enabled: true # <= See example 2.0.2.1e
              duration: "00:10" # <= See example 2.0.2.1
            - zone_id: 2 # This is controller 2, sequence 2, zone reference 2
              enabled: true # <= See example 2.0.2.2e
              duration: "00:10" # <= See example 2.0.2.2

Notes:

1. The adjust_time service call examples show the adjustment method of actual. This is shown for simplicity however all methods are available as described above.
2. The enable service call can also be disable or toggle.

# Example 1.0 -> controller 1 -> enabled. This will alter the enabled status for the controller.
- service: irrigation_unlimited.enable
  data:
    entity_id: binary_sensor.irrigation_unlimited_c1_m

# Example 1.1 -> controller 1 -> zone 1 -> enabled. This will alter the enabled status for zone 1.
- service: irrigation_unlimited.enable
  data:
    entity_id: binary_sensor.irrigation_unlimited_c1_z1

# Example 1.1.1 -> controller 1 -> zone 1 -> duration. This will alter the duration for zone 1.
- service: irrigation_unlimited.adjust_time
  data:
    entity_id: binary_sensor.irrigation_unlimited_c1_z1
    actual: "00:20"

# Example 1.2 -> controller 1 -> zone 2 -> enabled. This will alter the enabled status of zone 2.
- service: irrigation_unlimited.enable
  data:
    entity_id: binary_sensor.irrigation_unlimited_c1_z2

# Example 1.2.1 -> controller 1 -> zone 1 -> duration. This will alter the duration for zone 2.
- service: irrigation_unlimited.adjust_time
  data:
    entity_id: binary_sensor.irrigation_unlimited_c1_z2
    actual: "00:20"

# Example 1.0.1e -> controller 1 -> sequence 1 -> enabled. This will alter the enabled status of sequence 1.
- service: irrigation_unlimited.enable
  data:
    entity_id: binary_sensor.irrigation_unlimited_c1_m
    sequence_id: 1

# Example 1.0.1 -> controller 1 -> sequence 1 -> duration. This will proportionally alter the duration
# for all zone references in the first sequence.
- service: irrigation_unlimited.adjust_time
  data:
    entity_id: binary_sensor.irrigation_unlimited_c1_m
    sequence_id: 1
    actual: "00:20"

# Example 1.0.1.1e -> controller 1 -> sequence 1 -> zone reference 1 -> enabled. This will alter the enabled
# status of the first zone reference in the first sequence.
- service: irrigation_unlimited.enable
  data:
    entity_id: binary_sensor.irrigation_unlimited_c1_m
    sequence_id: 1
    zones: 1

# Example 1.0.1.1 -> controller 1 -> sequence 1 -> zone reference 1 -> duration. This will alter the duration
# for the first zone reference in the first sequence.
- service: irrigation_unlimited.adjust_time
  data:
    entity_id: binary_sensor.irrigation_unlimited_c1_m
    sequence_id: 1
    zones: 1
    actual: "00:20"

# Example 1.0.1.2 - controller 1 -> sequence 1 -> zone reference 2 -> enabled. This will alter the enabled
# status of the second zone reference in the first sequence.
- service: irrigation_unlimited.enable
  data:
    entity_id: binary_sensor.irrigation_unlimited_c1_m
    sequence_id: 1
    zones: 2

# Example 1.0.1.2 - controller 1 -> sequence 1 -> zone reference 2 -> duration. This will alter the duration
# for the second zone reference in the first sequence.
- service: irrigation_unlimited.adjust_time
  data:
    entity_id: binary_sensor.irrigation_unlimited_c1_m
    sequence_id: 1
    zones: 2
    actual: "00:20"

# Example 1.0.2e - controller 1 -> sequence 2 -> enabled. This will alter the enabled
# status of the second sequence.
- service: irrigation_unlimited.enabled
  data:
    entity_id: binary_sensor.irrigation_unlimited_c1_m
    sequence_id: 2

# Example 1.0.2 - controller 1 -> sequence 2 -> duration. This will proportionally alter the duration
# for all zone references in the second sequence.
- service: irrigation_unlimited.adjust_time
  data:
    entity_id: binary_sensor.irrigation_unlimited_c1_m
    sequence_id: 2
    actual: "00:20"

# Example 1.0.2.1e - controller 1 -> sequence 2 -> zone reference 1 -> enabled
- service: irrigation_unlimited.enable
  data:
    entity_id: binary_sensor.irrigation_unlimited_c1_m
    sequence_id: 2
    zones: 1

# Example 1.0.2.1 - controller 1 -> sequence 2 -> zone reference 1 -> duration
- service: irrigation_unlimited.adjust_time
  data:
    entity_id: binary_sensor.irrigation_unlimited_c1_m
    sequence_id: 2
    zones: 1
    actual: "00:20"

# Example 2.0 -> controller 2 -> enabled. This will alter the enabled status for the controller.
- service: irrigation_unlimited.enable
  data:
    entity_id: binary_sensor.irrigation_unlimited_c2_m

# Example 2.1 -> controller 2 -> zone 1 -> enabled. This will alter the enabled status for zone 1.
- service: irrigation_unlimited.enable
  data:
    entity_id: binary_sensor.irrigation_unlimited_c2_z1

# Example 2.2 -> controller 2 -> zone 2 -> enabled. This will alter the enabled status of zone 2.
- service: irrigation_unlimited.enable
  data:
    entity_id: binary_sensor.irrigation_unlimited_c2_z2

# Example 2.0.1e - controller 2 -> sequence 1 -> enabled. This will alter the enabled status
# for the first sequence.
- service: irrigation_unlimited.enable
  data:
    entity_id: binary_sensor.irrigation_unlimited_c2_m
    sequence_id: 1

# Example 2.0.1 - controller 2 -> sequence 1 -> duration. This will proportionally alter the duration
# for all zone references in the first sequence.
- service: irrigation_unlimited.adjust_time
  data:
    entity_id: binary_sensor.irrigation_unlimited_c2_m
    sequence_id: 1
    actual: "00:20"

# Example 2.0.1.1e - controller 2 -> sequence 1 -> zone reference 1 -> enabled. This will alter the enabled
# status for the first zone reference in the first sequence.
- service: irrigation_unlimited.enable
  data:
    entity_id: binary_sensor.irrigation_unlimited_c2_m
    sequence_id: 1
    zones: 1

# Example 2.0.1.1 - controller 2 -> sequence 1 -> zone reference 1 -> duration. This will alter the duration
# for the first zone reference in the first sequence.
- service: irrigation_unlimited.adjust_time
  data:
    entity_id: binary_sensor.irrigation_unlimited_c2_m
    sequence_id: 1
    zones: 1
    actual: "00:20"

# Example 2.0.1.2e - controller 2 -> sequence 1 -> zone reference 2 -> enabled. This will alter the enabled
# status for the second zone reference in the first sequence.
- service: irrigation_unlimited.enable
  data:
    entity_id: binary_sensor.irrigation_unlimited_c2_m
    sequence_id: 1
    zones: 2

# Example 2.0.1.2 - controller 2 -> sequence 1 -> zone reference 2 -> duration. This will alter the duration
# for the second zone reference in the first sequence.
- service: irrigation_unlimited.adjust_time
  data:
    entity_id: binary_sensor.irrigation_unlimited_c2_m
    sequence_id: 1
    zones: 2
    actual: "00:20"

# Example 2.0.2e - controller 2 -> sequence 2 -> enabled
- service: irrigation_unlimited.enable
  data:
    entity_id: binary_sensor.irrigation_unlimited_c2_m
    sequence_id: 2

# Example 2.0.2 - controller 2 -> sequence 2 -> duration
- service: irrigation_unlimited.adjust_time
  data:
    entity_id: binary_sensor.irrigation_unlimited_c2_m
    sequence_id: 2
    actual: "00:20"

# Example 2.0.2.1e - controller 2 -> sequence 2 -> zone reference 1 -> enabled
- service: irrigation_unlimited.enable
  data:
    entity_id: binary_sensor.irrigation_unlimited_c2_m
    sequence_id: 2
    zones: 1

# Example 2.0.2.2 - controller 2 -> sequence 2 -> zone reference 1 -> duration
- service: irrigation_unlimited.adjust_time
  data:
    entity_id: binary_sensor.irrigation_unlimited_c2_m
    sequence_id: 2
    zones: 1
    actual: "00:20"

# Example 2.0.2.2e - controller 2 -> sequence 2 -> zone reference 2 -> enabled
- service: irrigation_unlimited.enable
  data:
    entity_id: binary_sensor.irrigation_unlimited_c2_m
    sequence_id: 2
    zones: 2

# Example 2.0.2.2 - controller 2 -> sequence 2 -> zone reference 2 -> duration
- service: irrigation_unlimited.adjust_time
  data:
    entity_id: binary_sensor.irrigation_unlimited_c2_m
    sequence_id: 2
    zones: 2
    actual: "00:20"

8. Frontend

From release 2022.4.0 a companion card is available.

and expands to

8.1. Generic Cards

Most of the following will require installation of further lovelace cards. For some inspiration and a compact card try this.

and it expands to:

Note: This card uses some custom cards multiple-entity-row, fold-entity-row, logbook-card and at the moment card-mod for styles.

For watering history information here is a sample card.

.

Note: At time of writing this requires a pre-released version of mini-graph-card. Note: If you get "NaN" displayed instead of the actual value then clear out your browsers cache and make sure the development release is installed.

Although not really part of the integration but to get you started quickly here is a temperature card.

.

And a rainfall card. Note how the watering times reduced as rainfall started. More on this below in Automation.

Finally, a system event log

Putting it all together, here is the complete picture

This configuration is three vertical stacks and works well on mobile devices.

8.2. Timeline

Minimum version 2021.12.0 of Irrigation Unlimited is required for this feature. First up, enable the timeline in the zone show object.

irrigation_unlimited:
  controllers:
    all_zones_config: # <= Add these three lines <─┐
      show: # <= to the configuration            <─┤
        timeline: true # <= for all zones        <─┘
    zones:
      entity_id: "switch.my_switch"
      show: # <= Add these two lines to the                    <─┐
        timeline: true # <= configuration for individual zones <─┘
      schedules:
        - time: "06:00"
          duration: "00:20"

Like the watering history card above it also shows the upcoming schedule for a complete overview of your irrigation. Find the code here. Requires apexcharts-card.

If you prefer something akin to a airport departure board then try this. Uses Markdown card which is built into Home Assistant so will work straight out of the box.

8.3. Frontend Requirements

The manual_run and enable/disable cards require additional support files. Minimum version 2021.6.3 of Irrigation Unlimited is required. There is a support file packages/irrigation_unlimited_controls.yaml which should go in the config/packages directory. Also required is a pyscript which is called from the above automation to populate the input_select with all the irrigation unlimited controllers and zones. The script should go in the config/pyscript directory. If you don't have a packages and a pyscript folder then create them and add the following to your configuration.yaml.

homeassistant:
  packages: !include_dir_named packages

Using your HA configuration directory (folder) as a starting point you should now also have this:

pyscript/irrigation_unlimited_service_shim.py
packages/irrigation_unlimited_controls.yaml

More information on packages can be found here and pyscript can be found here, don't worry about the Jupyter kernel unless you are really keen. Hint: A pyscript is used instead of Jinja2 as it produces a list which Jinja2 is not capable of, many have tried... The pyscript is a small piece of code that convert for example ‘1.1 Zone1’ inside an input_select control into ‘binary_sensor.irrigation_unlimited_c1_z1’ and then call the actual service. They are just helpers sitting between the lovelace card and the integration. It's a great way to add some additional capabilities to lovelace cards.

8.4. Manual run card

Here is a card for manual runs, see requirements above. You can find the code here. Note: This card uses paper-buttons-row and time-picker-card.

8.5. Enable-disable card

This card will enable or disable a zone from a dropdown list, see requirements above. The code is here. Like the manual run card it requires paper-buttons-row.

8.6. Pause-resume button

The following yaml script can be attached to a front end button to pause and resume all zones of all sequences of all UI controllers.

Please note that a group helper for all UI controllers is required for this code sample to work.

group:
  irrigation_controllers:
  name: Irrigation Controllers
  entities:
    #Add at least one UI controller entity here
    - binary_sensor.irrigation_unlimited_c1_m
    - binary_sensor.irrigation_unlimited_c2_m
    - binary_sensor.irrigation_unlimited_c3_m
    - binary_sensor.irrigation_unlimited_c4_m
    - binary_sensor.irrigation_unlimited_c5_m
    - binary_sensor.irrigation_unlimited_c6_m
    #Add as many controller entities as you have configured

script:
  toggle_irrigation:
      alias: "Irrigation: Pause/Resume all irrigation unlimited controllers"
      sequence:
        - choose:
            - conditions:
                - condition: template
                  value_template: >-
                    {% set paused_sensors = states.binary_sensor
                        | selectattr('entity_id', 'match', '^binary_sensor\.irrigation_unlimited_c\d+_s\d+$')
                        | selectattr('attributes.status', 'equalto', 'paused')
                        | map(attribute='entity_id')
                        | list %}
                    {{ paused_sensors | length > 0 }}
              sequence:
                - service: irrigation_unlimited.resume
                  data:
                    entity_id: group.irrigation_controllers
                    sequence_id: 0
            - conditions:
                - condition: template
                  value_template: >-
                    {% set paused_sensors = states.binary_sensor
                        | selectattr('entity_id', 'match', '^binary_sensor\.irrigation_unlimited_c\d+_s\d+$')
                        | selectattr('attributes.status', 'equalto', 'paused')
                        | map(attribute='entity_id')
                        | list %}
                    {{ paused_sensors | length == 0 and states('group.irrigation_controllers') == 'on' }}
              sequence:
                - service: irrigation_unlimited.pause
                  data:
                    entity_id: group.irrigation_controllers
                    sequence_id: 0
      icon: mdi:play-pause

Issue 142 has a detailed discussion relating the pause and resume service call and its various use cases.

9. Automation

Due to the many weather integrations available and their relevance to your situation, there is realistically no way to provide a built in 'auto-adjustment' feature. Therefore, no attempt has been made to include a solution and this also makes the integration more independent and flexible. Run time adjustment is achieved by setting up sensor(s) that consume weather information such as rainfall and temperature but could factor in wind speed, solar radiation etc. to determine if more or less watering time is required. You might also consider using forecast information... A service call is then made to irrigation unlimited to adjust the run times. This does mean some knowledge of creating automations is required.

On a personal note, I use the national weather service BOM for my forecast information but find their observation data not relevant due to the extreme regional variations in my situation. There are many micro climates (mountains) and a few kilometres in any direction makes a lot of difference, down pour to a few drops. To this end I have a Personal Weather Station (PWS) that feeds Weather Underground where I use the WUnderground integration to retrieve the data.

You will find my adjustment automation here which feeds off the temperature and rainfall observation data. There is a card here which displays this information (uses multiple-entity-row). Some ideas were gleaned from kloggy's work.

9.1. ESPHome

This example uses the data from a soil moisture probe created in ESPHome to adjust the run times.

automation:
  - alias: ESPHome soil moisture adjustment
    trigger:
      platform: state
      entity_id:
        - sensor.yard1_humidity
    action:
      service: irrigation_unlimited.adjust_time
      data:
        entity_id: binary_sensor.irrigation_unlimited_c1_m
        percentage: >
          {# Threshold variable 0-100 percent #}
          {% set threshold = 40 %}

          {# Sensor data #}
          {% set humidity = states('sensor.yard1_humidity') | float %}

          {% if humidity < threshold %}
            {# Option 1 - A linear sliding scale #}
            {% set multiplier = 1 - (humidity / threshold) %}
            {# Option 2 - On or Off #}
            {% set multiplier = 1.0 %}
          {% else %}
            {% set multiplier = 0.0 %} {# It's too wet, turn off #}
          {% endif %}

          {# Return multiplier as a percentage #}
          {{ (multiplier * 100) | round(0) }}

9.2. HAsmartirrigation

HAsmartirrigation calculates the time to run your irrigation system to compensate for moisture lost by evaporation / evapotranspiration. The following automation runs at 23:30 and takes the calculated run time from HAsmartirrigation and updates Irrigation Unlimited with the new watering time. It then calls HAsmartirrigation to reset the bucket when the irrigation has run.

The example below offers two methods for a single zone or a sequence.

# Example automation for HAsmartirrigation integration (smart_irrigation)[https://github.com/jeroenterheerdt/HAsmartirrigation]
automation:
  - id: 'IU1653097957047'
    alias: Smart Irrigation adjustment
    description: Adjust watering times based on smart irrigation calculations
    trigger:
      - platform: time
        at: "23:30"
    condition:
      condition: and
      conditions:
        - "{{ states('sensor.smart_irrigation_daily_adjusted_run_time') | float(-1) >= 0 }}"
    action:
      - service: irrigation_unlimited.adjust_time
        data:
          actual: "{{ timedelta(seconds=states('sensor.smart_irrigation_daily_adjusted_run_time') | int(0)) }}"
          # -------------------------------------------------------------------
          # Please see documentation regarding the adjust_time service call.
          # Choose an option below. Comment out/delete as needed. This will NOT work as is.
          # 1. Adjust a single zone. Change the zone as required
          # entity_id: binary_sensor.irrigation_unlimited_c1_z1
          # 2. Adjust a sequence. Change the sequence_id as required
          # entity_id: binary_sensor.irrigation_unlimited_c1_m
          # sequence_id: 1
          # -------------------------------------------------------------------
    mode: single

  - id: 'IU1653098247170'
    alias: Smart Irrigation reset bucket
    description: Resets the Smart Irrigation bucket after watering
    trigger:
      - platform: state
        entity_id:
          # Add Irrigation Unlimited sensors here
          - binary_sensor.irrigation_unlimited_c1_m
        from: "on"
        to: "off"
    condition:
      - condition: numeric_state
        above: '0'
        entity_id: sensor.smart_irrigation_daily_adjusted_run_time
    action:
      - service: smart_irrigation.smart_irrigation_reset_bucket

9.3. Overnight watering

Run from sunset to sunrise. This automation will run 1 hour before sunset. It uses the sun integration to calculate the duration from sunset to sunrise and then set this via the adjust_time service call. Create a schedule that starts at sunset and just put in a nominal duration. The duration will be replaced by the service call. Please take note of the comments in the automation as you must change it to suit your configuration.

automation:
  - id: 'IU1655789912900'
    alias: IU Overnight
    description: Run irrigation from sunset to sunrise
    trigger:
      - platform: sun
        event: sunset
        offset: -00:60:00
    condition: []
    action:
      service: irrigation_unlimited.adjust_time
      data:
        # -------------------------------------------------------------------
        # Please see documentation regarding the adjust_time service call.
        # Choose an option below. Comment out/delete/change as needed.
        # *** This will NOT work as is. ***
        # 1. Adjust a single zone. Change the zone as required
        # entity_id: binary_sensor.irrigation_unlimited_c1_z1
        # 2. Adjust a sequence. Change the sequence_id as required
        # entity_id: binary_sensor.irrigation_unlimited_c1_m
        # sequence_id: 1
        # -------------------------------------------------------------------
        actual: >
          {% set t1 = as_datetime(state_attr("sun.sun", "next_setting")).replace(microsecond=0) %}
          {% set t2 = as_datetime(state_attr("sun.sun", "next_rising")).replace(microsecond=0) %}
          {{ t2 - t1 }}
    mode: single

10. Notifications

This section shows how to send a notification when a sequence starts or finishes. Messages can be sent for example via email (SMTP), push notification to mobile phones, twitter and many others. See here for more information on notifications in Home Assistant. Note that it is not limited to sending notifications but many other actions are available. There is quite a lot of information on using notifications in Home Assistant on the web. Try Google, YouTube etc. for some great information and tips.

10.1. Events

Irrigation Unlimited fires events that can be captured in an automation using the event platform as a trigger.

10.1.1. irrigation_unlimited_start, irrigation_unlimited_finish

These events are fired when a sequence starts and finishes. The trigger.event.data contains additional information that can be used in automation scripts. Here is the list of additional fields.

This example displays a persistent notification on the front end when a sequence completes. Note the use of templating to construct a specific message. Although not used here, this platform also supports markdown.

automation:
  - alias: "Irrigation Unlimited Completion"
    trigger:
      platform: event
      event_type: irrigation_unlimited_finish
    action:
      - service: notify.persistent_notification
        data:
          title: "Irrigation Unlimited - Completed"
          message: |
            Time: {{ as_local(trigger.event.time_fired).strftime('%c') }}
            Controller: {{ trigger.event.data.controller.index + 1 }} {{ trigger.event.data.controller.name }}
            Sequence: {{ trigger.event.data.sequence.index + 1 }} {{ trigger.event.data.sequence.name }}
            Schedule: {% if trigger.event.data.schedule.index is integer %}{{ trigger.event.data.schedule.index + 1 }} {{ trigger.event.data.schedule.name }}{% else %}Manual{% endif %}
            Duration: {{ timedelta(seconds=trigger.event.data.run.duration) }}

Here is the notification displayed in the Home Assistant web interface.

10.1.2. irrigation_unlimited_switch_error, irrigation_unlimited_sync_error

These events are fired during a check back operation. A irrigation_unlimited_sync_error is fired if the physical switch is found to be out of sync. This message will repeat for each attempted resync. After the specified number of retries have been exhusted a irrigation_unlimited_switch_error is fired. Additional information is available that can be used in automation scripts.

Example to send an email on switch failure. There are two parts to this procedure, the first is to setup an email notification for your provider. See here for a google mail example. The next is to use the notifier.

automation:
  - id: "IU1653340138435"
    alias: "Irrigation Unlimited Switch Error"
    description: "Email a switch syncronisation error"
    trigger:
      - platform: event
        event_type:
          # - irrigation_unlimited_sync_error
          - irrigation_unlimited_switch_error
    action:
      - service: notify.NOTIFIER_NAME # Make sure this matches the "NOTIFIER_NAME" in the smtp setup
        data:
          title: "Irrigation Switch Error"
          message: |
            Type: {{ trigger.event.event_type }}
            Time: {{ as_local(trigger.event.time_fired).strftime('%c') }}
            Expected: {{ trigger.event.data.expected }}
            Controller: {{ trigger.event.data.controller.index + 1 }} {{ trigger.event.data.controller.name }}
            {% if trigger.event.data.zone.index is not none %}
              Zone: {{ trigger.event.data.zone.index + 1 }} {{ trigger.event.data.zone.name }}
            {% endif %}
            Entity: {{ trigger.event.data.entity_id }}

11. Troubleshooting

There should be little trouble installing this component, please use the HACS method where possible. Binary sensors are created automatically. However, if you experience difficulties please check the following:

11.1. Requirements

This integration depends on two other components; recorder and history. Both of these components are part of the standard Home Assistant installation and enabled by default with the default_config: line in the configuration. If you have removed this line then a history: and recorder: section must be setup manually. If a mistake is made in either one of these configurations then they will not start and in turn, Irrigation Unlimited for which it depends on, will not start. Please check the log file for the following lines:

2021-08-03 12:12:40 INFO (MainThread) [homeassistant.setup] Setting up recorder
2021-08-03 12:12:40 INFO (MainThread) [homeassistant.setup] Setup of domain recorder took 0.1 seconds
...
2021-08-03 12:12:42 INFO (MainThread) [homeassistant.setup] Setting up history
2021-08-03 12:12:42 INFO (MainThread) [homeassistant.setup] Setup of domain history took 0.0 seconds

The above shows the requirements were loaded successfully. Note: The lines may not be consecutive in the log. If you do not see these lines then go back to basics and remove any history: and recorder: sections and ensure the default_config: line is present. Restart HA and check you have these log entries.

11.2. HA Configuration

There must be a irrigation_unlimited: section in the configuration. If the section is missing or invalid then Irrigation Unlimited will not start. Check the log file to see it successfully started up.

2021-08-03 12:12:45 INFO (MainThread) [homeassistant.setup] Setting up irrigation_unlimited
...
2021-08-03 12:12:47 INFO (MainThread) [homeassistant.setup] Setup of domain irrigation_unlimited took n.n seconds

The above shows that Irrigation Unlimited loaded successfully. Note: The lines will most likely not be together so do a search. If it failed then use the minimal configuration shown here. This is a good starting point to get acquainted with this integration.

11.3 Community Forum

Have a question then head over to the Irrigation Unlimited community forum. If discussing a problem it is best to post the configuration along with the log.

11.4. Logging

These messages are very important in helping to determine any problem. Go into Settings -> System -> Logs. In the search box put in irrigation_unlimited (Note the underscore between the two words) and press the LOAD FULL LOGS button. The log should always accompany the configuration when seeking help on the community forum or opening an issue.

For more detailed information set your logging for the component to debug:

logger:
  default: info
  logs:
    custom_components.irrigation_unlimited: debug

11.5. Last but not least

If all else fails please open an issue. Please be sure to post the configuration AND the log.

12. Notes

1. All feature requests, issues and questions are welcome.

<a href="https://www.buymeacoffee.com/rgc99" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" height=40px width=144px></a><!-- markdownlint-disable-line MD033 -->

13. Snake case

The controller_id, zone_id and schedule_id identifiers need to be in snake_case like my_garden, vege_patch, rose_bed, front_lawn, before_dawn. The allowable characters are lower case alphabet, numerals and the underscore. The underscore cannot be used as a leading or trailing character and not more than one together. For more information see here

14. Parameter Types

14.1 Irrigation Unlimited Entities

This parameter specifies one or more Irrigation Unlimited entities such as 'binary_sensor.irrigation_unlimited_c1_z1'. Multiple entities can be a CSV string or a list. Here is a code snippet to show different ways to specify the entity_ids.

  ...
  entity_id: binary_sensor.irrigation_unlimited_c1_z1
  entity_id: binary_sensor.irrigation_unlimited_c1_z1,binary_sensor.irrigation_unlimited_c1_z2
  entity_id:
    - binary_sensor.irrigation_unlimited_c1_z1
    - binary_sensor.irrigation_unlimited_c1_z2
  ...

14.2 Duration (Time Period)

The time period (duration) type is a string in the format HH:MM, HH:MM:SS, the number of seconds or a dictionary. Time type must be a positive value unless otherwise noted. The value will be rounded down to the system granularity. The default granularity is one second. This is the heart beat or system pulse. All times will be synchronised to these boundaries. Here are different ways to specify 10 minutes.

  ...
  time: '00:10' # HH:MM
  time: '0:10:00' # H:MM:SS
  time: '00:10:00' # HH:MM:SS
  time: 600 # Seconds
  time: # One or more or the following
    days: 0
    hours: 0
    minutes: 10
    seconds: 0
  ...

14.3 Switch entities

These can be any entity from the switch, light, valve or cover platforms or anything that supports the turn_on and turn_off actions. Multiple entities can be a CSV string or a list. Here is a code snippet to show different ways to specify the entity_ids.

  ...
  entity_id: switch.valve_1
  entity_id: light.valve_1,light.valve_2
  entity_id:
    - switch.valve_1
    - light.valve_2
  ...

In case you wish to control some other device like a motorised valve that presents itself in Home Assistant as a cover then adapt the following automation.

automation:
  - alias: 'Zone 1 motorised valve'
    description: Turn on/off motorised valve
    trigger:
      - platform: state
        entity_id:
          - binary_sensor.irrigation_unlimited_c1_z1
    condition: []
    action:
      - service: |-
          {% if trigger.to_state.state == 'on' %}
            cover.open_cover
          {% else %}
            cover.close_cover
          {% endif %}
        entity_id: cover.my_cover_1
    mode: single

14.4 Templating

Some parameters support templating. Actual support is noted in the relevant documentation.

Templating is an advanced Home Assistant scripting technique. In many cases such as scripts and automations templating is built in. In other situations like the tap action from a button card, templating is not available but the string will be passed to the service call. Irrigation Unlimited will detect the string contains a template and convert it. Here are some examples that retrieve data from an input text box and pass it to a service call.

  ...
  action:
    service: irrigation_unlimited.adjust_time
    service_data:
      percentage: "{{ states('input_text.adjustment') | float(100) }}"
  ...
  action:
    service: irrigation_unlimited.manual_run
    service_data:
      time: "{{ states('input_text.run_time') | default('00:00') }}"

14.5 Sequence

Sequence to adjust, a number (1, 2..N). This is the position number of the sequence under the controller. sequence_id: 1 is the first, 2 is the second and so on. As a shortcut, sequence_id: 0 will alter all sequences. Within a controller, sequences are numbered by their position starting at 1. Only relevant when entity_id is a controller/master. An error message will be generated if a sequence_id is specified and entity_id is not a controller/master.

14.6 Zones

Zone(s) to adjust, number/list (1, 2..N). This is the position number of the zone reference under the sequence. zones: 1 is the first, 2 is the second and so on. As a shortcut, zones: 0 will alter all zones. Within a sequence, zones are numbered by their position starting a 1.

14.7 Time (Time of Day)

The time of day type is a string in the format HH:MM or HH:MM:SS. It is assumed to be in the local time.

15. Contributions are welcome

If you want to contribute to this please read the Contribution guidelines.

16. Credits

Code template was mainly taken from @Ludeeus's integration_blueprint template.

Some inspiration was taken from kloggy's work.