mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-22 16:56:50 +00:00
Merge remote-tracking branch 'origin/current' into next
This commit is contained in:
Paulus Schoutsen
commit
34fa44fa9b
@ -55,7 +55,7 @@ Use the following configuration in Home Assistant to use the generated certifica
|
||||
|
||||
```yaml
|
||||
http:
|
||||
base_url: https://my-domain.duckdns.org:8123
|
||||
base_url: my-domain.duckdns.org:8123
|
||||
ssl_certificate: /ssl/fullchain.pem
|
||||
ssl_key: /ssl/privkey.pem
|
||||
```
|
||||
|
||||
@ -13,9 +13,13 @@ featured: true
|
||||
ha_release: '0.10'
|
||||
---
|
||||
|
||||
<p class='note'>
|
||||
Use [Home Assistant Cloud](/components/cloud/) to integrate with Alexa without any effort.
|
||||
</p>
|
||||
## {% linkable_title Automatic setup via Home Assistant Cloud %}
|
||||
|
||||
With [Home Assistant Cloud](/cloud/), you can connect your Home Assistant instance in a few simple clicks to Amazon Alexa. 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/amazon_alexa/).
|
||||
|
||||
## {% linkable_title Manual setup %}
|
||||
|
||||
There are a few ways that you can use Amazon Echo and Home Assistant together.
|
||||
|
||||
|
||||
@ -19,4 +19,4 @@ The `nest` platform allows you to watch still frames from a video stream (not li
|
||||
You must have the [Nest component](/components/nest/) configured to use this camera. The `nest` camera will automatically be setup when you do.
|
||||
</p>
|
||||
|
||||
Nest Camera supports `camera.turn_on` and `camera.turn_off` service since 0.75 release.
|
||||
Nest Camera supports the `camera.turn_on` and `camera.turn_off` services since the 0.75 release.
|
||||
|
||||
@ -13,7 +13,7 @@ ha_iot_class: "Cloud Push"
|
||||
---
|
||||
|
||||
|
||||
The `nest` climate platform let you control a thermostat from [Nest](https://nest.com).
|
||||
The `nest` climate platform lets you control a thermostat from [Nest](https://nest.com).
|
||||
|
||||
<p class='note'>
|
||||
You must have the [Nest component](/components/nest/) configured to use these sensors. The `nest` climate component will automatically be setup when you do.
|
||||
|
||||
@ -12,7 +12,7 @@ ha_release: 0.64
|
||||
logo: apple-homekit.png
|
||||
---
|
||||
|
||||
The `HomeKit` component allows you to forward entities from Home Assistant to Apple `HomeKit`, so they can be controlled from Apple's `Home` app and `Siri`. Please make sure that you have read the [considerations](#considerations) listed below to save you some trouble later. However if you do encounter issues, check out the [troubleshooting](#troubleshooting) section.
|
||||
The `homekit` component allows you to forward entities from Home Assistant to Apple HomeKit, so they can be controlled from Apple's Home app and Siri. Please make sure that you have read the [considerations](#considerations) listed below to save you some trouble later. However if you do encounter issues, check out the [troubleshooting](#troubleshooting) section.
|
||||
|
||||
<p class="note">
|
||||
If you want to control `HomeKit` only devices with Home Assistant, check out the [HomeKit controller](/components/homekit_controller/) component.
|
||||
@ -137,14 +137,15 @@ homekit:
|
||||
|
||||
## {% linkable_title Setup %}
|
||||
|
||||
To enable the `HomeKit` component in Home Assistant, add the following to your configuration file:
|
||||
To enable the HomeKit component in Home Assistant, add the following to your configuration file:
|
||||
|
||||
```yaml
|
||||
# Example for HomeKit setup
|
||||
homekit:
|
||||
```
|
||||
|
||||
After Home Assistant has started, the entities specified by the filter are exposed to `HomeKit` if they are [supported](#supported-components). To add them:
|
||||
After Home Assistant has started, the entities specified by the filter are exposed to HomeKit if they are [supported](#supported-components). To add them:
|
||||
|
||||
1. Open the Home Assistant frontend. A new card will display the `pin code`.
|
||||
1. Open the `Home` app.
|
||||
2. Click `Add Accessory`, then select `Don't Have a Code or Can't Scan?` and choose the `Home Assistant Bridge`.
|
||||
@ -153,7 +154,7 @@ After Home Assistant has started, the entities specified by the filter are expos
|
||||
6. Follow the setup by clicking on `Next` and lastly `Done` in the top right-hand corner.
|
||||
7. The `Home Assistant` Bridge and the Accessories should now be listed in the `Home` app.
|
||||
|
||||
After the setup is completed, you should be able to control your Home Assistant components through `Home` and `Siri`.
|
||||
After the setup is completed, you should be able to control your Home Assistant components through Apple's Home and Siri.
|
||||
|
||||
## {% linkable_title Move Home Assistant install %}
|
||||
|
||||
@ -310,13 +311,15 @@ The following components are currently supported:
|
||||
### {% linkable_title Deleting the `.homekit.state` file %}
|
||||
|
||||
The `.homekit.state` file can be found in the configurations directory. You might need to enable `view hidden files` to see it.
|
||||
|
||||
1. **Stop** Home Assistant
|
||||
2. Delete the `.homekit.state` file
|
||||
3. **Start** Home Assistant
|
||||
|
||||
### {% linkable_title Errors during pairing %}
|
||||
|
||||
If you encounter any issues during pairing, make sure to
|
||||
If you encounter any issues during pairing, make sure to:
|
||||
|
||||
1. **Stop** Home Assistant
|
||||
2. Delete the `.homekit.state` file
|
||||
3. Edit your configuration (see below)
|
||||
|
||||
@ -112,6 +112,13 @@ timeout:
|
||||
| ------- | ----------- |
|
||||
| write_register | Write register. Requires `unit`, `address` and `value` fields. `value` can be either single value or an array |
|
||||
|
||||
#### {% linkable_title Service Data Attributes %}
|
||||
|
||||
| Attribute | Description |
|
||||
| --------- | ----------- |
|
||||
| unit | Slave address (set to 255 you talk to Modbus via TCP) |
|
||||
| address | Address of the Register (e.g., 138) |
|
||||
| value | An array of 16-bit values. Might need reverse ordering. E.g., to set 0x0004 you might need to set `[4,0]` |
|
||||
|
||||
## {% linkable_title Building on top of Modbus %}
|
||||
|
||||
|
||||
@ -58,3 +58,7 @@ The following statistics will be exposed as attributes.
|
||||
|max_byte_rate_down |Maximum downstream-rate in bytes/s |
|
||||
|
||||
The sensor's state corresponds to the `is_linked` attribute and is either `online`, `offline`, or `unavailable` (in case connection to the router is lost).
|
||||
|
||||
<p class='note info'>
|
||||
This component does not support "Fritz!Box 6490 Cable" with FritzOS 6.87 installed.
|
||||
</p>
|
||||
|
||||
@ -14,7 +14,7 @@ ha_release: 0.28
|
||||
---
|
||||
|
||||
|
||||
The `pi_hole` sensor platform is displaying the statistical summary of a [Pi-hole](https://pi-hole.net/) system.
|
||||
The `pi_hole` sensor platform displays the statistical summary of a [Pi-hole](https://pi-hole.net/) system.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
@ -73,4 +73,4 @@ monitored_conditions:
|
||||
description: Total number of seen clients.
|
||||
{% endconfiguration %}
|
||||
|
||||
This sensor platform was not made by Pi-hole LLC or the Pi-hole community. They didn't provide support, feedback, testing or helped in any way while it was created. This is third party, may not work if Pi-hole is breaking their API with the latest release, not official, not developed, not supported and not endorsed Pi-hole LLC or the Pi-hole community. The trademark `Pi-hole` and the logo is used here to describe the platform and only to describe. `Pi-hole` is a registered trademark of Pi-hole LLC.
|
||||
This sensor platform was not made by Pi-hole LLC or the Pi-hole community. They did not provide support, feedback, testing, or any other help during its creation. This is a third party platform which may break if Pi-hole changes their API in a later release. It is not official, not developed, not supported, and not endorsed Pi-hole LLC or the Pi-hole community. The trademark `Pi-hole` and the logo is used here to describe the platform. `Pi-hole` is a registered trademark of Pi-hole LLC.
|
||||
|
||||
@ -21,8 +21,8 @@ If the preceding command returns the string `systemd`, continue with the instruc
|
||||
A service file is needed to control Home Assistant with `systemd`. The template below should be created using a text editor. Note, root permissions via `sudo` will likely be needed. The following should be noted to modify the template:
|
||||
|
||||
- `ExecStart` contains the path to `hass` and this may vary. Check with `whereis hass` for the location.
|
||||
- For most systems, the file is `/etc/systemd/system/home-assistant@[your user].service` with [your user] replaced by the user account that Home Assistant will run as (normally `homeassistant`). In particular, this is the case for Ubuntu 16.04.
|
||||
- If unfamiliar with command-line text editors, `sudo nano -w [filename]` can be used with `[filename]` replaced with the full path to the file. Ex. `sudo nano -w /etc/systemd/system/home-assistant@[your user].service`. After text entered, press CTRL-X then press Y to save and exit.
|
||||
- For most systems, the file is `/etc/systemd/system/home-assistant@YOUR_USER.service` with YOUR_USER replaced by the user account that Home Assistant will run as (normally `homeassistant`). In particular, this is the case for Ubuntu 16.04.
|
||||
- If unfamiliar with command-line text editors, `sudo nano -w [filename]` can be used with `[filename]` replaced with the full path to the file. Ex. `sudo nano -w /etc/systemd/system/home-assistant@YOUR_USER.service`. After text entered, press CTRL-X then press Y to save and exit.
|
||||
- If you're running Home Assistant in a Python virtual environment or a Docker container, please skip to the appropriate template listed below.
|
||||
|
||||
```
|
||||
@ -41,7 +41,7 @@ WantedBy=multi-user.target
|
||||
|
||||
### {% linkable_title Python virtual environment %}
|
||||
|
||||
If you've setup Home Assistant in `virtualenv` following our [Python installation guide](/getting-started/installation-virtualenv/) or [manual installation guide for Raspberry Pi](/getting-started/installation-raspberry-pi/), the following template should work for you. If Home Assistant install is not located at `/srv/homeassistant`, please modify the `ExecStart=` line appropriately.
|
||||
If you've setup Home Assistant in `virtualenv` following our [Python installation guide](/getting-started/installation-virtualenv/) or [manual installation guide for Raspberry Pi](/getting-started/installation-raspberry-pi/), the following template should work for you. If Home Assistant install is not located at `/srv/homeassistant`, please modify the `ExecStart=` line appropriately. `YOUR_USER` should be replaced by the user account that Home Assistant will run as (e.g `homeassistant`).
|
||||
|
||||
```
|
||||
[Unit]
|
||||
@ -51,7 +51,7 @@ After=network-online.target
|
||||
[Service]
|
||||
Type=simple
|
||||
User=%i
|
||||
ExecStart=/srv/homeassistant/bin/hass -c "/home/homeassistant/.homeassistant"
|
||||
ExecStart=/srv/homeassistant/bin/hass -c "/home/YOUR_USER/.homeassistant"
|
||||
|
||||
[Install]
|
||||
WantedBy=multi-user.target
|
||||
|
||||
@ -10,9 +10,9 @@ footer: true
|
||||
redirect_from: /details/database/
|
||||
---
|
||||
|
||||
The default database used by Home Assistant is [SQLite](https://www.sqlite.org/) and is stored in your [configuration directory](/getting-started/configuration/) (e.g., `<path to config dir>/.homeassistant/home-assistant_v2.db`). To change the database, use the [`recorder` component](/components/recorder/).
|
||||
The default database used by Home Assistant is [SQLite](https://www.sqlite.org/), and the database file is stored in your [configuration directory](/getting-started/configuration/) (e.g., `<path to config dir>/.homeassistant/home-assistant_v2.db`). If you prefer to run a database server (e.g. PostgreSQL), use the [`recorder` component](/components/recorder/).
|
||||
|
||||
To work with the SQLite database manually, you will need an installation of `sqlite3`, the command-line for SQLite database, or [DB Browser for SQLite](http://sqlitebrowser.org/), which provides an editor for executing SQL commands.
|
||||
To work with the SQLite database manually from the command-line, you will need an [installation](http://www.sqlitetutorial.net/download-install-sqlite/) of `sqlite3`. Alternatively [DB Browser for SQLite](http://sqlitebrowser.org/) provides a viewer for exploring the database data and an editor for executing SQL commands.
|
||||
First load your database with `sqlite3`:
|
||||
|
||||
```bash
|
||||
@ -124,4 +124,4 @@ The `VACUUM` command cleans your database.
|
||||
sqlite> VACUUM;
|
||||
```
|
||||
|
||||
For a more interactive way to work with the database or the create statistics, checkout our [Jupyter notebooks](http://nbviewer.jupyter.org/github/home-assistant/home-assistant-notebooks/tree/master/).
|
||||
For a more interactive way of working with the database, checkout our [Jupyter notebooks](http://nbviewer.jupyter.org/github/home-assistant/home-assistant-notebooks/tree/master/).
|
||||
|
||||
@ -16,7 +16,7 @@ Remember to follow the [securing checklist](/docs/configuration/securing/) befor
|
||||
</p>
|
||||
|
||||
<p class='note'>
|
||||
Home Assistant no longer support remote access via IP address since release 0.77, you have to use domain name.
|
||||
Home Assistant no longer support remote access via IP address since release 0.77, you have to use a domain name.
|
||||
</p>
|
||||
|
||||
The most common approach is to set up port forwarding (for any port) from your router to port 8123 on the computer that is hosting Home Assistant. General instructions on how to do this can be found by searching `<router model> port forwarding instructions`. You can use any free port on your router and forward that to port 8123.
|
||||
@ -25,7 +25,9 @@ A problem with making a port accessible is that some Internet Service Providers
|
||||
|
||||
If you cannot access your Home Assistant installation remotely, remember to check if your ISP provides you with a dedicated IP, instead of one shared with other users via a [CG-NAT](https://en.wikipedia.org/wiki/Carrier-grade_NAT). This is becoming fairly common nowadays due to the shortage of IPv4 addresses. Some, if not most ISPs will require you to pay an extra fee to be assigned a dedicated IPv4 address.
|
||||
|
||||
Remember: Just putting a port up is not secure. You should definitely consider encrypting your traffic if you are accessing your Home Assistant installation remotely. For details please check the [set up encryption using Let's Encrypt](/blog/2017/09/27/effortless-encryption-with-lets-encrypt-and-duckdns/) blog post or this [detailed guide](/docs/ecosystem/certificates/lets_encrypt/) to using Let's Encrypt with Home Assistant.
|
||||
<p class='note'>
|
||||
Just putting a port up is not secure. You should definitely consider encrypting your traffic if you are accessing your Home Assistant installation remotely. For details please check the [set up encryption using Let's Encrypt](/blog/2017/09/27/effortless-encryption-with-lets-encrypt-and-duckdns/) blog post or this [detailed guide](/docs/ecosystem/certificates/lets_encrypt/) to using Let's Encrypt with Home Assistant.
|
||||
</p>
|
||||
|
||||
Protect your communication with a [self-signed certificate](/docs/ecosystem/certificates/tls_self_signed_certificate/) between your client and the Home Assistant instance.
|
||||
|
||||
|
||||
@ -10,12 +10,10 @@ footer: true
|
||||
redirect_from: /ecosystem/notebooks/
|
||||
---
|
||||
|
||||
The [Jupyter Notebooks](http://jupyter.org/) allows you to create and share documents that contain live code, equations, visualizations, and explanatory text directly in your browser. The web application what is formerly known as the IPython Notebook supports over 40 programming languages.
|
||||
|
||||
Visit [https://try.jupyter.org/](https://try.jupyter.org/) to get a preview before you install it locally.
|
||||
[Jupyter Notebooks](http://jupyter.org/) allow you to create and share documents that contain live code, equations, visualizations, and explanatory text directly in your browser. Over 40 programming languages are supported including Python, R and Julia. Visit [https://try.jupyter.org/](https://try.jupyter.org/) to try out Jupyter notebooks without installing anything.
|
||||
|
||||
<p class='img'>
|
||||
<img src='{{site_root}}/images/screenshots/jupyter-new.png' />
|
||||
</p>
|
||||
|
||||
[nbviewer](http://nbviewer.jupyter.org/github/home-assistant/home-assistant-notebooks/tree/master/) is rendering our notebooks online. GitHub is creating a preview as well.
|
||||
[nbviewer](http://nbviewer.jupyter.org/github/home-assistant/home-assistant-notebooks/tree/master/) is used to render the Home Assistant notebooks online. GitHub will also display a preview of Jupyter notebooks.
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Home Assistant Python API"
|
||||
description: "Basic example how to work with the Home Assistant Python API in a Jupyter notebook."
|
||||
description: "Basic example of interacting with Home Assistant live from a Jupyter notebook using the Python API."
|
||||
date: 2016-07-23 09:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
@ -10,4 +10,4 @@ footer: true
|
||||
redirect_from: /ecosystem/notebooks/api/
|
||||
---
|
||||
|
||||
The [Python API](/developers/python_api/) allows one to create [interactive notebooks](http://nbviewer.jupyter.org/github/home-assistant/home-assistant-notebooks/blob/master/home-assistant-python-api.ipynb).
|
||||
You can interact with Home Assistant live from Jupyter notebooks buy using the Home Assistant [Python API](/developers/python_api/). [See this example notebook](http://nbviewer.jupyter.org/github/home-assistant/home-assistant-notebooks/blob/master/home-assistant-python-api.ipynb).
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Database"
|
||||
description: "Basic example how to work with stored Home Assistant information in a Jupyter notebook."
|
||||
description: "Accessing the Home-Assistant database from a Jupyter notebook."
|
||||
date: 2016-07-23 09:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
@ -10,4 +10,4 @@ footer: true
|
||||
redirect_from: /ecosystem/notebooks/database/
|
||||
---
|
||||
|
||||
The [Database example](http://nbviewer.jupyter.org/github/home-assistant/home-assistant-notebooks/blob/master/database-examples.ipynb) shows you the details about how you can work with stored values.
|
||||
You can directly access the Home-Assistant database from Jupyter notebooks. The [Database example](http://nbviewer.jupyter.org/github/home-assistant/home-assistant-notebooks/blob/master/database-examples.ipynb) shows you how you can work with stored database values.
|
||||
|
||||
@ -20,7 +20,7 @@ $ pip3 install jupyter matplotlib
|
||||
Certain notebooks hosted in the [Home Assistant notebooks repository](https://github.com/home-assistant/home-assistant-notebooks) require access to a running Home Assistant instance or parts of a Home Assistant installation. If you want to run those notebooks, install Home Assistant with `$ pip3 install homeassistant` as well.
|
||||
</p>
|
||||
|
||||
Now you are able to start the application.
|
||||
Run Jupyter from the command line.
|
||||
|
||||
```bash
|
||||
$ jupyter notebook
|
||||
@ -37,7 +37,7 @@ Open [http://localhost:8888/](http://localhost:8888/) in your browser. Press "Ne
|
||||
<img src='{{site_root}}/images/screenshots/jupyter-new.png' />
|
||||
</p>
|
||||
|
||||
You will get an empty notebook with one cell. Cells can contain code or text. To get the output of a cell you need to execute them with "Cell" -> "Run Cells" from the menu or by pressing the icon.
|
||||
You will get an empty notebook with one cell. Cells can contain code or text. To get the output of a cell you need to execute them with "Cell" -> "Run Cells" from the menu or by pressing the Play icon.
|
||||
|
||||
<p class='img'>
|
||||
<img src='{{site_root}}/images/screenshots/jupyter-notebook.png' />
|
||||
@ -46,6 +46,6 @@ You will get an empty notebook with one cell. Cells can contain code or text. To
|
||||
The downloadable version of this notebook is available in the [Home Assistant notebooks repository](https://github.com/home-assistant/home-assistant-notebooks/blob/master/first-notebook.ipynb).
|
||||
|
||||
|
||||
As you can see is the workflow very similar to working directly with a Python shell. One advantage is that you can go back and forth as you please and save your work.
|
||||
As you can see is the Jupyter notebook workflow is very similar to working directly with a Python shell. One advantage of notebooks is that you can go back and forth between cells as you please and save your work.
|
||||
|
||||
|
||||
|
||||
@ -10,4 +10,4 @@ footer: true
|
||||
redirect_from: /ecosystem/notebooks/stats/
|
||||
---
|
||||
|
||||
The [Statistics notebook](http://nbviewer.jupyter.org/github/home-assistant/home-assistant-notebooks/blob/master/database-statistics.ipynb) gets you started if you want to create statistical analysis of your data.
|
||||
The [Statistics notebook](http://nbviewer.jupyter.org/github/home-assistant/home-assistant-notebooks/blob/master/database-statistics.ipynb) shows some basic statistical analysis on data in the Home Assistant database.
|
||||
|
||||
@ -40,6 +40,10 @@ unit_of_measurement:
|
||||
description: Unit of Measurement given to data
|
||||
type: string
|
||||
default: "Unit Of Measurement given by entity"
|
||||
theme:
|
||||
required: false
|
||||
description: Set to any theme within `themes.yaml`
|
||||
type: string
|
||||
min:
|
||||
required: false
|
||||
description: Minimum value for graph
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user