diff --git a/source/_components/alarm_control_panel.egardia.markdown b/source/_components/alarm_control_panel.egardia.markdown index e091c2d83b9..4a885eb68fa 100644 --- a/source/_components/alarm_control_panel.egardia.markdown +++ b/source/_components/alarm_control_panel.egardia.markdown @@ -41,7 +41,7 @@ Configuration variables: 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 a more advanced configuration. -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. +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`. Refer to the [python-egardia repository](https://github.com/jeroenterheerdt/python-egardia) for detailed documentation on parameters. 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`: diff --git a/source/_components/alert.markdown b/source/_components/alert.markdown index 8967a134e5f..acdf983305f 100644 --- a/source/_components/alert.markdown +++ b/source/_components/alert.markdown @@ -75,7 +75,7 @@ freshwater_temp_alert: ### {% linkable_title Complex Alert Criteria %} -By design, the `alert` component only handles very simple criteria for firing. That is, it only checks if a single entity's state is equal to a value. At some point, it may be desireable to have an alert with a more complex criteria. Possibly, when a battery percentage falls below a threshold. Maybe you want to disable the alert on certain days. Maybe the alert firing should depend on more than one input. For all of these situations, it is best to use the alert in conjunction with a `Template Binary Sensor`. The following example does that. +By design, the `alert` component only handles very simple criteria for firing. That is, it only checks if a single entity's state is equal to a value. At some point, it may be desirable to have an alert with a more complex criteria. Possibly, when a battery percentage falls below a threshold. Maybe you want to disable the alert on certain days. Maybe the alert firing should depend on more than one input. For all of these situations, it is best to use the alert in conjunction with a `Template Binary Sensor`. The following example does that. ```yaml binary_sensor: @@ -99,7 +99,7 @@ This example will begin firing as soon as the entity `sensor.motion`'s `battery` ### {% linkable_title Dynamic Notification Delay Times %} -It may be desireable to have the delays between alert notifications dynamically change as the alert continues to fire. This can be done by setting the `repeat` configuration key to a list of numbers rather than a single number. Altering the first example would look like the following. +It may be desirable to have the delays between alert notifications dynamically change as the alert continues to fire. This can be done by setting the `repeat` configuration key to a list of numbers rather than a single number. Altering the first example would look like the following. ```yaml # Example configuration.yaml entry diff --git a/source/_components/alexa.markdown b/source/_components/alexa.markdown index 60f7e4c4677..ceb6a3f2f12 100644 --- a/source/_components/alexa.markdown +++ b/source/_components/alexa.markdown @@ -33,7 +33,7 @@ The built-in Alexa component allows you to integrate Home Assistant into Alexa/A ### {% linkable_title Requirements %} -Amazon requires the endpoint of a skill to be hosted via SSL. Self-signed certificates are ok because our skills will only run in development mode. Read more on [our blog][blog-lets-encrypt] about how to set up encryption for Home Assistant. When running Hass.io, using the [Let's Encrypt](/addons/lets_encrypt/) the and [Duck DNS](/addons/duckdns/) add-ons is the easiest method. If you are unable to get HTTPS up and running, consider using [this AWS Lambda proxy for Alexa skills](https://community.home-assistant.io/t/aws-lambda-proxy-custom-alexa-skill-when-you-dont-have-https/5230). +Amazon requires the endpoint of a skill to be hosted via SSL. Self-signed certificates are OK because our skills will only run in development mode. Read more on [our blog][blog-lets-encrypt] about how to set up encryption for Home Assistant. When running Hass.io, using the [Let's Encrypt](/addons/lets_encrypt/) the and [Duck DNS](/addons/duckdns/) add-ons is the easiest method. If you are unable to get HTTPS up and running, consider using [this AWS Lambda proxy for Alexa skills](https://community.home-assistant.io/t/aws-lambda-proxy-custom-alexa-skill-when-you-dont-have-https/5230). Additionally, note that at the time of this writing, your Alexa skill endpoint *must* accept requests over port 443 (Home Assistant default to 8123). There are two ways you can handle this: @@ -295,7 +295,7 @@ alexa: {% endif %}{% endraw %} ``` -You can add multiple items for a feed if you want. The Amazon required uid and timestamp will be randomly generated at startup and change at every restart of Home Assistant. +You can add multiple items for a feed if you want. The Amazon required UID and timestamp will be randomly generated at startup and change at every restart of Home Assistant. Please refer to the [Amazon documentation][flash-briefing-api-docs] for more information about allowed configuration parameters and formats. diff --git a/source/_components/binary_sensor.bayesian.markdown b/source/_components/binary_sensor.bayesian.markdown index af58bf0d2fe..53505593b6b 100644 --- a/source/_components/binary_sensor.bayesian.markdown +++ b/source/_components/binary_sensor.bayesian.markdown @@ -41,7 +41,7 @@ Configuration variables: - **prob_given_true** (*Required*): The probability of the observation occurring, given the event is `true`. - **prob_given_false** (*Optional*): The probability of the observation occurring, given the event is `false` can be set as well. If `prob_given_false` is not set, it will default to `1 - prob_given_true`. - **platform** (*Required*): The only supported observation platforms are `state` and `numeric_state`, which are modeled after their corresponding triggers for automations. - - **to_state** (*Required*): THe target start. + - **to_state** (*Required*): The target start. - **probability_threshold** (*Optional*): The probability at which the sensor should trigger to `on`. - **name** (*Optional*): Name of the sensor to use in the frontend. Defaults to `Bayesian Binary`. diff --git a/source/_components/binary_sensor.enocean.markdown b/source/_components/binary_sensor.enocean.markdown index d817fd1ea22..32f3fc3340e 100644 --- a/source/_components/binary_sensor.enocean.markdown +++ b/source/_components/binary_sensor.enocean.markdown @@ -30,7 +30,7 @@ Configuration variables: - **name** (*Optional*): An identifier for the switch in the frontend. - **device_class** (*Optional*): The [type/class](/components/binary_sensor/) of the sensor to set the icon in the frontend. -EnOcean binary sensors only generate 'button_pressed' events. The event data has follwing four fields: +EnOcean binary sensors only generate 'button_pressed' events. The event data has following four fields: - **id**: The ID of the device (see configuration). - **pushed**: `1` for a button press, `0` for a button release. diff --git a/source/_components/binary_sensor.flic.markdown b/source/_components/binary_sensor.flic.markdown index c6a5b19e92b..a392b08b612 100644 --- a/source/_components/binary_sensor.flic.markdown +++ b/source/_components/binary_sensor.flic.markdown @@ -62,7 +62,7 @@ automation: Event data: - **button_name**: The name of the button, that triggered the event. -- **button_address**: The bluetooth address of the button, that triggered the event. +- **button_address**: The Bluetooth address of the button, that triggered the event. - **click_type**: The type of click. Possible values are `single`, `double` and `hold`. - **queued_time**: The amount of time this event was queued on the button, in seconds. diff --git a/source/_components/binary_sensor.hikvision.markdown b/source/_components/binary_sensor.hikvision.markdown index 72dbd613c1d..ae37f2e9797 100644 --- a/source/_components/binary_sensor.hikvision.markdown +++ b/source/_components/binary_sensor.hikvision.markdown @@ -24,7 +24,7 @@ binary_sensor.front_porch_motion binary_sensor.front_port_line_crossing ``` -When used with a NVR device the sensors will be appeneded 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: ``` binary_sensor.home_motion_1 diff --git a/source/_components/binary_sensor.mqtt.markdown b/source/_components/binary_sensor.mqtt.markdown index 722ec499495..c577be56c02 100644 --- a/source/_components/binary_sensor.mqtt.markdown +++ b/source/_components/binary_sensor.mqtt.markdown @@ -35,7 +35,7 @@ Configuration variables: - **device_class** (*Optional*): The [type/class](/components/binary_sensor/) of the sensor to set the icon in the frontend. - **value_template** (*Optional*): Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract a value from the payload. -For a quick check you can use the commandline tools shipped with `mosquitto` to send MQTT messages. Set the state of a sensor manually: +For a quick check you can use the command line tools shipped with `mosquitto` to send MQTT messages. Set the state of a sensor manually: ```bash $ mosquitto_pub -h 127.0.0.1 -t home-assistant/window/contact -m "OFF" diff --git a/source/_components/binary_sensor.mystrom.markdown b/source/_components/binary_sensor.mystrom.markdown index ec61cdd5ca4..9deeb443452 100644 --- a/source/_components/binary_sensor.mystrom.markdown +++ b/source/_components/binary_sensor.mystrom.markdown @@ -40,7 +40,7 @@ binary_sensor: You need to configure every button to make it work with Home Assistant. First connect the Wifi Buttons to your wireless network. Keep in mind that they only support WPS (Wi-FI Protected Setup). Once a button is connected you have three minutes to set the actions for the push patterns. The fastest way is to use `curl`. Check the [documentation](https://mystrom.ch/wp-content/uploads/REST_API_WBP.txt) of the WiFi Button for further details about the implementation (`http://` is replaced by `get://` or `post://`). `action` is the name of the corresponding push pattern (see above). -The endpoint that is recieving the data is `[IP address Home Assistant]:8123/api/mystrom`. +The endpoint that is receiving the data is `[IP address Home Assistant]:8123/api/mystrom`. ```bash $ curl -d "[action]=get://[IP address Home Assistant]:8123/api/mystrom?[action]%3D[ID of the button]" http://[IP address of the button]/api/v1/device/[MAC address of the button] diff --git a/source/_components/binary_sensor.pilight.markdown b/source/_components/binary_sensor.pilight.markdown index f278d116b6c..4ccf5273920 100644 --- a/source/_components/binary_sensor.pilight.markdown +++ b/source/_components/binary_sensor.pilight.markdown @@ -13,7 +13,7 @@ ha_release: 0.44 ha_iot_class: "Local Polling" --- -The `pilight` binary sensor platform implement the [pilight hub](/components/pilight/) binary sensor functionality. Two type of Pilight binary sensor configuration available. A normal sensor which send the on and off state cyclical and a trigger sensor which send only a trigger when an event happend (for example lots of cheap PIR motion detector). +The `pilight` binary sensor platform implement the [pilight hub](/components/pilight/) binary sensor functionality. Two type of Pilight binary sensor configuration available. A normal sensor which send the on and off state cyclical and a trigger sensor which send only a trigger when an event happened (for example lots of cheap PIR motion detector). To enable a Pilight binary sensor in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/binary_sensor.rfxtrx.markdown b/source/_components/binary_sensor.rfxtrx.markdown index d2c2df56c8d..2c72fe07c51 100644 --- a/source/_components/binary_sensor.rfxtrx.markdown +++ b/source/_components/binary_sensor.rfxtrx.markdown @@ -25,7 +25,7 @@ binary_sensor: automatic_add: True ``` -Open your local home-assistant web UI and go to the "states" page. Then make sure to trigger your sensor. You should see a new entity appear in the *Current entites* list, starting with "binary_sensor." and some hexadecimal digits. Those hexadecimal digits are your device id. +Open your local home-assistant web UI and go to the "states" page. Then make sure to trigger your sensor. You should see a new entity appear in the *Current entities* list, starting with "binary_sensor." and some hexadecimal digits. Those hexadecimal digits are your device id. For example: "binary_sensor.0913000022670e013b70". Here your device id is `0913000022670e013b70`. Then you should update your configuration to: @@ -70,7 +70,7 @@ binary_sensor: ## Options for PT-2262 devices under the Lighting4 protocol -When a data packet is transmitted by a PT-2262 device using the Lighting4 protocol, there is no way to automatically extract the device identifier and the command from the packet. Each device has its own id/command length combination and the fields lengths are not included in the data. One device that sends 2 different commands will be seen as 2 devices on Home Assistant. For sur cases, the following options are available in order to circumvent the problem: +When a data packet is transmitted by a PT-2262 device using the Lighting4 protocol, there is no way to automatically extract the device identifier and the command from the packet. Each device has its own id/command length combination and the fields lengths are not included in the data. One device that sends 2 different commands will be seen as 2 devices on Home Assistant. For such cases, the following options are available in order to circumvent the problem: - **data_bits** (*Optional*): Defines how many bits are used for commands inside the data packets sent by the device. - **command_on** (*Optional*): Defines the data bits value that is sent by the device upon an 'On' command. diff --git a/source/_components/binary_sensor.ring.markdown b/source/_components/binary_sensor.ring.markdown index be27ab30d0d..8a7c204df61 100644 --- a/source/_components/binary_sensor.ring.markdown +++ b/source/_components/binary_sensor.ring.markdown @@ -29,6 +29,6 @@ Configuration variables: - **monitored_conditions** array (*Required*): Conditions to display in the frontend. The following conditions can be monitored. - **ding**: Return a boolean value when the doorbell button was pressed. - - **motion**: Return a boolean value when a moviment was detected by the Ring doorbell. + - **motion**: Return a boolean value when a movement was detected by the Ring doorbell. Currently only doorbells are supported by this sensor. diff --git a/source/_components/binary_sensor.velbus.markdown b/source/_components/binary_sensor.velbus.markdown index 579f3c273ef..7c9c9ef62dd 100644 --- a/source/_components/binary_sensor.velbus.markdown +++ b/source/_components/binary_sensor.velbus.markdown @@ -37,6 +37,6 @@ Configuration variables: - **name** (*Required*): Name of the binary sensor. - **module** (*Required*): The hexadecimal module address - **channel** (*Required*): The channel number in the module. - - **is_pushbutton** (*Optional*): Booelan to indicate if a wall switch is a push button or not (default: false) + - **is_pushbutton** (*Optional*): Boolean to indicate if a wall switch is a push button or not (default: false) For hub configuration, see [the Velbus component](/components/velbus/). diff --git a/source/_components/binary_sensor.wink.markdown b/source/_components/binary_sensor.wink.markdown index 9c975eff79b..1203e764394 100644 --- a/source/_components/binary_sensor.wink.markdown +++ b/source/_components/binary_sensor.wink.markdown @@ -34,6 +34,6 @@ The requirement is that you have setup [Wink](/components/wink/). - Dropcam sensors

