Merge branch 'current' into next
@ -7,6 +7,7 @@ sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: restful.png
|
||||
ha_category: Binary Sensor
|
||||
ha_release: "0.10"
|
||||
ha_iot_class: "Local Polling"
|
||||
|
@ -7,6 +7,7 @@ sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: tcp_ip.png
|
||||
ha_category: Binary Sensor
|
||||
ha_release: 0.14
|
||||
---
|
||||
|
@ -11,7 +11,7 @@ footer: true
|
||||
|
||||
Home Assistant can get information from your wireless router or third party services like iCloud or OwnTracks to track which devices are connected and considered "in home". Please check the sidebar for a list of brands of supported wireless routers and services.
|
||||
|
||||
There are also trackers available which use different technologies like [MQTT](/components/mqtt/) or [Nmap](/components/device_tracker.nmap_scanner/) to scan the network for devices.
|
||||
There are also trackers available which use different technologies like [MQTT](/components/mqtt/) or [Nmap](/components/device_tracker.nmap_tracker/) to scan the network for devices.
|
||||
|
||||
# {% linkable_title Configuring a `device_tracker` platform %}
|
||||
|
||||
@ -47,7 +47,7 @@ device_tracker:
|
||||
track_new_devices: yes
|
||||
```
|
||||
|
||||
Multiple device trackers can be used in parallel, such as [Owntracks](/components/device_tracker.owntracks/) and [Nmap](/components/device_tracker.nmap_scanner/). The state of the device will be determined by the source that reported last.
|
||||
Multiple device trackers can be used in parallel, such as [Owntracks](/components/device_tracker.owntracks/) and [Nmap](/components/device_tracker.nmap_tracker/). The state of the device will be determined by the source that reported last.
|
||||
|
||||
# {% linkable_title `known_devices.yaml` %}
|
||||
|
||||
|
@ -7,6 +7,7 @@ sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: tomato.png
|
||||
ha_category: Presence Detection
|
||||
ha_release: pre 0.7
|
||||
---
|
||||
|
@ -14,7 +14,7 @@ ha_category: Hub
|
||||
The FFmpeg component allows other Home Assistant components to process video and audio streams. This component supports all FFmpeg versions since 3.0.0; if you have a older version, please update.
|
||||
|
||||
<p class='note'>
|
||||
You need the `ffmpeg` binary in your system path. On Debian 8 or Raspbian (Jessie) you can install it from [debian-backports](https://backports.debian.org/Instructions/). If you want hardware acceleration support on a Raspberry Pi, you will need to build from source by yourself. Windows binaries are avilable on the [FFmpeg](http://www.ffmpeg.org/) website.
|
||||
You need the `ffmpeg` binary in your system path. On Debian 8 or Raspbian (Jessie) you can install it from [debian-backports](https://backports.debian.org/Instructions/). If you want [hardware acceleration](https://trac.ffmpeg.org/wiki/HWAccelIntro) support on a Raspberry Pi, you will need to build from source by yourself. Windows binaries are avilable on the [FFmpeg](http://www.ffmpeg.org/) website.
|
||||
</p>
|
||||
|
||||
To set it up, add the following information to your `configuration.yaml` file:
|
||||
|
@ -7,6 +7,7 @@ sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: magic_light.png
|
||||
ha_category: Light
|
||||
ha_iot_class: "Local Polling"
|
||||
featured: false
|
||||
|
@ -8,6 +8,7 @@ layout: page
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: limitlessled_logo.png
|
||||
ha_category: Light
|
||||
ha_iot_class: "Assumed State"
|
||||
ha_release: pre 0.7
|
||||
|
@ -34,7 +34,7 @@ Configuration variables:
|
||||
|
||||
### {% linkable_title Getting ready for Chrome %}
|
||||
|
||||
Google has [a handy guide](https://developers.google.com/web/fundamentals/getting-started/push-notifications/step-04) that goes into great detail about how to set up for pushing to Chrome. Once you have your GCM API Key and Sender ID in hand, plug them into your configuration as described above.
|
||||
Google has [a handy guide](https://developers.google.com/web/fundamentals/getting-started/codelabs/push-notifications/#make_a_project_on_the_google_developer_console) that goes into great detail about how to set up for pushing to Chrome. Once you have your GCM API Key and Sender ID in hand, plug them into your configuration as described above.
|
||||
|
||||
### {% linkable_title Requirements %}
|
||||
|
||||
|
@ -7,6 +7,7 @@ sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: restful.png
|
||||
ha_category: Notifications
|
||||
ha_release: 0.13
|
||||
---
|
||||
|
@ -7,12 +7,13 @@ sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: simplepush.png
|
||||
ha_category: Notifications
|
||||
ha_release: 0.29
|
||||
---
|
||||
|
||||
|
||||
The `simplepush` platform uses [Simplepush](https://simplepush.io/) to delivery notifications from Home Assistant to your Android device.
|
||||
The `simplepush` platform uses [Simplepush](https://simplepush.io/) to delivery notifications from Home Assistant to your Android device. Unlike similar apps the Simplepush app requires no registration.
|
||||
|
||||
To add Simplepush to your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
|
@ -52,20 +52,57 @@ script:
|
||||
entity_id: group.living_room
|
||||
```
|
||||
|
||||
### {% linkable_title Passing parameters in service calls %}
|
||||
### {% linkable_title Passing variables to scripts %}
|
||||
|
||||
As part of the service, parameters can be passed in that will be made available to the script as variables within templates.
|
||||
As part of the service, variables can be passed along to a script so they become available within templates in that script.
|
||||
|
||||
There are two ways to activate scripts. One is using the generic `script.turn_on` service. To pass variables to the script with this service, call it using the following parameters:
|
||||
There are two ways to achieve this. One way is using the generic `script.turn_on` service. To pass variables to the script with this service, call it with the desired variables:
|
||||
|
||||
```yaml
|
||||
{
|
||||
"entity_id": "script.wakeup",
|
||||
"variables": {
|
||||
"hello": "world",
|
||||
"name": "Paulus"
|
||||
}
|
||||
}
|
||||
# Example configuration.yaml entry
|
||||
automation:
|
||||
trigger:
|
||||
platform: state
|
||||
entity_id: light.bedroom
|
||||
from: 'off'
|
||||
to: 'on'
|
||||
action:
|
||||
service: script.turn_on
|
||||
entity_id: script.notify_pushover
|
||||
data:
|
||||
variables:
|
||||
title: 'State change'
|
||||
message: 'The light is on!'
|
||||
```
|
||||
|
||||
If you are calling the script service directly, for example `script.wakeup`. All service data will be made available as variables.
|
||||
The other way is calling the script as a service directly. In this case, all service data will be made available as variables. If we apply this approach on the script above, it would look like this:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
automation:
|
||||
trigger:
|
||||
platform: state
|
||||
entity_id: light.bedroom
|
||||
from: 'off'
|
||||
to: 'on'
|
||||
action:
|
||||
service: script.notify_pushover
|
||||
data:
|
||||
title: 'State change'
|
||||
message: 'The light is on!'
|
||||
```
|
||||
|
||||
Using the variables in the script requires the use of `data_template`:
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
script:
|
||||
notify_pushover:
|
||||
sequence:
|
||||
- condition: state
|
||||
entity_id: switch.pushover_notifications
|
||||
state: 'on'
|
||||
- service: notify.pushover
|
||||
data_template:
|
||||
title: "{% raw %}{{ title }}{% endraw %}"
|
||||
message: "{% raw %}{{ message }}{% endraw %}"
|
||||
```
|
||||
|
@ -7,6 +7,7 @@ sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: cpu.png
|
||||
ha_category: System Monitor
|
||||
ha_release: pre 0.7
|
||||
ha_iot_class: "Local Push"
|
||||
|
@ -7,6 +7,7 @@ sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: smtp.png
|
||||
ha_category: Sensor
|
||||
ha_release: 0.25
|
||||
ha_iot_class: "Local Polling"
|
||||
|
@ -7,6 +7,7 @@ sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: smtp.png
|
||||
ha_category: Sensor
|
||||
ha_iot_class: "Local Polling"
|
||||
ha_release: 0.25
|
||||
|
@ -7,6 +7,7 @@ sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: linux_battery.png
|
||||
ha_category: System Monitor
|
||||
ha_release: 0.28
|
||||
ha_iot_class: "Local Polling"
|
||||
|
@ -7,6 +7,7 @@ sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: mhz19_logo.png
|
||||
ha_category: Sensor
|
||||
ha_release: 0.27
|
||||
---
|
||||
|
@ -7,6 +7,7 @@ sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: miflora.png
|
||||
ha_category: DIY
|
||||
ha_release: 0.29
|
||||
ha_iot_class: "Local Polling"
|
||||
|
@ -7,6 +7,7 @@ sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: onewire.png
|
||||
ha_category: Sensor
|
||||
ha_release: 0.12
|
||||
---
|
||||
|
@ -7,6 +7,7 @@ sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: restful.png
|
||||
ha_category: Sensor
|
||||
ha_release: 0.7.4
|
||||
---
|
||||
|
@ -7,6 +7,7 @@ sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: serial_pm.png
|
||||
ha_category: DIY
|
||||
ha_release: 0.26
|
||||
---
|
||||
|
@ -7,6 +7,7 @@ sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: supervisord.png
|
||||
ha_category: System Monitor
|
||||
ha_release: "0.20"
|
||||
---
|
||||
|
@ -7,6 +7,7 @@ sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: system_monitor.png
|
||||
ha_category: System Monitor
|
||||
ha_release: pre 0.7
|
||||
ha_iot_class: "Local Push"
|
||||
|
@ -7,6 +7,7 @@ sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: tcp_ip.png
|
||||
ha_category: Sensor
|
||||
ha_release: 0.14
|
||||
---
|
||||
|
@ -7,6 +7,7 @@ sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: restful.png
|
||||
ha_category: Switch
|
||||
ha_release: 0.7.6
|
||||
---
|
||||
|
13
source/_cookbook/jupyter_notebooks_stats.markdown
Normal file
@ -0,0 +1,13 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Jupyter Notebooks Statistics"
|
||||
description: "Basic example how to create basic statistics with a Jupyter notebook."
|
||||
date: 2016-10-03 09:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
ha_category: Jupyter Notebooks
|
||||
ha_external_link: http://nbviewer.jupyter.org/github/home-assistant/home-assistant-notebooks/blob/master/database-statistics.ipynb
|
||||
---
|
||||
|
@ -11,25 +11,28 @@ footer: true
|
||||
|
||||
You'll need to set up a development environment if you want to develop a new feature or component for Home Assistant. Read on to learn how to set up.
|
||||
|
||||
1. Visit the [the Home Assistant repository](https://github.com/home-assistant/home-assistant) and click "fork."
|
||||
* Visit the [Home Assistant repository](https://github.com/home-assistant/home-assistant) and click **Fork**.
|
||||
|
||||
* Consider setting up a virtual environment using [`venv`](https://docs.python.org/3.4/library/venv.html) before running the setup script.
|
||||
* Consider setting up a virtual environment using [`venv`](https://docs.python.org/3.4/library/venv.html) before running the setup script.
|
||||
|
||||
```bash
|
||||
$ git clone https://github.com/YOUR_GIT_USERNAME/home-assistant.git
|
||||
$ cd home-assistant
|
||||
$ git remote add upstream https://github.com/home-assistant/home-assistant.git
|
||||
$ script/setup
|
||||
```
|
||||
* On Windows, you can use `python setup.py develop` instead of the setup script.
|
||||
```bash
|
||||
$ git clone https://github.com/YOUR_GIT_USERNAME/home-assistant.git
|
||||
$ cd home-assistant
|
||||
$ git remote add upstream https://github.com/home-assistant/home-assistant.git
|
||||
$ script/setup
|
||||
```
|
||||
|
||||
2. Run `hass` to invoke your local installation.
|
||||
* On Windows, you can use `python setup.py develop` instead of the setup script.
|
||||
|
||||
* Run `hass` to invoke your local installation.
|
||||
|
||||
### {% linkable_title Developing on Windows %}
|
||||
|
||||
### Developing on Windows
|
||||
If you are using Windows as a development platform, make sure that you have the correct Microsoft Visual C++ build tools installed. Check the [Windows Compilers](https://wiki.python.org/moin/WindowsCompilers) section on the [Python website](https://www.python.org/) for details. Validation using `tox` will fail if this is not done correctly.
|
||||
|
||||
Also, make sure to install or upgrade the `Setuptools` Python package -- it contains compatibility improvements and adds automatic use of compilers:
|
||||
```bash
|
||||
pip install --upgrade setuptools
|
||||
```
|
||||
Also, make sure to install or upgrade the `setuptools` Python package. It contains compatibility improvements and adds automatic use of compilers:
|
||||
|
||||
```bash
|
||||
$ pip install --upgrade setuptools
|
||||
```
|
||||
|
||||
|
@ -11,16 +11,16 @@ footer: true
|
||||
|
||||
The website you are reading now is the home of Home Assistant: [https://home-assistant.io](https://home-assistant.io). This is the place where we provide documentation and additional details about Home Assistant for end users and developers.
|
||||
|
||||
home-assistant.io is built using [Jekyll](http://github.com/mojombo/jekyll) and [those available dependencies](https://pages.github.com/versions/). The pages are written in [markdown](http://daringfireball.net/projects/markdown/); to add a page you don't need to know about HTML or the like.
|
||||
home-assistant.io is built using [Jekyll](http://github.com/mojombo/jekyll) and [these available dependencies](https://pages.github.com/versions/). The pages are written in [markdown](http://daringfireball.net/projects/markdown/). To add a page, you don't need to know about HTML.
|
||||
|
||||
The link "**Edit this page on GitHub**" allows one to edit pages without creating a fork.
|
||||
You can use the "**Edit this page on GitHub**" link to edit pages without creating a fork.
|
||||
|
||||
For larger changes, we suggest that you clone the website repository. This has the advantage that you can review your changes locally. The process for working on the website is no different from working on Home Assistant itself. You work on your change and propose it via a pull request.
|
||||
For larger changes, we suggest that you clone the website repository. This way, you can review your changes locally. The process for working on the website is no different from working on Home Assistant itself. You work on your change and propose it via a pull request.
|
||||
|
||||
To test your changes locally, you need to install the **Ruby** dependencies (gems):
|
||||
|
||||
- [Install Ruby](https://www.ruby-lang.org/en/documentation/installation/) if you don't have it already.
|
||||
- Install `bundler`, which is a dependency manager for Ruby: `gem install bundler`
|
||||
- Install `bundler`, a dependency manager for Ruby: `gem install bundler`
|
||||
- In your home-assistant.github.io root directory, run `bundle` to install the gems you need.
|
||||
|
||||
Then you can work on the documentation:
|
||||
|
@ -35,9 +35,11 @@ Have you found an issue in your Home Assistant installation? Please report it. R
|
||||
- [Automating your Home with Home Assistant](https://www.youtube.com/watch?v=4-6rTwKl6ww&list=PLKsVm4cWHDQB9JBcD7_ZfNcvC6xx47QHT&index=2) at OpenIoT 2016 - March 2016
|
||||
- [Automating Your Life - Home Automation](http://slides.com/teagan42/life_automation#/) at Develop Denver 2016 - August
|
||||
|
||||
Looking for [talking points](/help/talking-points/) or [trivia](/help/trivia)?
|
||||
|
||||
### {% linkable_title Site Search %}
|
||||
|
||||
There is not currently a site search for Home-Assistant.io but it's in the works. For now, you can use this [Google link](https://cse.google.com/cse/publicurl?cx=005053695590750500199:dtrfi8yigbi) which will narrow your search to this specific site.
|
||||
There is not currently a site search for Home-Assistant.io but it's in the works. For now, you can use this [Google link](https://cse.google.com/cse/publicurl?cx=005053695590750500199:dtrfi8yigbi) which will narrow your search to this specific site.
|
||||
|
||||
### {% linkable_title Roadmap %}
|
||||
|
||||
|
21
source/help/talking-points.markdown
Normal file
@ -0,0 +1,21 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Talking points"
|
||||
description: "Talking points for your Home Assistant talk or presentation."
|
||||
date: 2016-10-06 06:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
---
|
||||
|
||||
People are starting to present Home Assistant at meetings and get-togethers. Below you find a couple of bullet points for your presentation.
|
||||
|
||||
- [Numbers, numbers, numbers](/help/trivia/) and other details
|
||||
- Over 400 implementations
|
||||
- Not depending on cloud services. We like to keep your privacy private
|
||||
- Control all your devices from a single, mobile-friendly, interface
|
||||
- Written in Python3 with 94% test coverage
|
||||
- Active and helpful community
|
||||
|
||||
|
BIN
source/images/supported_brands/cpu.png
Normal file
After Width: | Height: | Size: 67 KiB |
BIN
source/images/supported_brands/limitlessled_logo.png
Normal file
After Width: | Height: | Size: 50 KiB |
BIN
source/images/supported_brands/linux_battery.png
Normal file
After Width: | Height: | Size: 32 KiB |
BIN
source/images/supported_brands/magic_light.png
Normal file
After Width: | Height: | Size: 29 KiB |
BIN
source/images/supported_brands/mhz19_logo.png
Normal file
After Width: | Height: | Size: 263 KiB |
BIN
source/images/supported_brands/miflora.png
Normal file
After Width: | Height: | Size: 66 KiB |
BIN
source/images/supported_brands/onewire.png
Normal file
After Width: | Height: | Size: 44 KiB |
BIN
source/images/supported_brands/restful.png
Normal file
After Width: | Height: | Size: 8.3 KiB |
BIN
source/images/supported_brands/serial_pm.png
Normal file
After Width: | Height: | Size: 28 KiB |
BIN
source/images/supported_brands/simplepush.png
Normal file
After Width: | Height: | Size: 5.6 KiB |
BIN
source/images/supported_brands/supervisord.png
Normal file
After Width: | Height: | Size: 2.1 KiB |
BIN
source/images/supported_brands/system_monitor.png
Normal file
After Width: | Height: | Size: 13 KiB |
BIN
source/images/supported_brands/tcp_ip.png
Normal file
After Width: | Height: | Size: 33 KiB |
BIN
source/images/supported_brands/tomato.png
Normal file
After Width: | Height: | Size: 35 KiB |