Review/Edit: Getting Started Guide (#3184)

* Review/Edit: Getting Started Guide

I've made some documentation fixes (spelling, grammar, and punctuations) to the 'Getting Started Guide'.

* Fix small typo 'tje' -> 'the'.
This commit is contained in:
Franck Nijhof 2017-08-15 21:09:00 +02:00 committed by Fabian Affolter
parent 5272dca6db
commit 0acfd0aab4
4 changed files with 16 additions and 18 deletions

View file

@ -17,7 +17,7 @@ We are defining a [trigger](/docs/automation/trigger/) to track the sunset and t
```yaml
# Example configuration.yaml entry
automation:
alias: Turn on light when sun sets
alias: Turn on the lights when the sun sets
initial_state: True
hide_entity: False
trigger:
@ -27,14 +27,14 @@ automation:
service: light.turn_on
```
Starting with 0.28 automation rules can be reloaded from the [frontend](/components/automation/) and are shown by default. With [`hide_entity:`](/components/automation/) you can control this behaviour. It's very handy if you are working on your rules but when a rule is finished and you don't want to see that rule in your frontend, you can set `hide_entity:` to `True`. To set an automation to be disabled when Home Assistant starts set `initial_state:` to `False`.
Starting with 0.28 automation rules can be reloaded from the [frontend](/components/automation/) and are shown by default. With [`hide_entity:`](/components/automation/) you can control this behavior. It's convenient if you are working on your rules, but when a rule is finished, and you don't want to see that rule in your frontend, you can set `hide_entity:` to `True`. To set an automation to be disabled when Home Assistant starts set `initial_state:` to `False`.
After a few days of running this automation rule, you come to realize that this automation rule is not good enough. It was already dark when the lights went on and the one day you weren't home, the lights turned on anyway. Time for some tweaking. Let's add an offset to the sunset trigger and a [condition](/docs/automation/condition/) to only turn on the lights if anyone is home.
After a few days of running this automation rule, you come to realize that this automation rule is not sufficient. It was already dark when the lights went on, and the one day you weren't home, the lights turned on anyway. Time for some tweaking. Let's add an offset to the sunset trigger and a [condition](/docs/automation/condition/) to only turn on the lights if anyone is home.
```yaml
# Example configuration.yaml entry
automation:
alias: Turn on light when sun sets
alias: Turn on the lights when the sun sets
trigger:
platform: sun
event: sunset
@ -47,9 +47,9 @@ automation:
service: light.turn_on
```
Now you're happy and all is good. You start to like this automation business and buy some more lights, this time you put them in the bedroom. But what you now realize is that when the sun is setting, the lights in the bedroom are also being turned on! Time to tweak the automation to only turn on the living room lights.
Now you're happy, and all is good. You start to like this automation business and buy some more lights, this time you put them in the bedroom. But what you now realize is that when the sun is setting, the lights in the bedroom are also being turned on! Time to tweak the automation to only turn on the living room lights.
The first thing you do is to look at the entities in the developer tools (second icon) in the app. You see the names of your lights and you write them down: `light.table_lamp`, `light.bedroom`, `light.ceiling`.
The first thing you do is to look at the entities in the developer tools (second icon) in the app. You see the names of your lights, and you write them down: `light.table_lamp`, `light.bedroom`, `light.ceiling`.
Instead of hard coding the entity IDs of the lights in the automation rule, we will set up a group. This will allow us to see the living room separate in the app and be able to address it from automation rules.
@ -63,7 +63,7 @@ group:
- light.ceiling
automation:
alias: Turn on light when sun sets
alias: Turn on the light when the sun sets
trigger:
platform: sun
event: sunset
@ -77,9 +77,9 @@ automation:
entity_id: group.living_room
```
Christmas is coming along and you decide to buy a remote switch to control the Christmas lights from Home Assistant. You can't claim to live in the house of the future if you're still manually turning on your Christmas lights!
Christmas is coming along, and you decide to buy a remote switch to control the Christmas lights from Home Assistant. You can't claim to live in the house of the future if you're still manually turning on your Christmas lights!
We hook the switch up to Home Assistant and grab the entity ID from the developer tools: `switch.christmas_lights`. We will update the group to include the switch and will change our [action](/docs/automation/action/). We are no longer able to call `light.turn_on` because we also want to turn on a switch. This is where `homeassistant.turn_on` comes to the rescue. This service is capable of turning any entity on.
We hook the switch up to Home Assistant and grab the entity ID from the developer tools: `switch.christmas_lights`. We will update the group to include the switch and will change our [action](/docs/automation/action/). We are no longer able to call `light.turn_on` because we also want to turn on a switch. This is where `homeassistant.turn_on` comes to the rescue. This service is capable of turning on any entity.
```yaml
# Example configuration.yaml entry
@ -90,7 +90,7 @@ group:
- switch.christmas_lights
automation:
alias: Turn on light when sun sets
alias: Turn on the lights when the sun sets
hide_entity: True
trigger:
platform: sun
@ -106,4 +106,3 @@ automation:
```
### [Next step: Presence detection »](/getting-started/presence-detection/)