Centralize rainbird config and add binary sensor platform

CODEOWNERS

@@ -221,6 +221,7 @@ homeassistant/components/qld_bushfire/* @exxamalte
 homeassistant/components/qnap/* @colinodell
 homeassistant/components/quantum_gateway/* @cisasteelersfan
 homeassistant/components/qwikswitch/* @kellerza
+homeassistant/components/rainbird/* @konikvranik
 homeassistant/components/raincloud/* @vanstinator
 homeassistant/components/rainforest_eagle/* @gtdiehl
 homeassistant/components/rainmachine/* @bachya

homeassistant/components/rainbird/__init__.py

@@ -1,42 +1,91 @@
 """Support for Rain Bird Irrigation system LNK WiFi Module."""
 import logging
 
+from pyrainbird import RainbirdController
 import voluptuous as vol
 
+from homeassistant.components import binary_sensor, sensor, switch
+from homeassistant.const import (
+    CONF_FRIENDLY_NAME,
+    CONF_HOST,
+    CONF_PASSWORD,
+    CONF_TRIGGER_TIME,
+)
+from homeassistant.helpers import discovery
 import homeassistant.helpers.config_validation as cv
-from homeassistant.const import CONF_HOST, CONF_PASSWORD
+
+CONF_ZONES = "zones"
+
+SUPPORTED_PLATFORMS = [switch.DOMAIN, sensor.DOMAIN, binary_sensor.DOMAIN]
 
 _LOGGER = logging.getLogger(__name__)
 
+RAINBIRD_CONTROLLER = "controller"
 DATA_RAINBIRD = "rainbird"
 DOMAIN = "rainbird"
 
-CONFIG_SCHEMA = vol.Schema(
+SENSOR_TYPE_RAINDELAY = "raindelay"
+SENSOR_TYPE_RAINSENSOR = "rainsensor"
+# sensor_type [ description, unit, icon ]
+SENSOR_TYPES = {
+    SENSOR_TYPE_RAINSENSOR: ["Rainsensor", None, "mdi:water"],
+    SENSOR_TYPE_RAINDELAY: ["Raindelay", None, "mdi:water-off"],
+}
+
+TRIGGER_TIME_SCHEMA = vol.All(
+    cv.time_period, cv.positive_timedelta, lambda td: (td.total_seconds() // 60)
+)
+
+ZONE_SCHEMA = vol.Schema(
     {
-        DOMAIN: vol.Schema(
-            {vol.Required(CONF_HOST): cv.string, vol.Required(CONF_PASSWORD): cv.string}
-        )
-    },
+        vol.Optional(CONF_FRIENDLY_NAME): cv.string,
+        vol.Optional(CONF_TRIGGER_TIME): TRIGGER_TIME_SCHEMA,
+    }
+)
+CONTROLLER_SCHEMA = vol.Schema(
+    {
+        vol.Required(CONF_HOST): cv.string,
+        vol.Required(CONF_PASSWORD): cv.string,
+        vol.Required(CONF_TRIGGER_TIME): TRIGGER_TIME_SCHEMA,
+        vol.Optional(CONF_ZONES): vol.Schema({cv.positive_int: ZONE_SCHEMA}),
+    }
+)
+CONFIG_SCHEMA = vol.Schema(
+    {DOMAIN: vol.Schema(vol.All(cv.ensure_list, [CONTROLLER_SCHEMA]))},
     extra=vol.ALLOW_EXTRA,
 )
 
 
 def setup(hass, config):
     """Set up the Rain Bird component."""
-    conf = config[DOMAIN]
-    server = conf.get(CONF_HOST)
-    password = conf.get(CONF_PASSWORD)
 
-    from pyrainbird import RainbirdController
+    hass.data[DATA_RAINBIRD] = []
+    success = False
+    for controller_config in config[DOMAIN]:
+        success = success or _setup_controller(hass, controller_config, config)
 
-    controller = RainbirdController(server, password)
+    return success
 
-    _LOGGER.debug("Rain Bird Controller set to: %s", server)
 
-    initial_status = controller.currentIrrigation()
-    if initial_status and initial_status["type"] != "CurrentStationsActiveResponse":
-        _LOGGER.error("Error getting state. Possible configuration issues")
+def _setup_controller(hass, controller_config, config):
+    """Set up a controller."""
+    server = controller_config[CONF_HOST]
+    password = controller_config[CONF_PASSWORD]
+    controller = RainbirdController(server, password)
+    position = len(hass.data[DATA_RAINBIRD])
+    try:
+        controller.get_serial_number()
+    except Exception as exc:  # pylint: disable=W0703
+        _LOGGER.error("Unable to setup controller: %s", exc)
         return False
-
-    hass.data[DATA_RAINBIRD] = controller
+    hass.data[DATA_RAINBIRD].append(controller)
+    _LOGGER.debug("Rain Bird Controller %d set to: %s", position, server)
+    for platform in SUPPORTED_PLATFORMS:
+        discovery.load_platform(
+            hass,
+            platform,
+            DOMAIN,
+            {RAINBIRD_CONTROLLER: position, **controller_config},
+            config,
+        )
     return True

homeassistant/components/rainbird/binary_sensor.py

@@ -0,0 +1,64 @@
+"""Support for Rain Bird Irrigation system LNK WiFi Module."""
+import logging
+
+from pyrainbird import RainbirdController
+
+from homeassistant.components.binary_sensor import BinarySensorDevice
+
+from . import (
+    DATA_RAINBIRD,
+    RAINBIRD_CONTROLLER,
+    SENSOR_TYPE_RAINDELAY,
+    SENSOR_TYPE_RAINSENSOR,
+    SENSOR_TYPES,
+)
+
+_LOGGER = logging.getLogger(__name__)
+
+
+def setup_platform(hass, config, add_entities, discovery_info=None):
+    """Set up a Rain Bird sensor."""
+    if discovery_info is None:
+        return
+
+    controller = hass.data[DATA_RAINBIRD][discovery_info[RAINBIRD_CONTROLLER]]
+    add_entities(
+        [RainBirdSensor(controller, sensor_type) for sensor_type in SENSOR_TYPES], True
+    )
+
+
+class RainBirdSensor(BinarySensorDevice):
+    """A sensor implementation for Rain Bird device."""
+
+    def __init__(self, controller: RainbirdController, sensor_type):
+        """Initialize the Rain Bird sensor."""
+        self._sensor_type = sensor_type
+        self._controller = controller
+        self._name = SENSOR_TYPES[self._sensor_type][0]
+        self._icon = SENSOR_TYPES[self._sensor_type][2]
+        self._state = None
+
+    @property
+    def is_on(self):
+        """Return true if the binary sensor is on."""
+        return None if self._state is None else bool(self._state)
+
+    def update(self):
+        """Get the latest data and updates the states."""
+        _LOGGER.debug("Updating sensor: %s", self._name)
+        state = None
+        if self._sensor_type == SENSOR_TYPE_RAINSENSOR:
+            state = self._controller.get_rain_sensor_state()
+        elif self._sensor_type == SENSOR_TYPE_RAINDELAY:
+            state = self._controller.get_rain_delay()
+        self._state = None if state is None else bool(state)
+
+    @property
+    def name(self):
+        """Return the name of this camera."""
+        return self._name
+
+    @property
+    def icon(self):
+        """Return icon."""
+        return self._icon

homeassistant/components/rainbird/manifest.json

@@ -3,8 +3,10 @@
   "name": "Rainbird",
   "documentation": "https://www.home-assistant.io/components/rainbird",
   "requirements": [
-    "pyrainbird==0.2.1"
+    "pyrainbird==0.4.1"
   ],
   "dependencies": [],
-  "codeowners": []
+  "codeowners": [
+    "@konikvranik"
+  ]
 }

homeassistant/components/rainbird/sensor.py

@@ -1,44 +1,37 @@
 """Support for Rain Bird Irrigation system LNK WiFi Module."""
 import logging
 
-import voluptuous as vol
+from pyrainbird import RainbirdController
 
-from homeassistant.components.sensor import PLATFORM_SCHEMA
-from homeassistant.const import CONF_MONITORED_CONDITIONS
-import homeassistant.helpers.config_validation as cv
 from homeassistant.helpers.entity import Entity
 
-from . import DATA_RAINBIRD
+from . import (
+    DATA_RAINBIRD,
+    RAINBIRD_CONTROLLER,
+    SENSOR_TYPE_RAINDELAY,
+    SENSOR_TYPE_RAINSENSOR,
+    SENSOR_TYPES,
+)
 
 _LOGGER = logging.getLogger(__name__)
 
-# sensor_type [ description, unit, icon ]
-SENSOR_TYPES = {"rainsensor": ["Rainsensor", None, "mdi:water"]}
-
-PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend(
-    {
-        vol.Optional(CONF_MONITORED_CONDITIONS, default=list(SENSOR_TYPES)): vol.All(
-            cv.ensure_list, [vol.In(SENSOR_TYPES)]
-        )
-    }
-)
-
 
 def setup_platform(hass, config, add_entities, discovery_info=None):
     """Set up a Rain Bird sensor."""
-    controller = hass.data[DATA_RAINBIRD]
 
-    sensors = []
-    for sensor_type in config.get(CONF_MONITORED_CONDITIONS):
-        sensors.append(RainBirdSensor(controller, sensor_type))
+    if discovery_info is None:
+        return
 
-    add_entities(sensors, True)
+    controller = hass.data[DATA_RAINBIRD][discovery_info[RAINBIRD_CONTROLLER]]
+    add_entities(
+        [RainBirdSensor(controller, sensor_type) for sensor_type in SENSOR_TYPES], True
+    )
 
 
 class RainBirdSensor(Entity):
     """A sensor implementation for Rain Bird device."""
 
-    def __init__(self, controller, sensor_type):
+    def __init__(self, controller: RainbirdController, sensor_type):
         """Initialize the Rain Bird sensor."""
         self._sensor_type = sensor_type
         self._controller = controller
@@ -55,12 +48,10 @@ def state(self):
     def update(self):
         """Get the latest data and updates the states."""
         _LOGGER.debug("Updating sensor: %s", self._name)
-        if self._sensor_type == "rainsensor":
-            result = self._controller.currentRainSensorState()
-            if result and result["type"] == "CurrentRainSensorStateResponse":
-                self._state = result["sensorState"]
-            else:
-                self._state = None
+        if self._sensor_type == SENSOR_TYPE_RAINSENSOR:
+            self._state = self._controller.get_rain_sensor_state()
+        elif self._sensor_type == SENSOR_TYPE_RAINDELAY:
+            self._state = self._controller.get_rain_delay()
 
     @property
     def name(self):

homeassistant/components/rainbird/services.yaml

@@ -0,0 +1,9 @@
+start_irrigation:
+  description: Start the irrigation
+  fields:
+    entity_id:
+      description: Name of a single irrigation to turn on
+      example: 'switch.sprinkler_1'
+    duration:
+      description: Duration for this sprinkler to be turned on
+      example: 1