- 2015-09-01T02:02:41-07:00
+ 2015-09-10T12:38:32-07:00https://home-assistant.io/
@@ -16,7 +16,7 @@
- 2015-08-31T22:12:00-07:00
+ 2015-08-31T14:12:00-07:00https://home-assistant.io/blog/2015/08/31/version-7-revamped-ui-and-improved-distributionAs Home Assistant is gaining more and more users we started to feel the pain from not having a
proper release mechanism. We had no version numbering and required users to checkout the source
diff --git a/blog/2015/08/31/version-7-revamped-ui-and-improved-distribution/index.html b/blog/2015/08/31/version-7-revamped-ui-and-improved-distribution/index.html
index 952dbc16f9..e3baa78fac 100644
--- a/blog/2015/08/31/version-7-revamped-ui-and-improved-distribution/index.html
+++ b/blog/2015/08/31/version-7-revamped-ui-and-improved-distribution/index.html
@@ -113,7 +113,7 @@
-
+
@@ -127,7 +127,7 @@
diff --git a/blog/categories/architecture/atom.xml b/blog/categories/architecture/atom.xml
index 2ad0c34f46..3a2b490735 100644
--- a/blog/categories/architecture/atom.xml
+++ b/blog/categories/architecture/atom.xml
@@ -4,7 +4,7 @@
- 2015-09-01T02:02:41-07:00
+ 2015-09-10T12:38:32-07:00https://home-assistant.io/
diff --git a/blog/categories/branding/atom.xml b/blog/categories/branding/atom.xml
index 4d31746370..9d587f10d0 100644
--- a/blog/categories/branding/atom.xml
+++ b/blog/categories/branding/atom.xml
@@ -4,7 +4,7 @@
- 2015-09-01T02:02:41-07:00
+ 2015-09-10T12:38:32-07:00https://home-assistant.io/
diff --git a/blog/categories/component/atom.xml b/blog/categories/component/atom.xml
index 1bb4039732..4fc8cf24a0 100644
--- a/blog/categories/component/atom.xml
+++ b/blog/categories/component/atom.xml
@@ -4,7 +4,7 @@
- 2015-09-01T02:02:41-07:00
+ 2015-09-10T12:38:32-07:00https://home-assistant.io/
diff --git a/blog/categories/core/atom.xml b/blog/categories/core/atom.xml
index 6ccdeaea6b..4ac6d9c348 100644
--- a/blog/categories/core/atom.xml
+++ b/blog/categories/core/atom.xml
@@ -4,7 +4,7 @@
- 2015-09-01T02:02:41-07:00
+ 2015-09-10T12:38:32-07:00https://home-assistant.io/
diff --git a/blog/categories/frontend/atom.xml b/blog/categories/frontend/atom.xml
index 78b42f4f8f..67d448d45f 100644
--- a/blog/categories/frontend/atom.xml
+++ b/blog/categories/frontend/atom.xml
@@ -4,7 +4,7 @@
- 2015-09-01T02:02:41-07:00
+ 2015-09-10T12:38:32-07:00https://home-assistant.io/
diff --git a/blog/categories/release-notes/atom.xml b/blog/categories/release-notes/atom.xml
index ca487f0527..5a6978ad5f 100644
--- a/blog/categories/release-notes/atom.xml
+++ b/blog/categories/release-notes/atom.xml
@@ -4,7 +4,7 @@
- 2015-09-01T02:02:41-07:00
+ 2015-09-10T12:38:32-07:00https://home-assistant.io/
@@ -13,135 +13,6 @@
Octopress
-
-
-
- 2015-08-31T22:12:00-07:00
- https://home-assistant.io/blog/2015/08/31/version-7-revamped-ui-and-improved-distribution
- As Home Assistant is gaining more and more users we started to feel the pain from not having a
-proper release mechanism. We had no version numbering and required users to checkout the source
-using Git to get started. On top of that, as the number of devices that we support keeps raising, so
-did the number of dependencies that are used. That’s why we decided to change the way we roll. From
-now on:
-
-
-
Each release will have a version number, starting with version 0.7. This was chosen because it
-shows that we have been around for some time but are not considering ourselves to be fully
-stable.
-
Each release will be pushed to PyPi. This will be the only supported method of distribution.
-
Home Assistant is available after installation as a command-line utility hass.
-
The default configuration location has been moved from config in the current working directory
-to ~/.homeassistant (%APPDATA%/.homeassistant on Windows).
-
Requirements for components and platforms are no longer installed into the current Python
-environment (being virtual or not) but will be installed in <config-dir>/lib.
-
-
-
-
A huge shout out to Ryan Kraus for making this all possible. Please
-make sure you read the full blog post for details on how to migrate your existing setup.
-
-
And while Ryan was fixing distribution, I have been hard at work in giving Home Assistant a face
-lift. We already looked pretty good but lacked proper form of organization for users with many
-devices. The new UI moves away from a card per entity and has cards per group and domain instead.
-The demo has been updated so give it a spin.
It If you want to have the configuration in a different location, for example
-/home/paulus/home-assistant-config, you will have to point Home Assistant at this configuration
-folder when launching:
MQTT Sensors and Switches
-
-@sfam has blessed us with two more MQTT platforms to extend our
-integration with MQTTT: sensor and switch. Both platforms require the
-MQTT component to be connected to a broker.
DHT temperature and humidty sensors
-@MakeMeASandwich has contributed support for DHT temperature
-and humidity sensors. It allows you to get the current temperature and humidity from a DHT11, DHT22,
-or AM2302 device.
-]]>
-
-
@@ -576,6 +447,124 @@ switch:
username: YOUR_USERNAME
password: YOUR_PASSWORD
+]]>
+
+
+
+
+
+ 2015-05-14T22:25:00-07:00
+ https://home-assistant.io/blog/2015/05/14/release-notes
+ Almost three busy weeks have past since the last release. We used this time to finally make the overhaul to use UTC as the internal date time format. We added a bunch of test coverage in the process to make sure the transition went smoothly. Pleas see the blog post about the UTC refactor for backwards incompatible changes.
+
+
This release includes a significant startup boost for the frontend and a fix for Wemo discovery after their latest firmware upgrade.
+
+
I would like to give a big shout out to our newest contributor fabaff for taking the time to improve the documentation.
+
+
+To update to the latest version, run scripts/update. Please report any issues on GitHub.
+
+
+
+
+
+
+
+
+
Overwriting Entity Attributes
+Before diving into the newly supported devices and services, I want to highlight an awesome configuration enhancement by rmkraus: overwriting entity attributes.
+
+
These new configuration settings allow you to overwrite entity state attributes. The main usage for this is being able to overwrite attributes that influence how an entity is shown in the interface.
+
+
# Example configuration.yaml entry
+homeassistant:
+ customize:
+ light.bowl:
+ # hides this entity from the interface
+ hidden: true
+ light.ceiling:
+ # Replaces the state badge with given picture
+ entity_picture: http://graph.facebook.com/schoutsen/picture
+
InstaPush
+
+Fabaff has contributed support for InstaPush. This will allow you send messages from Home Assistant to your iOS and Android devices.
+
+
# Example configuration.yaml entry
+notify:
+ platform: instapush
+ # Get those by creating a new application, event, and tracker on https://instapush.im
+ api_key: ABCDEFGHJKLMNOPQRSTUVXYZ
+ app_secret: ABCDEFGHJKLMNOPQRSTUVXYZ
+ event: ABCDEFGHJKLMNOPQRSTUVXYZ
+ tracker: ABCDEFGHJKLMNOPQRSTUVXYZ
+
+
+
XMPP
+
+Fabaff has contributed support for Jabber/XMPP. This will allow you send messages from Home Assistant to anyone on Jabber/XMPP.
Notify My Android
+
+Fabaff has contributed support for Notify My Android. This will allow you to send messages from Home Assistant to your Android device.
+
+
# Example configuration.yaml entry
+notify:
+ platform: nma
+ # Get this by registering a new application on http://www.notifymyandroid.com/
+ api_key: ABCDEFGHJKLMNOPQRSTUVXYZ
+
+
+
Time & Date sensor
+Fabaff has contributed a time & date sensor. This will allow you to show the current time/date on the dashboard.
diff --git a/blog/categories/user-stories/atom.xml b/blog/categories/user-stories/atom.xml
index 0a58e6a453..1afedbe207 100644
--- a/blog/categories/user-stories/atom.xml
+++ b/blog/categories/user-stories/atom.xml
@@ -4,7 +4,7 @@
- 2015-09-01T02:02:41-07:00
+ 2015-09-10T12:38:32-07:00https://home-assistant.io/
@@ -13,6 +13,135 @@
Octopress
+
+
+
+ 2015-08-31T14:12:00-07:00
+ https://home-assistant.io/blog/2015/08/31/version-7-revamped-ui-and-improved-distribution
+ As Home Assistant is gaining more and more users we started to feel the pain from not having a
+proper release mechanism. We had no version numbering and required users to checkout the source
+using Git to get started. On top of that, as the number of devices that we support keeps raising, so
+did the number of dependencies that are used. That’s why we decided to change the way we roll. From
+now on:
+
+
+
Each release will have a version number, starting with version 0.7. This was chosen because it
+shows that we have been around for some time but are not considering ourselves to be fully
+stable.
+
Each release will be pushed to PyPi. This will be the only supported method of distribution.
+
Home Assistant is available after installation as a command-line utility hass.
+
The default configuration location has been moved from config in the current working directory
+to ~/.homeassistant (%APPDATA%/.homeassistant on Windows).
+
Requirements for components and platforms are no longer installed into the current Python
+environment (being virtual or not) but will be installed in <config-dir>/lib.
+
+
+
+
A huge shout out to Ryan Kraus for making this all possible. Please
+make sure you read the full blog post for details on how to migrate your existing setup.
+
+
And while Ryan was fixing distribution, I have been hard at work in giving Home Assistant a face
+lift. We already looked pretty good but lacked proper form of organization for users with many
+devices. The new UI moves away from a card per entity and has cards per group and domain instead.
+The demo has been updated so give it a spin.
It If you want to have the configuration in a different location, for example
+/home/paulus/home-assistant-config, you will have to point Home Assistant at this configuration
+folder when launching:
MQTT Sensors and Switches
+
+@sfam has blessed us with two more MQTT platforms to extend our
+integration with MQTTT: sensor and switch. Both platforms require the
+MQTT component to be connected to a broker.
DHT temperature and humidty sensors
+@MakeMeASandwich has contributed support for DHT temperature
+and humidity sensors. It allows you to get the current temperature and humidity from a DHT11, DHT22,
+or AM2302 device.
The port where is your board connected to your Home Assistant host. If you are using an original Arduino the port will be named ttyACM*. The exact
-number can be determined with ls /dev/ttyACM*.
+
Configuration variables:
+
+
+
port (Required): The port where your board is connected to your Home Assistant host. If you are using an original Arduino the port will be named ttyACM*. The exact number can be determined with ls /dev/ttyACM*.
+
+
1
ls /dev/ttyACM*
@@ -171,9 +175,20 @@ A word of caution: The Arduino boards are not storing states. This means that wi
-
The digital pins are numbered from 0 to 13. The available pins are 2 till 13. For testing purposes you can use pin 13 because with that pin you can control the internal LED.
+
Configuration variables:
-
The name field of the pins array will be used in the frontend.
+
+
pins array (Required): Pins to use.
+
+
+
name: Name that will be used in the frontend for the pin.
+
type: The type of the pin. At the moment only ‘digital’ is supported.
+
+
+
+
+
+
The digital pins are numbered from 0 to 13. The available pins are 2 till 13. For testing purposes you can use pin 13 because with that pin you can control the internal LED.
Sensor Configuration
@@ -204,9 +219,20 @@ A word of caution: The Arduino boards are not storing states. This means that wi
-
The 6 analog pins are numbered from A0 to A5.
+
Configuration variables:
-
The name field of the pins array will be used in the frontend.
+
+
pins array (Required): Pins to use.
+
+
+
name: Name that will be used in the frontend for the pin.
+
type: The type of the pin. At the moment only ‘analog’ is supported.
Home Assistant will serve the images via its server, making it possible to view your IP camera’s while outside of your network.
+
To enable this sensor in your installation, add the following to your configuration.yaml file:
+
123
@@ -120,13 +122,23 @@
# Example configuration.yaml entrycamera:platform:generic
-name:my sample camera
-username:MY_USERNAME
-password:MY_PASSWORDstill_image_url:http://194.218.96.92/jpg/image.jpg
+name:my sample camera
+username:USERNAME
+password:PASSWORD
This platform allows you to detect presence by looking at connected devices to an Actiontec device.
-
Supported devices:
-- MI424WR (Verizon FIOS)
+
Supported devices (tested):
+
+
+
MI424WR (Verizon FIOS)
+
+
This device tracker needs telnet to be enabled on the router.
@@ -123,15 +127,27 @@ This device tracker needs telnet to be enabled on the router.
456
+7
# Example configuration.yaml entrydevice_tracker:platform:actiontechost:YOUR_ROUTER_IPusername:YOUR_ADMIN_USERNAMEpassword:YOUR_ADMIN_PASSWORD
+home_interval:MINUTES
+
Configuration variables:
+
+
+
host (Required): The IP address of your router, e.g. 192.168.1.1.
+
username (Required: The username of an user with administrative privileges, usually admin.
+
password (Required): The password for your given admin account.
+
home_interval (Optional): If the home_interval is set then the component will not let a device be AWAY if it has been HOME in the last home_interval minutes. This is in addition to the 3 minute wait built into the device_tracker component.
diff --git a/components/device_tracker.ddwrt.html b/components/device_tracker.ddwrt.html
index a06d3401a4..9d237a76f9 100644
--- a/components/device_tracker.ddwrt.html
+++ b/components/device_tracker.ddwrt.html
@@ -118,12 +118,21 @@ This platform offers presence detection by looking at connected devices to a
# Example configuration.yaml entrydevice_tracker:platform:ddwrt
-host:192.168.1.1
-username:admin
-password:PASSWORD
+host:ROUTER_IP_ADDRESS
+username:YOUR_ADMIN_USERNAME
+password:YOUR_ADMIN_PASSWORD
+
Configuration variables:
+
+
+
host (Required): The IP address of your router, e.g. 192.168.1.1.
+
username (Required: The username of an user with administrative privileges, usually admin.
+
password (Required): The password for your given admin account.
Home Assistant can get information from your wireless router to track which devices are connected. There are three different types of supported wireless routers:
# Example configuration.yaml entry for Netgear device
+device_tracker:
+platform:netgear
+host:192.168.1.1
+username:admin
+password:YOUR_PASSWORD
+
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.
diff --git a/components/device_tracker.luci.html b/components/device_tracker.luci.html
index 8311992653..3c4ad0d887 100644
--- a/components/device_tracker.luci.html
+++ b/components/device_tracker.luci.html
@@ -116,12 +116,21 @@ Before this scanner can be used you have to install the luci RPC package on Open
# Example configuration.yaml entrydevice_tracker:platform:luci
-host:192.168.1.1
-username:admin
-password:PASSWORD
+host:ROUTER_IP_ADDRESS
+username:YOUR_ADMIN_USERNAME
+password:YOUR_ADMIN_PASSWORD
+
Configuration variables:
+
+
+
host (Required): The IP address of your router, e.g. 192.168.1.1.
+
username (Required: The username of an user with administrative privileges, usually admin.
+
password (Required): The password for your given admin account.
diff --git a/components/device_tracker.netgear.html b/components/device_tracker.netgear.html
index 8240a1112d..684163aba0 100644
--- a/components/device_tracker.netgear.html
+++ b/components/device_tracker.netgear.html
@@ -116,12 +116,21 @@ This platform allows you to detect presence by looking at connected devices to a
# Example configuration.yaml entrydevice_tracker:platform:netgear
-host:192.168.1.1
-username:admin
-password:PASSWORD
+host:YOUR_ROUTER_IP
+username:YOUR_ADMIN_USERNAME
+password:YOUR_ADMIN_PASSWORD
+
Configuration variables:
+
+
+
host (Required): The IP address of your router, e.g. 192.168.1.1.
+
username (Required: The username of an user with administrative privileges, usually admin.
+
password (Required): The password for your given admin account.
diff --git a/components/device_tracker.tomato.html b/components/device_tracker.tomato.html
index a863648e1e..f5a6fd6e36 100644
--- a/components/device_tracker.tomato.html
+++ b/components/device_tracker.tomato.html
@@ -117,13 +117,23 @@ Tomato requires an extra config variable called http_id. The value
diff --git a/components/device_tracker.tplink.html b/components/device_tracker.tplink.html
index 7380966ffb..44493b5bc1 100644
--- a/components/device_tracker.tplink.html
+++ b/components/device_tracker.tplink.html
@@ -122,6 +122,15 @@ This platform allows you to detect presence by looking at connected devices to a
+
Configuration variables:
+
+
+
host (Required): The IP address of your router, e.g. 192.168.1.1.
+
username (Required: The username of an user with administrative privileges, usually admin.
+
password (Required): The password for your given admin account.
diff --git a/components/discovery.html b/components/discovery.html
index de038f00d3..42ff345ee7 100644
--- a/components/discovery.html
+++ b/components/discovery.html
@@ -125,6 +125,11 @@ Home Assistant can discover and automatically configure zeroconf/mDNS and uPnP d
+IFTTT is a web service that allows users to create chains of simple conditional statements, so called “recipes”. With the ifttt component you can trigger recipes through the “maker” channel.
+
+
1
+2
+3
+
# Example configuration.yaml entry
+ifttt:
+key:xxxxx-x-xxxxxxxxxxxxx
+
+
+
+
Key is your API key which can be obtained by viewing the properties of the Maker Channel.
+
+
+
+Property screen of the Maker Channel
+
+
+
+
Once you have added your key to configuration.yaml, restart your Home Assistant server. This will load up the IFTTT component and make a service available to trigger events in IFTTT.
+
+
+After restarting the server, be sure to watch the console for any logging errors that show up in red, white or yellow.
+
+
+
+
Testing your trigger
+
+
You can use the developer tools to test your Maker Channel trigger. To do this, open the Home Assistant UI, open the sidebar, click on the first icon in the developer tools. This should get you to the ‘Call Service’ screen. Fill in the following values:
+
+
+
+
+
Field
+
Value
+
+
+
+
+
domain
+
ifttt
+
+
+
service
+
trigger
+
+
+
Service Data
+
{"event": "EventName", "value1": "Hello World"}
+
+
+
+
+
+
+
+When your screen looks like this, click the ‘call service’ button.
+
+
+
+
Setting up a recipe
+
+
+
+You need to setup a unique trigger for each event you sent to IFTTT.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/components/index.html b/components/index.html
index 77daaee3be..648365b4ce 100644
--- a/components/index.html
+++ b/components/index.html
@@ -165,7 +165,7 @@
diff --git a/components/isy994.html b/components/isy994.html
index 2f6c6977d1..56d7aa06e6 100644
--- a/components/isy994.html
+++ b/components/isy994.html
@@ -116,8 +116,7 @@ Devices.
that is configured on the controller. Using the programs on the controller,
custom switches and sensors can also be created.
-
To integrate your ISY994 controller with Home Assistant, add the following
-section to your configuration.yaml file:
+
To integrate your ISY994 controller with Home Assistant, add the following section to your configuration.yaml file:
12
@@ -127,46 +126,34 @@ section to your configuration.yaml file:
678
-9
-10
-11
The ISY_USERNAME and ISY_PASSWORD are the configured username and password used
-to access the ISY interface.
-
-
The SENSOR_STRING is a string that is used to identify which devices are to be
-assumed to be sensors instead of lights of switches. By default, this string is
-‘Sensor’. If this string is found in the device name, Home Assistant will
-assume it is as a sensor.
-
-
The HIDDEN_STRING is a string that is used to identify which devices are to be
+
username (Required): The username that used to access the ISY interface.
+
password (Required): The password that used to access the ISY interface.
+
sensor_string (Optional): This is the string that is used to identify which devices are to be assumed to be sensors instead of lights of switches. By default, this string is ‘Sensor’. If this string is found in the device name, Home Assistant will
+assume it is as a sensor.
+
hidden_string (Optional): The HIDDEN_STRING is a string that is used to identify which devices are to be
hidden on Home Assistant’s front page. This string will be stripped from the
-device’s name before being used. By default, this value is ‘{HIDE ME}’.
+device’s name before being used. By default, this value is ‘{HIDE ME}’.
+
tls (Optional): This entry should refelct the version of TLS that the ISY controller is using for HTTPS encryption. This value can be either 1.1 or 1.2. If this value is not set, it is assumed to be version 1.1. This is the default for most users.
+ISY994 Pro users may likely be using 1.2. When using HTTPS in the host entry, it is best practice to set this value.
+
-
The TLS_VERSION value is the version of TLS that the ISY controller is using
-for HTTPS encryption. This value can be either 1.1 or 1.2. If this value is not
-set, it is assumed to be version 1.1. This is the default for most users.
-ISY994 Pro users may likely be using 1.2. When using HTTPS in the ISY_ADDRESS
-string, it is best practice to set this value.
-
Once the ISY controller is configured, it will automatically import any lights,
-switches, and sensors it can locate.
+
Once the ISY controller is configured, it will automatically import any lights, switches, and sensors it can locate.
Creating Custom Switches
diff --git a/components/keyboard.html b/components/keyboard.html
index 3b10f08f66..99252864c1 100644
--- a/components/keyboard.html
+++ b/components/keyboard.html
@@ -123,6 +123,20 @@ The keyboard component simulates key presses on the host machine. I
keyboard:
+
Dependencies
+
+
You may need to install platform-specific dependencies for PyUserInput in order to use the keyboard component. In most cases this can be done by running:
+
+
1
+
pip3 install [package name]
+
+
+
Windows
+
+
x64 Windows users may have trouble installing pywin through pip. Using an executable installer should work around this issue.
+
+
Similar installers (unofficial) for pyhook have been ported to python 3.4 and should help with x64 pip issues with pyhook.
+
diff --git a/components/light.limitlessled.html b/components/light.limitlessled.html
index 4f68c02723..34f81ed273 100644
--- a/components/light.limitlessled.html
+++ b/components/light.limitlessled.html
@@ -120,13 +120,21 @@ The limitlessled can control your Limitle
host (Required): IP address of the device, eg. 192.168.1.32
+
group_X_name (Required): Name of the group. Multiple entries with a consecutive number.
+
+
+
diff --git a/components/media_player.cast.html b/components/media_player.cast.html
index 71d8928318..518e26b4f2 100644
--- a/components/media_player.cast.html
+++ b/components/media_player.cast.html
@@ -109,14 +109,22 @@ Google Cast devices will be automatically discovered if you enable
1
+
1234
-
media_player:
- platform: chromecast
- # Optional. Will scan for devices if left out
- host: 192.168.1.9
+
# Example configuration.yaml entry
+media_player:
+platform:chromecast
+host:192.168.1.9
+
+
+
+
Configuration variables:
+
+
+
hostOptional: Use only if you don’t want to scan for devices.
diff --git a/components/media_player.kodi.html b/components/media_player.kodi.html
index b78ecda498..b0910ca396 100644
--- a/components/media_player.kodi.html
+++ b/components/media_player.kodi.html
@@ -119,12 +119,20 @@ The kodi platform allows you to control a Kodi mul
nameOptional: The name of the device used in the frontend.
+
usernameOptional: The XBMC/Kodi HTTP username.
+
passwordOptional: The XBMC/Kodi HTTP password.
+
diff --git a/components/media_player.mpd.html b/components/media_player.mpd.html
index e760d79c7c..22cf6bba72 100644
--- a/components/media_player.mpd.html
+++ b/components/media_player.mpd.html
@@ -115,14 +115,24 @@ The mpd platform allows you to control a Music
456
+7
+The arest sensor platform allows you to get all data from your devices (like Arduinos with a ethernet/wifi connection, the ESP8266, and the Raspberry Pi) running the aREST RESTful framework.
+
+
To use your aREST enabled device in your installation, add the following to your configuration.yaml file:
resource (Required): IP address and schema of the device that is exposing an aREST API, e.g. http://192.168.1.10.
+
monitored_variables array:
+
+
+
name (Required): The name of the variable you wish to monitor.
+
unit (Optional): Defines the units of measurement of the sensor, if any.
+
+
+
+
+
+
The variables in the monitored_variables array must be available in the response of the device. As a starting point you find below a sketch for the Arduino device family. There are two variables (temperature and humidity) which will act as endpoints.
/*
+ This modified sketch is based on the Ethernet example of the aREST
+ (http://arest.io/) library.
+*/
+
+// Libraries
+#include <SPI.h>
+#include <Ethernet.h>
+#include <aREST.h>
+#include <avr/wdt.h>
+
+// Device settings
+char*deviceId="sensor02";
+char*deviceName="livingroom";
+bytedeviceMac[]={0x20,0xD5,0xD3,0x03,0xFE,0x31};
+IPAddressdeviceIp(192,168,1,12);
+
+EthernetServerserver(80);
+aRESTrest=aREST();
+
+// Variables to be exposed to the API
+inttemperature;
+inthumidity;
+
+voidsetup(void){
+Serial.begin(57600);
+
+// Init variables and expose them to REST API
+temperature=0;
+humidity=0;
+
+rest.variable("temperature",&temperature);
+rest.variable("humidity",&humidity);
+
+// Give name and ID to device
+rest.set_id(deviceId);
+rest.set_name(deviceName);
+
+Ethernet.begin(deviceMac,deviceIp);
+
+server.begin();
+Serial.print("Sensor is ready...");
+
+// Start watchdog
+wdt_enable(WDTO_4S);
+}
+
+voidloop(){
+EthernetClientclient=server.available();
+rest.handle(client);
+wdt_reset();
+
+// Replace this with your actual sensor readings, like
+// temperature = (((analogRead(A0) * 5.0) / 1024) - 0.5) * 10;
+temperature=random(400);
+humidity=random(600);
+delay(500);
+}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/components/sensor.bitcoin.html b/components/sensor.bitcoin.html
index 788bc248a2..1f59797d1c 100644
--- a/components/sensor.bitcoin.html
+++ b/components/sensor.bitcoin.html
@@ -109,6 +109,8 @@ The bitcoin platform displays various details about the Blockchain.info the sensor is capable to show your current balance.
+
You need to enable the API access for your online wallet to get the balance. To do that log in and move to ‘Account Setting’, choose ‘IP Restrictions’, and check ‘Enable Api Access’. You will get an email message from blockchain.info where you must authorize the API access.
+
To add the Bitcoin sensor to your installation, add a selection of the available display options to your configuration.yaml file:
1
@@ -170,6 +172,39 @@ The bitcoin platform displays various details about the https://blockchain.info to access the online wallet.
+
password (Optional): Password for your online wallet.
+
currency (Optional): The currency to exchange to, eg. CHF, USD, EUR, etc. Default is USD.
+
display_options array (Required): Options to display in the frontend.
+
+
+
exchangerate: Exchange rate of 1 BTC
+
trade_volume_btc: Trade volume
+
miners_revenue_usd: Miners revenue
+
btc_mined: BTC mined
+
trade_volume_usd: Trade volume in USD
+
difficulty: Difficulty
+
minutes_between_blocks: Time between blocks in minutes
+
number_of_transactions: Number of transactions
+
hash_rate: Hash rate in PH/s
+
timestamp: Timestamp
+
mined_blocks: Minded Blocks
+
blocks_size: Block size
+
total_fees_btc: Total fees in BTC
+
total_btc_sent: Total sent in BTC
+
estimated_btc_sent: Estimated sent in BTC
+
total_btc: Total of BTC
+
total_blocks: Total Blocks
+
next_retarget: Next retarget
+
estimated_transaction_volume_usd: Estimated transaction volume in BTC
The dht sensor platform allows you to get the current temperature and humidity from a DHT11, DHT22, or AM2302 device.
+
+The dht sensor platform allows you to get the current temperature and humidity from a DHT11, DHT22, or AM2302 device.
To use your DHTxx sensor in your installation, add the following to your configuration.yaml file:
@@ -127,6 +128,23 @@
+
Configuration variables:
+
+
+
sensor (Required): The sensor type, supported devices are DHT11, DHT22, and AM2302
+
pin (Required): The pin the sensor is connected to.
+
monitored_conditions array: Conditions to monitor.
+
+
+
temperature:
+
humidity:
+
+
+
+
+
+
Available conditions are only temperature and humidity.
+
The name of the pin to which the sensor is connected has different names on different platforms. ‘P8_11’ for Beaglebone, ‘23’ for Raspberry Pi.
diff --git a/components/sensor.efergy.html b/components/sensor.efergy.html
index a51d55b864..9062a4a95d 100644
--- a/components/sensor.efergy.html
+++ b/components/sensor.efergy.html
@@ -132,6 +132,23 @@ Integrate your Efergy meter information into Ho
+
Configuration variables:
+
+
+
app_token (Required): The App Token for your account.
+
utc_offset (Required): Some variables (currently only the daily_cost) require that the
+negative number of minutes your timezone is ahead/behind UTC time.
+
monitored_variables array (Required): Variables to monitor.
+
+
+
type (Required): Name of the variable.
+
period (Optional): Some variables take a period argument. Valid options are “day”, “week”, “month”, and “year”.
+
currency (Optional): This is used to display the cost/period as the unit when monitoring the cost. It should correspond to the actual currency used in your dashboard.
The forecast platform uses the Forecast.io web service as a source for meteorological data for your location.
-
You need an API key which is free but requires a registration.
+
You need an API key which is free but requires a registration. You can make 1000 requests per day. This means that you could create approximately every 1.4 minute one.
To add Forecast.io to your installation, add the following to your configuration.yaml file:
@@ -148,7 +148,31 @@ The forecast platform uses the Forecast.io we
-
diff --git a/components/sensor.mqtt.html b/components/sensor.mqtt.html
index 5de787bd75..b1e5602d5d 100644
--- a/components/sensor.mqtt.html
+++ b/components/sensor.mqtt.html
@@ -116,20 +116,26 @@ last known value. Otherwise, the initial state will be undefined.
456
+7
# Example configuration.yml entrysensor:platform:mqtt
-name:"MQTTSensor"state_topic:"home/bedroom/temperature"
-unit_of_measurement:"ºC"
+name:"MQTTSensor"
+qos:0
+unit_of_measurement:"°C"
-
state_topic: The MQTT topic subscribed to receive sensor values. Required
+
Configuration variables:
-
name: The name of the sensor. Default is ‘MQTT Sensor’. Optional
+
+
state_topic (Required): The MQTT topic subscribed to receive sensor values.
+
name (Optional): The name of the sensor. Default is ‘MQTT Sensor’.
+
qos (Optional): The maximum QoS level of the state topic. Default is 0.
+
unit_of_measurement (Optional): Defines the units of measurement of the sensor, if any.
+
-
unit_of_measurement: Defines the units of measurement of the sensor, if any. Optional
port (Required): The port where your board is connected to your Home Assistant host. If you are using an original Arduino the port will be named ttyACM*. The exact number can be determined with ls /dev/ttyACM*.
# Example configuration.yaml entrysensor:
--platform:rfxtrx
-device:PATH_TO_DEVICE
+platform:rfxtrx
+device:PATH_TO_DEVICE
-
The path to your device, e.g. /dev/serial/by-id/usb-RFXCOM_RFXtrx433_A1Y0NJGR-if00-port0
+
Configuration variables:
+
+
+
device (Required): The path to your device, e.g. /dev/serial/by-id/usb-RFXCOM_RFXtrx433_A1Y0NJGR-if00-port0
+
+
diff --git a/components/sensor.swiss_public_transport.html b/components/sensor.swiss_public_transport.html
index 15d741ca29..7b140ce11c 100644
--- a/components/sensor.swiss_public_transport.html
+++ b/components/sensor.swiss_public_transport.html
@@ -126,6 +126,14 @@ The swiss public transport sensor will give you the next two departure times fro
+
Configuration variables:
+
+
+
from (Required): The ID of the station of the start station.
+
to (Required): The ID of the station of the end station.
diff --git a/components/sensor.systemmonitor.html b/components/sensor.systemmonitor.html
index 5ed0406a24..2770913854 100644
--- a/components/sensor.systemmonitor.html
+++ b/components/sensor.systemmonitor.html
@@ -128,6 +128,19 @@ The system monitoring sensor platform to allow you to monitor disk usage, memory
+
Configuration variables:
+
+
+
resources array (Required): Contains all entries to display.
+
+
+
type (Required): The type of the information to display, please check the table below for details.
+
arg (Optional): Argument to use, please check the table below for details.
+
+
+
+
+
The table contains types and their argument to use in your configuration.yaml file.
diff --git a/components/sensor.transmission.html b/components/sensor.transmission.html
index e04873ec96..c1d2e8c91a 100644
--- a/components/sensor.transmission.html
+++ b/components/sensor.transmission.html
@@ -122,22 +122,41 @@ The Transmission platform allows yo
host (Required): This is the IP address of your Transmission daemon, e.g. 192.168.1.32.
+
port (Optional): The port your Transmission daemon uses, defaults to 9091.
+
name (Optional): The name to use when displaying this Transmission instance.
+
username (Optional): Your Transmission username, if you use authentication.
+
password (Optional): Your Transmission password, if you use authentication.
+
display_variables array: Conditions to display in the frontend.
+
+
+
current_status: The status of your Transmission daemon.
+
download_speed: The current download speed.
+
upload_speed: The current upload speed.
+
+
+
+
+
To use the monitoring, your transmission client needs to allow remote access. If you are running the graphical transmission client (transmission-gtk) go to Edit -> Perferences and choose the tab Remote. Check Allow remote access, enter your username and your password, and uncheck the network restriction as needed.
-
+
diff --git a/components/switch.command_switch.html b/components/switch.command_switch.html
index 24a9133f07..65064faa22 100644
--- a/components/switch.command_switch.html
+++ b/components/switch.command_switch.html
@@ -125,6 +125,24 @@ A switch platform that issues specific commands when it is turned on and off. Th
offcmd: switch_command off kitchen
+
Configuration variables:
+
+
+
switches array (Required): Contains all command switches.
+
+
+
‘entry’ (Required): Name of the command switch. Multiple entries are possible.
+
+
+
oncmd (Required): The action to take for on.
+
offcmd (Required): The action to take for off.
+
+
+
+
+
+
+
diff --git a/components/switch.edimax.html b/components/switch.edimax.html
index 53dd691581..f41c923faa 100644
--- a/components/switch.edimax.html
+++ b/components/switch.edimax.html
@@ -125,6 +125,16 @@ This edimax switch platform allows you to control the state of your # Example configuration.yml entr
+10
+
# Example configuration.yml entryswitch:platform:mqttname:"BedroomSwitch"state_topic:"home/bedroom/switch1"command_topic:"home/bedroom/switch1/set"
+qos:0payload_on:"ON"payload_off:"OFF"optimistic:false
-
command_topic: The MQTT topic to publish commands to change the switch state. Required
+
Configuration variables:
-
name: The name of the switch. Default is ‘MQTT Switch’. Optional
+
+
name (Optional): The name of the switch. Default is ‘MQTT Switch’.
+
state_topic (Optional): The MQTT topic subscribed to receive state updates.
+
command_topic (Required): The MQTT topic to publish commands to change the switch state.
+
qos (Optional): The maximum QoS level of the state topic. Default is 0 and will also be used to publishing messages.
+
payload_on (Optional): The payload that represents enabled state. Default is “ON”.
+
payload_off (Optional): The payload that represents disabled state. Default is “OFF”.
+
optimistic (Optional): Flag that defines if switch works in optimistic mode. Default is true if no state topic defined, else false.
+
-
state_topic: The MQTT topic subscribed to receive state updates. Optional
-
payload_on: The payload that represents enabled state. Default is “ON”. Optional
+
+Make sure that your topics match exact. some-topic/ and some-topic are different topics.
+
-
payload_off: The payload that represents disabled state. Default is “OFF”. Optional
-
-
optimistic: Flag that defines if switch works in optimistic mode. Default is true if no state topic defined, else false. Optional
# Example configuration.yaml entry
+switch:platform:tellsticksensor:
@@ -144,6 +147,8 @@
+
+
diff --git a/components/thermostat.nest.html b/components/thermostat.nest.html
index c81dd8ddbf..2a1732374f 100644
--- a/components/thermostat.nest.html
+++ b/components/thermostat.nest.html
@@ -115,10 +115,16 @@ The nest thermostat platform let you control a thermostat from
diff --git a/developers/index.html b/developers/index.html
index 58cddd1f26..38962e2987 100644
--- a/developers/index.html
+++ b/developers/index.html
@@ -168,6 +168,7 @@ pull request.
Adding support for a new platform
Here are some general tutorials on how to setup some of the more advanced deployments that are frequently requested.
+
+
+
+
+
+
+
+
+Many linux distributions use the Upstart system (or similar) for managing daemons. Typically, systems based on Debian 7 or previous use Upstart. This includes Ubuntu releases before 15.04 and all current Raspian releases. If you are unsure if your system is using Upstart, you may check with the following command:
+
+
1
+
ps -p 1 -o comm=
+
+
+
If the preceding command returns the string init, you are likely using Upstart.
+
+
Upstart will launch init scripts that are located in the directory /etc/init.d/. A sample init script for systems using Upstart is maintained by this project.
+
+
To install this script, download it, tweak it to you liking, and install it by following the directions in the header. This script will setup Home Assistant to run when the system boots. To start/stop Home Assistant manually, issue the following commands:
+
1
+2
+
sudo service hass-daemon start
+sudo service hass-daemon stop
+
+
+
When running Home Assistant with this script, the configuration directory will be located at /var/opt/homeassistant. This directory will contain a verbose log rather than simply an error log.
+
+
When running daemons, it is good practice to have the daemon run under its own user name rather than the default user’s name. Instructions for setting this up are outside the scope of this document.
+
+
+
+Newer linux distributions are trending towards using systemd for managing daemons. Typically, systems based on Fedora or Debian 8 or later use systemd. This includes Ubuntu releases including and after 15.04, CentOS, and Red Hat. If you are unsure if your system is using systemd, you may check with the following command:
+
+
1
+
ps -p 1 -o comm=
+
+
+
If the preceding command returns the string systemd, you are likely using systemd.
+
+
If you want Home Assistant to be launched automatically, an extra step is needed to setup systemd. You need a service file to control Home Assistant with systemd.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/getting-started/android.html b/getting-started/android.html
index 34591da180..cf06774148 100644
--- a/getting-started/android.html
+++ b/getting-started/android.html
@@ -107,11 +107,11 @@
Home Assistant is not available on the Play Store. Instead, Home Assistant leverages the new manifest.json support to allow Android devices to add the web application to your homescreen as if it was a native application.
By default, Home Assistant will create a configuration folder. Depending on your operating system this is ~/.homeassistant (OS X/Linux) or %APPDATA%/.homeassistant (Windows). If you want to use a different folder for configuration, run hass --config path/to/config.
+
Home Assistant will create a configuration folder when it is run for the first time. Depending on your operating system this is ~/.homeassistant (OS X/Linux) or %APPDATA%/.homeassistant (Windows). If you want to use a different folder for configuration, run hass --config path/to/config.
Inside your configuration folder is the file configuration.yaml. This is the main file that contains which components will be loaded and what their configuration is. An example configuration file is located at here.
-Installing and running Home Assistant on your local machine is easy. Make sure you have Python 3.4 installed and execute the following code in a console:
+
+Installing and running Home Assistant on your local machine is easy. Make sure you have Python 3.4 installed and execute the following code in a console:
-
-
-
-
-
The preparation of a Fedora 22 host will only take a couple of minutes. First install Python 3.4 and the other needed packages out of the Fedora Package Collection. This ensure that you receive updates in the future.
-
-
-It’s assumed that your user has an entry in the sudoers file. Otherwise, run the commands which needs more privileges as root.
-
-
-
1
-
sudo dnf -y install python3 python3-devel gcc
-
-
-
-
-
-
-
CentOS is providing longtime support and often not shipping the latest release of a software component. To run, Python 3.x on CentOS Software Collections needs to be activated.
-
-
Step 1. Install the tools for the Software Collection
Installation with Docker is straightforward. Adjust the following command so that /path/to/your/config/ points at the folder where you want to store your config and run it:
-
-
-
-
-
-
-
-
-
There is nothing else to do. If you run into any issues, please see the troubleshooting page.
+
This will launch Home Assistant and serve its web interface from port 8123 on your Docker host.
-
If you want to see what Home Assistant can do, you can start the demo mode by running hass --demo-mode.
-
-
In the future, if you want to update to the latest version, run pip3 install --upgrade home-assistant.
-
-
-
-
-
By default, the access to port 8123 is not allowed. If you want to allow other hosts in your local network access, open port 8123.
If you want that Home Assistant is lauched automatically, an extra step is needed to setup systemd. You need a service file to control Home Assistant with systemd.
-
-
-
If everything went well, sudo systemctl start home-assistant should give you a positive feedback.
-
-
1
-2
-3
-4
-5
-6
-7
-8
-
$ sudo systemctl status home-assistant -l
-● home-assistant.service - Home Assistant
- Loaded: loaded (/usr/lib/systemd/system/home-assistant.service; disabled; vendor preset: disabled)
- Active: active (running) since Thu 2015-06-25 23:38:37 CEST; 3min 13s ago
- Main PID: 8557(python3.4)
- CGroup: /system.slice/home-assistant.service
- └─8557 /usr/bin/python3.4 -m homeassistant
-[...]
-
-
-
To get Home Assistant’s logging output, simple use journalctl.
-
-
1
-
sudo journalctl -f -u home-assistant
-
-
-
In the future, if you want to update to the latest version, run pip3 install --upgrade home-assistant.
-
-
-Those instructions were written for Fedora 22 Server and Workstation. They may work for Cloud flavor as well but this was not tested.
+
+When using boot2docker on OS X you are unable to map the local time to your Docker container. Replace -v /etc/localtime:/etc/localtime:ro with -e “TZ=America/Los_Angeles” (replacing America/Los_Angeles with your timezone)
+
+
+
Home Assistant uses Python 3.4 which is not shipped with the current Raspbian distibution for the Raspberry Pi. Before installing Home Assistant, you will have to install Python 3.4.
-
-
-
+
Once that is complete, installing and running Home Assistant on your local machine is easy. Make sure you have Python 3.4 installed and execute the following code in a console:
-
Coming soon…
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Installation with Docker is straightforward. Adjust the following command so that /path/to/your/config/ points at the folder where you want to store your config and run it:
This will launch Home Assistant and serve its web interface from port 8123 on your Docker host.
-
-
-When using boot2docker on OS X you are unable to map the local time to your Docker container. Replace -v /etc/localtime:/etc/localtime:ro with -e "TZ=America/Los_Angeles" (replacing America/Los_Angeles with your timezone)
-
-
-
-
-
-
-
-
Home Assistant uses Python 3.4. This makes installation on a Raspberry Pi a bit more difficult as it is not available in the package repository. Please follow the following instructions to get it up and running.
In order to update Home Assistant to the latest stable release, simply type the following into a console:
1
-
hass
+
pip3 install --upgrade homeassistant
+
If you would like to stay up to date with the newest unstable builds (alphas, betas, and release candidates), use this command:
+
1
+
pip3 install --upgrade --pre homeassistant
+
-
It will be up and running on port 8123
+
What’s Next
+
If you want to see what Home Assistant can do, you can start the demo mode by running hass --demo-mode. Home Assistant has a few other command line flags that can be displayed by running hass --help.
+
From here you may now start configuring Home Assistant to your liking. For more advanced users, the advanced configuration page contains brief tutorials on creating more advanced installations.
-
In the future, if you want to update to the latest version, run pip3 install --upgrade home-assistant.
diff --git a/getting-started/troubleshooting.html b/getting-started/troubleshooting.html
index 6e6309fea3..2e02ceae24 100644
--- a/getting-started/troubleshooting.html
+++ b/getting-started/troubleshooting.html
@@ -112,7 +112,7 @@ This utility should have been installed as part of the Python 3.4 installation.
is installed by running python3 --version. If it is not installed,
download it here.
-
If you are to succesfully run python3 --version but not pip3, run the following command instead
+
If you are able to successfully run python3 --version but not pip3, run the following command instead
to install Home Assistant: python3 -m pip install homeassistant.
No module named pip
@@ -122,10 +122,39 @@ by some distributions. If you are unable to run python3 -m pip --version
python3 get-pip.py.
No access to the frontend
-In newer Linux distributions (at least Fedora 22/CentOS 7) the access to a host are very limited.
-This means that you can’t access the Home Assistant Frontend that is running on a host in your
-network. Check the Post-installation section on the Getting started page and
-follow the instruction that match your distribution to allow access to port 8123.
+In newer Linux distributions (at least Fedora 22/CentOS 7) the access to a host is very limited.
+This means that you can’t access the Home Assistant Frontend that is running on a host outside of the host machine. Windows and OSX machines may also have issues with this.
+
+
To fix this you will need to open your machine’s firewall for TCP traffic over port 8123. The method for doing this will vary depending on your operating system and the firewall you have installed. Below are some suggestions to try. Google is your friend here.
diff --git a/images/components/ifttt/finding_key.png b/images/components/ifttt/finding_key.png
new file mode 100644
index 0000000000..5502f2a68a
Binary files /dev/null and b/images/components/ifttt/finding_key.png differ
diff --git a/images/components/ifttt/setup_trigger.png b/images/components/ifttt/setup_trigger.png
new file mode 100644
index 0000000000..6e93b14ea3
Binary files /dev/null and b/images/components/ifttt/setup_trigger.png differ
diff --git a/images/components/ifttt/testing_service.png b/images/components/ifttt/testing_service.png
new file mode 100644
index 0000000000..27a53a5ff2
Binary files /dev/null and b/images/components/ifttt/testing_service.png differ
diff --git a/images/screenshots/transmission-pref.png b/images/screenshots/transmission_perf.png
similarity index 100%
rename from images/screenshots/transmission-pref.png
rename to images/screenshots/transmission_perf.png
diff --git a/images/supported_brands/arest.png b/images/supported_brands/arest.png
new file mode 100644
index 0000000000..8905776801
Binary files /dev/null and b/images/supported_brands/arest.png differ
diff --git a/images/supported_brands/aruba.png b/images/supported_brands/aruba.png
new file mode 100644
index 0000000000..e20f1c95a6
Binary files /dev/null and b/images/supported_brands/aruba.png differ
diff --git a/images/supported_brands/denon.png b/images/supported_brands/denon.png
new file mode 100644
index 0000000000..621cdda9d6
Binary files /dev/null and b/images/supported_brands/denon.png differ
diff --git a/images/supported_brands/dht.png b/images/supported_brands/dht.png
new file mode 100644
index 0000000000..701af8ffbd
Binary files /dev/null and b/images/supported_brands/dht.png differ
diff --git a/images/supported_brands/ifttt.png b/images/supported_brands/ifttt.png
new file mode 100644
index 0000000000..f986bf76db
Binary files /dev/null and b/images/supported_brands/ifttt.png differ
diff --git a/index.html b/index.html
index 3d9a1d8d6d..7df78a8d3f 100644
--- a/index.html
+++ b/index.html
@@ -141,19 +141,48 @@ Home Assistant is an open-source home automation platform running on Python 3. T
Home Assistant will track the state of all the devices in your home, so you don’t have to.