@@ -18,4 +16,8 @@ Home Assistant will track the state of all the devices in your home, so you don'
+
-Home Assistant will track the state of all the devices in your home, so you don't have to. -
+Home Assistant will track the state of all the devices in your home, so you don't have to.
@@ -18,4 +16,8 @@ Home Assistant will track the state of all the devices in your home, so you don'
+
+Before this scanner can be used you have to install the luci RPC package on OpenWRT: opkg install luci-mod-rpc.
+
+```yaml
+# Example configuration.yaml entry
+device_tracker:
+ platform: luci
+ host: 192.168.1.1
+ username: admin
+ password: PASSWORD
+```
+
+See the [device tracker component page](/components/device_tracker.html) for instructions how to configure the people to be tracked.
diff --git a/source/components/device_tracker.markdown b/source/components/device_tracker.markdown
index d44d9eec605..19416710083 100644
--- a/source/components/device_tracker.markdown
+++ b/source/components/device_tracker.markdown
@@ -9,7 +9,9 @@ sharing: true
footer: true
---
-Home Assistant can get information from your wireless router to track which devices are connected. There are three different types of supported wireless routers: tomato, netgear and luci (OpenWRT). To get started add the following lines to your `configuration.yaml` (example for Netgear):
+Home Assistant can get information from your wireless router to track which devices are connected. There are three different types of supported wireless routers: [tomato](/components/device_tracker.tomato.html), [netgear](/components/device_tracker.netgear.html) and [luci (OpenWRT)](/components/device_tracker.luci.html). You can also decide to directly scan the network for devices by using the [nmap scanner](/components/device_tracker.nmap_scanner.html).
+
+To get started add the following lines to your `configuration.yaml` (example for Netgear):
```
device_tracker:
@@ -19,20 +21,4 @@ device_tracker:
password: MY_PASSWORD
```
--Tomato requires an extra config variable called `http_id`. The value can be obtained by logging in to the Tomato admin interface and search for `http_id` in the page source code. -
- -
-Before the Luci scanner can be used you have to install the luci RPC package on OpenWRT: opkg install luci-mod-rpc.
-
+
+
+```yaml
+# Example configuration.yaml entry
+device_tracker:
+ platform: netgear
+ host: 192.168.1.1
+ username: admin
+ password: PASSWORD
+```
+
+See the [device tracker component page](/components/device_tracker.html) for instructions how to configure the people to be tracked.
diff --git a/source/components/device_tracker.nmap_scanner.markdown b/source/components/device_tracker.nmap_scanner.markdown
new file mode 100644
index 00000000000..59f2c94e4ec
--- /dev/null
+++ b/source/components/device_tracker.nmap_scanner.markdown
@@ -0,0 +1,21 @@
+---
+layout: page
+title: "OpenWRT support"
+description: "Instructions how to integrate OpenWRT routers into Home Assistant."
+date: 2015-03-23 19:59
+sidebar: false
+comments: false
+sharing: true
+footer: true
+---
+
+As an alternative to the router-based device tracking, it is possible to directly scan the network for devices by using nmap. The IP addresses to scan can be specified in any format that nmap understands, including the network-prefix notation (`192.168.1.1/24`) and the range notation (`192.168.1.1-255`).
+
+```
+# Example configuration.yaml entry
+device_tracker:
+ platform: nmap_tracker
+ hosts: 192.168.1.1/24
+```
+
+See the [device tracker component page](/components/device_tracker.html) for instructions how to configure the people to be tracked.
diff --git a/source/components/device_tracker.tomato.markdown b/source/components/device_tracker.tomato.markdown
new file mode 100644
index 00000000000..175cedb6a83
--- /dev/null
+++ b/source/components/device_tracker.tomato.markdown
@@ -0,0 +1,24 @@
+---
+layout: page
+title: "Tomato support"
+description: "Instructions how to integrate Tomato routers into Home Assistant."
+date: 2015-03-23 19:59
+sidebar: false
+comments: false
+sharing: true
+footer: true
+---
+
+Tomato requires an extra config variable called `http_id`. The value can be obtained by logging in to the Tomato admin interface and search for `http_id` in the page source code.
+
+```yaml
+# Example configuration.yaml entry
+device_tracker:
+ platform: tomato
+ host: 192.168.1.1
+ username: admin
+ password: PASSWORD
+ http_id: ABCDEFG
+```
+
+See the [device tracker component page](/components/device_tracker.html) for instructions how to configure the people to be tracked.
diff --git a/source/components/group.markdown b/source/components/group.markdown
new file mode 100644
index 00000000000..7c1556ad4cf
--- /dev/null
+++ b/source/components/group.markdown
@@ -0,0 +1,26 @@
+---
+layout: page
+title: "Group support"
+description: "Instructions how to setup groups within Home Assistant."
+date: 2015-03-23 19:59
+sidebar: false
+comments: false
+sharing: true
+footer: true
+---
+
+Groups allow the user to combine multiple entities into 1. If all entities are switches or lights they can be controlled as one.
+
+```yaml
+# Example configuration.yaml entry
+# A comma seperated list of states that have to be tracked as a single group
+# Grouped states should share the same type of states (ON/OFF or HOME/NOT_HOME)
+group:
+ living_room:
+ - light.Bowl
+ - light.Ceiling
+ - light.TV_back_light
+ children:
+ - device_tracker.child_1
+ - device_tracker.child_2
+```
diff --git a/source/components/history.markdown b/source/components/history.markdown
new file mode 100644
index 00000000000..2917609f05a
--- /dev/null
+++ b/source/components/history.markdown
@@ -0,0 +1,52 @@
+---
+layout: page
+title: "History support"
+description: "Instructions how enable historyt support for Home Assistant."
+date: 2015-03-23 19:59
+sidebar: false
+comments: false
+sharing: true
+footer: true
+---
+
+This component will track everything that is going on within Home Assistant and allows the user to browse through it.
+
+```yaml
+# Example configuration.yaml entry
+history:
+```
+
+
+
+ 
+
+
+Events are saved in a local database. Google Graphs is used to draw the graph. Drawing is happening 100% in your browser - no data is transfered to anyone at any time. +
+ +### Implementation details + +The history is stored in a SQLite databse `home-assistant.db` within your config directory. + + - events table is all events except time_changed that happened while recorder component was running. + - states table contains all the new_state values of state_changed events. + - Inside the states table you have: + - entity_id: the entity_id of the entity + - state: the state of the entity + - attributes: JSON of the state attributes + - last_changed: timestamp last time the state has changed. A state_changed event can happen when just attributes change. + - last_updated: timestamp anything has changed (state, attributes) + - created: timestamp this entry was inserted into the database + +When the history component queries the states table it only selects states where the state has changed: `WHERE last_changed=last_updated` + +#### On dates + +SQLite databases do not support native dates. That's why all the dates are saved in seconds since the UNIX epoch. Convert them manually using this site or in Python: + +```python +from datetime import datetime +datetime.fromtimestamp(1422830502) +``` diff --git a/source/components/index.markdown b/source/components/index.markdown index 567c3cdba34..13bc6db4d3f 100644 --- a/source/components/index.markdown +++ b/source/components/index.markdown @@ -7,10 +7,176 @@ sidebar: false comments: false sharing: true footer: true +is_homepage: true --- -Home Assistant consists of the following built-in components: +Components add support for devices, automation and much much more to Home Assistant. The following things are supported out-of-the-box. +## {% linkable_title Entities %} + +Entities are things that you want to observe within Home Assistant. Support for these things are provided by the entity components [Light](/components/light.html), [Switch](/components/switch.html), [Thermostat](/components/thermostat.html), [Media player](/components/media_player.html), [Device tracker](/components/device_tracker.html), [Sun](/components/sun.html). + +| Type | +Description | +|
|---|---|---|
 |
