jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-19 15:26:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

✏️ Spelling, grammar, styling and fixes (#8181)

Browse Source
This commit is contained in:
Franck Nijhof 2019-01-16 09:06:39 +01:00 committed by Fabian Affolter
parent 7dce7f1aa8
commit 0e43e7927e
11 changed files with 62 additions and 61 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
source/_components/alexa.markdown
View File

@ -54,16 +54,16 @@ Additionally, note that at the time of this writing, your Alexa skill endpoint *
To get started with Alexa skills:
- Log in to [Amazon developer console][amazon-dev-console]
- Click the Alexa button at the top of the console
- Click the yellow "Add a new skill" button in the top right
- Skill Type: Custom Interaction Model (default)
- Name: Home Assistant
- Invocation name: home assistant (or be creative, up to you)
- Version: 1.0
- Endpoint:
- https
- `https://YOUR_HOST/api/alexa?api_password=YOUR_API_PASSWORD`
- Log in to [Amazon developer console][amazon-dev-console]
- Click the Alexa button at the top of the console
- Click the yellow "Add a new skill" button in the top right
- Skill Type: Custom Interaction Model (default)
- Name: Home Assistant
- Invocation name: home assistant (or be creative, up to you)
- Version: 1.0
- Endpoint:
- https
- `https://YOUR_HOST/api/alexa?api_password=YOUR_API_PASSWORD`
You can use this [specially sized Home Assistant logo][large-icon] as the large icon and [this one][small-icon] as the small one.
@ -103,14 +103,14 @@ WhereAreWeIntent where we are
This means that we can now ask Alexa things like:
- Alexa, ask Home Assistant where Paul is
- Alexa, ask Home Assistant where we are
- Alexa, ask Home Assistant where Paul is
- Alexa, ask Home Assistant where we are
## {% linkable_title Configuring Home Assistant %}
When activated, the Alexa component will have Home Assistant's native intent support handle the incoming intents. If you want to run actions based on intents, use the [`intent_script`](/components/intent_script) component.
To enable Alexa add the following entry to your `configuration.yaml` file:
To enable Alexa, add the following entry to your `configuration.yaml` file:
```yaml
alexa:
@ -222,15 +222,16 @@ intent_script:
Now say `Alexa ask Home Assistant to run <some script>` and Alexa will run that script for you.
### {% linkable_title Support for Launch Requests %}
There may be times when you want to respond to a launch request initiated from a command such as "Alexa, Red Alert!".
To start, you need to get the skill id:
- Log into [Amazon developer console][amazon-dev-console]
- Click the Alexa button at the top of the console
- Click the Alexa Skills Kit Get Started button
- Locate the skill for which you would like Launch Request support
- Click the "View Skill ID" link and copy the ID
- Log into [Amazon developer console][amazon-dev-console]
- Click the Alexa button at the top of the console
- Click the Alexa Skills Kit Get Started button
- Locate the skill for which you would like Launch Request support
- Click the "View Skill ID" link and copy the ID
The configuration is the same as an intent with the exception being you will use your skill ID instead of the intent name.
```yaml
@ -273,13 +274,13 @@ First create a file called `alexa_confirm.yaml` with something like the followin
Then, wherever you would put some simple text for a response like `OK`, replace it with a reference to the file so that:
```
```yaml
text: OK
```
becomes:
```
```yaml
text: !include alexa_confirm.yaml
```
@ -334,10 +335,9 @@ Please refer to the [Amazon documentation][flash-briefing-api-docs] for more inf
- All other settings are up to you
- Hit "Next"
- Test
- Having passed all validations to reach this screen, you can now click on "< Back to All Skills" as your flash briefing is now available as in "Development" service.
- Having passed all validations to reach this screen, you can now click on "< Back to All Skills" as your flash briefing is now available as in "Development" service.
- To invoke your flash briefing, open the Alexa app on your phone or go to the [Alexa Settings Site][alexa-settings-site], open the "Skills" configuration section, select "Your Skills", scroll to the bottom, tap on the Flash Briefing Skill you just created, enable it, then manage Flash Briefing and adjust ordering as necessary. Finally ask your Echo for your "news","flash briefing", or "briefing".
## {% linkable_title Smart Home %}
While the Skills API described above allows for arbitrary intents, all
@ -384,7 +384,7 @@ function to integrate this endpoint. See
[Haaska](https://github.com/mike-grant/haaska) for an example.
The `endpoint`, `client_id` and `client_secret` are optional, and are only required if you want to enable Alexa's proactive mode. Please note the following if you want to enable proactive mode:
- There are different endpoint urls, depending on the region of your skill. Please check the available endpoints at https://developer.amazon.com/docs/smarthome/send-events-to-the-alexa-event-gateway.html#endpoints
- There are different endpoint urls, depending on the region of your skill. Please check the available endpoints at <https://developer.amazon.com/docs/smarthome/send-events-to-the-alexa-event-gateway.html#endpoints>
- The `client_id` and `client_secret` are not the ones used by the skill that have been set up using "Login with Amazon" (in the Alexa Developer Console: Build > Account Linking), but rather from the "Alexa Skill Messaging" (in the Alexa Developer Console: Build > Permissions > Alexa Skill Messaging). To get them, you need to enable the "Send Alexa Events" permission.
- If the "Send Alexa Events" permission was not enabled previously, you need to unlink and relink the skill using the Alexa App, or else Home Assistant will show the following error: "Token invalid and no refresh token available."

18
source/_components/climate.zwave.markdown
View File

@ -1,7 +1,7 @@
---
layout: page
title: "Z-Wave Climate"
description: "Instructions on how to setup the Z-Wave thermostat or HVAC within Home Assistant."
description: "Instructions on how to set up the Z-Wave thermostat or HVAC within Home Assistant."
date: 2016-04-03 9:52
sidebar: true
comments: false
@ -13,13 +13,12 @@ ha_release: 0.17
ha_iot_class: "Local Push"
---
To get your Z-Wave thermostat or HVAC unit working with Home Assistant, follow the instructions for the general [Z-Wave component](/getting-started/z-wave/).
<p class='note'>
Thermostats with support for fan modes or different operating modes, will be handled like a HVAC device and will also be detected as one.
If the thermostat support different operating modes, you will get one thermostat entity for each mode. These can be hidden with settings using the customize setting in the `configuration.yaml` file.
If the thermostat supports different operating modes, you will get one thermostat entity for each mode. These can be hidden with settings using the customize setting in the `configuration.yaml` file.
</p>
To enable the climate component for your Z-Wave network, add the following to your `configuration.yaml` file.
@ -31,10 +30,10 @@ climate:
Once enabled, any Z-Wave climate devices will be available to Home Assistant. Multiple entities may be created. The following entities are created for a Remotec ZXT-120.
- **climate.remotec_zxt120_heating_1_id** Allows you to control the connected device. See below for examples.
- **sensor.remotec_zxt120_temperature_38** A sensor which returns the current temperature set on the attached device.
- `climate.remotec_zxt120_heating_1_id`: Allows you to control the connected device. See below for examples.
- `sensor.remotec_zxt120_temperature_38`: A sensor which returns the current temperature set on the attached device.
### {% linkable_title Automating Z-Wave Climate Devices %}
## {% linkable_title Automating Z-Wave Climate Devices %}
The following examples will instruct a Remotec ZXT-120 to turn the attached device mode to Heating, and set the temperature at 24 degrees after 8pm. Add it to `automation.yaml`.
@ -55,7 +54,7 @@ automation:
temperature: 24
```
Generally in Home Assistant you can use the `homeassistant/turn_off` service to turn devices off. For the Remotec ZXT-120, you must instead make a service call like the following.
Generally, in Home Assistant, you can use the `homeassistant/turn_off` service to turn devices off. For the Remotec ZXT-120, you must instead make a service call like the following.
```yaml
automation:
@ -72,9 +71,9 @@ automation:
**Note:** In the example above, the word `Off` is encased in single quotes to be valid YAML.
### {% linkable_title Test if it works %}
## {% linkable_title Test if it works %}
A simple way to test if your Z-Wave climate device is working is to use <img src='/images/screenshots/developer-tool-services-icon.png' alt='service developer tool icon' class="no-shadow" height="38" /> **Services** from the **Developer Tools**. Choose the applicable Climate service from the list of **Available services:** and enter something like the sample below into the **Service Data** field and then press **CALL SERVICE**.
A simple way to test if your Z-Wave climate device is working is to use <img src='/images/screenshots/developer-tool-services-icon.png' alt='service developer tool icon' class="no-shadow" height="38" /> **Services** from the **Developer Tools**. Choose the applicable Climate service from the list of **Available services:** and enter something like the sample below into the **Service Data** field and then press **CALL SERVICE**.
```json
{
@ -82,4 +81,3 @@ A simple way to test if your Z-Wave climate device is working is to use <img src
"operation_mode": "Heat"
}
```

3
source/_components/telegram_bot.markdown
View File

@ -150,6 +150,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 previously sent message in a conversation.
| Service data attribute | Optional | Description |
@ -161,7 +162,7 @@ Delete a previously sent message in a conversation.
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:
The required YAML configuration now reduces to:
```yaml
notify:

13
source/_components/tesla.markdown
View File

@ -16,12 +16,13 @@ ha_iot_class: "Cloud Polling"
The `Tesla` component offers integration with the [Tesla](https://auth.tesla.com/login) cloud service and provides presence detection as well as sensors such as charger state and temperature.
This component provides the following platforms:
- Binary sensors - such as parking and charger connection.
- Sensors - such as Battery level, Inside/Outside temperature, odometer, and estimated range.
- Device tracker - to track location of your car
- Lock - Door lock. Enables you to control Tesla's door lock
- Climate - HVAC control. Allow you to control (turn on/off, set target temperature) your Tesla's HVAC system.
- Switch - Charger and max range switch. Allow you to start/stop charging and set max range charging.
- Binary sensors - such as parking and charger connection.
- Sensors - such as Battery level, Inside/Outside temperature, odometer, and estimated range.
- Device tracker - to track location of your car
- Lock - Door lock. Enables you to control Tesla's door lock
- Climate - HVAC control. Allow you to control (turn on/off, set target temperature) your Tesla's HVAC system.
- Switch - Charger and max range switch. Allow you to start/stop charging and set max range charging.
## {% linkable_title Configuration %}

8
source/_components/timer.markdown
View File

@ -18,7 +18,7 @@ The `timer` component aims to simplify automations based on (dynamic) durations.
When a timer finishes or gets canceled the corresponding events are fired. This allows you to differentiate if a timer has switched from `active` to `idle` because the given duration has elapsed or it has been canceled. To control timers in your automations you can use the services mentioned below. When calling the `start` service on a timer that is already running, it resets the duration it will need to finish and restart the timer without triggering a canceled or finished event. This, for example, makes it easy to create timed lights that get triggered by motion. Starting a timer triggers a started event unless the timer is paused, in that case, it triggers a restarted event.
<p class='note warning'>
With the current implementation timers don't persist over restarts. After a restart they will be idle again, together with their initial configuration.
With the current implementation timers don't persist over restarts. After a restart, they will be idle again, together with their initial configuration.
</p>
## {% linkable_title Configuration %}
@ -67,7 +67,7 @@ Pick an icon that you can find on [materialdesignicons.com](https://materialdesi
## {% linkable_title Services %}
#### {% linkable_title Service `timer.start` %}
### {% linkable_title Service `timer.start` %}
Starts or restarts a timer with the provided duration. If no duration is given, it will either restart with its initial value, or continue a paused timer with the remaining duration. If a new duration is provided, this will be the new default for the timer until Home Assistant is restarted (which loads your default values). The duration can be specified as a number of seconds or the easier to read `01:23:45` format.
If no `entity_id` is given all active timers will be started.
@ -77,7 +77,7 @@ If no `entity_id` is given all active timers will be started.
| `entity_id` | yes | Name of the entity to take action, e.g., `timer.timer0`. |
| `duration` | yes | Duration in seconds or `00:00:00` until the timer finishes. |
#### {% linkable_title Service `timer.pause` %}
### {% linkable_title Service `timer.pause` %}
Pause a running timer. This will retain the remaining duration for later continuation. If no `entity_id` is given all active timers will be paused.
@ -151,7 +151,7 @@ timer:
message: "Timer stop"
```
### {% linkable_title Control a timer from the frontend %}
### {% linkable_title Control a timer manually %}
With the [`script`](/components/script/) component you would be able to control a timer (see above for a `timer` configuration sample) manually.

7
source/_components/tts.markdown
View File

@ -1,7 +1,7 @@
---
layout: page
title: "Text-to-Speech (TTS)"
description: "Instructions on how to setup Text-to-Speech (TTS) with Home Assistant."
description: "Instructions on how to set up Text-to-Speech (TTS) with Home Assistant."
date: 2016-12-13 07:00
sidebar: true
comments: false
@ -17,7 +17,7 @@ Text-to-Speech (TTS) enables Home Assistant to speak to you.
To get started, add the following lines to your `configuration.yaml` (example for Google):
```yaml
# Example configuration.yaml entry for google tts service
# Example configuration.yaml entry for Google TTS service
tts:
- platform: google
```
@ -97,6 +97,7 @@ service: tts.google_say
data:
message: 'May the Force be with you.'
```
Say to the `media_player.floor` device entity:
```yaml
@ -131,7 +132,7 @@ The component has two caches. Both caches can be controlled with the `cache` opt
## {% linkable_title REST Api %}
#### {% linkable_title POST /api/tts_get_url %}
### {% linkable_title POST /api/tts_get_url %}
Returns an URL to the generated TTS file. Platform and message are required.

3
source/_components/tts.microsoft.markdown
View File

@ -1,7 +1,7 @@
---
layout: page
title: "Microsoft Text-to-Speech"
description: "Instructions on how to setup Microsoft Text-to-Speech with Home Assistant."
description: "Instructions on how to set up Microsoft Text-to-Speech with Home Assistant."
date: 2017-11-07 12:00
sidebar: true
comments: false
@ -67,7 +67,6 @@ contour:
type: string
{% endconfiguration %}
## {% linkable_title Full configuration example %}
A full configuration sample including optional variables:

4
source/_components/twilio.markdown
View File

@ -14,7 +14,7 @@ ha_release: "0.40"
The `twilio` component enables the sending of notifications via SMS and the creation of calls with [Twilio](https://twilio.com).
Free trial account is available at [Twilio](https://twilio.com) website providing free calls to verified phone numbers.
A free trial account is available at [Twilio](https://twilio.com) website providing free calls to verified phone numbers.
Calls are limited to 10 minutes and will play a short trial message before your message runs. Upgraded accounts have no limitation.
## {% linkable_title Configuration %}
@ -40,6 +40,7 @@ auth_token:
{% endconfiguration %}
### {% linkable_title Usage %}
After configuring the base Twilio component, add and configure either or both of the [twilio SMS](/components/notify.twilio_sms/) and [twilio Phone](/components/notify.twilio_call) components to utilize the notification functionality.
To be able to receive events from Twilio, your Home Assistant instance needs to be accessible from the web ([Hass.io instructions](/addons/duckdns/)) and you need to have the `base_url` configured for the HTTP component ([docs](https://www.home-assistant.io/components/http/#base_url)).
@ -63,4 +64,3 @@ automation:
service: light.turn_on
entity_id: light.office
```

1
source/_components/usps.markdown
View File

@ -43,6 +43,7 @@ If you use the PhantomJS option, specify `driver: phantomjs` in your `usps` conf
Install Chrome 59 or greater (preferably the most recent). Install the latest [Chromedriver](https://sites.google.com/a/chromium.org/chromedriver/downloads). Ensure both executables are on your `PATH`. `google-chrome --version` and `chromedriver --version` should work and report the correct version.
OS-specific instructions:
- [Ubuntu 16](https://gist.github.com/ziadoz/3e8ab7e944d02fe872c3454d17af31a5) (Selenium server portion *not* necessary)
- [RHEL/Centos 7](https://stackoverflow.com/a/46686621)

17
source/_components/vacuum.dyson.markdown
View File

@ -22,11 +22,12 @@ You have to set up the [Dyson component](/components/dyson/) first.
### {% linkable_title Component services %}
This component support the following services (see [Vacuum Cleaner Robots](/components/vacuum/)):
* [`turn_on`](/components/vacuum/#service-vacuumturn_on)
* [`turn_off`](/components/vacuum/#service-vacuumturn_off)
* [`start_pause`](/components/vacuum/#service-vacuumstart_pause)
* [`stop`](/components/vacuum/#service-vacuumstop)
* [`return_to_home`](/components/vacuum/#service-vacuumreturn_to_home)
* [`set_fan_speed`](/components/vacuum/#service-vacuumset_fanspeed). Fan speed values:
* `Quiet`
* `Max`
- [`turn_on`](/components/vacuum/#service-vacuumturn_on)
- [`turn_off`](/components/vacuum/#service-vacuumturn_off)
- [`start_pause`](/components/vacuum/#service-vacuumstart_pause)
- [`stop`](/components/vacuum/#service-vacuumstop)
- [`return_to_home`](/components/vacuum/#service-vacuumreturn_to_home)
- [`set_fan_speed`](/components/vacuum/#service-vacuumset_fanspeed). Fan speed values:
- `Quiet`
- `Max`

1
source/_components/vacuum.mqtt.markdown
View File

@ -160,7 +160,6 @@ payload_not_available:
default: offline
{% endconfiguration %}
### {% linkable_title Full configuration example %}
{% raw %}