mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-16 13:56:53 +00:00
Docs c z apply sentence style caps add term refs (#29892)
* Docs a-b: apply sentence-style-caps, add term refs * Docs: apply sentence-style-caps, add term refs * Apply suggestions from code review * Glossary: add alias for plural * Apply suggestions from code review Co-authored-by: Joakim Sørensen <joasoe@gmail.com> --------- Co-authored-by: Joakim Sørensen <joasoe@gmail.com>
This commit is contained in:
c0ffeeca7
GitHub
parent
473d9d3fae
commit
8d98500d0e
@ -338,6 +338,8 @@
|
||||
a scene can specify that light A should be turned on and light B should
|
||||
be bright red.
|
||||
link: /integrations/scene/
|
||||
aliases:
|
||||
- scenes
|
||||
|
||||
- term: Script
|
||||
definition: >
|
||||
@ -396,6 +398,8 @@
|
||||
State changes can be used as the source of triggers. The current state can be used in conditions.
|
||||
|
||||
link: /docs/configuration/state_object/
|
||||
aliases:
|
||||
- states
|
||||
excerpt: >
|
||||
The state holds the information of interest of an entity, for example, if a light is on or off. Each entity has exactly one state and the state only holds one value at a time. However, entities can store attributes related to that state such as brightness, color, or a unit of measurement.
|
||||
|
||||
@ -411,6 +415,8 @@
|
||||
service or data from the trigger values. This allows automations to generate
|
||||
dynamic actions.
|
||||
link: /docs/automation/templating/
|
||||
aliases:
|
||||
- templates
|
||||
|
||||
- term: Thread
|
||||
definition: >-
|
||||
@ -425,6 +431,8 @@
|
||||
A trigger is a set of values or conditions of a platform that are defined
|
||||
to cause an automation to run.
|
||||
link: /docs/automation/trigger/
|
||||
aliases:
|
||||
- triggers
|
||||
|
||||
- term: TTS
|
||||
definition: >-
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
---
|
||||
title: "Asterisk Voicemail Server Installation"
|
||||
title: "Asterisk Voicemail server installation"
|
||||
description: "Instructions on how to integrate your existing Asterisk voicemail within Home Assistant."
|
||||
---
|
||||
|
||||
|
||||
@ -24,7 +24,7 @@ For the moment, other user accounts will have the same access as the owner accou
|
||||
If you want to manage users and you're an owner but you do not see "Users" in your main configuration menu, make sure that "Advanced Mode" is enabled for your user in your profile.
|
||||
</div>
|
||||
|
||||
### Your Account Profile
|
||||
### Your account profile
|
||||
|
||||
Once you're logged in, you can see the details of your account at the _Profile_ page by clicking on the circular at the very bottom of the sidebar.
|
||||
|
||||
@ -105,9 +105,9 @@ Replace `12.34.56.78` with your Home Assistant's public IP address.
|
||||
|
||||
This will allow you to open Home Assistant at `http://homeassistant.home:8123/`
|
||||
|
||||
### Stuck on Loading data
|
||||
### Stuck on loading data
|
||||
|
||||
Some ad blocking software, such as Wipr, also blocks web sockets. If you're stuck on the Loading data screen, try disabling your ad blocker.
|
||||
Some ad blocking software, such as Wipr, also blocks WebSockets. If you're stuck on the Loading data screen, try disabling your ad blocker.
|
||||
|
||||
### Migrating from pre 0.77
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "Authentication Providers"
|
||||
description: "Guide on configuring different auth providers."
|
||||
title: "Authentication providers"
|
||||
description: "Guide on configuring different authentication providers."
|
||||
---
|
||||
|
||||
<div class='note warning'>
|
||||
@ -103,7 +103,7 @@ allow_bypass_login:
|
||||
type: boolean
|
||||
{% endconfiguration %}
|
||||
|
||||
#### Trusted Users Examples
|
||||
#### Trusted users examples
|
||||
|
||||
```yaml
|
||||
homeassistant:
|
||||
@ -131,7 +131,7 @@ In above example, if user try to access Home Assistant from 192.168.0.1, they wi
|
||||
|
||||
Specially, you can use `group: GROUP_ID` to assign all users in certain `user group` to be available to choose. Group and users can be mix and match.
|
||||
|
||||
#### Skip Login Page Examples
|
||||
#### Skip login page examples
|
||||
|
||||
This is a feature to allow you to bring back some of the experience before the user system was implemented. You can directly jump to the main page if you are accessing from trusted networks, the `allow_bypass_login` is on, and you have ONLY ONE available user to choose from in the login form.
|
||||
|
||||
|
||||
@ -3,7 +3,7 @@ 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 available for the user in the dashboard and it can be used to trigger automations. And that's fun!
|
||||
Home Assistant contains information about all your {% term devices %} and {% term services %}. This information is available for the user in the dashboard and it can be used to trigger {% term 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.
|
||||
|
||||
|
||||
@ -1,11 +1,11 @@
|
||||
---
|
||||
title: "Automation Actions"
|
||||
title: "Automation actions"
|
||||
description: "Automations result in action."
|
||||
---
|
||||
|
||||
The action of an automation rule is what is being executed when a rule fires. The action part follows the [script syntax](/docs/scripts/) which can be used to interact with anything via services or events. For services you can specify the entity_id that it should apply to and optional service parameters (to specify for example the brightness).
|
||||
The action of an automation rule is what is being executed when a rule fires. The action part follows the [script syntax](/docs/scripts/) which can be used to interact with anything via services or events. For {% term services %}, you can specify the entity_id that it should apply to and optional service parameters (to specify for example the brightness).
|
||||
|
||||
You can also call the service to activate [a scene](/integrations/scene/) which will allow you to define how you want your devices to be and have Home Assistant call the right services.
|
||||
You can also call the {% term service %} to activate [a scene](/integrations/scene/) which will allow you to define how you want your devices to be and have Home Assistant call the right services.
|
||||
|
||||
{% raw %}
|
||||
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
---
|
||||
title: "Understanding Automations"
|
||||
title: "Understanding automations"
|
||||
description: "A breakdown of what an automation consists of."
|
||||
---
|
||||
|
||||
|
||||
@ -1,9 +1,9 @@
|
||||
---
|
||||
title: "Automation Conditions"
|
||||
title: "Automation conditions"
|
||||
description: "Automations can test conditions when invoked."
|
||||
---
|
||||
|
||||
Conditions are an optional part of an automation rule. They can be used to prevent the automation's actions from being run. After a trigger occurred, all conditions will be checked. If any of them do not return true, the automation will stop executing. Conditions look very similar to triggers, but they are very different — a trigger will look at events happening in the system, while a condition only looks at how the system looks right now. A trigger can observe that a switch is being turned on. A condition can only see if a switch is currently on or off.
|
||||
Conditions are an optional part of an automation rule. They can be used to prevent the automation's actions from being run. After a {% term trigger %} occurred, all conditions will be checked. If any of them do not return true, the automation will stop executing. Conditions look very similar to triggers, but they are very different — a trigger will look at events happening in the system, while a condition only looks at how the system looks right now. A trigger can observe that a switch is being turned on. A condition can only see if a switch is currently on or off.
|
||||
|
||||
The available conditions for an automation are the same as for the script syntax so see that page for a [full list of available conditions](/docs/scripts/conditions/).
|
||||
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
---
|
||||
title: "Automation Editor"
|
||||
title: "Automation editor"
|
||||
description: "Instructions on how to use the automation editor."
|
||||
---
|
||||
|
||||
|
||||
@ -1,11 +1,11 @@
|
||||
---
|
||||
title: "Automation Modes"
|
||||
title: "Automation modes"
|
||||
description: "How to use and configure automation modes."
|
||||
---
|
||||
|
||||
An automation can be triggered while it is already running.
|
||||
An {% term automation %} can be triggered while it is already running.
|
||||
|
||||
The automation's `mode` configuration option controls what happens when the automation is triggered while the actions are still running from a previous trigger.
|
||||
The automation's `mode` configuration option controls what happens when the automation is triggered while the {% term actions %} are still running from a previous {% term trigger %}.
|
||||
|
||||
Mode | Description
|
||||
-|-
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
---
|
||||
title: "Automation Services"
|
||||
title: "Automation services"
|
||||
description: "How to use the various automation services."
|
||||
---
|
||||
|
||||
@ -7,7 +7,7 @@ The automation integration has services to control automations, like turning aut
|
||||
|
||||
## Service {% my developer_call_service service="automation.turn_on" %}
|
||||
|
||||
This service enables the automation's triggers.
|
||||
This service enables the automation's {% term triggers %}.
|
||||
|
||||
Service data attribute | Optional | Description
|
||||
-|-|-
|
||||
@ -15,7 +15,7 @@ Service data attribute | Optional | Description
|
||||
|
||||
## Service {% my developer_call_service service="automation.turn_off" %}
|
||||
|
||||
This service disables the automation's triggers, and optionally stops any currently active actions.
|
||||
This service disables the automation's {% term triggers %}, and optionally stops any currently active {% term actions %}.
|
||||
|
||||
Service data attribute | Optional | Description
|
||||
-|-|-
|
||||
@ -32,7 +32,7 @@ Service data attribute | Optional | Description
|
||||
|
||||
## Service {% my developer_call_service service="automation.trigger" %}
|
||||
|
||||
This service will trigger the action of an automation. By default it bypasses any conditions, though that can be changed via the `skip_condition` attribute.
|
||||
This service will trigger the {% term action %} of an {% term automation %}. By default it bypasses any conditions, though that can be changed via the `skip_condition` attribute.
|
||||
|
||||
Service data attribute | Optional | Description
|
||||
-|-|-
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
---
|
||||
title: "Automation Trigger Variables"
|
||||
title: "Automation trigger variables"
|
||||
description: "List all available variables made available by triggers."
|
||||
---
|
||||
|
||||
@ -7,13 +7,13 @@ Automations support [templating](/docs/configuration/templating/) in the same wa
|
||||
|
||||
The template variable `this` is also available when evaluating any `trigger_variables` declared in the configuration.
|
||||
|
||||
## Available this Data
|
||||
## Available `this` data
|
||||
|
||||
The variable `this` is the [state object](/docs/configuration/state_object) of the automation at the moment of triggering the actions. State objects also contain context data which can be used to identify the user that caused a script or automation to execute. Note that `this` will not change while executing the actions.
|
||||
The variable `this` is the [state object](/docs/configuration/state_object) of the automation at the moment of triggering the actions. State objects also contain context data which can be used to identify the user that caused a {% term script %} or {% term automation %} to execute. Note that `this` will not change while executing the {% term actions %}.
|
||||
|
||||
## Available Trigger Data
|
||||
## Available trigger data
|
||||
|
||||
The variable `trigger` is an object that contains details about which trigger triggered the automation.
|
||||
The variable `trigger` is an object that contains details about which {% term trigger %} triggered the automation.
|
||||
|
||||
Templates can use the data to modify the actions performed by the automation or displayed in a message. For example, you could create an automation that multiple sensors can trigger and then use the sensor's location to specify a light to activate; or you could send a notification containing the friendly name of the sensor that triggered it.
|
||||
|
||||
|
||||
@ -3,9 +3,9 @@ title: "Automation Trigger"
|
||||
description: "All the different ways how automations can be triggered."
|
||||
---
|
||||
|
||||
Triggers are what starts the processing of an automation rule. When _any_ of the automation's triggers becomes true (trigger _fires_), Home Assistant will validate the [conditions](/docs/automation/condition/), if any, and call the [action](/docs/automation/action/).
|
||||
Triggers are what starts the processing of an {% term automation %} rule. When _any_ of the automation's triggers becomes true (trigger _fires_), Home Assistant will validate the [conditions](/docs/automation/condition/), if any, and call the [action](/docs/automation/action/).
|
||||
|
||||
An automation can be triggered by an event, a certain entity state, at a given time, and more. These can be specified directly or more flexible via templates. It is also possible to specify multiple triggers for one automation.
|
||||
An {% term automation %} can be triggered by an {% term event %}, a certain {% term entity %} {% term state %}, at a given time, and more. These can be specified directly or more flexible via templates. It is also possible to specify multiple triggers for one automation.
|
||||
|
||||
- [Trigger ID](#trigger-id)
|
||||
- [Trigger variables](#trigger-variables)
|
||||
@ -34,6 +34,7 @@ An automation can be triggered by an event, a certain entity state, at a given t
|
||||
All triggers can be assigned an optional `id`. If the ID is omitted, it will instead be set to the index of the trigger. The `id` can be referenced from [trigger conditions and actions](/docs/scripts/conditions/#trigger-condition). The `id` does not have to be unique for each trigger, and it can be used to group similar triggers for use later in the automation (i.e., several triggers of different types that should all turn some entity on).
|
||||
|
||||
### Video tutorial
|
||||
|
||||
This video tutorial explains how trigger IDs work.
|
||||
|
||||
<lite-youtube videoid="fE_MYcXYwMI" videotitle="How to use Trigger IDs in Home Assistant - Tutorial" posterquality="maxresdefault"></lite-youtube>
|
||||
|
||||
@ -1,9 +1,9 @@
|
||||
---
|
||||
title: "Troubleshooting Automations"
|
||||
title: "Troubleshooting automations"
|
||||
description: "Tips on how to troubleshoot your automations."
|
||||
---
|
||||
|
||||
When an automation is run, all steps are recorded and a trace is made. From the UI choose **Settings** which is located in the sidebar, then click on **Automations & Scenes** to go to the automation editor or click this button directly: {% my automations badge %}
|
||||
When an {% term automation %} is run, all steps are recorded and a trace is made. From the UI, open **Settings**, which is located in the sidebar, then select **Automations & Scenes** to go to the automation editor or click this button directly: {% my automations badge %}
|
||||
|
||||
Click on the clock icon next to an automation to enter the debugging screen. Alternatively, click on **Show trace** directly from a Logbook automation entry.
|
||||
|
||||
|
||||
@ -3,7 +3,7 @@ title: "Using automation blueprints"
|
||||
description: "How to create automations based off blueprints."
|
||||
---
|
||||
|
||||
Automation blueprints are pre-made automations that you can easily add to your Home Assistant instance. Each blueprint can be added as many times as you want.
|
||||
Automation blueprints are pre-made {% term automations %} that you can easily add to your Home Assistant instance. Each blueprint can be added as many times as you want.
|
||||
|
||||
Quick links:
|
||||
|
||||
@ -11,7 +11,7 @@ Quick links:
|
||||
|
||||
## Blueprint automations
|
||||
|
||||
Automations based on a blueprint need to be configured. What needs to be configured differs on each blueprint.
|
||||
Automations based on a blueprint need to be configured. What needs to be configured differs by blueprint.
|
||||
|
||||
1. To create your first automation based on a blueprint, go to **{% my blueprints title="Settings > Automations & Scenes > Blueprints" %}**.
|
||||
2. Find the blueprint that you want to use and select **Create Automation**.
|
||||
|
||||
@ -3,7 +3,7 @@ title: "Automation YAML"
|
||||
description: "How to use the automation integration with YAML."
|
||||
---
|
||||
|
||||
Automations are created in Home Assistant via the UI, but are stored in a YAML format. If you want to edit the YAML of an automation, select the automation, click on the menu button in the top right then on **Edit in YAML**.
|
||||
Automations are created in Home Assistant via the UI, but are stored in a YAML format. If you want to edit the YAML of an {% term automation %}, select the automation, click on the menu button in the top right then on **Edit in YAML**.
|
||||
|
||||
The UI will write your automations to `automations.yaml`. This file is managed by the UI and should not be edited manually.
|
||||
|
||||
@ -70,7 +70,7 @@ trigger_variables:
|
||||
description: "The value of the variable. Any YAML is valid. Only [limited templates](/docs/configuration/templating/#limited-templates) can be used."
|
||||
type: any
|
||||
mode:
|
||||
description: "Controls what happens when the automation is invoked while it is still running from one or more previous invocations. See [Automation Modes](#automation-modes)."
|
||||
description: "Controls what happens when the automation is invoked while it is still running from one or more previous invocations. See [Automation modes](#automation-modes)."
|
||||
required: false
|
||||
type: string
|
||||
default: single
|
||||
@ -126,7 +126,6 @@ Mode | Description
|
||||
</p>
|
||||
|
||||
|
||||
|
||||
## YAML example
|
||||
|
||||
Example of a YAML based automation that you can add to `configuration.yaml`.
|
||||
|
||||
@ -3,7 +3,7 @@ title: "Database"
|
||||
description: "Details about the database used by Home Assistant."
|
||||
---
|
||||
|
||||
Home Assistant uses database to store events and parameters for history and tracking. The default database used is [SQLite](https://www.sqlite.org/) and the database file is stored in your [configuration directory](/getting-started/configuration/) (e.g., `<path to config dir>/home-assistant_v2.db`); however, other databases can be used. If you prefer to run a database server (e.g., PostgreSQL), use the [`recorder` integration](/integrations/recorder/).
|
||||
Home Assistant uses databases to store {% term events %} and parameters for history and tracking. The default database used is [SQLite](https://www.sqlite.org/) and the database file is stored in your [configuration directory](/getting-started/configuration/) (e.g., `<path to config dir>/home-assistant_v2.db`); however, other databases can be used. If you prefer to run a database server (e.g., PostgreSQL), use the [`recorder` integration](/integrations/recorder/).
|
||||
|
||||
To work with SQLite database manually from the command-line, you will need an [installation](https://www.sqlitetutorial.net/download-install-sqlite/) of `sqlite3`. Alternatively [DB Browser for SQLite](https://sqlitebrowser.org/) provides a viewer for exploring the database data and an editor for executing SQL commands.
|
||||
First load your database with `sqlite3`:
|
||||
|
||||
@ -7,9 +7,9 @@ This section gives a high-level introduction to blueprints. To view a descriptio
|
||||
|
||||
## What is a blueprint?
|
||||
|
||||
A blueprint is a script or automation configuration with certain parts marked as configurable. This allows you to create different scripts or automations based on the same blueprint.
|
||||
A blueprint is a {% term script %} or {% term automation %} configuration with certain parts marked as configurable. This allows you to create different scripts or automations based on the same blueprint.
|
||||
|
||||
Imagine you want to control lights based on motion. A blueprint provides the generic automation framework, while letting you select one specific motion sensor as a trigger, and the exact light to control. This blueprint makes it possible to create two automations. Each automation has their own configuration and act completely independently. Yet, they share some basic automation configuration so that you do not have to set this up every time.
|
||||
Imagine you want to control lights based on motion. A blueprint provides the generic {% term automation %} framework, while letting you select one specific motion sensor as a {% term trigger %}, and the exact light to control. This blueprint makes it possible to create two automations. Each automation has their own configuration and act completely independently. Yet, they share some basic automation configuration so that you do not have to set this up every time.
|
||||
|
||||
Blueprints are shared by the community in the [blueprint community forum][blueprint-forums].
|
||||
|
||||
|
||||
@ -716,7 +716,7 @@ light.living_room
|
||||
An example entity selector that, will only show entities that are:
|
||||
|
||||
- Provided by the [ZHA](/integrations/zha) integration.
|
||||
- From the [Binary Sensor](/integrations/binary_sensor) domain.
|
||||
- From the [Binary sensor](/integrations/binary_sensor) domain.
|
||||
- Have presented themselves as devices of a motion device class.
|
||||
- Allows selecting one or more entities.
|
||||
|
||||
|
||||
@ -5,7 +5,7 @@ description: "Tutorial on creating an automation blueprint."
|
||||
|
||||
<div class='note'>
|
||||
|
||||
While the tutorial only shows how to create an automation blueprint, scripts also support blueprints in the same way.
|
||||
While the tutorial only shows how to create an automation blueprint, {% term scripts %} also support blueprints in the same way.
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
@ -118,6 +118,6 @@ country:
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
## Reload Core Service
|
||||
## Reload core service
|
||||
|
||||
Home Assistant offers a service to reload the core configuration while Home Assistant is running called {% my developer_call_service service="homeassistant.reload_core_config" %}. This allows you to change any of the above sections and see it being applied without having to restart Home Assistant. To call this service, go to the "{% my developer_services %}" tab under {% my developer_services title="Developer Tools" %}, select the {% my developer_call_service service="homeassistant.reload_core_config" %} service and click the "CALL SERVICE" button. Alternatively, you can press the "Reload Location & Customizations" button under {% my server_controls title="Developer Tools > YAML" %}.
|
||||
Home Assistant offers a service to reload the core configuration while Home Assistant is running called {% my developer_call_service service="homeassistant.reload_core_config" %}. This allows you to change any of the above sections and see it being applied without having to restart Home Assistant. To call this service, go to the "{% my developer_services %}" tab under {% my developer_services title="Developer Tools" %}, select the {% my developer_call_service service="homeassistant.reload_core_config" %} service and click the "CALL SERVICE" button. Alternatively, you can press the "Location & Customizations" button under {% my server_controls title="Developer Tools > YAML" %}.
|
||||
|
||||
@ -7,8 +7,8 @@ description: "Simple customization for entities."
|
||||
|
||||
You can use the UI to change the entity ID and friendly name of supported entities. To do this:
|
||||
|
||||
1. Select the entity, either from the frontend or by clicking the info button next to the entity in the Developer Tools "States" tab.
|
||||
2. Click on the cog icon in the right corner of the entity's dialog
|
||||
1. Select the {% term entity %}, either from the frontend or by selecting the info button next to the entity in the Developer Tools "States" tab.
|
||||
2. Select the cog icon in the right corner of the entity's dialog
|
||||
|
||||
3. Enter the new name or the new entity ID (remember not to change the domain of the entity - the part before the `.`)
|
||||
|
||||
@ -61,11 +61,11 @@ initial_state:
|
||||
|
||||
Device class is currently supported by the following platforms:
|
||||
|
||||
- [Binary Sensor](/integrations/binary_sensor/)
|
||||
- [Binary sensor](/integrations/binary_sensor/)
|
||||
- [Button](/integrations/button/)
|
||||
- [Cover](/integrations/cover/)
|
||||
- [Humidifier](/integrations/humidifier/)
|
||||
- [Media Player](/integrations/media_player/)
|
||||
- [Media player](/integrations/media_player/)
|
||||
- [Number](/integrations/number/)
|
||||
- [Sensor](/integrations/sensor/)
|
||||
- [Switch](/integrations/switch/)
|
||||
|
||||
@ -1,9 +1,9 @@
|
||||
---
|
||||
title: "State Objects"
|
||||
title: "State objects"
|
||||
description: "Describes all there is to know about state objects in Home Assistant."
|
||||
---
|
||||
|
||||
Your devices are represented in Home Assistant as entities. The entities will write their current state to the state machine for other entities/templates/frontend to access. States are a current representation of the entity.
|
||||
Your {% term devices %} are represented in Home Assistant as entities. The {% term entities %} will write their current {% term state %} to the state machine for other entities/templates/frontend to access. States are a current representation of the {% term entity %}.
|
||||
|
||||
If you overwrite a state via the states dev tool or the API, it will not impact the actual device. If the device state is being polled, it will overwrite the state in the state machine the next polling.
|
||||
|
||||
@ -23,7 +23,7 @@ All states will always have an entity id, a state and a timestamp when last upda
|
||||
|
||||
## Attributes
|
||||
|
||||
The attributes of an entity are optional. There are a few attributes that are used by Home Assistant for representing the entity in a specific way. Each integration will also have its own attributes to represent extra state data about the entity. For example, the light integration has attributes for the current brightness and color of the light. When an attribute is not available, Home Assistant will not write it to the state.
|
||||
The attributes of an {% term entity %} are optional. There are a few attributes that are used by Home Assistant for representing the entity in a specific way. Each integration will also have its own attributes to represent extra state data about the entity. For example, the light integration has attributes for the current brightness and color of the light. When an attribute is not available, Home Assistant will not write it to the state.
|
||||
|
||||
When using templates, attributes will be available by their name. For example `state.attributes.assumed_state`.
|
||||
|
||||
@ -39,7 +39,7 @@ When an attribute contains spaces, you can retrieve it like this: `state_attr('s
|
||||
|
||||
## Context
|
||||
|
||||
Context is used to tie events and states together in Home Assistant. Whenever an automation or user interaction causes states to change, a new context is assigned. This context will be attached to all events and states that happen as result of the change.
|
||||
Context is used to tie {% term events %} and {% term states %} together in Home Assistant. Whenever an {% term automation %} or user interaction causes states to change, a new context is assigned. This context will be attached to all events and states that happen as result of the change.
|
||||
|
||||
| Field | Description |
|
||||
| ----- | ------------------------------------------------------------------- |
|
||||
|
||||
@ -46,7 +46,7 @@ script:
|
||||
|
||||
{% endraw %}
|
||||
|
||||
### Important Template Rules
|
||||
### Important template rules
|
||||
|
||||
There are a few very important rules to remember when adding templates to YAML:
|
||||
|
||||
@ -57,7 +57,7 @@ There are a few very important rules to remember when adding templates to YAML:
|
||||
|
||||
Remembering these simple rules will help save you from many headaches and endless hours of frustration when using automation templates.
|
||||
|
||||
### Enabled Jinja Extensions
|
||||
### Enabled Jinja extensions
|
||||
|
||||
Jinja supports a set of language extensions that add new functionality to the language.
|
||||
To improve the experience of writing Jinja templates, we have enabled the following
|
||||
@ -325,7 +325,7 @@ List of lights that are on with a brightness of 255:
|
||||
|
||||
{% endraw %}
|
||||
|
||||
### Working with Groups
|
||||
### Working with groups
|
||||
|
||||
Not supported in [limited templates](#limited-templates).
|
||||
|
||||
@ -1066,7 +1066,7 @@ The following overview contains a couple of options to get the needed values:
|
||||
|
||||
{% endraw %}
|
||||
|
||||
To evaluate a response, go to **{% my developer_template title="Developer Tools -> Template" %}**, create your output in "Template editor", and check the result.
|
||||
To evaluate a response, go to **{% my developer_template title="Developer Tools > Template" %}**, create your output in "Template editor", and check the result.
|
||||
|
||||
{% raw %}
|
||||
|
||||
|
||||
@ -98,11 +98,11 @@ The only characters valid in entity names are:
|
||||
|
||||
If you create an entity with other characters then Home Assistant may not generate an error for that entity. However you will find that attempts to use that entity will generate errors (or possibly fail silently).
|
||||
|
||||
## Debug Logs and Diagnostics
|
||||
## Debug logs and diagnostics
|
||||
|
||||
The first thing you will need before reporting an issue online is debug logs and diagnostics (if available) for the integration giving you trouble. Getting those ahead of time will ensure someone can help resolve your issue in the fastest possible manner.
|
||||
|
||||
### Enabling Debug Logging
|
||||
### Enabling debug logging
|
||||
|
||||
To enable debug logging for an integration, go to **Settings** > **Devices & Services** > **Integrations** and go to the detail page of the integration. Select the **Enable Debug Logging** button on the left side of the integration detail page.
|
||||
|
||||
@ -111,7 +111,7 @@ To enable debug logging for an integration, go to **Settings** > **Devices & Ser
|
||||
Example of Enable debug logging.
|
||||
</p>
|
||||
|
||||
### Disable Debug Logging and Download Logs
|
||||
### Disable debug logging and download logs
|
||||
|
||||
Once you enable debug logging, you ideally need to make the error happen. Run your automation, change up your device or whatever was giving you an error and then come back and disable the debug logging. Disabling the debug logging is the same as enabling, but now the button says **Disable Debug Logging**. After you disable it, you will be automatically prompted you to download your log file. Save this to a safe location to upload later.
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "Browsers"
|
||||
description: "Browser Compatibility List"
|
||||
description: "Browser compatibility list"
|
||||
---
|
||||
|
||||
Home Assistant requires a web browser to show the frontend and supports all major modern browsers. We don't test the web interface against all available browsers but this page tracks different browsers on various operating systems and should help you to pick a browser which works. The "Release" column contains the release number which was tested. This doesn't mean that older or newer releases will not work.
|
||||
|
||||
@ -29,7 +29,7 @@ The most common way you can find icons is by using the icon picker built right i
|
||||
|
||||
</div>
|
||||
|
||||
### Material Design Icons Picker Browser Extension
|
||||
### Material design icons picker browser extension
|
||||
|
||||
The easiest way to browse and find icons outside of Home Assistant is with the official [Material Design Icons Picker](https://github.com/Pictogrammers/MaterialDesignIcons-Picker) browser extension. The extension is available for Chrome, Firefox, and Edge and is maintained by the MDI team.
|
||||
|
||||
@ -43,19 +43,19 @@ The easiest way to browse and find icons outside of Home Assistant is with the o
|
||||
|
||||
</div>
|
||||
|
||||
### Material Design Icons on the Pictogrammers Website
|
||||
### Material design icons on the Pictogrammers website
|
||||
|
||||
The last way to browse through available icons is by viewing the library on the Pictogrammers website, [https://pictogrammers.com/library/mdi/](https://pictogrammers.com/library/mdi/). Select an icon you'd like to use, then click "Home Assistant" to see an example of its usage.
|
||||
|
||||
<div class='note info'>
|
||||
|
||||
The Pictogrammers website will always show the latest release of the Material Design Icons library. However, you may find icons that may not yet be available in Home Assistant (yet!). Watch the Home Assistant release notes for announcements on upgrades of the Material Design Icons library.
|
||||
The Pictogrammers website will always show the latest release of the material design icons library. However, you may find icons that may not yet be available in Home Assistant (yet!). Watch the Home Assistant release notes for announcements on upgrades of the Material Design Icons library.
|
||||
|
||||
</div>
|
||||
|
||||
## Suggesting or Contributing New Icons
|
||||
## Suggesting or contributing new icons
|
||||
|
||||
Being open-source like Home Assistant, the Material Design Icons library is always accepting suggestions and contributions to expand the library.
|
||||
Being open-source like Home Assistant, the material design icons library is always accepting suggestions and contributions to expand the library.
|
||||
|
||||
<div class='note info'>
|
||||
|
||||
@ -63,7 +63,7 @@ Being open-source like Home Assistant, the Material Design Icons library is alwa
|
||||
|
||||
</div>
|
||||
|
||||
### Suggesting a New Icon
|
||||
### Suggesting a new icon
|
||||
|
||||
If you have an idea for an icon that isn't currently in the library, but are not interested in creating it yourself, [open a new icon suggestion](https://github.com/Templarian/MaterialDesign/issues/new?assignees=&labels=Icon+Request&template=1_icon_request.yml).
|
||||
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
---
|
||||
title: "Scenes Editor"
|
||||
title: "Scenes editor"
|
||||
description: "Instructions on how to use the scenes editor."
|
||||
---
|
||||
|
||||
|
||||
@ -387,7 +387,7 @@ The following automation example shows how to capture the custom event `event_li
|
||||
|
||||
{% endraw %}
|
||||
|
||||
## Repeat a Group of Actions
|
||||
## Repeat a group of actions
|
||||
|
||||
This action allows you to repeat a sequence of other actions. Nesting is fully supported.
|
||||
There are three ways to control how many times the sequence will be run.
|
||||
@ -564,7 +564,7 @@ For example:
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
### Repeat Loop Variable
|
||||
### Repeat loop variable
|
||||
|
||||
A variable named `repeat` is defined within the repeat action (i.e., it is available inside `sequence`, `while` & `until`.)
|
||||
It contains the following fields:
|
||||
|
||||
@ -5,9 +5,9 @@ toc: true
|
||||
no_toc: true
|
||||
---
|
||||
|
||||
Conditions can be used within a script or automation to prevent further execution. When a condition evaluates true, the script or automation will be executed. If any other value is returned, the script or automation stops executing. A condition will look at the system at that moment. For example, a condition can test if a switch is currently turned on or off.
|
||||
Conditions can be used within a {% term script %} or {% term automation %} to prevent further execution. When a condition evaluates true, the script or automation will be executed. If any other value is returned, the script or automation stops executing. A condition will look at the system at that moment. For example, a condition can test if a switch is currently turned on or off.
|
||||
|
||||
Unlike a trigger, which is always `or`, conditions are `and` by default - all conditions have to be true.
|
||||
Unlike a {% term trigger %}, which is always `or`, conditions are `and` by default - all conditions have to be true.
|
||||
|
||||
All conditions support an optional `alias`.
|
||||
|
||||
|
||||
@ -1,9 +1,9 @@
|
||||
---
|
||||
title: "Service Calls"
|
||||
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, a dashboard or via voice command devices such as Amazon Echo.
|
||||
Various integrations allow calling {% term services %} when a certain event occurs. The most common one is calling a service when an automation {% term trigger %} happens. But a service can also be called from a {% term script %}, a 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.
|
||||
|
||||
@ -15,7 +15,7 @@ Use the "Services" tab under Developer Tools to discover available services.
|
||||
|
||||
### The basics
|
||||
|
||||
Call the service `homeassistant.turn_on` on the entity `group.living_room`. This will turn all members of `group.living_room` on. You can also use `entity_id: all` and it will turn on all possible entities.
|
||||
Call the service `homeassistant.turn_on` on the {% term entity %} `group.living_room`. This will turn all members of `group.living_room` on. You can also use `entity_id: all` and it will turn on all possible entities.
|
||||
|
||||
```yaml
|
||||
service: homeassistant.turn_on
|
||||
@ -24,7 +24,7 @@ entity_id: group.living_room
|
||||
|
||||
### Targeting areas and devices
|
||||
|
||||
Instead of targeting an entity, you can also target an area or device. Or a combination of these.
|
||||
Instead of targeting an entity, you can also target an {% term area %} or {% term device %}. Or a combination of these.
|
||||
This is done with the `target` key.
|
||||
|
||||
A `target` is a map that contains at least one of the following: `area_id`, `device_id`, `entity_id`.
|
||||
|
||||
@ -3,7 +3,7 @@ title: "check_config"
|
||||
description: "Script to perform a check of the current configuration"
|
||||
---
|
||||
|
||||
Test any changes to your `configuration.yaml` file before launching Home Assistant. This script allows you to test changes without the need to restart Home Assistant.
|
||||
Test any changes to your `configuration.yaml` file before launching Home Assistant. This {% term script %} allows you to test changes without the need to restart Home Assistant.
|
||||
|
||||
```bash
|
||||
hass --script check_config
|
||||
|
||||
@ -1,13 +1,13 @@
|
||||
---
|
||||
title: "Developer Tools"
|
||||
description: "Description of the Developer Tools."
|
||||
title: "Developer tools"
|
||||
description: "Description of the developer tools."
|
||||
---
|
||||
|
||||
The frontend contains a section called **Developer Tools**.
|
||||
The dashboard contains a section called **Developer tools**.
|
||||
|
||||
<p class='img'>
|
||||
<img src='/images/screenshots/developer-tools.png' />
|
||||
Screenshot of Home Assistant's Developer Tools.
|
||||
Screenshot of Home Assistant's developer tools.
|
||||
</p>
|
||||
|
||||
| Section |Description |
|
||||
@ -60,7 +60,7 @@ rgb_color: [255, 0, 0]
|
||||
|
||||
## Template editor
|
||||
|
||||
The Template Editor provides a way to quickly test templates prior to placing them into automations and scripts. A code editor is on the left side and your real-time output is displayed in the preview on the right side.
|
||||
The template editor provides a way to quickly test templates prior to placing them into automations and scripts. A code editor is on the left side and your real-time output is displayed in the preview on the right side.
|
||||
|
||||
By default, this will contain sample code that illustrates how templates can be written and tested. This sample code can be removed and replaced with your own. You can restore the default example by pressing the "Reset to Demo Template" button beneath the code editor.
|
||||
|
||||
|
||||
@ -1,9 +1,9 @@
|
||||
---
|
||||
title: "Quick Bar"
|
||||
title: "Quick bar"
|
||||
description: "Dialog for quickly accessing entities or running commands."
|
||||
---
|
||||
|
||||
The "Quick Bar" allows you to quickly look up entities or run commands without needing to navigate away from your current view (Similar to the "quick open" feature in VS Code, Chrome Developer Tools, etc).
|
||||
The **Quick bar** allows you to quickly look up entities or run commands without needing to navigate away from your current view (Similar to the "quick open" feature in VS Code, Chrome Developer Tools, etc).
|
||||
|
||||
It can be launched from anywhere in the frontend using [hotkeys](#hotkeys).
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user