Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
e6021f6
Add missing link to update (#16994)
ludeeus Mar 14, 2021
ede860d
Some fixes for service-call docu (#17006)
spacegaier Mar 15, 2021
57acb25
Add icon reference to Lovelace documentation (#16865)
frenck Mar 15, 2021
63d0f4a
Add unique ID to weather template (#16869)
frenck Mar 15, 2021
9cfdae1
Add note about tested hardware in NAD documentation (#16870)
frenck Mar 15, 2021
a910742
Lowercase MDI icons URLs (#17012)
frenck Mar 15, 2021
6d01d72
[Xiaomi Miio] Add example for vacuum segment clean with repetition (#…
b0g3r Mar 15, 2021
040aed6
generic camera : example of secured access (#16991)
cnico Mar 15, 2021
259fb6f
added another choose example (#16972)
Nihvel Mar 15, 2021
fff7349
Remove additional ")" (#16980)
eifinger Mar 15, 2021
9dad584
Bump nokogiri from 1.11.1 to 1.11.2 (#16964)
dependabot[bot] Mar 15, 2021
d7295df
Tweaks to the blueprint selectors (#17007)
spacegaier Mar 15, 2021
59853a9
corrected parameter in Service `opentherm_gw.set_hot_water_setpoint` …
ejars Mar 15, 2021
f81f898
added missing instructions (#16933)
ikifar2012 Mar 15, 2021
db18cb2
Add report model to Yeelight documentation (#17015)
frenck Mar 15, 2021
2a84f1e
Update verisure documentation for 2fa bug (#17013)
martycochrane Mar 15, 2021
540557d
Small fix (#17021)
cogneato Mar 16, 2021
52a872b
Update output of help (#17023)
cogneato Mar 16, 2021
78febbe
Wrap service call docs template example value in quotes (#17025)
davidjb Mar 16, 2021
f464e9f
Update automation.markdown (#17027)
anugs Mar 16, 2021
172011f
Remove confusing line from History docs (#17032)
frenck Mar 16, 2021
19178b2
Removed repeated word (#17043)
fredericks1982 Mar 17, 2021
e69ebc0
Bump kramdown from 2.3.0 to 2.3.1 (#17046)
dependabot[bot] Mar 18, 2021
d01307c
Add ESPHome blog
balloob Mar 18, 2021
0c2aab0
Add social image on top
balloob Mar 18, 2021
c995bef
Typo
balloob Mar 19, 2021
6296f4b
Update using_blueprints.markdown (#16910)
jonwaland Mar 19, 2021
4b5b185
Bump textlint from 11.8.2 to 11.8.3 (#17054)
dependabot[bot] Mar 19, 2021
08f8a98
Original doc for the Leviosa Zone hub
altersis Mar 19, 2021
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Gemfile
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ group :jekyll_plugins do
end

gem 'sinatra', '2.1.0'
gem 'nokogiri', '1.11.1'
gem 'nokogiri', '1.11.2'

# Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem
# and associated library
Expand Down
8 changes: 4 additions & 4 deletions Gemfile.lock
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ GEM
nokogiri (~> 1.10)
jekyll-watch (2.2.1)
listen (~> 3.0)
kramdown (2.3.0)
kramdown (2.3.1)
rexml
kramdown-parser-gfm (1.1.0)
kramdown (~> 2.0)
Expand All @@ -74,10 +74,10 @@ GEM
multi_json (1.15.0)
mustermann (1.1.1)
ruby2_keywords (~> 0.0.1)
nokogiri (1.11.1)
nokogiri (1.11.2)
mini_portile2 (~> 2.5.0)
racc (~> 1.4)
nokogiri (1.11.1-x64-mingw32)
nokogiri (1.11.2-x64-mingw32)
racc (~> 1.4)
pathutil (0.16.2)
forwardable-extended (~> 2.6)
Expand Down Expand Up @@ -130,7 +130,7 @@ DEPENDENCIES
jekyll-sitemap (= 1.4.0)
jekyll-time-to-read (= 0.1.2)
jekyll-toc (= 0.17.0)
nokogiri (= 1.11.1)
nokogiri (= 1.11.2)
rake (= 13.0.3)
sass-globbing (= 1.1.5)
sassc (= 2.1.0)
Expand Down
274 changes: 137 additions & 137 deletions package-lock.json

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
"remark-lint-fenced-code-flag": "^2.0.1",
"remark-lint-no-shell-dollars": "^2.0.2",
"remark-stringify": "^9.0.1",
"textlint": "^11.8.2",
"textlint": "^11.8.3",
"textlint-rule-common-misspellings": "^1.0.1",
"textlint-rule-terminology": "^2.1.5"
},
Expand Down
6 changes: 3 additions & 3 deletions source/_docs/automation.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,14 @@ title: "Automating Home Assistant"
description: "Steps to help you get automation setup in Home Assistant."
---

Home Assistant contains information about all your devices and services. This information is not only available for the user in the dashboard, it can also be used to trigger automations. And that's fun!
Home Assistant contains information about all your devices and services. This information is available for the user in the dashboard and it can be used to trigger automations. And that's fun!

Automations in Home Assistant allow you to automatically respond to things that happen. You can turn the lights on at sunset or pause the music when you receive a call.

If you are just starting out, we strongly suggest you start with blueprint automations. These are ready-made automations by the community that you only need to configure.
If you are just starting out, we recommend that you start with blueprint automations. These are ready-made automations by the community that you only need to configure.

### [Learn about automation blueprints »](/docs/automation/using_blueprints/)

If you got the hang of blueprints and need more, it's time for the next step. But before we can start creating automations, you will need to learn about the automation basics.
If you have got the hang of blueprints and would like to explore more, it's time for the next step. But before you start creating automations, you will need to learn about the automation basics.

### [Learn about automation basics »](/docs/automation/basics/)
4 changes: 4 additions & 0 deletions source/_docs/automation/using_blueprints.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -44,3 +44,7 @@ The Home Assistant Community forums have a specific tag for blueprints. This tag
[Visit the Home Assistant forums][blueprint-forums]

[blueprint-forums]: /get-blueprints

## Troubleshooting missing automations

When you're creating automations using blueprints and they don't appear in the UI, make sure that you add back `automation: !include automations.yaml` from the default configuration to your `configuration.yaml`.
18 changes: 9 additions & 9 deletions source/_docs/blueprint/selectors.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Some selectors can, for example, show a toggle button to turn something
on or off, while another select can filter a list of devices to show
only devices that have motion-sensing capabilities.

Having the good selectors set on your blueprint automations inputs makes a
Having good selectors set on your blueprint automation inputs makes a
blueprint easier to use from the UI.

The following selectors are currently available:
Expand Down Expand Up @@ -53,7 +53,7 @@ The add-on selector allows the user to input an add-on slug.
On the user interface, it will list all installed add-ons and use the slug of the
selected add-on.

![Screenshot of an Add-on selector](/images/blueprints/selector-addon.png)
![Screenshot of an add-on selector](/images/blueprints/selector-addon.png)

This selector does not have any other options; therefore, it only has its key.

Expand All @@ -71,7 +71,7 @@ and entities that are assigned to those areas. For example, the areas list could
be limited to areas with entities provided by the [ZHA](/integrations/zha)
integration.

In its most basic form, it doesn't require any options, which will show
In its most basic form, this selector doesn't require any options, which will show
all areas.

```yaml
Expand Down Expand Up @@ -183,9 +183,9 @@ A device selector can filter the list of devices, based on things like the
manufacturer or model of the device, the entities the device provides or based
on the domain that provided the device.

![Screenshot of an device selector](/images/blueprints/selector-device.png)
![Screenshot of a device selector](/images/blueprints/selector-device.png)

In its most basic form, it doesn't require any options, which will show
In its most basic form, this selector doesn't require any options, which will show
all devices.

```yaml
Expand Down Expand Up @@ -270,7 +270,7 @@ entity.

![Screenshot of an entity selector](/images/blueprints/selector-entity.png)

In its most basic form, it doesn't require any options, which will show
In its most basic form, this selector doesn't require any options, which will show
all entities.

```yaml
Expand Down Expand Up @@ -329,7 +329,7 @@ On the user interface, the input can either be in a slider or number mode.
Both modes limit the user input by a minimal and maximum value, and can
have a unit of measurement to go with it.

In its most basic form, it requires a minimal and maximum value:
In its most basic form, this selector requires a minimal and maximum value:

```yaml
number:
Expand Down Expand Up @@ -425,7 +425,7 @@ options:

## Target selector

The target selector is a rather special selector, allowing the user to selector
The target selector is a rather special selector, allowing the user to select
targeted entities, devices or areas for service calls. The value of
the input will contain a special target format, that is accepted by
service calls.
Expand All @@ -436,7 +436,7 @@ those properties in those areas.

![Screenshot of a target selector](/images/blueprints/selector-target.png)

Its most basic form, doesn't require any options, which will allow the
In its most basic form, this selector does not require any options, which will allow the
user to target any entity, device or area available in the system.

```yaml
Expand Down
2 changes: 1 addition & 1 deletion source/_docs/configuration/customizing-devices.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ entity_picture:
required: false
type: string
icon:
description: "Any icon from [MaterialDesignIcons.com](http://MaterialDesignIcons.com) ([Cheatsheet](https://cdn.materialdesignicons.com/5.3.45/)). Prefix name with `mdi:`, ie `mdi:home`. Note: Newer icons may not yet be available in the current Home Assistant release. You can check when an icon was added to MaterialDesignIcons.com at [MDI History](https://materialdesignicons.com/history)."
description: "Any icon from [MaterialDesignIcons.com](http://materialdesignicons.com). Prefix name with `mdi:`, ie `mdi:home`. Note: Newer icons may not yet be available in the current Home Assistant release. You can check when an icon was added to MaterialDesignIcons.com at [MDI History](https://materialdesignicons.com/history)."
required: false
type: string
assumed_state:
Expand Down
2 changes: 1 addition & 1 deletion source/_docs/configuration/templating.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ Extensions allow templates to access all of the Home Assistant specific states a

### Limited Templates

Templates for some triggers [triggers](/docs/automation/trigger/) as well as `trigger_variables` only support a subset of the Home Assistant template extensions. This subset is referred to as "Limited Templates".
Templates for some [triggers](/docs/automation/trigger/) as well as `trigger_variables` only support a subset of the Home Assistant template extensions. This subset is referred to as "Limited Templates".

### States

Expand Down
2 changes: 1 addition & 1 deletion source/_docs/locked_out.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ or need to recover your data.

If you are still logged in to the web interface with your user, then you are in luck. Add a new user as an administrator and give the new user a password you can remember. Then log out, and log in with this new user. You may then reset your password via this new administrator account (and then delete this new account), or you can delete your old user account. Either way, your configuration will remain, and you don't have to do a new onboarding process.

If you’ve forgotten your username, then deleting the files mentioned above will be necessary to start a new onboarding process.
If you’ve forgotten your username, then deleting the files mentioned further below will be necessary to start a new onboarding process.

#### To reset a user's password, via console
If you know the username, but not the password and you can access the [Home Assistant console](https://www.home-assistant.io/hassio/commandline/) and use the command below:
Expand Down
58 changes: 58 additions & 0 deletions source/_docs/scripts.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -610,6 +610,64 @@ automation:

{% endraw %}


More `choose` can be used together. This is the case of an IF-IF.

The following example shows how a single automation can control entities that aren't related to each other but have in common the same trigger.

When the sun goes below the horizon, the `porch` and `garden` lights must turn on. If someone is watching the TV in the living room, there is a high chance that someone is in that room, therefore the living room lights have to turn on too. The same concept applies to the `studio` room.

{% raw %}

```yaml
# Example with "if" and "if"
automation:
- alias: "Turn lights on when the sun gets dim and if some room is occupied"
trigger:
- platform: numeric_state
entity_id: sun.sun
attribute: elevation
below: 4
action:
# This must always apply
- service: light.turn_on
data:
brightness: 255
color_temp: 366
target:
entity_id:
- light.porch
- light.garden
# IF a entity is ON
- choose:
- conditions:
- condition: state
entity_id: binary_sensor.livingroom_tv
state: "on"
sequence:
- service: light.turn_on
data:
brightness: 255
color_temp: 366
target:
entity_id: light.livingroom
# IF another entity not related to the previous, is ON
- choose:
- conditions:
- condition: state
entity_id: binary_sensor.studio_pc
state: "on"
sequence:
- service: light.turn_on
data:
brightness: 255
color_temp: 366
target:
entity_id: light.studio
```

{% endraw %}

[Script component]: /integrations/script/
[automations]: /getting-started/automation-action/
[Alexa/Amazon Echo]: /integrations/alexa/
Expand Down
14 changes: 7 additions & 7 deletions source/_docs/scripts/service-calls.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "Service Calls"
description: "Instructions on how to call services in Home Assistant."
---

Various integrations allow calling services when a certain event occurs. The most common one is calling a service when an automation trigger happens. But a service can also be called from a script or via the Amazon Echo.
Various integrations allow calling services when a certain event occurs. The most common one is calling a service when an automation trigger happens. But a service can also be called from a script, a Lovelace dashboard or via voice command devices such as Amazon Echo.

The configuration options to call a configuration are the same between all integrations and are described on this page.

Expand All @@ -27,10 +27,10 @@ entity_id: group.living_room
Instead of targeting an entity, you can also target an area or device. Or a combination of these.
This is done with the `target` key.

A `target` is a map thats contains atleast one of the following: `area_id`, `device_id`, `entity_id`.
A `target` is a map that contains at least one of the following: `area_id`, `device_id`, `entity_id`.
Each of these can be a list.

When the service is called, the area's and devices will be resolved to entities.
When the service is called, the areas and devices will be resolved to entities.

```yaml
service: homeassistant.turn_on
Expand All @@ -46,7 +46,7 @@ target:

### Passing data to the service call

You can also specify other parameters beside the entity to target. For example, the light turn on service allows specifying the brightness.
You can also specify other parameters beside the entity to target. For example, the `light.turn_on` service allows specifying the brightness.

```yaml
service: light.turn_on
Expand Down Expand Up @@ -103,16 +103,16 @@ target:
thermostat.downstairs
{% endif %}
data:
temperature: {{ 22 - distance(states.device_tracker.paulus) }}
temperature: "{{ 22 - distance(states.device_tracker.paulus) }}"
```

{% endraw %}
### `homeassistant` services

There are four `homeassistant` services that aren't tied to any single domain, these are:

- `homeassistant.turn_on` - Turns on an entity (that supports being turned on), for example an `automation`, `switch`, etc
- `homeassistant.turn_off` - Turns off an entity (that supports being turned off), for example an `automation`, `switch`, etc
- `homeassistant.turn_on` - Turns on an entity (that supports being turned on), for example an `automation`, `switch`, etc.
- `homeassistant.turn_off` - Turns off an entity (that supports being turned off), for example an `automation`, `switch`, etc.
- `homeassistant.toggle` - Turns off an entity that is on, or turns on an entity that is off (that supports being turned on and off)
- `homeassistant.update_entity` - Request the update of an entity, rather than waiting for the next scheduled update, for example [Google travel time] sensor, a [template sensor], or a [light]

Expand Down
11 changes: 10 additions & 1 deletion source/_includes/common-tasks/commandline.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,21 +67,30 @@ Usage:

Available Commands:
addons Install, update, remove and configure Home Assistant add-ons
audio Audio device handling.
authentication Authentication for Home Assistant users.
banner Prints the CLI Home Assistant banner along with some useful information
cli Get information, update or configure the Home Assistant cli backend
core Provides control of the Home Assistant Core
dns Get information, update or configure the Home Assistant DNS server
docker Docker backend specific for info and OCI configuration
hardware Provides hardware information about your system
help Help about any command
host Control the host/system that Home Assistant is running on
info Provides a general Home Assistant information overview
jobs Get information and manage running jobs
multicast Get information, update or configure the Home Assistant Multicast
network Network specific for updating, info and configuration imports
observer Get information, update or configure the Home Assistant observer
os Operating System specific for updating, info and configuration imports
resolution Resolution center of Supervisor, show issues and suggest solutions
snapshots Create, restore and remove snapshot backups
supervisor Monitor, control and configure the Home Assistant Supervisor

Flags:
--api-token string Home Assistant Supervisor API token
--config string Optional config file (default is $HOME/.homeassistant.yaml)
--endpoint string Endpoint for Home Assistant Supervisor ( default is 'supervisor' )
--endpoint string Endpoint for Home Assistant Supervisor (default is 'supervisor')
-h, --help help for ha
--log-level string Log level (defaults to Warn)
--no-progress Disable the progress spinner
Expand Down
1 change: 1 addition & 0 deletions source/_includes/installation/operating_system.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,7 @@ _Select and copy the URL or use the "copy" button that appear when you hover it.
1. Put the SD card in your card reader.
2. Open balenaEtcher, select the Home Assistant image and flash it to the SD card.
3. Unmount the SD card and remove it from your card reader.
4. Once completed you will be able to reach Home Assistant on <a href="http://homeassistant.local:8123" target="_blank">homeassistant.local:8123</a>. If you are running an older Windows version or have a stricter network configuration, you might need to access Home Assistant at <a href="http://homeassistant:8123" target="_blank">homeassistant:8123</a> or `http://X.X.X.X:8123` (replace X.X.X.X with your {{site.installation.types[page.installation_type].board}}’s IP address).
{% else %}

### Create the Virtual Machine
Expand Down
16 changes: 16 additions & 0 deletions source/_integrations/generic.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -139,3 +139,19 @@ camera:
still_image_url: http://194.218.96.92/jpg/image.jpg
stream_source: rtsp://194.218.96.92:554
```

### Secured access to the camera

To access a camera that requires secured access for still image or live stream (an HIK in my case).

```yaml
camera:
- platform: generic
still_image_url: "http://192.168.1.100/ISAPI/Streaming/Channels/101/picture"
stream_source: "rtsp://USERNAME:PASSWORD@192.168.1.100:554/Streaming/Channels/102"
name: "My Camera"
verify_ssl: false
username: "USERNAME"
password: "PASSWORD"
authentication: digest
```
18 changes: 9 additions & 9 deletions source/_integrations/history.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -164,15 +164,15 @@ The following characters can be used in entity globs:
The history is stored in a SQLite database `home-assistant_v2.db` within your
configuration directory unless the `recorder` integration is set up differently.

- events table is all events except `time_changed` that happened while recorder integration was running.
- states table contains all the `new_state` values of `state_changed` events.
- Inside the states table you have:
- `entity_id`: the entity_id of the entity
- `state`: the state of the entity
- `attributes`: JSON of the state attributes
- `last_changed`: timestamp last time the state has changed. A state_changed event can happen when just attributes change.
- `last_updated`: timestamp anything has changed (state, attributes)
- `created`: timestamp this entry was inserted into the database
- events table is all events except `time_changed` that happened while recorder integration was running.
- states table contains all the `new_state` values of `state_changed` events.
- Inside the states table you have:
- `entity_id`: the entity_id of the entity
- `state`: the state of the entity
- `attributes`: JSON of the state attributes
- `last_changed`: timestamp last time the state has changed.
- `last_updated`: timestamp anything has changed (state, attributes)
- `created`: timestamp this entry was inserted into the database

When the `history` integration queries the states table it only selects states
where the state has changed: `WHERE last_changed=last_updated`
Expand Down
Loading