-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/source/_components/binary_sensor.workday.markdown b/source/_components/binary_sensor.workday.markdown index b063bb5e138..45f1d2386cc 100644 --- a/source/_components/binary_sensor.workday.markdown +++ b/source/_components/binary_sensor.workday.markdown @@ -18,7 +18,7 @@ The `workday` binary sensor indicates, whether the current day is a workday or n To enable the `workday` sensor in your installation, add the following to your `configuration.yaml` file: ```yaml -# Example configuation.yaml entry +# Example configuration.yaml entry binary_sensor: - platform: workday country: DE diff --git a/source/_components/camera.generic.markdown b/source/_components/camera.generic.markdown index 11aecff2e25..69637387a44 100644 --- a/source/_components/camera.generic.markdown +++ b/source/_components/camera.generic.markdown @@ -34,7 +34,7 @@ Configuration variables: - **username** (*Optional*): The username for accessing your camera. - **password** (*Optional*): The password for accessing your camera. - **authentication** (*Optional*): Type for authenticating the requests `basic` (default) or `digest`. -- **limit_refetch_to_url_change** (*Optional*): True/false value (default: false). Limits refetching of the remote image to when the URL changes. Only relevant if using a template to fetch the remote image. +- **limit_refetch_to_url_change** (*Optional*): True/false value (default: false). Limits re-fetching of the remote image to when the URL changes. Only relevant if using a template to fetch the remote image. - **content_type** (*Optional*): Set the content type for the IP camera if it is not a jpg file (default: `image/jpeg`). Use `image/svg+xml` to add a dynamic svg file.

diff --git a/source/_components/camera.mjpeg.markdown b/source/_components/camera.mjpeg.markdown index a307590ca2a..784be3e325d 100644 --- a/source/_components/camera.mjpeg.markdown +++ b/source/_components/camera.mjpeg.markdown @@ -28,7 +28,7 @@ camera: Configuration variables: - **mjpeg_url** (*Required*): The URL your camera serves the video on, eg. http://192.168.1.21:2112/ -- **still_image_url** (*Optional*): The URL for thumbmail picture if camera support that. +- **still_image_url** (*Optional*): The URL for thumbnail picture if camera support that. - **name** (*Optional*): This parameter allows you to override the name of your camera. - **username** (*Optional*): The username for accessing your camera. - **password** (*Optional*): The password for accessing your camera. diff --git a/source/_components/camera.mqtt.markdown b/source/_components/camera.mqtt.markdown index 5e7c8ce07dd..852140ddf9e 100644 --- a/source/_components/camera.mqtt.markdown +++ b/source/_components/camera.mqtt.markdown @@ -13,7 +13,7 @@ ha_release: 0.43 ha_iot_class: depends --- -The `mqtt` camera platform allows you to integrate the content of an image file sent through MQTT into Home Assistant as a camera. Everytime a message under the `topic` in the configuration is received, the image displayed in Home Assistant will also be updated. +The `mqtt` camera platform allows you to integrate the content of an image file sent through MQTT into Home Assistant as a camera. Every time a message under the `topic` in the configuration is received, the image displayed in Home Assistant will also be updated. This can be used with an application or a service capable of sending images through MQTT, for example [Zanzito](https://play.google.com/store/apps/details?id=it.barbaro.zanzito). diff --git a/source/_components/camera.synology.markdown b/source/_components/camera.synology.markdown index d8b9d3f92c2..258bc1e832b 100644 --- a/source/_components/camera.synology.markdown +++ b/source/_components/camera.synology.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Synology Camera" -description: "Instructions how to integrate Synolog Surveillance Station cameras within Home Assistant." +description: "Instructions how to integrate Synology Surveillance Station cameras within Home Assistant." date: 2016-10-13 08:01 sidebar: true comments: false diff --git a/source/_components/climate.ecobee.markdown b/source/_components/climate.ecobee.markdown index a6052218898..4c06cbbf90b 100644 --- a/source/_components/climate.ecobee.markdown +++ b/source/_components/climate.ecobee.markdown @@ -87,7 +87,7 @@ Returns the current temperature measured by the thermostat. | Attribute type | Description | | ---------------| ----------- | -| Integer | Currenly measured temperature +| Integer | Currently measured temperature ### {% linkable_title Attribute `target_temperature` %} @@ -171,7 +171,7 @@ is returned as the user-visible name (rather than the internally used name). ### {% linkable_title Attribute `fan_min_on_time` %} -Returns the current fan mimimum on time. +Returns the current fan minimum on time. | Attribute type | Description | | ---------------| ----------- | @@ -234,7 +234,7 @@ Turns the away mode on or off for the thermostat. ### {% linkable_title Service `set_hold_mode` %} Puts the thermostat into the given hold mode. For 'home', 'away', 'sleep', -and ony other hold based on a reference climate, the +and any other hold based on a reference climate, the target temperature is taken from the reference climate. For 'temp', the current temperature is taken as the target temperature. When None is provided as parameter, the hold_mode is turned off. diff --git a/source/_components/climate.knx.markdown b/source/_components/climate.knx.markdown index 21cf5494101..c2ce30a811c 100644 --- a/source/_components/climate.knx.markdown +++ b/source/_components/climate.knx.markdown @@ -1,7 +1,7 @@ --- layout: page title: "KNX Climate" -description: "Instructions on how to integrate KXN thermostats with Home Assistant." +description: "Instructions on how to integrate KNX thermostats with Home Assistant." date: 2016-06-24 12:00 sidebar: true comments: false @@ -56,7 +56,7 @@ climate: * **controller_status_state_address** (*Optional*) Explicit KNX address for reading HVAC controller status * **operation_mode_frost_protection_address** (*Optional*) KNX address for switching on/off frost/heat protection mode. -* **operation_mode_night_address** (*Optional*) KNX address for switching on/off night nmode. +* **operation_mode_night_address** (*Optional*) KNX address for switching on/off night mode. * **operation_mode_comfort_address** (*Optional*) KNX address for switching on/off comfort mode. `operation_mode_frost_protection_address` / `operation_mode_night_address` / `operation_mode_comfort_address` are not necessary if `operation_mode_address` was specified. diff --git a/source/_components/climate.proliphix.markdown b/source/_components/climate.proliphix.markdown index d2c048762d3..74227c0a98b 100644 --- a/source/_components/climate.proliphix.markdown +++ b/source/_components/climate.proliphix.markdown @@ -36,6 +36,6 @@ Configuration variables: - **username** (*Required*): Username for the thermostat. - **password** (*Required*): Password for the thermostat. -The Proliphix NT Thermostat series are ethernet connected thermostats. They have a local HTTP interface that is based on get/set +The Proliphix NT Thermostat series are Ethernet connected thermostats. They have a local HTTP interface that is based on get/set of OID values. A complete collection of the API is available in this [API documentation](https://github.com/sdague/thermostat.rb/blob/master/docs/PDP_API_R1_11.pdf). diff --git a/source/_components/climate.sensibo.markdown b/source/_components/climate.sensibo.markdown index 71111a88477..9b9771bc42d 100644 --- a/source/_components/climate.sensibo.markdown +++ b/source/_components/climate.sensibo.markdown @@ -27,7 +27,7 @@ climate: Configuration variables: - **api_key** (*Required*): Your API key. -- **id** (*Optional*): A unit ID or a list of IDs. If none specified then all units acessible by the `api_key` will be used. +- **id** (*Optional*): A unit ID or a list of IDs. If none specified then all units accessible by the `api_key` will be used. To get your API key visit diff --git a/source/_components/climate.wink.markdown b/source/_components/climate.wink.markdown index d7fac5462fc..d39c300169a 100644 --- a/source/_components/climate.wink.markdown +++ b/source/_components/climate.wink.markdown @@ -30,6 +30,6 @@ The requirement is that you have setup [Wink](/components/wink/). - Quirky Aros window AC unit

-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/source/_components/cover.knx.markdown b/source/_components/cover.knx.markdown index 43e08e93439..a5a6bf65ac7 100644 --- a/source/_components/cover.knx.markdown +++ b/source/_components/cover.knx.markdown @@ -1,7 +1,7 @@ --- layout: page title: "KNX Cover" -description: "Instructions on how to integrate KXN covers with Home Assistant." +description: "Instructions on how to integrate KNX covers with Home Assistant." date: 2017-06-18 12:00 sidebar: true comments: false diff --git a/source/_components/cover.mqtt.markdown b/source/_components/cover.mqtt.markdown index a19fafb6459..c062119727f 100755 --- a/source/_components/cover.mqtt.markdown +++ b/source/_components/cover.mqtt.markdown @@ -55,7 +55,7 @@ Configuration variables: - **tilt_max** (*Optional*): The maximum tilt value. Default is `100` - **tilt_closed_value** (*Optional*): The value that will be sent on a `close_cover_tilt` command. Default is `0` - **tilt_opened_value** (*Optional*): The value that will be sent on an `open_cover_tilt` command. Default is `100` -- **tilt_status_optimistic** (*Optional*): Flag that determines if tilt works in optimistic mode. Default is `true` if `tilt_status_topic` is not deinfed, else `false` +- **tilt_status_optimistic** (*Optional*): Flag that determines if tilt works in optimistic mode. Default is `true` if `tilt_status_topic` is not defined, else `false` - **tilt_invert_state** (*Optional*): Flag that determines if open/close are flipped; higher values toward closed and lower values toward open. Default is `False` ## {% linkable_title Examples %} diff --git a/source/_components/cover.wink.markdown b/source/_components/cover.wink.markdown index 10cbe4f98ee..758f01b8441 100644 --- a/source/_components/cover.wink.markdown +++ b/source/_components/cover.wink.markdown @@ -31,6 +31,6 @@ The requirement is that you have setup [Wink](/components/wink/). - Chamberlain (Limited functionality) (No Wink hub required)

-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/source/_components/device_tracker.bluetooth_le_tracker.markdown b/source/_components/device_tracker.bluetooth_le_tracker.markdown index ccd8bbddaf3..e0da81a826a 100644 --- a/source/_components/device_tracker.bluetooth_le_tracker.markdown +++ b/source/_components/device_tracker.bluetooth_le_tracker.markdown @@ -17,7 +17,7 @@ ha_release: 0.27 We have received numerous reports that this integration will have a big impact on the performance of the server.

-This tracker discovers new devices on boot and in regular intervals and tracks bluetooth low-energy devices periodically based on interval_seconds value. It is not required to pair the devices with each other. +This tracker discovers new devices on boot and in regular intervals and tracks Bluetooth low-energy devices periodically based on interval_seconds value. It is not required to pair the devices with each other. Devices discovered are stored with 'BLE_' as the prefix for device mac addresses in `known_devices.yaml`. @@ -42,12 +42,12 @@ device_tracker: Configuration variables: -- **device_id** (*Optional*): The device ID for the bluetooth device to be used for tracking. Defaults to `hci0`. +- **device_id** (*Optional*): The device ID for the Bluetooth device to be used for tracking. Defaults to `hci0`. As some BT LE devices change their MAC address regularly, a new device is only discovered when it has been seen 5 times. Some BTLE devices (e.g. fitness trackers) are only visible to the devices that they are paired with. In this case, the BTLE tracker won't see this device. -For running Home Assistant as non root user we can give python3 the missing capabilities to access the bluetooth stack. Quite like setting the setuid bit (see [Stack Exchange](http://unix.stackexchange.com/questions/96106/bluetooth-le-scan-as-non-root) for more information). +For running Home Assistant as non root user we can give python3 the missing capabilities to access the Bluetooth stack. Quite like setting the setuid bit (see [Stack Exchange](http://unix.stackexchange.com/questions/96106/bluetooth-le-scan-as-non-root) for more information). ```bash $ sudo apt-get install libcap2-bin diff --git a/source/_components/device_tracker.bluetooth_tracker.markdown b/source/_components/device_tracker.bluetooth_tracker.markdown index f926d934042..0a2a2d06323 100644 --- a/source/_components/device_tracker.bluetooth_tracker.markdown +++ b/source/_components/device_tracker.bluetooth_tracker.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Bluetooth Tracker" -description: "Instructions for integrating bluetooth tracking within Home Assistant." +description: "Instructions for integrating Bluetooth tracking within Home Assistant." date: 2016-04-10 17:24 sidebar: true comments: false @@ -16,7 +16,7 @@ ha_release: 0.18 This tracker discovers new devices on boot and tracks Bluetooth devices periodically based on `interval_seconds` value. It is not required to pair the devices with each other! Devices discovered are stored with 'bt_' as the prefix for device MAC addresses in `known_devices.yaml`.

-[Hass.io](/hassio/) only supports bluetooth on Raspberry Pi 3 via the Bluetooth BCM43xx (/addons/bluetooth_bcm43xx/) addon. [Hass.io](/hassio/) doesn't support external Bluetooth dongles. +[Hass.io](/hassio/) only supports Bluetooth on Raspberry Pi 3 via the Bluetooth BCM43xx (/addons/bluetooth_bcm43xx/) addon. [Hass.io](/hassio/) doesn't support external Bluetooth dongles.

To use the Bluetooth tracker in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/device_tracker.mysensors.markdown b/source/_components/device_tracker.mysensors.markdown index be28b220e80..14db68931ad 100644 --- a/source/_components/device_tracker.mysensors.markdown +++ b/source/_components/device_tracker.mysensors.markdown @@ -47,7 +47,7 @@ For more information, visit the [serial api] of MySensors. #define SN "GPS Sensor" #define SV "1.0" -// GPS position send interval (in millisectonds) +// GPS position send interval (in milliseconds) #define GPS_SEND_INTERVAL 30000 // The child id used for the gps sensor #define CHILD_ID_GPS 1 diff --git a/source/_components/device_tracker.nmap_tracker.markdown b/source/_components/device_tracker.nmap_tracker.markdown index dcd5841edce..74b40f25eed 100644 --- a/source/_components/device_tracker.nmap_tracker.markdown +++ b/source/_components/device_tracker.nmap_tracker.markdown @@ -18,7 +18,7 @@ As an alternative to the router-based device tracking, it is possible to directl If you're on Debian or Ubuntu, you might have to install the packages for `arp` and `nmap`. Do so by running `$ sudo apt-get install net-tools nmap`. On a Fedora host run `$ sudo dnf -y install nmap`.

-If you are using [Hass.io](/hassio/) then just move forward to the configuration as all requirements are already fullfilled. +If you are using [Hass.io](/hassio/) then just move forward to the configuration as all requirements are already fulfilled.

Host detection is done via Nmap's "fast scan" (`-F`) of the most frequently used 100 ports, with a host timeout of 5 seconds. diff --git a/source/_components/device_tracker.owntracks.markdown b/source/_components/device_tracker.owntracks.markdown index f7fc9192a8a..59e6cca8752 100644 --- a/source/_components/device_tracker.owntracks.markdown +++ b/source/_components/device_tracker.owntracks.markdown @@ -31,7 +31,7 @@ Configuration variables: - **max_gps_accuracy** (*Optional*): Sometimes Owntracks can report GPS location with a very low accuracy (few kilometers). That can trigger false zoning in your Home Assistant installation. With the parameter, you can filter these GPS reports. The number has to be in meter. For example, if you put 200 only GPS report with an accuracy under 200 will be take in account. - **waypoints** (*Optional*): Owntracks users can define [waypoints](http://owntracks.org/booklet/features/waypoints/) (a.k.a regions) which are similar in spirit to Home Assistant zones. If this configuration variable is `True`, the Owntracks users who are in `waypoint_whitelist` can export waypoints from the device and Home Assistant will import them as zone definitions. Defaults to `True`. - **waypoint_whitelist** (*Optional*): A list of user names (as defined for [Owntracks](/components/device_tracker.owntracks/)) who can export their waypoints from Owntracks to Home Assistant. Defaults to all users who are connected to Home Assistant via Owntracks. -- **secret** (*Optional*): [Payload encryption key](http://owntracks.org/booklet/features/encrypt/). This is usable when communicating with a third-party untrusted server or a public server (where anybody can subscribe to any topic). By default the payload is assumed to be unecrypted (although the comunication between Home Assistant and the server might still be encrypted). This feature requires the `libsodium` library to be present. +- **secret** (*Optional*): [Payload encryption key](http://owntracks.org/booklet/features/encrypt/). This is usable when communicating with a third-party untrusted server or a public server (where anybody can subscribe to any topic). By default the payload is assumed to be unencrypted (although the communication between Home Assistant and the server might still be encrypted). This feature requires the `libsodium` library to be present. A full sample configuration for the `owntracks` platform is shown below: @@ -71,13 +71,13 @@ When you exit a zone, Home Assistant will start using location updates to track ### {% linkable_title Using Owntracks regions - forcing Owntracks to update using %}iBeacons When run in the usual *significant changes mode* (which is kind to your phone battery), Owntracks sometimes doesn't update your location as quickly as you'd like when you arrive at a zone. This can be annoying if you want to trigger an automation when you get home. You can improve the situation using iBeacons. -iBeacons are simple bluetooth devices that send out an "I'm here" message. They are supported by IOS and some Android devices. Owntracks explain more [here](http://owntracks.org/booklet/guide/beacons/). +iBeacons are simple Bluetooth devices that send out an "I'm here" message. They are supported by IOS and some Android devices. Owntracks explain more [here](http://owntracks.org/booklet/guide/beacons/). When you enter an iBeacon region, Owntracks will send a `region enter` message to HA as described above. So if you want to have an event triggered when you arrive home, you can put an iBeacon outside your front door. If you set up an OwnTracks iBeacon region called `home` then getting close to the beacon will trigger an update to HA that will set your zone to be `home`. When you exit an iBeacon region HA will switch back to using GPS to determine your location. Depending on the size of your zone, and the accuracy of your GPS location this may change your HA zone. -Sometimes Owntracks will lose connection with an iBeacon for a few seconds. If you name your beacon starting with `-` Owntracks will wait longer before deciding it has exited the beacon zone. HA will ignore the `-` when it matches the Owntracks region with Zones. So if you call your Owntracks region `-home` then HA will recognise it as `home`, but you will have a more stable iBeacon connection. +Sometimes Owntracks will lose connection with an iBeacon for a few seconds. If you name your beacon starting with `-` Owntracks will wait longer before deciding it has exited the beacon zone. HA will ignore the `-` when it matches the Owntracks region with Zones. So if you call your Owntracks region `-home` then HA will recognize it as `home`, but you will have a more stable iBeacon connection. ### {% linkable_title Using Owntracks iBeacons to track devices %} iBeacons don't need to be stationary. You could put one on your key ring, or in your car. diff --git a/source/_components/device_tracker.snmp.markdown b/source/_components/device_tracker.snmp.markdown index 65630b80fc0..6fefef638eb 100644 --- a/source/_components/device_tracker.snmp.markdown +++ b/source/_components/device_tracker.snmp.markdown @@ -13,7 +13,7 @@ ha_release: 0.7.5 --- -A lot WiFi access points and WiFi routers support the Simple Network Management Protocol (SNMP). This is a standardized method for monitoring/manageing network connected devices. SNMP uses a tree-like hierarchy where each node is an object. Many of these objects contain (live) lists of insances and metrics, like network interfaces, disks, and wifi registrations. +A lot WiFi access points and WiFi routers support the Simple Network Management Protocol (SNMP). This is a standardized method for monitoring/manageing network connected devices. SNMP uses a tree-like hierarchy where each node is an object. Many of these objects contain (live) lists of instances and metrics, like network interfaces, disks, and WiFi registrations.

This device tracker needs SNMP to be enabled on the router. It could be that you need to install the SNMP support manually. diff --git a/source/_components/device_tracker.trackr.markdown b/source/_components/device_tracker.trackr.markdown index 19ced73c084..6337b8f7870 100644 --- a/source/_components/device_tracker.trackr.markdown +++ b/source/_components/device_tracker.trackr.markdown @@ -16,7 +16,7 @@ ha_iot_class: "Cloud Polling" The `trackr` platform allows you to detect presence using [TrackR](https://www.thetrackr.com/) devices. -The offical TrackR mobile app handles the tracking of the TrackR devices using your phones bluetooth and GPS. +The official TrackR mobile app handles the tracking of the TrackR devices using your phones Bluetooth and GPS. To integrate TrackR in Home Assistant, add the following section to your `configuration.yaml` file: diff --git a/source/_components/ecobee.markdown b/source/_components/ecobee.markdown index 6b5fd1d61e4..a3e6da2ceef 100644 --- a/source/_components/ecobee.markdown +++ b/source/_components/ecobee.markdown @@ -42,7 +42,7 @@ The PIN can be found from the Home Assistant portal on the Ecobee card or from t - If you do not have an ecobee card, you may be using groups with `default_view` that don't show the card. To get around this you can temporarily comment out the `default_view` section or add the `configurator.ecobee` component to your `default_view` and restart Home Assistant. -Once you enter the PIN on the ecobee site, wait approximately 5 minutes and then click on the **I have authorized the app** link at the bottom of the ecobee popup window. If everything worked correctly, you should now be able to restart Home Assistant again to see the full ecobee card with all of the sensors populated or see the list of sensors in the developer tools. Now you can re-enable your `default_view` (if you had to disable it) and add the ecobee sensors to a group and/or view. +Once you enter the PIN on the ecobee site, wait approximately 5 minutes and then click on the **I have authorized the app** link at the bottom of the ecobee pop-up window. If everything worked correctly, you should now be able to restart Home Assistant again to see the full ecobee card with all of the sensors populated or see the list of sensors in the developer tools. Now you can re-enable your `default_view` (if you had to disable it) and add the ecobee sensors to a group and/or view. To set it up, add the following information to your `configuration.yaml` file: diff --git a/source/_components/foursquare.markdown b/source/_components/foursquare.markdown index c8070eff9a2..10b5d6ebe61 100644 --- a/source/_components/foursquare.markdown +++ b/source/_components/foursquare.markdown @@ -46,7 +46,7 @@ After that, you will get redirected to your `REDIRECT_URL` with the `access_toke The component accepts pushes from Foursquare at `/api/foursquare`. The route does not require authentication. -Foursquare checkin events can be used out of the box to trigger automation actions, e.g.: +Foursquare check-in events can be used out of the box to trigger automation actions, e.g.: ```yaml automation: @@ -69,7 +69,7 @@ Parameters: - **eventId** (*Optional*): The event the user is checking in to. - **shout** (*Optional*): A message about your check-in. The maximum length of this field is 140 characters. - **mentions** (*Optional*): Mentions in your check-in. This parameter is a semicolon-delimited list of mentions. A single mention is of the form "start,end,userid", where start is the index of the first character in the shout representing the mention, end is the index of the first character in the shout after the mention, and userid is the userid of the user being mentioned. If userid is prefixed with "fbu-", this indicates a Facebook userid that is being mention. Character indices in shouts are 0-based. -- **broadcast** (*Optional*): "Who to broadcast this check-in to. Accepts a comma-delimited list of values: private (off the grid) or public (share with friends), facebook share on facebook, twitter share on twitter, followers share with followers (celebrity mode users only), If no valid value is found, the default is public." +- **broadcast** (*Optional*): "Who to broadcast this check-in to. Accepts a comma-delimited list of values: private (off the grid) or public (share with friends), Facebook share on Facebook, twitter share on twitter, followers share with followers (celebrity mode users only), If no valid value is found, the default is public." - **ll** (*Optional*): Latitude and longitude of the user's location. Only specify this field if you have a GPS or other device reported location for the user at the time of check-in. - **llAcc** (*Optional*): Accuracy of the user's latitude and longitude, in meters. - **alt** (*Optional*): Altitude of the user's location, in meters. diff --git a/source/_components/hdmi_cec.markdown b/source/_components/hdmi_cec.markdown index 0bb62b4ead4..03f775e47fa 100644 --- a/source/_components/hdmi_cec.markdown +++ b/source/_components/hdmi_cec.markdown @@ -13,7 +13,7 @@ ha_release: 0.23 ha_iot_class: "Local Push" --- -The `hdmi_cec` component provides services that allow selecting the active device, powering on all devices, setting all devices to standby and creates switch entites for HDMI devices. Devices are defined in the configuration file by associating HDMI port number and a device name. Connected devices that provide further HDMI ports, such as Soundbars and AVRs are also supported. Devices are listed from the perspective of the CEC-enabled Home Assistant device. Any connected device can be listed, regardless of whether it supports CEC. Ideally the HDMI port number on your device will map correctly the CEC physical address. If it does not, use `cec-client` (part of the `libcec` package) to listen to traffic on the CEC bus and discover the correct numbers. +The `hdmi_cec` component provides services that allow selecting the active device, powering on all devices, setting all devices to standby and creates switch entities for HDMI devices. Devices are defined in the configuration file by associating HDMI port number and a device name. Connected devices that provide further HDMI ports, such as sound-bars and AVRs are also supported. Devices are listed from the perspective of the CEC-enabled Home Assistant device. Any connected device can be listed, regardless of whether it supports CEC. Ideally the HDMI port number on your device will map correctly the CEC physical address. If it does not, use `cec-client` (part of the `libcec` package) to listen to traffic on the CEC bus and discover the correct numbers. ## {% linkable_title CEC Setup %} @@ -26,7 +26,7 @@ The computer running Home Assistant must support CEC, and of course be connected [libcec](https://github.com/Pulse-Eight/libcec) must be installed for this component to work. Follow the installation instructions for your environment, provided at the link. `libcec` installs Python 3 bindings by default as a system Python module. If you are running Home Assistant in a [Python virtual environment](/getting-started/installation-virtualenv/), make sure it can access the system module, by either symlinking it or using the `--system-site-packages` flag.

-If you are using [Hass.io](/hassio/) then just move forward to the configuration as all requirements are already fullfilled. +If you are using [Hass.io](/hassio/) then just move forward to the configuration as all requirements are already fulfilled.

#### {% linkable_title Symlinking into virtual environment %} diff --git a/source/_components/homematic.markdown b/source/_components/homematic.markdown index 2f6a245d90e..823dd35aa36 100644 --- a/source/_components/homematic.markdown +++ b/source/_components/homematic.markdown @@ -35,7 +35,7 @@ homematic: Configuration variables (global): - **hosts** (*Required*): Configuration for each host to integrate into Home Assistant. -- **local_ip** (*Optional*): IP of device running Home Assistant. Override autodetected value for exotic network setups. +- **local_ip** (*Optional*): IP of device running Home Assistant. Override auto-detected value for exotic network setups. - **local_port** (*Optional*): Port for connection with Home Assistant. By default it is randomly assigned. Configuration variables (host): @@ -87,7 +87,7 @@ Resolving names can take some time. So when you start Home Assistant you won't s In order to allow communication with multiple hosts or different protocols in parallel (wireless, wired and ip), multiple connections will be established, each to the configured destination. The name you choose for the host has to be unique and limited to ASCII letters. Using multiple hosts has the drawback, that the services (explained below) may not work as expected. Only one connection can be used for services, which limits the devices/variables a service can use to the scope/protocol of the host. -This does *not* affect the entites in Home Assistant. They all use their own connection and work as expected. +This does *not* affect the entities in Home Assistant. They all use their own connection and work as expected. ### {% linkable_title Reading attributes of entities %} diff --git a/source/_components/http.markdown b/source/_components/http.markdown index 749c9fa0e15..0c49db9b4af 100644 --- a/source/_components/http.markdown +++ b/source/_components/http.markdown @@ -26,7 +26,7 @@ http: Configuration variables: - **api_password** (*Optional*): Protect Home Assistant with a password. -- **server_host** (*Optional*): Only listen to incoming requests on specific ip/host (default: accept all) +- **server_host** (*Optional*): Only listen to incoming requests on specific IP/host (default: accept all) - **server_port** (*Optional*): Let you set a port to use. Defaults to 8123. - **base_url** (*Optional*): The URL that Home Assistant is available on the internet. For example: `hass-example.duckdns.org:8123`. Defaults to local IP address. The IOS app finds local installations, if you have an outside URL use this so that you can auto fill when discovered in the app. - **development** (*Optional*): Disable caching and load unvulcanized assets. Useful for Frontend development. @@ -36,7 +36,7 @@ Configuration variables: - **use_x_forwarded_for** (*Optional*): Enable parsing of the `X-Forwarded-For` header, passing on the client's correct IP address in proxied setups. You should only enable this in a trustworthy network environment, as clients passing that header could easily spoof their source IP address. Defaults to False. - **trusted_networks** (*Optional*): List of trusted networks, consisting of IP addresses or networks, that are allowed to bypass password protection when accessing Home Assistant. It should be noted that if you use a reverse proxy, all requests to home assistant, regardless of source, will arrive from the reverse proxy IP address. Therefore in a reverse proxy scenario this option should be used with extreme care. - **ip_ban_enabled** (*Optional*): Flag indicating whether additional IP filtering is enabled. Defaults to False. -- **login_attempts_threshold** (*Optional*): Number of failed login attemt from single IP after which it will be automatically banned if `ip_ban_enabled` is True. Defaults to -1, meaning that no new automatic bans will be added. +- **login_attempts_threshold** (*Optional*): Number of failed login attempt from single IP after which it will be automatically banned if `ip_ban_enabled` is True. Defaults to -1, meaning that no new automatic bans will be added. The sample below shows a configuration entry with possible values: @@ -74,7 +74,7 @@ All [requests](/developers/rest_api/#post-apistatesltentity_id) need to be sent If you want to use Home Assistant to host or serve static files then create a directory called `www` under the `.homeassistant` configuration path. The static files in `.homeassistant/www/` can be accessed by the following URL `http://your.domain:8123/local/`. -If you want to apply additional IP filtering, and automatically ban bruteforce attempts, set `ip_ban_enabled` to `True` and select number of attempts. After first ban file `ip_bans.yaml` will be created in the root configuration folder. It will have IP address and time in UTC when it was added: +If you want to apply additional IP filtering, and automatically ban brute force attempts, set `ip_ban_enabled` to `True` and select number of attempts. After first ban file `ip_bans.yaml` will be created in the root configuration folder. It will have IP address and time in UTC when it was added: ```yaml 127.0.0.1: diff --git a/source/_components/ifttt.manything.markdown b/source/_components/ifttt.manything.markdown index 5113b8bbcb7..7288afb90b9 100644 --- a/source/_components/ifttt.manything.markdown +++ b/source/_components/ifttt.manything.markdown @@ -11,7 +11,7 @@ logo: manything.png ha_category: Camera --- -[Manything](https://manything.com) is a smart app that turns your Android device, iPhone, iPod, or iPad into a wifi camera for monitoring your home, your pets, anything! Comes with live streaming, motion activated alerts, cloud video recording, and more. +[Manything](https://manything.com) is a smart app that turns your Android device, iPhone, iPod, or iPad into a WiFi camera for monitoring your home, your pets, anything! Comes with live streaming, motion activated alerts, cloud video recording, and more. To get manything support, HA will use IFTTT's [Maker Channel](https://ifttt.com/maker) and the [ManyThing Channel](https://ifttt.com/manything). Use the [IFTTT Setup instructions](/components/ifttt/) to activate the IFTTT Platform. diff --git a/source/_components/image_processing.openalpr_local.markdown b/source/_components/image_processing.openalpr_local.markdown index 76e00486710..593a9212614 100644 --- a/source/_components/image_processing.openalpr_local.markdown +++ b/source/_components/image_processing.openalpr_local.markdown @@ -22,7 +22,7 @@ For using inside automation look on [component](/components/image_processing) pa If you want process all data locally, you need version 2.3.1 or higher of the `alpr` commandline tool. -If you don't find binaries for your distribution you can compile from source. Documention of how to build OpenALPR is found [here](https://github.com/openalpr/openalpr/wiki). +If you don't find binaries for your distribution you can compile from source. Documentation of how to build OpenALPR is found [here](https://github.com/openalpr/openalpr/wiki). On a Debian system you can use this `cmake` command to build only the command line tool: diff --git a/source/_components/image_processing.seven_segments.markdown b/source/_components/image_processing.seven_segments.markdown index 4385b2e9993..db0ebf4f1b7 100644 --- a/source/_components/image_processing.seven_segments.markdown +++ b/source/_components/image_processing.seven_segments.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Seven segments display" -description: "Instructions how to use OCR for seven segemnts displays into Home Assistant." +description: "Instructions how to use OCR for seven segments displays into Home Assistant." date: 2017-05-18 08:00 sidebar: true comments: false @@ -18,7 +18,7 @@ ha_iot_class: "Local Polling" The `seven_segments` image processing platform allows you to read physical seven segments displays through Home Assistant. [`ssocr`](https://www.unix-ag.uni-kl.de/~auerswal/ssocr/) is used to extract the value shown on the display which is observed by a [camera](/components/camera/).

-If you are using [Hass.io](/hassio/) then just move forward to the configuration as all requirements are already fullfilled. +If you are using [Hass.io](/hassio/) then just move forward to the configuration as all requirements are already fulfilled.

`ssocr` needs to be available on your system. Check the installation instruction below: @@ -34,7 +34,7 @@ $ sudo make PREFIX=/usr install # On most systems $ make deb # (Optional) This allows you to make a deb so that you apt is aware of ssocr ``` -To enable the OCR of a seven segement display in your installation, add the following to your `configuration.yaml` file: +To enable the OCR of a seven segment display in your installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry @@ -98,7 +98,7 @@ sensor: - platform: template sensors: power_meter: - value_template: '{{ states.image_processing.sevensegement_ocr_seven_segments.state }}' + value_template: '{{ states.image_processing.sevensegment_ocr_seven_segments.state }}' friendly_name: 'Ampere' unit_of_measurement: 'A' ``` diff --git a/source/_components/influxdb.markdown b/source/_components/influxdb.markdown index b34b3147f20..60bd6cac432 100644 --- a/source/_components/influxdb.markdown +++ b/source/_components/influxdb.markdown @@ -109,10 +109,10 @@ optional arguments: If you want to import all the recorded data from your recorder database you can use the data import script. It will read all your state_change events from the database and add them as data-points to the InfluxDB. -You can specify the source database either by pointing the `--config` option to the config directory which includes the default sqlite database or by giving a sqlalchemy connection URI with `--uri`. +You can specify the source database either by pointing the `--config` option to the config directory which includes the default SQLite database or by giving a sqlalchemy connection URI with `--uri`. The writing to InfluxDB is done in batches that can be changed with `--step`. -You can control, which data is imported by using the commandline options `--exclude_entities` and `--exclude_domains`. +You can control, which data is imported by using the command line options `--exclude_entities` and `--exclude_domains`. Both get a comma separated list of either entity-ids or domain names that are excluded from the import. To test what gets imported you can use the `--simulate` option, which disables the actual write to the InfluxDB instance. diff --git a/source/_components/insteon_plm.markdown b/source/_components/insteon_plm.markdown index 8949d4872ed..f28db9b74cd 100644 --- a/source/_components/insteon_plm.markdown +++ b/source/_components/insteon_plm.markdown @@ -63,7 +63,7 @@ unambiguous, but sometimes the component will not be able to guess the actual usage of the device. For example, there might be a table lamp plugged into an INSTEON appliance relay module. By default, this will show as a 'switch' device in Home Assistant, but it really should be a 'light' device. For -exceptions like this, the component supports a device plaform override. You +exceptions like this, the component supports a device platform override. You can set any device (by address) to explicitly use a specific platform if the default is not correct. diff --git a/source/_components/keyboard_remote.markdown b/source/_components/keyboard_remote.markdown index 5c6a3502ad0..f1d80bfa973 100644 --- a/source/_components/keyboard_remote.markdown +++ b/source/_components/keyboard_remote.markdown @@ -69,7 +69,7 @@ automation: ``` ## {% linkable_title Disconnections %} -This component manages disconnections and re-connections of the keyboard, for example in the case of a bluetooth device that turns off automatically to preserve battery. +This component manages disconnections and re-connections of the keyboard, for example in the case of a Bluetooth device that turns off automatically to preserve battery. If the keyboard disconnects, the component will fire an event `keyboard_remote_disconnected`. When the keyboard reconnects, an event `keyboard_remote_connected` will be fired. diff --git a/source/_components/knx.markdown b/source/_components/knx.markdown index 00e5e476576..fed2791d74d 100644 --- a/source/_components/knx.markdown +++ b/source/_components/knx.markdown @@ -1,7 +1,7 @@ --- layout: page title: "KNX" -description: "Instructions on how to integrate KXN components with Home Assistant." +description: "Instructions on how to integrate KNX components with Home Assistant." date: 2016-06-08 12:00 sidebar: true comments: false diff --git a/source/_components/lametric.markdown b/source/_components/lametric.markdown index 0f172ad40de..6431b954542 100644 --- a/source/_components/lametric.markdown +++ b/source/_components/lametric.markdown @@ -18,7 +18,7 @@ There is currently support for the following device types within Home Assistant: - [Notify](/components/notify.lametric) -The LaMetric Time can only be accessed by authorized applications. Therefore, each application that wants to access the LaMetric time needs to be registered at the LaMetric Developer webpage. Sign Up and login to the developer webpage. Click the Create button in the upper right corner, then select Notification App and click Create again. Enter an app name, a description and a redirect URL. Finally, click Save to create the application. For the newly created app you will obtain a client id and a client secret that is required in the following configuration. +The LaMetric Time can only be accessed by authorized applications. Therefore, each application that wants to access the LaMetric time needs to be registered at the LaMetric Developer web page. Sign Up and login to the developer web page. Click the Create button in the upper right corner, then select Notification App and click Create again. Enter an app name, a description and a redirect URL. Finally, click Save to create the application. For the newly created app you will obtain a client id and a client secret that is required in the following configuration. ```yaml # configuration.yaml example diff --git a/source/_components/light.avion.markdown b/source/_components/light.avion.markdown index 4c973d33377..74260e93957 100644 --- a/source/_components/light.avion.markdown +++ b/source/_components/light.avion.markdown @@ -29,12 +29,12 @@ Configuration variables: - **username** (*Optional*): The username used in the Avion app. If username and password are both provided, any associated switches will automatically be added to your configuration. - **password** (*Optional*): The password used in the Avion app. -- **devices** (*Optional*): An optional list of devices with their bluetooth address, a custom name to use in the frontend and the API key. The API key can be obtained by executing the following command: +- **devices** (*Optional*): An optional list of devices with their Bluetooth address, a custom name to use in the frontend and the API key. The API key can be obtained by executing the following command: ``` curl -X POST -H "Content-Type: application/json" -d '{"email": "fakename@example.com", "password": "password"}' https://admin.avi-on.com/api/sessions | jq ``` -with the email and password fields replaced with those used when registering the device via the mobile app. The passphrase field of the output should be used as the API key in the configuration. +with the email and password fields replaced with those used when registering the device via the mobile app. The pass phrase field of the output should be used as the API key in the configuration. If username and password are not supplied, devices must be configured manually like so: diff --git a/source/_components/light.hue.markdown b/source/_components/light.hue.markdown index f6e88086905..0c1e035bfe1 100644 --- a/source/_components/light.hue.markdown +++ b/source/_components/light.hue.markdown @@ -58,9 +58,9 @@ light: ### {% linkable_title Using Hue Groups in Home Assistant %} -The Hue API allows you to group lights. Home Assistant also supports grouping of entities natively, but sometimes it can be usefull to use Hue Groups to group light bulbs. By doing so, Home Assistant only needs to send one API call to change the state of all the bulbs in those groups instead of one call for every light in the group. This causes all the bulbs to change state simultaniously. +The Hue API allows you to group lights. Home Assistant also supports grouping of entities natively, but sometimes it can be useful to use Hue Groups to group light bulbs. By doing so, Home Assistant only needs to send one API call to change the state of all the bulbs in those groups instead of one call for every light in the group. This causes all the bulbs to change state simultaneously. -These Hue Groups can be a `Luminaire`, `Lightsource`, `LightGroup` or `Room`. The `Luminaire` and `Lightsource` can't be created manually since the Hue bridge manages these automatically based on the discovered bulbs. The `Room` and `LightGroup` can be created manually through the API, or the mobile app. A bulb can only exist in one `Room`, but can exist in multiple `LightGroup`. The `LightGroup` can be usefull to link certain bulbs together since. +These Hue Groups can be a `Luminaire`, `Lightsource`, `LightGroup` or `Room`. The `Luminaire` and `Lightsource` can't be created manually since the Hue bridge manages these automatically based on the discovered bulbs. The `Room` and `LightGroup` can be created manually through the API, or the mobile app. A bulb can only exist in one `Room`, but can exist in multiple `LightGroup`. The `LightGroup` can be useful to link certain bulbs together since. The 2nd generation Hue app only allows to create a `Room`. You need to use the first generation app or the API to create a `LightGroup`. @@ -129,4 +129,4 @@ The Hue API doesn't activate scenes directly, only on a Hue Group (typically roo Neither group names or scene names are guaranteed unique in Hue. If you are getting non deterministic behavior, adjust your Hue scenes via the App to be more identifying. -The Hue hub has limitted spaces for scenes, and will delete scenes if new ones get created that would overflow that space. The API docs say this is based on "Least Recently Used". +The Hue hub has limited spaces for scenes, and will delete scenes if new ones get created that would overflow that space. The API docs say this is based on "Least Recently Used". diff --git a/source/_components/light.knx.markdown b/source/_components/light.knx.markdown index 168f4469d65..36aac8596b0 100644 --- a/source/_components/light.knx.markdown +++ b/source/_components/light.knx.markdown @@ -1,7 +1,7 @@ --- layout: page title: "KNX Light" -description: "Instructions on how to integrate KXN lights with Home Assistant." +description: "Instructions on how to integrate KNX lights with Home Assistant." date: 2016-06-24 12:00 sidebar: true comments: false @@ -39,5 +39,5 @@ light: * **state_address**: (*Optional*) separate KNX group address for retrieving the switch state of the light. * **brightness_state_address**: (*Optional*) separate KNX group address for retrieving the dimmed state of the light. -Some KNX devices can change their state internally without any messages on the KXN bus, e.g., if you configure a timer on a channel. The optional `state_address` can be used to inform Home Assistant about these state changes. If a KNX message is seen on the bus addressed to the given state address, this will overwrite the state of the switch object. +Some KNX devices can change their state internally without any messages on the KNX bus, e.g., if you configure a timer on a channel. The optional `state_address` can be used to inform Home Assistant about these state changes. If a KNX message is seen on the bus addressed to the given state address, this will overwrite the state of the switch object. For switching/light actuators that are only controlled by a single group address and can't change their state internally, you don't have to configure the state address. diff --git a/source/_components/light.limitlessled.markdown b/source/_components/light.limitlessled.markdown index a0d0933b253..bc0849cbcaf 100644 --- a/source/_components/light.limitlessled.markdown +++ b/source/_components/light.limitlessled.markdown @@ -18,7 +18,7 @@ ha_release: pre 0.7 ### {% linkable_title Setup %} -Before configuring Home Assistant, make sure you can control your bulbs or LEDs with the MiLight mobile application. Discover your bridge(s) IP address. You can do this via your router or a mobile application like Fing ([android](https://play.google.com/store/apps/details?id=com.overlook.android.fing&hl=en) or [itunes](https://itunes.apple.com/us/app/fing-network-scanner/id430921107?mt=8)). Keep in mind that LimitlessLED bulbs are controlled via groups. You can not control an individual bulb via the bridge, unless it is in a group by itself. Note that you can assign an `rgbw`, `rgbww` and `white` group to the same group number, effectively allowing 12 groups (4 `rgbww`, 4 `rgbw` and 4 `white`) per bridge. +Before configuring Home Assistant, make sure you can control your bulbs or LEDs with the MiLight mobile application. Discover your bridge(s) IP address. You can do this via your router or a mobile application like Fing ([android](https://play.google.com/store/apps/details?id=com.overlook.android.fing&hl=en) or [iTunes](https://itunes.apple.com/us/app/fing-network-scanner/id430921107?mt=8)). Keep in mind that LimitlessLED bulbs are controlled via groups. You can not control an individual bulb via the bridge, unless it is in a group by itself. Note that you can assign an `rgbw`, `rgbww` and `white` group to the same group number, effectively allowing 12 groups (4 `rgbww`, 4 `rgbw` and 4 `white`) per bridge. To add `limitlessled` to your installation, add the following to your `configuration.yaml` file: @@ -71,7 +71,7 @@ Refer to the [light]({{site_root}}/components/light/) documentation for general - *Color*: There are 256 color possibilities along the LimitlessLED color spectrum. Color properties like saturation and lightness can not be used - only Hue can. The only exception is white (which may be warm or cold depending on the type of RGBW bulb). If you select a color with saturation or lightness, Home Assistant will calculate the nearest valid LimitlessLED color. - *Brightness*: Wifi bridge v6 supports 101 brightness steps; older versions only 25. - **White** - - When using a legacy wifi bridge (before v6), you can observe on the MiLight mobile application, you can not select a specific brightness or temperature - you can only step each property up or down. There is no indication of which step you are on. This restriction, combined with the unreliable nature of LimitlessLED transmissions, means that setting white bulb properties is done on a best-effort basis. The only very reliable settings are the minimum and maximum of each property. + - When using a legacy WiFi bridge (before v6), you can observe on the MiLight mobile application, you can not select a specific brightness or temperature - you can only step each property up or down. There is no indication of which step you are on. This restriction, combined with the unreliable nature of LimitlessLED transmissions, means that setting white bulb properties is done on a best-effort basis. The only very reliable settings are the minimum and maximum of each property. - *Temperature*: Wifi bridge v6 supports 101 temperature steps; older versions only 10. - *Brightness*: Wifi bridge v6 supports 101 brightness steps; older versions only 10. - **Transitions** diff --git a/source/_components/light.rflink.markdown b/source/_components/light.rflink.markdown index 4b24c6c1f84..0bd73b588ef 100644 --- a/source/_components/light.rflink.markdown +++ b/source/_components/light.rflink.markdown @@ -80,7 +80,7 @@ light: name: Bedroom Lamp ``` -Any on/off command from any allias ID updates the current state of the light. However when sending a command through the frontend only the primary ID is used. +Any on/off command from any alias ID updates the current state of the light. However when sending a command through the frontend only the primary ID is used. ### {% linkable_title Light types %} diff --git a/source/_components/light.wink.markdown b/source/_components/light.wink.markdown index 0991595fcf0..5e7b74771ed 100644 --- a/source/_components/light.wink.markdown +++ b/source/_components/light.wink.markdown @@ -28,7 +28,7 @@ The requirement is that you have setup [Wink](/components/wink/). - Wink light groups (User created groups of lights)

-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/source/_components/light.x10.markdown b/source/_components/light.x10.markdown index 19e6dbe43cd..7e0a52fd58a 100644 --- a/source/_components/light.x10.markdown +++ b/source/_components/light.x10.markdown @@ -31,5 +31,5 @@ light: Configuration variables: -- **id** (*Required*): Device identifier. Composed of house code und unit id. +- **id** (*Required*): Device identifier. Composed of house code and unit id. - **name** (*Optional*): A friendly name for the device. By default *id* from the device is used. diff --git a/source/_components/light.yeelight.markdown b/source/_components/light.yeelight.markdown index 603527e56e4..426b4754b0b 100644 --- a/source/_components/light.yeelight.markdown +++ b/source/_components/light.yeelight.markdown @@ -48,7 +48,7 @@ Per default the bulb limits the amount of requests per minute to 60, a limitatio

Before trying to control your light through Home Assistant, you have to setup your bulb using Yeelight app. ( [Android](https://play.google.com/store/apps/details?id=com.yeelight.cherry&hl=fr), [IOS](https://itunes.apple.com/us/app/yeelight/id977125608?mt=8) ). In the bulb property, you have to enable "Developer Mode" Developer mode may only be available with the latest firmware installed on your bulb. Firmware can be updated in the application after connecting the bulb. -Determine your bulb ip (using router, software, ping ...) +Determine your bulb IP (using router, software, ping ...)

diff --git a/source/_components/media_player.firetv.markdown b/source/_components/media_player.firetv.markdown index aab8c253e0f..855333def81 100644 --- a/source/_components/media_player.firetv.markdown +++ b/source/_components/media_player.firetv.markdown @@ -1,7 +1,7 @@ --- layout: page title: "FireTV" -description: "Instructions how to integrate FIre-TV into Home Assistant." +description: "Instructions how to integrate Fire-TV into Home Assistant." date: 2015-10-23 18:00 sidebar: true comments: false diff --git a/source/_components/media_player.kodi.markdown b/source/_components/media_player.kodi.markdown index a5297acd749..948e42259db 100644 --- a/source/_components/media_player.kodi.markdown +++ b/source/_components/media_player.kodi.markdown @@ -164,7 +164,7 @@ media_player: method: System.Shutdown ``` -#### Turn on and off the TV with the Kodi JSON-CEC Addon +#### Turn on and off the TV with the Kodi JSON-CEC Add-on For Kodi devices running 24/7 attached to a CEC capable TV (OSMC / OpenElec and systems alike running in Rasperry Pi's, for example), this configuration enables the optimal way to turn on/off the attached TV from Home Assistant while Kodi is always active and ready: diff --git a/source/_components/media_player.spotify.markdown b/source/_components/media_player.spotify.markdown index f6b1cfe51e4..ec347498342 100644 --- a/source/_components/media_player.spotify.markdown +++ b/source/_components/media_player.spotify.markdown @@ -68,7 +68,7 @@ Configuration variables: After the prerequisites and configuration are complete, restart Home Assistant. A **Spotify** configurator element will be available. Follow the instructions to authorize Home Assistant to access your Spotify account. A Spotify media player will then appear. If Spotify prompts you to download a file after completing authorization, discard the download. It is not needed. ## {% linkable_title Sources %} -The sources are based on if you have streamed to these devices before in Spotify. If you don't have any sources, then simply stream from your phone to another device in your house, bluetooth, echo, etc. Once you do the sources will show up in the developer console as a device to cast/stream to. Also know that the devices won't show up in the dev-console as sources unless they are powered on as well. +The sources are based on if you have streamed to these devices before in Spotify. If you don't have any sources, then simply stream from your phone to another device in your house, Bluetooth, echo, etc. Once you do the sources will show up in the developer console as a device to cast/stream to. Also know that the devices won't show up in the dev-console as sources unless they are powered on as well. ## {% linkable_title URI Links For Playlists/Etc %} You can send playlists to spotify via the "media_content_type": "playlist" and "media_content_id": "spotify:user:spotify:playlist:37i9dQZF1DWSkkUxEhrBdF" which are a part of the media_player.play_media service, you can test this from the services control panel in the Home Assistant frontend. diff --git a/source/_components/media_player.universal.markdown b/source/_components/media_player.universal.markdown index a46f438e8c8..1d19ddadcf6 100644 --- a/source/_components/media_player.universal.markdown +++ b/source/_components/media_player.universal.markdown @@ -60,7 +60,7 @@ It is recommended that the command *turn_on*, the command *turn_off*, and the at It is also recommended that the command *volume_up*, the command *volume_down*, the command *volume_mute*, and the attribute *is_volume_muted* all be provided together. The attribute *is_volume_muted* should return either True or the on state when the volume is muted. The *volume_mute* service should toggle the mute setting. -When providing *select_source* as a command, it is recomended to also provide the attributes *source*, and *source_list*. The *source* attribute is the currently select source, while the *source_list* attribute is a list of all available sources. +When providing *select_source* as a command, it is recommended to also provide the attributes *source*, and *source_list*. The *source* attribute is the currently select source, while the *source_list* attribute is a list of all available sources. Below is an example configuration. diff --git a/source/_components/media_player.yamaha.markdown b/source/_components/media_player.yamaha.markdown index 3285d021d7b..cebbd62f3ab 100644 --- a/source/_components/media_player.yamaha.markdown +++ b/source/_components/media_player.yamaha.markdown @@ -41,7 +41,7 @@ A few notes: - Not specifying the host variable will result in automatically searching your network for Yamaha Receivers. It will add a media player device for each one. - For receivers that support more than one zone, Home Assistant will add one media player per zone supported by the player, named "$name Zone 2" and "$name Zone 3". -- In some cases, autodiscovery fails due to a known bug in the receiver's firmware. It is possible to manually specify the receiver's IP address or via it's hostname (if it is discoverably by your DNS) then. +- In some cases, auto-discovery fails due to a known bug in the receiver's firmware. It is possible to manually specify the receiver's IP address or via it's hostname (if it is discoverable by your DNS) then. - Please note: If adding the IP address or hostname manually, you **must** enable network standby on your receiver, or else startup of Home Assistant will hang if you have your receiver switched off. - Currently, this component supports powering on/off, mute, volume control and source selection. Playback controls, for instance play and stop are available for sources that supports it. diff --git a/source/_components/mysensors.markdown b/source/_components/mysensors.markdown index d323ce64897..01037803f40 100644 --- a/source/_components/mysensors.markdown +++ b/source/_components/mysensors.markdown @@ -49,9 +49,9 @@ mysensors: Configuration variables: -- **device** (*Required*): The path to the serial gateway where it is connected to your Home Assistant host, or the address of the tcp ethernet gateway, or `mqtt` to setup the MQTT gateway. Resolving DNS addresses is theoretically supported but not tested. +- **device** (*Required*): The path to the serial gateway where it is connected to your Home Assistant host, or the address of the TCP Ethernet gateway, or `mqtt` to setup the MQTT gateway. Resolving DNS addresses is theoretically supported but not tested. - **baud_rate** (*Optional*): Specifies the baud rate of the connected serial gateway. Default is 115200. -- **tcp_port** (*Optional*): Specifies the port of the connected tcp ethernet gateway. Default is 5003. +- **tcp_port** (*Optional*): Specifies the port of the connected TCP Ethernet gateway. Default is 5003. - **topic_in_prefix** (*Optional*): Set the prefix of the MQTT topic for messages coming from the MySensors gateway in to Home Assistant. Default is an empty string. - **topic_out_prefix** (*Optional*): Set the prefix of the MQTT topic for messages going from Home Assistant out to the MySensors gateway. Default is an empty string. - **debug** (*DEPRECATED*): This option has been deprecated. Please remove this from your config is you have it included. Use the logger component to filter log messages on log level. @@ -88,7 +88,7 @@ The MQTT gateway requires MySensors version 2.0 and only the MQTT client gateway Present a MySensors sensor or actuator, by following these steps: -1. Connect the serial gateway to your computer or the ethernet or MQTT gateway to your network. +1. Connect the serial gateway to your computer or the Ethernet or MQTT gateway to your network. 2. Configure the MySensors component in `configuration.yaml`. 3. Start hass. 4. Write and upload your MySensors sketch to the sensor. Make sure you: diff --git a/source/_components/nest.markdown b/source/_components/nest.markdown index 5483a42eeba..b697d5ab3ea 100644 --- a/source/_components/nest.markdown +++ b/source/_components/nest.markdown @@ -25,7 +25,7 @@ The Nest component is the main component to integrate all [Nest](https://nest.co 5. Click "[Create New Product](https://developers.nest.com/products/new)" 6. Fill in details: - Product name must be unique. We recommend [email] - Home Assistant. - - The description, users, urls can all be anything you want. + - The description, users, URLs can all be anything you want. - Leave the "Redirect URI" Field blank 7. For permissions check every box and if it's an option select the read/write option. - The description requires a specific format to be accepted. diff --git a/source/_components/netatmo.markdown b/source/_components/netatmo.markdown index bc10916cc61..a7b6a30a0c0 100644 --- a/source/_components/netatmo.markdown +++ b/source/_components/netatmo.markdown @@ -56,5 +56,5 @@ That's it. You can copy and paste your new `client id` and `client secret` in yo

-The Home Assistant Netatmo platform has only be tested with the classic indoor, outdoor module and rainmeter. There is no support for the windmeter module at this time because developers does not own these modules. +The Home Assistant Netatmo platform has only be tested with the classic indoor, outdoor module and rain meter. There is no support for the wind meter module at this time because developers does not own these modules.

diff --git a/source/_components/notify.ciscospark.markdown b/source/_components/notify.ciscospark.markdown index db3e736beaf..96bc67c4968 100644 --- a/source/_components/notify.ciscospark.markdown +++ b/source/_components/notify.ciscospark.markdown @@ -16,7 +16,7 @@ The `ciscospark` notification platform allows you to deliver notifications from To use this notification platform you need to get a developer token. To obtain a token visit [Spark for Developers](https://developer.ciscospark.com/index.html) -At this time you also need to specify the `Cisco Spark` `roomid`. The `roomid` can also be found at [Spark for Developers](https://developer.ciscospark.com/index.html). Just look in the Doumentation under Rooms. +At this time you also need to specify the `Cisco Spark` `roomid`. The `roomid` can also be found at [Spark for Developers](https://developer.ciscospark.com/index.html). Just look in the Documentation under Rooms. To enable the Cisco Spark notification in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/notify.slack.markdown b/source/_components/notify.slack.markdown index 88cee6a70e9..1eb10e8189a 100644 --- a/source/_components/notify.slack.markdown +++ b/source/_components/notify.slack.markdown @@ -38,7 +38,7 @@ Configuration variables: - **api_key** (*Required*): The Slack API token to use for sending Slack messages. - **default_channel** (*Required*): The default channel to post to if no channel is explicitly specified when sending the notification message. - **username** (*Optional*): Setting username will allow Home Assistant to post to Slack using the username specified. By default not setting this will post to Slack using the user account or botname that you generated the api_key as. -- **icon** (*Optional*): Use one of the Slack emoji's as an Icon for the supplied username. Slack uses the standard emoji sets used [here](http://www.webpagefx.com/tools/emoji-cheat-sheet/). +- **icon** (*Optional*): Use one of the Slack emojis as an Icon for the supplied username. Slack uses the standard emoji sets used [here](http://www.webpagefx.com/tools/emoji-cheat-sheet/). ### {% linkable_title Slack service data %} diff --git a/source/_components/pilight.markdown b/source/_components/pilight.markdown index 8a2a10b1f5f..cbe219be565 100644 --- a/source/_components/pilight.markdown +++ b/source/_components/pilight.markdown @@ -35,7 +35,7 @@ Configuration variables: - **send_delay** (*Optional*): You can define a send delay as a fraction of seconds if you experience transmission problems when you try to switch multiple switches at once. This can happen when you use a [pilight USB Nano](https://github.com/pilight/pilight-usb-nano) as hardware and switches a whole group of multiple switches on or off. Tested values are between 0.3 and 0.8 seconds depending on the hardware. - **whitelist** (*Optional*): You can define a whitelist to prevent that too many unwanted RF codes (e.g. the neighbours weather station) are put on your HA event bus. All defined subsections have to be matched. A subsection is matched if one of the items are true. -In this example only received RF codes using a daycom or intertechno protocol are put on the event bus and only when the device id is 42. For more possible settings please look at the receiver section of the pilight [API](https://www.pilight.org/development/api/). +In this example only received RF codes using a daycom or Intertechno protocol are put on the event bus and only when the device id is 42. For more possible settings please look at the receiver section of the pilight [API](https://www.pilight.org/development/api/). A full configuration sample could look like the sample below: diff --git a/source/_components/plant.markdown b/source/_components/plant.markdown index 2b77eee4e7e..665921095ab 100644 --- a/source/_components/plant.markdown +++ b/source/_components/plant.markdown @@ -33,11 +33,11 @@ Configuration variables: - **entity_id** (*Required*): Set by you and is used by the component as the `entity_id`. - **sensors** (*Required*): - - **moisture** (*Optional*): Moisture of the plant. Meassured in %. Can have a min and max value set optionally. - - **battery** (*Optional*): Battery level of the plant sensor. Meassured in %. Can only have a min level set optionally. - - **temperature:** (*Optional*): Temperaure of the plant. Meassured in degrees Celcius. Can have a min and max value set optionally. - - **conductivity:** (*Optional*): Conductivity of the plant. Meassured in µS/cm. Can have a min and max value set optionally. - - **brightness:** (*Optional*): Light exposure of the plant. Meassured in Lux. Can have a min and max value set optionally. + - **moisture** (*Optional*): Moisture of the plant. Measured in %. Can have a min and max value set optionally. + - **battery** (*Optional*): Battery level of the plant sensor. Measured in %. Can only have a min level set optionally. + - **temperature:** (*Optional*): Temperature of the plant. Measured in degrees Celsius. Can have a min and max value set optionally. + - **conductivity:** (*Optional*): Conductivity of the plant. Measured in µS/cm. Can have a min and max value set optionally. + - **brightness:** (*Optional*): Light exposure of the plant. Measured in Lux. Can have a min and max value set optionally. - **min_moisture** (*Optional*): Minimum moisture level before triggering a problem. Typical value: 20 - **max_moisture** (*Optional*): Maximum moisture level before triggering a problem. Typical value: 60 - **min_battery** (*Optional*): Minimum battery level before triggering a problem. Typical value: 20 @@ -50,7 +50,7 @@ Configuration variables: ## {% linkable_title Examples %} ### Using plain MQTT sensor to get the data -This is a practial example that uses a multiple of `MQTT sensors` to supply the readings used by the `plant` sensor. +This is a practical example that uses a multiple of `MQTT sensors` to supply the readings used by the `plant` sensor. Another good source of this data would be the [Mi Flora](https://home-assistant.io/components/sensor.miflora/) component. diff --git a/source/_components/remote.harmony.markdown b/source/_components/remote.harmony.markdown index 3ed589b3850..41cc37cdc53 100755 --- a/source/_components/remote.harmony.markdown +++ b/source/_components/remote.harmony.markdown @@ -146,7 +146,7 @@ automation: action: service: remote.send_command data_template: - # using a data template to have if brances for relavant device + # using a data template to have if brances for relevant device # Always the same entity_id - the harmony hub entity_id: remote.bedroom # Always the same command - the Pause key diff --git a/source/_components/remote.itach.markdown b/source/_components/remote.itach.markdown index cdfd5eff7c5..a8860ddbadd 100755 --- a/source/_components/remote.itach.markdown +++ b/source/_components/remote.itach.markdown @@ -14,7 +14,7 @@ ha_release: 0.39 --- -The `itach` remote platform allows you to control IR devices with a [Global Caché iTach Device](https://www.globalcache.com/products/itach/ip2irspecs) and GC-100 devices. The Global Cache IR API are similar accross their product line. See API documentation links at the end of this page. +The `itach` remote platform allows you to control IR devices with a [Global Caché iTach Device](https://www.globalcache.com/products/itach/ip2irspecs) and GC-100 devices. The Global Cache IR API are similar across their product line. See API documentation links at the end of this page. To use your iTach remote in your installation, you will need to know the IR commands for your devices in Pronto hex format and add the following to your `configuration.yaml` file: diff --git a/source/_components/rflink.markdown b/source/_components/rflink.markdown index 4efec4ab993..95c590b6413 100644 --- a/source/_components/rflink.markdown +++ b/source/_components/rflink.markdown @@ -14,9 +14,9 @@ ha_release: 0.38 The `rflink` component support devices that use [RFLink gateway firmware](http://www.nemcon.nl/blog2/), for example the [Nodo RFLink Gateway](https://www.nodo-shop.nl/nl/21-rflink-gateway). RFLink gateway is an Arduino Mega firmware that allows two-way communication with a multitude of RF wireless devices using cheap hardware (Arduino + transceiver). -The 433 Mhz spectrum is used by many manufacturers mostly using their own protocol/standard and includes devices like: light switches, blinds, weather stations, alarms and various other sensors. +The 433 MHz spectrum is used by many manufacturers mostly using their own protocol/standard and includes devices like: light switches, blinds, weather stations, alarms and various other sensors. -RFLink Gateway supports a number of RF frequencies, using a wide range of low-cost hardware. Their website provides details for various RF transmitter, receiver and transceiver modules for 433Mhz, 868Mhz and 2.4 Ghz [here.](http://www.nemcon.nl/blog2/wiring) +RFLink Gateway supports a number of RF frequencies, using a wide range of low-cost hardware. Their website provides details for various RF transmitter, receiver and transceiver modules for 433MHz, 868MHz and 2.4 GHz [here.](http://www.nemcon.nl/blog2/wiring)

Note: Versions later than R44 adds support for Ikea Ansluta, Philips Living Colors Gen1, MySensors devices. @@ -40,7 +40,7 @@ Configuration variables: - **port** (*Required*): The path to RFLink USB/serial device or TCP port in TCP mode. - **host** (*Optional*): Switches to TCP mode, connects to host instead of to USB/serial. -- **wait_for_ack** (*Optional*): Wait for RFLink to ackowledge commands sent before sending new command (slower but more reliable). Defaults to `True` +- **wait_for_ack** (*Optional*): Wait for RFLink to acknowledge commands sent before sending new command (slower but more reliable). Defaults to `True` - **ignore_devices** (*Optional*): List of devices id's to ignore. Supports wildcards (*) at the end. - **reconnect_interval** (*Optional*): Time in seconds between reconnect attempts. @@ -87,7 +87,7 @@ rflink: ### {% linkable_title Ignoring devices %} -RFLink platform can be configured to completely ignore a device on a platform level. This is useful when you have neighbors which also use 433 Mhz technology. +RFLink platform can be configured to completely ignore a device on a platform level. This is useful when you have neighbors which also use 433 MHz technology. For example: @@ -112,14 +112,14 @@ Even though a lot of devices are supported by RFLink, not all have been tested/i ### {% linkable_title Device Incorrectly Identified %} -If you find a device is recognized differently, with different protocols or the ON OFF is swapped or detected as two ON commands, it can be overcome with the RFlink 'RF Signal Learning' mechanism from RFLink Rev 46 (11 March 2017). [Link to further detail.](http://www.nemcon.nl/blog2/faq#RFFind) +If you find a device is recognized differently, with different protocols or the ON OFF is swapped or detected as two ON commands, it can be overcome with the RFLink 'RF Signal Learning' mechanism from RFLink Rev 46 (11 March 2017). [Link to further detail.](http://www.nemcon.nl/blog2/faq#RFFind) ### {% linkable_title Technical overview %} - The`rflink` Python module a asyncio transport/protocol is setup that fires an callback for every (valid/supported) packet received by the RFLink gateway. - This component uses this callback to distribute 'rflink packet events' over Home Assistant's bus which can be subscribed to by entities/platform implementations. -- The platform implementions take care of creating new devices (if enabled) for unsees incoming packet id's. -- Device entities take care of matching to the packet ID, interpreting and performing actions based on the packet contents. Common entitiy logic is maintained in this main component. +- The platform implementation takes care of creating new devices (if enabled) for unseen incoming packet id's. +- Device entities take care of matching to the packet ID, interpreting and performing actions based on the packet contents. Common entity logic is maintained in this main component. ### {% linkable_title Debug logging %} diff --git a/source/_components/satel_integra.markdown b/source/_components/satel_integra.markdown index 7953b1695c5..c882e71c626 100644 --- a/source/_components/satel_integra.markdown +++ b/source/_components/satel_integra.markdown @@ -56,7 +56,7 @@ Configuration variables: - **port** (*Optional*): The port on which the ETHM module listens for clients using integration protocol. Default: `7094` - **partition** (*Optional*): The partition to operate on. Integra can support multiple partitions, this platform only supports one. Default: `1` - **arm_home_mode** (*Optional*): The mode in which arm Satel Integra when 'arm home' is used. Possible options are `1`,`2` or `3`, default being `1`. For more information on what are the differences between them, please refer to Satel Integra manual. -- **zones** (*Optional*): This module does not discover currently which zones are actually in use, so it will only monitor the ones defined in the config. For each zone, a proper ID mus be given as well as it's name (does not need to match the one specified in Satel Integra alarm). 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.* +- **zones** (*Optional*): This module does not discover currently which zones are actually in use, so it will only monitor the ones defined in the config. For each zone, a proper ID must be given as well as it's name (does not need to match the one specified in Satel Integra alarm). 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.* List of all zone IDs can be taken from DloadX program. diff --git a/source/_components/scsgate.markdown b/source/_components/scsgate.markdown index cd53a48c1e3..c70238554ca 100644 --- a/source/_components/scsgate.markdown +++ b/source/_components/scsgate.markdown @@ -13,7 +13,7 @@ ha_release: 0.13 ha_iot_class: "Local Polling" --- -The SCSGate component support the [SCSGate](https://translate.google.com/translate?hl=en&sl=it&tl=en&u=http%3A%2F%2Fguidopic.altervista.org%2Feibscsgt%2Finterface.html) device. This a homebrew device allows to interact with the MyHome system from BTicino/Legrande. +The SCSGate component support the [SCSGate](https://translate.google.com/translate?hl=en&sl=it&tl=en&u=http%3A%2F%2Fguidopic.altervista.org%2Feibscsgt%2Finterface.html) device. This a home-brew device allows to interact with the MyHome system from BTicino/Legrande. To enable SCSGate in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/sensor.arest.markdown b/source/_components/sensor.arest.markdown index 181d9eaa6c3..d8bf05b07c4 100644 --- a/source/_components/sensor.arest.markdown +++ b/source/_components/sensor.arest.markdown @@ -14,7 +14,7 @@ ha_release: pre 0.7 --- -The `arest` sensor platform allows you to get all data from your devices (like Arduinos with a ethernet/wifi connection, the ESP8266, and the Raspberry Pi) running the [aREST](http://arest.io/) RESTful framework. +The `arest` sensor platform allows you to get all data from your devices (like Arduinos with a Ethernet/Wifi connection, the ESP8266, and the Raspberry Pi) running the [aREST](http://arest.io/) RESTful framework. To use your aREST enabled device in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/sensor.bh1750.markdown b/source/_components/sensor.bh1750.markdown index c2bd03c4cfa..754dc91f86e 100644 --- a/source/_components/sensor.bh1750.markdown +++ b/source/_components/sensor.bh1750.markdown @@ -14,7 +14,7 @@ ha_iot_class: "Local Push" --- -The `bh1750` sensor platform allows you to read the ambient light level in lux from a [BH1750FVI sensor](http://cpre.kmutnb.ac.th/esl/learning/bh1750-light-sensor/bh1750fvi-e_datasheet.pdf) connected via [I2c](https://en.wikipedia.org/wiki/I²C) bus (SDA, SCL pins). It allows you to use all the resolution modes of the sensor described in its datasheet. +The `bh1750` sensor platform allows you to read the ambient light level in Lux from a [BH1750FVI sensor](http://cpre.kmutnb.ac.th/esl/learning/bh1750-light-sensor/bh1750fvi-e_datasheet.pdf) connected via [I2c](https://en.wikipedia.org/wiki/I²C) bus (SDA, SCL pins). It allows you to use all the resolution modes of the sensor described in its datasheet. Tested devices: diff --git a/source/_components/sensor.broadlink.markdown b/source/_components/sensor.broadlink.markdown index c6953398668..4d0dae53e9e 100644 --- a/source/_components/sensor.broadlink.markdown +++ b/source/_components/sensor.broadlink.markdown @@ -80,7 +80,7 @@ The pycrypto library needs to be available on your platform. On a typical window The quickest way around this is to use a pre-built binary, e.g. from https://github.com/sfbahr/PyCrypto-Wheels -Be sure to get the correct 64 or 32-bit binary for your system, the full commandline will look something like the sample below for a 64-bit system: +Be sure to get the correct 64 or 32-bit binary for your system, the full command line will look something like the sample below for a 64-bit system: ```bash pip install --use-wheel --no-index --find-links=https://github.com/sfbahr/PyCrypto-Wheels/raw/master/pycrypto-2.6.1-cp35-none-win_amd64.whl pycrypto diff --git a/source/_components/sensor.buienradar.markdown b/source/_components/sensor.buienradar.markdown index 27f6dfd796c..e9706efdafd 100644 --- a/source/_components/sensor.buienradar.markdown +++ b/source/_components/sensor.buienradar.markdown @@ -14,9 +14,9 @@ ha_iot_class: "Cloud Polling" --- -The `buienradar` platform uses [buienradar.nl](http://buienradar.nl/) as an source for current meteorological data for your location. The weather forecast is delivered by Buienradar, who provides a webservice that provides detailed weather information for users in The Netherlands. The relevant weatherstation used will be automatically selected based on the location specified in the Home Assistant configuration (or in the buienradar weather/sensor component). A map of all available weatherstations can be found [here](https://www.google.com/maps/d/embed?mid=1NivHkTGQUOs0dwQTnTMZi8Uatj0). +The `buienradar` platform uses [buienradar.nl](http://buienradar.nl/) as an source for current meteorological data for your location. The weather forecast is delivered by Buienradar, who provides a web service that provides detailed weather information for users in The Netherlands. The relevant weather station used will be automatically selected based on the location specified in the Home Assistant configuration (or in the buienradar weather/sensor component). A map of all available weather stations can be found [here](https://www.google.com/maps/d/embed?mid=1NivHkTGQUOs0dwQTnTMZi8Uatj0). -The selected weatherstation will provide all weather data, with the exception of the forecasted precipitation. The forecasted precipitation data will be retrieved from buienradar using your actual gps-location (and not the location of the nearest weatherstation). +The selected weather station will provide all weather data, with the exception of the forecasted precipitation. The forecasted precipitation data will be retrieved from buienradar using your actual gps-location (and not the location of the nearest weather station). To integrate `buienradar` with Home Assistant, add the following section to your `configuration.yaml` file: @@ -60,10 +60,10 @@ Configuration variables: - **windazimuth**: Where the wind is coming from in degrees, with true north at 0° and progressing clockwise. - **pressure**: The sea-level air pressure in [hPa](https://en.wikipedia.org/wiki/Hectopascal). - **visibility**: Visibility in meters ([m](https://en.wikipedia.org/wiki/Metre)). - - **windgust**: The windspeed of wind gusts ([m/s](https://en.wikipedia.org/wiki/M/s)). + - **windgust**: The wind speed of wind gusts ([m/s](https://en.wikipedia.org/wiki/M/s)). - **precipitation**: The amount of precipitation/rain in mm/h. - - **precipitation_forecast_average**: The average expected precipitation/rain in mm/h within the given timeframe. - - **precipitation_forecast_total**: The total expected precipitation/rain in mm within the given timeframe. The total expected rain in the configured timeframe will be equal to _precipitation_forecast_total_/_timeframe_ mm/min. So, with timeframe configured to 30 minutes and a value of 5, the expected rain is 5 mm in 30 minutes, which is the same as 10 mm/h. If timeframe is set to 90 minutes and a value of 5, the expected rain is 5 mm in 90 minutes, which is equal to 3.3 mm/h. + - **precipitation_forecast_average**: The average expected precipitation/rain in mm/h within the given time-frame. + - **precipitation_forecast_total**: The total expected precipitation/rain in mm within the given time-frame. The total expected rain in the configured time-frame will be equal to _precipitation_forecast_total_/_timeframe_ mm/min. So, with time-frame configured to 30 minutes and a value of 5, the expected rain is 5 mm in 30 minutes, which is the same as 10 mm/h. If time-frame is set to 90 minutes and a value of 5, the expected rain is 5 mm in 90 minutes, which is equal to 3.3 mm/h. - **irradiance**: Sun intensity in Watt per square meter ([W/m2](https://en.wikipedia.org/wiki/W/m2)). - **temperature_1d** [[1d]](#1d): The forecasted temperature (in [C](https://en.wikipedia.org/wiki/Celsius)). - **mintemp_1d** [[1d]](#1d): The forecasted minimum temperature (in [C](https://en.wikipedia.org/wiki/Celsius)). @@ -162,4 +162,4 @@ sensor: ``` [Usage statement:](https://www.buienradar.nl/overbuienradar/gratis-weerdata) -> Buienradar makes free weatherdata available for use by individuals and businesses (website/intranet). The use of the weatherdata is allowed for **non-commercial purposes**. Please refer to the full usage statement linked above to confirm your usage or to request permission. +> Buienradar makes free weather-data available for use by individuals and businesses (website/intranet). The use of the weather-data is allowed for **non-commercial purposes**. Please refer to the full usage statement linked above to confirm your usage or to request permission. diff --git a/source/_components/sensor.cups.markdown b/source/_components/sensor.cups.markdown index fc5e1567db7..6ccaf7f3879 100644 --- a/source/_components/sensor.cups.markdown +++ b/source/_components/sensor.cups.markdown @@ -16,7 +16,7 @@ ha_release: 0.32 The `cups` sensor platform is using the open source printing system [CUPS](https://www.cups.org/) to show details about your printers. -To set up the sensor the "Queue Name" of the printer is needed. The fastest way to get it, is to visit the CUPS webinterface at "http://[IP ADDRESS PRINT SERVER]:631" and go to "Printers". +To set up the sensor the "Queue Name" of the printer is needed. The fastest way to get it, is to visit the CUPS web interface at "http://[IP ADDRESS PRINT SERVER]:631" and go to "Printers".

diff --git a/source/_components/sensor.currencylayer.markdown b/source/_components/sensor.currencylayer.markdown index 29aad210caf..d26955ba01d 100644 --- a/source/_components/sensor.currencylayer.markdown +++ b/source/_components/sensor.currencylayer.markdown @@ -14,7 +14,7 @@ ha_release: 0.32 --- -The `currencylayer` sensor will show you the current exchange rate from [Currencylayer](https://currencylayer.com/) that provides realtime exchange rates for [170 currencies](https://currencylayer.com/currencies). The free account is limited to only USD as a base currency, allows 1000 requests per month, and updates every hour. +The `currencylayer` sensor will show you the current exchange rate from [Currencylayer](https://currencylayer.com/) that provides real-time exchange rates for [170 currencies](https://currencylayer.com/currencies). The free account is limited to only USD as a base currency, allows 1000 requests per month, and updates every hour. Obtain your API key [here](https://currencylayer.com/product) diff --git a/source/_components/sensor.darksky.markdown b/source/_components/sensor.darksky.markdown index a070d2b6783..98360737dc6 100644 --- a/source/_components/sensor.darksky.markdown +++ b/source/_components/sensor.darksky.markdown @@ -41,7 +41,7 @@ Configuration variables: - **api_key** (*Required*): Your API key. - **name** (*Optional*): Additional name for the sensors. Default to platform name. - **forecast** array (*Optional*): List of days in the 7 day forecast you would like to receive data on, starting with tomorrow as day 1. Any `monitored_condition` with a daily forecast by DarkSky will generate a sensor tagged with `_`. -- **latitude** (*Optional*): Latitude coordinate to monitor weather of (required if **longitude** is specificed), defaults to coordinates defined in your `configuration.yaml` +- **latitude** (*Optional*): Latitude coordinate to monitor weather of (required if **longitude** is specified), defaults to coordinates defined in your `configuration.yaml` - **longitude** (*Optional*): Longitude coordinate to monitor weather of (required if **latitude** is specified), defaults to coordinates defined in your `configuration.yaml` - **monitored_conditions** array (*Required*): Conditions to display in the frontend. - **summary**: A human-readable text summary of the current conditions. diff --git a/source/_components/sensor.dwd_weather_warnings.markdown b/source/_components/sensor.dwd_weather_warnings.markdown index 5ac273a7f0a..2965c009260 100644 --- a/source/_components/sensor.dwd_weather_warnings.markdown +++ b/source/_components/sensor.dwd_weather_warnings.markdown @@ -31,7 +31,7 @@ To get the region name: - Find your region here: `https://www.dwd.de/DE/wetter/warnungen_landkreise/warnWetter_node.html?ort=Hamburg` - Verify if you find any warning for your region here: `https://www.dwd.de/DWD/warnungen/warnapp_landkreise/json/warnings.json?jsonp=loadWarnings` -The warning level is between 0 (no danger) and 4 (extrem weather conditions): +The warning level is between 0 (no danger) and 4 (extreme weather conditions): - Warnungen vor extremem Unwetter (Stufe 4) - Unwetterwarnungen (Stufe 3) - Warnungen vor markantem Wetter (Stufe 2) diff --git a/source/_components/sensor.dweet.markdown b/source/_components/sensor.dweet.markdown index 733b04a1a17..fe9697d447d 100644 --- a/source/_components/sensor.dweet.markdown +++ b/source/_components/sensor.dweet.markdown @@ -34,7 +34,7 @@ Configuration variables: ### {% linkable_title Full configuration sample %} -A ful configuration entry could look like the sample below. +A full configuration entry could look like the sample below. ```yaml # Example configuration.yaml entry @@ -48,7 +48,7 @@ sensor: ### {% linkable_title Interacting with Dweet.io %} -You can easily send dweets from the commandline to test your sensor with `curl`. +You can easily send dweets from the command-line to test your sensor with `curl`. ```bash $ curl -H 'Content-Type: application/json' -d '{"temperature": 40, "humidity": 65}' https://dweet.io/dweet/for/ha-sensor diff --git a/source/_components/sensor.eddystone_temperature.markdown b/source/_components/sensor.eddystone_temperature.markdown index 57f61bdcf99..4d5aacbbc25 100644 --- a/source/_components/sensor.eddystone_temperature.markdown +++ b/source/_components/sensor.eddystone_temperature.markdown @@ -47,7 +47,7 @@ sensor: instance: "000000000002" ``` Configuration variables: -- **bt_device_id** (*Optional*): The id of the bluetooth device that should be used for scanning (hci*X*). You can find the correct one using `hcitool dev` (default: 0). +- **bt_device_id** (*Optional*): The id of the Bluetooth device that should be used for scanning (hci*X*). You can find the correct one using `hcitool dev` (default: 0). - **beacons** array (*Required*): The beacons that should be monitored. - **[entry]** (*Required*): Name of the beacon. - **namespace** (*Required*): Namespace ID of the beacon in hexadecimal notation. Must be exactly 20 characters (10 bytes) long. diff --git a/source/_components/sensor.emoncms.markdown b/source/_components/sensor.emoncms.markdown index 16673c163fa..cf11b14dd50 100644 --- a/source/_components/sensor.emoncms.markdown +++ b/source/_components/sensor.emoncms.markdown @@ -92,7 +92,7 @@ sensor: - 120 sensor_names: 5: "feed 1" - 48: "kwh feed" + 48: "kWh feed" 61: "amp feed" 110: "watt feed" ``` diff --git a/source/_components/sensor.envirophat.markdown b/source/_components/sensor.envirophat.markdown index cf899363f7f..0d1c200a6df 100644 --- a/source/_components/sensor.envirophat.markdown +++ b/source/_components/sensor.envirophat.markdown @@ -13,7 +13,7 @@ ha_iot_class: "Local Polling" ha_release: 0.44 --- -The `envirophat` sensor platform allows you to display information collected by an [Enviro pHAT](https://shop.pimoroni.com/products/enviro-phat) add-on board for the Raspberry Pi. The board featues a wide range of sensors, such as: +The `envirophat` sensor platform allows you to display information collected by an [Enviro pHAT](https://shop.pimoroni.com/products/enviro-phat) add-on board for the Raspberry Pi. The board features a wide range of sensors, such as: - BMP280 temperature/pressure sensor - TCS3472 light and RGB colour sensor with two LEDs for illumination @@ -50,7 +50,7 @@ sensor: Configuration variables: - **display_options** (*Optional*) array: List of readings to monitor. Default is monitoring all of them: - - **temperature**: ambient temperature in Celsius. Since the sensor is close to the Raspberry Pi, that migth affect the accuracy of the reading (ie. the Pi might heat up the sensor) + - **temperature**: ambient temperature in Celsius. Since the sensor is close to the Raspberry Pi, that might affect the accuracy of the reading (ie. the Pi might heat up the sensor) - **pressure**: atmospheric pressure in hPa. - **light**: ambient light, as an integer in the 0-65535 range - **light_red**: red color reading scaled to the ambient light, as an integer in the 0-255 range @@ -66,7 +66,7 @@ Configuration variables: - **voltage_1**: voltage reading on Analog In 1 in units of V - **voltage_2**: voltage reading on Analog In 2 in units of V - **voltage_3**: voltage reading on Analog In 3 in units of V -- **use_led** (*Optional*) True / False boolean; Default value is False, declaring that the onboard LEDs are *not* used for the color measurements thus these readings are based on the ambient light. If the value is set to True, the onboard LEDs will blink whenever a reading is taken. +- **use_led** (*Optional*) True / False boolean; Default value is False, declaring that the on-board LEDs are *not* used for the color measurements thus these readings are based on the ambient light. If the value is set to True, the on-board LEDs will blink whenever a reading is taken. ### Notes @@ -101,7 +101,7 @@ Add something like the following to your [customize section](/docs/configuration # Example configuration.yaml entry group: enviro_phat_voltages: - name: Enviro pHAT Volages` + name: Enviro pHAT Voltages` entities: - sensor.voltage_0 - sensor.voltage_1 diff --git a/source/_components/sensor.fido.markdown b/source/_components/sensor.fido.markdown index 1b863d0e5f0..165f52bbf0c 100644 --- a/source/_components/sensor.fido.markdown +++ b/source/_components/sensor.fido.markdown @@ -53,6 +53,6 @@ Configuration variables: - **talk_used**: Talk time used - **talk_limit**: Talk time limit - **talt_remaining**: Talk time remaining - - **other_talk_used**: Other talk time used (It could be internation calls) + - **other_talk_used**: Other talk time used (It could be international calls) - **other_talk_limit**: Other talk time limit - **other_talt_remaining**: Other talk time remaining diff --git a/source/_components/sensor.google_wifi.markdown b/source/_components/sensor.google_wifi.markdown index c2a00ebeaa4..76bb37400a5 100644 --- a/source/_components/sensor.google_wifi.markdown +++ b/source/_components/sensor.google_wifi.markdown @@ -28,11 +28,11 @@ sensor: Configuration variables: -- **host** (*Optional*): The address to retreive status from the router. Defaults to `testwifi.here` (other options include `onhub.here` and your router's IP such as `192.168.86.1`). +- **host** (*Optional*): The address to retrieve status from the router. Defaults to `testwifi.here` (other options include `onhub.here` and your router's IP such as `192.168.86.1`). - **name** (*Optional*): Name to give the Google Wifi sensor. Defaults to `google_wifi`. - **monitored_conditions** array (*Optional*): Defines the data to monitor as sensors. Defaults to all of the listed options below. - **current_version**: Current firmware version of the router. - - **new_version**: Latest availiable firmware version. If router is up-to-date, this value defaults to `Latest`. + - **new_version**: Latest available firmware version. If router is up-to-date, this value defaults to `Latest`. - **uptime**: Days since router has been turned on. - **last_restart**: Date of last restart. Format is `YYYY-MM-DD HH:mm:SS`. - **local_ip**: Local public IP address. diff --git a/source/_components/sensor.hddtemp.markdown b/source/_components/sensor.hddtemp.markdown index d3669c7d76b..8827856b46c 100644 --- a/source/_components/sensor.hddtemp.markdown +++ b/source/_components/sensor.hddtemp.markdown @@ -1,7 +1,7 @@ --- layout: page title: "HDDTemp" -description: "Instructions how to integrate harddrive temperature information into Home Assistant." +description: "Instructions how to integrate hard drive temperature information into Home Assistant." date: 2016-10-28 07:00 sidebar: true comments: false diff --git a/source/_components/sensor.loop_energy.markdown b/source/_components/sensor.loop_energy.markdown index f78fa70d7f2..626aae7de71 100644 --- a/source/_components/sensor.loop_energy.markdown +++ b/source/_components/sensor.loop_energy.markdown @@ -18,7 +18,7 @@ Integrate your [Loop Energy](https://www.your-loop.com/) meter information into The library used to get the data isn't officially supported and the only way to get the keys is to log into loop energy's website and type a command into your browser console. -To do this log into [Loop Energy](https://www.your-loop.com/). Once you're logged in you should be able see see your live readings on the webpage. +To do this log into [Loop Energy](https://www.your-loop.com/). Once you're logged in you should be able see see your live readings on the web page. You can then open your browser's console window, how you do this varies by browser but in Chrome you click on `More Tools / Developer Tools' and click on the console window. You then type: diff --git a/source/_components/sensor.markdown b/source/_components/sensor.markdown index fc8a35d9269..9f446e5266e 100644 --- a/source/_components/sensor.markdown +++ b/source/_components/sensor.markdown @@ -11,6 +11,6 @@ footer: true Sensors are gathering information about states and conditions. -Home Assistant currently supports a wide range of sensors. They are able to display information which are provides by Home assistant directly, are gathered from webservices, and, of course, physical devices. Please check the sidebar for a full list of supported sensor platforms. +Home Assistant currently supports a wide range of sensors. They are able to display information which are provides by Home assistant directly, are gathered from web services, and, of course, physical devices. Please check the sidebar for a full list of supported sensor platforms. diff --git a/source/_components/sensor.metoffice.markdown b/source/_components/sensor.metoffice.markdown index c855095d050..fc47f5f5c9b 100644 --- a/source/_components/sensor.metoffice.markdown +++ b/source/_components/sensor.metoffice.markdown @@ -47,7 +47,7 @@ Configuration variables:

This sensor is an alternative to the [`metoffice`](/components/weather.metoffice/) weather platform. -The weather platform is easier to configure but less customisable. +The weather platform is easier to configure but less customizable.

[datapoint]: http://www.metoffice.gov.uk/datapoint diff --git a/source/_components/sensor.mhz19.markdown b/source/_components/sensor.mhz19.markdown index 0d4d92302b1..25cd6405ce7 100644 --- a/source/_components/sensor.mhz19.markdown +++ b/source/_components/sensor.mhz19.markdown @@ -13,7 +13,7 @@ ha_release: 0.27 ha_iot_class: "Local Polling" --- -The MH-Z19 is a small nondispersive infrared sensor that can measure CO2 level. High CO2 levels can lead to drowsiness, poor concentration, loss of attention or increased heart rate. The CO2 level outside is around 400ppm, but inside levels can reach between 1000 and 5000 ppm. High CO2 levels indicate that you should increase ventilation. +The MH-Z19 is a small non-dispersive infrared sensor that can measure CO2 level. High CO2 levels can lead to drowsiness, poor concentration, loss of attention or increased heart rate. The CO2 level outside is around 400ppm, but inside levels can reach between 1000 and 5000 ppm. High CO2 levels indicate that you should increase ventilation. Check out the [Open Home Automation web site](https://www.open-homeautomation.com/2016/08/24/monitor-co2-levels-in-your-house/) for a quick guide how to connect the sensor to your PC or Raspberry Pi. diff --git a/source/_components/sensor.miflora.markdown b/source/_components/sensor.miflora.markdown index 9d64df6df01..67f6ecd25f3 100644 --- a/source/_components/sensor.miflora.markdown +++ b/source/_components/sensor.miflora.markdown @@ -39,7 +39,7 @@ sensor: ``` - **mac** (*Required*): The MAC address of your sensor. -- **monitored_conditions** array (*Optional*): The paramaters that should be monitored (defaults to monitoring all parameters). +- **monitored_conditions** array (*Optional*): The parameters that should be monitored (defaults to monitoring all parameters). - **moisture**: Moisture in the soil. - **light**: Brightness at the sensor's location. - **temperature**: Temperature at the sensor's location. @@ -51,7 +51,7 @@ sensor: - **timeout** (*Optional*): Define the timeout value in seconds when polling (defaults to 10 if not defined) - **retries** (*Optional*): Define the number of retries when polling (defaults to 2 if not defined) - **cache_value** (*Optional*): Define cache expiration value in seconds (defaults to 1200 if not defined) -- **adapter** (*Optional*): Define the bluetooth adapter to use (defaults to hci0). Run `hciconfig` to get a list of available adapters. +- **adapter** (*Optional*): Define the Bluetooth adapter to use (defaults to hci0). Run `hciconfig` to get a list of available adapters. Note that by default the sensor is only polled once every 15 minutes. This means with the `median: 3` setting will take as least 30 minutes before the sensor will report a value after a Home Assistant restart. As the values usually change very slowly, this isn't a big problem. Reducing polling intervals will have a negative effect on the battery life. diff --git a/source/_components/sensor.mold_indicator.markdown b/source/_components/sensor.mold_indicator.markdown index 4cc9c84833a..74d91d671dc 100644 --- a/source/_components/sensor.mold_indicator.markdown +++ b/source/_components/sensor.mold_indicator.markdown @@ -29,9 +29,9 @@ sensor: Configuration variables: -- **indoor_temp_sensor** (*Required*): The entitiy ID of the indoor temperature sensor. -- **indoor_humidity_sensor** (*Required*): The entitiy ID of the indoor humidity sensor. -- **outdoor_temp_sensor** (*Required*): The entitiy ID of the outdoor temperature sensor. +- **indoor_temp_sensor** (*Required*): The entity ID of the indoor temperature sensor. +- **indoor_humidity_sensor** (*Required*): The entity ID of the indoor humidity sensor. +- **outdoor_temp_sensor** (*Required*): The entity ID of the outdoor temperature sensor. - **calibration_factor** (*Required*): Needs to be calibrated to the critical point in the room. In this case, the weather forecast temperature sensor is used for the outside temperature. diff --git a/source/_components/sensor.mopar.markdown b/source/_components/sensor.mopar.markdown index 940d3d548f7..eef49e8f63a 100644 --- a/source/_components/sensor.mopar.markdown +++ b/source/_components/sensor.mopar.markdown @@ -16,7 +16,7 @@ ha_iot_class: "Cloud Polling" The `mopar` sensor provides the following for owners of FCA vehicles with a uConnect subscription: -- Sensor per vehicle with vehicle health report and other metadata +- Sensor per vehicle with vehicle health report and other meta-data - Service for remote commands: Lock/unlock, Engine on/off, Horn & lights Be sure you have a [mopar.com](http://mopar.com) account with your vehicle(s) registered by VIN. You must also have a current uConnect subscription. diff --git a/source/_components/sensor.mvglive.markdown b/source/_components/sensor.mvglive.markdown index 8d8dad582ae..d3b10f18822 100644 --- a/source/_components/sensor.mvglive.markdown +++ b/source/_components/sensor.mvglive.markdown @@ -34,7 +34,7 @@ Configuration variables: - **lines** (*Optional*): One or more line numbers, e.g. 'U2' or ['U2','U8','N41'] - **products** (*Optional*): One or more modes of transport, defaults to all 4 modes ['U-Bahn', 'Tram', 'Bus', 'S-Bahn']. - **timeoffset** (*Optional*): Do not display departures leaving sooner than this number of minutes (defaults to 0). Useful if you are a couple of minutes away from the stop. - - **name** (*Optional*): You can customise the name of the sensor, which defaults to the station name. + - **name** (*Optional*): You can customize the name of the sensor, which defaults to the station name. ## {% linkable_title Examples %} ### {% linkable_title Full configuration %} diff --git a/source/_components/sensor.mysensors.markdown b/source/_components/sensor.mysensors.markdown index 6324f833db7..06d90e74f87 100644 --- a/source/_components/sensor.mysensors.markdown +++ b/source/_components/sensor.mysensors.markdown @@ -64,7 +64,7 @@ S_WATER_QUALITY | V_TEMP, V_PH, V_ORP, V_EC Some sensor value types are not specific for a certain sensor type. These do not have a default unit of measurement in Home Assistant. For example, the V_LEVEL type can be used for different sensor types, dust, sound, vibration etc. -By using V_UNIT_PREFIX, it's possible to set a custom unit for any sensor. The string value that is sent for V_UNIT_PREFIX will be used in preference to any other unit of measurement, for the defined sensors. V_UNIT_PREFIX can't be used as a standalone sensor value type. Sending a supported value type and value from the tables above is also required. V_UNIT_PREFIX is available with MySensors version 1.5 and later. +By using V_UNIT_PREFIX, it's possible to set a custom unit for any sensor. The string value that is sent for V_UNIT_PREFIX will be used in preference to any other unit of measurement, for the defined sensors. V_UNIT_PREFIX can't be used as a stand-alone sensor value type. Sending a supported value type and value from the tables above is also required. V_UNIT_PREFIX is available with MySensors version 1.5 and later. For more information, visit the [serial api] of MySensors. diff --git a/source/_components/sensor.netatmo.markdown b/source/_components/sensor.netatmo.markdown index e92471bdb15..14e71e985fe 100644 --- a/source/_components/sensor.netatmo.markdown +++ b/source/_components/sensor.netatmo.markdown @@ -42,7 +42,7 @@ sensor: Configuration variables: - **station** (*Optional*): The name of the weather station. Needed if several stations are associated with the account. -- **modules** (*Required*): Modules to use. Multiple entries allowed. Please checkthe next section about how to retrieve the module names. +- **modules** (*Required*): Modules to use. Multiple entries allowed. Please check the next section about how to retrieve the module names. - **module_name** array (*Required*): Name of the module. - **temperature**: Current temperature. - **co2**: CO2 concentration in ppm. diff --git a/source/_components/sensor.nzbget.markdown b/source/_components/sensor.nzbget.markdown index 6ca6fb85274..ad05e14fd0c 100644 --- a/source/_components/sensor.nzbget.markdown +++ b/source/_components/sensor.nzbget.markdown @@ -36,7 +36,7 @@ Configuration variables: - **name** (*Optional*): The prefix to use for your sensor. Defaults to NZBGet. - **username** (*Optional*): The username to access your NZBGet installation. - **password** (*Optional*): The password to access your NZBGet installation. -- **monitored_variables** arrary (*Required*): List of monitored details. +- **monitored_variables** array (*Required*): List of monitored details. - **article_cache**: Number of cached articles. - **average_download_rate**: Average download rate - **download_paused**: Paused downloads diff --git a/source/_components/sensor.openhardwaremonitor.markdown b/source/_components/sensor.openhardwaremonitor.markdown index f0080919b0b..3692a8cf141 100644 --- a/source/_components/sensor.openhardwaremonitor.markdown +++ b/source/_components/sensor.openhardwaremonitor.markdown @@ -32,5 +32,5 @@ Configuration variables:

OpenHardwareMonitor must be running on the host, with "Remote web server" active. -You also need to open an inbound port for (TPC 8085) in the advanced firewall settings. +You also need to open an inbound port for (TCP 8085) in the advanced firewall settings.

diff --git a/source/_components/sensor.pushbullet.markdown b/source/_components/sensor.pushbullet.markdown index 18d9007b393..df04990f68a 100644 --- a/source/_components/sensor.pushbullet.markdown +++ b/source/_components/sensor.pushbullet.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Pushbullet Mirrors" -description: "Instructions how to read user pushes in Home Assitant" +description: "Instructions how to read user pushes in Home Assistant" date: 2017-04-20 16:44 sidebar: true comments: false diff --git a/source/_components/sensor.radarr.markdown b/source/_components/sensor.radarr.markdown index b2e957d95bf..78ca33d041d 100644 --- a/source/_components/sensor.radarr.markdown +++ b/source/_components/sensor.radarr.markdown @@ -37,7 +37,7 @@ Configuration variables: - **diskspace**: The available disk space. - **status**: The current system status information. - **days** (*Optional*): How many days to look ahead for the upcoming sensor, 1 means today only. Defaults to 1. -- **include_paths** (*Optional*): Array of filepaths to include when calculating diskspace. Leave blank to include all. +- **include_paths** (*Optional*): Array of file paths to include when calculating diskspace. Leave blank to include all. - **unit**: (*Optional*): The unit to display disk space in. Defaults to GB. - **ssl**: boolean (*Optional*): Whether or not to use SSL for Radarr. diff --git a/source/_components/sensor.scrape.markdown b/source/_components/sensor.scrape.markdown index e752a521ce2..6f48598d961 100644 --- a/source/_components/sensor.scrape.markdown +++ b/source/_components/sensor.scrape.markdown @@ -14,7 +14,7 @@ ha_iot_class: "Cloud Polling" --- -The `scrape` sensor platform is scraping information from websites. The sensor loads a HTML page and gives you the option to search and split out a value. As this is not a full-blown web scraper like [scrapy](https://scrapy.org/), it will most likely only work with simple webpages and it can be time-consuming to get the right section. +The `scrape` sensor platform is scraping information from websites. The sensor loads a HTML page and gives you the option to search and split out a value. As this is not a full-blown web scraper like [scrapy](https://scrapy.org/), it will most likely only work with simple web pages and it can be time-consuming to get the right section. To enable this sensor, add the following lines to your `configuration.yaml` file: diff --git a/source/_components/sensor.sensehat.markdown b/source/_components/sensor.sensehat.markdown index ae552a92445..ae270f052fb 100644 --- a/source/_components/sensor.sensehat.markdown +++ b/source/_components/sensor.sensehat.markdown @@ -104,7 +104,7 @@ group: ### Directions for installing on Raspberry Pi All-In-One installer and HASSbian: -Here are the steps to make the _SenseHAT_ sensor work _successfully_ with the virtual enviroment versions. +Here are the steps to make the _SenseHAT_ sensor work _successfully_ with the virtual environment versions. #### Install SenseHAT package to _homeassistant_venv_ ```bash diff --git a/source/_components/sensor.skybeacon.markdown b/source/_components/sensor.skybeacon.markdown index f7fd535b3bd..d4e95bb97ff 100644 --- a/source/_components/sensor.skybeacon.markdown +++ b/source/_components/sensor.skybeacon.markdown @@ -27,7 +27,7 @@ sensor: ``` - **mac** (*Required*): The MAC address of your sensor. You can find this be running `hcitool lescan` from command line. -- **monitored_conditions** array (*Required*): The paramaters that should be monitored. +- **monitored_conditions** array (*Required*): The parameters that should be monitored. - **temperature**: Temperature at the sensor's location. - **humidity**: Humidity at the sensor's location. diff --git a/source/_components/sensor.sonarr.markdown b/source/_components/sensor.sonarr.markdown index 8fabbd6bcc2..5f4d437c02b 100644 --- a/source/_components/sensor.sonarr.markdown +++ b/source/_components/sensor.sonarr.markdown @@ -40,7 +40,7 @@ Configuration variables: - **urlbase** (*Optional*): The base URL Sonarr is running under. Defaults to `/`. - **days** (*Optional*): How many days to look ahead for the upcoming sensor, 1 means today only. Defaults to 1. -- **include_paths** (*Optional*): Array of filepaths to include when calculating diskspace. Leave blank to include all. +- **include_paths** (*Optional*): Array of file paths to include when calculating diskspace. Leave blank to include all. - **unit**: (*Optional*): The unit to display disk space in. Defaults to GB. - **ssl**: boolean (*Optional*): Whether or not to use SSL for Sonarr. diff --git a/source/_components/sensor.systemmonitor.markdown b/source/_components/sensor.systemmonitor.markdown index 0cf101c08c0..3ec9bbcb338 100644 --- a/source/_components/sensor.systemmonitor.markdown +++ b/source/_components/sensor.systemmonitor.markdown @@ -80,7 +80,7 @@ sensor: arg: 'Local Area Connection' ``` -If you need to use some other interface, open a commandline prompt and type `ipconfig` to list all interface names. For example a wireless connection output from `ifconfig` might look like: +If you need to use some other interface, open a command line prompt and type `ipconfig` to list all interface names. For example a wireless connection output from `ifconfig` might look like: ```bash Wireless LAN adapter Wireless Network Connection: diff --git a/source/_components/sensor.tcp.markdown b/source/_components/sensor.tcp.markdown index 0267007d9fa..1d27c668827 100644 --- a/source/_components/sensor.tcp.markdown +++ b/source/_components/sensor.tcp.markdown @@ -67,7 +67,7 @@ sensor: ### {% linkable_title hddtemp %} -The tool `hddtemp` collects the temperature of your harddisks. +The tool `hddtemp` collects the temperature of your hard disks. ```bash $ hddtemp diff --git a/source/_components/sensor.thinkingcleaner.markdown b/source/_components/sensor.thinkingcleaner.markdown index 2b1f54b03b9..d5c681ff736 100644 --- a/source/_components/sensor.thinkingcleaner.markdown +++ b/source/_components/sensor.thinkingcleaner.markdown @@ -13,7 +13,7 @@ ha_iot_class: "Local Poll" ha_release: 0.18 --- -The `thinkingcleaner` sensor platform simple displays information about your [Thinking Cleaner](http://www.thinkingcleaner.com) addon. +The `thinkingcleaner` sensor platform simple displays information about your [Thinking Cleaner](http://www.thinkingcleaner.com) add-on. To enable this sensor in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/sensor.torque.markdown b/source/_components/sensor.torque.markdown index 914e46e66bd..87ff9e0eca2 100644 --- a/source/_components/sensor.torque.markdown +++ b/source/_components/sensor.torque.markdown @@ -29,8 +29,8 @@ Under the **Logging Preferences** header: Under the **Realtime Web Upload** header: -- Check **Upload to webserver**. -- Enter `http://HOST:PORT/api/torque?api_password=YOUR_PASSWORD` as the **Webserver URL**, where `HOST` and `PORT` are your externally accessible Home Assistant HTTP host and port and YOUR_PASSWORD is your Home Assistant's [API password](/components/http/). It highly recommended that you protect your Home Assistant instance with [SSL/TSL](/docs/ecosystem/certificates/). +- Check **Upload to web-server**. +- Enter `http://HOST:PORT/api/torque?api_password=YOUR_PASSWORD` as the **Web-server URL**, where `HOST` and `PORT` are your externally accessible Home Assistant HTTP host and port and YOUR_PASSWORD is your Home Assistant's [API password](/components/http/). It highly recommended that you protect your Home Assistant instance with [SSL/TSL](/docs/ecosystem/certificates/). - Enter an email address in **User Email Address**. - Optionally set the **Web Logging Interval**. The 2-second default may quickly fill up the Home Assistant history database. diff --git a/source/_components/sensor.wink.markdown b/source/_components/sensor.wink.markdown index a67e3c2df42..5a54a704243 100644 --- a/source/_components/sensor.wink.markdown +++ b/source/_components/sensor.wink.markdown @@ -30,6 +30,6 @@ The requirement is that you have setup [Wink](/components/wink/). - Quirky refuel propane tank monitor (No Wink hub required)

-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/source/_components/sensor.wunderground.markdown b/source/_components/sensor.wunderground.markdown index d3b3d266127..4183dfa0b08 100644 --- a/source/_components/sensor.wunderground.markdown +++ b/source/_components/sensor.wunderground.markdown @@ -37,7 +37,7 @@ Configuration variables: - **api_key** (*Required*): The API key for Weather Underground. See above for details. - **pws_id** (*Optional*): You can enter a Personal Weather Station ID. The current list of Wunderground PWS stations is available [here](https://www.wunderground.com/weatherstation/ListStations.asp). If you do not enter a PWS ID, the current location information (latitude and longitude) from your `configuration.yaml` will be used to display weather conditions. - **lang** (*Optional*): Specify the language that the API returns. The current list of all Wunderground language codes is available [here](https://www.wunderground.com/weather/api/d/docs?d=language-support). If not specified, it defaults to English (EN). -- **latitude** (*Optional*): Latitude coordinate to monitor weather of (required if **longitude** is specificed). Defaults to coordinates defined in your `configuration.yaml`. +- **latitude** (*Optional*): Latitude coordinate to monitor weather of (required if **longitude** is specified). Defaults to coordinates defined in your `configuration.yaml`. - **longitude** (*Optional*): Longitude coordinate to monitor weather of (required if **latitude** is specified). Defaults to coordinates defined in your `configuration.yaml`. - **monitored_conditions** array (*Required*): Conditions to display in the frontend. The following conditions can be monitored. - **alerts**: Current severe weather advisories @@ -56,22 +56,22 @@ Configuration variables: - **precip_today_in**: Total precipitation in inches - **precip_today_metric**: Total precipitation in metric units - **precip_today_string**: Text summary of precipitation today - - **precip_1d_mm** [[1d]](#1d): Forecasted precipitation intensity in milimeters + - **precip_1d_mm** [[1d]](#1d): Forecasted precipitation intensity in millimeters - **precip_1d_in** [[1d]](#1d): Forecasted precipitation intensity in inches - **precip_1d** [[1d]](#1d): Forecasted precipitation probability in % - **pressure_in**: Atmospheric air pressure in inches - **pressure_mb**: Atmospheric air pressure in millibars - - **pressure_trend**: Atmospheric air presure trend signal (+/-) + - **pressure_trend**: Atmospheric air pressure trend signal (+/-) - **relative_humidity**: Relative humidity - **station_id**: Your personal weather station (PWS) ID - **solarradiation**: Current levels of solar radiation - - **temperature_string**: Temperature text combinding Fahrenheit and Celsius + - **temperature_string**: Temperature text combining Fahrenheit and Celsius - **temp_c**: Current temperature in Celsius - **temp_f**: Current temperature in Fahrenheit - - **temp_high_record_c**: Maximum temperature meassured in Celsius - - **temp_high_record_f**: Maximum temperature meassured in Fahrenheit - - **temp_low_record_c**: Minimal temperature meassured in Celsius - - **temp_low_record_f**: Minimal temperature meassured in Fahrenheit + - **temp_high_record_c**: Maximum temperature measured in Celsius + - **temp_high_record_f**: Maximum temperature measured in Fahrenheit + - **temp_low_record_c**: Minimal temperature measured in Celsius + - **temp_low_record_f**: Minimal temperature measured in Fahrenheit - **temp_high_avg_c**: Average high for today in Celsius - **temp_high_avg_f**: Average high for today in Fahrenheit - **temp_low_avg_c**: Average low for today in Celsius diff --git a/source/_components/sensor.zabbix.markdown b/source/_components/sensor.zabbix.markdown index 9a3a123a8ab..daf65e1a784 100644 --- a/source/_components/sensor.zabbix.markdown +++ b/source/_components/sensor.zabbix.markdown @@ -36,5 +36,5 @@ Configuration variables: - **triggers** array(*Required*): Specifies that this sensor is for Zabbix 'triggers'. In the future there will be other Zabbix sensors. - **name** (*Optional*): Allows you to specify the name for the Sensor, otherwise the host name, as stored in Zabbix, is used. This is useful when you are specifying a list of hostids to monitor as a single count. - **hostids** (*Optional*): This is a list of Zabbis hostids that we want to filter our count on. -- **individual** (*Optional*): A 'true'/'false' to specify whether we should show individual sensors when a list of hostsids is provided. If false, the sensor state will be the count of all triggers for the specified hosts (or all hosts within the Zabbix instance, if hostids isn't provided). +- **individual** (*Optional*): A 'true'/'false' to specify whether we should show individual sensors when a list of hostids is provided. If false, the sensor state will be the count of all triggers for the specified hosts (or all hosts within the Zabbix instance, if hostids isn't provided). diff --git a/source/_components/sensor.zamg.markdown b/source/_components/sensor.zamg.markdown index c91d90106cc..9c6558a5693 100644 --- a/source/_components/sensor.zamg.markdown +++ b/source/_components/sensor.zamg.markdown @@ -15,7 +15,7 @@ ha_iot_class: "Cloud Polling" The `zamg` platform uses meteorological details published by the Austrian weather service [Zentralanstalt für Meteorologie und Geodynamik (ZAMG)](https://www.zamg.ac.at). -Only observations for capital cities are publically available. You can check the list of stations in [CSV format](http://www.zamg.ac.at/ogd). +Only observations for capital cities are publicly available. You can check the list of stations in [CSV format](http://www.zamg.ac.at/ogd). To add ZAMG to your installation, add the following to your `configuration.yaml` file: @@ -29,7 +29,7 @@ Configuration variables: - **station_id** (*Optional*): The ID number for a supported ZAMG station. - **name** (*Optional*): Additional name for the sensors. Defaults to platform name. -- **latitude** (*Optional*): Latitude coordinate to monitor weather of (required if **longitude** is specificed). Defaults to coordinates defined in your `configuration.yaml` file. +- **latitude** (*Optional*): Latitude coordinate to monitor weather of (required if **longitude** is specified). Defaults to coordinates defined in your `configuration.yaml` file. - **longitude** (*Optional*): Longitude coordinate to monitor weather of (required if **latitude** is specified). Defaults to coordinates defined in your `configuration.yaml` file. - **monitored_conditions** array (*Optional*): Conditions to display in the frontend. - **pressure**: Pressure at station level @@ -58,5 +58,5 @@ sensor: ```

-This sensor is an alternative to the [`zamg`](/components/weather.zamg/) weather platform. The `zamg` weather platform is easier to configure but less customisable. +This sensor is an alternative to the [`zamg`](/components/weather.zamg/) weather platform. The `zamg` weather platform is easier to configure but less customizable.

diff --git a/source/_components/sensor.zha.markdown b/source/_components/sensor.zha.markdown index df15439d4ca..c32879d35cd 100644 --- a/source/_components/sensor.zha.markdown +++ b/source/_components/sensor.zha.markdown @@ -12,4 +12,4 @@ ha_category: Sensor ha_iot_class: "Local Polling" --- -To get your ZigBee sensors working with Home Assistant, follow theminstructions for the general [ZigBee Home Automationmcomponent](/components/zha/). +To get your ZigBee sensors working with Home Assistant, follow the instructions for the general [ZigBee Home Automation Component](/components/zha/). diff --git a/source/_components/sun.markdown b/source/_components/sun.markdown index 4e34e985e30..8de87f43be5 100644 --- a/source/_components/sun.markdown +++ b/source/_components/sun.markdown @@ -22,7 +22,7 @@ sun: Configuration variables: -- **elevation** (*Optional*): The (physical) elevation of your location, in metres above sea level. Defaults to the `elevation` in `configuration.yaml`, which is retrieved from Google Maps if not set. +- **elevation** (*Optional*): The (physical) elevation of your location, in meters above sea level. Defaults to the `elevation` in `configuration.yaml`, which is retrieved from Google Maps if not set.

diff --git a/source/_components/switch.anel_pwrctrl.markdown b/source/_components/switch.anel_pwrctrl.markdown index 5e2801fb137..fbd3023d3f8 100644 --- a/source/_components/switch.anel_pwrctrl.markdown +++ b/source/_components/switch.anel_pwrctrl.markdown @@ -40,4 +40,4 @@ Configuration variables: - **username** (*Required*): The username for your device. - **password** (*Required*): The password for your device. -

If no **host** is given the platform will try to autodiscover all devices on the network, that are listening on the given **port_recv**.

+

If no **host** is given the platform will try to auto-discover all devices on the network, that are listening on the given **port_recv**.

diff --git a/source/_components/switch.arest.markdown b/source/_components/switch.arest.markdown index a668611b16e..677866a13b0 100644 --- a/source/_components/switch.arest.markdown +++ b/source/_components/switch.arest.markdown @@ -13,7 +13,7 @@ ha_iot_class: "Local Polling" ha_release: 0.16 --- -The `arest` switch platform allows you to toggle pins of your devices (like Arduino boards with a ethernet/wifi connection, ESP8266 based devices, and the Raspberry Pi) running the [aREST](http://arest.io/) RESTful framework. +The `arest` switch platform allows you to toggle pins of your devices (like Arduino boards with a Ethernet/Wifi connection, ESP8266 based devices, and the Raspberry Pi) running the [aREST](http://arest.io/) RESTful framework. To use your aREST enabled device with pins in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/switch.broadlink.markdown b/source/_components/switch.broadlink.markdown index 323208deac3..8f733a6445b 100644 --- a/source/_components/switch.broadlink.markdown +++ b/source/_components/switch.broadlink.markdown @@ -184,7 +184,7 @@ First get or learn all the remotes you want to add to Home Assistant in E-Contro 3. `sudo python setup.py install` 7. Test the codes -Use the `sendcode` script you have already downloded to test the codes you got from the device. +Use the `sendcode` script you have already downloaded to test the codes you got from the device. You need to edit the script with your RM Pro IP Address and MAC Address and with the code in HEX format. When run the script, you know the code works when get message . Code sent... diff --git a/source/_components/switch.command_line.markdown b/source/_components/switch.command_line.markdown index 5c8574118ea..cdb5162ca2a 100644 --- a/source/_components/switch.command_line.markdown +++ b/source/_components/switch.command_line.markdown @@ -48,7 +48,7 @@ In this section you find some real life examples of how to use this switch. ### {% linkable_title aREST device %} -The example below is doing the same as the [aREST switch](/components/switch.arest/). The commandline tool [`curl`](http://curl.haxx.se/) is used to toggle a pin which is controllable through REST. +The example below is doing the same as the [aREST switch](/components/switch.arest/). The command line tool [`curl`](http://curl.haxx.se/) is used to toggle a pin which is controllable through REST. ```yaml # Example configuration.yaml entry diff --git a/source/_components/switch.hook.markdown b/source/_components/switch.hook.markdown index 0550cadb089..42903c50c7a 100644 --- a/source/_components/switch.hook.markdown +++ b/source/_components/switch.hook.markdown @@ -16,7 +16,7 @@ The `hook` component allows you to control the [Hook Smart Home Hub](http://www. Hook allows you to control cheap mains electrical outlets, like these ones at [Amazon](https://www.amazon.com/Etekcity-Wireless-Electrical-Household-Appliances/dp/B00DQELHBS). -In short, Hook is an RF to Wi-Fi bridge, controlling devices that recieve commands at 315MHz and 433MHz. Unfortunately, this does not allow Hook to determine if the command was successful, so the state is assumed. +In short, Hook is an RF to Wi-Fi bridge, controlling devices that receive commands at 315MHz and 433MHz. Unfortunately, this does not allow Hook to determine if the command was successful, so the state is assumed. Hook provides a simple [REST API](https://app.swaggerhub.com/api/rahilj/GetHook_RestAPI/v1). This Home Assistant component reads in devices that have been set up in the official app. diff --git a/source/_components/switch.kankun.markdown b/source/_components/switch.kankun.markdown index c518a459116..03c5a217ed9 100644 --- a/source/_components/switch.kankun.markdown +++ b/source/_components/switch.kankun.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Kankun SP3 Wifi Switch" -description: "Instructions for the Kankun SP3 wifi switch" +description: "Instructions for the Kankun SP3 Wifi switch" date: 2016-12-28 01:50 sidebar: true comments: false @@ -13,7 +13,7 @@ ha_iot_class: "Local Polling" --- -The `kankun` switch platform allows you to toggle customised Kankun SP3 wifi switches. Switches are +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 [here](http://www.homeautomationforgeeks.com/openhab_http.shtml#kankun) (be sure to install the JSON version diff --git a/source/_components/switch.knx.markdown b/source/_components/switch.knx.markdown index 53eafebe2c6..dbddf761518 100644 --- a/source/_components/switch.knx.markdown +++ b/source/_components/switch.knx.markdown @@ -1,7 +1,7 @@ --- layout: page title: "KNX Switch" -description: "Instructions on how to integrate KXN switches with Home Assistant." +description: "Instructions on how to integrate KNX switches with Home Assistant." date: 2016-06-24 12:00 sidebar: true comments: false @@ -30,7 +30,7 @@ switch: * **address**: KNX group address for switching the switch on/off * **state_address**: (*Optional*) separate KNX group address for retrieving the switch state. -Some KNX devices can change their state internally without any messages on the KXN bus, e.g., if you configure a timer on a channel. The optional `state_address` can be used to inform Home Assistant about these state changes. If a KNX message is seen on the bus addressed to the given state address, this will overwrite the state of the switch object. +Some KNX devices can change their state internally without any messages on the KNX bus, e.g., if you configure a timer on a channel. The optional `state_address` can be used to inform Home Assistant about these state changes. If a KNX message is seen on the bus addressed to the given state address, this will overwrite the state of the switch object. For switching actuators that are only controlled by a single group address and can't change their state internally, you don't have to configure the state address. diff --git a/source/_components/switch.netio.markdown b/source/_components/switch.netio.markdown index 380001bc2de..57f5a5abdb1 100644 --- a/source/_components/switch.netio.markdown +++ b/source/_components/switch.netio.markdown @@ -14,7 +14,7 @@ ha_release: 0.24 --- -The `netio` switch platform allows you to control your [Netio](http://www.netio-products.com/en/overview/) Netio4, Netio4 All, and Netio 230B. These are smart outlets controllable through ethernet and/or WiFi that reports consumptions (Netio4all). +The `netio` switch platform allows you to control your [Netio](http://www.netio-products.com/en/overview/) Netio4, Netio4 All, and Netio 230B. These are smart outlets controllable through Ethernet and/or WiFi that reports consumptions (Netio4all). To use Netio devices in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/switch.pilight.markdown b/source/_components/switch.pilight.markdown index 071f5186648..6bd48c3087f 100644 --- a/source/_components/switch.pilight.markdown +++ b/source/_components/switch.pilight.markdown @@ -55,7 +55,7 @@ Variables for the different codes (`on_code` and `off_code`): - **'off'** (*Optional*): `1` or `0` - **'on'** (*Optional*): `1` or `0` -For possible code entries look at the [pilight API](https://www.pilight.org/development/api/). All commands allowed by [pilight-send](https://wiki.pilight.org/doku.php/psend) can be used. Which means that if for a certain protocol there are different parameters used, you should be able to replace the variables above by the proper ones required by the specific protocol. When using the `elro_800_switch` or `mumbi` protocol for example, you will have to replace the variable `unit` with `unitcode` or there will be errors occuring. +For possible code entries look at the [pilight API](https://www.pilight.org/development/api/). All commands allowed by [pilight-send](https://wiki.pilight.org/doku.php/psend) can be used. Which means that if for a certain protocol there are different parameters used, you should be able to replace the variables above by the proper ones required by the specific protocol. When using the `elro_800_switch` or `mumbi` protocol for example, you will have to replace the variable `unit` with `unitcode` or there will be errors occurring. Variables for the different receive codes (`on_code_receive` and `off_code_receive`): diff --git a/source/_components/switch.thinkingcleaner.markdown b/source/_components/switch.thinkingcleaner.markdown index 19304fb0b4c..8be94f7992a 100644 --- a/source/_components/switch.thinkingcleaner.markdown +++ b/source/_components/switch.thinkingcleaner.markdown @@ -13,7 +13,7 @@ ha_iot_class: "Local Poll" ha_release: 0.18 --- -The `thinkingcleaner` switch platform allows you to control your [Thinking Cleaner](http://www.thinkingcleaner.com) addon. +The `thinkingcleaner` switch platform allows you to control your [Thinking Cleaner](http://www.thinkingcleaner.com) add-on. To enable this switch in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/switch.wake_on_lan.markdown b/source/_components/switch.wake_on_lan.markdown index 4bee47a8520..6fc7699fa72 100644 --- a/source/_components/switch.wake_on_lan.markdown +++ b/source/_components/switch.wake_on_lan.markdown @@ -41,7 +41,7 @@ Configuration variables: Here are some real life examples of how to use the **turn_off** variable. -### {% linkable_title Suspending linux %} +### {% linkable_title Suspending Linux %} Suggested recipe for letting the turn_off script suspend a Linux computer (the **target**) from Home Assistant running on another Linux computer (the **server**). diff --git a/source/_components/telegram_bot.markdown b/source/_components/telegram_bot.markdown index 56c699c8c8e..c4d93c43bc5 100644 --- a/source/_components/telegram_bot.markdown +++ b/source/_components/telegram_bot.markdown @@ -81,7 +81,7 @@ Send a location. | `inline_keyboard` | yes | List of rows of commands, comma-separated, to make a custom inline keyboard with buttons with associated callback data. Example: `["/button1, /button2", "/button3"]` or `[[["Text btn1", "/button1"], ["Text btn2", "/button2"]], [["Text btn3", "/button3"]]]` | #### {% linkable_title Service `telegram_bot/edit_message` %} -Edit a previusly sent message in a conversation. +Edit a previously sent message in a conversation. | Service data attribute | Optional | Description | |---------------------------|----------|--------------------------------------------------| @@ -94,7 +94,7 @@ Edit a previusly sent message in a conversation. | `inline_keyboard` | yes | List of rows of commands, comma-separated, to make a custom inline keyboard with buttons with associated callback data. Example: `["/button1, /button2", "/button3"]` or `[[["Text btn1", "/button1"], ["Text btn2", "/button2"]], [["Text btn3", "/button3"]]]` | #### {% linkable_title Service `telegram_bot/edit_caption` %} -Edit the caption of a previusly sent message. +Edit the caption of a previously sent message. | Service data attribute | Optional | Description | |---------------------------|----------|--------------------------------------------------| @@ -124,7 +124,7 @@ Respond to a callback query originated by clicking on an online keyboard button. | `show_alert` | yes | True/false for show a permanent notification. Defaults to False. | #### {% linkable_title Service `telegram_bot/delete_message` %} -Delete a previusly sent message in a conversation. +Delete a previously sent message in a conversation. | Service data attribute | Optional | Description | |---------------------------|----------|--------------------------------------------------| @@ -134,7 +134,7 @@ Delete a previusly sent message in a conversation. ### {% linkable_title `Telegram` notification platform %} -The [Telegram notification platform](/components/notify.telegram/) requires the `telegram_bot` component to work with, and it's designed to generate a customised shortcut (`notify.USERNAME`) to send notifications (messages, photos, documents and locations) to a particular `chat_id` with the old syntax, allowing backward compatibility. +The [Telegram notification platform](/components/notify.telegram/) requires the `telegram_bot` component to work with, and it's designed to generate a customized shortcut (`notify.USERNAME`) to send notifications (messages, photos, documents and locations) to a particular `chat_id` with the old syntax, allowing backward compatibility. The required yaml configuration now reduces to: ```yaml diff --git a/source/_components/telegram_bot.webhooks.markdown b/source/_components/telegram_bot.webhooks.markdown index 0cf3a4db249..d909793f9d4 100644 --- a/source/_components/telegram_bot.webhooks.markdown +++ b/source/_components/telegram_bot.webhooks.markdown @@ -36,7 +36,7 @@ telegram_bot: Configuration variables: -- **allowed_chat_ids** (*Required*): A list of ids representing the users and group chats that are authorised to interact with the webhook. +- **allowed_chat_ids** (*Required*): A list of ids representing the users and group chats that are authorized to interact with the webhook. - **api_key** (*Required*): The API token of your bot. - **trusted_networks** (*Optional*): Telegram server access ACL as list. Defaults to `149.154.167.197-233`. - **parse_mode** (*Optional*): Default parser for messages if not explicit in message data: 'html' or 'markdown'. Default is 'markdown'. @@ -44,7 +44,7 @@ Configuration variables: - **proxy_params** (*Optional*): Proxy configuration parameters, as dict, if working behind a proxy (`username`, `password`, etc.) - **url** (*Optional*): Allow to overwrite the `base_url` from the [`http`](/components/http/) component for different configurations (`https://:`). -To get your `chat_id` and `api_key` follow the instructions [here](/components/notify.telegram). As well as authorising the chat, if you have added your bot to a group you will also need to authorise any user that will be interacting with the webhook. When an unauthorised user tries to interact with the webhook Home Assistant will raise an error ("Incoming message is not allowed"), you can easily obtain the the users id by looking in the "from" section of this error message. +To get your `chat_id` and `api_key` follow the instructions [here](/components/notify.telegram). As well as authorizing the chat, if you have added your bot to a group you will also need to authorize any user that will be interacting with the webhook. When an unauthorized user tries to interact with the webhook Home Assistant will raise an error ("Incoming message is not allowed"), you can easily obtain the the users id by looking in the "from" section of this error message. Full configuration sample: diff --git a/source/_components/tellstick.markdown b/source/_components/tellstick.markdown index a7968cccb00..a26638c0521 100644 --- a/source/_components/tellstick.markdown +++ b/source/_components/tellstick.markdown @@ -12,7 +12,7 @@ ha_category: Hub --- -The `tellstick` component integrates [TellStick](http://www.telldus.se/products/tellstick) devices into Home Assistant. This integration allows users to add switches, lights, and sensors which are communicating with 433 Mhz. There are a number of vendors (Capidi Elro, Intertechno, Nexa, Proove, Sartano, and Viking) who are selling products that work with TellStick. For more details, please check the TellStick [protocol list](http://developer.telldus.com/wiki/TellStick_conf). +The `tellstick` component integrates [TellStick](http://www.telldus.se/products/tellstick) devices into Home Assistant. This integration allows users to add switches, lights, and sensors which are communicating with 433 MHz. There are a number of vendors (Capidi Elro, Intertechno, Nexa, Proove, Sartano, and Viking) who are selling products that work with TellStick. For more details, please check the TellStick [protocol list](http://developer.telldus.com/wiki/TellStick_conf). To get started, add the devices to your `configuration.yaml` file. diff --git a/source/_components/thingspeak.markdown b/source/_components/thingspeak.markdown index e96833fb065..d8da23a931b 100644 --- a/source/_components/thingspeak.markdown +++ b/source/_components/thingspeak.markdown @@ -17,7 +17,7 @@ For now, it records exactly one entity at once, which is great for testing purpo You will have to create a [new channel](https://thingspeak.com/channels/new) on ThingSpeak and grab your Write API Key from the "API Keys" tab of the channel you want to use. -To setup the ThinkSpeak component in your installation, add the following to your `configuration.yaml` file: +To setup the ThingSpeak component in your installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry diff --git a/source/_components/tradfri.markdown b/source/_components/tradfri.markdown index 8505d4b21e1..7c23b9c8f02 100644 --- a/source/_components/tradfri.markdown +++ b/source/_components/tradfri.markdown @@ -22,7 +22,7 @@ For this to work, you need to install a modified lib-coap library. This component does **not** work on Windows, as the modified lib-coap doesn't exists for Windows.

-If you are using [Hass.io](/hassio/) then just move forward to the configuration as all requirements are already fullfilled. +If you are using [Hass.io](/hassio/) then just move forward to the configuration as all requirements are already fulfilled.

Linux: diff --git a/source/_components/tts.markdown b/source/_components/tts.markdown index 369ee59a2e1..7a2733ebbc3 100644 --- a/source/_components/tts.markdown +++ b/source/_components/tts.markdown @@ -27,7 +27,7 @@ The following optional parameters can be used with any platform. However the TTS | Parameter | Default | Description | |---------------------|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `cache` | True | Allow TTS to cache voice file to local storage. | -| `cache_dir` | tts | Foldername or path to folder for caching files. | +| `cache_dir` | tts | Folder name or path to folder for caching files. | | `time_memory` | 300 | Time to hold the voice data inside memory for fast play on media player. Minimum is 60 s and the maximum 57600 s (16 hours). | The extended example from above would look like the following sample: diff --git a/source/_components/tts.voicerss.markdown b/source/_components/tts.voicerss.markdown index cd1a0156da8..a256b144dcc 100644 --- a/source/_components/tts.voicerss.markdown +++ b/source/_components/tts.voicerss.markdown @@ -25,9 +25,9 @@ tts: Configuration variables: -- **api_key** (*Requered*): API Key for use this service. +- **api_key** (*Required*): API Key for use this service. - **language** (*Optional*): The language to use. Defaults to `en-us`. -- **codec** (*Optional*): Audo codec. Default is 'mp3'. +- **codec** (*Optional*): Audio codec. Default is 'mp3'. - **format** (*Optional*): Audio sample format. Default is '8khz_8bit_mono' See on api [documentation](http://www.voicerss.org/api/documentation.aspx) for allow values. diff --git a/source/_components/tts.yandextts.markdown b/source/_components/tts.yandextts.markdown index 66f64186750..057dbf86adf 100644 --- a/source/_components/tts.yandextts.markdown +++ b/source/_components/tts.yandextts.markdown @@ -27,7 +27,7 @@ Configuration variables: - **api_key** (*Required*): API Key for use this service. - **language** (*Optional*): The language to use. Defaults to `en-US`. Supported `en-US`, `ru-RU`, `uk-UK`, `tr-TR`. -- **codec** (*Optional*): Audo codec. Default is `mp3`. Supported us `mp3`, `wav`, `opus`. +- **codec** (*Optional*): Audio codec. Default is `mp3`. Supported us `mp3`, `wav`, `opus`. - **voice** (*Optional*): Speaker voice. Default is `zahar`. Supported female voices are `jane`, `oksana`, `alyss`, `omazh` and male voices are `zahar` and `ermil`. - **emotion** (*Optional*): Speaker emotional intonation. Default is `neutral`. Also supported are `good` (freindly) and `evil` (angry) - **speed** (*Optional*): Speech speed. Default value is `1`. Highest speed is `3` and lowest `0,1` diff --git a/source/_components/weather.bom.markdown b/source/_components/weather.bom.markdown index 6f2ad02a0cd..03bc747f403 100644 --- a/source/_components/weather.bom.markdown +++ b/source/_components/weather.bom.markdown @@ -29,5 +29,5 @@ Configuration variables:

This platform is an alternative to the [`bom`](/components/sensor.bom/) sensor. -The weather platform is easier to configure but less customisable. +The weather platform is easier to configure but less customizable.

diff --git a/source/_components/weather.buienradar.markdown b/source/_components/weather.buienradar.markdown index c419bd88727..9cfb72d10ca 100644 --- a/source/_components/weather.buienradar.markdown +++ b/source/_components/weather.buienradar.markdown @@ -47,7 +47,7 @@ weather:

This platform is an alternative to the [`buienradar`](/components/sensor.buienradar/) sensor. -The weather platform is easier to configure but less customisable. +The weather platform is easier to configure but less customizable.

[Usage statement:](https://www.buienradar.nl/overbuienradar/gratis-weerdata) diff --git a/source/_components/weather.metoffice.markdown b/source/_components/weather.metoffice.markdown index a5800fdacd4..d05b55431e6 100644 --- a/source/_components/weather.metoffice.markdown +++ b/source/_components/weather.metoffice.markdown @@ -29,7 +29,7 @@ Configuration variables:

This platform is an alternative to the [`metoffice`](/components/sensor.metoffice/) sensor. -The weather platform is easier to configure but less customisable. +The weather platform is easier to configure but less customizable.

[datapoint]: http://www.metoffice.gov.uk/datapoint diff --git a/source/_components/weather.zamg.markdown b/source/_components/weather.zamg.markdown index 19645d68eec..89cc25bca87 100644 --- a/source/_components/weather.zamg.markdown +++ b/source/_components/weather.zamg.markdown @@ -15,7 +15,7 @@ ha_iot_class: "Cloud Polling" The `zamg` platform uses meteorological details published by the Austrian weather service [Zentralanstalt für Meteorologie und Geodynamik (ZAMG)](https://www.zamg.ac.at). -Only observations for capital cities are publically available. You can check the list of stations in [CSV format](http://www.zamg.ac.at/ogd). +Only observations for capital cities are publicly available. You can check the list of stations in [CSV format](http://www.zamg.ac.at/ogd). To add ZAMG to your installation, add the following to your `configuration.yaml` file: @@ -29,9 +29,9 @@ Configuration variables: - **station_id** (*Optional*): The ID number for a supported ZAMG station. - **name** (*Optional*): A name for the weather platform. -- **latitude** (*Optional*): Latitude coordinate to monitor weather of (required if **longitude** is specificed). Defaults to coordinates defined in your `configuration.yaml` file. +- **latitude** (*Optional*): Latitude coordinate to monitor weather of (required if **longitude** is specified). Defaults to coordinates defined in your `configuration.yaml` file. - **longitude** (*Optional*): Longitude coordinate to monitor weather of (required if **latitude** is specified). Defaults to coordinates defined in your `configuration.yaml` file.

-This platform is an alternative to the [`zamg`](/components/sensor.zamg/) sensor. The weather platform is easier to configure but less customisable. +This platform is an alternative to the [`zamg`](/components/sensor.zamg/) sensor. The weather platform is easier to configure but less customizable.

diff --git a/source/_components/zeroconf.markdown b/source/_components/zeroconf.markdown index 507b4ac8f56..3d054ea4d59 100644 --- a/source/_components/zeroconf.markdown +++ b/source/_components/zeroconf.markdown @@ -21,7 +21,7 @@ To integrate this into Home Assistant, add the following section to your `config zeroconf: ``` -The registration will include metadata about the Home Assistant instance, including a base URL that can be used to access Home Assistant, the currently running Home Assistant version, and whether an API password is needed to access the instance. The examples below show two ways to retrieve the details for testing. +The registration will include meta-data about the Home Assistant instance, including a base URL that can be used to access Home Assistant, the currently running Home Assistant version, and whether an API password is needed to access the instance. The examples below show two ways to retrieve the details for testing. ```bash $ avahi-browse -alr