Skip to content

Commit ddbd670

Browse files
scopfabaff
authored andcommitted
Spelling and grammar fixes (home-assistant#5031)
* Spelling and grammar fixes * Minor changes
1 parent f8393f0 commit ddbd670

18 files changed

+55
-54
lines changed

source/_addons/nginx_proxy.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ footer: true
1111

1212
Setup an SSL proxy with NGINX and redirect port 80 to 443. Make sure you have generated a certificate before you start this add-on.
1313

14-
In the `http` section of the `configuration.yaml` file remove `ssl_certificate` and `ssl_key` and don't enter the port in the `base_url` to avoid a HTTP 502 error.
14+
In the `http` section of the `configuration.yaml` file remove `ssl_certificate` and `ssl_key` and don't enter the port in the `base_url` to avoid an HTTP 502 error.
1515

1616
```json
1717
{

source/_addons/samba.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Configuration variables:
3535
- **name** (*Optional*): Set netbios name of Hass.io device. Default is `hassio`.
3636
- **workgroup** (*Optional*): Set network workgroup name. Default is `WORKGROUP`.
3737
- **guest** (*Optional*): Allow login without a username or password. Default is `true`.
38-
- **map** (*Optional*): Control which folders will be exposed. `config` shares the Home Assistant configuration folder. `addons` shares the local custom repositiory. `share` shares a folder that can be accessed by add-ons and Home Assistant. `backup` shares access to snapshot files. `ssl` shares certificate storage. Be careful with the `ssl` option! Defaults are all set to `true`, except for `ssl`.
38+
- **map** (*Optional*): Control which folders will be exposed. `config` shares the Home Assistant configuration folder. `addons` shares the local custom repository. `share` shares a folder that can be accessed by add-ons and Home Assistant. `backup` shares access to snapshot files. `ssl` shares certificate storage. Be careful with the `ssl` option! Defaults are all set to `true`, except for `ssl`.
3939
- **username** (*Optional*): Username for logging in if guest login is not used.
4040
- **password** (*Optional*): Password for `username`. An empty password is not supported.
4141
- **interface** (*Optional*): Interface that will start the share. Normally this is `eth0` for ethernet wired connection and `wlan0` for wireless connection.

source/_components/binary_sensor.hikvision.markdown

Lines changed: 37 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -15,58 +15,60 @@ ha_iot_class: "Local Push"
1515

1616
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.
1717

18-
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.
18+
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.
1919

2020
<p class='note'>
21-
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.
21+
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.
2222
</p>
2323

2424
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:
2525

26-
```
26+
```text
2727
binary_sensor.front_porch_motion
2828
binary_sensor.front_port_line_crossing
2929
```
3030

31-
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:
31+
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:
3232

33-
```
33+
```text
3434
binary_sensor.home_motion_1
3535
binary_sensor.home_motion_2
3636
binary_sensor.home_line_crossing_1
3737
binary_sensor.home_line_crossing_2
3838
```
3939

4040
This platform should work with all Hikvision cameras and nvrs, and has been confirmed to work with the following models:
41+
4142
- DS-2CD3132-I
4243
- DS-2CD2232-I5
4344
- DS-2CD2032-I
4445
- DS-2CD2042WD-I
4546
- DS-2CD2142FWD-I
4647

47-
To enable this sensor, the following lines are required in your `configuration.yaml`:
48+
To enable this sensor, the following lines are required in your `configuration.yaml` file:
4849

4950
```yaml
5051
binary_sensor:
51-
platform: hikvision
52-
host: IP_ADDRESS
53-
username: user
54-
password: pass
52+
- platform: hikvision
53+
host: IP_ADDRESS
54+
username: user
55+
password: pass
5556
```
5657
5758
Configuration options for a Hikvision Sensor:
5859
59-
- **name** (*Optional*): The name you'd like to give the camera in Home Assistant, defaults to name defined in the camera.
6060
- **host** (*Required*): The IP address of the camera you would like to connect to.
61-
- **port** (*Optional*): The port to connect to the camera on, defaults to 80.
62-
- **ssl** (*Optional*): True if you want to connect with https. Be sure to set the port also.
6361
- **username** (*Required*): The username to authenticate with.
6462
- **password** (*Required*): The password to authenticate with.
63+
- **name** (*Optional*): The name you'd like to give the camera in Home Assistant, defaults to name defined in the camera.
64+
- **port** (*Optional*): The port to connect to the camera on, defaults to 80.
65+
- **ssl** (*Optional*): True if you want to connect with https. Be sure to set the port also.
6566
- **customize** (*Optional*): This attribute contains sensor-specific override values. Only sensor name needs defined:
6667
- **ignored** (*Optional*): Ignore this sensor completely. It won't be shown in the Web Interface and no events are generated for it.
6768
- **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.
6869
6970
Supported sensor/event types are:
71+
7072
- Motion
7173
- Line Crossing
7274
- Field Detection
@@ -84,37 +86,36 @@ Supported sensor/event types are:
8486
- Face Detection
8587
- Scene Change Detection
8688
87-
8889
Example of a configuration in your `configuration.yaml` that utilizes the customize options for a camera:
8990

9091
```yaml
9192
binary_sensor:
92-
platform: hikvision
93-
host: 192.168.X.X
94-
port: 80
95-
ssl: False
96-
username: user
97-
password: pass
98-
customize:
99-
motion:
100-
delay: 30
101-
line_crossing:
102-
ignored: True
93+
- platform: hikvision
94+
host: 192.168.X.X
95+
port: 80
96+
ssl: False
97+
username: user
98+
password: pass
99+
customize:
100+
motion:
101+
delay: 30
102+
line_crossing:
103+
ignored: True
103104
```
104105

105106
Example of a configuration in your `configuration.yaml` that utilizes the customize options for a nvr:
106107

107108
```yaml
108109
binary_sensor:
109-
platform: hikvision
110-
host: 192.168.X.X
111-
port: 80
112-
ssl: False
113-
username: user
114-
password: pass
115-
customize:
116-
motion_1:
117-
delay: 30
118-
field_detection_2:
119-
ignored: True
110+
- platform: hikvision
111+
host: 192.168.X.X
112+
port: 80
113+
ssl: False
114+
username: user
115+
password: pass
116+
customize:
117+
motion_1:
118+
delay: 30
119+
field_detection_2:
120+
ignored: True
120121
```

source/_components/foursquare.markdown

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Configuration variables:
3131
#### Getting the access token ####
3232
3333
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
34-
`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.
34+
`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.
3535
Visit the following URL in your browser:
3636

3737
```
@@ -40,7 +40,7 @@ https://foursquare.com/oauth2/authenticate?client_id=CLIENT_ID&response_type=tok
4040

4141
and change the `CLIENT_ID` and `YOUR_REGISTERED_REDIRECT_URL` to your actual values.
4242
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".
43-
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`.
43+
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`.
4444

4545
### {% linkable_title Real-Time API %}
4646

source/_components/frontend.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ Those will be loaded via `<link rel='import' href='{{ extra_url }}' async>` on a
135135

136136
### {% linkable_title Manual Language Selection %}
137137

138-
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.
138+
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.
139139

140140
<p class='img'>
141141
<img src='/images/frontend/choose-language.png' />

source/_components/google_assistant.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ agent_user_id:
6767
required: false
6868
type: string
6969
api_key:
70-
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.
70+
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.
7171
required: false
7272
type: string
7373
expose_by_default:

source/_components/image_processing.dlib_face_identify.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ featured: false
1313
ha_release: 0.44
1414
---
1515

16-
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.
16+
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.
1717

1818
For using the result inside an automation rule, take a look at the [component](/components/image_processing/) page.
1919

source/_components/knx.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ knx:
116116
```
117117

118118
* **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").
119-
* **entity_id**: Entity id of the HASS component to be exposed. Not necessarry for types time and datetime.
119+
* **entity_id**: Entity id of the HASS component to be exposed. Not necessary for types time and datetime.
120120
* **address**: KNX group address.
121121

122122

source/_components/media_player.firetv.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ ha_iot_class: "Local Polling"
1616

1717
The `firetv` platform allows you to control a [Amazon Fire TV/stick](http://www.amazon.com/Amazon-DV83YW-Fire-TV/dp/B00U3FPN4U).
1818

19-
The python-firetv Python 2.x module with its helper script that exposes a HTTP server to fetch state and perform actions is used.
19+
The python-firetv Python 2.x module with its helper script that exposes an HTTP server to fetch state and perform actions is used.
2020

2121
Steps to configure your Amazon Fire TV stick with Home Assistant:
2222

source/_components/melissa.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ To set the Melissa component up, add the following information to your `configur
2121
```yaml
2222
# Example configuration.yaml entry
2323
melissa:
24-
username: <email adress>
24+
username: <email address>
2525
password: ********
2626
```
2727

source/_components/notify.gntp.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Configuration variables:
3030

3131
- **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`.
3232
- **app_name** (*Optional*): The application name that will be displayed on every notification and will be registered with the server.
33-
- **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.
33+
- **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.
3434
- **hostname** (*Optional*): The hostname or IP address of the GNTP server to contact.
3535
- **password** (*Optional*): The password to authenticate to the GNTP server with.
3636
- **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.

source/_components/sensor.rest.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ sensor:
151151
unit_of_measurement: "°C"
152152
```
153153

154-
### {% linkable_title Accessing a HTTP authentication protected endpoint %}
154+
### {% linkable_title Accessing an HTTP authentication protected endpoint %}
155155

156156
The REST sensor supports HTTP authentication and customized headers.
157157

source/_components/switch.fritzdect.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ Configuration variables:
4141
- **password** (*Required*): The password for your Fritz!Box.
4242
- **host** (*Optional*): The IP address/hostname of your Fritz!Box. Defaults to `fritz.box`.
4343

44-
It is recommened to create a dedicated user for Home Assistant and only allow access to "Smart Home".
44+
It is recommended to create a dedicated user for Home Assistant and only allow access to "Smart Home".
4545

4646
<p class='note warning'>
4747
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.

source/_components/switch.kankun.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ ha_iot_class: "Local Polling"
1515

1616
The `kankun` switch platform allows you to toggle customized Kankun SP3 Wifi switches. Switches are
1717
modified to include the [json.cgi](https://github.com/homedash/kankun-json/blob/master/cgi-bin/json.cgi)
18-
script to provide a HTTP API. Details of the necessary modifications can be found
18+
script to provide an HTTP API. Details of the necessary modifications can be found
1919
[here](http://www.homeautomationforgeeks.com/openhab_http.shtml#kankun) (be sure to install the JSON version
2020
of the script as linked above).
2121

source/_components/tellstick.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,6 @@ tellstick:
3030
Configuration variables:
3131
3232
- **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.
33-
- **host** (*Optional*): If you run tellstick on a other server or with a hass.io add-on.
33+
- **host** (*Optional*): If you run tellstick on another server or with a hass.io add-on.
3434
- **port** (*Optional*): If needed with host config option. Must be port pair, for example `[50800, 50801]`.
3535

source/_cookbook/custom_panel_using_react.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ This is a [React](https://facebook.github.io/react/) implementation of [TodoMVC]
2020

2121
Download the source [here](https://github.com/home-assistant/example-custom-config/blob/master/panels/react.html). Copy the file to `<config dir>/panels/` (you might have to create the directory if it doesn't exist).
2222

23-
Create a entry for the panel in your `configuration.yaml` file to enable it.
23+
Create an entry for the panel in your `configuration.yaml` file to enable it.
2424

2525
```yaml
2626
panel_custom:

source/_docs/installation/docker.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ If you want to use a USB Bluetooth adapter or Z-Wave USB Stick with Home Assista
8080

8181
### {% linkable_title QNAP NAS %}
8282

83-
As QNAP within QTS now supports Docker (with a neat UI), you can simply install Home Assistant using docker without the need for command-line. For details about the package (including compatability-information, if your NAS is supported), see https://www.qnap.com/solution/container_station/en/index.php
83+
As QNAP within QTS now supports Docker (with a neat UI), you can simply install Home Assistant using docker without the need for command-line. For details about the package (including compatibility-information, if your NAS is supported), see https://www.qnap.com/solution/container_station/en/index.php
8484

8585
The steps would be:
8686

source/_posts/2018-03-24-new-release-schedule.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ So this weekend we're going to shake things a little up. Instead of releasing a
2121
Diagram of the new release schedule
2222
</p>
2323

24-
The goal is to create a more stable first release without the need for a quick follow up hot fix. So if you want to be able to access the new features faster but don't mind the risk of running into the occassional bug, get yourself on the beta channel today:
24+
The goal is to create a more stable first release without the need for a quick follow up hot fix. So if you want to be able to access the new features faster but don't mind the risk of running into the occasional bug, get yourself on the beta channel today:
2525

2626
- Hass.io users will be able to enable the dev channel in the system settings.
2727
- For Docker users, the beta's will be published under the `rc` tag.

0 commit comments

Comments
 (0)