diff --git a/source/_integrations/rainbird.markdown b/source/_integrations/rainbird.markdown index 9af27ed604fe..d39ddddb3102 100644 --- a/source/_integrations/rainbird.markdown +++ b/source/_integrations/rainbird.markdown @@ -3,12 +3,15 @@ title: Rain Bird description: Instructions on how to integrate your Rain Bird LNK WiFi Module within Home Assistant. ha_category: - Irrigation + - Binary Sensor - Sensor - Switch +ha_config_flow: true ha_release: 0.61 ha_iot_class: Local Polling ha_codeowners: - '@konikvranik' + - '@allenporter' ha_domain: rainbird ha_platforms: - binary_sensor @@ -21,109 +24,44 @@ This `rainbird` integration allows interacting with [LNK WiFi](https://www.rainb There is currently support for the following device types within Home Assistant: +- [Binary Sensor](#binary-sensor) - [Sensor](#sensor) - [Switch](#switch) -## Configuration +{% include integrations/config_flow.md %} -To enable it, add the following to your `configuration.yaml` file: +## Configuration Options -```yaml -# Example configuration.yaml entry -rainbird: - host: IP_ADDRESS_OF_MODULE - password: YOUR_PASSWORD - trigger_time: 360 +The integration has a configuration option to change the default amount of time that the irrigation +will run when turning on a zone switch (default is 6 minutes). This can be overridden with a service call (see below). -``` +## Binary Sensor -{% configuration %} -host: - description: IP Address of the Module - required: true - type: string -password: - description: The password for accessing the module. - required: true - type: string -trigger_time: - description: Irrigation time. The time will be rounded down to whole minutes. - required: true - type: time -zones: - description: Dictionary of zone configurations - required: false - type: map - keys: - ZONE_NUMBER: - description: Zone ID - type: map - keys: - friendly_name: - description: Friendly name to see in GUI - required: false - type: string - trigger_time: - description: Irrigation time. Seconds are ignored. - required: false - type: time -{% endconfiguration %} - - -More complex configuration using all possible features could look like this example: -```yaml -# Example configuration.yaml entry -rainbird: - - host: IP_ADDRESS_OF_MODULE - password: YOUR_PASSWORD - trigger_time: - minutes: 6 - zones: - 1: - friendly_name: My zone 1 - trigger_time: - minutes: 6 - 2: - friendly_name: My zone 2 - trigger_time: - minutes: 2 - - host: IP_ADDRESS_OF_ANOTHER_MODULE - password: YOUR_ANOTHER_PASSWORD - trigger_time: 0:06 - zones: - 1: - friendly_name: My zone 1 - trigger_time: 0:06 - 3: - friendly_name: My zone 3 - trigger_time: 0:05 -``` -