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, netgear and luci (OpenWRT). You can also decide to directly scan the network for devices by using the nmap scanner.
+ +To get started add the following lines to your configuration.yaml (example for Netgear):
1 2 @@ -109,32 +119,8 @@ 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.
-
Once tracking, the device_tracker component will maintain a file in your config dir called known_devices.csv. Edit this file to adjust which devices have to be tracked. Here you can also setup a url for each device to be used as the entity picture.
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).
1 -2 -3 - | |
+Before this scanner can be used you have to install the luci RPC package on OpenWRT: opkg install luci-mod-rpc.
1 +2 +3 +4 +5 +6 + | |
See the device tracker component page for instructions how to configure the people to be tracked.
+ + +
1 +2 +3 +4 +5 +6 + | |
See the device tracker component page for instructions how to configure the people to be tracked.
+ + +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).
1 +2 +3 +4 + | |
See the device tracker component page for instructions how to configure the people to be tracked.
+ + +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.
1 +2 +3 +4 +5 +6 +7 + | |
See the device tracker component page for instructions how to configure the people to be tracked.
+ + +Groups allow the user to combine multiple entities into 1. If all entities are switches or lights they can be controlled as one.
+ +1 +2 +3 +4 +5 +6 +7 +8 +9 +10 +11 + | |
This component will track everything that is going on within Home Assistant and allows the user to browse through it.
+ +1 +2 + | |
+
+ 
+
+
+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. +
+ + +The history is stored in a SQLite databse home-assistant.db within your config directory.
When the history component queries the states table it only selects states where the state has changed: WHERE last_changed=last_updated
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:
+ +1 +2 + | |
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.
-Entities are things that you want to observe within Home Assistant. Support for these things are provided by the entity components Light, Switch, Thermostat, Media player, Device tracker, Sun.
+ +| 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) | +
| Type | +Description | +
|---|---|
| Group | +Allows grouping of entities | +
| Scene | +Allow defining preferred state of a set of entities | +
Home Assistant integrates with a variety of third party Home Automation hubs and networks. It allows you to control the connected switches, lights and sensors via Home Assistant. Click on the following logo’s for setup instructions:
+ +
+
+
+
| + | 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 | +
| Type | +Description | +
|---|---|
| Automation | +Allow for automating service calls when a specific state is met | +
| Scheduler | +Allows for scheduling service calls when sun sets or it is specific time | +
| Script | +Allow user to define scripts to run from within Home Assistant | +
| Device sun light trigger | +Slowly fade in the lights to compensate the setting sun. Also turns on lights when you get home after dark. | +
| Simple alarm | +Let the lights blink red when the lights turn on while no one is home. | +
| Type | +Description | +
|---|---|
| Configurator | +Component used by other components to get configuration from the user. | +
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.
+ +If you want to enable the light component directly, add the following lines to your configuration.yaml:
1 +2 + | |
+Google Cast devices will be automatically discovered if you enable the discovery component.
Can also be forced to load by adding the following lines to your configuration.yaml:
1 +2 + | |
+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. These will be automatically discovered if you setup the discovery component. Can also be forced to load by adding the following lines to your configuration.yaml:
1 -2 - | |
-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.
+Home Assistant currently supports the awesome PushBullet, 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:
1 +2 +3 + | |
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.
1 +2 +3 +4 +5 +6 +7 +8 +9 +10 + | |
For more automation examples, see the getting started with automation page.
+ + +
+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.
1 +2 +3 +4 +5 +6 +7 + | |
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.
1 +2 +3 +4 +5 +6 +7 +8 +9 +10 + | |
For more automation examples, see the getting started with automation page.
+ + +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.
+ +1 +2 +3 +4 +5 +6 +7 +8 +9 + | |
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.
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.
1 +2 +3 +4 +5 +6 +7 +8 +9 +10 +11 +12 +13 +14 +15 +16 +17 + | |
+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.
1 +2 +3 +4 +5 +6 +7 +8 +9 +10 +11 +12 +13 +14 + | |
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.
+ +1 +2 +3 +4 +5 +6 +7 +8 +9 + | |
1 +2 + | |
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.
+ +1 +2 +3 +4 +5 +6 +7 +8 +9 +10 +11 +12 +13 +14 +15 +16 +17 + | |
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
+ + +To set it up, add the following information to your configuration.yaml file:
1 +2 +3 +4 + | |
+ 
+
1 +2 +3 +4 +5 +6 +7 +8 +9 +10 +11 +12 +13 +14 +15 +16 +17 +18 +19 +20 +21 + | |
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:
+ +1 +2 + | |
As an alternative, the Home Assistant docker image has support for Z-Wave built-in.
+ +1 +2 +3 + | |
See the components overview page for a complete list of supported devices.
+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:
diff --git a/getting-started/index.html b/getting-started/index.html index dead7ff22a..fa538017a6 100644 --- a/getting-started/index.html +++ b/getting-started/index.html @@ -50,7 +50,15 @@-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.
@@ -144,8 +150,12 @@ Home Assistant will track the state of all the devices in your home, so you don&
+
Home Assistant
+