Update wording and provide new screenshots (#11180)
* Create trash * Add files via upload * Delete trash * Update wording and screenshots * Update screenshots and wording Also improve clarity * Revert improper references to Lovelace. * "states screen" > "Home Assistant web interface" * Delete automation-new-action.png * Delete automation-new-blank.png * Delete automation-new-name-trigger.png * Delete integrations.png * Create trash * Add new screenshots * Delete 01 - username.png * Delete 02 - location.png * Delete 03 - location.png * Delete 04 - devices.png * Delete 05 - lovelace.png * Delete 06 - config.png * Delete 07 - integrations.png * Delete 08 - new integration.png * Delete 09 - config 2.png * Delete 10 - automation editor.png * Delete 11 - new automation.png * Delete 12 - new trigger.png * Delete 13 - action.png * Delete 14 - server control.png * Delete trash * Update screenshot paths * Update onboarding.markdown * Correct image paths * Update automation.markdown * Reword and provide additional information This information was outdated, especially with the addition of default_config. Hopefully these changes make it clearer for new users who are confused about the missing homeassistant: line in their default configuration (this is something that has been popping up in the forum lately). I linked to an external source for the time zone names. Perhaps we should add this list to Home Assistant website instead (or if it already exists, my apologies: I can point it to that instead). * Update configuration.markdown
@ -6,36 +6,41 @@ redirect_from:
|
||||
- /getting-started/automation-2/
|
||||
---
|
||||
|
||||
When your devices are set up, it's time to put the cherry on the pie: automation. In this guide we're going to create a simple automation rule to **turn on the lights when the sun sets**.
|
||||
Once your devices are set up, it's time to put the cherry on the pie: automation. In this guide we're going to create a simple automation rule to **turn on the lights when the sun sets**.
|
||||
|
||||
In Home Assistant, open the menu by clicking on the top-left icon and click on configuration. Now click on automation. This is the automation screen from which you can manage all the automations in Home Assistant.
|
||||
|
||||
Click on the orange button at the bottom right to create a new automation. You are presented with a blank automation screen.
|
||||
In the user interface, click Configuration in the sidebar, then click Automation. You will now see the automation screen from which you can manage all the automations in Home Assistant.
|
||||
|
||||
<p class='img'>
|
||||
<img src='/images/getting-started/automation-new-blank.png'>
|
||||
<img src='/images/getting-started/automation-editor.png'>
|
||||
The automation editor.
|
||||
</p>
|
||||
|
||||
The first thing we will do is to set a name. Enter "Turn Lights On at Sunset".
|
||||
|
||||
The second step is defining what should trigger our automation to run. In this case we want to use the event of the sun setting to trigger our automation. However, if we would turn on the lights when the sun actually sets, it would be too late as it already gets quite dark while it's setting. So we're going to add an offset.
|
||||
|
||||
In the trigger section, click on the dropdown and change trigger type to "Sun". It allows us to pick between sunrise and sunset, go ahead and pick sunset. As we discussed, we want our automation to be triggered a little before the sun actually sets, so let's add `-0:30` to the offset. This indicates that we will trigger 30 minutes before the sun actually sets, neat!
|
||||
Click the orange button at the bottom right to create a new automation. You are presented with a blank automation screen.
|
||||
|
||||
<p class='img'>
|
||||
<img src='/images/getting-started/automation-new-name-trigger.png'>
|
||||
<img src='/images/getting-started/new-automation.png'>
|
||||
The start of a new automation.
|
||||
</p>
|
||||
|
||||
The first thing we will do is set a name. Enter "Turn Lights On at Sunset".
|
||||
|
||||
The second step is defining what should trigger our automation to run. In this case, we want to use the event of the sun setting to trigger our automation. However, if we would turn on the lights when the sun actually sets, it would be too late as it already gets quite dark while it's setting. So we're going to add an offset.
|
||||
|
||||
In the trigger section, click on the dropdown menu and change the trigger type to "Sun." It allows us to choose sunrise or sunset, so go ahead and pick sunset. As we discussed, we want our automation to be triggered a little before the sun actually sets, so let's add `-00:30` as the offset. This indicates that the automation will be triggered 30 minutes before the sun actually sets. Neat!
|
||||
|
||||
<p class='img'>
|
||||
<img src='/images/getting-started/new-trigger.png'>
|
||||
A new automation with a sun trigger filled in.
|
||||
</p>
|
||||
|
||||
Once we have defined our trigger, scroll down to the action section. Make sure the action type is set to "Call Service" and change the service to `light.turn_on`. For this automation we're going to turn on all lights, so let's change the service data to:
|
||||
Once we have defined our trigger, scroll down to the action section. Make sure the action type is set to "Call service," and change the service to `light.turn_on`. For this automation we're going to turn on all lights, so let's change the service data to:
|
||||
|
||||
```yaml
|
||||
entity_id: all
|
||||
```
|
||||
|
||||
<p class='img'>
|
||||
<img src='/images/getting-started/automation-new-action.png'>
|
||||
<img src='/images/getting-started/action.png'>
|
||||
A new automation with the action set up to turn on the lights.
|
||||
</p>
|
||||
|
||||
|
@ -3,11 +3,11 @@ title: "Advanced Configuration"
|
||||
description: "Instructions to get Home Assistant configured."
|
||||
---
|
||||
|
||||
Until now we have been able to configure Home Assistant purely via the user interface. However, not all options are accessible via the user interface. The other options are accessible via the Home Assistant configuration file called `configuration.yaml`. A default one is created when Home Assistant started for the first time.
|
||||
The onboarding process takes care of the initial setup for Home Assistant, such as naming your home and selecting your location. After initial onboarding, these options can be changed in the user interface by clicking on Configuration in the sidebar and clicking on General, or by manually editing them in the Home Assistant configuration file called `configuration.yaml`. This section will explain how to do the latter.
|
||||
|
||||
<div class='note'>
|
||||
|
||||
This final step of the getting started only applies if you've installed Home Assistant via Hass.io. If you've used another installation method, [see here](/docs/configuration/).
|
||||
The steps below only apply if you've installed Home Assistant via Hass.io. If you've used another installation method, [see here](/docs/configuration/).
|
||||
|
||||
</div>
|
||||
|
||||
@ -24,20 +24,40 @@ Under the "Core" section you will find HASS Configurator.
|
||||
- Now start the add-on by clicking on START.
|
||||
- Open the user interface by clicking on OPEN WEB UI.
|
||||
|
||||
Now let's make a small change using the configurator: we are going to change the name and location of your Home Assistant installation.
|
||||
Now let's make a change using the configurator: we are going to change the name, location, unit system, and time zone of your Home Assistant installation.
|
||||
|
||||
- Click the folder icon in the top left of the configurator window to open the file browser sidebar.
|
||||
- Click the `configuration.yaml` file (in the `/config/` folder) to load it into the main Configurator edit window.
|
||||
- Find the `homeassistant:` configuration block, which should be the first thing in `configuration.yaml`. In this block, update `name`, `latitude`, `longitude`, `unit_system` and `time_zone` to match yours.
|
||||
- Add the following to this file (preferably at the very top, but it ultimately doesn't matter):
|
||||
```yaml
|
||||
homeassistant:
|
||||
name: Home
|
||||
latitude: xx.xxxx
|
||||
longitude: xx.xxxx
|
||||
unit_system: imperial
|
||||
time_zone: America/Chicago
|
||||
```
|
||||
<div class='note'>
|
||||
|
||||
Valid options for `unit_system` are `imperial` or `metric`. See [here](https://timezonedb.com/time-zones) for a list of valid time zones. Enter the appropriate option found under the Time Zone column at that page.
|
||||
|
||||
</div>
|
||||
|
||||
- Click the save icon in the top right to commit changes.
|
||||
- Most changes in `configuration.yaml` require Home Assistant to be restarted to see the changes. You can verify that your changes are acceptable by running a config check. Do this by clicking on Configuration in the sidebar, click on "Server Control" and click on the "CHECK CONFIG" button. When it's valid, it will show the text "Configuration valid!".
|
||||
- Now Restart Home Assistant using the "restart" in the Server management section on the same page. In order for "Check Config" to be visible, you must enable "Advanced Mode" on your user profile.
|
||||
- Most changes in `configuration.yaml` require Home Assistant to be restarted to see the changes. You can verify that your changes are acceptable by running a config check. Do this by clicking on Configuration in the sidebar, click on "Server Control" and click on the CHECK CONFIG button. When it's valid, it will show the text "Configuration valid!"
|
||||
- Now Restart Home Assistant using the RESTART button in the Server management section on the same page. In order for "Check Config" to be visible, you must enable "Advanced Mode" on your user profile.
|
||||
|
||||
<p class='img'>
|
||||
<img src='/images/screenshots/configuration-validation.png' />
|
||||
Screenshot of the "General" page in the configuration panel.
|
||||
</p>
|
||||
|
||||
<div class='note'>
|
||||
|
||||
If you have watched any videos about setting up Home Assistant using configuration.yaml (particularly ones that are old), you might notice your default configuration file is much smaller than what the videos show. Don't be concerned, you haven't done anything wrong. Many items in the default configuration files shown in those old videos are now included in the `default_config:` line that you see in your configuration file. [See here](/integrations/default_config/) for more information on what's included in that line.
|
||||
|
||||
</div>
|
||||
|
||||
### Editing config via Samba/Windows Networking
|
||||
|
||||
Maybe you are not a big fan of our web editor and want to use a text editor on your computer instead. This is possible by sharing the configuration over the network using the Samba add-on, which can also be installed from the Hass.io add-on store. This will make your configuration accessible via the network tab on your computer.
|
||||
|
@ -5,11 +5,35 @@ description: "Instructions to get Home Assistant configured."
|
||||
|
||||
Alright, you made it here. The tough part is done.
|
||||
|
||||
With Home Assistant installed, it's time for doing the initial configuration. Here you will create the owner account of Home Assistant. This account will be an administrator and will always be able to change everything. Enter a name, username, password and click on "create account".
|
||||
With Home Assistant installed, it's time to configure it. Here you will create the owner account of Home Assistant. This account will be an administrator and will always be able to change everything. Enter a name, username, password and click on "create account".
|
||||
|
||||
Now you're brought to the main screen of Home Assistant: the states screen. The states screen will show all your devices. So let's get that screen filled up!
|
||||
<p class='img'>
|
||||
<img src='/images/getting-started/username.png' />
|
||||
Set your username and password.
|
||||
</p>
|
||||
|
||||
Open the menu on the top left and click on Configuration. On the next screen, click on Integrations. At this screen you will be able to set up integrations with Home Assistant. You might notice a "discovered" section, these are integrations that we found on your network and can easily be added with a few clicks. If your integrations are not discovered, find them in the list and click on configure.
|
||||
Next, you can enter a name for your home and set your location and unit system. Click "DETECT" to find your location and set your time zone and unit system based on that location. If you'd rather not send your location, you can set these values manually.
|
||||
|
||||
<p class='img'>
|
||||
<img src='/images/getting-started/location.png' />
|
||||
Set your location, time zone, and unit system.
|
||||
</p>
|
||||
|
||||
Once you are done, click Next. In this screen, Home Assistant will show any devices that it has discovered on your network. Don't be alarmed if you see fewer items than what is shown below; you can always manually add devices later.
|
||||
|
||||
<p class='img'>
|
||||
<img src='/images/getting-started/devices.png' />
|
||||
Discovery of devices on your network.
|
||||
</p>
|
||||
|
||||
Finally, click Finish. Now you're brought to the Home Assistant web interface. This screen will show all of your devices. So let's get that screen filled up!
|
||||
|
||||
<p class='img'>
|
||||
<img src='/images/getting-started/lovelace.png' />
|
||||
The Home Assistant user interface.
|
||||
</p>
|
||||
|
||||
Click on Configuration in the sidebar on the left. On the next screen, click on Integrations. At this screen you will be able to set up integrations with Home Assistant. You might notice a "discovered" section. This section contains integrations that were found on your network and can easily be added with a few clicks. If your integrations are not discovered, click the + button in the lower right and search for your integration in that list.
|
||||
|
||||
<p class='img'>
|
||||
<img src='/images/getting-started/integrations.png' />
|
||||
@ -18,6 +42,6 @@ The integrations page in the configurations panel shows you all your configured
|
||||
|
||||
When each integration is done setting up, it will ask you to put the new devices in areas. Areas allow you to organize all the devices in your home.
|
||||
|
||||
When you're done, navigate back to the states panel and voila, your devices are ready for you to control.
|
||||
When you're done, navigate back to the web interface and voila, your devices are ready for you to control.
|
||||
|
||||
### [Next step: Automate Home Assistant »](/getting-started/automation/)
|
||||
|
BIN
source/images/getting-started/action.png
Normal file
After Width: | Height: | Size: 44 KiB |
BIN
source/images/getting-started/automation-editor.png
Normal file
After Width: | Height: | Size: 106 KiB |
Before Width: | Height: | Size: 51 KiB |
Before Width: | Height: | Size: 48 KiB |
Before Width: | Height: | Size: 51 KiB |
BIN
source/images/getting-started/devices.png
Normal file
After Width: | Height: | Size: 42 KiB |
Before Width: | Height: | Size: 45 KiB After Width: | Height: | Size: 71 KiB |
BIN
source/images/getting-started/location.png
Normal file
After Width: | Height: | Size: 275 KiB |
BIN
source/images/getting-started/lovelace.png
Normal file
After Width: | Height: | Size: 116 KiB |
BIN
source/images/getting-started/new-automation.png
Normal file
After Width: | Height: | Size: 135 KiB |
BIN
source/images/getting-started/new-trigger.png
Normal file
After Width: | Height: | Size: 84 KiB |
BIN
source/images/getting-started/username.png
Normal file
After Width: | Height: | Size: 40 KiB |