Merge branch 'main' of github.com:rroller/dahua into main

Author: rroller

README.md

@@ -1,8 +1,48 @@
 
-# Dahua
+# Home Assistant Dahua Integration
+The `Dahua` integration allows you to integrate your [Dahua](https://www.dahuasecurity.com/) cameras in Home Assistant.
 
+## Installation
 
+### Manual install
+To manually install:
 
+```bash
+# Download a copy of this repository
+$ wget https://github.com/rroller/dahua/archive/main.zip
+
+# Unzip the archive
+$ unzip main.zip
+
+# Move the dahua directory into your custom_components directory in your Home Assistant install
+$ mv dahua/custom_components/dahua <home-assistant-install-directory>/config/custom_components/
+```
+
+### HACS install
+To install with [HACS](https://hacs.xyz/):
+
+1. Click on HACS in the Home Assistant menu
+2. Click on `Integrations`
+3. Click the top right menu (the three dots)
+4. Select `Custom repositories`
+5. Paste the repository URL (`https://github.com/rroller/dahua`) in the dialog box
+6. Select category `Integration`
+7. Click `Add`
+8. Click `Install`
+9. Add integration?
+
+> :warning: **After executing one of the above installation methods, restart Home Assistant. Also clear your browser cache before proceeding to the next step, as the integration may not be visible otherwise.**
+
+
+# Known supported cameras
+This integration should word with most Dahua cameras. It has been tested with very old and very new Dahua cameras.
+The following are confirmed to work:
+
+* xxx
+* yyy
+* IPC-HDlkjsdf
+
+# Services and Entities
 ## Services
 ```
 camera.enable_motion_detection
@@ -14,6 +54,14 @@ dahua.set_infrared_mode
     brightness: 100 # 0 - 100 inclusive
 ````
 
+## Camera
+
+## Switches
+
+## Lights
+
+## Binary Sensors
+
 # Local development
 If you wish to work on this component, the easiest way is to follow [HACS Dev Container README](https://github.com/custom-components/integration_blueprint/blob/master/.devcontainer/README.md). In short:
 

custom_components/dahua/client.py

@@ -15,7 +15,6 @@
 _LOGGER: logging.Logger = logging.getLogger(__package__)
 
 HEADERS = {"Content-type": "application/json; charset=UTF-8"}
-WHITE_LIGHT_TYPE = 1
 SECURITY_LIGHT_TYPE = 1
 SIREN_TYPE = 2
 

custom_components/dahua/light.py

@@ -153,7 +153,10 @@ async def async_turn_off(self, **kwargs):
 
 
 class DahuaSecurityLight(DahuaBaseEntity, LightEntity):
-    """Representation of a Dahua light (for cameras that have them). This is the red/blue flashing lights"""
+    """
+    Representation of a Dahua light (for cameras that have them). This is the red/blue flashing lights.
+    The camera will only keep this light on for a few seconds before it automatically turns off.
+    """
 
     def __init__(self, coordinator: DahuaDataUpdateCoordinator, entry, name):
         super().__init__(coordinator, entry)

custom_components/dahua/switch.py

@@ -12,10 +12,8 @@ async def async_setup_entry(hass: HomeAssistant, entry, async_add_devices):
     """Setup sensor platform."""
     coordinator: DahuaDataUpdateCoordinator = hass.data[DOMAIN][entry.entry_id]
 
-    devices = []
-
     # I think most cameras have a motion sensor so we'll blindly add a switch for it
-    devices.append(DahuaMotionDetectionBinarySwitch(coordinator, entry))
+    devices = [DahuaMotionDetectionBinarySwitch(coordinator, entry)]
 
     # But only some cams have a siren, very few do actually
     if coordinator.supports_siren():
@@ -68,7 +66,7 @@ class DahuaSirenBinarySwitch(DahuaBaseEntity, SwitchEntity):
     """dahua siren switch class. Used to enable or disable camera built in sirens"""
 
     async def async_turn_on(self, **kwargs):  # pylint: disable=unused-argument
-        """Turn on/enable the camrea siren"""
+        """Turn on/enable the camera's siren"""
         await self.coordinator.client.async_set_coaxial_control_state(SIREN_TYPE, True)
         await self.coordinator.async_refresh()