mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-23 01:06:52 +00:00
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
Fabian Affolter
parent
5272dca6db
commit
0acfd0aab4
@ -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/)
|
||||
|
||||
|
||||
@ -13,14 +13,14 @@ When launched for the first time, Home Assistant will write a default configurat
|
||||
|
||||
The `configuration.yaml` is written in [YAML](/docs/configuration/yaml/), stored in [`.homeassistant`](/docs/configuration/), and can be modified with a text editor.
|
||||
|
||||
See the [components overview page](/components/) to find sample entries for your devices and services. For a sensor that is showing [random values](/components/sensor.random/), the entry would looks like the sample below:
|
||||
See the [components overview page](/components/) to find sample entries for your devices and services. For a sensor that is showing [random values](/components/sensor.random/), the entry would look like the sample below:
|
||||
|
||||
```yaml
|
||||
sensor:
|
||||
- platform: random
|
||||
```
|
||||
|
||||
The [Setting up devices part](/docs/configuration/devices/) contains of the documentation additional details about adding device and services and [customization](/docs/configuration/customizing-devices/).
|
||||
The [Setting up devices part](/docs/configuration/devices/) contains the additional documentation details about adding devices and services and [customization](/docs/configuration/customizing-devices/).
|
||||
|
||||
For further details about configuration, please take a look at the [configuration documentation](/docs/configuration/).
|
||||
|
||||
|
||||
@ -9,7 +9,7 @@ sharing: true
|
||||
footer: true
|
||||
---
|
||||
|
||||
You will need to install Home Assistant before we can get started. You can install Home Assistant on your computer or you can turn a Raspberry Pi into a dedicated Home Assistant hub.
|
||||
You will need to install Home Assistant before we can get started. You can install Home Assistant on your computer, or you can turn a Raspberry Pi into a dedicated Home Assistant hub.
|
||||
|
||||
<div class="text-center hass-option-cards" markdown="0">
|
||||
<a class='option-card' href='/hassio/'>
|
||||
@ -27,7 +27,7 @@ You will need to install Home Assistant before we can get started. You can insta
|
||||
</div>
|
||||
<br>
|
||||
|
||||
For alternative installation methods please take a look at the [installation documentation](/docs/installation/).
|
||||
For alternative installation methods, please take a look at the [installation documentation](/docs/installation/).
|
||||
|
||||
If you run into any issues, please see [the troubleshooting page](/docs/installation/troubleshooting/) or [communication channels](/help/). It contains solutions to many commonly encountered issues.
|
||||
|
||||
|
||||
@ -13,7 +13,7 @@ footer: true
|
||||
We care about privacy. Collected data is <b>only</b> stored in your instance of Home Assistant.
|
||||
</p>
|
||||
|
||||
Presence detection detects if people are home, which is the most important input for automation. Knowing who is home or where they are will open a whole range of other automation options:
|
||||
Presence detection detects if people are home, which is the most valuable input for automation. Knowing who is home or where they are, will open a whole range of other automation options:
|
||||
|
||||
- Send me a notification when my child arrives at school
|
||||
- Turn on the AC when I leave work
|
||||
@ -27,7 +27,7 @@ Screenshot of Home Assistant showing a school, work and home zone and two people
|
||||
|
||||
The device tracker component offers presence detection for Home Assistant. It supports two different methods for presence detection: scan for connected devices on the local network and connect to third party service.
|
||||
|
||||
Scanning for connected devices is easy to setup. See the instructions for our [supported routers][routers] or [scan the network using nmap][nmap]. This approach does have its limitations, however: it will only be able to detect if a device is home, and iPhones may show as not home inaccurately (as iPhones disconnect from WiFi if idle).
|
||||
Scanning for connected devices is easy to setup. See the instructions for our [supported routers][routers] or [scan the network using nmap][nmap]. This approach does have its limitations, however: it will only be able to detect if a device is at home, and iPhones may show as not home inaccurately (as iPhones disconnect from WiFi if idle).
|
||||
|
||||
Home Assistant currently supports multiple third-party services for presence detection: [OwnTracks][ha-owntracks], [GPSLogger][ha-gpslogger] and [Locative][ha-locative]. OwnTracks is an app that you install on your iPhone or Android phone that allows you to push the location of your device to Home Assistant using an MQTT broker. An MQTT broker is an Internet of Things communication platform that you can [freely host yourself][mqtt-self] or get [a private instance for free in the cloud](/components/mqtt/#run-your-own).
|
||||
|
||||
@ -53,4 +53,3 @@ Home Assistant will know the location of your device if you are using OwnTracks.
|
||||
[condition]: /getting-started/automation-condition/#zone-condition
|
||||
|
||||
### [Next step: Use Home Assistant »](/getting-started/use/)
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user