Spelling and grammar fixes (#5031)
* Spelling and grammar fixes * Minor changes
This commit is contained in:
Ville Skyttä
Fabian Affolter
parent
f8393f0659
commit
ddbd670547
18 changed files with 55 additions and 54 deletions
|
|
@ -15,22 +15,22 @@ ha_iot_class: "Local Push"
|
|||
|
||||
The Hikvision Binary Sensor is a platform that parses the event stream of a [Hikvision IP Camera or NVR](http://www.hikvision.com/) and presents the camera/nvr events to Home Assistant as binary sensors with either an "off" or "on" state.
|
||||
|
||||
The platform will automatically add all sensors to Home Assistant that are configured within the camera/nvr interface to "Notify the surveillance center" as a trigger. If you would like to hide a sensor type you can do so by either unchecking "Notify the surveillance center" in the camera configuration or by using the "ignored" customize option detailed below.
|
||||
The platform will automatically add all sensors to Home Assistant that are configured within the camera/nvr interface to "Notify the surveillance center" as a trigger. If you would like to hide a sensor type you can do so by either unchecking "Notify the surveillance center" in the camera configuration or by using the "ignored" customize option detailed below.
|
||||
|
||||
<p class='note'>
|
||||
In order for the sensors to work the hikvision user must have the 'Remote: Notify Surveillance Center / Trigger Alarm Output' permission which can be enabled from the user managment section of the web interace. Also the 'WEB Authentication' needs to be set to 'digest/basic' in the security / authentication section.
|
||||
In order for the sensors to work the hikvision user must have the 'Remote: Notify Surveillance Center/Trigger Alarm Output' permission which can be enabled from the user management section of the web interface. Also the 'WEB Authentication' needs to be set to 'digest/basic' in the security/authentication section.
|
||||
</p>
|
||||
|
||||
For example, if you configure a camera with the name "Front Porch" that has motion detection and line crossing events enabled to notify the surveillance center the following binary sensors will be added to Home Assistant:
|
||||
|
||||
```
|
||||
```text
|
||||
binary_sensor.front_porch_motion
|
||||
binary_sensor.front_port_line_crossing
|
||||
```
|
||||
|
||||
When used with a NVR device the sensors will be appended with the channel number they represent. For example, if you configure an NVR with the name "Home" that supports 2 cameras with motion detection and line crossing events enabled to notify the surveillance center the following binary sensors will be added to Home Assistant:
|
||||
When used with a NVR device the sensors will be appended with the channel number they represent. For example, if you configure an NVR with the name "Home" that supports 2 cameras with motion detection and line crossing events enabled to notify the surveillance center the following binary sensors will be added to Home Assistant:
|
||||
|
||||
```
|
||||
```text
|
||||
binary_sensor.home_motion_1
|
||||
binary_sensor.home_motion_2
|
||||
binary_sensor.home_line_crossing_1
|
||||
|
|
@ -38,35 +38,37 @@ binary_sensor.home_line_crossing_2
|
|||
```
|
||||
|
||||
This platform should work with all Hikvision cameras and nvrs, and has been confirmed to work with the following models:
|
||||
|
||||
- DS-2CD3132-I
|
||||
- DS-2CD2232-I5
|
||||
- DS-2CD2032-I
|
||||
- DS-2CD2042WD-I
|
||||
- DS-2CD2142FWD-I
|
||||
|
||||
To enable this sensor, the following lines are required in your `configuration.yaml`:
|
||||
To enable this sensor, the following lines are required in your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
binary_sensor:
|
||||
platform: hikvision
|
||||
host: IP_ADDRESS
|
||||
username: user
|
||||
password: pass
|
||||
- platform: hikvision
|
||||
host: IP_ADDRESS
|
||||
username: user
|
||||
password: pass
|
||||
```
|
||||
|
||||
Configuration options for a Hikvision Sensor:
|
||||
|
||||
- **name** (*Optional*): The name you'd like to give the camera in Home Assistant, defaults to name defined in the camera.
|
||||
- **host** (*Required*): The IP address of the camera you would like to connect to.
|
||||
- **port** (*Optional*): The port to connect to the camera on, defaults to 80.
|
||||
- **ssl** (*Optional*): True if you want to connect with https. Be sure to set the port also.
|
||||
- **username** (*Required*): The username to authenticate with.
|
||||
- **password** (*Required*): The password to authenticate with.
|
||||
- **name** (*Optional*): The name you'd like to give the camera in Home Assistant, defaults to name defined in the camera.
|
||||
- **port** (*Optional*): The port to connect to the camera on, defaults to 80.
|
||||
- **ssl** (*Optional*): True if you want to connect with https. Be sure to set the port also.
|
||||
- **customize** (*Optional*): This attribute contains sensor-specific override values. Only sensor name needs defined:
|
||||
- **ignored** (*Optional*): Ignore this sensor completely. It won't be shown in the Web Interface and no events are generated for it.
|
||||
- **delay** (*Optional*): Specify the delay to wait after a sensor event ends before notifying Home Assistant. This is useful to catch multiple quick trips in one window without the state toggling on and off. The default delay is 5 seconds.
|
||||
|
||||
Supported sensor/event types are:
|
||||
|
||||
- Motion
|
||||
- Line Crossing
|
||||
- Field Detection
|
||||
|
|
@ -84,37 +86,36 @@ Supported sensor/event types are:
|
|||
- Face Detection
|
||||
- Scene Change Detection
|
||||
|
||||
|
||||
Example of a configuration in your `configuration.yaml` that utilizes the customize options for a camera:
|
||||
|
||||
```yaml
|
||||
binary_sensor:
|
||||
platform: hikvision
|
||||
host: 192.168.X.X
|
||||
port: 80
|
||||
ssl: False
|
||||
username: user
|
||||
password: pass
|
||||
customize:
|
||||
motion:
|
||||
delay: 30
|
||||
line_crossing:
|
||||
ignored: True
|
||||
- platform: hikvision
|
||||
host: 192.168.X.X
|
||||
port: 80
|
||||
ssl: False
|
||||
username: user
|
||||
password: pass
|
||||
customize:
|
||||
motion:
|
||||
delay: 30
|
||||
line_crossing:
|
||||
ignored: True
|
||||
```
|
||||
|
||||
Example of a configuration in your `configuration.yaml` that utilizes the customize options for a nvr:
|
||||
|
||||
```yaml
|
||||
binary_sensor:
|
||||
platform: hikvision
|
||||
host: 192.168.X.X
|
||||
port: 80
|
||||
ssl: False
|
||||
username: user
|
||||
password: pass
|
||||
customize:
|
||||
motion_1:
|
||||
delay: 30
|
||||
field_detection_2:
|
||||
ignored: True
|
||||
- platform: hikvision
|
||||
host: 192.168.X.X
|
||||
port: 80
|
||||
ssl: False
|
||||
username: user
|
||||
password: pass
|
||||
customize:
|
||||
motion_1:
|
||||
delay: 30
|
||||
field_detection_2:
|
||||
ignored: True
|
||||
```
|
||||
|
|
|
|||
|
|
@ -31,7 +31,7 @@ Configuration variables:
|
|||
#### Getting the access token ####
|
||||
|
||||
After you have registered your APP on your [My Apps Page](https://foursquare.com/developers/apps) you get a `CLIENT_ID` and you have specified a
|
||||
`REDIRECT_URL` which can be any URL you like, but since it will get your access token via a HTTP GET request, it should be a URL which will ignore the `access_token` HTTP GET variable. A good idea is to choose the URL of your Home Assistant.
|
||||
`REDIRECT_URL` which can be any URL you like, but since it will get your access token via an HTTP GET request, it should be a URL which will ignore the `access_token` HTTP GET variable. A good idea is to choose the URL of your Home Assistant.
|
||||
Visit the following URL in your browser:
|
||||
|
||||
```
|
||||
|
|
@ -40,7 +40,7 @@ https://foursquare.com/oauth2/authenticate?client_id=CLIENT_ID&response_type=tok
|
|||
|
||||
and change the `CLIENT_ID` and `YOUR_REGISTERED_REDIRECT_URL` to your actual values.
|
||||
You will receive an OAuth request landing page, asking you if you want to connect your Foursquare account to your newly created app. Say "Yes".
|
||||
After that, you will get redirected to your `REDIRECT_URL` with the `access_token` as a HTTP GET variable. Copy everything after the = and paste it in your configuration.yaml as the `access_token`.
|
||||
After that, you will get redirected to your `REDIRECT_URL` with the `access_token` as an HTTP GET variable. Copy everything after the = and paste it in your configuration.yaml as the `access_token`.
|
||||
|
||||
### {% linkable_title Real-Time API %}
|
||||
|
||||
|
|
|
|||
|
|
@ -135,7 +135,7 @@ Those will be loaded via `<link rel='import' href='{{ extra_url }}' async>` on a
|
|||
|
||||
### {% linkable_title Manual Language Selection %}
|
||||
|
||||
The browser language is automatically detected. To use a different language, go to **General** in the Configuration panel and select a one from "Choose a Language". It will be applied immediately.
|
||||
The browser language is automatically detected. To use a different language, go to **General** in the Configuration panel and select one from "Choose a Language". It will be applied immediately.
|
||||
|
||||
<p class='img'>
|
||||
<img src='/images/frontend/choose-language.png' />
|
||||
|
|
|
|||
|
|
@ -67,7 +67,7 @@ agent_user_id:
|
|||
required: false
|
||||
type: string
|
||||
api_key:
|
||||
description: An API Key generated for the project from [Google Console](https://console.cloud.google.com/apis/api/homegraph.googleapis.com/overview) which allows you to update devices without unlinking and relinking an account (see step 9 below). If not provided then the `google_assistant.request_sync` service is not exposed. It is recommended to set up this configuration key as it also allows the usage of the following command, "Ok Google, sync my devices". Once you have setup this componenet you will need to call this service (or command) each time you add a new device that you wish to control via the Google Assistant integration.
|
||||
description: An API Key generated for the project from [Google Console](https://console.cloud.google.com/apis/api/homegraph.googleapis.com/overview) which allows you to update devices without unlinking and relinking an account (see step 9 below). If not provided then the `google_assistant.request_sync` service is not exposed. It is recommended to set up this configuration key as it also allows the usage of the following command, "Ok Google, sync my devices". Once you have setup this component you will need to call this service (or command) each time you add a new device that you wish to control via the Google Assistant integration.
|
||||
required: false
|
||||
type: string
|
||||
expose_by_default:
|
||||
|
|
|
|||
|
|
@ -13,7 +13,7 @@ featured: false
|
|||
ha_release: 0.44
|
||||
---
|
||||
|
||||
The `dlib_face_identify` image processing platform allows you to use the [Dlib](http://www.dlib.net/) through Home Assistant. This platform allow you to identify persons on camera and fire a event with identify persons.
|
||||
The `dlib_face_identify` image processing platform allows you to use the [Dlib](http://www.dlib.net/) through Home Assistant. This platform allow you to identify persons on camera and fire an event with identify persons.
|
||||
|
||||
For using the result inside an automation rule, take a look at the [component](/components/image_processing/) page.
|
||||
|
||||
|
|
|
|||
|
|
@ -116,7 +116,7 @@ knx:
|
|||
```
|
||||
|
||||
* **type**: Type of the exposed value. Either time or datetime or any supported type of [KNX Sensor](/components/sensor.knx/) (e.g., "temperature" or "humidity").
|
||||
* **entity_id**: Entity id of the HASS component to be exposed. Not necessarry for types time and datetime.
|
||||
* **entity_id**: Entity id of the HASS component to be exposed. Not necessary for types time and datetime.
|
||||
* **address**: KNX group address.
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -16,7 +16,7 @@ ha_iot_class: "Local Polling"
|
|||
|
||||
The `firetv` platform allows you to control a [Amazon Fire TV/stick](http://www.amazon.com/Amazon-DV83YW-Fire-TV/dp/B00U3FPN4U).
|
||||
|
||||
The python-firetv Python 2.x module with its helper script that exposes a HTTP server to fetch state and perform actions is used.
|
||||
The python-firetv Python 2.x module with its helper script that exposes an HTTP server to fetch state and perform actions is used.
|
||||
|
||||
Steps to configure your Amazon Fire TV stick with Home Assistant:
|
||||
|
||||
|
|
|
|||
|
|
@ -21,7 +21,7 @@ To set the Melissa component up, add the following information to your `configur
|
|||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
melissa:
|
||||
username: <email adress>
|
||||
username: <email address>
|
||||
password: ********
|
||||
```
|
||||
|
||||
|
|
|
|||
|
|
@ -30,7 +30,7 @@ Configuration variables:
|
|||
|
||||
- **name** (*Optional*): Setting the optional parameter `name` allows multiple notifiers to be created. The default value is `notify`. The notifier will bind to the service `notify.NOTIFIER_NAME`.
|
||||
- **app_name** (*Optional*): The application name that will be displayed on every notification and will be registered with the server.
|
||||
- **app_icon** (*Optional*): The icon that will be displayed on every notification. You can provide a HTTP URL or a `file://` URL. File URLs only work if Home Assistant and the GNTP server are running on the same machine. If no `app_icon` is set a local copy of the Home Assistant logo will be used. If you choose to use a HTTP URL please make the maximum image size 150 px by 150 px as Growl for Mac will sometimes timeout when registering.
|
||||
- **app_icon** (*Optional*): The icon that will be displayed on every notification. You can provide an HTTP URL or a `file://` URL. File URLs only work if Home Assistant and the GNTP server are running on the same machine. If no `app_icon` is set a local copy of the Home Assistant logo will be used. If you choose to use an HTTP URL please make the maximum image size 150 px by 150 px as Growl for Mac will sometimes timeout when registering.
|
||||
- **hostname** (*Optional*): The hostname or IP address of the GNTP server to contact.
|
||||
- **password** (*Optional*): The password to authenticate to the GNTP server with.
|
||||
- **port** (*Optional*): The port that the GNTP server runs on. The specification states that servers should not allow users to use any port other than 23053 but `port` is provided here just in case.
|
||||
|
|
|
|||
|
|
@ -151,7 +151,7 @@ sensor:
|
|||
unit_of_measurement: "°C"
|
||||
```
|
||||
|
||||
### {% linkable_title Accessing a HTTP authentication protected endpoint %}
|
||||
### {% linkable_title Accessing an HTTP authentication protected endpoint %}
|
||||
|
||||
The REST sensor supports HTTP authentication and customized headers.
|
||||
|
||||
|
|
|
|||
|
|
@ -41,7 +41,7 @@ Configuration variables:
|
|||
- **password** (*Required*): The password for your Fritz!Box.
|
||||
- **host** (*Optional*): The IP address/hostname of your Fritz!Box. Defaults to `fritz.box`.
|
||||
|
||||
It is recommened to create a dedicated user for Home Assistant and only allow access to "Smart Home".
|
||||
It is recommended to create a dedicated user for Home Assistant and only allow access to "Smart Home".
|
||||
|
||||
<p class='note warning'>
|
||||
If this component throws an error when starting home-assistant you should check if all actors are plugged in and connected to the FritzBox. Inactive actors that are not deleted from FritzBox configuration might lead to errors.
|
||||
|
|
|
|||
|
|
@ -15,7 +15,7 @@ ha_iot_class: "Local Polling"
|
|||
|
||||
The `kankun` switch platform allows you to toggle customized Kankun SP3 Wifi switches. Switches are
|
||||
modified to include the [json.cgi](https://github.com/homedash/kankun-json/blob/master/cgi-bin/json.cgi)
|
||||
script to provide a HTTP API. Details of the necessary modifications can be found
|
||||
script to provide an HTTP API. Details of the necessary modifications can be found
|
||||
[here](http://www.homeautomationforgeeks.com/openhab_http.shtml#kankun) (be sure to install the JSON version
|
||||
of the script as linked above).
|
||||
|
||||
|
|
|
|||
|
|
@ -30,6 +30,6 @@ tellstick:
|
|||
Configuration variables:
|
||||
|
||||
- **signal_repetitions** (*Optional*): Because the tellstick sends its actions via radio and from most receivers it's impossible to know if the signal was received or not. Therefore you can configure the switch and light to try to send each signal repeatedly.
|
||||
- **host** (*Optional*): If you run tellstick on a other server or with a hass.io add-on.
|
||||
- **host** (*Optional*): If you run tellstick on another server or with a hass.io add-on.
|
||||
- **port** (*Optional*): If needed with host config option. Must be port pair, for example `[50800, 50801]`.
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue