jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-23 17:27:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'current' into next

Browse Source
This commit is contained in:
Fabian Affolter 2018-11-25 10:07:28 +01:00
commit e8a4516e1b
No known key found for this signature in database
GPG Key ID: E23CD2DD36A4397F
16 changed files with 175 additions and 78 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
source/_components/cast.markdown
View File

@ -34,9 +34,13 @@ you want to configure the IP address of the Cast device directly:
# Example configuration.yaml entry
cast:
media_player:
- host: 192.168.1.10
- host: 192.168.1.10
```
<p class='note'>
You may need to enable Multicast DNS (MDNS) on your router if you are on a different subnet or VLAN.
</p>
{% configuration %}
media_player:
description: A list that contains all Cast devices.
@ -62,6 +66,6 @@ those as follows:
# Example configuration.yaml entry for multiple devices
cast:
media_player:
- host: IP_ADDRESS_DEVICE_1
- host: IP_ADDRESS_DEVICE_2
- host: IP_ADDRESS_DEVICE_1
- host: IP_ADDRESS_DEVICE_2
```

2
source/_components/device_tracker.netgear.markdown
View File

@ -21,8 +21,6 @@ To use this device tracker in your installation, add the following to your `conf
# Example configuration.yaml entry
device_tracker:
- platform: netgear
host: YOUR_ROUTER_IP
username: YOUR_ADMIN_USERNAME
password: YOUR_ADMIN_PASSWORD
```

9
source/_components/dialogflow.markdown
View File

