Rain Bird

This Rain Bird integration allows interacting with LNK WiFi module of the Rain Bird Irrigation system in Home Assistant.

There is currently support for the following device types within Home Assistant:

Home Assistant allows you to control the irrigation values, log details about the device including optional rain sensor, and allow you to view any upcoming irrigations schedules on a calendar.

Prerequisites

  1. Follow the Rain Bird instructions for set up of your sprinkler system
  2. Follow the setup guide for installing your LNK WiFi Module
  3. Complete the necessary steps in the Rain Bird App
  4. Home Assistant should auto discover the device on your network based on the mac address. Otherwise you will need to know the devices IP address on your network to let Home Assistant know how to connect to it.

Configuration

To add the Rain Bird integration to your Home Assistant instance, use this My button:

Manual configuration steps

If the above My button doesn’t work, you can also perform the following steps manually:

  • Browse to your Home Assistant instance.

  • Go to Settings > Devices & Services.

  • In the bottom right corner, select the Add Integration button.

  • From the list, select Rain Bird.

  • Follow the instructions on screen to complete the setup.

Host

The IP address of your Rain Bird device. You can find the IP address under the device in the Rain Bird app under Controller Settings -> Network Info.

Password

The password used to authenticate the Rain Bird device.

Configuration options

The integration provides the following configuration options:

Default irrigation time

The number of minutes that the irrigation will run when turning on a zone switch. The default is 6 minutes. This can be overridden with an action (see below).

Data updates

The Rain Bird integration fetches available irrigation zones once, then polls every minute to check the current state of each valve. The irrigation schedule calendar is only fetched every 15 minutes.

Supported functionality

Entities

The Rain Bird integration provides the following entities.

Binary sensor

  • Rain sensor
    • Description: The rain sensor will tell if you if the device has detected rain.
    • Available for devices: The rain sensor is an optional add-on for the device purchased from Rain Bird.

Calendar

  • Controller irrigation schedule
    • Description: The irrigation schedule Calendar entity is created for each schedule configured in the Rain Bird app. You can view the program schedule in the Home Assistant calendar UI, or trigger other automations based on the irrigation start or end time.
    • Available for devices: Only available for Rain Bird devices irrigation schedules.

Number

  • Rain Delay
    • Description: Lets you set and view the number of days, if any, the automatic irrigation schedule has been delayed due to rain. You may use the number entity with an automation such as increasing the number of days to delay irrigation when combined with another weather forecast integration in Home Assistant.
    • Available for devices: Only available for Rain Bird devices irrigation schedules.

Switch

  • Irrigation Zone
    • Description: Switches are automatically added for all available zones of configured controllers. Turning on the switch will open the irrigation valve for that zone.
    • Available for devices: All

Actions

The integration exposes actions to give additional control over a Rain Bird device.

rainbird.start_irrigation

Start a Rain Bird zone for a set number of minutes. This action accepts a Rain Bird sprinkler zone switch entity and allows a custom duration unlike the switch.

Data attribute Optional Description
entity_id no The Rain Bird Sprinkler zone switch to turn on.
duration no Number of minutes for this zone to be turned on.
# Example configuration.yaml automation entry
automation:
  - alias: "Turn irrigation on"
    triggers:
      - trigger: time
        at: "5:30:00"
    actions:
      - action: rainbird.start_irrigation
        data:
          entity_id: switch.rain_bird_sprinkler_1
          duration: 5

This lets you other triggers in Home Assistant to set a more complex schedule than what is possible using the built in schedule in the Rain Bird app.

Known Limitations

The Rain Bird LNK WiFi can only receive one incoming request at a time. It may not be possible for Home Assistant to send commands to the device while you are also using the Rain Bird App. Home Assistant tries to carefully limit connections to the device to avoid failures.

Remove integration

This integration can be removed by following these steps:

To remove an integration instance from Home Assistant

  1. Go to Settings > Devices & services and select the integration card.
  2. From the list of devices, select the integration instance you want to remove.
  3. Next to the entry, select the three-dot menu. Then, select Delete.