+ Philips Hue | +Turn lights on, control brightness and color. | +
|
+ SABnzbd clients | +Monitor queue and download speeds | +
| + | System Monitor | +Track CPU, memory and disk usage on the host machine. | +
 |
+ Nest thermostats | +See current temperature and control target temperature and away mode. | +
| + | Heat Control | +Turn home Assistant into your own thermostat by reading a temperature sensor and controlling a switch connected to a heater. | +
 |
+ WeMo switches | +Control WeMo switches and read the usage statistics from Insight switches. | +
|
+ OpenWRT routers | +Offers presence detection by looking at connected devices. | +
|
+ Netgear routers | +Offers presence detection by looking at connected devices. | +
| + | Tomato routers | +Offers presence detection by looking at connected devices. | +
| + | NMap network scanning | +Offers presence detection by scanning the network for connected devices. | +
 |
+ Google Cast devices | +Track what is being played and control playback. (temporarely disabled awaiting protobuf 3 release) | +
](/components/zwave.html)
+[
](/components/tellstick.html)
+[](/components/vera.html)
+[
](/components/wink.html)
+
+
+## {% linkable_title Services %}
+
+| + | History | +Track the state of entities and allow users to browse through history. | +
| + | Conversation | +Process textual commands like ones received by speech-to-text engines. | +
| + | Discovery | +Scans the network for supported devices. | +
 |
