mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-20 15:56:51 +00:00
✏️ The great integration migration - part 2 (#9760)
* ✏️ The great integration migration - part 2 * ✏️ Tweak
This commit is contained in:
parent
9ae34605af
commit
b1ef4996eb
@ -68,7 +68,7 @@ tts_platform:
|
|||||||
|
|
||||||
### {% linkable_title Home Assistant configuration %}
|
### {% linkable_title Home Assistant configuration %}
|
||||||
|
|
||||||
A simple configuration just requires this. Consult [Snips.ai component](/components/snips/) for more options.
|
A simple configuration just requires this. Consult [Snips.ai integration](/components/snips/) for more options.
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
snips:
|
snips:
|
||||||
@ -98,7 +98,7 @@ Next create a weather sensor, e.g., one for (Dark Sky)[/components/sensor.darksk
|
|||||||
- temperature_min
|
- temperature_min
|
||||||
```
|
```
|
||||||
|
|
||||||
Next add this to your `configuration.yaml` file to reference a new `intent_script` component. This is a good practice to [split your configuration files](/docs/configuration/splitting_configuration/) up.
|
Next add this to your `configuration.yaml` file to reference a new `intent_script` integration. This is a good practice to [split your configuration files](/docs/configuration/splitting_configuration/) up.
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
intent_script: !include intent_script.yaml
|
intent_script: !include intent_script.yaml
|
||||||
|
@ -7,7 +7,8 @@ sidebar: true
|
|||||||
comments: false
|
comments: false
|
||||||
sharing: true
|
sharing: true
|
||||||
footer: true
|
footer: true
|
||||||
redirect_from: /components/air_pollutants/
|
redirect_from:
|
||||||
|
- /components/air_pollutants/
|
||||||
ha_release: 0.85
|
ha_release: 0.85
|
||||||
---
|
---
|
||||||
|
|
||||||
|
@ -15,7 +15,7 @@ ha_release: 0.66
|
|||||||
|
|
||||||
The `ifttt` platform allows you to integrate security systems that have no open API but can be controlled through [IFTTT](https://ifttt.com/discover).
|
The `ifttt` platform allows you to integrate security systems that have no open API but can be controlled through [IFTTT](https://ifttt.com/discover).
|
||||||
|
|
||||||
This platform depends on the [IFTTT](/components/ifttt/) Home Assistant component. See the component's documentation to set it up.
|
This platform depends on the [IFTTT](/components/ifttt/) Home Assistant integration. See the integrations documentation to set it up.
|
||||||
|
|
||||||
<p class='note'>
|
<p class='note'>
|
||||||
It is important to note that this platform fully relies on IFTTT to receive updates when the security system's state changes. Therefore, this platform shows an assumed state.
|
It is important to note that this platform fully relies on IFTTT to receive updates when the security system's state changes. Therefore, this platform shows an assumed state.
|
||||||
|
@ -91,7 +91,7 @@ panel_display:
|
|||||||
default: false
|
default: false
|
||||||
type: boolean
|
type: boolean
|
||||||
zones:
|
zones:
|
||||||
description: "AlarmDecoder has no way to tell us which zones are actually in use, so each zone must be configured in Home Assistant. For each zone, at least a name must be given. For more information on the available zone types, take a look at the [Binary Sensor](/components/binary_sensor.alarmdecoder/) docs. *Note: If no zones are specified, Home Assistant will not load any binary_sensor components.*"
|
description: "AlarmDecoder has no way to tell us which zones are actually in use, so each zone must be configured in Home Assistant. For each zone, at least a name must be given. For more information on the available zone types, take a look at the [Binary Sensor](/components/binary_sensor.alarmdecoder/) docs. *Note: If no zones are specified, Home Assistant will not load any binary_sensor integrations.*"
|
||||||
required: false
|
required: false
|
||||||
type: list
|
type: list
|
||||||
keys:
|
keys:
|
||||||
|
@ -25,8 +25,8 @@ This entity allows you to silence an alert until it is resolved.
|
|||||||
|
|
||||||
### {% linkable_title Basic Example %}
|
### {% linkable_title Basic Example %}
|
||||||
|
|
||||||
The `alert` integration makes use of any of the `notifications` components. To
|
The `alert` integration makes use of any of the `notifications` integrations. To
|
||||||
setup the `alert` component, first, you must setup a `notification` component.
|
setup the `alert` integration, first, you must setup a `notification` integration.
|
||||||
Then, add the following to your configuration file:
|
Then, add the following to your configuration file:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
|
@ -90,7 +90,7 @@ This means that we can now ask Alexa things like:
|
|||||||
|
|
||||||
## {% linkable_title Configuring Home Assistant %}
|
## {% linkable_title Configuring Home Assistant %}
|
||||||
|
|
||||||
When activated, the Alexa integration will have Home Assistant's native intent support handle the incoming intents. If you want to run actions based on intents, use the [`intent_script`](/components/intent_script) component.
|
When activated, the Alexa integration will have Home Assistant's native intent support handle the incoming intents. If you want to run actions based on intents, use the [`intent_script`](/components/intent_script) integration.
|
||||||
|
|
||||||
To enable Alexa, add the following entry to your `configuration.yaml` file:
|
To enable Alexa, add the following entry to your `configuration.yaml` file:
|
||||||
|
|
||||||
|
@ -27,7 +27,7 @@ There are a few ways that you can use Amazon Alexa and Home Assistant together.
|
|||||||
- [Build custom commands to use](/components/alexa.intent/)
|
- [Build custom commands to use](/components/alexa.intent/)
|
||||||
- [Create a new Flash Briefing source](/components/alexa.flash_briefings/)
|
- [Create a new Flash Briefing source](/components/alexa.flash_briefings/)
|
||||||
- [Use the Smart Home API to control lights, etc](/components/alexa.smart_home/)
|
- [Use the Smart Home API to control lights, etc](/components/alexa.smart_home/)
|
||||||
- Alternative: use the [Emulated Hue component][emulated-hue-component] to trick Alexa to thinking Home Assistant is a Philips Hue hub.
|
- Alternative: use the [Emulated Hue integration][emulated-hue-component] to trick Alexa to thinking Home Assistant is a Philips Hue hub.
|
||||||
|
|
||||||
### {% linkable_title Requirements %}
|
### {% linkable_title Requirements %}
|
||||||
|
|
||||||
|
@ -19,7 +19,7 @@ ha_release: "0.54"
|
|||||||
While the Skills API described above allows for arbitrary intents, all
|
While the Skills API described above allows for arbitrary intents, all
|
||||||
utterances must begin with "Alexa, tell $invocation_name ..."
|
utterances must begin with "Alexa, tell $invocation_name ..."
|
||||||
|
|
||||||
The [Emulated Hue component][emulated-hue-component] provides a simpler
|
The [Emulated Hue integration][emulated-hue-component] provides a simpler
|
||||||
interface such as, "Alexa, turn on the kitchen light". However, it has some
|
interface such as, "Alexa, turn on the kitchen light". However, it has some
|
||||||
limitations since everything looks like a light bulb.
|
limitations since everything looks like a light bulb.
|
||||||
|
|
||||||
|
@ -14,7 +14,7 @@ ha_qa_scale: internal
|
|||||||
ha_release: 0.7
|
ha_release: 0.7
|
||||||
---
|
---
|
||||||
|
|
||||||
The `api` integration exposes a RESTful API and allows one to interact with a Home Assistant instance that is running headless. This integration depends on the [`http` component](/components/http/).
|
The `api` integration exposes a RESTful API and allows one to interact with a Home Assistant instance that is running headless. This integration depends on the [`http` integration](/components/http/).
|
||||||
|
|
||||||
<p class='note warning'>
|
<p class='note warning'>
|
||||||
It is HIGHLY recommended that you set the `api_password`, especially if you are planning to expose your installation to the internet.
|
It is HIGHLY recommended that you set the `api_password`, especially if you are planning to expose your installation to the internet.
|
||||||
|
@ -15,4 +15,4 @@ redirect_from:
|
|||||||
- /components/mailbox.asterisk_cdr/
|
- /components/mailbox.asterisk_cdr/
|
||||||
---
|
---
|
||||||
|
|
||||||
The Asterisk Call Data Recorder provides access to Asterisk call logs on the Asterisk PBX server. This mailbox is enabled automatically through the [Asterisk Voicemail component](/components/asterisk_mbox/) configuration if the `asterisk_mbox_server` is configured to provide CDR data. More information on configuring the server can be found in the [Asterisk PBX configuration guide](/docs/asterisk_mbox/).
|
The Asterisk Call Data Recorder provides access to Asterisk call logs on the Asterisk PBX server. This mailbox is enabled automatically through the [Asterisk Voicemail integration](/components/asterisk_mbox/) configuration if the `asterisk_mbox_server` is configured to provide CDR data. More information on configuring the server can be found in the [Asterisk PBX configuration guide](/docs/asterisk_mbox/).
|
||||||
|
@ -18,7 +18,7 @@ The `knx` sensor platform allows you to monitor [KNX](http://www.knx.org) binary
|
|||||||
|
|
||||||
## {% linkable_title Configuration %}
|
## {% linkable_title Configuration %}
|
||||||
|
|
||||||
The `knx` integration must be configured correctly, see [KNX Component](/components/knx).
|
The `knx` integration must be configured correctly, see [KNX Integration](/components/knx).
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
|
@ -45,7 +45,7 @@ The way these sensors are displayed in the frontend can be modified in the [cust
|
|||||||
- **vibration**: `On` means vibration detected, `Off` means no vibration (clear)
|
- **vibration**: `On` means vibration detected, `Off` means no vibration (clear)
|
||||||
- **window**: `On` means open, `Off` means closed
|
- **window**: `On` means open, `Off` means closed
|
||||||
|
|
||||||
For analog sensors please check the [component overview](/components/#sensor).
|
For analog sensors please check the [integration overview](/components/#sensor).
|
||||||
|
|
||||||
<p class='img'>
|
<p class='img'>
|
||||||
<img src='/images/screenshots/binary_sensor_classes_icons.png' />
|
<img src='/images/screenshots/binary_sensor_classes_icons.png' />
|
||||||
|
@ -16,7 +16,7 @@ ha_iot_class: Local Push
|
|||||||
|
|
||||||
The `xiaomi aqara` binary sensor platform allows you to get data from your [Xiaomi](http://www.mi.com/en/) binary sensors.
|
The `xiaomi aqara` binary sensor platform allows you to get data from your [Xiaomi](http://www.mi.com/en/) binary sensors.
|
||||||
|
|
||||||
The requirement is that you have setup the [`xiaomi aqara` component](/components/xiaomi_aqara/).
|
The requirement is that you have setup the [`xiaomi aqara` integration](/components/xiaomi_aqara/).
|
||||||
|
|
||||||
### {% linkable_title Type of sensors supported %}
|
### {% linkable_title Type of sensors supported %}
|
||||||
|
|
||||||
|
@ -160,7 +160,7 @@ The following are some examples showing how to correctly make service calls usin
|
|||||||
|
|
||||||
### {% linkable_title Snap Picture and Save Locally %}
|
### {% linkable_title Snap Picture and Save Locally %}
|
||||||
|
|
||||||
This example script shows how to take a picture with your camera, named `My Camera` in your Blink app (this is **not necessarily** the friendly name in home-assistant). After snapping a picture, the image will then be saved to a local directory called `/tmp/my_image.jpg`. Note that this example makes use of services found in the [camera component](https://www.home-assistant.io/components/camera#service-snapshot)
|
This example script shows how to take a picture with your camera, named `My Camera` in your Blink app (this is **not necessarily** the friendly name in home-assistant). After snapping a picture, the image will then be saved to a local directory called `/tmp/my_image.jpg`. Note that this example makes use of services found in the [camera integration](https://www.home-assistant.io/components/camera#service-snapshot)
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
alias: Blink Snap Picture
|
alias: Blink Snap Picture
|
||||||
|
@ -114,7 +114,7 @@ aq_humidity_bias:
|
|||||||
default: 25
|
default: 25
|
||||||
type: integer
|
type: integer
|
||||||
temp_offset:
|
temp_offset:
|
||||||
description: "The temperature for the sensor will always be too high as it pulls heat from the components around it. Consider adding a negative offset to ensure the sensor returns an accurate temperature. Note: This value is in celsius."
|
description: "The temperature for the sensor will always be too high as it pulls heat from the components around it. Consider adding a negative offset to ensure the sensor returns an accurate temperature. Note: This value is in celsius."
|
||||||
required: false
|
required: false
|
||||||
default: 0
|
default: 0
|
||||||
type: float
|
type: float
|
||||||
|
@ -18,7 +18,7 @@ The `ffmpeg` platform allows you to use any video feed as a camera in Home Assis
|
|||||||
|
|
||||||
## {% linkable_title Configuration %}
|
## {% linkable_title Configuration %}
|
||||||
|
|
||||||
To enable your FFmpeg feed in your installation you must first configure the [ffmpeg component](/components/ffmpeg/), then add the following to your `configuration.yaml` file:
|
To enable your FFmpeg feed in your installation you must first configure the [ffmpeg integration](/components/ffmpeg/), then add the following to your `configuration.yaml` file:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
|
@ -57,7 +57,7 @@ timeout:
|
|||||||
default: 10
|
default: 10
|
||||||
{% endconfiguration %}
|
{% endconfiguration %}
|
||||||
|
|
||||||
Once loaded, your front end will have the following components:
|
Once loaded, your front end will have the following integrations:
|
||||||
|
|
||||||
- A camera image triggered by motion for each camera.
|
- A camera image triggered by motion for each camera.
|
||||||
- An alarm control panel for each location.
|
- An alarm control panel for each location.
|
||||||
@ -67,9 +67,9 @@ Once loaded, your front end will have the following components:
|
|||||||
|
|
||||||
## {% linkable_title Camera %}
|
## {% linkable_title Camera %}
|
||||||
|
|
||||||
The `canary` camera platform allows you to watch the live stream of your [Canary](https://canary.is) camera in Home Assistant. This requires the [`ffmpeg` component](/components/ffmpeg/) to be already configured.
|
The `canary` camera platform allows you to watch the live stream of your [Canary](https://canary.is) camera in Home Assistant. This requires the [`ffmpeg` integration](/components/ffmpeg/) to be already configured.
|
||||||
|
|
||||||
Once you have [Canary component](/components/canary/) setup, your [Canary](https://canary.is) camera(s) should show up automatically.
|
Once you have [Canary integration](/components/canary/) setup, your [Canary](https://canary.is) camera(s) should show up automatically.
|
||||||
|
|
||||||
## {% linkable_title Configuration %}
|
## {% linkable_title Configuration %}
|
||||||
|
|
||||||
@ -82,7 +82,7 @@ camera:
|
|||||||
|
|
||||||
{% configuration %}
|
{% configuration %}
|
||||||
ffmpeg_arguments:
|
ffmpeg_arguments:
|
||||||
description: Extra options to pass to `ffmpeg`, e.g., image quality or video filter options. More details in [FFmpeg component](/components/ffmpeg).
|
description: Extra options to pass to `ffmpeg`, e.g., image quality or video filter options. More details in [FFmpeg integration](/components/ffmpeg).
|
||||||
required: false
|
required: false
|
||||||
type: string
|
type: string
|
||||||
{% endconfiguration %}
|
{% endconfiguration %}
|
||||||
|
@ -17,15 +17,15 @@ redirect_from: /components/media_player.cast/
|
|||||||
---
|
---
|
||||||
|
|
||||||
Google Cast devices like Android TVs and Chromecasts will be automatically
|
Google Cast devices like Android TVs and Chromecasts will be automatically
|
||||||
discovered if you enable [the discovery component](/components/discovery/). If
|
discovered if you enable [the discovery integration(/components/discovery/). If
|
||||||
you don't have the discovery integration enabled, you can enable the Cast
|
you don't have the discovery integration enabled, you can enable the Cast
|
||||||
component by going to the Integrations page inside the config panel.
|
integration by going to the Integrations page inside the config panel.
|
||||||
|
|
||||||
## {% linkable_title Advanced use %}
|
## {% linkable_title Advanced use %}
|
||||||
|
|
||||||
The Cast integration has some extra configuration options available for advanced
|
The Cast integration has some extra configuration options available for advanced
|
||||||
users. You will still need to create a config entry to initialize the Cast
|
users. You will still need to create a config entry to initialize the Cast
|
||||||
component.
|
integration.
|
||||||
|
|
||||||
For example, Cast devices can only be discovered if they are on the same subnet
|
For example, Cast devices can only be discovered if they are on the same subnet
|
||||||
as Home Assistant. If this is not the case,
|
as Home Assistant. If this is not the case,
|
||||||
|
@ -16,7 +16,7 @@ ha_iot_class: Local Polling
|
|||||||
|
|
||||||
The `knx` climate platform is used as in interface with KNX thermostats.
|
The `knx` climate platform is used as in interface with KNX thermostats.
|
||||||
|
|
||||||
The `knx` integration must be configured correctly, see [KNX Component](/components/knx).
|
The `knx` integration must be configured correctly, see [KNX Integration](/components/knx).
|
||||||
|
|
||||||
To use your KNX thermostats in your installation, add the following lines to your `configuration.yaml` file:
|
To use your KNX thermostats in your installation, add the following lines to your `configuration.yaml` file:
|
||||||
|
|
||||||
|
@ -24,6 +24,6 @@ The configurator integration allows integrations to request information from the
|
|||||||
- Input fields can be defined with a description, and optional type
|
- Input fields can be defined with a description, and optional type
|
||||||
- It will trigger a callback when the button is pressed
|
- It will trigger a callback when the button is pressed
|
||||||
|
|
||||||
The Hue integration in [the demo](/demo) and Plex are implemented using the configurator. See [the source of the demo component](https://github.com/home-assistant/home-assistant/tree/dev/homeassistant/components/demo) for a simple example.
|
The Hue integration in [the demo](/demo) and Plex are implemented using the configurator. See [the source of the demo integration](https://github.com/home-assistant/home-assistant/tree/dev/homeassistant/components/demo) for a simple example.
|
||||||
|
|
||||||
See [the source](https://github.com/home-assistant/home-assistant/tree/dev/homeassistant/components/configurator) for more details on how to use the configurator component.
|
See [the source](https://github.com/home-assistant/home-assistant/tree/dev/homeassistant/components/configurator) for more details on how to use the configurator integration.
|
||||||
|
@ -40,7 +40,7 @@ intents:
|
|||||||
|
|
||||||
## {% linkable_title Adding custom sentences %}
|
## {% linkable_title Adding custom sentences %}
|
||||||
|
|
||||||
By default, it will support turning devices on and off. You can say things like "turn on kitchen lights" or "turn the living room lights off". You can also configure your own sentences to be processed. This works by mapping sentences to intents and then configure the [intent script component](/components/intent_script/) to handle these intents.
|
By default, it will support turning devices on and off. You can say things like "turn on kitchen lights" or "turn the living room lights off". You can also configure your own sentences to be processed. This works by mapping sentences to intents and then configure the [intent script integration](/components/intent_script/) to handle these intents.
|
||||||
|
|
||||||
Here is a simple example to be able to ask what the temperature in the living room is.
|
Here is a simple example to be able to ask what the temperature in the living room is.
|
||||||
|
|
||||||
|
@ -17,7 +17,7 @@ ha_iot_class: Local Polling
|
|||||||
|
|
||||||
The `knx` cover platform is used as in interface with KNX covers.
|
The `knx` cover platform is used as in interface with KNX covers.
|
||||||
|
|
||||||
The `knx` integration must be configured correctly, see [KNX Component](/components/knx).
|
The `knx` integration must be configured correctly, see [KNX Integration](/components/knx).
|
||||||
|
|
||||||
To use your KNX covers in your installation, add the following to your `configuration.yaml` file:
|
To use your KNX covers in your installation, add the following to your `configuration.yaml` file:
|
||||||
|
|
||||||
|
@ -38,7 +38,7 @@ There is currently support for the following device types within Home Assistant:
|
|||||||
|
|
||||||
The Daikin integration can be configured in three ways.
|
The Daikin integration can be configured in three ways.
|
||||||
|
|
||||||
- Automatically via the [discovery]({{site_root}}/components/discovery/) component.
|
- Automatically via the [discovery]({{site_root}}/components/discovery/) integration.
|
||||||
- Via the Home Assistant user interface where it will let you enter the IP-address of your Daikin AC.
|
- Via the Home Assistant user interface where it will let you enter the IP-address of your Daikin AC.
|
||||||
- Or via the `configuration.yaml` file by adding the following:
|
- Or via the `configuration.yaml` file by adding the following:
|
||||||
|
|
||||||
|
@ -329,7 +329,7 @@ The `entity_id` name will be `binary_sensor.device_name`, where `device_name` is
|
|||||||
|
|
||||||
## {% linkable_title Climate %}
|
## {% linkable_title Climate %}
|
||||||
|
|
||||||
See the [deCONZ main component](/components/deconz/) for configuration instructions.
|
See the [deCONZ main integration](/components/deconz/) for configuration instructions.
|
||||||
|
|
||||||
Climate currently represent thermostats.
|
Climate currently represent thermostats.
|
||||||
|
|
||||||
@ -386,7 +386,7 @@ The following sensor types are supported:
|
|||||||
- Switches
|
- Switches
|
||||||
- Temperature sensor
|
- Temperature sensor
|
||||||
|
|
||||||
The `entity_id` name will be `sensor.device_name`, where `device_name` is defined in deCONZ. Switches aren't exposed as ordinary entities, see the [deCONZ main component](/components/deconz/) for more details.
|
The `entity_id` name will be `sensor.device_name`, where `device_name` is defined in deCONZ. Switches aren't exposed as ordinary entities, see the [deCONZ main integration](/components/deconz/) for more details.
|
||||||
|
|
||||||
### {% linkable_title Verified to be supported sensors %}
|
### {% linkable_title Verified to be supported sensors %}
|
||||||
|
|
||||||
|
@ -22,7 +22,7 @@ Home Assistant has a built-in integration called `device_sun_light_trigger` to h
|
|||||||
|
|
||||||
This integration requires the integrations [sun](/components/sun/), [device_tracker](/components/device_tracker/) and [light](/components/light/) to be enabled.
|
This integration requires the integrations [sun](/components/sun/), [device_tracker](/components/device_tracker/) and [light](/components/light/) to be enabled.
|
||||||
|
|
||||||
To enable this component, add the following lines to your `configuration.yaml` file:
|
To enable this integration, add the following lines to your `configuration.yaml` file:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
|
@ -11,7 +11,8 @@ logo: dialogflow.png
|
|||||||
ha_category:
|
ha_category:
|
||||||
- Voice
|
- Voice
|
||||||
ha_release: 0.56
|
ha_release: 0.56
|
||||||
redirect_from: /components/apiai/
|
redirect_from:
|
||||||
|
- /components/apiai/
|
||||||
---
|
---
|
||||||
|
|
||||||
The `dialogflow` integration is designed to be used with the [webhook](https://dialogflow.com/docs/fulfillment#webhook) integration of [Dialogflow](https://dialogflow.com/). When a conversation ends with a user, Dialogflow sends an action and parameters to the webhook.
|
The `dialogflow` integration is designed to be used with the [webhook](https://dialogflow.com/docs/fulfillment#webhook) integration of [Dialogflow](https://dialogflow.com/). When a conversation ends with a user, Dialogflow sends an action and parameters to the webhook.
|
||||||
@ -62,7 +63,7 @@ Take a look to "Integrations", in the left menu, to configure third parties.
|
|||||||
|
|
||||||
### {% linkable_title Configuring Home Assistant %}
|
### {% linkable_title Configuring Home Assistant %}
|
||||||
|
|
||||||
When activated, the [`alexa` component](/components/alexa/) will have Home Assistant's native intent support handle the incoming intents. If you want to run actions based on intents, use the [`intent_script`](/components/intent_script) component.
|
When activated, the [`alexa` integration](/components/alexa/) will have Home Assistant's native intent support handle the incoming intents. If you want to run actions based on intents, use the [`intent_script`](/components/intent_script) integration.
|
||||||
|
|
||||||
## {% linkable_title Examples %}
|
## {% linkable_title Examples %}
|
||||||
|
|
||||||
|
@ -16,7 +16,7 @@ redirect_from:
|
|||||||
- /components/media_player.directv/
|
- /components/media_player.directv/
|
||||||
---
|
---
|
||||||
|
|
||||||
Master [DirecTV](http://www.directv.com/) receivers (ie: those that have tuners) will be automatically discovered if you enable the [discovery component](/components/discovery/) and the receiver is powered-on. Slave/RVU client/Genie boxes will also be discovered, but only if they are also online at the time of discovery.
|
Master [DirecTV](http://www.directv.com/) receivers (ie: those that have tuners) will be automatically discovered if you enable the [discovery integration](/components/discovery/) and the receiver is powered-on. Slave/RVU client/Genie boxes will also be discovered, but only if they are also online at the time of discovery.
|
||||||
|
|
||||||
To ensure that your DirecTV boxes are always found and configured, they should be added into your `configuration.yaml`.
|
To ensure that your DirecTV boxes are always found and configured, they should be added into your `configuration.yaml`.
|
||||||
|
|
||||||
|
@ -17,7 +17,7 @@ redirect_from:
|
|||||||
|
|
||||||
The `dlib_face_detect` image processing platform allows you to use the [Dlib](http://www.dlib.net/) through Home Assistant. This platform enables face detection from cameras, and can fire events with attributes.
|
The `dlib_face_detect` image processing platform allows you to use the [Dlib](http://www.dlib.net/) through Home Assistant. This platform enables face detection from cameras, and can fire events with attributes.
|
||||||
|
|
||||||
This can be used to trigger an automation rule. Further info is on the [component](/components/image_processing/) page.
|
This can be used to trigger an automation rule. Further info is on the [integration](/components/image_processing/) page.
|
||||||
|
|
||||||
### {% linkable_title Configuration Home Assistant %}
|
### {% linkable_title Configuration Home Assistant %}
|
||||||
|
|
||||||
|
@ -17,7 +17,7 @@ redirect_from:
|
|||||||
|
|
||||||
The `dlib_face_identify` image processing platform allows you to use the [Dlib](http://www.dlib.net/) through Home Assistant. This platform allow you to identify persons on camera and fire an event with identify persons.
|
The `dlib_face_identify` image processing platform allows you to use the [Dlib](http://www.dlib.net/) through Home Assistant. This platform allow you to identify persons on camera and fire an event with identify persons.
|
||||||
|
|
||||||
For using the result inside an automation rule, take a look at the [component](/components/image_processing/) page.
|
For using the result inside an automation rule, take a look at the [integration](/components/image_processing/) page.
|
||||||
|
|
||||||
### {% linkable_title Configuration Home Assistant %}
|
### {% linkable_title Configuration Home Assistant %}
|
||||||
|
|
||||||
|
@ -10,7 +10,7 @@ footer: true
|
|||||||
ha_category: Automation Examples
|
ha_category: Automation Examples
|
||||||
---
|
---
|
||||||
|
|
||||||
This will send a message when someone in your known devices list connects to your local network. In other words, when someone arrives home. It will only work if you are using the [Nmap](/components/device_tracker.nmap_tracker/) device tracker or a similar component.
|
This will send a message when someone in your known devices list connects to your local network. In other words, when someone arrives home. It will only work if you are using the [Nmap](/components/device_tracker.nmap_tracker/) device tracker or a similar integration.
|
||||||
|
|
||||||
This example uses [Telegram](/components/notify.telegram/) to send the notification.
|
This example uses [Telegram](/components/notify.telegram/) to send the notification.
|
||||||
|
|
||||||
|
@ -12,7 +12,7 @@ ha_category: Automation Examples
|
|||||||
|
|
||||||
Like it how the lights dim up/down at the movies? Do it at home as well!
|
Like it how the lights dim up/down at the movies? Do it at home as well!
|
||||||
|
|
||||||
This example uses the [media player](/components/media_player/), [lights](/components/light/) (transitions) and the [sun](/components/sun/) component. We'll use actions to detect media player state changes and [scenes](/components/scene/) to control multiple lights and transition between scenes.
|
This example uses the [media player](/components/media_player/), [lights](/components/light/) (transitions) and the [sun](/components/sun/) integration. We'll use actions to detect media player state changes and [scenes](/components/scene/) to control multiple lights and transition between scenes.
|
||||||
|
|
||||||
#### {% linkable_title Scenes %}
|
#### {% linkable_title Scenes %}
|
||||||
One scene for normal light, one for when movies are on. A 2 second transition gives a nice 'feel' to the switch.
|
One scene for normal light, one for when movies are on. A 2 second transition gives a nice 'feel' to the switch.
|
||||||
|
@ -11,10 +11,10 @@ ha_category: Custom Python Component Examples
|
|||||||
---
|
---
|
||||||
|
|
||||||
<p class='note'>
|
<p class='note'>
|
||||||
This example requires you to have the [MQTT component](/components/mqtt/) up and running.
|
This example requires you to have the [MQTT integration](/components/mqtt/) up and running.
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
This is a simple hello world example to show the basics of using MQTT in a custom component. To use this example, create the file `<config dir>/custom_components/hello_mqtt.py` and copy the below example code.
|
This is a simple hello world example to show the basics of using MQTT in a custom integration. To use this example, create the file `<config dir>/custom_components/hello_mqtt.py` and copy the below example code.
|
||||||
|
|
||||||
This example follows a topic on MQTT and updates the state of an entity to the last message received on that topic. It will also register a service 'set_state' that will publish a message to the MQTT topic that we're listening to.
|
This example follows a topic on MQTT and updates the state of an entity to the last message received on that topic. It will also register a service 'set_state' that will publish a message to the MQTT topic that we're listening to.
|
||||||
|
|
||||||
|
@ -10,7 +10,7 @@ footer: true
|
|||||||
ha_category: Automation in Python Examples
|
ha_category: Automation in Python Examples
|
||||||
---
|
---
|
||||||
|
|
||||||
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 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 integration](/components/notify/). It will also flash a specific light when a known person comes home.
|
||||||
|
|
||||||
This integration depends on the integrations [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.
|
||||||
|
|
||||||
|
@ -3,7 +3,8 @@ layout: page
|
|||||||
title: "Authentication"
|
title: "Authentication"
|
||||||
description: "Guide on authentication in Home Assistant."
|
description: "Guide on authentication in Home Assistant."
|
||||||
date: 2018-08-23 09:40
|
date: 2018-08-23 09:40
|
||||||
redirect_from: /components/auth/
|
redirect_from:
|
||||||
|
- /components/auth/
|
||||||
sidebar: true
|
sidebar: true
|
||||||
comments: false
|
comments: false
|
||||||
sharing: true
|
sharing: true
|
||||||
|
@ -27,7 +27,7 @@ See the [open ports](/docs/security/porosity/) of a Hass.io instance with variou
|
|||||||
|
|
||||||
## {% linkable_title HTTP SSL/TLS %}
|
## {% linkable_title HTTP SSL/TLS %}
|
||||||
|
|
||||||
Home Assistant is following the [Mozilla's Operations Security team recommendations](https://wiki.mozilla.org/Security/Server_Side_TLS) for Server side SSL/TLS settings. Home Assistant uses **Modern compatibility** by default. If an user wishes to use **Intermediate compatibilty**, this is configurable in the [`http` component](/components/http/).
|
Home Assistant is following the [Mozilla's Operations Security team recommendations](https://wiki.mozilla.org/Security/Server_Side_TLS) for Server side SSL/TLS settings. Home Assistant uses **Modern compatibility** by default. If an user wishes to use **Intermediate compatibilty**, this is configurable in the [`http` integration](/components/http/).
|
||||||
|
|
||||||
## {% linkable_title SSH %}
|
## {% linkable_title SSH %}
|
||||||
|
|
||||||
|
@ -20,7 +20,7 @@ Before configuring the Z-Wave setup, please take a moment and read [this article
|
|||||||
|
|
||||||
Z-Wave is a wireless communication protocol designed for home automation. It uses a low power, and low bandwidth, mesh network that allows devices that aren't within direct range of each other to communicate indirectly, via other nodes. Any device that's permanently powered (not battery powered) will help build the mesh, if you don't have enough powered devices, or you locate these poorly, your mesh will be unreliable. You can [view the state](https://community.home-assistant.io/t/graph-your-z-wave-mesh-python-auto-update/40549) of your mesh [by graphing it](https://community.home-assistant.io/t/z-wave-graph-without-the-python/64275).
|
Z-Wave is a wireless communication protocol designed for home automation. It uses a low power, and low bandwidth, mesh network that allows devices that aren't within direct range of each other to communicate indirectly, via other nodes. Any device that's permanently powered (not battery powered) will help build the mesh, if you don't have enough powered devices, or you locate these poorly, your mesh will be unreliable. You can [view the state](https://community.home-assistant.io/t/graph-your-z-wave-mesh-python-auto-update/40549) of your mesh [by graphing it](https://community.home-assistant.io/t/z-wave-graph-without-the-python/64275).
|
||||||
|
|
||||||
There is a limit of 232 devices in a single Z-Wave network. If you need more devices then you could set up a second Home Assistant system with its own Z-Wave network and connect these with the [MQTT Eventstream](/components/mqtt_eventstream/) or [MQTT Statestream](/components/mqtt_statestream) components. There is also a limit of 4 hops for Z-Wave, so placing the controller as centrally as you can is important.
|
There is a limit of 232 devices in a single Z-Wave network. If you need more devices then you could set up a second Home Assistant system with its own Z-Wave network and connect these with the [MQTT Eventstream](/components/mqtt_eventstream/) or [MQTT Statestream](/components/mqtt_statestream) integrations. There is also a limit of 4 hops for Z-Wave, so placing the controller as centrally as you can is important.
|
||||||
|
|
||||||
The Z-Wave standard was improved with Z-Wave Plus, and if you only use Z-Wave plus devices then you will gain the full benefits.
|
The Z-Wave standard was improved with Z-Wave Plus, and if you only use Z-Wave plus devices then you will gain the full benefits.
|
||||||
|
|
||||||
@ -34,7 +34,7 @@ There are 12 different regions for Z-Wave devices, which relates to the frequenc
|
|||||||
|
|
||||||
## {% linkable_title Getting started %}
|
## {% linkable_title Getting started %}
|
||||||
|
|
||||||
You'll now need to connect your [controller](/docs/z-wave/controllers/), [configure](/docs/z-wave/installation) the Z-Wave component, then [add some devices](/docs/z-wave/adding) using the [control panel](/docs/z-wave/control-panel). [This explains](/docs/z-wave/devices/) about devices, and how [entities are named](/docs/z-wave/entities).
|
You'll now need to connect your [controller](/docs/z-wave/controllers/), [configure](/docs/z-wave/installation) the Z-Wave integration, then [add some devices](/docs/z-wave/adding) using the [control panel](/docs/z-wave/control-panel). [This explains](/docs/z-wave/devices/) about devices, and how [entities are named](/docs/z-wave/entities).
|
||||||
|
|
||||||
You can get more information on the [available services](/docs/z-wave/services/) and [events](/docs/z-wave/events/), what the [query stages](/docs/z-wave/query-stage) of battery powered devices are, as well as details on configuring [specific devices](/docs/z-wave/device-specific/).
|
You can get more information on the [available services](/docs/z-wave/services/) and [events](/docs/z-wave/events/), what the [query stages](/docs/z-wave/query-stage) of battery powered devices are, as well as details on configuring [specific devices](/docs/z-wave/device-specific/).
|
||||||
|
|
||||||
|
@ -2,7 +2,7 @@
|
|||||||
layout: page
|
layout: page
|
||||||
title: "Alarm Panel Card"
|
title: "Alarm Panel Card"
|
||||||
sidebar_label: Alarm Panel
|
sidebar_label: Alarm Panel
|
||||||
description: "The Alarm Panel allows you to Arm and Disarm your Alarm Control Panel Components"
|
description: "The Alarm Panel allows you to Arm and Disarm your Alarm Control Panel Integrations"
|
||||||
date: 2018-10-15 10:28 +00:00
|
date: 2018-10-15 10:28 +00:00
|
||||||
sidebar: true
|
sidebar: true
|
||||||
comments: false
|
comments: false
|
||||||
@ -10,7 +10,7 @@ sharing: true
|
|||||||
footer: true
|
footer: true
|
||||||
---
|
---
|
||||||
|
|
||||||
The Alarm Panel allows you to Arm and Disarm your Alarm Control Panel Components.
|
The Alarm Panel allows you to Arm and Disarm your Alarm Control Panel Integrations.
|
||||||
|
|
||||||
<p class='img'>
|
<p class='img'>
|
||||||
<img src='/images/lovelace/lovelace_alarm_panel_card.gif' alt='Screenshot of the alarm panel card'>
|
<img src='/images/lovelace/lovelace_alarm_panel_card.gif' alt='Screenshot of the alarm panel card'>
|
||||||
|
@ -7,7 +7,8 @@ sidebar: false
|
|||||||
comments: false
|
comments: false
|
||||||
sharing: true
|
sharing: true
|
||||||
footer: true
|
footer: true
|
||||||
redirect_from: /components/cloud.alexa/
|
redirect_from:
|
||||||
|
- /components/cloud.alexa/
|
||||||
---
|
---
|
||||||
|
|
||||||
Home Assistant Cloud is a subscription service provided by our partner Nabu Casa, Inc. Check out [the Nabu Casa website](https://www.nabucasa.com/config/amazon_alexa/) for help with the Amazon Alexa integration via Home Assistant Cloud.
|
Home Assistant Cloud is a subscription service provided by our partner Nabu Casa, Inc. Check out [the Nabu Casa website](https://www.nabucasa.com/config/amazon_alexa/) for help with the Amazon Alexa integration via Home Assistant Cloud.
|
||||||
|
@ -116,7 +116,7 @@ The packages you need to have available on your system that will run Hass.io may
|
|||||||
- software-properties-common
|
- software-properties-common
|
||||||
|
|
||||||
<p class='note warning'>
|
<p class='note warning'>
|
||||||
The `modemmanager` package will interfere with any Z-Wave or Zigbee stick and should be removed or disabled. Failure to do so will result in random failures of those components. For example you can disable with `sudo systemctl disable ModemManager` and remove with `sudo apt-get purge modemmanager`
|
The `modemmanager` package will interfere with any Z-Wave or Zigbee stick and should be removed or disabled. Failure to do so will result in random failures of those integrations. For example you can disable with `sudo systemctl disable ModemManager` and remove with `sudo apt-get purge modemmanager`
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
### {% linkable_title Arch Linux %}
|
### {% linkable_title Arch Linux %}
|
||||||
|
@ -33,12 +33,12 @@ If possible, provide the latest release of which you know that the integration o
|
|||||||
|
|
||||||
There are many different ways to run Home Assistant. In this section please mention which you are using, e.g., manual installation, [Hass.io](/hassio/), Hasbian or as container (Docker). It can help if you mention which operating system you are using because not all are supported on the same level.
|
There are many different ways to run Home Assistant. In this section please mention which you are using, e.g., manual installation, [Hass.io](/hassio/), Hasbian or as container (Docker). It can help if you mention which operating system you are using because not all are supported on the same level.
|
||||||
|
|
||||||
### {% linkable_title Component/platform %}
|
### {% linkable_title Integration/platform %}
|
||||||
|
|
||||||
Please add the link to the documention of the component/platform in question. E.g.,
|
Please add the link to the documention of the integration/platform in question. E.g.,
|
||||||
|
|
||||||
- issue with the `random` sensor: [/components/sensor.random/](/components/sensor.random/)
|
- issue with the `random` sensor: [/components/sensor.random/](/components/sensor.random/)
|
||||||
- issue with the `hue` component: [/components/hue/](/components/hue/)
|
- issue with the `hue` integration: [/components/hue/](/components/hue/)
|
||||||
|
|
||||||
### {% linkable_title Description of problem %}
|
### {% linkable_title Description of problem %}
|
||||||
|
|
||||||
|
@ -17,7 +17,7 @@ Isn't it obvious? Home Assistant is the good soul that is assisting you in your
|
|||||||
|
|
||||||
### {% linkable_title Website %}
|
### {% linkable_title Website %}
|
||||||
|
|
||||||
The website [https://www.home-assistant.io](/) was launched on December 18, 2014 and contains documentation about the setup process, the platforms and components, and for the developers.
|
The website [https://www.home-assistant.io](/) was launched on December 18, 2014 and contains documentation about the setup process, the platforms and integrations, and for the developers.
|
||||||
|
|
||||||
### {% linkable_title Logo %}
|
### {% linkable_title Logo %}
|
||||||
|
|
||||||
|
@ -7,7 +7,8 @@ sidebar: true
|
|||||||
comments: false
|
comments: false
|
||||||
sharing: true
|
sharing: true
|
||||||
footer: true
|
footer: true
|
||||||
redirect_from: /components/lovelace/
|
redirect_from:
|
||||||
|
- /components/lovelace/
|
||||||
---
|
---
|
||||||
|
|
||||||
Lovelace is the name of the Home Assistant user interface. It is a fast, customizable and powerful way for users to manage their homes, working both on mobile and desktop.
|
Lovelace is the name of the Home Assistant user interface. It is a fast, customizable and powerful way for users to manage their homes, working both on mobile and desktop.
|
||||||
|
Loading…
x
Reference in New Issue
Block a user