From 8d7475245965f940a7e4cf25440bfae4e6beecdf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Petr=20Vran=C3=ADk?= Date: Mon, 9 Sep 2019 20:32:40 +0200 Subject: [PATCH 01/12] New version of rainbird component see https://github.com/home-assistant/home-assistant/pull/26393 --- source/_components/rainbird.markdown | 122 +++++++++++++++------------ 1 file changed, 69 insertions(+), 53 deletions(-) diff --git a/source/_components/rainbird.markdown b/source/_components/rainbird.markdown index 1b189adc420b..2575ed40a2b6 100644 --- a/source/_components/rainbird.markdown +++ b/source/_components/rainbird.markdown @@ -29,6 +29,44 @@ To enable it, add the following to your `configuration.yaml` file: rainbird: host: IP_ADDRESS_OF_MODULE password: YOUR_PASSWORD + trigger_time: 6 + scan_interval: 5 + zones: + 1: + friendly_name: My zone 1 + trigger_time: 6 + scan_interval: 5 +``` + +or multiple controllers variant: + +```yaml +# Example configuration.yaml entry +rainbird: + - host: IP_ADDRESS_OF_MODULE + password: YOUR_PASSWORD + trigger_time: 6 + scan_interval: 5 + zones: + 1: + friendly_name: My zone 1 + trigger_time: 6 + 2: + friendly_name: My zone 2 + trigger_time: 2 + scan_interval: 1 + - host: IP_ADDRESS_OF_ANOTHER_MODULE + password: YOUR_ANOTHER_PASSWORD + trigger_time: 6 + scan_interval: 5 + zones: + 1: + friendly_name: My zone 1 + trigger_time: 6 + 3: + friendly_name: My zone 3 + trigger_time: 5 + scan_interval: 3 ``` {% configuration %} @@ -40,6 +78,35 @@ password: description: The password for accessing the module. required: true type: string +trigger_time: + description: Irrigation time. + required: false + type: int +scan_interval: + description: Interval to scan for zone state. + required: false + type: int +zones: + description: Dictionary of zone configurations + required: false + type: dict + keys: + 1: + description: Zone ID + type: dict + keys: + friendly_name: + description: Friendly name to see in GUI + required: false + type: string + trigger_time: + description: Irrigation time. + required: false + type: int + scan_interval: + description: Interval to scan for zone state. + required: false + type: int {% endconfiguration %}
@@ -50,62 +117,11 @@ Please note that due to the implementation of the API within the LNK Module, the This `rainbird` sensor allows interacting with [LNK WiFi](http://www.rainbird.com/landscape/products/controllers/LNK-WiFi.htm) module of the Rain Bird Irrigation system in Home Assistant. -Add the following to your `configuration.yaml` file to enable the rain sensor: - -```yaml -# Example configuration.yaml entry -sensor: - - platform: rainbird - monitored_conditions: - - rainsensor -``` - -{% configuration %} -monitored_conditions: - description: Conditions to be monitored. - type: list - keys: - rainsensor: - description: Returns the sensor level. -{% endconfiguration %} +The component adds `rainsensor` and `raindelay` sensors and their `binary_sensor` alternatives. ## Switch This `rainbird` switch platform allows interacting with [LNK WiFi](http://www.rainbird.com/landscape/products/controllers/LNK-WiFi.htm) module of the Rain Bird Irrigation system in Home Assistant. -Add the following to your `configuration.yaml` file to use the switch platform: - -```yaml -switch: - - platform: rainbird - switches: - sprinkler_1: - zone: 1 - friendly_name: "Front sprinklers" - trigger_time: 10 - scan_interval: 10 - sprinkler_2: - friendly_name: "Back sprinklers" - zone: 2 - trigger_time: 20 - scan_interval: 10 -``` +Switches are automatically added for all available zones of configured controllers- -{% configuration %} -zone: - description: Station zone identifier. - required: true - type: string -friendly_name: - description: Just a friendly name for the station. - required: false - type: string -trigger_time: - description: The default duration to sprinkle the zone in minutes. - required: true - type: integer -scan_interval: - description: How fast to refresh the switch in minutes. - required: false - type: integer -{% endconfiguration %} From 7525247de43fa30ca1be07a8ba5a426ad45e8027 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Petr=20Vran=C3=ADk?= Date: Mon, 9 Sep 2019 20:39:56 +0200 Subject: [PATCH 02/12] Update rainbird.markdown --- source/_components/rainbird.markdown | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/source/_components/rainbird.markdown b/source/_components/rainbird.markdown index 2575ed40a2b6..84fa75b72f79 100644 --- a/source/_components/rainbird.markdown +++ b/source/_components/rainbird.markdown @@ -81,19 +81,19 @@ password: trigger_time: description: Irrigation time. required: false - type: int + type: integer scan_interval: description: Interval to scan for zone state. required: false - type: int + type: integer zones: description: Dictionary of zone configurations required: false - type: dict + type: map keys: 1: description: Zone ID - type: dict + type: map keys: friendly_name: description: Friendly name to see in GUI @@ -102,11 +102,11 @@ zones: trigger_time: description: Irrigation time. required: false - type: int + type: integer scan_interval: description: Interval to scan for zone state. required: false - type: int + type: integer {% endconfiguration %}
From 4c1186b4fa77891bdb6a0f295adcb87d9015262f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Petr=20Vran=C3=ADk?= Date: Mon, 9 Sep 2019 20:44:44 +0200 Subject: [PATCH 03/12] Update rainbird.markdown --- source/_components/rainbird.markdown | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/source/_components/rainbird.markdown b/source/_components/rainbird.markdown index 84fa75b72f79..220faf8d9987 100644 --- a/source/_components/rainbird.markdown +++ b/source/_components/rainbird.markdown @@ -48,10 +48,10 @@ rainbird: trigger_time: 6 scan_interval: 5 zones: - 1: + "1": friendly_name: My zone 1 trigger_time: 6 - 2: + "2": friendly_name: My zone 2 trigger_time: 2 scan_interval: 1 @@ -60,10 +60,10 @@ rainbird: trigger_time: 6 scan_interval: 5 zones: - 1: + "1": friendly_name: My zone 1 trigger_time: 6 - 3: + "3": friendly_name: My zone 3 trigger_time: 5 scan_interval: 3 From f8ea86565ae1ce59ed629b40ae24aa4e209a08a4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Petr=20Vran=C3=ADk?= Date: Mon, 9 Sep 2019 20:46:59 +0200 Subject: [PATCH 04/12] Update rainbird.markdown --- source/_components/rainbird.markdown | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/source/_components/rainbird.markdown b/source/_components/rainbird.markdown index 220faf8d9987..f195d2214287 100644 --- a/source/_components/rainbird.markdown +++ b/source/_components/rainbird.markdown @@ -24,7 +24,7 @@ There is currently support for the following device types within Home Assistant: To enable it, add the following to your `configuration.yaml` file: -```yaml +``` # Example configuration.yaml entry rainbird: host: IP_ADDRESS_OF_MODULE @@ -40,7 +40,7 @@ rainbird: or multiple controllers variant: -```yaml +``` # Example configuration.yaml entry rainbird: - host: IP_ADDRESS_OF_MODULE @@ -48,10 +48,10 @@ rainbird: trigger_time: 6 scan_interval: 5 zones: - "1": + 1: friendly_name: My zone 1 trigger_time: 6 - "2": + 2: friendly_name: My zone 2 trigger_time: 2 scan_interval: 1 @@ -60,10 +60,10 @@ rainbird: trigger_time: 6 scan_interval: 5 zones: - "1": + 1: friendly_name: My zone 1 trigger_time: 6 - "3": + 3: friendly_name: My zone 3 trigger_time: 5 scan_interval: 3 From 048450382f92f85fdfce28c4e9394d85eb64a246 Mon Sep 17 00:00:00 2001 From: konikvranik Date: Mon, 9 Sep 2019 21:20:33 +0200 Subject: [PATCH 05/12] Update rainbird.markdown --- source/_components/rainbird.markdown | 22 +++------------------- 1 file changed, 3 insertions(+), 19 deletions(-) diff --git a/source/_components/rainbird.markdown b/source/_components/rainbird.markdown index f195d2214287..790371ee289e 100644 --- a/source/_components/rainbird.markdown +++ b/source/_components/rainbird.markdown @@ -24,23 +24,7 @@ There is currently support for the following device types within Home Assistant: To enable it, add the following to your `configuration.yaml` file: -``` -# Example configuration.yaml entry -rainbird: - host: IP_ADDRESS_OF_MODULE - password: YOUR_PASSWORD - trigger_time: 6 - scan_interval: 5 - zones: - 1: - friendly_name: My zone 1 - trigger_time: 6 - scan_interval: 5 -``` - -or multiple controllers variant: - -``` +```yaml # Example configuration.yaml entry rainbird: - host: IP_ADDRESS_OF_MODULE @@ -91,7 +75,7 @@ zones: required: false type: map keys: - 1: + ZONE_NUMBER: description: Zone ID type: map keys: @@ -123,5 +107,5 @@ The component adds `rainsensor` and `raindelay` sensors and their `binary_sensor This `rainbird` switch platform allows interacting with [LNK WiFi](http://www.rainbird.com/landscape/products/controllers/LNK-WiFi.htm) module of the Rain Bird Irrigation system in Home Assistant. -Switches are automatically added for all available zones of configured controllers- +Switches are automatically added for all available zones of configured controllers. From f3eceb5d46a5792b74ec2052bb1d75ea0084c11a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Petr=20Vran=C3=ADk?= Date: Wed, 11 Sep 2019 09:50:18 +0200 Subject: [PATCH 06/12] Update rainbird.markdown --- source/_components/rainbird.markdown | 58 ++++++++++++++++------------ 1 file changed, 34 insertions(+), 24 deletions(-) diff --git a/source/_components/rainbird.markdown b/source/_components/rainbird.markdown index 790371ee289e..2c8665209c26 100644 --- a/source/_components/rainbird.markdown +++ b/source/_components/rainbird.markdown @@ -27,30 +27,10 @@ To enable it, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry rainbird: - - host: IP_ADDRESS_OF_MODULE - password: YOUR_PASSWORD - trigger_time: 6 - scan_interval: 5 - zones: - 1: - friendly_name: My zone 1 - trigger_time: 6 - 2: - friendly_name: My zone 2 - trigger_time: 2 - scan_interval: 1 - - host: IP_ADDRESS_OF_ANOTHER_MODULE - password: YOUR_ANOTHER_PASSWORD - trigger_time: 6 - scan_interval: 5 - zones: - 1: - friendly_name: My zone 1 - trigger_time: 6 - 3: - friendly_name: My zone 3 - trigger_time: 5 - scan_interval: 3 + host: IP_ADDRESS_OF_MODULE + password: YOUR_PASSWORD + trigger_time: 6 + ``` {% configuration %} @@ -93,6 +73,36 @@ zones: type: integer {% endconfiguration %} + +More complex configuration using all possibe features could look like tihs example: +```yaml +# Example configuration.yaml entry +rainbird: + - host: IP_ADDRESS_OF_MODULE + password: YOUR_PASSWORD + trigger_time: 6 + scan_interval: 5 + zones: + 1: + friendly_name: My zone 1 + trigger_time: 6 + 2: + friendly_name: My zone 2 + trigger_time: 2 + scan_interval: 1 + - host: IP_ADDRESS_OF_ANOTHER_MODULE + password: YOUR_ANOTHER_PASSWORD + trigger_time: 6 + scan_interval: 5 + zones: + 1: + friendly_name: My zone 1 + trigger_time: 6 + 3: + friendly_name: My zone 3 + trigger_time: 5 + scan_interval: 3 +```
Please note that due to the implementation of the API within the LNK Module, there is a concurrency issue. For example, the Rain Bird app will give connection issues (like already a connection active).
From 10c23c42b04c4307ae96ae7ae7af4764fa1789e2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Petr=20Vran=C3=ADk?= Date: Thu, 12 Sep 2019 08:43:56 +0200 Subject: [PATCH 07/12] Update rainbird.markdown --- source/_components/rainbird.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_components/rainbird.markdown b/source/_components/rainbird.markdown index 2c8665209c26..05f6994f6109 100644 --- a/source/_components/rainbird.markdown +++ b/source/_components/rainbird.markdown @@ -44,7 +44,7 @@ password: type: string trigger_time: description: Irrigation time. - required: false + required: true type: integer scan_interval: description: Interval to scan for zone state. From b01d27bfa319d5bf0210d6d46a9c9de31645f17e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Petr=20Vran=C3=ADk?= Date: Wed, 18 Sep 2019 21:57:40 +0200 Subject: [PATCH 08/12] Update rainbird.markdown --- source/_components/rainbird.markdown | 12 ------------ 1 file changed, 12 deletions(-) diff --git a/source/_components/rainbird.markdown b/source/_components/rainbird.markdown index 05f6994f6109..19a301f3da43 100644 --- a/source/_components/rainbird.markdown +++ b/source/_components/rainbird.markdown @@ -46,10 +46,6 @@ trigger_time: description: Irrigation time. required: true type: integer -scan_interval: - description: Interval to scan for zone state. - required: false - type: integer zones: description: Dictionary of zone configurations required: false @@ -67,10 +63,6 @@ zones: description: Irrigation time. required: false type: integer - scan_interval: - description: Interval to scan for zone state. - required: false - type: integer {% endconfiguration %} @@ -81,7 +73,6 @@ rainbird: - host: IP_ADDRESS_OF_MODULE password: YOUR_PASSWORD trigger_time: 6 - scan_interval: 5 zones: 1: friendly_name: My zone 1 @@ -89,11 +80,9 @@ rainbird: 2: friendly_name: My zone 2 trigger_time: 2 - scan_interval: 1 - host: IP_ADDRESS_OF_ANOTHER_MODULE password: YOUR_ANOTHER_PASSWORD trigger_time: 6 - scan_interval: 5 zones: 1: friendly_name: My zone 1 @@ -101,7 +90,6 @@ rainbird: 3: friendly_name: My zone 3 trigger_time: 5 - scan_interval: 3 ```
Please note that due to the implementation of the API within the LNK Module, there is a concurrency issue. For example, the Rain Bird app will give connection issues (like already a connection active). From 59023cacaa1891c3bbf5aeeec4af25b57c1d103a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Petr=20Vran=C3=ADk?= Date: Mon, 23 Sep 2019 10:10:18 +0200 Subject: [PATCH 09/12] Update rainbird.markdown --- source/_components/rainbird.markdown | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/source/_components/rainbird.markdown b/source/_components/rainbird.markdown index 19a301f3da43..de931fb8a603 100644 --- a/source/_components/rainbird.markdown +++ b/source/_components/rainbird.markdown @@ -29,7 +29,7 @@ To enable it, add the following to your `configuration.yaml` file: rainbird: host: IP_ADDRESS_OF_MODULE password: YOUR_PASSWORD - trigger_time: 6 + trigger_time: 360 ``` @@ -43,9 +43,9 @@ password: required: true type: string trigger_time: - description: Irrigation time. + description: Irrigation time. Seconds are ignored. required: true - type: integer + type: time zones: description: Dictionary of zone configurations required: false @@ -60,9 +60,9 @@ zones: required: false type: string trigger_time: - description: Irrigation time. + description: Irrigation time. Seconds are ignored. required: false - type: integer + type: time {% endconfiguration %} @@ -76,20 +76,21 @@ rainbird: zones: 1: friendly_name: My zone 1 - trigger_time: 6 + trigger_time: + minutes: 6 2: friendly_name: My zone 2 trigger_time: 2 - host: IP_ADDRESS_OF_ANOTHER_MODULE password: YOUR_ANOTHER_PASSWORD - trigger_time: 6 + trigger_time: 0:06 zones: 1: friendly_name: My zone 1 - trigger_time: 6 + trigger_time: 0:06 3: friendly_name: My zone 3 - trigger_time: 5 + trigger_time: 0:05 ```
Please note that due to the implementation of the API within the LNK Module, there is a concurrency issue. For example, the Rain Bird app will give connection issues (like already a connection active). From de3bf898445519b318428b7a792b0db5d187488f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Petr=20Vran=C3=ADk?= Date: Thu, 26 Sep 2019 12:00:33 +0200 Subject: [PATCH 10/12] Update source/_components/rainbird.markdown Co-Authored-By: Martin Hjelmare --- source/_components/rainbird.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_components/rainbird.markdown b/source/_components/rainbird.markdown index de931fb8a603..350c9e47324d 100644 --- a/source/_components/rainbird.markdown +++ b/source/_components/rainbird.markdown @@ -43,7 +43,7 @@ password: required: true type: string trigger_time: - description: Irrigation time. Seconds are ignored. + description: Irrigation time. The time will be rounded down to whole minutes. required: true type: time zones: From 2e3f2022a974a9e989435f58e2333b2276593473 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Petr=20Vran=C3=ADk?= Date: Thu, 26 Sep 2019 12:00:42 +0200 Subject: [PATCH 11/12] Update source/_components/rainbird.markdown Co-Authored-By: Martin Hjelmare --- source/_components/rainbird.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_components/rainbird.markdown b/source/_components/rainbird.markdown index 350c9e47324d..f3abcf36680e 100644 --- a/source/_components/rainbird.markdown +++ b/source/_components/rainbird.markdown @@ -66,7 +66,7 @@ zones: {% endconfiguration %} -More complex configuration using all possibe features could look like tihs example: +More complex configuration using all possible features could look like this example: ```yaml # Example configuration.yaml entry rainbird: From 33a43118c733c09d6da0dace76f2c3cdbb5b4348 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Petr=20Vran=C3=ADk?= Date: Thu, 26 Sep 2019 12:00:59 +0200 Subject: [PATCH 12/12] Update source/_components/rainbird.markdown Co-Authored-By: Martin Hjelmare --- source/_components/rainbird.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_components/rainbird.markdown b/source/_components/rainbird.markdown index f3abcf36680e..4001713357fb 100644 --- a/source/_components/rainbird.markdown +++ b/source/_components/rainbird.markdown @@ -100,7 +100,7 @@ Please note that due to the implementation of the API within the LNK Module, the This `rainbird` sensor allows interacting with [LNK WiFi](http://www.rainbird.com/landscape/products/controllers/LNK-WiFi.htm) module of the Rain Bird Irrigation system in Home Assistant. -The component adds `rainsensor` and `raindelay` sensors and their `binary_sensor` alternatives. +The integration adds `rainsensor` and `raindelay` sensors and their `binary_sensor` alternatives. ## Switch