-
The alarmdotcom platform is consuming the information provided by a Alarm.com.
The alarmdotcom platform is consuming the information provided by Alarm.com.
To enable this, add the following lines to your configuration.yaml:
# Example configuration.yaml entry
alarm_control_panel:
diff --git a/components/alarm_control_panel.egardia/index.html b/components/alarm_control_panel.egardia/index.html
index 44da2414a8..c0f712d181 100644
--- a/components/alarm_control_panel.egardia/index.html
+++ b/components/alarm_control_panel.egardia/index.html
@@ -97,11 +97,11 @@
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.
- - 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
+ - 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.
- 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’.
- - 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).
+ - 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).
- Once you have the codes, update your
configuration.yaml:
# Example configuration.yaml entry
alarm_control_panel:
@@ -119,13 +119,13 @@ You can change this however, using the following procedure. This is an more adva
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.
- Start the
egardiaserver.py script on boot of your Home Assistant machine, for example by adding the following to your /etc/rc.local:
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.
- 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/components/alarm_control_panel.manual/index.html b/components/alarm_control_panel.manual/index.html
index bce0b2e952..77097e2912 100644
--- a/components/alarm_control_panel.manual/index.html
+++ b/components/alarm_control_panel.manual/index.html
@@ -89,7 +89,7 @@
disarm_after_trigger (Optional): If true, the alarm will automatically disarm after it has been triggered instead of returning to the previous state.
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.
Sensors
Using sensors to trigger the alarm.
automation:
diff --git a/components/alarm_control_panel.manual_mqtt/index.html b/components/alarm_control_panel.manual_mqtt/index.html
index a159ca8de7..9c838f26d2 100644
--- a/components/alarm_control_panel.manual_mqtt/index.html
+++ b/components/alarm_control_panel.manual_mqtt/index.html
@@ -109,7 +109,7 @@
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/components/alarm_control_panel.mqtt/index.html b/components/alarm_control_panel.mqtt/index.html
index 322d0af3bb..0e7ead84f8 100644
--- a/components/alarm_control_panel.mqtt/index.html
+++ b/components/alarm_control_panel.mqtt/index.html
@@ -83,7 +83,7 @@
- ‘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:
# Example configuration.yaml entry
alarm_control_panel:
diff --git a/components/alarm_control_panel.wink/index.html b/components/alarm_control_panel.wink/index.html
index b46ade76b2..4e93db43e8 100644
--- a/components/alarm_control_panel.wink/index.html
+++ b/components/alarm_control_panel.wink/index.html
@@ -82,7 +82,7 @@
Canary all-in-one security camera
-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.
diff --git a/components/alarmdecoder/index.html b/components/alarmdecoder/index.html
index 10667a6c42..f0a3e0fb4b 100644
--- a/components/alarmdecoder/index.html
+++ b/components/alarmdecoder/index.html
@@ -74,7 +74,7 @@
- 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 for further information about the AlarmDecoder devices.
There is currently support for the following device types within Home Assistant:
@@ -102,12 +102,12 @@
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 docs. Note: If no zones are specified, Home Assistant will not load any binary_sensor components.
diff --git a/components/alert/index.html b/components/alert/index.html
index 4c42ff4c52..931d74a707 100644
--- a/components/alert/index.html
+++ b/components/alert/index.html
@@ -74,9 +74,9 @@
- 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).
Basic Example
The alert component makes use of any of the notifications components. To setup the alert component, first, you must setup a notification component. Then, add the following to your configuration file:
# Example configuration.yaml entry
@@ -101,7 +101,7 @@
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/components/alexa/index.html b/components/alexa/index.html
index e1124560c5..a25007e7a1 100644
--- a/components/alexa/index.html
+++ b/components/alexa/index.html
@@ -146,7 +146,7 @@ WhereAreWeIntent where we are
When activated, the Alexa component will have Home Assistant’s native intent support handle the incoming intents. If you want to run actions based on intents, use the intent_script component.
Working With Scenes
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:
{
"intent": "ActivateSceneIntent",
"slots":
@@ -182,7 +182,7 @@ Custom slot type for scene support.
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.
Adding Scripts
We can easily extend the above idea to work with scripts as well. As before, add an intent for scripts:
{
@@ -218,12 +218,12 @@ Custom slot type for script support.
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.
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
+ - Log into Amazon developer console
- Click the Alexa button at the top of the console
- Click the Alexa Skills Kit Get Started button
@@ -330,7 +330,7 @@ Custom slot type for script support.
- 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.
diff --git a/components/amcrest/index.html b/components/amcrest/index.html
index 073a6fb27c..d78e75b40f 100644
--- a/components/amcrest/index.html
+++ b/components/amcrest/index.html
@@ -96,7 +96,7 @@
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”.
@@ -104,7 +104,7 @@
- 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.
@@ -114,7 +114,7 @@
-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 documentation to install the ffmpeg.
Finish its configuration by visiting the Amcrest sensor page or Amcrest camera page.
diff --git a/components/android_ip_webcam/index.html b/components/android_ip_webcam/index.html
index c3b76c1128..02b7825e3e 100644
--- a/components/android_ip_webcam/index.html
+++ b/components/android_ip_webcam/index.html
@@ -75,7 +75,7 @@
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, and add the following information to your configuration.yaml file:
# Example configuration.yaml entry
android_ip_webcam:
@@ -90,8 +90,8 @@
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.
Supported features
diff --git a/components/apiai/index.html b/components/apiai/index.html
index 9b12f419e8..997764d6c8 100644
--- a/components/apiai/index.html
+++ b/components/apiai/index.html
@@ -74,8 +74,8 @@
- This component is designed to be used with the “webhook” integration in api.ai. When a conversation ends with an user, api.ai sends an action and parameters to the webhook.
-api.ai requires a public endpoint (HTTPS recommended), so your Home Assistant should be exposed to Internet. api.ai will return fallback answers if your server do not answer, or takes too long (more than 5 seconds).
+ This component is designed to be used with the “webhook” integration in api.ai. When a conversation ends with a user, api.ai sends an action and parameters to the webhook.
+api.ai requires a public endpoint (HTTPS recommended), so your Home Assistant should be exposed to the Internet. api.ai will return fallback answers if your server does not answer, or takes too long (more than 5 seconds).
api.ai could be integrated with many popular messaging, virtual assistant and IoT platforms, eg.: Google Assistant (Google Actions), Skype, Messenger. See here the complete list.
Using Api.ai will be easy to create conversations like:
@@ -88,14 +88,14 @@
User: In the kitchen
Bot: Turning on kitchen light
-To use this integration you should define a conversation (intent) in Api.ai, configure Home Assistant with the speech to return and, optionally, the action to execute.
+To use this integration, you should define a conversation (intent) in Api.ai, configure Home Assistant with the speech to return and, optionally, the action to execute.
Configuring your api.ai account
- Login with your Google account.
- Click on “Create Agent”
- Select name, language (if you are planning to use it with Google Actions check here supported languages) and time zone
- Click “Save”
- - Go to “Fullfiment” (in the left menu)
+ - Go to “Fulfillment” (in the left menu)
- Enable Webhook and set your Home Assistant URL with the Api.ai endpoint. Eg.:
https://myhome.duckdns.org/api/apiai?api_password=HA_PASSWORD
- Click “Save”
- Create a new intent
diff --git a/components/apple_tv/index.html b/components/apple_tv/index.html
index ef834648c2..a12b39e880 100644
--- a/components/apple_tv/index.html
+++ b/components/apple_tv/index.html
@@ -76,13 +76,13 @@
The apple_tv platform allows you to control an Apple TV (3rd and 4th generation). See the remote platform if you want to send remote control buttons, e.g. arrow keys.
-Currently you must have Home Sharing enabled for this to work. Support for pairing Home Assistant with your device will be supported in a later release.
+Currently, you must have Home Sharing enabled for this to work. Support for pairing Home Assistant with your device will be supported in a later release.
To use this component, you must first install some system libraries and a compiler. For Debian or a similar system, this should be enough:
$ sudo apt-get install build-essential libssl-dev libffi-dev python-dev
-If you want to automatically discover new devices, just make sure you have discovery: in your configuration.yaml file. To manually add one or more Apple TVs to your installation, add the following to your configuration.yaml file:
+If you want to discover new devices automatically, just make sure you have discovery: in your configuration.yaml file. To manually add one or more Apple TVs to your installation, add the following to your configuration.yaml file:
# Example configuration.yaml entry
apple_tv:
- host: IP_1
@@ -102,10 +102,10 @@ Currently you must have Home Sharing enabled for this to work. Support for pairi
- host (Required): The IP-address of the device.
- login_id (Required): An identifier used to login to the device, see below.
- name (Optional): The name of the device used in the frontend.
- - start_off (Optional): Set to true if device should start in fake standby.
+ - start_off (Optional): Set to true if the device should start in fake standby.
- credentials (Optional): Credentials used for AirPlay playback.
-In order to connect to the device you need a login id. The easiest way to obtain this identifier is to use the apple_tv_scan service (described below). Additional information about start_off and credentials can also be found under the guides section.
+In order to connect to the device, you need a login id. The easiest way to obtain this identifier is to use the apple_tv_scan service (described below). Additional information about start_off and credentials can also be found under the guides section.
Guides
Scanning for devices
To scan for devices, press the icon in the upper left corner and select the leftmost icon according to the image:
@@ -114,7 +114,7 @@ Currently you must have Home Sharing enabled for this to work. Support for pairi
Scanning will be done for three seconds and notification will be shown in the state view with all found devices:
-Alternatively you may use the application atvremote. Install it with pip3 install --upgrade pyatv in your Home Assistant environment (note: do not use sudo). Then run atvremote scan to scan for all devices (try again if a device is missing):
+Alternatively, you may use the application atvremote. Install it with pip3 install --upgrade pyatv in your Home Assistant environment (note: do not use sudo). Then run atvremote scan to scan for all devices (try again if a device is missing):
$ atvremote scan
Found Apple TVs:
- Apple TV at 10.0.10.22 (login id: 00000000-1234-5678-9012-345678901234)
@@ -124,17 +124,17 @@ Note: You must use 'pair' with devices that have home sh
Just copy and paste the login id from the device you want to add. For more details about atvremote, see: this page.
My Apple TV turns on when I restart Home Assistant
-The Apple TV will automatically turn on if a request is sent to it, e.g. if a button is pressed, something is streamed to it via AirPlay or if current state (currently playing) is accessed. This is how Apple has designed it and it will cause problems if you are using HDMI CEC. Every time Home Assistant is started, a new request is sent to the device to figure out what is currently playing. When using CEC, this will wake up your TV and other devices you have configured.
-So, if your TV is randomly turning on, this is probably the reason. As stated, this is by design and there is no real fix for it. There’s also no known way to turn off the Apple TV via the procotol used for communication. You basically have the following options:
+The Apple TV will automatically turn on if a request is sent to it, e.g., if a button is pressed, something is streamed to it via AirPlay or if current state (currently playing) is accessed. This is how Apple has designed it, and it will cause problems if you are using HDMI CEC. Every time Home Assistant is started, a new request is sent to the device to figure out what is currently playing. When using CEC, this will wake up your TV and other devices you have configured.
+So, if your TV is randomly turning on, this is probably the reason. As stated, this is by design, and there is no real fix for it. There’s also no known way to turn off the Apple TV via the protocol used for communication. You have the following options:
- Do not use this platform
- Disable HDMI CEC on your Apple TV
- Use “fake standby”
-The first two points are quite obvious. Fake standby is a concept implemented in this platform that disables all requests to the device and make it appear as being “off” in the web interface. This will make sure that the device is not woken up, but it will of course not show any information or allow you to control it. It is however easy to turn it on (or off) in the web interface or using an automation with turn_on. To make it more useful, you can write automations that turns it on or off depending on some other device, like the input source on your receiver.
+The first two points are quite obvious. Fake standby is a concept implemented in this platform that disables all requests to the device and makes it appear as being “off” in the web interface. This will make sure that the device is not woken up, but it will of course not show any information or allow you to control it. It is however easy to turn it on (or off) in the web interface or to use an automation with turn_on. To make it more useful, you can write automations that turn it on or off depending on some other device, like the input source on your receiver.
To put a device into fake standby when starting Home Assistant, add start_off: true to your configuration.
-Turning the device on/off in the user interface will not turn the physical device on/off according to description above.
+Turning the device on/off in the user interface will not turn the physical device on/off according to the description above.
Setting up device authentication
If you, when playing media with play_url, get the following error message:
@@ -153,10 +153,10 @@ Turning the device on/off in the user interface will not turn the physi
credentials: 1B8C387DDB59BDF6:CF5ABB6A2C070688F5926ADB7C010F6DF847252C15F9BDB6DA3E09D6591E90E5
-Restart Home Assistant and you should now be able to use play_url as before.
+Restart Home Assistant, and you should now be able to use play_url as before.
Services
Service apple_tv_authenticate
-In order to play media on an Apple TV with device authentication enabled (e.g. ATV4 with tvOS 10.2+), Home Assistant must properly authenticated. This method starts the process and presents the credentials needed for playback as a persistent notification. Please see guide above for usage.
+To play media on an Apple TV with device authentication enabled (e.g., ATV4 with tvOS 10.2+), Home Assistant must be properly authenticated. This method starts the process and presents the credentials needed for playback as a persistent notification. Please see guide above for usage.
diff --git a/components/arduino/index.html b/components/arduino/index.html
index bbeef54f42..7b2c524a8c 100644
--- a/components/arduino/index.html
+++ b/components/arduino/index.html
@@ -74,10 +74,10 @@
- The Arduino device family are microcontroller boards that are often based on the ATmega328 chip. They come with digital input/output pins (some can be used as PWM outputs), analog inputs, and a USB connection. The equipment depends on the type of board. The most common ones are the Arduino Uno and the Arduino Leonardo with 14 digital input/output pins and 6 analog input pins.
-There are a lot of extensions (so called shields) available. Those shields can be plugged-in into the existing connectors and stacked on top of each other. This makes it possible to expand the capabilities of the Arduino boards.
+ The Arduino device family are microcontroller boards that are often based on the ATmega328 chip. They come with digital input/output pins (some can be used as PWM outputs), analog inputs, and a USB connection. The equipment depends on the type of the board. The most common ones are the Arduino Uno and the Arduino Leonardo with 14 digital input/output pins and 6 analog input pins.
+There are a lot of extensions (so-called shields) available. Those shields can be plugged-in into the existing connectors and stacked on top of each other. This makes it possible to expand the capabilities of the Arduino boards.
The arduino component is designed to let you use a directly attached board to your Home Assistant host over USB.
-You need to have the Firmata firmware on your board. Please upload the StandardFirmata sketch to your board, please refer to the Arduino documentation for further information.
+You need to have the Firmata firmware on your board. Please upload the StandardFirmata sketch to your board; please refer to the Arduino documentation for further information.
To integrate an Arduino boards with Home Assistant, add the following section to your configuration.yaml file:
# Example configuration.yaml entry
arduino:
@@ -86,13 +86,13 @@
Configuration variables:
- - port (Required): The port where your board is connected to your Home Assistant host. If you are using an original Arduino the port will be named
ttyACM* otherwise ttyUSB*.
+ - port (Required): The port where your board is connected to your Home Assistant host. If you are using an original Arduino, the port will be named
ttyACM* otherwise ttyUSB*.
The exact number can be determined with the command shown below.
$ ls /dev/ttyACM*
-If that’s not working, check your dmesg or journalctl -f output. Keep in mind that Arduino clones are often using a different name for the port (eg. /dev/ttyUSB*).
+If that’s not working, check your dmesg or journalctl -f output. Keep in mind that Arduino clones are often using a different name for the port (e.g. /dev/ttyUSB*).
A word of caution: The Arduino boards are not storing states. This means that with every initialization the pins are set to off/low.
diff --git a/components/asterisk_mbox/index.html b/components/asterisk_mbox/index.html
index 6a8a7eb693..ec3cfb5560 100644
--- a/components/asterisk_mbox/index.html
+++ b/components/asterisk_mbox/index.html
@@ -74,9 +74,9 @@
- The Asterisk Voicemail integration for Home Assistant allows you to view, listen-to, and delete voicemails from a Asterisk voicemail mailbox. The component includes a panel on the frontend that provides caller-id and speech-to-text transcription (using Google’s API) of messages in addition to playback and message deletion. There is also an included sensor that provides an indication of the number of available messages. There is no requirement that the Asterisk PBX and Home Assistant are running on the same machine.
-To enable the component, configuration is required in both Home Assistant as well as on the Asterisk server.
-First follow the Asterisk PBX configuration guide to setup the necessary server on the Asterisk PBX server (this is necessary even if Asterisk and Home Assistant are running on the same server)
+ The Asterisk Voicemail integration for Home Assistant allows you to view, listen to, and delete voicemails from an Asterisk voicemail mailbox. The component includes a panel on the frontend that provides caller-id and speech-to-text transcription (using Google’s API) of messages in addition to playback and message deletion. There is also an included sensor that indicates of the number of available messages. There is no requirement that the Asterisk PBX and Home Assistant are running on the same machine.
+To enable the component, a configuration is required in both Home Assistant as well as on the Asterisk server.
+First follow the Asterisk PBX configuration guide to setup the necessary server on the Asterisk PBX server (this is needed even if Asterisk and Home Assistant are running on the same server)
Once that is complete, add the the following entry configuration.yaml file:
# Example configuration.yaml entry
asterisk_mbox:
@@ -88,12 +88,12 @@
This will add a new ‘Mailbox’ side-panel, as well as a sensor to indicate # of messages available.
Configuration variables:
- - password (Required): The password that was set during Asterisk PBX confguration
+ - password (Required): The password that was set during Asterisk PBX configuration
- host (Required): The ip-address of the server that is running the Asterisk PBX
- - port (Required): The port on the Asterisk PBX server that was configured during Asterisk PBX confguration
+ - port (Required): The port on the Asterisk PBX server that was configured during Asterisk PBX configuration
-Communication between the Asterisk PBX server and the Home Assistant server is password-protected, but the data transmission is not encrypted. It is recommended to only use this component when communication will be contained within a local area network.
+Communication between the Asterisk PBX server and the Home Assistant server is password-protected, but the data transmission is not encrypted. It is recommended to only use this component when communication is contained within a local area network.
diff --git a/components/axis/index.html b/components/axis/index.html
index 6ac625f49e..318fd71153 100644
--- a/components/axis/index.html
+++ b/components/axis/index.html
@@ -74,7 +74,7 @@
- Axis Communications devices are surveillance cameras and other security related network connected hardware. Sensor API works with firmware 5.50 and newer.
+ Axis Communications devices are surveillance cameras and other security-related network connected hardware. Sensor API works with firmware 5.50 and newer.
Home Assistant will automatically discover their presence on your network.
Dependencies
$ sudo apt-get install python3-gi gir1.2-gstreamer-1.0
@@ -112,7 +112,7 @@
- camera: Stream MJPEG video to Home Assistant.
- motion: The built-in motion detection in Axis cameras.
- vmd3: ACAP Motion Detection app which has better algorithms for motion detection.
- - pir: PIR sensor that can trigger on motion.
+ - pir: PIR sensor that can trigger on a motion.
- sound: Sound detector.
- daynight: Certain cameras have day/night mode if they have built-in IR lights.
- tampering: Signals when camera believes that it has been tampered with.
@@ -138,13 +138,13 @@
-If you are using Python3.6 you might need to replace the 34m with 36m in the _gi.*.so filename in the gi folder.
+If you are using Python 3.6, you might need to replace the 34m with 36m in the _gi.*.so filename in the gi folder.
Any specific levels for triggers needs to be configured on the device.
- It is recommended that you create a user on your Axis device specifically for Home Assistant. For all current functionality it is enough to create a user belonging to user group viewer.
+ It is recommended that you create a user on your Axis device specifically for Home Assistant. For all current functionality, it is enough to create a user belonging to user group viewer.
Device services
Available services: vapix_call.
@@ -172,7 +172,7 @@ Any specific levels for triggers needs to be configured on the device.
cgiyes
- Which cgi to call on device. Default is param.cgi.
+ Which cgi to call on the device. Default is param.cgi.
action
https://home-assistant.io/demo/frontend.html
-2017-08-22T09:04:54+00:00
+2017-08-22T11:06:30+00:00
https://home-assistant.io/demo/index.html
-2017-08-22T09:04:54+00:00
+2017-08-22T11:06:30+00:00
https://home-assistant.io/demo/panels/ha-panel-dev-event.html
-2017-08-22T09:04:54+00:00
+2017-08-22T11:06:30+00:00
https://home-assistant.io/demo/panels/ha-panel-dev-info.html
-2017-08-22T09:04:54+00:00
+2017-08-22T11:06:30+00:00
https://home-assistant.io/demo/panels/ha-panel-dev-service.html
-2017-08-22T09:04:54+00:00
+2017-08-22T11:06:30+00:00
https://home-assistant.io/demo/panels/ha-panel-dev-state.html
-2017-08-22T09:04:54+00:00
+2017-08-22T11:06:30+00:00
https://home-assistant.io/demo/panels/ha-panel-dev-template.html
-2017-08-22T09:04:54+00:00
+2017-08-22T11:06:30+00:00
https://home-assistant.io/demo/panels/ha-panel-history.html
-2017-08-22T09:04:54+00:00
+2017-08-22T11:06:30+00:00
https://home-assistant.io/demo/panels/ha-panel-iframe.html
-2017-08-22T09:04:54+00:00
+2017-08-22T11:06:30+00:00
https://home-assistant.io/demo/panels/ha-panel-logbook.html
-2017-08-22T09:04:54+00:00
+2017-08-22T11:06:30+00:00
https://home-assistant.io/demo/panels/ha-panel-map.html
-2017-08-22T09:04:54+00:00
+2017-08-22T11:06:30+00:00
https://home-assistant.io/googlef4f3693c209fe788.html
-2017-08-22T09:04:54+00:00
+2017-08-22T11:06:30+00:00
https://home-assistant.io/static/fonts/roboto/DESCRIPTION.en_us.html
-2017-08-22T09:04:54+00:00
+2017-08-22T11:06:31+00:00
https://home-assistant.io/static/fonts/robotomono/DESCRIPTION.en_us.html
-2017-08-22T09:04:54+00:00
+2017-08-22T11:06:31+00:00
https://home-assistant.io/static/mdi-demo.html
-2017-08-22T09:04:54+00:00
+2017-08-22T11:06:31+00:00