Review/Edit components starting with the letter A (home-assistant#3220)

frenck · fabaff · commit 19738675e810 · 2017-08-25T13:07:42.000+02:00
diff --git a/source/_components/alarm_control_panel.alarmdotcom.markdown b/source/_components/alarm_control_panel.alarmdotcom.markdown
@@ -12,7 +12,7 @@ ha_category: Alarm
 ha_release: 0.11
 ---
 
-The `alarmdotcom` platform is consuming the information provided by a [Alarm.com](https://www.alarm.com/).
+The `alarmdotcom` platform is consuming the information provided by [Alarm.com](https://www.alarm.com/).
 
 To enable this, add the following lines to your `configuration.yaml`:
 
diff --git a/source/_components/alarm_control_panel.egardia.markdown b/source/_components/alarm_control_panel.egardia.markdown
@@ -39,11 +39,11 @@ Configuration variables:
 - **report_server_codes** list (*Optional*): List of codes for the different states.
 
 Note that this basic configuration will only enable you to read the armed/armed away/disarmed status of your alarm and will **not** update the status if the alarm is triggered. This is because of how Egardia built their system. The alarm triggers normally go through their servers.
-You can change this however, using the following procedure. This is an more advanced configuration.
+You can change this, however, using the following procedure. This is a more advanced configuration.
 
-1. Login into your alarm system's control panel. You will need to access http://[ip of your control panel]. You know this already, since you need it in the basic configuration from above. Login to the control panel with your Egardia/Woonveilig username and password
+1. Log in into your alarm system's control panel. You will need to access http://[ip of your control panel]. You know this already since you need it in the basic configuration from above. Log in to the control panel with your Egardia/Woonveilig username and password.
 2. Once logged in, go to *System Settings*, *Report* and change the Server Address for your primary server to the IP or hostname of your Home Assistant machine. Also, update the port number 85 or to anything you like. The provided software that you will set up in the next steps runs on port 85 by default. **Make sure to change the settings of the primary server otherwise the messages will not come through. Note that this will limit (or fully stop) the number of alarm messages you will get through Egardia's / Woonveilig services.** Maybe, that is just what you want. Make sure to save your settings by selecting 'OK'.
-3. On your Home Assistant machine run `$ sudo python3 egardiaserver.py`. This will receive status codes from your alarm control panel and display them. You will need the codes to include in your configuration.yaml. Make sure to change the status of your alarm to all states (disarm, arm, armhome) as well as trigger the alarm in all ways possible to get 100% coverage. **Before triggering the alarm it might be good to temporarily disable the siren (can be done in Panel Settings).**
+3. On your Home Assistant machine run `$ sudo python3 egardiaserver.py`. This will receive status codes from your alarm control panel and display them. You will need the codes to include in your configuration.yaml. Make sure to change the status of your alarm to all states (disarm, arm, armhome) as well as trigger the alarm in all ways possible to get 100% coverage. **Before triggering the alarm it might be good to disable the siren temporarily (can be done in Panel Settings).**
 4. Once you have the codes, update your `configuration.yaml`:
 ```yaml
 # Example configuration.yaml entry
@@ -61,10 +61,10 @@ alarm_control_panel:
       triggered: XXXXXXXXXXXXXXXX, XXXXXXXXXXXXXXXX, XXXXXXXXXXXXXXXX
       standby: XXXXXXXXXXXXXXXX
 ```
-  Note that your can have more than one code for triggered, since every sensor generates it's own code. arm, disarm, armhome and standby will all be one code.
+  Note that you can have more than one code for triggered since every sensor generates its own code. arm, disarm, armhome and standby will all be one code.
 5. Start the `egardiaserver.py` script on boot of your Home Assistant machine, for example by adding the following to your `/etc/rc.local`:
 ```bash
  python3 [path/to/]egardiaserver.py &
 ```
- **Do not forget the trailing & here, otherwise you will be having a hard time logging back in to the machine.**
+ **Do not forget the trailing & here; otherwise you will be having a hard time logging back into the machine.**
 6. Test your setup and enjoy. The component will update if the alarm status changes, including triggers. You can use this to build your own automations and send notifications as you wish.
diff --git a/source/_components/alarm_control_panel.manual.markdown b/source/_components/alarm_control_panel.manual.markdown
@@ -31,7 +31,7 @@ Configuration variables:
 
 ## {% linkable_title Examples %}
 
-In this section you find some real life examples of how to use this panel.
+In this section, you find some real-life examples of how to use this panel.
 
 ### {% linkable_title Sensors %}
 
diff --git a/source/_components/alarm_control_panel.manual_mqtt.markdown b/source/_components/alarm_control_panel.manual_mqtt.markdown
@@ -51,7 +51,7 @@ All configuration variables from the base manual alarm platform are available:
 Additionally, the following MQTT configuration variables are also available:
 
 - **state_topic** (*Required*): The MQTT topic HA will publish state updates to.
-- **command_topic** (*Required*): The MQTT topic HA will subscribe to to receive commands from a remote device to change the alarm state.
+- **command_topic** (*Required*): The MQTT topic HA will subscribe to, to receive commands from a remote device to change the alarm state.
 - **qos** (*Optional*): The maximum QoS level for subscribing and publishing to MQTT messages. Default is 0.
 - **payload_disarm** (*Optional*): The payload to disarm this Alarm Panel. Default is "DISARM".
 - **payload_arm_home** (*Optional*): The payload to set armed-home mode on this Alarm Panel. Default is "ARM_HOME".
diff --git a/source/_components/alarm_control_panel.mqtt.markdown b/source/_components/alarm_control_panel.mqtt.markdown
@@ -23,7 +23,7 @@ The component will accept the following states from your Alarm Panel (in lower c
 - 'pending'
 - 'triggered'
 
-The component is able to control your Alarm Panel by publishing to the `command_topic` when a user interacts with the Home Assistant frontend.
+The component can control your Alarm Panel by publishing to the `command_topic` when a user interacts with the Home Assistant frontend.
 
 To enable this platform, add the following lines to your `configuration.yaml`:
 
diff --git a/source/_components/alarm_control_panel.wink.markdown b/source/_components/alarm_control_panel.wink.markdown
@@ -26,6 +26,6 @@ The requirement is that you have setup [Wink](/components/wink/).
 
 
 <p class='note'>
-The above devices are confimed to work, but others may work as well.
+The above devices are confirmed to work, but others may work as well.
 </p>
 
diff --git a/source/_components/alarmdecoder.markdown b/source/_components/alarmdecoder.markdown
@@ -13,7 +13,7 @@ ha_release: 0.43
 ha_iot_class: "Local Push"
 ---
 
-The `alarmdecoder` component will allow Home Assistant users who own either a DSC or Honeywell alarm panel to leverage their alarm system and it's sensors to provide Home Assistant with rich information about their homes. Connectivity between Home Assistant and the alarm panel is accomplished through a device produced by Nu Tech Software Solutions, known as the AlarmDecoder. The AlarmDecoder devices provide a serial, TCP/IP socket or USB interface to the alarm panel, where it emulates an alarm keypad. 
+The `alarmdecoder` component will allow Home Assistant users who own either a DSC or Honeywell alarm panel to leverage their alarm system and its sensors to provide Home Assistant with rich information about their homes. Connectivity between Home Assistant and the alarm panel is accomplished through a device produced by Nu Tech Software Solutions, known as the AlarmDecoder. The AlarmDecoder devices provide a serial, TCP/IP socket or USB interface to the alarm panel, where it emulates an alarm keypad. 
 
 Please visit the [AlarmDecoder website](https://www.alarmdecoder.com/) for further information about the AlarmDecoder devices.
 
@@ -46,10 +46,10 @@ alarmdecoder:
 
 Configuration variables:
 
-- **type** (*Required*): The type of AlarmDecoder device: socket, serial or usb
+- **type** (*Required*): The type of AlarmDecoder device: socket, serial or USB
 - **host** (*Optional*): The IP address of the AlarmDecoder device on your home network, if using socket type. Default: `localhost`
 - **port** (*Optional*): The port of the AlarmDecoder device on your home network, if using socket type. Default: `10000`
 - **path** (*Optional*): The path of the AlarmDecoder device, if using socket type. Default: `/dev/ttyUSB0`
 - **baud** (*Optional*): The baud rate of the AlarmDecoder device, if using serial type. Default: `115200`
-- **panel_display** (*Optional*): Create a sensor called sensor.alarm_display to match the Alarm Keypad dispaly. Default: `off`
+- **panel_display** (*Optional*): Create a sensor called sensor.alarm_display to match the Alarm Keypad display. Default: `off`
 - **zones** (*Optional*): AlarmDecoder has no way to tell us which zones are actually in use, so each zone must be configured in Home Assistant. For each zone, at least a name must be given. For more information on the available zone types, take a look at the [Binary Sensor](/components/binary_sensor.alarmdecoder/) docs. *Note: If no zones are specified, Home Assistant will not load any binary_sensor components.*
diff --git a/source/_components/alert.markdown b/source/_components/alert.markdown
@@ -12,11 +12,11 @@ ha_category: Automation
 ha_release: 0.38
 ---
 
-The `alert` component is designed to notify you when problematic issues arise. For example, if the garage door is left open, the `alert` component can be used remind you of this by sending you repeating notifications at customizable intervals. This is also useful for low battery sensors, water leak sensors, or any condition that may need your attention.
+The `alert` component is designed to notify you when problematic issues arise. For example, if the garage door is left open, the `alert` component can be used remind you of this by sending you repeating notifications at customizable intervals. This is also used for low battery sensors, water leak sensors, or any condition that may need your attention.
 
 Alerts will add an entity to the front end only when they are firing. This entity allows you to silence an alert until it is resolved.
 
-When using the `alert` component it is important that the timezone used for Home Assistant and the underlying operating system match. Failing to do so may result in multiple alerts being sent at the same time (such as when Home Assistant is set to the `America/Detroit` timezone but the operating system uses `UTC`).
+When using the `alert` component, it is important that the time zone used for Home Assistant and the underlying operating system match. Failing to do so may result in multiple alerts being sent at the same time (such as when Home Assistant is set to the `America/Detroit` time zone but the operating system uses `UTC`).
 
 ### {% linkable_title Basic Example %}
 
@@ -44,7 +44,7 @@ Configuration variables:
 - **entity_id** (*Required*): The ID of the entity to watch.
 - **state** (*Optional*): The problem condition for the entity. Defaults to `on`.
 - **repeat** (*Required*): Number of minutes before the notification should be repeated. Can be either a number or a list of numbers.
-- **can_acknowledge** (*Optional*): Allows the alert to be unacknowledgable. Defaults to `true`.
+- **can_acknowledge** (*Optional*): Allows the alert to be unacknowledgeable. Defaults to `true`.
 - **skip_first** (*Optional*): Controls whether the notification should be sent immediately or after the first delay. Defaults to `false`.
 - **notifiers** (*Required*): List of `notification` components to use for alerts.
 
diff --git a/source/_components/alexa.markdown b/source/_components/alexa.markdown
@@ -99,7 +99,7 @@ When activated, the Alexa component will have Home Assistant's native intent sup
 
 One of the most useful applications of Alexa integrations is to call scenes directly. This is easily achieved with some simple setup on the Home Assistant side and by letting Alexa know which scenes you want to run.
 
-First we will configure Alexa. In the Amazon Interaction module add this to the intent schema:
+First, we will configure Alexa. In the Amazon Interaction module add this to the intent schema:
 
 ```json
 {
@@ -144,7 +144,7 @@ intent_script:
 
 Here we are using [templates] to take the name we gave to Alexa e.g. `downstairs on` and replace the space with an underscore so it becomes `downstairs_on` as Home Assistant expects.
 
-Now say `Alexa ask homeassistant to activate <some scene>` and Alexa will activate that scene for you.
+Now say `Alexa ask Home Assistant to activate <some scene>` and Alexa will activate that scene for you.
 
 ### {% linkable_title Adding Scripts %}
 
@@ -190,14 +190,14 @@ intent_script:
       text: OK
 ```
 
-Now say `Alexa ask homeassistant to run <some script>` and Alexa will run that script for you.
+Now say `Alexa ask Home Assistant to run <some script>` and Alexa will run that script for you.
 
 ### {% linkable_title Support for Launch Requests %}
 There may be times when you want to respond to a launch request initiated from a command such as "Alexa, Red Alert!".
 
-To start you need to get the skill id:
+To start, you need to get the skill id:
 
- - Log in to [Amazon developer console][amazon-dev-console]
+ - Log into [Amazon developer console][amazon-dev-console]
  - Click the Alexa button at the top of the console
  - Click the Alexa Skills Kit Get Started button
    - Locate the skill for which you would like Launch Request support
@@ -305,7 +305,7 @@ Please refer to the [Amazon documentation][flash-briefing-api-docs] for more inf
       - All other settings are up to you
       - Hit "Next"
   - Test
-      - Having passed all validations to reach this screen you can now click on "< Back to All Skills" as your flash briefing is now available as in "Development" service.  
+      - Having passed all validations to reach this screen, you can now click on "< Back to All Skills" as your flash briefing is now available as in "Development" service.  
 - To invoke your flash briefing, open the Alexa app on your phone or go to the [Alexa Settings Site][alexa-settings-site], open the "Skills" configuration section, select "Your Skills", scroll to the bottom, tap on the Flash Briefing Skill you just created, enable it, then manage Flash Briefing and adjust ordering as necessary.  Finally ask your Echo for your "news","flash briefing", or "briefing".
 
 [amazon-dev-console]: https://developer.amazon.com
diff --git a/source/_components/amcrest.markdown b/source/_components/amcrest.markdown
@@ -38,22 +38,22 @@ amcrest:
 
 Configuration variables:
 
-- **host** (*Required*): The IP address or hostname of your camera. If using hostname, make sure the DNS works as expected.
+- **host** (*Required*): The IP address or hostname of your camera. If using a hostname, make sure the DNS works as expected.
 - **username** (*Required*): The username for accessing your camera.
 - **password** (*Required*): The password for accessing your camera.
 - **name** (*Optional*): This parameter allows you to override the name of your camera. The default is "Amcrest Camera".
 - **port** (*Optional*): The port that the camera is running on. The default is 80.
 - **resolution** (*Optional*): This parameter allows you to specify the camera resolution. For a high resolution (1080/720p), specify the option `high`. For VGA resolution (640x480p), specify the option `low`. If omitted, it defaults to *high*.
 - **stream_source** (*Optional*): The data source for the live stream. `mjpeg` will use the camera's native MJPEG stream, whereas `snapshot` will use the camera's snapshot API to create a stream from still images. You can also set the `rtsp` option to generate the streaming via RTSP protocol. If omitted, it defaults to *snapshot*.
 - **ffmpeg_arguments**: (*Optional*): Extra options to pass to ffmpeg, e.g. image quality or video filter options.
-- **authentication**: (*Optional*): Defines which authentication method to use only when **stream_source** is **mjpeg**. Currently *aiohttp* only support *basic*. It defaults to *basic*.
+- **authentication**: (*Optional*): Defines which authentication method to use only when **stream_source** is **mjpeg**. Currently, *aiohttp* only support *basic*. It defaults to *basic*.
 - **scan_interval** (*Optional*): Defines the update interval of the sensor in seconds. The default is 10 seconds.
 - **sensors** array (*Optional*): Conditions to display in the frontend. By default, *none* of the conditions are enabled. The following conditions can be monitored.
   - **motion_detector**: Return True/False when a motion is detected
   - **sdcard**: Return the SD card usage by reporting the total and used space
   - **ptz_preset**: Return the number of PTZ preset positions configured for the given camera
 
-**Note:** Amcrest cameras with newer firmwares no longer have the ability to stream `high` definition video with MJPEG encoding. You may need to use `low` resolution stream or the `snapshot` stream source instead.  If the quality seems too poor, lower the `Frame Rate (FPS)` and max out the `Bit Rate` settings in your camera's configuration manager. If you defined the *stream_source* to **mjpeg**, make sure your camera supports *Basic* HTTP authentication. Newer Amcrest firwmares may not work, then **rtsp** is recommended instead.
+**Note:** Amcrest cameras with newer firmware no longer have the ability to stream `high` definition video with MJPEG encoding. You may need to use `low` resolution stream or the `snapshot` stream source instead.  If the quality seems too poor, lower the `Frame Rate (FPS)` and max out the `Bit Rate` settings in your camera's configuration manager. If you defined the *stream_source* to **mjpeg**, make sure your camera supports *Basic* HTTP authentication. Newer Amcrest firmware may not work, then **rtsp** is recommended instead.
 
 **Note:** If you set the `stream_source` option to `rtsp`, make sure to follow the steps mentioned at
 [FFMPEG](https://home-assistant.io/components/ffmpeg/) documentation to install the `ffmpeg`.
diff --git a/source/_components/android_ip_webcam.markdown b/source/_components/android_ip_webcam.markdown
@@ -15,7 +15,7 @@ ha_iot_class: "Local Polling"
 
 The `android_ip_webcam` component turns an Android phone into a network camera with multiple viewing options.
 
-It's setup as a mjpeg camera and all settings as switches inside of Home Assistant. You can also expose the sensors. If you have multiple phones, you can use all options inside a list.
+It's setup as an M-JPEG camera and all settings as switches inside of Home Assistant. You can also expose the sensors. If you have multiple phones, you can use all options inside a list.
 
 To set it up, download [the IP Webcam app][app], and add the following information to your `configuration.yaml` file:
 
@@ -33,8 +33,8 @@ Configuration variables:
 - **username** (*Optional*): The username to access the phone.
 - **password** (*Optional*): The password to access the phone.
 - **scan_interval** (*Optional*): Default is 10 seconds. Defines the update interval of the phone.
-- **sensors** array (*Optional*): Conditions to display sensor in the frontend. See list of supported sensors.
-- **switches** array (*Optional*): Conditions to display settings in the frontend. See list of supported settings.
+- **sensors** array (*Optional*): Conditions to display sensor in the frontend. See the list of supported sensors.
+- **switches** array (*Optional*): Conditions to display settings in the frontend. See the list of supported settings.
 - **motion_sensor** (*Optional*): Activate motion sensor if auto_discovery is disabled.
 
 ### {% linkable_title Supported features %}
diff --git a/source/_components/apiai.markdown b/source/_components/apiai.markdown
diff --git a/source/_components/apple_tv.markdown b/source/_components/apple_tv.markdown
diff --git a/source/_components/arduino.markdown b/source/_components/arduino.markdown
diff --git a/source/_components/asterisk_mbox.markdown b/source/_components/asterisk_mbox.markdown
diff --git a/source/_components/axis.markdown b/source/_components/axis.markdown
