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-13 12:26:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'current' into release-0-60

Browse Source
This commit is contained in:
Fabian Affolter 2017-12-17 16:04:27 +01:00 committed by GitHub
commit 824d9266f7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 238 additions and 153 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

70
source/_addons/homematic.markdown Normal file
View File

@ -0,0 +1,70 @@
---
layout: page
title: "HomeMatic"
description: "HomeMatic hardware support to turn you Home-Assistant into a CCU."
date: 2017-04-30 13:28
sidebar: true
comments: false
sharing: true
footer: true
---
Set up a [HomeMatic](https://github.com/eq-3/occu) hardware layer. At the moment we don't support hmIP but that is in progress. For learning and handling devices use our internal homematic panel and services (in progress) or use [Homematic-Manager](https://github.com/hobbyquaker/homematic-manager) > 2.0.
The logic layer will be Home-Assistant. There is no ReGa or other logic layer installed. You can't import exists configuration, you need new learn it into Home-Assistant.
Follow devices will be supported and tested:
- [HM-MOD-RPI-PCB](https://www.elv.ch/homematic-funkmodul-fuer-raspberry-pi-bausatz.html)
```json
{
"rf_enable": true,
"rf": [
{
"type": "CCU2",
"device": "/dev/ttyAMA0"
}
],
"wired_enable": false,
"wired": [
{
"serial": "xy",
"key": "abc",
"ip": "192.168.0.0"
}
]
}
```
Configuration variables:
- **rf_enable** (*Require*): Boolean. Enable or disable BidCoS-RF.
- **wired_enable** (*Require*): Boolean. Enable or disable BidCoS-Wired.
For RF devices
- **type** (*Require*): Device type for RFD service. Look into handbook of your device.
- **device** (*Require*): Device on host.
For RF devices
- **serial** (*Require*): Serial number of device.
- **key** (*Require*): Encrypted key.
- **ip** (*Require*): IP address of lan gateway.
## {% linkable_title Home Assistant configuration %}
Use the following configuration in Home Assistant to use it:
```yaml
homematic:
interfaces
BidCoS-RF:
host: core-homematic
port: 2001
```
## {% linkable_title Raspberry Pi3 %}
With HM-MOD-PRI-PCB you need add follow into your `config.txt` on boot partition:
```
dtoverlay=pi3-miniuart-bt
```

42
source/_components/sensor.mqtt.markdown
View File

@ -25,14 +25,40 @@ sensor:
state_topic: "home/bedroom/temperature" state_topic: "home/bedroom/temperature"
``` ```
Configuration variables: {% configuration %}
state_topic:
- **state_topic** (*Required*): The MQTT topic subscribed to receive sensor values. description: The MQTT topic subscribed to receive sensor values.
- **name** (*Optional*): The name of the sensor. Default is 'MQTT Sensor'. required: true
- **qos** (*Optional*): The maximum QoS level of the state topic. Default is 0. type: string
- **unit_of_measurement** (*Optional*): Defines the units of measurement of the sensor, if any. name:
- **expire_after** (*Optional*): Defines the number of seconds after the value expires if it's not updated. Default is 0 (=never expire). description: Name of the MQTT sensor.
- **value_template** (*Optional*): Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract a value from the payload. required: false
type: string
default: MQTT Sensor
qos:
description: The maximum QoS level of the state topic.
required: false
type: int
default: 0
unit_of_measurement:
description: Defines the units of measurement of the sensor, if any.
required: false
type: string
expire_after:
description: Defines the number of seconds after the value expires if it's not updated.
required: false
type: int
default: 0
value_template:
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the value."
required: false
type: template
force_update:
description: Sends update events even if the value hasn't changed. Useful if you want to have meaningful value graphs in history.
reqired: false
type: boolean
default: False
{% endconfiguration %}
## {% linkable_title Examples %} ## {% linkable_title Examples %}

14
source/_docs/installation.markdown
View File

@ -14,9 +14,21 @@ redirect_from: /getting-started/installation/
Beginners should check our [Getting started guide](/getting-started/) first. This is for users that require advanced installations. Beginners should check our [Getting started guide](/getting-started/) first. This is for users that require advanced installations.
</p> </p>
Home Assistant provides multiple ways to be installed. A requirement is that you have [Python](https://www.python.org/downloads/) installed. For Windows, we require at least **Python 3.5** and for other operating systems at least **Python 3.4.2**. Home Assistant provides multiple ways to be installed. A requirement is that you have [Python 3.5+](https://www.python.org/downloads/) installed.
<div class="text-center hass-option-cards" markdown="0"> <div class="text-center hass-option-cards" markdown="0">
<a class='option-card' href='/getting-started/'>
<div class='img-container'>
<img src='/images/supported_brands/home-assistant.png' />
</div>
<div class='title'>Hass.io<br>(Beginner friendly)</div>
</a>
<a class='option-card' href='/docs/installation/virtualenv/'>
<div class='img-container'>
<img src='/images/supported_brands/python.svg' />
</div>
<div class='title'>On top of an existing Python 3.5+ installation</div>
</a>
<a class='option-card' href='/docs/hassbian/installation/'> <a class='option-card' href='/docs/hassbian/installation/'>
<div class='img-container'> <div class='img-container'>
<img src='/images/supported_brands/home-assistant.png' /> <img src='/images/supported_brands/home-assistant.png' />

144
source/_docs/installation/virtualenv.markdown
View File

@ -9,113 +9,39 @@ sharing: true
footer: true footer: true
redirect_from: /getting-started/installation-virtualenv/ redirect_from: /getting-started/installation-virtualenv/
--- ---
<p class='note'>
Beginners should check our [getting started guide](/getting-started/) first. If you already have Python 3.5 or later installed, you can easily give Home Assistant a spin.
It's recommended when installing Python packages that you use a virtual environment. This will make sure that your Python installation and Home Assistant installation won't impact one another.
_(If you're on a Debian based system, you will need to install Python virtual environment support using `apt-get install python3-pip python3-venv`)_
1. Create a virtual environment:
```
python3 -m venv homeassistant
```
2. Open virtual environment:
```
cd homeassistant
```
3. Activate virtual environment:
```
source bin/activate
```
4. Install Home Assistant:
```
python3 -m pip install --upgrade homeassistant
```
5. Run Home Assistant:
```
hass --open-ui
```
### {% linkable_title Notes %}
- In the future, if you want to start Home Assistant again, follow step 2, 3 and 5.
- If you want to upgrade Home Assistant, follow step 2 and 3 and 4.
<p class='info'>
Looking for more advanced guides? Check our <a href='/docs/installation/'>available guides</a>.
</p> </p>
There are several reasons why it makes sense to run Home Assistant in a virtual environment. A [virtual environments (or short `venv`)](https://docs.python.org/3.6/library/venv.html) encapsulates all aspect of a Python environment within a single directory tree. That means the Python packages you install for Home Assistant won't interact with the rest of your system and vice-versa. It means a random upgrade for some other program on your computer won't break Home Assistant, and it means you don't need to install Python packages as root.
Virtual environments are pretty easy to setup. We'll be using Debian in this example (as many Home Assistant users are running Raspbian on a Raspberry Pi), but all of the Python related steps should be the same on just about any platform.
### {% linkable_title Basic guide %}
The basic guide is for testing Home Assistant. Also check the advanced guide for instances used in production.
## {% linkable_title Step 1: Install dependencies %}
```bash
$ sudo apt-get update
$ sudo apt-get upgrade
$ sudo apt-get install python3-pip python3-dev python3-venv
$ sudo pip3 install --upgrade virtualenv
```
## {% linkable_title Step 2: Setup virtualenv %}
```bash
$ python3 -m venv $HOME/homeassistant
```
## {% linkable_title Step 3: Install or update Home Assistant %}
```bash
$ source $HOME/homeassistant/bin/activate
(homeassistant)$ pip3 install --upgrade homeassistant
```
## {% linkable_title Step 4: Run Home Assistant %}
```bash
$ $HOME/homeassistant/bin/hass
```
### {% linkable_title Advanced guide %}
## {% linkable_title Separate user & group for Home Assistant (Basic guide step 2) %}
It's a good idea to give services like Home Assistant their own user. It gives you more granular control over permissions, and reduces the exposure to the rest of your system in the event there is a security related bug in Home Assistant. This is a reasonably Linux oriented step, and will look different on other operating systems (or even other Linux distributions).
```bash
$ sudo adduser --system homeassistant
$ sudo addgroup homeassistant
```
Home Assistant stores its configuration in `$HOME/.homeassistant` by default, so in this case, it would be in `/home/homeassistant/.homeassistant`.
If you plan to use a Z-Wave controller, you will need to add this user to the `dialout` group:
```bash
$ sudo usermod -G dialout -a homeassistant
```
## {% linkable_title Custom installation directory for Home Assistant (Basic guide step 2) %}
This can be anywhere you want. We chose to put it in `/srv`. You also need to change the ownership of the directory to the user you created above.
```bash
$ sudo mkdir /srv/homeassistant
$ sudo chown homeassistant:homeassistant /srv/homeassistant
```
Switching to your `homeassistant` user is obviously only necessary if you created a `homeassistant` user, but if you did, be sure to switch to that user whenever you install things in your virtual environment, otherwise you'll end up with mucked up permissions.
```bash
$ sudo su -s /bin/bash homeassistant
```
The `su` command means 'switch' user. We use the '-s' flag because the `homeassistant` user is a system user and doesn't have a default shell by default (to prevent attackers from being able to log in as that user).
Now, you can setup your virtual environment.
```bash
$ python3 -m venv /srv/homeassistant
```
## {% linkable_title Install or update Home Assistant %}
With [`pip`](https://pip.pypa.io/en/stable/quickstart/) you are now able to install Home Assistant in your virtual environment.
```bash
$ source /srv/homeassistant/bin/activate
(homeassistant)$ pip3 install homeassistant
```
Or updating:
```bash
$ source /srv/homeassistant/bin/activate
(homeassistant)$ pip3 install --upgrade homeassistant
```
## {% linkable_title Run Home Assistant (Basic guide step 4) %}
There are two ways to launch Home Assistant. If you are **in** the virtual environment, you can just run `hass` and it will work as normal. If the virtual environment is not activated, you just use the `hass` executable in the `bin` directory mentioned earlier. There is one caveat. Because Home Assistant stores its configuration in the user's home directory, we need to be the user `homeassistant` or specify the configuration with `-c`.
```bash
$ sudo -u homeassistant -H /srv/homeassistant/bin/hass
```
The `-H` flag is important. It sets the `$HOME` environment variable to `/home/homeassistant` so `hass` can find its configuration.
## {% linkable_title Starting Home Assistant on boot %}
The [autostart instructions](/getting-started/autostart/) will work just fine, just be sure to replace `/usr/bin/hass` with `/srv/homeassistant/bin/hass` and specify the `homeassistant` user where appropriate.

16
source/developers/development_environment.markdown
View File

@ -85,21 +85,23 @@ $ git remote add upstream https://github.com/home-assistant/home-assistant.git
### {% linkable_title Setting up virtual environment %} ### {% linkable_title Setting up virtual environment %}
If you plan on providing isolation to your environment using [`venv`](https://docs.python.org/3.4/library/venv.html). Within the `home-assistant` directory, create and activate your virtual environment. To isolate your environment from the rest of the system, set up a [`venv`](https://docs.python.org/3.4/library/venv.html). Within the `home-assistant` directory, create and activate your virtual environment.
```bash ```bash
$ python3 -m venv venv $ python3 -m venv .
$ source venv/bin/activate $ source bin/activate
``` ```
Install the requirements with a provided script named `setup`.
### {% linkable_title Setup and Run %}
```bash ```bash
$ cd home-assistant
$ script/setup $ script/setup
``` ```
* Run `hass` to invoke your local installation. Invoke your installation.
```bash
$ hass
```
### {% linkable_title Logging %} ### {% linkable_title Logging %}

54
source/getting-started/configuration.markdown
View File

@ -9,19 +9,59 @@ sharing: true
footer: true footer: true
--- ---
When launched for the first time, Home Assistant will write a default configuration file, called `configuration.yaml`, enabling the web interface and [device discovery](/components/discovery/). It can take up to a minute for your devices to be discovered and appear in the user interface. If you made it here, awesome! That means that you got Home Assistant up and running. It might have already found some of your networked devices. This is going to be fun!
The `configuration.yaml` is written in [YAML](/docs/configuration/yaml/), stored in [`.homeassistant`](/docs/configuration/), and can be modified with a text editor. Home Assistant stores its configuration in a file called `configuration.yaml`. A default one is created when Home Assistant is started for the first time. Some of the things in the configuration file can be edited via the user interface, other parts require you to edit the configuration file directly.
See the [components overview page](/components/) to find sample entries for your devices and services. For a sensor that is showing [random values](/components/sensor.random/), the entry would look like the sample below: There are two common approaches to edit your configuration: via Samba/Windows Networking and via the HASS Configurator. Both of these are [official add-ons for Hass.io](/addons/).
## {% linkable_title Installing Hass.io add-ons %}
Hass.io add-ons are installed from the add-on store embedded in the Hass.io panel:
- Open Home Assistant by navigating to [http://hassio.local:8123][local].
- Click on the menu icon in the top left and select Hass.io in the sidebar.
- The Hass.io panel opens, now open the add-on store by clicking the shopping bag.
[local]: http://hassio.local:8123
<p class='img'>
<img src='/images/hassio/screenshots/main_panel_store_icon.png' />
From the Hass.io main panel open the add-on store.
</p>
### {% linkable_title Editing config via HASS Configurator %}
The first add-on we should install is the HASS Configurator. With the HASS Configurator you'll be able to edit your Home Assistant configuration from the web interface.
Go to the add-on store (see previous step), click on Configurator and click on INSTALL. When installation is complete the UI will go to the add-on details page for the configurator. Here you will be able to change settings, start and stop the add-on.
- Change the settings to set a password and click on save
- Start the add-on
- You will be able to click the "WEB UI" link to open the Web UI
Time for the first practice with the configurator. Add the following to `configuration.yaml` file to add a link to the Configurator in the sidebar:
```yaml ```yaml
sensor: panel_iframe:
- platform: random configurator:
title: Configurator
icon: mdi:wrench
url: http://hassio.local:3218
``` ```
The [Setting up devices part](/docs/configuration/devices/) contains the additional documentation details about adding devices and services and [customization](/docs/configuration/customizing-devices/). Now restart Home Assistant for the changes to the configuration to take effect. You can do this by going to the config panel (Configuration in the sidebar) -> General -> Restart Home Assistant.
For further details about configuration, please take a look at the [configuration documentation](/docs/configuration/). ### {% linkable_title Editing config via Samba/Windows Networking %}
Maybe you are not a big fan of our web editor and want to use a text editor on your computer instead. This is possible by sharing the configuration over the network using the Samba add-on, which can be installed from the Hass.io add-on store.
After you have installed it, click on START. Hass.io should now be available in the networking tab on your computer. Use a text editor like the free [Visual Studio Code](https://code.visualstudio.com/) to edit `configuration.yaml`.
## {% linkable_title Configuring integrations %}
Now that you are able to edit the configuration, it's time to set up some of your devices and services. Each service and device will have its own instructions on how to be integrated. Find your devices and services on the [components overview page](/components/).
<p class='note'>YAML can be a little daunting at first. A lot is possible! [Here is some more info.](/docs/configuration/devices/)</p>
### [Next step: Automate Home Assistant &raquo;](/getting-started/automation/) ### [Next step: Automate Home Assistant &raquo;](/getting-started/automation/)

51
source/getting-started/index.markdown
View File

@ -9,30 +9,39 @@ sharing: true
footer: true footer: true
--- ---
First you will need to install Home Assistant before we can get started: The goal of this getting started guide is to install Hass.io on a Raspberry Pi 3. Hass.io is our own all in one solution that turns your Raspberry PI into the utlimate home automation hub.
We have developed **Hass.io** to turn your device into a dedicated Home Assistant hub controlled by a nice webinterface. Follow this guide if you want to easily get started with Home Assistant or if you have none or little Linux experience. For advanced users, check our [alternative installation methods](/docs/installation/).
For Raspberry Pi and Intel NUC we offer configured images. Flash the image, setup WiFi (if required) and everything else can be done inside the Hass.io webinterface. Great, isn't it?
Also Home Assistant runs on any other device that supports **Python 3**. ### {% linkable_title Hardware requirements %}
<div class="text-center hass-option-cards" markdown="0">
<a class='option-card' href='/hassio/installation/'>
<div class='img-container'>
<img src='/images/supported_brands/home-assistant.png' />
</div>
<div class='title'>Install Home Assistant using Hass.io</div>
</a>
<a class='option-card' href='/docs/installation/virtualenv/'>
<div class='img-container'>
<img src='/images/supported_brands/python.svg' />
</div>
<div class='title'>Install Home Assistant on your computer</div>
</a>
</div>
<br>
For alternative installation methods, please take a look at the [installation documentation](/docs/installation/). We will need a few things to get started with installing Home Assistant. Links below are linking to Amazon US. If you're not in the US, you should be able to find these items in web stores in your country.
If you run into any issues, please see [the troubleshooting page](/docs/installation/troubleshooting/) or [communication channels](/help/). It contains solutions to many commonly encountered issues. - [Raspberry Pi 3 model B](http://a.co/gEfMqL4) + [Power Supply](http://a.co/cgKUgkt) (atleast 2.5A)
- [Micro SD Card](http://a.co/gslOydD). Get one that is Class 10 as they are more reliable. Size 32GB or bigger recommended.
- SD Card reader. Part of most laptops. Also available as [standalone USB sticks](http://a.co/5FCyb0N) (brand doesn't matter, just pick cheapest)
- Ethernet cable (optional, Hass.io can work with WiFi too)
### {% linkable_title Software requirements %}
- Download [Hass.io image for Raspberry Pi 3][pi3]
- Download [Etcher] to write the image to an SD card
- Text Editor like [Visual Studio Code](https://code.visualstudio.com/)
[Etcher]: https://etcher.io/
[pi3]: https://github.com/home-assistant/hassio-build/releases/download/1.1/resinos-hassio-1.1-raspberrypi3.img.bz2
### Installing Hass.io
1. Put the SD card in your SD card reader,
2. Open Etcher, select the Hass.io image and flash it to the SD card.
3. WiFi setup only: open the file `system-connections/resin-sample` with a text editor. Change `ssid` to be your network name and `psk` to be your password.
4. Unmount the SD card and remove it from your SD card reader.
5. Insert the SD card into your Raspberry Pi 3. If you are going to use an Ethernet cable to supply Internet, connect that too.
6. Connect your Raspberry Pi to the power supply so it turns on.
7. The Raspberry Pi will now boot up, connect to the Internet and download the latest version of Home Assistant. This will take about 20 minutes.
8. Home Assistant will be available at [http://hassio.local:8123][local].
[local]: http://hassio.local:8123
### [Next step: Configuring Home Assistant &raquo;](/getting-started/configuration/) ### [Next step: Configuring Home Assistant &raquo;](/getting-started/configuration/)