@ -14,10 +14,6 @@ ha_release: 0.56
redirect_from: /components/apiai/
---
<p class='note'>
Before 0.56 this component was named `apiai`.
</p>
The `dialogflow` component 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.
To be able to receive messages from DialogFlow, your Home Assistant instance needs to be accessible from the web ([Hass.io instructions](/addons/duckdns/)) and you need to have the `base_url` configured for the HTTP component ([docs](https://www.home-assistant.io/components/http/#base_url)). Dialogflow will return fallback answers if your server does not answer or takes too long (more than 5 seconds).
@ -40,10 +36,10 @@ Using Dialogflow will be easy to create conversations like:
To use this integration, you should define a conversation (intent) in Dialogflow, configure Home Assistant with the speech to return and, optionally, the action to execute.
To get the webhook url, go to the integrations page in the configuration screen and find Dialogflow. Click on configure. Follow the instructions on the screen.
### {% linkable_title Configuring your Dialogflow account %}
To get the webhook URL, go to the integrations page in the configuration screen and find "Dialogflow". Click on "configure". Follow the instructions on the screen.
- [Login](https://console.dialogflow.com/) with your Google account
- Click on "Create Agent"
- Select name, language (if you are planning to use Google Actions check their [supported languages](https://support.google.com/assistant/answer/7108196?hl=en)) and time zone
@ -62,7 +58,6 @@ To get the webhook url, go to the integrations page in the configuration screen
Take a look to "Integrations", in the left menu, to configure third parties.
### {% 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.

2
source/_components/google_assistant.markdown
View File

@ -19,6 +19,8 @@ The `google_assistant` component allows you to control things via Google Assista
With [Home Assistant Cloud](/cloud/), you can connect your Home Assistant instance in a few simple clicks to Google Assistant. With Home Assistant Cloud you don't have to deal with dynamic DNS, SSL certificates or opening ports on your router. Just log in via the user interface and a secure connection with the cloud will be established. Home Assistant Cloud requires a paid subscription after a 30-day free trial.
For Home Assistant Cloud Users, documentation can be found [here](https://www.nabucasa.com/config/google_assistant/).
## {% linkable_title Manual setup %}
The Google Assistant component requires a bit more setup than most due to the way Google requires Assistant Apps to be set up.

1
source/_components/light.yeelight.markdown
View File

@ -91,6 +91,7 @@ This component is tested to work with the following models. If you have a differ
| `color2` | YLDP06YL | LED Bulb (Color) - 2nd generation |
| `strip1` | YLDD01YL | Lightstrip (Color) |
| `strip1` | YLDD02YL | Lightstrip (Color) |
| ? | YLDD04YL | Lightstrip (Color)
| `bslamp1` | MJCTD01YL | Xiaomi Mijia Bedside Lamp - WIFI Version! |
| `lamp1` | MJTD01YL | Xiaomi Mijia Smart LED Desk Lamp (autodiscovery isn't possible because the device doesn't support mDNS due to the small amount of RAM) |
| `ceiling1` | YLXD01YL | Yeelight Ceiling Light |

2
source/_components/media_player.russound_rnet.markdown
View File

@ -15,7 +15,7 @@ ha_iot_class: "Local Polling"
The `russound_rnet` platform allows you to control Russound devices that make use of the RNET protocol.
This has initially been tested against a Russound CAV6.6 unit with six zones and six sources.
This has initially been tested against a Russound CAV6.6 unit with six zones and six sources. It will also work with a Russound CAA66, but be sure to use a null-modem cable.
Connecting to the Russound device is only possible by TCP, you can make use of a TCP to Serial gateway such as [tcp_serial_redirect](https://github.com/pyserial/pyserial/blob/master/examples/tcp_serial_redirect.py)

4
source/_components/media_player.samsungtv.markdown
View File

@ -20,8 +20,7 @@ The `samsungtv` platform allows you to control a
When the TV is first connected,
you will need to accept Home Assistant on the TV to allow communication.
To add a TV to your installation,
add the following to your `configuration.yaml` file:
To add a TV to your installation without relying on the [discovery component](/components/discovery/), add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
@ -93,6 +92,7 @@ Currently known supported models:
- U6000 (port must be set to 8001)
- U6300 (port must be set to 8001, and `pip3 install websocket-client` must be executed)
- UE40KU6400U (port must be set to 8001, and `pip3 install websocket-client` must be executed)
- UE40ES6800
- UE46D7000
- UE6199UXZG (port must be set to 8001, On/Off, Forward/Backward, Volume control, but no Play button)
- UE65KS8005 (port must be set to 8001, On/Off, Forward/Backward, Volume are OK, but no Play button)

3
source/_components/media_player.spotify.markdown
View File

@ -72,9 +72,10 @@ client_secret:
required: true
type: string
cache_path:
description: Path to cache authentication token (defaults to configuration directory).
description: Path to cache authentication token.
required: false
type: string
default: .spotify-token-cache
aliases:
description: "Dictionary of device ids to be aliased, handy for devices that Spotify cannot properly determine the device name of. New devices will be logged to the `info` channel for ease of aliasing."
required: false

31
source/_components/notify.aws_sqs.markdown
View File

@ -32,13 +32,30 @@ notify:
region_name: 'us-east-1'
```
Configuration variables:
- **aws_access_key_id** (*Required if aws_secret_access_key is provided*): Your AWS Access Key ID. If provided, you must also provide an `aws_secret_access_key` and must **not** provide a `profile_name`.
- **aws_secret_access_key** (*Required if aws_access_key_id is provided*): Your AWS Secret Access Key. If provided, you must also provide an `aws_access_key_id` and must **not** provide a `profile_name`.
- **profile_name** (*Optional*): A credentials profile name.
- **region_name** (*Required*): The region identifier to connect to. The default is `us-east-1`.
- **name** (*Optional*): Setting the optional parameter `name` allows multiple notifiers to be created. The default value is `notify`. The notifier will bind to the service `notify.NOTIFIER_NAME`.
{% configuration %}
aws_access_key_id:
description: Your AWS Access Key ID. If provided, you must also provide an `aws_secret_access_key` and must **not** provide a `profile_name`.
required: Required if aws_secret_access_key is provided
type: string
aws_secret_access_key:
description: Your AWS Secret Access Key. If provided, you must also provide an `aws_access_key_id` and must **not** provide a `profile_name`.
required: Required if aws_access_key_id is provided
type: string
profile_name:
description: A credentials profile name.
required: false
type: string
region_name:
description: The region identifier to connect to.
required: true
default: us-east-1
type: string
name:
description: Setting the optional parameter `name` allows multiple notifiers to be created. The notifier will bind to the service `notify.NOTIFIER_NAME`.
required: false
default: notify
type: string
{% endconfiguration %}
### {% linkable_title Usage %}

23
source/_components/notify.pushover.markdown
View File

@ -12,7 +12,6 @@ ha_category: Notifications
ha_release: pre 0.7
---
The [Pushover service](https://pushover.net/) is a platform for the notify component. This allows components to send messages to the user using Pushover.
## {% linkable_title Configuration %}
@ -30,11 +29,21 @@ notify:
user_key: YOUR_USER_KEY
```
Configuration variables:
- **name** (*Optional*): Setting the optional parameter `name` allows multiple notifiers to be created. The default value is `notify`. The notifier will bind to the service `notify.NOTIFIER_NAME`.
- **api_key** (*Required*): Your API key.
- **user_key** (*Required*): Your user key for Pushover.
{% configuration %}
name:
description: Setting the optional parameter `name` allows multiple notifiers to be created. The notifier will bind to the service `notify.NOTIFIER_NAME`.
required: false
default: notify
type: string
api_key:
description: Your API key.
required: true
type: string
user_key:
description: Your user key for Pushover.
required: true
type: string
{% endconfiguration %}
Example Automation:
@ -58,6 +67,7 @@ When sending a notification, optional parameters can also be set as per the push
Example notification triggered from the Alexa component for an intents is shown below which also uses [Automation Templating](/getting-started/automation-templating/) for the message:
{% raw %}
```yaml
# Example configuration.yaml entries
alexa:
@ -74,4 +84,5 @@ alexa:
device: pixel
url: "https://www.home-assistant.io/"
```
{% endraw %}

14
source/_components/sensor.onewire.markdown
View File

@ -66,8 +66,6 @@ To enable One wire sensors in your installation, add the following to your `conf
# Example configuration.yaml entry
sensor:
- platform: onewire
names:
some_id: your name
```
{% configuration %}
@ -81,3 +79,15 @@ mount_dir:
type: string
{% endconfiguration %}
### Configuration Example
When `onewire` is added to Home Assistant, it will generate an ID for the sensor. You can specify a friendly name for the sensor with the name configuration option.
```yaml
# Named sensor configuration.yaml entry
sensor:
- platform: onewire
names:
GENERATED_ID: FRIENDLY_NAME
```

129
source/_components/sensor.qnap.markdown
View File

@ -13,7 +13,6 @@ ha_release: 0.38
ha_iot_class: "Local Polling"
---
This `qnap` sensor allows getting various statistics from your [QNAP NAS](https://www.qnap.com/en-us/).
## {% linkable_title Configuration %}
@ -35,48 +34,104 @@ sensor:
- volume_percentage_used
```
Configuration variables:
{% configuration %}
host:
description: The IP address of the QNAP NAS to monitor.
required: true
type: string
port:
description: The port number on which the QNAP NAS web interface is reachable.
required: false
default: 8080
type: integer
ssl:
description: Whether to connect via `https`.
required: false
default: false
type: boolean
verify_ssl:
description: Whether SSL certificates should be validated.
required: false
default: true
type: boolean
timeout:
description: How long (in seconds) to wait for a response from the QNAP device before giving up.
required: false
default: 10
type: integer
username:
description: An user to connect to the QNAP NAS.
required: true
type: string
password:
description: The password of the user to connect to the QNAP NAS.
required: true
type: string
drivers:
description: "Array of drives to monitor (ex: `0:1`)."
required: false
default: all drivers
type: list
volumes:
description: "Array of volumes to monitor (ex: `DataVol1`)."
required: false
default: all volumes
type: list
nics:
description: "Array of network interfaces to monitor (ex: `eth0`)."
required: false
default: all NICs
type: list
monitored_conditions:
description: Defines the stats to monitor as sensors.
required: true
type: list
keys:
status:
description: Displays overall system health.
system_temp:
description: Displays the overall system temperature.
cpu_temp:
description: Displays the CPU's temperature.
cpu_usage:
description: Displays the CPU's utilization as a percentage.
memory_free:
description: Displays the size of available RAM in GB.
memory_used:
description: Displays the size of used RAM in GB.
memory_percent_used:
description: Displays the size of used RAM as a percentage of total RAM.
network_link_status:
description: Displays whether the network interfaces is up (creates a new entry for each interface).
network_tx:
description: Displays the upload speed of a network interface in MB/s (creates a new entry for each interface).
network_rx:
description: Displays the download speed of a network interface in MB/s (creates a new entry for each interface).
drive_smart_status:
description: Displays the S.M.A.R.T. status of the drive (creates a new entry for each drive).
drive_temp:
description: Displays the temperature of the drive (creates a new entry for each drive).
volume_size_free:
description: Displays the available space of the volume in GB (creates a new entry for each volume).
volume_size_used:
description: Displays the used space of the volume in GB (creates a new entry for each volume).
volume_percentage_used:
description: Displays the used space of the volume as a percentage (creates a new entry for each volume).
{% endconfiguration %}
- **host** (*Required*): The IP address of the QNAP NAS to monitor
- **port** (*Optional*): The port number on which the QNAP NAS web interface is reachable. Defaults to `8080`.
- **ssl** (*Optional*): Whether to connect via `https`. Defaults to `false`.
- **verify_ssl** (*Optional*): Whether SSL certificates should be validated. Defaults to `true`.
- **timeout** (*Optional*): How long (in seconds) to wait for a response from the QNAP device before giving up. Defaults to `10`.
- **username** (*Required*): An user to connect to the QNAP NAS.
- **password** (*Required*): The password of the user to connect to the QNAP NAS.
- **drives** (*Optional*): Array of drives to monitor (ex: `0:1`). Defaults to all drives.
- **volumes** (*Optional*): Array of volumes to monitor (ex: `DataVol1`). Defaults to all volumes.
- **nics** (*Optional*): Array of network interfaces to monitor (ex: `eth0`). Defaults to all NICs.
- **monitored_conditions** (*Required*): Defines the stats to monitor as sensors.
- **status**: Displays overall system health.
- **system_temp**: Displays the overall system temperature.
- **cpu_temp**: Displays the CPU's temperature.
- **cpu_usage**: Displays the CPU's utilization as a percentage.
- **memory_free**: Displays the size of available RAM in GB.
- **memory_used**: Displays the size of used RAM in GB.
- **memory_percent_used**: Displays the size of used RAM as a percentage of total RAM.
- **network_link_status**: Displays whether the network interfaces is up (creates a new entry for each interface).
- **network_tx**: Displays the upload speed of a network interface in MB/s (creates a new entry for each interface).
- **network_rx**: Displays the download speed of a network interface in MB/s (creates a new entry for each interface).
- **drive_smart_status**: Displays the S.M.A.R.T. status of the drive (creates a new entry for each drive).
- **drive_temp**: Displays the temperature of the drive (creates a new entry for each drive).
- **volume_size_free**: Displays the available space of the volume in GB (creates a new entry for each volume).
- **volume_size_used**: Displays the used space of the volume in GB (creates a new entry for each volume).
- **volume_percentage_used**: Displays the used space of the volume as a percentage (creates a new entry for each volume).
### Self-signed certificates
### {% linkable_title Self-signed certificates %}
If your QNAP device uses self-signed certificates, set the `verify_ssl` option to `false`.
### QNAP device support:
### {% linkable_title QNAP device support: %}
This component has been tested on the following devices:
- TS-259 Pro+ (QTS 4.2.6)
- TS-410 (QTS 4.2.3)
- TS-419 (QTS 4.2.3)
- TS-451 (QTS 4.2.2)
- TS-470 (QTS 4.2.2)
- TS-639 (QTS 4.2.3)
- TS-259 Pro+ (QTS 4.2.6)
- TS-410 (QTS 4.2.3)
- TS-419 (QTS 4.2.3)
- TS-451 (QTS 4.2.2)
- TS-470 (QTS 4.2.2)
- TS-639 (QTS 4.2.3)
Other QNAP NAS devices using similar firmware should work fine. For more information about supported devices, or to report issues with your device, please visit the [qnapstats project](https://github.com/colinodell/python-qnapstats#device-support).

2
source/_components/tuya.markdown
View File

@ -40,7 +40,7 @@ country_code:
required: true
type: string
platform:
description: "The app where your account register. `tuya` for Tuya Smart and `smart_life` for Smart Life."
description: "The app where your account register. `tuya` for Tuya Smart, `smart_life` for Smart Life, `jinvoo_smart` for Jinvoo Smart."
required: false
type: string
default: tuya

4
source/_components/xiaomi_aqara.markdown
View File

@ -273,5 +273,7 @@ That means that Home Assistant is not getting any response from your Xiaomi gate
- Try to disable and then enable LAN access.
- Hard reset the gateway: Press the button of the gateway 30 seconds and start again from scratch.
- If you are using Home Assistant in [Docker](/docs/installation/docker/), make sure to use `--net=host`.
- If you receive an `{"error":"Invalid key"}` in your log while trying to control the gateway light, you should generate the key again using an Android Phone or alternatively an emulator such as [bluestacks](https://www.bluestacks.com). In some instances there is an issue with keys being generated using the iOS application.
- If you receive an `{"error":"Invalid key"}` in your log while trying to control the gateway light
- You should generate the key again using an Android Phone or alternatively an emulator such as [bluestacks](https://www.bluestacks.com). In some instances there is an issue with keys being generated using the iOS application.
- You need to make sure to have multicast support on your network. If you are running Home Assistant in a virtual machine (like Proxmox), try `echo 0 >/sys/class/net/vmbr0/bridge/multicast_snooping` on the host and restart the service or reboot the host.
- If the required library "PyXiaomiGateway" cannot be installed you will need to install some missing system dependencies `python3-dev`, `libssl-dev`, `libffi-dev` manually (e.g., `$ sudo apt-get install python3-dev libssl-dev libffi-dev`).

1
source/_docs/configuration.markdown
View File

@ -21,6 +21,7 @@ The location of the folder differs between operating systems:
| Linux | `~/.homeassistant` |
| Windows | `%APPDATA%/.homeassistant` |
| Hass.io | `/config` |
| Docker | `/config` |
If you want to use a different folder for configuration, use the config command line parameter: `hass --config path/to/config`.

16
source/hassio/installation.markdown
View File

@ -92,14 +92,14 @@ A detailed guide about running Hass.io as a virtual machine is available in the
[etcher]: https://etcher.io/
[Virtual Appliance]: https://github.com/home-assistant/hassos/blob/dev/Documentation/boards/ova.md
[hassos-network]: https://github.com/home-assistant/hassos/blob/dev/Documentation/network.md
[pi0-w]: https://github.com/home-assistant/hassos/releases/download/1.12/hassos_rpi0-w-1.12.img.gz
[pi1]: https://github.com/home-assistant/hassos/releases/download/1.12/hassos_rpi-1.12.img.gz
[pi2]: https://github.com/home-assistant/hassos/releases/download/1.12/hassos_rpi2-1.12.img.gz
[pi3-32]: https://github.com/home-assistant/hassos/releases/download/1.12/hassos_rpi3-1.12.img.gz
[pi3-64]: https://github.com/home-assistant/hassos/releases/download/1.12/hassos_rpi3-64-1.12.img.gz
[tinker]: https://github.com/home-assistant/hassos/releases/download/2.2/hassos_tinker-2.2.img.gz
[odroid-c2]: https://github.com/home-assistant/hassos/releases/download/2.2/hassos_odroid-c2-2.2.img.gz
[vmdk]: https://github.com/home-assistant/hassos/releases/download/1.12/hassos_ova-1.12.vmdk
[pi0-w]: https://github.com/home-assistant/hassos/releases/download/1.13/hassos_rpi0-w-1.13.img.gz
[pi1]: https://github.com/home-assistant/hassos/releases/download/1.13/hassos_rpi-1.13.img.gz
[pi2]: https://github.com/home-assistant/hassos/releases/download/1.13/hassos_rpi2-1.13.img.gz
[pi3-32]: https://github.com/home-assistant/hassos/releases/download/1.13/hassos_rpi3-1.13.img.gz
[pi3-64]: https://github.com/home-assistant/hassos/releases/download/1.13/hassos_rpi3-64-1.13.img.gz
[tinker]: https://github.com/home-assistant/hassos/releases/download/2.3/hassos_tinker-2.3.img.gz
[odroid-c2]: https://github.com/home-assistant/hassos/releases/download/2.3/hassos_odroid-c2-2.3.img.gz
[vmdk]: https://github.com/home-assistant/hassos/releases/download/1.13/hassos_ova-1.13.vmdk.gz
[linux]: https://github.com/home-assistant/hassio-build/tree/master/install#install-hassio
[local]: http://hassio.local:8123
[samba]: /addons/samba/