+PushBullet | +Allow sending messages using PushBullet | +
 |
+PushOver | +Allow sending messages using PushOver | +
| + | Browser | +Open URLs on the host machine | +
| + | Downloader | +Allows downloading URLs to the host machine. | +
| + | Keyboard | +Simulate key presses on the host machine | +
+
+Philips Hue support is integrated into Home Assistant as a light platform. The preferred way to setup the Philips Hue platform is by enabling the [the discovery component]({{site_root}}/components/discovery.html).
+
+If you want to enable the light component directly, add the following lines to your `configuration.yaml`:
+
+```
+light:
+ platform: hue
+```
diff --git a/source/components/media_player.cast.markdown b/source/components/media_player.cast.markdown
new file mode 100644
index 00000000000..fc4d231bda5
--- /dev/null
+++ b/source/components/media_player.cast.markdown
@@ -0,0 +1,24 @@
+---
+layout: page
+title: "Google Cast support"
+description: "Instructions how to integrate Google Cast into Home Assistant."
+date: 2015-03-23 19:59
+sidebar: false
+comments: false
+sharing: true
+footer: true
+---
+
+
+Google Cast devices will be automatically discovered if you enable [the discovery component]({{site_root}}/components/discovery.html).
+
+Can also be forced to load by adding the following lines to your `configuration.yaml`:
+
+```
+media_player:
+ platform: chromecast
+```
+
++Chromecasts have recently received a new API which is not yet supported by Home Assistant. Therefore we currently can only detect them and do not know what they are up to. +
diff --git a/source/components/media_player.markdown b/source/components/media_player.markdown index 6ff1f045e9a..10122393be5 100644 --- a/source/components/media_player.markdown +++ b/source/components/media_player.markdown @@ -9,16 +9,7 @@ sharing: true footer: true --- -Interacts with media players on your network. Currently only supports Chromecasts. These will be automatically discovered if you setup [the discovery component]({{site_root}}/components/discovery.html). Can also be forced to load by adding the following lines to your `configuration.yaml`: - -``` -media_player: - platform: chromecast -``` - --Chromecasts have recently received a new API which is not yet supported by Home Assistant. Therefore we currently can only detect them and do not know what they are up to. -
+Interacts with media players on your network. Currently only supports [Chromecasts](/components/media_player.cast.html). ## Services diff --git a/source/components/notify.pushbullet.markdown b/source/components/notify.pushbullet.markdown new file mode 100644 index 00000000000..d3d33ef872b --- /dev/null +++ b/source/components/notify.pushbullet.markdown @@ -0,0 +1,40 @@ +--- +layout: page +title: "Notifications" +description: "Instructions how to add user notifications to Home Assistant." +date: 2015-01-20 22:36 +sidebar: false +comments: false +sharing: true +footer: true +--- + +
+Home Assistant currently supports the awesome [PushBullet](https://www.pushbullet.com/), a free service to send information between your phones, browsers and friends.
+
+To add PushBullet to your installation, add the following to your `configuration.yaml` file:
+
+```
+notify:
+ platform: pushbullet
+ api_key: YOUR_API_KEY
+```
+
+### Automation example
+
+Notifications are great to be used within Home Automation. Below is a an example configuration that you can add to your `configuration.yaml` to be notified when the sun sets.
+
+```
+automation:
+ alias: Sun set notification
+
+ platform: state
+ state_entity_id: sun.sun
+ state_from: above_horizon
+ state_to: below_horizon
+
+ execute_service: notify.notify
+ service_data: {"message":"YAY"}
+```
+
+For more automation examples, see the [getting started with automation page]({{site_root}}/components/automation.html).
diff --git a/source/components/notify.pushover.markdown b/source/components/notify.pushover.markdown
new file mode 100644
index 00000000000..43615c38d30
--- /dev/null
+++ b/source/components/notify.pushover.markdown
@@ -0,0 +1,43 @@
+---
+layout: page
+title: "Notifications"
+description: "Instructions how to add user notifications to Home Assistant."
+date: 2015-01-20 22:36
+sidebar: false
+comments: false
+sharing: true
+footer: true
+---
+
+
+James Cole has contributed support for the PushOver service as a platform for the notify component. This allows components to send messages to the user using PushOver.
+
+```yaml
+# Example configuration.yaml entry
+notify:
+ platform: pushover
+ # Get this by registering a new application on https://pushover.net
+ api_key: ABCDEFGHJKLMNOPQRSTUVXYZ
+ # Get this by logging into your account on https://pushover.net
+ user_key: ABCDEFGHJKLMNOPQRSTUVXYZ
+```
+
+
+### Automation example
+
+Notifications are great to be used within Home Automation. Below is a an example configuration that you can add to your `configuration.yaml` to be notified when the sun sets.
+
+```
+automation:
+ alias: Sun set notification
+
+ platform: state
+ state_entity_id: sun.sun
+ state_from: above_horizon
+ state_to: below_horizon
+
+ execute_service: notify.notify
+ service_data: {"message":"YAY"}
+```
+
+For more automation examples, see the [getting started with automation page]({{site_root}}/components/automation.html).
diff --git a/source/components/scene.markdown b/source/components/scene.markdown
new file mode 100644
index 00000000000..5e58283eb39
--- /dev/null
+++ b/source/components/scene.markdown
@@ -0,0 +1,24 @@
+---
+layout: page
+title: "Scenes"
+description: "Instructions how to setup scenes within Home Assistant."
+date: 2015-03-23 19:59
+sidebar: false
+comments: false
+sharing: true
+footer: true
+---
+
+A user can create scenes that capture the states you want certain entities to be. For example a scene can contain that light A should be turned on and light B should be bright red. Deactivating a scene will restore the previous state from before the scene was activated. Just like scripts, scenes have their own separate page to see which scenes are on.
+
+```yaml
+# Example configuration.yaml entry
+scene:
+ - name: Romantic
+ entities:
+ light.tv_back_light: on
+ light.ceiling:
+ state: on
+ color: [0.33, 0.66]
+ brightness: 200
+```
diff --git a/source/components/scheduler.markdown b/source/components/scheduler.markdown
new file mode 100644
index 00000000000..be8a23338a2
--- /dev/null
+++ b/source/components/scheduler.markdown
@@ -0,0 +1,24 @@
+---
+layout: page
+title: "Scheduler"
+description: "Instructions how to setup the scheduler within Home Assistant."
+date: 2015-03-23 19:59
+sidebar: false
+comments: false
+sharing: true
+footer: true
+---
+
+A component that will act as a scheduler and performe actions based
+on the events in the schedule.
+
+It will read a json object from `schedule.json` in the config dir and create a schedule based on it.
+
+Each schedule is a JSON with the keys `id`, `name`, `description`, `entity_ids`, `events`.
+
+- days is an array with the weekday number (monday=0) that the schdule
+ is active
+- entity_ids an array with entity ids that the events in the schedule should
+ effect (can also be groups)
+- events is an array of objects that describe the different events that is
+ supported. Read in the events descriptions for more information
diff --git a/source/components/script.markdown b/source/components/script.markdown
new file mode 100644
index 00000000000..689bbfc936f
--- /dev/null
+++ b/source/components/script.markdown
@@ -0,0 +1,32 @@
+---
+layout: page
+title: "Scripts"
+description: "Instructions how to setup scripts within Home Assistant."
+date: 2015-03-23 19:59
+sidebar: false
+comments: false
+sharing: true
+footer: true
+---
+
+Andythigpen has contributed a script component. This allows users to create a sequence of service calls and delays. Scripts can be started using the service `script/turn_on` and interrupted using the service `script/turn_off`. A separate page has been added to the frontend to see the status of your scripts.
+
+```yaml
+# Example configuration.yaml entry
+script:
+ # Turns on the bedroom lights and then the living room lights 1 minute later
+ wakeup:
+ alias: Wake Up
+ sequence:
+ - alias: Bedroom lights on
+ execute_service: light.turn_on
+ service_data:
+ entity_id: group.bedroom
+ - delay:
+ # supports seconds, milliseconds, minutes, hours, etc.
+ minutes: 1
+ - alias: Living room lights on
+ execute_service: light.turn_on
+ service_data:
+ entity_id: group.living_room
+```
diff --git a/source/components/sensor.sabnzbd.markdown b/source/components/sensor.sabnzbd.markdown
new file mode 100644
index 00000000000..fc7911c3dbd
--- /dev/null
+++ b/source/components/sensor.sabnzbd.markdown
@@ -0,0 +1,31 @@
+---
+layout: page
+title: "SABnzbd support"
+description: "Instructions how to integrate SABnzbd within Home Assistant."
+date: 2015-03-23 19:59
+sidebar: false
+comments: false
+sharing: true
+footer: true
+---
+
+
+James Cole has contributed support to integrate SABnzbd. This will allow you to monitor your downloads from within Home Assistant and setup automation based on the information.
+
+```yaml
+# Example configuration.yaml entry
+sensor:
+ - platform: sabnzbd
+ name: SAB
+ api_key: YOUR_API_KEY
+ # Example: http://192.168.1.32:8124/
+ base_url: YOUR_SABNZBD_BASE_URL
+ monitored_variables:
+ - type: 'current_status'
+ - type: 'speed'
+ - type: 'queue_size'
+ - type: 'queue_remaining'
+ - type: 'disk_size'
+ - type: 'disk_free'
+```
+
diff --git a/source/components/sensor.systemmonitor.markdown b/source/components/sensor.systemmonitor.markdown
new file mode 100644
index 00000000000..92a24070722
--- /dev/null
+++ b/source/components/sensor.systemmonitor.markdown
@@ -0,0 +1,24 @@
+---
+layout: page
+title: "Monitor server resources"
+description: "Instructions how to integrate server resources within Home Assistant."
+date: 2015-03-23 19:59
+sidebar: false
+comments: false
+sharing: true
+footer: true
+---
+
+Theodor has contributed a new sensor platform to allow you to monitor disk usage, memory usage, CPU usage and running processes. This platform has superseded the process component which is now considered deprecated.
+
+```yaml
+# Example configuration.yaml entry
+sensor:
+ - platform: systemmonitor
+ resources:
+ - type: disk_use_percent
+ arg: /home
+ - type: memory_free
+ - type: process
+ arg: kodi
+```
diff --git a/source/components/switch.wemo.markdown b/source/components/switch.wemo.markdown
new file mode 100644
index 00000000000..543cc67a94e
--- /dev/null
+++ b/source/components/switch.wemo.markdown
@@ -0,0 +1,17 @@
+---
+layout: page
+title: "Belkin WeMo switches support"
+description: "Instructions how to integrate Belkin WeMo switches into Home Assistant."
+date: 2015-03-23 19:59
+sidebar: false
+comments: false
+sharing: true
+footer: true
+---
+
+
+
+```yaml
+switch:
+ platform: wemo
+```
diff --git a/source/components/thermostat.heat_control.markdown b/source/components/thermostat.heat_control.markdown
new file mode 100644
index 00000000000..1ad58b14259
--- /dev/null
+++ b/source/components/thermostat.heat_control.markdown
@@ -0,0 +1,57 @@
+---
+layout: page
+title: "Heat control"
+description: "Turn Home Assistant into a thermostat"
+date: 2015-03-23 19:59
+sidebar: false
+comments: false
+sharing: true
+footer: true
+---
+
+Specify a start time, end time and a target temperature.
+If the the current temperature is lower than the target temperature,
+and the time is between start time and end time, the heater will
+be turned on. Opposite if the the temperature is higher than the
+target temperature the heater will be turned off.
+
+If away mode is activated the target temperature is sat to a min
+temperature (min_temp in config). The min temperature is also used
+as target temperature when no other temperature is specified.
+
+If the heater is manually turned on, the target temperature will
+be sat to 100*C. Meaning
+the thermostat probably will never turn off the heater.
+If the heater is manually turned off, the target temperature will
+be sat according to normal rules. (Based on target temperature
+for given time intervals and the min temperature.)
+
+A target temperature sat with the set_temperature function will
+override all other rules for the target temperature.
+
+```yaml
+# Example configuration.yaml entry
+thermostat:
+ platform: heat_control
+ name: Stue
+
+ # entity_id for heater switch, must be a toggle device
+ heater: switch.Ovn_stue
+
+ # entity_id for temperature sensor, target_sensor.state must be temperature
+ target_sensor: tellstick_sensor.Stue_temperature
+
+ # start_time-end_time:target_temp,
+ time_temp: 0700-0745:17,1500-1850:20
+
+ # minimum temperature, used when away mode is active or
+ # no other temperature specified.
+ min_temp: 10
+```
+
+For the example the heater will turn on at 0700 if the temperature
+is lower than 17C away mode is false. Between 0700 and 0745 the
+target temperature will be 17C. Between 0745 and 1500 no temperature
+is specified. so the min_temp of 10C will be used. From 1500 to 1850
+the target temperature is 20, but if away mode is true the target
+temperature will be sat to 10C
diff --git a/source/components/thermostat.nest.markdown b/source/components/thermostat.nest.markdown
new file mode 100644
index 00000000000..225c3f29aa4
--- /dev/null
+++ b/source/components/thermostat.nest.markdown
@@ -0,0 +1,23 @@
+---
+layout: page
+title: "Nest thermostat support"
+description: "Instructions how to integrate Nest thermostats within Home Assistant."
+date: 2015-03-23 19:59
+sidebar: false
+comments: false
+sharing: true
+footer: true
+---
+
+To set it up, add the following information to your `configuration.yaml` file:
+
+```
+thermostat:
+ platform: nest
+ username: myemail@mydomain.com
+ password: mypassword
+```
+
+
+ 
+
+
+```
+# Example configuration.yaml entry
+sensor:
+ platform: vera
+ vera_controller_url: http://YOUR_VERA_IP:3480/
+ device_data:
+ 10:
+ name: Another sensor
+
+switch:
+ platform: vera
+ vera_controller_url: http://YOUR_VERA_IP:3480/
+ device_data:
+ 12:
+ name: Another Switch
+
+light:
+ platform: vera
+ vera_controller_url: http://YOUR_VERA_IP:3480/
+ device_data:
+ 11:
+ name: Another light
+```
diff --git a/source/components/zwave.markdown b/source/components/zwave.markdown
new file mode 100644
index 00000000000..bfcbbc28e31
--- /dev/null
+++ b/source/components/zwave.markdown
@@ -0,0 +1,33 @@
+---
+layout: page
+title: "Z-Wave support"
+description: "Instructions how to integrate your existing Z-Wave within Home Assistant."
+date: 2015-03-23 19:59
+sidebar: false
+comments: false
+sharing: true
+footer: true
+---
+
+
+
+Z-Wave support for Home Assistant is very new. We have started now by integrating only the sensors.
+
+Support for Z-Wave can be added by plugging a Z-Wave USB stick into your computer.
+
+To allow Home Assistant to talk to your Z-Wave USB stick you will have to compile `Python Open Z-Wave` yourself. We have made it easy and added a script that will do just that for you: `script/build_python_openzwave`.
+
+Please make sure you have the correct dependencies installed:
+
+```
+apt-get install cython3 libudev-dev python-sphinx python3-setuptools
+pip3 install cython
+```
+
+As an alternative, the Home Assistant docker image has support for Z-Wave built-in.
+
+```yaml
+# Example configuration.yaml entry
+zwave:
+ usb_path: /dev/ttyUSB0
+```
diff --git a/source/getting-started/configuration.markdown b/source/getting-started/configuration.markdown
index cc06fffcf0c..63c6bf29d47 100644
--- a/source/getting-started/configuration.markdown
+++ b/source/getting-started/configuration.markdown
@@ -41,6 +41,8 @@ Not all devices can be discovered, so if you have any of the following devices o
* [Device tracking]({{site_root}}/components/device_tracker.html)
* [Add support for your own device or service]({{site_root}}/developers/add_new_platform.html)
+See the [components overview page](/components/) for a complete list of supported devices.
+
### {% linkable_title Setting up Home Automation %}
When all your devices are set up it's time to put the cherry on the pie: automation. There are many ways to automate your home with Home Assistant so we have divided it into a couple of topics: