mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-13 04:16:48 +00:00
Component(s) -> Integration(s) (#9656)
Signed-off-by: Franck Nijhof <frenck@addons.community>
This commit is contained in:
Franck Nijhof
GitHub
parent
d0e59b0d3a
commit
1e46c4fcbe
@ -17,7 +17,7 @@ The Snips add-on depends on the Mosquitto add on to bridge to Home Assistant, so
|
||||
|
||||
Home Assistant comes with certain Intents builtin to handle common tasks. A complete list of Intents can be found in this wiki [Hass Snips Bundle](https://github.com/tschmidty69/hass-snips-bundle-intents/wiki).
|
||||
|
||||
The Snips add-on by default comes with an assistant that allows you to turn on lights or switches, open covers, or add and list items to a shopping list if that component is enabled.
|
||||
The Snips add-on by default comes with an assistant that allows you to turn on lights or switches, open covers, or add and list items to a shopping list if that integration is enabled.
|
||||
|
||||
If using a USB microphone and speakers plugged into the Raspberry Pi output, Snips will work without any change to the configuration. Trying saying things like:
|
||||
|
||||
|
||||
@ -15,7 +15,7 @@ This is a [React](https://facebook.github.io/react/) implementation of [TodoMVC]
|
||||
- It uses React to render the data.
|
||||
- It hooks into Home Assistant JS which means updates pushed from the server are instantly rendered.
|
||||
- It accesses properties made available from Polymer.
|
||||
- It uses the user configuration for the component in the `configuration.yaml` file for rendering.
|
||||
- It uses the user configuration for the integration in the `configuration.yaml` file for rendering.
|
||||
- It allows toggling the sidebar.
|
||||
|
||||
[Download the source for React Starter Kit here](https://github.com/home-assistant/custom-panel-starter-kit-react). Copy the file to `<config dir>/panels/` (you might have to create the directory if it doesn't exist).
|
||||
|
||||
@ -48,7 +48,7 @@ automation:
|
||||
service: notify.pushbullet
|
||||
data_template:
|
||||
title: 'New Home Assistant Release'
|
||||
target: 'YOUR_TARGET_HERE' #See Pushbullet component for usage
|
||||
target: 'YOUR_TARGET_HERE' #See Pushbullet integration for usage
|
||||
message: "Home Assistant {% raw %} {{ states.updater.updater.state }} {% endraw %} is now available."
|
||||
```
|
||||
|
||||
|
||||
@ -10,7 +10,7 @@ footer: true
|
||||
ha_category: Automation in Python Examples
|
||||
---
|
||||
|
||||
Example component to target an `entity_id` to:
|
||||
Example integration to target an `entity_id` to:
|
||||
|
||||
- turn it on at 7AM in the morning
|
||||
- turn it on if anyone comes home and it is off
|
||||
@ -57,7 +57,7 @@ from homeassistant.helpers.event import (async_track_state_change,
|
||||
# The domain of your component. Should be equal to the name of your component.
|
||||
DOMAIN = "example"
|
||||
|
||||
# List of component names (string) your component depends upon.
|
||||
# List of integration names (string) your integration depends upon.
|
||||
# We depend on group because group will be loaded after all the components that
|
||||
# initialize devices have been setup.
|
||||
DEPENDENCIES = ['group', 'device_tracker', 'light']
|
||||
|
||||
@ -24,7 +24,7 @@ import homeassistant.loader as loader
|
||||
# The domain of your component. Should be equal to the name of your component.
|
||||
DOMAIN = 'hello_mqtt'
|
||||
|
||||
# List of component names (string) your component depends upon.
|
||||
# List of integration names (string) your integration depends upon.
|
||||
DEPENDENCIES = ['mqtt']
|
||||
|
||||
|
||||
@ -63,7 +63,7 @@ def setup(hass, config):
|
||||
return True
|
||||
```
|
||||
|
||||
Load the component by adding the following to your `configuration.yaml`. When your component is loaded, a new entity should popup and there should be a new service available to call.
|
||||
Load the integration by adding the following to your `configuration.yaml`. When your integration is loaded, a new entity should popup and there should be a new service available to call.
|
||||
|
||||
```yaml
|
||||
# configuration.yaml entry
|
||||
|
||||
@ -10,9 +10,9 @@ footer: true
|
||||
ha_category: Automation in Python Examples
|
||||
---
|
||||
|
||||
This example component will detect intruders. It does so by checking if lights are being turned on while there is no one at home. When this happens it will turn the lights red, flash them for 30 seconds and send a message via [the notify component](/components/notify/). It will also flash a specific light when a known person comes home.
|
||||
This example integration will detect intruders. It does so by checking if lights are being turned on while there is no one at home. When this happens it will turn the lights red, flash them for 30 seconds and send a message via [the notify component](/components/notify/). It will also flash a specific light when a known person comes home.
|
||||
|
||||
This component depends on the components [device_tracker](/components/device_tracker/) and [light](/components/light/) being setup.
|
||||
This integration depends on the integrations [device_tracker](/components/device_tracker/) and [light](/components/light/) being setup.
|
||||
|
||||
To set it up, add the following lines to your `configuration.yaml` file:
|
||||
|
||||
|
||||
@ -12,7 +12,7 @@ ha_category: Automation Examples
|
||||
|
||||
### {% linkable_title iOS Devices %}
|
||||
|
||||
If you have a device running iOS (iPhone, iPad, etc), The [iCloud](/components/device_tracker.icloud/) component is gathering various details about your device including the battery level. To display it in the Frontend use a [template sensor](/components/sensor.template/). You can also use the `battery` [sensor device class](/components/sensor/#device-class) to dynamically change the icon with the battery level.
|
||||
If you have a device running iOS (iPhone, iPad, etc), The [iCloud](/components/device_tracker.icloud/) integration is gathering various details about your device including the battery level. To display it in the Frontend use a [template sensor](/components/sensor.template/). You can also use the `battery` [sensor device class](/components/sensor/#device-class) to dynamically change the icon with the battery level.
|
||||
|
||||
{% raw %}
|
||||
```yaml
|
||||
|
||||
@ -73,7 +73,7 @@ If you see this, you need to add an [`api_password`](/components/http/#api_passw
|
||||
|
||||
### {% linkable_title Bearer token informational messages %}
|
||||
|
||||
If you see the following, then this is a message for component developers, to tell them they need to update how they authenticate to Home Assistant. As an end user you don't need to do anything:
|
||||
If you see the following, then this is a message for integration developers, to tell them they need to update how they authenticate to Home Assistant. As an end user you don't need to do anything:
|
||||
|
||||
```txt
|
||||
INFO (MainThread) [homeassistant.components.http.auth] You need to use a bearer token to access /blah/blah from 192.0.2.4
|
||||
|
||||
@ -52,7 +52,7 @@ config:
|
||||
|
||||
The automation editor reads and writes to the file `automations.yaml` in the root of your [configuration](/docs/configuration/) folder.
|
||||
Currently, both the name of this file and its location are fixed.
|
||||
Make sure that you have set up the automation component to read from it:
|
||||
Make sure that you have set up the automation integration to read from it:
|
||||
|
||||
```yaml
|
||||
# Configuration.yaml example
|
||||
|
||||
@ -16,7 +16,7 @@ Triggers are what starts the processing of an automation rule. It is possible to
|
||||
|
||||
Triggers when an event is being processed. Events are the raw building blocks of Home Assistant. You can match events on just the event name or also require specific event data to be present.
|
||||
|
||||
Events can be fired by components or via the API. There is no limitation to the types. A list of built-in events can be found [here](/docs/configuration/events/).
|
||||
Events can be fired by integrations or via the API. There is no limitation to the types. A list of built-in events can be found [here](/docs/configuration/events/).
|
||||
|
||||
```yaml
|
||||
automation:
|
||||
|
||||
@ -19,7 +19,7 @@ INFO [homeassistant.components.automation] Initialized rule Rainy Day
|
||||
INFO [homeassistant.components.automation] Initialized rule Rain is over
|
||||
```
|
||||
|
||||
The Logbook component will show a line entry when an automation is triggered. You can look at the previous entry to determine which trigger in the rule triggered the event.
|
||||
The Logbook integration will show a line entry when an automation is triggered. You can look at the previous entry to determine which trigger in the rule triggered the event.
|
||||
|
||||
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Updater"
|
||||
description: "Details what the updater component is reporting about your Home Assistant instance."
|
||||
description: "Details what the updater integration is reporting about your Home Assistant instance."
|
||||
date: 2016-10-22 08:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
@ -12,7 +12,7 @@ redirect_from: /details/updater/
|
||||
|
||||
Starting with 0.31 the [updater component](/components/updater/) sends an optional report about Home Assistant instance.
|
||||
|
||||
If you want to opt-in to include component information, add `include_used_components` to your config. This will allow the Home Assistant developers to focus development efforts on the most popular components.
|
||||
If you want to opt-in to include integration information, add `include_used_components` to your config. This will allow the Home Assistant developers to focus development efforts on the most popular components.
|
||||
|
||||
```yaml
|
||||
updater:
|
||||
|
||||
@ -25,7 +25,7 @@ The location of the folder differs between operating systems:
|
||||
|
||||
If you want to use a different folder for configuration, use the config command line parameter: `hass --config path/to/config`.
|
||||
|
||||
Inside your configuration folder is the file `configuration.yaml`. This is the main file that contains components to be loaded with their configurations. Throughout the documentation you will find snippets that you can add to your configuration file to enable functionality.
|
||||
Inside your configuration folder is the file `configuration.yaml`. This is the main file that contains integrations to be loaded with their configurations. Throughout the documentation you will find snippets that you can add to your configuration file to enable functionality.
|
||||
|
||||
If you run into trouble while configuring Home Assistant, have a look at the [configuration troubleshooting page](/getting-started/troubleshooting-configuration/) and at the [configuration.yaml examples](/cookbook/#example-configurationyaml).
|
||||
|
||||
|
||||
@ -10,12 +10,12 @@ footer: true
|
||||
redirect_from: /topics/events/
|
||||
---
|
||||
|
||||
The core of Home Assistant is the event bus. The event bus allows any component to fire or listen for events. It is the core of everything. For example, any state change will be announced on the event bus as a `state_changed` event containing the previous and the new state of an entity.
|
||||
The core of Home Assistant is the event bus. The event bus allows any integration to fire or listen for events. It is the core of everything. For example, any state change will be announced on the event bus as a `state_changed` event containing the previous and the new state of an entity.
|
||||
|
||||
Home Assistant contains a few built-in events that are used to coordinate between various components.
|
||||
|
||||
### {% linkable_title Event `homeassistant_start` %}
|
||||
Event `homeassistant_start` is fired when all components from the configuration have been initialized. This is the event that will start the timer firing off `time_changed` events.
|
||||
Event `homeassistant_start` is fired when all integrations from the configuration have been initialized. This is the event that will start the timer firing off `time_changed` events.
|
||||
|
||||
<p class='note warning'>
|
||||
Starting 0.42, it is no longer possible to listen for event `homeassistant_start`. Use the 'homeassistant' [platform](/docs/automation/trigger) instead.
|
||||
@ -84,8 +84,8 @@ Field | Description
|
||||
|
||||
|
||||
### {% linkable_title Event `component_loaded` %}
|
||||
Event `component_loaded` is fired when a new component has been loaded and initialized.
|
||||
Event `component_loaded` is fired when a new integration has been loaded and initialized.
|
||||
|
||||
Field | Description
|
||||
----- | -----------
|
||||
`component` | Domain of the component that has just been initialized. Example: `light`.
|
||||
`component` | Domain of the integration that has just been initialized. Example: `light`.
|
||||
|
||||
@ -10,7 +10,7 @@ footer: true
|
||||
redirect_from: /topics/packages/
|
||||
---
|
||||
|
||||
Packages in Home Assistant provide a way to bundle different component's configuration together. We already learned about the two configuration styles (specifying platforms entries together or individually) on the [adding devices](/docs/configuration/devices/) page. Both of these configuration methods require you to create the component key in the main `configuration.yaml` file. With packages we have a way to include different components, or different configuration parts using any of the `!include` directives introduced in [splitting the configuration](/docs/configuration/splitting_configuration).
|
||||
Packages in Home Assistant provide a way to bundle different component's configuration together. We already learned about the two configuration styles (specifying platforms entries together or individually) on the [adding devices](/docs/configuration/devices/) page. Both of these configuration methods require you to create the integration key in the main `configuration.yaml` file. With packages we have a way to include different components, or different configuration parts using any of the `!include` directives introduced in [splitting the configuration](/docs/configuration/splitting_configuration).
|
||||
|
||||
<p class='note tip'>
|
||||
Note that if you use packages for your configuration, the configuration reloading buttons in the configuration panel will not reload your packages.
|
||||
@ -26,7 +26,7 @@ homeassistant:
|
||||
...package configuration here...
|
||||
```
|
||||
|
||||
The package configuration can include: `switch`, `light`, `automation`, `groups`, or most other Home Assistant components including hardware platforms.
|
||||
The package configuration can include: `switch`, `light`, `automation`, `groups`, or most other Home Assistant integrations including hardware platforms.
|
||||
|
||||
It can be specified inline or in a separate YAML file using `!include`.
|
||||
|
||||
@ -67,7 +67,7 @@ light:
|
||||
|
||||
There are some rules for packages that will be merged:
|
||||
|
||||
1. Platform based components (`light`, `switch`, etc) can always be merged.
|
||||
1. Platform based integrations (`light`, `switch`, etc) can always be merged.
|
||||
2. Components where entities are identified by a key that will represent the entity_id (`{key: config}`) need to have unique 'keys' between packages and the main configuration file.
|
||||
|
||||
For example if we have the following in the main config. You are not allowed to re-use "my_input" again for `input_boolean` in a package:
|
||||
@ -76,10 +76,10 @@ There are some rules for packages that will be merged:
|
||||
input_boolean:
|
||||
my_input:
|
||||
```
|
||||
3. Any component that is not a platform [2], or dictionaries with Entity ID keys [3] can only be merged if its keys, except those for lists, are solely defined once.
|
||||
3. Any integration that is not a platform [2], or dictionaries with Entity ID keys [3] can only be merged if its keys, except those for lists, are solely defined once.
|
||||
|
||||
<p class='note tip'>
|
||||
Components inside packages can only specify platform entries using configuration style 1, where all the platforms are grouped under the component name.
|
||||
Components inside packages can only specify platform entries using configuration style 1, where all the platforms are grouped under the integration name.
|
||||
</p>
|
||||
|
||||
### {% linkable_title Create a packages folder %}
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Entity component platform options"
|
||||
description: "Shows how to customize polling interval for any component via configuration.yaml."
|
||||
title: "Entity integration platform options"
|
||||
description: "Shows how to customize polling interval for any integration via configuration.yaml."
|
||||
date: 2016-02-12 23:17 -0800
|
||||
sidebar: true
|
||||
comments: false
|
||||
@ -12,7 +12,7 @@ redirect_from: /topics/platform_options/
|
||||
|
||||
<p class='note info'>These options are being phased out and are only available for single platform integrations.</p>
|
||||
|
||||
Some components or platforms (those that are based on the [entity](https://github.com/home-assistant/home-assistant/blob/dev/homeassistant/helpers/entity.py) class) allows various extra options to be set.
|
||||
Some integrations or platforms (those that are based on the [entity](https://github.com/home-assistant/home-assistant/blob/dev/homeassistant/helpers/entity.py) class) allows various extra options to be set.
|
||||
|
||||
### {% linkable_title Entity namespace %}
|
||||
|
||||
|
||||
@ -19,7 +19,7 @@ Here's the summary of what you *must* do to secure your Home Assistant system:
|
||||
- Configure [secrets](/docs/configuration/secrets/) (but do remember to back them up)
|
||||
- Regularly keep the system up to date
|
||||
|
||||
If you only want to use components supported by [Home Assistant cloud](/cloud/) then you don't need to enable remote access. This is obviously the most secure option, but does mean that you're relying on a cloud service for that functionality.
|
||||
If you only want to use integrations supported by [Home Assistant cloud](/cloud/) then you don't need to enable remote access. This is obviously the most secure option, but does mean that you're relying on a cloud service for that functionality.
|
||||
|
||||
- For remote access to the UI, use a [VPN](http://www.pivpn.io/), [Tor](/docs/ecosystem/tor/) or an [SSH tunnel](/blog/2017/11/02/secure-shell-tunnel/)
|
||||
- For remote access for components, use a [TLS/SSL](/docs/ecosystem/certificates/lets_encrypt/) certificate
|
||||
@ -45,7 +45,7 @@ If you only want remote access for access to the web UI then we advise that you
|
||||
- [Tor](/docs/ecosystem/tor/), which also avoids the need for port forwarding
|
||||
- An [SSH tunnel](/blog/2017/11/02/secure-shell-tunnel/) to connect to your frontend
|
||||
|
||||
### {% linkable_title Remote access for components %}
|
||||
### {% linkable_title Remote access for integrations %}
|
||||
|
||||
For remote access for a component, for example, a device tracker, you have to enable access to the API by:
|
||||
|
||||
|
||||
@ -38,7 +38,7 @@ Note that each line after `homeassistant:` is indented two (2) spaces. Since the
|
||||
|
||||
`!include filename.yaml` is the statement that tells Home Assistant to insert the contents of `filename.yaml` at that point. This is how we are going to break a monolithic and hard to read file (when it gets big) into more manageable chunks.
|
||||
|
||||
Now before we start splitting out the different components, let's look at the other components (in our example) that will stay in the base file:
|
||||
Now before we start splitting out the different components, let's look at the other integrations (in our example) that will stay in the base file:
|
||||
|
||||
```yaml
|
||||
history:
|
||||
@ -62,9 +62,9 @@ zwave:
|
||||
mqtt:
|
||||
broker: 127.0.0.1
|
||||
```
|
||||
As with the core snippet, indentation makes a difference. The component headers (`mqtt:`) should be fully left aligned (aka no indent), and the parameters (`broker:`) should be indented two (2) spaces.
|
||||
As with the core snippet, indentation makes a difference. The integration headers (`mqtt:`) should be fully left aligned (aka no indent), and the parameters (`broker:`) should be indented two (2) spaces.
|
||||
|
||||
While some of these components can technically be moved to a separate file they are so small or "one off's" where splitting them off is superfluous. Also, you'll notice the # symbol (hash/pound). This represents a "comment" as far as the commands are interpreted. Put another way, any line prefixed with a `#` will be ignored. This makes breaking up files for human readability really convenient, not to mention turning off features while leaving the entry intact.
|
||||
While some of these integrations can technically be moved to a separate file they are so small or "one off's" where splitting them off is superfluous. Also, you'll notice the # symbol (hash/pound). This represents a "comment" as far as the commands are interpreted. Put another way, any line prefixed with a `#` will be ignored. This makes breaking up files for human readability really convenient, not to mention turning off features while leaving the entry intact.
|
||||
|
||||
Now, lets assume that a blank file has been created in the Home Assistant configuration directory for each of the following:
|
||||
|
||||
@ -77,7 +77,7 @@ device_tracker.yaml
|
||||
customize.yaml
|
||||
```
|
||||
|
||||
`automation.yaml` will hold all the automation component details. `zones.yaml` will hold the zone component details and so forth. These files can be called anything but giving them names that match their function will make things easier to keep track of.
|
||||
`automation.yaml` will hold all the automation integration details. `zones.yaml` will hold the zone integration details and so forth. These files can be called anything but giving them names that match their function will make things easier to keep track of.
|
||||
|
||||
Inside the base configuration file add the following entries:
|
||||
|
||||
@ -89,9 +89,9 @@ switch: !include switch.yaml
|
||||
device_tracker: !include device_tracker.yaml
|
||||
```
|
||||
|
||||
Note that there can only be one `!include:` for each component so chaining them isn't going to work. If that sounds like Greek, don't worry about it.
|
||||
Note that there can only be one `!include:` for each integration so chaining them isn't going to work. If that sounds like Greek, don't worry about it.
|
||||
|
||||
Alright, so we've got the single components and the include statements in the base file, what goes in those extra files?
|
||||
Alright, so we've got the single integrations and the include statements in the base file, what goes in those extra files?
|
||||
|
||||
Let's look at the `device_tracker.yaml` file from our example:
|
||||
|
||||
|
||||
@ -27,7 +27,7 @@ Field | Description
|
||||
`state.last_changed` | Time the state changed in the state machine in UTC time. This is not updated when there are only updated attributes. Example: `2017-10-28 08:13:36.715874+00:00`.
|
||||
`state.attributes` | A dictionary with extra attributes related to the current state.
|
||||
|
||||
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 component will also have its own attributes to represent extra state data about the entity. For example, the light component 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 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`.
|
||||
|
||||
|
||||
@ -232,9 +232,9 @@ Some of these functions can also be used in a [filter](http://jinja.pocoo.org/do
|
||||
|
||||
## {% linkable_title Processing incoming data %}
|
||||
|
||||
The other part of templating is processing incoming data. It allows you to modify incoming data and extract only the data you care about. This will only work for platforms and components that mention support for this in their documentation.
|
||||
The other part of templating is processing incoming data. It allows you to modify incoming data and extract only the data you care about. This will only work for platforms and integrations that mention support for this in their documentation.
|
||||
|
||||
It depends per component or platform, but it is common to be able to define a template using the `value_template` configuration key. When a new value arrives, your template will be rendered while having access to the following values on top of the usual Home Assistant extensions:
|
||||
It depends per integration or platform, but it is common to be able to define a template using the `value_template` configuration key. When a new value arrives, your template will be rendered while having access to the following values on top of the usual Home Assistant extensions:
|
||||
|
||||
| Variable | Description |
|
||||
|--------------|------------------------------------|
|
||||
|
||||
@ -10,15 +10,15 @@ footer: true
|
||||
redirect_from: /getting-started/troubleshooting-configuration/
|
||||
---
|
||||
|
||||
It can happen that you run into trouble while configuring Home Assistant. Perhaps a component is not showing up or is acting strangely. This page will discuss a few of the most common problems.
|
||||
It can happen that you run into trouble while configuring Home Assistant. Perhaps a integration is not showing up or is acting strangely. This page will discuss a few of the most common problems.
|
||||
|
||||
Before we dive into common issues, make sure you know where your configuration directory is. Home Assistant will print out the configuration directory it is using when starting up.
|
||||
|
||||
Whenever a component or configuration option results in a warning, it will be stored in `home-assistant.log` in the configuration directory. This file is reset on start of Home Assistant.
|
||||
Whenever a integration or configuration option results in a warning, it will be stored in `home-assistant.log` in the configuration directory. This file is reset on start of Home Assistant.
|
||||
|
||||
### {% linkable_title My component does not show up %}
|
||||
### {% linkable_title My integration does not show up %}
|
||||
|
||||
When a component does not show up, many different things can be the case. Before you try any of these steps, make sure to look at the `home-assistant.log` file and see if there are any errors related to your component you are trying to set up.
|
||||
When a integration does not show up, many different things can be the case. Before you try any of these steps, make sure to look at the `home-assistant.log` file and see if there are any errors related to your integration you are trying to set up.
|
||||
|
||||
If you have incorrect entries in your configuration files you can use the [`check_config`](/docs/tools/check_config/) script to assist in identifying them: `hass --script check_config`. If you need to provide the path for your configuration you can do this using the `-c` argument like this: `hass --script check_config -c /path/to/your/config/dir`.
|
||||
|
||||
@ -40,21 +40,21 @@ sensor:
|
||||
...
|
||||
```
|
||||
|
||||
Another common problem is that a required configuration setting is missing. If this is the case, the component will report this to `home-assistant.log`. You can have a look at [the various component pages](/components/) for instructions on how to setup the components.
|
||||
Another common problem is that a required configuration setting is missing. If this is the case, the integration will report this to `home-assistant.log`. You can have a look at [the various integration pages](/components/) for instructions on how to setup the components.
|
||||
|
||||
See the [logger](/components/logger/) component for instructions on how to define the level of logging you require for specific modules.
|
||||
See the [logger](/components/logger/) integration for instructions on how to define the level of logging you require for specific modules.
|
||||
|
||||
If you find any errors or want to expand the documentation, please [let us know](https://github.com/home-assistant/home-assistant.io/issues).
|
||||
|
||||
#### {% linkable_title Problems with dependencies %}
|
||||
|
||||
Almost all components have external dependencies to communicate with your devices and services. Sometimes Home Assistant is unable to install the necessary dependencies. If this is the case, it should show up in `home-assistant.log`.
|
||||
Almost all integrations have external dependencies to communicate with your devices and services. Sometimes Home Assistant is unable to install the necessary dependencies. If this is the case, it should show up in `home-assistant.log`.
|
||||
|
||||
The first step is trying to restart Home Assistant and see if the problem persists. If it does, look at the log to see what the error is. If you can't figure it out, please [report it](https://github.com/home-assistant/home-assistant/issues) so we can investigate what is going on.
|
||||
|
||||
#### {% linkable_title Problems with components %}
|
||||
#### {% linkable_title Problems with integrations %}
|
||||
|
||||
It can happen that some components either do not work right away or stop working after Home Assistant has been running for a while. If this happens to you, please [report it](https://github.com/home-assistant/home-assistant/issues) so that we can have a look.
|
||||
It can happen that some integrations either do not work right away or stop working after Home Assistant has been running for a while. If this happens to you, please [report it](https://github.com/home-assistant/home-assistant/issues) so that we can have a look.
|
||||
|
||||
#### {% linkable_title Multiple files %}
|
||||
|
||||
|
||||
@ -12,7 +12,7 @@ redirect_from: /getting-started/yaml/
|
||||
|
||||
Home Assistant uses the [YAML](http://yaml.org/) syntax for configuration. YAML might take a while to get used to but is really powerful in allowing you to express complex configurations.
|
||||
|
||||
For each component that you want to use in Home Assistant, you add code in your `configuration.yaml` file to specify its settings.
|
||||
For each integration that you want to use in Home Assistant, you add code in your `configuration.yaml` file to specify its settings.
|
||||
The following example entry specifies that you want to use the [notify component](/components/notify) with the [pushbullet platform](/components/notify.pushbullet).
|
||||
|
||||
|
||||
@ -40,7 +40,7 @@ Please pay attention on not storing private data (passwords, API keys, etc.) dir
|
||||
|
||||
Text following a `#` are comments and are ignored by the system.
|
||||
|
||||
The next example shows an [input_select](/components/input_select) component that uses a block collection for the options values.
|
||||
The next example shows an [input_select](/components/input_select) integration that uses a block collection for the options values.
|
||||
The other properties (like name) are specified using mappings. Note that the second line just has `threat:` with no value on the same line. Here threat is the name of the input_select and the values for it are everything nested below it.
|
||||
|
||||
```yaml
|
||||
|
||||
@ -282,7 +282,7 @@ In most cases, the attribute `state` has the most important value in it, e.g., f
|
||||
get_state(entity = None, attribute = None)
|
||||
```
|
||||
|
||||
`get_state()` is used to query the state of any component within Home Assistant. State updates are continuously tracked so this call runs locally and does not require AppDaemon to call back to Home Assistant and as such is very efficient.
|
||||
`get_state()` is used to query the state of any integration within Home Assistant. State updates are continuously tracked so this call runs locally and does not require AppDaemon to call back to Home Assistant and as such is very efficient.
|
||||
|
||||
#### {% linkable_title Returns %}
|
||||
|
||||
@ -788,7 +788,7 @@ Function to be invoked when the requested state change occurs. It must conform t
|
||||
|
||||
##### {% linkable_title time %}
|
||||
|
||||
A Python `time` object that specifies when the callback will occur, the hour component of the time object is ignored. If the time specified is in the past, the callback will occur the next hour at the specified time. If time is not supplied, the callback will start an hour from the time that `run_hourly()` was executed.
|
||||
A Python `time` object that specifies when the callback will occur, the hour integration of the time object is ignored. If the time specified is in the past, the callback will occur the next hour at the specified time. If time is not supplied, the callback will start an hour from the time that `run_hourly()` was executed.
|
||||
|
||||
##### {% linkable_title \*\*kwargs %}
|
||||
|
||||
@ -1348,7 +1348,7 @@ self.notify("", "Switching mode to Evening")
|
||||
|
||||
### {% linkable_title About Events %}
|
||||
|
||||
Events are a fundamental part of how Home Assistant works under the covers. HA has an event bus that all components can read and write to, enabling components to inform other components when important events take place. We have already seen how state changes can be propagated to AppDaemon - a state change however is merely an example of an event within Home Assistant. There are several other event types, among them are:
|
||||
Events are a fundamental part of how Home Assistant works under the covers. HA has an event bus that all integrations can read and write to, enabling integrations to inform other integrations when important events take place. We have already seen how state changes can be propagated to AppDaemon - a state change however is merely an example of an event within Home Assistant. There are several other event types, among them are:
|
||||
|
||||
- `homeassistant_start`
|
||||
- `homeassistant_stop`
|
||||
@ -1490,7 +1490,7 @@ service, kwargs = self.info_listen_event(handle)
|
||||
|
||||
### {% linkable_title fire_event() %}
|
||||
|
||||
Fire an event on the Home Assistant bus, for other components to hear.
|
||||
Fire an event on the Home Assistant bus, for other integrations to hear.
|
||||
|
||||
#### {% linkable_title Synopsis %}
|
||||
|
||||
@ -1536,7 +1536,7 @@ A dictionary containing any additional information associated with the event.
|
||||
|
||||
### {% linkable_title Use of Events for Signaling between Home Assistant and AppDaemon %}
|
||||
|
||||
Home Assistant allows for the creation of custom events and existing components can send and receive them. This provides a useful mechanism for signaling back and forth between Home Assistant and AppDaemon. For instance, if you would like to create a UI Element to fire off some code in Home Assistant, all that is necessary is to create a script to fire a custom event, then subscribe to that event in AppDaemon. The script would look something like this:
|
||||
Home Assistant allows for the creation of custom events and existing integrations can send and receive them. This provides a useful mechanism for signaling back and forth between Home Assistant and AppDaemon. For instance, if you would like to create a UI Element to fire off some code in Home Assistant, all that is necessary is to create a script to fire a custom event, then subscribe to that event in AppDaemon. The script would look something like this:
|
||||
|
||||
```yaml
|
||||
alias: Day
|
||||
|
||||
@ -10,4 +10,4 @@ footer: true
|
||||
redirect_from: /ecosystem/appdaemon/tutorial/
|
||||
---
|
||||
|
||||
Since `AppDaemon` under the covers uses the exact same APIs as the frontend UI, you typically see it react at about the same time to a given event. Calling back to Home Assistant is also pretty fast especially if they are running on the same machine. In action, observed latency above the built in automation component is usually sub-second.
|
||||
Since `AppDaemon` under the covers uses the exact same APIs as the frontend UI, you typically see it react at about the same time to a given event. Calling back to Home Assistant is also pretty fast especially if they are running on the same machine. In action, observed latency above the built in automation integration is usually sub-second.
|
||||
|
||||
@ -341,7 +341,7 @@ http:
|
||||
base_url: examplehome.duckdns.org
|
||||
```
|
||||
|
||||
You may wish to set up other options for the [http](/components/http/) component at this point, these extra options are beyond the scope of this guide.
|
||||
You may wish to set up other options for the [http](/components/http/) integration at this point, these extra options are beyond the scope of this guide.
|
||||
|
||||
Save the changes to configuration.yaml. Restart Home Assistant.
|
||||
|
||||
@ -429,7 +429,7 @@ sensor:
|
||||
|
||||
Save the configuration.yaml. Restart Home Assistant.
|
||||
|
||||
On your default_view you should now see a sensor badge containing your number of days until expiry. If you've been following this guide from the start and have not taken any breaks in between, this should be 89 or 90. The sensor will update every 3 hours. You can place this reading on a card using groups, or hide it using customize. These topics are outside of the scope of this guide, but information can be found on their respective components pages: [Group](/components/group/) and [Customize](/docs/configuration/customizing-devices/)
|
||||
On your default_view you should now see a sensor badge containing your number of days until expiry. If you've been following this guide from the start and have not taken any breaks in between, this should be 89 or 90. The sensor will update every 3 hours. You can place this reading on a card using groups, or hide it using customize. These topics are outside of the scope of this guide, but information can be found on their respective integrations pages: [Group](/components/group/) and [Customize](/docs/configuration/customizing-devices/)
|
||||
|
||||
Got your sensor up and running and where you want it? Top drawer! Nearly there, now move on to the final steps to ensure that you're never without a secure connection in the future.
|
||||
|
||||
|
||||
@ -27,9 +27,9 @@ The app is available on the iOS App Store in every country that Apple supports.
|
||||
* Home Assistant 0.42.4 or higher for push notification support.
|
||||
* SSL is strongly recommended. Self-signed SSL certificates will not work due to Apple's limitations.
|
||||
|
||||
The `ios` component is the companion component for the Home Assistant iOS app. While not required, adding the `ios` component to your setup will greatly enhance the iOS app with new notification, location and sensor functions not possible with a standalone app.
|
||||
The `ios` integration is the companion integration for the Home Assistant iOS app. While not required, adding the `ios` integration to your setup will greatly enhance the iOS app with new notification, location and sensor functions not possible with a standalone app.
|
||||
|
||||
Loading the `ios` component will also load the [`device_tracker`](/components/device_tracker), [`zeroconf`](/components/zeroconf) and [`notify`](/components/notify) platforms.
|
||||
Loading the `ios` integration will also load the [`device_tracker`](/components/device_tracker), [`zeroconf`](/components/zeroconf) and [`notify`](/components/notify) platforms.
|
||||
|
||||
The Home Assistant for iOS app supports the new authentication system introduced in Home Assistant 0.77.
|
||||
|
||||
@ -37,18 +37,18 @@ The Home Assistant for iOS app supports the new authentication system introduced
|
||||
|
||||
### {% linkable_title Automated Setup %}
|
||||
|
||||
The `ios` component will automatically be loaded under the following circumstances:
|
||||
The `ios` integration will automatically be loaded under the following circumstances:
|
||||
|
||||
1. The [`discovery`](/components/discovery) component is enabled.
|
||||
1. The [`discovery`](/components/discovery) integration is enabled.
|
||||
2. You have just installed the app and are at the getting started screen.
|
||||
|
||||
Automated discovery and component loading only happens at first install of the app. You may need to wait a few minutes for the iOS component to load as the `discovery` component only scans the network every 5 minutes.
|
||||
Automated discovery and integration loading only happens at first install of the app. You may need to wait a few minutes for the iOS integration to load as the `discovery` integration only scans the network every 5 minutes.
|
||||
|
||||
After the first automated setup you need to add `ios:` to your configuration so that the component loads by default even after restarting Home Assistant.
|
||||
After the first automated setup you need to add `ios:` to your configuration so that the integration loads by default even after restarting Home Assistant.
|
||||
|
||||
### {% linkable_title Manual Setup %}
|
||||
|
||||
You may also manually load the `ios` component by adding the following to your configuration:
|
||||
You may also manually load the `ios` integration by adding the following to your configuration:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
|
||||
@ -12,8 +12,8 @@ redirect_from: /ecosystem/ios/notifications/
|
||||
|
||||
The `ios` notify platform enables sending push notifications to the Home Assistant iOS app.
|
||||
|
||||
The 'ios' component will automatically load the notify service.
|
||||
The service component can be called using `service: notify.ios_<your_device_ID>`.
|
||||
The 'ios' integration will automatically load the notify service.
|
||||
The service integration can be called using `service: notify.ios_<your_device_ID>`.
|
||||
Your device ID can be found in the `ios.conf` file in your configuration folder. The file is compressed JSON. You can view it easier by copying the file contents and pasting them into [JSONLint](http://jsonlint.com).
|
||||
|
||||
In this example, the device ID is `robbiet480_7plus`, so the notify service to use is `notify.ios_robbiet480_7plus`:
|
||||
|
||||
@ -45,7 +45,7 @@ NUC i7/i9 | Pure power, you should not have *any* performance issues
|
||||
|
||||
## {% linkable_title Recommended %}
|
||||
|
||||
These install options are fully supported by Home Assistant's documentation. For example, if a component requires that you install something to make it work on one of these methods then the component page will document the steps required.
|
||||
These install options are fully supported by Home Assistant's documentation. For example, if a integration requires that you install something to make it work on one of these methods then the integration page will document the steps required.
|
||||
|
||||
**Method**|**You have**|**Recommended for**
|
||||
:-----|:-----|:-----
|
||||
@ -55,7 +55,7 @@ These install options are fully supported by Home Assistant's documentation. For
|
||||
|
||||
## {% linkable_title Alternative installs %}
|
||||
|
||||
If you use these install methods, we assume that you know how to manage and administer the operating system you're using. Due to the range of platforms on which these install methods can be used, component documentation may only tell you what you have to install, not how to install it.
|
||||
If you use these install methods, we assume that you know how to manage and administer the operating system you're using. Due to the range of platforms on which these install methods can be used, integration documentation may only tell you what you have to install, not how to install it.
|
||||
|
||||
**Method**|**You have**|**Recommended for**
|
||||
:-----|:-----|:-----
|
||||
@ -64,7 +64,7 @@ If you use these install methods, we assume that you know how to manage and admi
|
||||
|
||||
## {% linkable_title Community provided guides %}
|
||||
|
||||
These guides are provided as-is. Some of these install methods are more limited than the methods above. Some components may not work due to limitations of the platform or because required Python packages aren't available for that platform.
|
||||
These guides are provided as-is. Some of these install methods are more limited than the methods above. Some integrations may not work due to limitations of the platform or because required Python packages aren't available for that platform.
|
||||
|
||||
<div class="text-center hass-option-cards" markdown="0">
|
||||
<a class='option-card' href='/docs/installation/armbian/'>
|
||||
|
||||
@ -220,7 +220,7 @@ $ docker-compose restart
|
||||
|
||||
### {% linkable_title Exposing Devices %}
|
||||
|
||||
In order to use Z-Wave, Zigbee or other components that require access to devices, you need to map the appropriate device into the container. Ensure the user that is running the container has the correct privileges to access the `/dev/tty*` file, then add the device mapping to your docker command:
|
||||
In order to use Z-Wave, Zigbee or other integrations that require access to devices, you need to map the appropriate device into the container. Ensure the user that is running the container has the correct privileges to access the `/dev/tty*` file, then add the device mapping to your docker command:
|
||||
|
||||
```bash
|
||||
$ docker run --init -d --name="home-assistant" -v /PATH_TO_YOUR_CONFIG:/config \
|
||||
|
||||
@ -10,7 +10,7 @@ footer: true
|
||||
redirect_from: /docs/hassbian/integrations/
|
||||
---
|
||||
|
||||
Some components that are specific for the Raspberry Pi can require some further configuration outside of Home Assistant. All commands below are assumed to be executed with the `pi` account. For full documentation of these components refer to the [components](/components) page.
|
||||
Some integrations that are specific for the Raspberry Pi can require some further configuration outside of Home Assistant. All commands below are assumed to be executed with the `pi` account. For full documentation of these integrations refer to the [components](/components) page.
|
||||
|
||||
### {% linkable_title Bluetooth Tracker %}
|
||||
|
||||
@ -23,8 +23,8 @@ Software needed for the tracker is pre-installed so just follow the [Bluetooth T
|
||||
Each of the following devices are connected to the GPIO pins on the Raspberry Pi.
|
||||
For more details about the GPIO layout, visit the [documentation](https://www.raspberrypi.org/documentation/usage/gpio/) from the Raspberry Pi foundation.
|
||||
|
||||
Permission have been given to the `homeassistant` user to use the GPIO pins and all of the following components should require no underlying changes to work.
|
||||
Just follow the component pages for each on how to add them to your Home Assistant installation.
|
||||
Permission have been given to the `homeassistant` user to use the GPIO pins and all of the following integrations should require no underlying changes to work.
|
||||
Just follow the integration pages for each on how to add them to your Home Assistant installation.
|
||||
|
||||
- [DHT Sensor](/components/sensor.dht/)
|
||||
- [Raspberry Pi Cover](/components/cover.rpi_gpio/)
|
||||
|
||||
@ -10,7 +10,7 @@ footer: true
|
||||
logo: mqtt.png
|
||||
---
|
||||
|
||||
The MQTT component needs you to run an MQTT broker for Home Assistant to connect to. There are four options, each with various degrees of ease of setup and privacy.
|
||||
The MQTT integration needs you to run an MQTT broker for Home Assistant to connect to. There are four options, each with various degrees of ease of setup and privacy.
|
||||
|
||||
### {% linkable_title Run your own %}
|
||||
|
||||
|
||||
@ -64,7 +64,7 @@ The discovery topic need to follow a specific format:
|
||||
|
||||
The payload must be a JSON dictionary and will be checked like an entry in your `configuration.yaml` file if a new device is added. This means that missing variables will be filled with the platform's default values. All configuration variables which are *required* must be present in the initial payload send to `/config`.
|
||||
|
||||
If the component is `alarm_control_panel`, `binary_sensor`, or `sensor` and the mandatory `state_topic` is not present in the payload, `state_topic` will be automatically set to <discovery_prefix>/<component>/[<node_id>/]<object_id>/state. The automatic setting of `state_topic` id depracated and may be removed in a future version of Home Assistant.
|
||||
If the integration is `alarm_control_panel`, `binary_sensor`, or `sensor` and the mandatory `state_topic` is not present in the payload, `state_topic` will be automatically set to <discovery_prefix>/<component>/[<node_id>/]<object_id>/state. The automatic setting of `state_topic` id depracated and may be removed in a future version of Home Assistant.
|
||||
|
||||
An empty payload will cause a previously discovered device to be deleted.
|
||||
|
||||
@ -280,7 +280,7 @@ Setting up a switch using topic prefix and abbreviated configuration variable na
|
||||
- State topic: `homeassistant/switch/irrigation/state`
|
||||
- Payload: `{"~": "homeassistant/switch/irrigation", "name": "garden", "cmd_t": "~/set", "stat_t": "~/state"}`
|
||||
|
||||
Setting up a climate component (heat only) with abbreviated configuration variable names to reduce payload length.
|
||||
Setting up a climate integration (heat only) with abbreviated configuration variable names to reduce payload length.
|
||||
|
||||
- Configuration topic: `homeassistant/climate/livingroom/config`
|
||||
- Configuration payload:
|
||||
|
||||
@ -10,7 +10,7 @@ footer: true
|
||||
logo: mqtt.png
|
||||
---
|
||||
|
||||
The [logger](/components/logger/) component allows the logging of received MQTT messages.
|
||||
The [logger](/components/logger/) integration allows the logging of received MQTT messages.
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
|
||||
@ -10,7 +10,7 @@ footer: true
|
||||
logo: mqtt.png
|
||||
---
|
||||
|
||||
The MQTT component will register the service `mqtt.publish` which allows publishing messages to MQTT topics. There are two ways of specifying your payload. You can either use `payload` to hard-code a payload or use `payload_template` to specify a [template](/topics/templating/) that will be rendered to generate the payload.
|
||||
The MQTT integration will register the service `mqtt.publish` which allows publishing messages to MQTT topics. There are two ways of specifying your payload. You can either use `payload` to hard-code a payload or use `payload_template` to specify a [template](/topics/templating/) that will be rendered to generate the payload.
|
||||
|
||||
### {% linkable_title Service `mqtt.publish` %}
|
||||
|
||||
|
||||
@ -15,7 +15,7 @@ Scripts are a sequence of actions that Home Assistant will execute. Scripts are
|
||||
The script syntax basic structure is a list of key/value maps that contain actions. If a script contains only 1 action, the wrapping list can be omitted.
|
||||
|
||||
```yaml
|
||||
# Example script component containing script syntax
|
||||
# Example script integration containing script syntax
|
||||
script:
|
||||
example_script:
|
||||
sequence:
|
||||
@ -144,7 +144,7 @@ You can also get the script to abort after the timeout by using `continue_on_tim
|
||||
|
||||
### {% linkable_title Fire an Event %}
|
||||
|
||||
This action allows you to fire an event. Events can be used for many things. It could trigger an automation or indicate to another component that something is happening. For instance, in the below example it is used to create an entry in the logbook.
|
||||
This action allows you to fire an event. Events can be used for many things. It could trigger an automation or indicate to another integration that something is happening. For instance, in the below example it is used to create an entry in the logbook.
|
||||
|
||||
```yaml
|
||||
- event: LOGBOOK_ENTRY
|
||||
|
||||
@ -18,7 +18,7 @@ In Home Assistant 0.52 we introduced the first version of our script editor. If
|
||||
|
||||
## {% linkable_title Updating your configuration to use the editor %}
|
||||
|
||||
The script editor reads and writes to the file `scripts.yaml` in your [configuration](/docs/configuration/) folder. Make sure that you have set up the script component to read from it:
|
||||
The script editor reads and writes to the file `scripts.yaml` in your [configuration](/docs/configuration/) folder. Make sure that you have set up the script integration to read from it:
|
||||
|
||||
```yaml
|
||||
# Configuration.yaml example
|
||||
|
||||
@ -10,11 +10,11 @@ footer: true
|
||||
redirect_from: /getting-started/scripts-service-calls/
|
||||
---
|
||||
|
||||
Various components 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 or via the Amazon Echo.
|
||||
|
||||
The configuration options to call a config are the same between all components and are described on this page.
|
||||
The configuration options to call a config are the same between all integrations and are described on this page.
|
||||
|
||||
Examples on this page will be given as part of an automation component configuration but different approaches can be used for other components too.
|
||||
Examples on this page will be given as part of an automation integration configuration but different approaches can be used for other integrations too.
|
||||
|
||||
<p class='note'>
|
||||
Use the <img src='/images/screenshots/developer-tool-services-icon.png' class='no-shadow' height='38' /> service developer tool in the frontend to discover available services.
|
||||
|
||||
@ -21,7 +21,7 @@ Further [details about the fingerprint/server banner](/docs/security/webserver/)
|
||||
|
||||
## {% linkable_title Porosity %}
|
||||
|
||||
The default port of Home Assistant is 8123. This is the port where the [`frontend`](/components/frontend/) and the [`API`](/components/api/) is served. Both are depending on the [`http`](/components/http/) component which contains the capability to adjust the settings like `server_host` or `server_port`.
|
||||
The default port of Home Assistant is 8123. This is the port where the [`frontend`](/components/frontend/) and the [`API`](/components/api/) is served. Both are depending on the [`http`](/components/http/) integration which contains the capability to adjust the settings like `server_host` or `server_port`.
|
||||
|
||||
See the [open ports](/docs/security/porosity/) of a Hass.io instance with various add-ons.
|
||||
|
||||
|
||||
@ -18,7 +18,7 @@ Screenshot of Home Assistant's Developer Tools.
|
||||
|
||||
| Section | Icon | Description |
|
||||
| ------- |------| ----- |
|
||||
| Services | <img src='/images/screenshots/developer-tool-services-icon.png' alt='service developer tool icon' class="no-shadow" height="38" /> | Calls services from components |
|
||||
| Services | <img src='/images/screenshots/developer-tool-services-icon.png' alt='service developer tool icon' class="no-shadow" height="38" /> | Calls services from integrations |
|
||||
| States | <img src='/images/screenshots/developer-tool-states-icon.png' alt='service developer tool icon' class="no-shadow" height="38" /> | Sets the representation of an entity |
|
||||
| Events | <img src='/images/screenshots/developer-tool-events-icon.png' alt='service developer tool icon' class="no-shadow" height="38" /> | Fires events |
|
||||
| Templates | <img src='/images/screenshots/developer-tool-templates-icon.png' alt='service developer tool icon' class="no-shadow" height="38" /> | Renders templates |
|
||||
@ -31,7 +31,7 @@ The Developer Tools is meant for **all** (not just for the developers) to quickl
|
||||
|
||||
This section is used to call Services that are available in the ServiceRegistry.
|
||||
|
||||
The list of services in the “Service” drop down are automatically populated based on the components that are found in the configuration, automation and script files. If a desired service does not exist, it means either the component is not configured properly or not defined in the configuration, automation or script files.
|
||||
The list of services in the “Service” drop down are automatically populated based on the integrations that are found in the configuration, automation and script files. If a desired service does not exist, it means either the integration is not configured properly or not defined in the configuration, automation or script files.
|
||||
|
||||
When a Service is selected, and if that service requires an `entity_id` to be passed, the “Entity” drop down will automatically be populated with corresponding entities.
|
||||
|
||||
@ -94,7 +94,7 @@ For more information about jinja2, visit [jinja2 documentation](http://jinja.poc
|
||||
|
||||
{% linkable_title mqtt %}
|
||||
|
||||
This section is only visible if the MQTT component is configured. To configure MQTT, add `mqtt:` to the `configuration.yaml` file. For more information, refer to the [mqtt](/components/mqtt/) component.
|
||||
This section is only visible if the MQTT integration is configured. To configure MQTT, add `mqtt:` to the `configuration.yaml` file. For more information, refer to the [mqtt](/components/mqtt/) component.
|
||||
|
||||
Even though MQTT in general provides deeper functionality, the developer tools section of MQTT is limited to publishing messages to a given topic. It supports templates for the payload. To publish a message, simply specify the topic name and the payload and click “PUBLISH” button.
|
||||
|
||||
|
||||
@ -22,7 +22,7 @@ Many sensors and actors can directly control other devices through a capability
|
||||
|
||||
The *node* is the presence of the device on the Z-Wave mesh. Once you've added a device to Home Assistant, the node is represented by an `entity_id` that starts with `zwave`.
|
||||
|
||||
The *entity* is an individual component of the node. It may be a sensor that you read from, or a control that you operate. For any node, there will be at least one entity (for the node itself) and if it exposes any controls or sensors there will be at least one entity per control or sensor. The [entities](/docs/z-wave/entities) that are created depend on the Command Class the device supports.
|
||||
The *entity* is an individual integration of the node. It may be a sensor that you read from, or a control that you operate. For any node, there will be at least one entity (for the node itself) and if it exposes any controls or sensors there will be at least one entity per control or sensor. The [entities](/docs/z-wave/entities) that are created depend on the Command Class the device supports.
|
||||
|
||||
## {% linkable_title Z-Wave, Plus, Security 2 %}
|
||||
|
||||
|
||||
@ -68,12 +68,12 @@ device_config / device_config_domain / device_config_glob:
|
||||
type: integer
|
||||
default: 0
|
||||
refresh_value:
|
||||
description: Enable refreshing of the node value. Only the light component uses this.
|
||||
description: Enable refreshing of the node value. Only the light integration uses this.
|
||||
required: false
|
||||
type: boolean
|
||||
default: false
|
||||
delay:
|
||||
description: Specify the delay for refreshing of node value. Only the light component uses this.
|
||||
description: Specify the delay for refreshing of node value. Only the light integration uses this.
|
||||
required: false
|
||||
type: integer
|
||||
default: 5
|
||||
@ -107,7 +107,7 @@ Ensure you keep a backup of this key. If you have to rebuild your system and don
|
||||
|
||||
On platforms other than Hass.io and Docker, the compilation and installation of python-openzwave happens when you first enable the Z-Wave component, and can take half an hour or more on a Raspberry Pi. When you upgrade Home Assistant and python-openzwave is also upgraded, this will also result in a delay while the new version is compiled and installed.
|
||||
|
||||
The first run after adding a device is when the `zwave` component will take time to initialize the entities, some entities may appear with incomplete names. Running a network heal may speed up this process.
|
||||
The first run after adding a device is when the `zwave` integration will take time to initialize the entities, some entities may appear with incomplete names. Running a network heal may speed up this process.
|
||||
|
||||
## {% linkable_title Platform specific instructions %}
|
||||
|
||||
|
||||
@ -9,7 +9,7 @@ sharing: true
|
||||
footer: true
|
||||
---
|
||||
|
||||
The `zwave` component exposes multiple services to help maintain the network. All of these are available through the Z-Wave control panel.
|
||||
The `zwave` integration exposes multiple services to help maintain the network. All of these are available through the Z-Wave control panel.
|
||||
|
||||
| Service | Description |
|
||||
| ---------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
---
|
||||
layout: page
|
||||
title: "My component does not show up"
|
||||
description: "My component does not show up"
|
||||
title: "My integration does not show up"
|
||||
description: "My integration does not show up"
|
||||
date: 2017-06-18 09:00
|
||||
comments: false
|
||||
sharing: true
|
||||
@ -9,6 +9,6 @@ footer: true
|
||||
ha_category: Configuration
|
||||
---
|
||||
|
||||
When a component does not show up, many different things can be the case. Before you try any of these steps, make sure to look at the `home-assistant.log` file and see if there are any errors related to your component you are trying to set up.
|
||||
When a integration does not show up, many different things can be the case. Before you try any of these steps, make sure to look at the `home-assistant.log` file and see if there are any errors related to your integration you are trying to set up.
|
||||
|
||||
If you have incorrect entries in your configuration files you can use the `check_config` script to assist in identifying them: `hass --script check_config`.
|
||||
|
||||
@ -9,6 +9,6 @@ footer: true
|
||||
ha_category: Usage
|
||||
---
|
||||
|
||||
Almost all components have external dependencies to communicate with your devices and services. Sometimes Home Assistant is unable to install the necessary dependencies. If this is the case, it should show up in `home-assistant.log`.
|
||||
Almost all integrations have external dependencies to communicate with your devices and services. Sometimes Home Assistant is unable to install the necessary dependencies. If this is the case, it should show up in `home-assistant.log`.
|
||||
|
||||
The first step is trying to restart Home Assistant and see if the problem persists. If it does, look at the log to see what the error is. If you can't figure it out, please [report it](https://github.com/home-assistant/home-assistant/issues) so we can investigate what is going on.
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Integrations"
|
||||
description: "List of the built-in components of Home Assistant."
|
||||
description: "List of the built-in integrations of Home Assistant."
|
||||
date: 2014-12-21 13:35
|
||||
sidebar: false
|
||||
comments: false
|
||||
|
||||
@ -11,7 +11,7 @@ regenerate: true
|
||||
hide_github_edit: true
|
||||
---
|
||||
|
||||
This is a community curated list of different ways to use Home Assistant. Most of these examples are using the [automation] component and other built-in [automation related][sec-automation] and [organization] components available.
|
||||
This is a community curated list of different ways to use Home Assistant. Most of these examples are using the [automation] integration and other built-in [automation related][sec-automation] and [organization] integrations available.
|
||||
|
||||
For [`python_script:` examples](/components/python_script/) visit the [Scripts section](https://community.home-assistant.io/c/projects/scripts) in our forum.
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Components Architecture"
|
||||
description: "Overview of components within the Home Assistant architecture."
|
||||
description: "Overview of integrations within the Home Assistant architecture."
|
||||
date: 2016-04-16 14:24 -07:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Component Discovery"
|
||||
description: "How to make component discovery work."
|
||||
description: "How to make integration discovery work."
|
||||
date: 2017-11-23 07:27 +02:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Loading your components"
|
||||
description: "Instructions on how to get your component loaded by Home Assistant."
|
||||
description: "Instructions on how to get your integration loaded by Home Assistant."
|
||||
date: 2016-04-16 13:32
|
||||
sidebar: true
|
||||
comments: false
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Creating components"
|
||||
description: "Guidelines to get you create your first component for Home Assistant."
|
||||
description: "Guidelines to get you create your first integration for Home Assistant."
|
||||
date: 2014-12-21 13:32
|
||||
sidebar: true
|
||||
comments: false
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Custom Component Localization"
|
||||
description: "Translating custom components in Home Assistant"
|
||||
description: "Translating custom integrations in Home Assistant"
|
||||
date: 2018-03-01 18:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
|
||||
@ -13,7 +13,7 @@ Hass.io is a managed environment, which means you can't install applications tha
|
||||
|
||||
There are three options if you need to run a script which reads data from a sensor or sends commands to other devices on Hass.io.
|
||||
|
||||
The first option is to write a custom component for Home Assistant. This implies that you can communicate with your device using Python. For more information about developing a custom component, take a look at [custom-component development][custom-component].
|
||||
The first option is to write a custom integration for Home Assistant. This implies that you can communicate with your device using Python. For more information about developing a custom component, take a look at [custom-component development][custom-component].
|
||||
|
||||
The second option is to use STDIN inside an add-on and use the service `hassio.addon_stdin` to send data. For more information, have a look at [internal add-on communication][communication]. Here you will also find how you can easily access the Home Assistant Rest API.
|
||||
|
||||
|
||||
@ -27,7 +27,7 @@ Please provide the release which contains the issue.
|
||||
|
||||
### {% linkable_title Last working Home Assistant release (if known) %}
|
||||
|
||||
If possible, provide the latest release of which you know that the component or platform was working. Home Assistant is evolving very fast and issues may already be addressed or be introduced by a recent change.
|
||||
If possible, provide the latest release of which you know that the integration or platform was working. Home Assistant is evolving very fast and issues may already be addressed or be introduced by a recent change.
|
||||
|
||||
### {% linkable_title Operating environment (Hass.io/Docker/Windows/etc.) %}
|
||||
|
||||
@ -44,7 +44,7 @@ Please add the link to the documention of the component/platform in question. E.
|
||||
|
||||
Provide a summary of your issue and tell us what's wrong.
|
||||
|
||||
There are components and platform which require additional steps (installing third-party tools, compilers, etc.) to get your setup working. Please describe the steps you took and the ones to reproduce the issue if needed.
|
||||
There are integrations and platform which require additional steps (installing third-party tools, compilers, etc.) to get your setup working. Please describe the steps you took and the ones to reproduce the issue if needed.
|
||||
|
||||
### {% linkable_title Problem-relevant `configuration.yaml` entries %}
|
||||
|
||||
|
||||
@ -9,7 +9,7 @@ sharing: true
|
||||
footer: true
|
||||
---
|
||||
|
||||
It is possible to write your Lovelace config in YAML instead of via the UI. To do so, you will need to configure the Lovelace component to be in yaml mode by adding the following to your `configuration.yaml`:
|
||||
It is possible to write your Lovelace config in YAML instead of via the UI. To do so, you will need to configure the Lovelace integration to be in yaml mode by adding the following to your `configuration.yaml`:
|
||||
|
||||
```yaml
|
||||
lovelace:
|
||||
|
||||
@ -29,7 +29,7 @@ Certain visitors to Home Assistant’s websites choose to interact with Home Ass
|
||||
|
||||
## {% linkable_title Aggregated Statistics %}
|
||||
|
||||
Home Assistant may collect statistics about the behavior of visitors to its websites. For instance, Home Assistant may monitor the most popular component documentation. Home Assistant may display this information publicly or provide it to others. However, Home Assistant does not disclose personally-identifying information other than as described below.
|
||||
Home Assistant may collect statistics about the behavior of visitors to its websites. For instance, Home Assistant may monitor the most popular integration documentation. Home Assistant may display this information publicly or provide it to others. However, Home Assistant does not disclose personally-identifying information other than as described below.
|
||||
|
||||
## {% linkable_title Information We Collect from Other Sources %}
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user