Extracting zoneminder to a new library (#16527)

* Migrating out the zoneminder platform (and camera.zoneminder) to a new library

* Clean up the global variable ZM usage

* Modify camera.zoneminder to use the new Monitor class implementation

* Refactor camera.zoneminder after latest refactor in zm-py

* Implementing changes to switch.zoneminder to use zm-py native methods

* Complete migrating over sensor.zoneminder to the zm-py library

* Tweaking ZoneMinder components from code review

* Linting fixes for the zoneminder components

* Directly assign value when turning on/off in switch.zoneminder

homeassistant/components/camera/zoneminder.py

@@ -4,91 +4,47 @@ Support for ZoneMinder camera streaming.
 For more details about this platform, please refer to the documentation at
 https://home-assistant.io/components/camera.zoneminder/
 """
-import asyncio
 import logging
-from urllib.parse import urljoin, urlencode
 
 from homeassistant.const import CONF_NAME
 from homeassistant.components.camera.mjpeg import (
     CONF_MJPEG_URL, CONF_STILL_IMAGE_URL, MjpegCamera)
-
-from homeassistant.components import zoneminder
+from homeassistant.components.zoneminder import DOMAIN as ZONEMINDER_DOMAIN
 
 _LOGGER = logging.getLogger(__name__)
 
 DEPENDENCIES = ['zoneminder']
-DOMAIN = 'zoneminder'
-
-# From ZoneMinder's web/includes/config.php.in
-ZM_STATE_ALARM = "2"
 
 
-def _get_image_url(hass, monitor, mode):
-    zm_data = hass.data[DOMAIN]
-    query = urlencode({
-        'mode': mode,
-        'buffer': monitor['StreamReplayBuffer'],
-        'monitor': monitor['Id'],
-    })
-    url = '{zms_url}?{query}'.format(
-        zms_url=urljoin(zm_data['server_origin'], zm_data['path_zms']),
-        query=query,
-    )
-    _LOGGER.debug('Monitor %s %s URL (without auth): %s',
-                  monitor['Id'], mode, url)
-
-    if not zm_data['username']:
-        return url
-
-    url += '&user={:s}'.format(zm_data['username'])
-
-    if not zm_data['password']:
-        return url
-
-    return url + '&pass={:s}'.format(zm_data['password'])
-
-
-@asyncio.coroutine
-def async_setup_platform(hass, config, async_add_entities,
-                         discovery_info=None):
+def setup_platform(hass, config, add_entities, discovery_info=None):
     """Set up the ZoneMinder cameras."""
-    cameras = []
-    monitors = zoneminder.get_state('api/monitors.json')
+    zm_client = hass.data[ZONEMINDER_DOMAIN]
+
+    monitors = zm_client.get_monitors()
     if not monitors:
         _LOGGER.warning("Could not fetch monitors from ZoneMinder")
         return
 
-    for i in monitors['monitors']:
-        monitor = i['Monitor']
-
-        if monitor['Function'] == 'None':
-            _LOGGER.info("Skipping camera %s", monitor['Id'])
-            continue
-
-        _LOGGER.info("Initializing camera %s", monitor['Id'])
-
-        device_info = {
-            CONF_NAME: monitor['Name'],
-            CONF_MJPEG_URL: _get_image_url(hass, monitor, 'jpeg'),
-            CONF_STILL_IMAGE_URL: _get_image_url(hass, monitor, 'single')
-        }
-        cameras.append(ZoneMinderCamera(hass, device_info, monitor))
-
-    if not cameras:
-        _LOGGER.warning("No active cameras found")
-        return
-
-    async_add_entities(cameras)
+    cameras = []
+    for monitor in monitors:
+        _LOGGER.info("Initializing camera %s", monitor.id)
+        cameras.append(ZoneMinderCamera(hass, monitor))
+    add_entities(cameras)
 
 
 class ZoneMinderCamera(MjpegCamera):
     """Representation of a ZoneMinder Monitor Stream."""
 
-    def __init__(self, hass, device_info, monitor):
+    def __init__(self, hass, monitor):
         """Initialize as a subclass of MjpegCamera."""
+        device_info = {
+            CONF_NAME: monitor.name,
+            CONF_MJPEG_URL: monitor.mjpeg_image_url,
+            CONF_STILL_IMAGE_URL: monitor.still_image_url
+        }
         super().__init__(hass, device_info)
-        self._monitor_id = int(monitor['Id'])
         self._is_recording = None
+        self._monitor = monitor
 
     @property
     def should_poll(self):
@@ -97,17 +53,8 @@ class ZoneMinderCamera(MjpegCamera):
 
     def update(self):
         """Update our recording state from the ZM API."""
-        _LOGGER.debug("Updating camera state for monitor %i", self._monitor_id)
-        status_response = zoneminder.get_state(
-            'api/monitors/alarm/id:%i/command:status.json' % self._monitor_id
-        )
-
-        if not status_response:
-            _LOGGER.warning("Could not get status for monitor %i",
-                            self._monitor_id)
-            return
-
-        self._is_recording = status_response.get('status') == ZM_STATE_ALARM
+        _LOGGER.debug("Updating camera state for monitor %i", self._monitor.id)
+        self._is_recording = self._monitor.is_recording
 
     @property
     def is_recording(self):