-You must have the [ZoneMinder component](/components/zoneminder/) configured to view the camera stream. -
- -## {% linkable_title Configuration %} - -To set it up, add the following information to your `configuration.yaml` file: - -```yaml -# Example configuration.yaml entry -camera: - - platform: zoneminder -``` diff --git a/source/_components/climate.opentherm_gw.markdown b/source/_components/climate.opentherm_gw.markdown deleted file mode 100644 index 1248a657816..00000000000 --- a/source/_components/climate.opentherm_gw.markdown +++ /dev/null @@ -1,25 +0,0 @@ ---- -layout: page -title: "OpenTherm Gateway Climate" -description: "Control your OpenTherm Gateway from Home Assistant." -date: 2018-08-29 16:23 -sidebar: true -comments: false -sharing: true -footer: true -logo: opentherm.png -ha_category: Climate -ha_release: 0.78 -ha_iot_class: "Local Push" ---- - - -The `opentherm_gw` climate platform is used to control the [OpenTherm Gateway](http://otgw.tclcode.com/) from Home Assistant. - -# {% linkable_title Configuration %} - -Configuration of this platform is achieved through the [OpenTherm Gateway Hub](/components/opentherm_gw/) configuration. - --The OpenTherm protocol is based on polling. The thermostat sends requests to the boiler at specific intervals. As a result, it may take some time for changes to propagate between Home Assistant and the thermostat. -
diff --git a/source/_components/device_tracker.asuswrt.markdown b/source/_components/device_tracker.asuswrt.markdown deleted file mode 100644 index a24982b7a6a..00000000000 --- a/source/_components/device_tracker.asuswrt.markdown +++ /dev/null @@ -1,22 +0,0 @@ ---- -layout: page -title: "Asuswrt Device Tracker" -description: "Instructions on how to integrate Asuswrt device tracker into Home Assistant." -date: 2015-08-06 19:00 -sidebar: true -comments: false -sharing: true -footer: true -logo: asus.png -ha_category: Presence Detection -ha_release: pre 0.7 ---- - - -The `asuswrt` platform offers presence detection by looking at connected devices to a [ASUSWRT](http://event.asus.com/2013/nw/ASUSWRT/) based router. - -The platform will be automatically configured if Asuswrt component is configured. - -For more configuration information see the [Asuswrt component](/components/asuswrt/) documentation. - -See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked. \ No newline at end of file diff --git a/source/_components/device_tracker.upc_connect.markdown b/source/_components/device_tracker.upc_connect.markdown index c196d366c52..27f5b941abc 100644 --- a/source/_components/device_tracker.upc_connect.markdown +++ b/source/_components/device_tracker.upc_connect.markdown @@ -13,7 +13,7 @@ ha_release: 0.36 --- -The `upc_connect` platform offers presence detection by looking at connected devices to a [Connect Box](https://www.upc.ch/de/internet/connectbox/) from [Liberty Global](http://www.libertyglobal.com/) (also known as UPC Cablecom in Switzerland) which is a Internet provider in Switzerland and Austria. +The `upc_connect` platform offers presence detection by looking at connected devices to a [Connect Box](https://www.upc.ch/en/internet/learn-about-internet/) from [Liberty Global](https://www.libertyglobal.com) (also known as UPC Cablecom in Switzerland) which is an Internet provider in Switzerland, Austria and the Netherlands (under Ziggo). To use a Connect Box in your installation, add the following to your `configuration.yaml` file: @@ -35,5 +35,6 @@ See the [device tracker component page](/components/device_tracker/) for instruc Also known to be working with the following devices: - Irish Virgin Media Super Hub 3.0 - - Ziggo Connectbox NL - Unitymedia Connect Box (DE) + - Ziggo Connectbox (NL) + diff --git a/source/_components/esphome.markdown b/source/_components/esphome.markdown index bf2bcab37f0..ae995bccbf1 100644 --- a/source/_components/esphome.markdown +++ b/source/_components/esphome.markdown @@ -19,7 +19,7 @@ redirect_from: - /components/switch.esphome/ --- -This component allows you to connect your [ESPHome](https://esphomelib.com/esphomeyaml/index.html) devices directly into Home Assistant with the [native ESPHome API](https://esphomelib.com/esphomeyaml/components/api.html). +This component allows you to connect your [ESPHome](https://esphome.io) devices directly into Home Assistant with the [native ESPHome API](https://esphome.io/components/api.html). ## {% linkable_title Setup the component via the integrations screen %} diff --git a/source/_components/fritzbox.markdown b/source/_components/fritzbox.markdown index a3c5ac12eee..3b0ffb95d5b 100644 --- a/source/_components/fritzbox.markdown +++ b/source/_components/fritzbox.markdown @@ -11,6 +11,7 @@ logo: avm.png ha_category: - Binary Sensor - Climate + - Sensor - Switch ha_release: 0.68 ha_iot_class: "Local Polling" @@ -18,10 +19,18 @@ redirect_from: - /components/binary_sensor.fritzbox/ - /components/switch.fritzbox/ - /components/climate.fritzbox/ + - /components/sensor.fritzbox/ --- The [AVM](https://en.avm.de) Fritzbox component for Home Assistant allows you to integrate the switch and climate devices. +There is currently support for the following device types within Home Assistant: + +- Binary Sensor +- Climate +- [Sensor](#sensor) +- Switch + #### {% linkable_title Tested Devices %} - [FRITZ!Box 6490 Cable](https://en.avm.de/products/fritzbox/fritzbox-6490-cable/) @@ -80,4 +89,19 @@ The are several attributes that can be useful for automations and templates. | `temperature_unit` | The unit of the temperature sensor (only available if the device support temperature sensor). | `temperature` | The current temperature sensor reading (only available if the device supports temperature sensor). | `total_consumption` | The total power consumption since the beginning of operation (only available if the device supports power meter function). -| `total_consumption_unit` | The unit of the total_consumption (only available if the device supports power meter function). \ No newline at end of file +| `total_consumption_unit` | The unit of the total_consumption (only available if the device supports power meter function). + +## {% linkable_title Sensor %} + +To get AVM Fritzbox temperature sensor (e.g. FRITZ!DECT Repeater 100) follow the instructions for the [Fritzbox component](#setup). + +### {% linkable_title Attributes %} + +The are several attributes that can be useful for automations and templates. + +| Attribute | Description | +| --------- | ----------- | +| `device_locked` | The state of the key lock at the device. +| `locked` | The state of the lock for configuring the device via the app or the Fritzbox web interface. +| `temperature_unit` | The unit of the temperature sensor. +| `temperature` | The current temperature sensor reading. \ No newline at end of file diff --git a/source/_components/geofency.md b/source/_components/geofency.md index 7b270b15d2f..5f4a904e42d 100644 --- a/source/_components/geofency.md +++ b/source/_components/geofency.md @@ -17,12 +17,9 @@ This component sets up integration with [Geofency](http://www.geofency.com/). Ge Enabling this component will automatically enable the [Geofency Device Tracker](/components/device_tracker.geofency/). -To integrate Geofency in Home Assistant, add the following section to your `configuration.yaml` file: +To configure Geofency, you must set it up via the integrations panel in the configuration screen. You must then configure the iOS app (via the Webhook feature) to send a POST request to your Home Assistant server at the webhook URL provided by the integration during setup. Use the default POST format. Make sure to enable the 'Update Geo-Position' functionality for mobile beacons. -```yaml -# Example configuration.yaml entry -geofency: -``` +When using mobile beacons (optional) an entry in `configuration.yaml` is still needed as this can't be added via the integrations panel. {% configuration %} mobile_beacons: @@ -31,7 +28,7 @@ mobile_beacons: type: list {% endconfiguration %} -A full sample configuration for the `geofency` component is shown below: +A sample configuration for the `geofency` component when using mobile beacons is shown below: ```yaml # Example configuration.yaml entry @@ -40,5 +37,3 @@ geofency: - car - keys ``` - -To configure Geofency, you must set it up via the integrations panel in the configuration screen. You must then configure the iOS app (via the Webhook feature) to send a POST request to your Home Assistant server at the webhook URL provided by the integration during setup. Use the default POST format. Make sure to enable the 'Update Geo-Position' functionality for mobile beacons. diff --git a/source/_components/homematic.markdown b/source/_components/homematic.markdown index 0c9e6af31ba..cc57415ac40 100644 --- a/source/_components/homematic.markdown +++ b/source/_components/homematic.markdown @@ -410,7 +410,7 @@ When the connection to your HomeMatic CCU or Homegear is lost, Home Assistant wi 1. Create a string variable **V_Last_Reboot** on the CCU - 2. Creata a new programm on the CCU **without any conditions**, which executes the following *HM-Script* with a delay of 30 seconds: + 2. Creata a new programm on the CCU **without any conditions**, which executes the following *HM-Script* with a delay of 30 seconds. The Script needs to be implemented within the section `Activity: Then`. ```javascript var obj = dom.GetObject("V_Last_Reboot"); diff --git a/source/_components/hue.markdown b/source/_components/hue.markdown index 51187522275..7b7849bd423 100644 --- a/source/_components/hue.markdown +++ b/source/_components/hue.markdown @@ -8,16 +8,24 @@ comments: false sharing: true footer: true logo: philips_hue.png -ha_category: Hub +ha_category: + - Hub + - Light ha_iot_class: "Local Polling" ha_qa_scale: platinum featured: true ha_release: "0.60" ha_qa_scale: platinum +redirect_from: + - /components/light.hue/ --- Philips Hue support is integrated into Home Assistant as a Hub that can drive the light platform. The preferred way to setup the Philips Hue platform is by enabling the [discovery component](/components/discovery/). +There is currently support for the following device types within Home Assistant: + +- Light + Once discovered, if you have a custom default view, locate `configurator.philips_hue` in the entities list ( < > ) and add it to a group in `configuration.yaml`. Restart Home Assistant so that the configurator is visible in the Home Assistant dashboard. Once Home Assistant is restarted, locate and click on `configurator.philips_hue` to bring up the initiation dialog. This will prompt you to press the Hue button to register the Hue hub in Home Assistant. Once complete, the configurator entity isn't needed anymore and can be removed from any visible group in `configuration.yaml`. When you configure the Hue bridge from Home Assistant, it writes a token to a file in your Home Assistant [configuration directory](/docs/configuration/). That token authenticates the communication with the Hue bridge. This token uses the Address of the Hue Bridge. If the IP address for the Hue Bridge changes, you will need to register the Hue Bridge with Home Assistant again. To avoid this you may set up DHCP registration for your Hue Bridge, so that it always has the same IP address. @@ -124,7 +132,6 @@ Home Assistant will automatically detect your new `LightGroup` and add it to the More information can be found on the [Philips Hue API documentation](https://www.developers.meethue.com/documentation/groups-api#22_create_group) website. - ### {% linkable_title Using Hue Scenes in Home Assistant %} The Hue platform has its own concept of scenes for setting the colors of a group of lights at once. Hue Scenes are very cheap, get created by all kinds of apps (as it is the only way to have 2 or more lights change at the same time), and are rarely deleted. A typical Hue hub might have hundreds of scenes stored in them, many that you've never used, almost all very poorly named. diff --git a/source/_components/light.hue.markdown b/source/_components/light.hue.markdown deleted file mode 100644 index 59e8b8e970e..00000000000 --- a/source/_components/light.hue.markdown +++ /dev/null @@ -1,20 +0,0 @@ ---- -layout: page -title: "Philips Hue Light" -description: "Instructions on how to integrate Philips Hue lights into Home Assistant." -date: 2015-03-23 20:09 -sidebar: true -comments: false -sharing: true -footer: true -logo: philips_hue.png -ha_category: Light -ha_iot_class: "Local Polling" -ha_release: pre 0.7 ---- - -The Philips Hue light platform allows you to control your Philips Hue lights. - -This component will automatically add `Lights` configured on your Hue bridges. - -The requirement is that you have setup your [Philips Hue bridge](/components/hue/). diff --git a/source/_components/light.mqtt.markdown b/source/_components/light.mqtt.markdown index 98cffe460fb..26104f2eed8 100644 --- a/source/_components/light.mqtt.markdown +++ b/source/_components/light.mqtt.markdown @@ -639,7 +639,7 @@ light: - [MQTT JSON Light](https://github.com/mertenats/Open-Home-Automation/tree/master/ha_mqtt_rgbw_light_with_discovery) is another implementation for ESP8266 including [MQTT discovery](/docs/mqtt/discovery/). -- [esphomelib](https://github.com/OttoWinter/esphomelib) is a library for ESP8266 and ESP32 boards that has many of Home Assistant's MQTT features (like [discovery](/docs/mqtt/discovery/)) pre-implemented and provides high-level abstractions for components such as lights or sensors. +- [ESPHome](https://esphome.io) implements the JSON schema for MQTT based installs and supports [MQTT discovery](/docs/mqtt/discovery/). - [AiLight](https://github.com/stelgenhof/AiLight) is a custom firmware for the Ai-Thinker (and equivalent) RGBW WiFi light bulbs that has an ESP8266 onboard and controlled by the MY9291 LED driver. It implements the [MQTT JSON light](/components/light.mqtt_json/) platform and supports ON/OFF, RGBW colours, brightness, colour temperature, flashing and transitions. Also it includes [MQTT Auto Discovery](/docs/mqtt/discovery/)) and the MQTT Last Will and Testament is enabled as well. diff --git a/source/_components/lupusec.markdown b/source/_components/lupusec.markdown index fbbc273c613..8577f2bffe6 100644 --- a/source/_components/lupusec.markdown +++ b/source/_components/lupusec.markdown @@ -8,9 +8,17 @@ comments: false sharing: true footer: true logo: lupusec.png -ha_category: Hub +ha_category: + - Hub + - Alarm + - Binary Sensor + - Switch ha_release: 0.83 ha_iot_class: "Local Polling" +redirect_from: + - /components/alarm_control_panel.lupusec/ + - /components/binary_sensor.lupusec/ + - /components/switch.lupusec/ --- The `lupusec` component allows the user to integrate their Lupusec alarm control panel and ultimately all connected sensors and other devices. For more information about the LUPUS-Electronics security system please visit their [website](https://www.lupus-electronics.de). @@ -21,9 +29,9 @@ Supported units: The following devices are supported by the underlying `lupupy` Python library and integrated into Home Assistant. -- [Alarm Control Panel](/components/alarm_control_panel.lupusec/): Displays the alarm status and controls arming, disarming and home modus. -- [Binary Sensor](/components/binary_sensor.lupusec/): Displays the status of binary sensors. Currently only Door and window sensors are supported. -- [Switch](/components/switch.lupusec/): Turn off and on your Lupus power switches. +- **Alarm Control Panel**: Displays the alarm status and controls arming, disarming and home modus. +- **Binary Sensor**: Displays the status of binary sensors. Currently only Door and window sensors are supported. +- **Switch**: Turn off and on your Lupus power switches. ## {% linkable_title Configuration %} diff --git a/source/_components/media_player.apple_tv.markdown b/source/_components/media_player.apple_tv.markdown deleted file mode 100644 index 7b163077602..00000000000 --- a/source/_components/media_player.apple_tv.markdown +++ /dev/null @@ -1,16 +0,0 @@ ---- -layout: page -title: "Apple TV Media Player" -description: "Instructions on how to integrate Apple TV devices into Home Assistant." -date: 2017-02-08 07:11 -sidebar: true -comments: false -sharing: true -footer: true -logo: apple.png -ha_category: Media Player -ha_iot_class: "Local Push" -ha_release: 0.38 ---- - -To setup the `apple_tv` media player platform, please follow the instructions on the [Apple TV Component page](/components/apple_tv/). diff --git a/source/_components/notify.html5.markdown b/source/_components/notify.html5.markdown index 50166ea8f02..0f6527b075b 100644 --- a/source/_components/notify.html5.markdown +++ b/source/_components/notify.html5.markdown @@ -99,9 +99,11 @@ Assuming you have already added the platform to your configuration: 1. Open Home Assistant in Chrome or Firefox. 2. Load profile page by clicking on the badge next to the Home Assistant title in the sidebar. Assuming you have met all the [requirements](#requirements) above then you should see a new slider for Push Notifications. If the slider is greyed out, ensure you are viewing Home Assistant via its external HTTPS address. If the slider is not visible, ensure you are not in the user configuration (Sidebar, Configuration, Users, View User). 3. Slide it to the on position. -4. Within a few seconds you should be prompted to allow notifications from Home Assistant. -5. Assuming you accept, that's all there is to it! -6. (Optional, but highly recommended!) Open the `html5_push_registrations.conf` file in your configuration directory. You will see a new entry for the browser you just added. Rename it from `unnamed device` to a name of your choice, which will make it easier to identify later. _Do not change anything else in this file!_ You need to restart Home Assistant after making any changes to the file. +4. Name the device you're using in the alert that appears. +5. Within a few seconds you should be prompted to allow notifications from Home Assistant. +6. Assuming you accept, that's all there is to it! + +**Note:** If you aren't prompted for a device name when enabling notifications, open the `html5_push_registrations.conf` file in your configuration directory. You will see a new entry for the browser you just added. Rename it from `unnamed device` to a name of your choice, which will make it easier to identify later. _Do not change anything else in this file!_ You need to restart Home Assistant after making any changes to the file. ### {% linkable_title Testing %} diff --git a/source/_components/opentherm_gw.markdown b/source/_components/opentherm_gw.markdown index 937062df83f..be8ff5d7d2e 100644 --- a/source/_components/opentherm_gw.markdown +++ b/source/_components/opentherm_gw.markdown @@ -8,14 +8,33 @@ comments: false sharing: true footer: true logo: opentherm.png -ha_category: Hub +ha_category: + - Hub + - Binary Sensor + - Climate + - Sensor ha_release: 0.81 ha_iot_class: "Local Push" +redirect_from: + - /components/binary_sensor.opentherm_gw/ + - /components/climate.opentherm_gw/ + - /components/sensor.opentherm_gw/ --- The `opentherm_gw` component is used to control the [OpenTherm Gateway](http://otgw.tclcode.com/) from Home Assistant. + +There is currently support for the following device types within Home Assistant: + +- Binary Sensor +- Climate +- Sensor + When enabled, this component will automatically add its [`climate` entity](/components/climate.opentherm_gw) to Home Assistant. ++The OpenTherm protocol is based on polling. The thermostat sends requests to the boiler at specific intervals. As a result, it may take some time for changes to propagate between Home Assistant and the thermostat. +
+ # {% linkable_title Configuration %} ```yaml @@ -253,6 +272,7 @@ monitored_variables: {% endconfiguration %} ## {% linkable_title Supported Variables %} + The list above contains all supported variables. Note that not all boilers and thermostats properly support all variables, so the fact that a variable is listed here and published by your system does not necessarily mean that you will get useful data out of it. To see which variables are published in your situation, enable debug logging for the `opentherm_gw` component and look for the status updates. # {% linkable_title Services %} @@ -346,12 +366,13 @@ The value you provide here will be used with the GPIO `home` (5) and `away` (6) | ---------------------- | -------- | ----------- | | `temperature` | no | The setback temperature. Accepted values are `0.0` through `30.0`. - ## {% linkable_title GPIO modes %} + Possible modes and their meaning for the GPIO pins are listed here: {% comment %} Bulletpoints and numbers to match the LED mode layout below. {% endcomment %} + * 1\. No function, default for both ports on a freshly flashed chip. * 2\. Ground - A permanently low output (0V). Could be used for a power LED. * 3\. Vcc - A permanently high output (5V). Can be used as a short-proof power supply for some external circuitry used by the other GPIO port. @@ -361,9 +382,10 @@ Possible modes and their meaning for the GPIO pins are listed here: * 7\. Away - Set thermostat to setback temperature when pulled high. * 8\. DS1820 (GPIO port B only) - Data line for a DS18S20 or DS18B20 temperature sensor used to measure the outside temperature. A 4k7 resistor should be connected between GPIO port B and Vcc. - ## {% linkable_title LED modes %} + Possible LED modes and their meaning are listed here: + * R. Receiving an Opentherm message from the thermostat or boiler. * X. Transmitting an Opentherm message to the thermostat or boiler. * T. Transmitting or receiving a message on the thermostat interface. diff --git a/source/_components/openuv.markdown b/source/_components/openuv.markdown index 9d1516f48d7..442315a407f 100644 --- a/source/_components/openuv.markdown +++ b/source/_components/openuv.markdown @@ -35,6 +35,23 @@ component does not automatically query the API for new data after it initially loads. To request new data, the `update_data` service may be used. ++Each use of the `update_data` service will consume 1 or 2 API calls, depending +on which monitored conditions are configured. + +If the OpenUV component is configured through the Home Assistant UI (via the +`Configuration >> Integrations` panel), each service call will consume 2 API +calls from the daily quota. + +If the OpenUV component is configured via `configuration.yaml`, service calls +will consume 2 API calls if `monitored_conditions` contains both +`uv_protection_window` and any other condition; any other scenarios will only +consume 1 API call. + +Ensure that you understand these specifications when calling the `update_data` +service. +
+ ## {% linkable_title Configuration %} To retrieve data from OpenUV, add the following to your `configuration.yaml` diff --git a/source/_components/remote.apple_tv.markdown b/source/_components/remote.apple_tv.markdown deleted file mode 100644 index 7fe3bc7f9af..00000000000 --- a/source/_components/remote.apple_tv.markdown +++ /dev/null @@ -1,40 +0,0 @@ ---- -layout: page -title: "Apple TV Remote" -description: "Instructions on how to integrate Apple TV remote into Home Assistant." -date: 2017-06-26 20:50 -sidebar: true -comments: false -sharing: true -footer: true -logo: apple.png -ha_category: Remote -ha_iot_class: "Local Push" -ha_release: 0.49 ---- - - -The `apple_tv` remote platform allows you to send remote control buttons to an Apple TV. It is automatically setup when an Apple TV is configured, please see [Apple TV Component](/components/apple_tv/) for configuration details. - -At the moment, the following buttons are supported: - -- up -- down -- left -- right -- menu -- top_menu -- select - -A typical service call for press several buttons looks like this. - -```yaml -service: remote.send_command -data: - entity_id: remote.apple_tv - command: - - left - - left - - menu - - select -``` diff --git a/source/_components/ring.markdown b/source/_components/ring.markdown index e600e3e140a..f0c3e3ec0d8 100644 --- a/source/_components/ring.markdown +++ b/source/_components/ring.markdown @@ -8,12 +8,27 @@ comments: false sharing: true footer: true logo: ring.png -ha_category: Doorbell +ha_category: + - Doorbell + - Binary Sensor + - Camera + - Sensor ha_release: 0.42 +ha_iot_class: "Cloud Polling" +redirect_from: + - /components/binary_sensor.ring/ + - /components/camera.ring/ + - /components/sensor.ring/ --- The `ring` implementation allows you to integrate your [Ring.com](https://ring.com/) devices in Home Assistant. +There is currently support for the following device types within Home Assistant: + +- [Binary Sensor](#binary-sensor) +- [Camera](#camera) - downloading and playing Ring video will require a Ring Protect plan. +- [Sensor](#sensor) + Currently only doorbells are supported by this sensor. ## {% linkable_title Configuration %} @@ -38,4 +53,136 @@ password: type: string {% endconfiguration %} -Finish its configuration by visiting the [Ring binary sensor](/components/binary_sensor.ring/) or [Ring sensor](/components/sensor.ring/) documentation. +## {% linkable_title Binary Sensor %} + +Once you have enabled the [Ring component](/components/ring), you can start using a binary sensor. Add the following to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +binary_sensor: + - platform: ring +``` + +{% configuration %} +monitored_conditions: + description: Conditions to display in the frontend. The following conditions can be monitored. If not specified, all conditions below will be enabled. + required: false + type: list + keys: + ding: + description: Return a boolean value when the doorbell button was pressed. + motion: + description: Return a boolean value when a movement was detected by the Ring doorbell. +{% endconfiguration %} + +Currently it supports doorbell, external chimes and stickup cameras. + +## {% linkable_title Camera %} + ++Please note that downloading and playing Ring video will require a Ring Protect plan. +
+
+Once you have enabled the [Ring component](/components/ring), you can start using the camera platform. Add the following to your `configuration.yaml` file:
+
+```yaml
+# Example configuration.yaml entry
+camera:
+ - platform: ring
+```
+
+{% configuration %}
+ffmpeg_arguments:
+ description: Extra options to pass to ffmpeg, e.g., image quality or video filter options.
+ required: false
+ type: string
+scan_interval:
+ description: How frequently to query for new video in seconds.
+ required: false
+ type: integer
+ default: 90
+{% endconfiguration %}
+
+**Note:** To be able to playback the last capture, it is required to install the `ffmpeg` component. Make sure to follow the steps mentioned at [FFMPEG](/components/ffmpeg/) documentation.
+
+Currently it supports doorbell and stickup cameras.
+
+## {% linkable_title Saving the videos captured by your Ring Door Bell %}
+
+You can save locally the latest video captured by your Ring Door Bell using the [downloader](/components/downloader) along with either an [automation](/components/automation) or [python_script](/components/python_script). First, enable the [downloader](/components/downloader) component in your configuration by adding the following to your `configuration.yaml`.
+
+```yaml
+downloader:
+ download_dir: downloads
+```
+
+Then you can use the following `action` in your automation (this will save the video file under `
-The OpenTherm protocol is based on polling. The thermostat sends requests to the boiler at specific intervals. As a result, it may take some time for changes to propagate between Home Assistant and the thermostat.
-
-You must have the [ZoneMinder component](/components/zoneminder/) configured to use this sensor.
-
-In previous versions, switch devices in setups with multiple cameras, would not have specific entity ID causing them to change randomly after each Home Assistant restart. The current version adds the name of the camera at the end of the switch entity ID, making it more specific and consistent and causes the name option to be required in a multi-camera system. This behavior matches the sensor behavior of the Amcrest component. Because of this, older automations may require updates to the entity ID.
-
-You must have the [ZoneMinder component](/components/zoneminder/) configured to use this and if ZoneMinder authentication is enabled the account specified in the component configuration must have "Edit" permission for "System".
-
-The default functions installed by ZoneMinder are: None, Monitor, Modect, Record, Mocord, Nodect.
-
+You must have the [ZoneMinder component](/components/zoneminder/) configured to use this and if ZoneMinder authentication is enabled the account specified in the component configuration must have "Edit" permission for "System".
+
+The default functions installed by ZoneMinder are: None, Monitor, Modect, Record, Mocord, Nodect.
+
+```text
+2019-02-14 16:20:35 ERROR (MainThread) [homeassistant.loader] Unable to find component system_healt
+2019-02-14 16:20:36 ERROR (MainThread) [homeassistant.components.device_tracker] Error setting up platform google_maps
+Traceback (most recent call last):
+ File "/home/fab/Documents/repos/ha/home-assistant/homeassistant/components/device_tracker/__init__.py", line 184, in
+[...]
+```
-The message ("Unable to find service..."), source (`core.py`) and level (`WARNING`) can easily be extracted from the image. The exact timestamp and stack trace is shown in the selected entry.
+The message ("Unable to find component system_healt"), source (`homeassistant.loader`) and level (`ERROR`) can easily be extracted from the log. The exact timestamp and if there is a stack trace that's shown as well. Here is another error caused by the `google_map` integration with additional output present.
## {% linkable_title Examples %}
@@ -91,6 +97,7 @@ automation:
This automation will create a persistent notification whenever an error or warning is logged that has the word "service" in the message:
+{% raw %}
```yaml
automation:
- alias: Create notifications for "service" errors
@@ -99,10 +106,11 @@ automation:
event_type: system_log_event
condition:
condition: template
- value_template: {% raw %}'{{ "service" in trigger.event.data.message }}'{% endraw %}
+ value_template: '{{ "service" in trigger.event.data.message }}'
action:
service: persistent_notification.create
data_template:
title: Something bad happened
- message: {% raw %}'{{ trigger.event.data.message }}'{% endraw %}
+ message: '{{ trigger.event.data.message }}'
```
+{% endraw %}
diff --git a/source/_components/zoneminder.markdown b/source/_components/zoneminder.markdown
index 950870f0e9f..8c25922db65 100644
--- a/source/_components/zoneminder.markdown
+++ b/source/_components/zoneminder.markdown
@@ -8,13 +8,30 @@ comments: false
sharing: true
footer: true
logo: zoneminder.png
-ha_category: Hub
+ha_category:
+ - Hub
+ - Binary Sensor
+ - Camera
+ - Sensor
+ - Switch
featured: false
ha_release: 0.31
ha_iot_class: "Local Polling"
+redirect_from:
+ - /components/binary_sensor.zoneminder/
+ - /components/camera.zoneminder/
+ - /components/sensor.zoneminder/
+ - /components/switch.zoneminder/
---
-The ZoneMinder component sets up the integration with your [ZoneMinder](https://www.zoneminder.com) instance so that [cameras](/components/camera.zoneminder/), [sensors](/components/sensor.zoneminder/), and [switches](/components/switch.zoneminder) can use it. Configuring this component will automatically load the [binary_sensor](/components/binary_sensor.zoneminder) which tracks ZoneMinder availability.
+The ZoneMinder component sets up the integration with your [ZoneMinder](https://www.zoneminder.com) instance.
+
+There is currently support for the following device types within Home Assistant:
+
+- [Binary Sensor](#binary-sensor)
+- [Camera](#camera)
+- [Sensor](#sensor)
+- [Switch](#switch)
## {% linkable_title Configuration %}
@@ -91,3 +108,92 @@ action:
id: ZM_HOST
name: Home
```
+
+## {% linkable_title Binary Sensor %}
+
+The `zoneminder` binary sensor platform lets you monitor the availability of your [ZoneMinder](https://www.zoneminder.com) install.
+
+Each binary_sensor created will be named after the hostname used when configuring the [ZoneMinder component](/components/zoneminder/).
+
+## {% linkable_title Camera %}
+
+The `zoneminder` camera platform lets you monitor the current stream of your [ZoneMinder](https://www.zoneminder.com) cameras.
+
+## {% linkable_title Configuration %}
+
+To set it up, add the following information to your `configuration.yaml` file:
+
+```yaml
+# Example configuration.yaml entry
+camera:
+ - platform: zoneminder
+```
+
+## {% linkable_title Sensor %}
+
+The `zoneminder` sensor platform lets you monitor the current state of your [ZoneMinder](https://www.zoneminder.com) install including the number of events, the current state of the cameras and ZoneMinder's current run state.
+
+To set it up, add the following information to your `configuration.yaml` file:
+
+```yaml
+# Example configuration.yaml entry
+sensor:
+ - platform: zoneminder
+ include_archived: false
+```
+
+{% configuration %}
+include_archived:
+ description: Whether to include archived ZoneMinder events in event counts.
+ required: false
+ default: false
+ type: boolean
+monitored_conditions:
+ description: Event count sensors to display in the frontend.
+ required: false
+ type: list
+ keys:
+ all:
+ description: All events.
+ month:
+ description: Events in the last month.
+ week:
+ description: Events in the last week.
+ day:
+ description: Events in the last day.
+ hour:
+ description: Events in the last hour.
+{% endconfiguration %}
+
+## {% linkable_title Switch %}
+
+The `zoneminder` switch platform allows you to toggle the current function of all cameras attached to your [ZoneMinder](https://www.zoneminder.com) instance.
+
+