Home Assistant will track the state of all the devices in your home, so you don't have to.
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 
+
+
+
+
+
+ 
+
+
+ 
+
+
+
+
+
+
+
+
+
+
+
+
+
+The [MQTT](https://en.wikipedia.org/wiki/MQTT) support was added to Home Assistant recently. The [MQTT component](https://home-assistant.io/components/mqtt.html) will enable you to do all sort of things. Most likely you will use it to communicate with your devices. But Home Assistant doesn't care where the data is coming from or is limited to real hardware as long as there is MQTT support. This means that it doesn't matter if the data is coming from a human, a web service, or a device.
+
+A great example is shown in a [Laundry Automation](https://home-assistant.io/blog/2015/08/26/laundry-automation-with-moteino-mqtt-and-home-assistant/) post in this blog.
+
+This post will give you a small overview of some other possibilities on how to use MQTT with Home Assistant.
+
+
+### {% linkable_title Manual usage %}
+
+The simplest but not the coolest way as a human to interact with a Home Assistant sensor is launching a command manually. Let's create a "Mood" sensor. For simplicity Home Assistant and the MQTT broker are both running on the same host. The needed configuration snipplets to add to the `configuration.yaml` file consists of two parts: one for the broker and one for the sensor.
+
+```yaml
+mqtt:
+ broker: 127.0.0.1
+
+sensor:
+ - platform: mqtt
+ name: "Fabian's Mood"
+ state_topic: "home-assistant/fabian/mood"
+```
+
+After a restart of Home Assistant the "Mood" sensor will show up in the frontend. For more details about the configuration of MQTT itself and the sensor, please refer to the [MQTT component](https://home-assistant.io/components/mqtt.html) or the [MQTT sensor](https://home-assistant.io/components/sensor.mqtt.html) documentation.
+
+Now we can set the mood. The commandline tool (`mosquitto_pub`) which is shipped with `mosquitto` is used to send an MQTT message.
+
+```bash
+mosquitto_pub -h 127.0.0.1 -t "home-assistant/fabian/mood" -m "bad"
+```
+
+
+ 
+ The Mood sensor
+
+ 
+ The Lottery sensor
+
+ 
+ The Arduino UNO with Ethernet shield and photo resistor
+
+ 
+ The Brightness sensor
+
+ 
+
+ 
+
+ 
+
+ 
+
+ 
+
+ 
+
+Inspried by a [feature requests](https://github.com/balloob/home-assistant/issues/310) I started looking into the available options to do monitoring of remote hosts. The feature request is about displaying system information in a similar way than the [systemmonitor](/components/sensor.systemmonitor.html) sensor does it for the local system. After a while I started to think that it would be a nice addition for a small home network where no full-blown system monitoring setup is present.
+
+
+
+The basic problem is to get the data from the remote host. Starting with [psutil](https://pypi.python.org/pypi/psutil) that is used by the systemmonitor sensor, a possible solution is only a click away and named [Glances](https://github.com/nicolargo/glances). Glances has a nice curses-based interface and a [RESTful API](https://github.com/nicolargo/glances/wiki/The-Glances-RESTFULL-JSON-API).
+
+The [Glances sensor](/components/sensor.glances.html) sensor uses that API to get all needed data.
+
+In this post a default Fedora 22 Workstation installation is used on the host that should be monitored. In fact, it doesn't matter if the system is the local one or a remote one as long as Glances is available. With some adjustments it should work on your own systems too. The difference will be the package and the firewall management tools.
+
+First some extra packages are needed beside Glances, especially the [bottle](http://bottlepy.org/docs/dev/index.html) webserver. I guess that Glances is available for your distribution as well. Otherwise follow those [instructions](https://github.com/nicolargo/glances#installation).
+
+```
+sudo dnf -y install glances python-bottle
+```
+
+On Fedora the Firewall settings are strict. Let's open port 61208 to allow other hosts to connect to that port. This is not needed if you just want to observe your local machine.
+
+```bash
+sudo firewall-cmd --permanent --add-port=61208/tcp
+sudo firewall-cmd --reload
+```
+
+Launch `glances` and keep an eye on the output.
+
+```bash
+glances -w
+Glances web server started on http://0.0.0.0:61208/
+```
+
+Now browse to http://IP_ADRRESS:61208/. You should see the webified view of Glances.
+
+
+ 
+ Glances web interface
+
+ 
+ The Glances sensors
+
+Sonos support has been added by [@rhooper](https://github.com/rhooper) and [@SEJeff](https://github.com/SEJeff). Home Assistant is now able to automatically
+detect Sonos devices in your network and set them up for you. It will allow you to control music
+playing on your Sonos and change the volume.
+
+__iTunes and airplay speakers__
+[@maddox](https://github.com/maddox) has contributed support for controlling iTunes and airplay speakers. For this to work you will
+have to run [itunes-api](https://github.com/maddox/itunes-api) on your Mac as middleware.
+
+```
+# Example configuration.yaml entry
+media_player:
+ platform: itunes
+ name: iTunes
+ host: http://192.168.1.50
+ port: 8181
+```
+
+
+
+__Automation__
+We now support arming and disarming your verisure alarm from within Home Assistant thanks to added
+support by [@persandstrom](https://github.com/persandstrom).
diff --git a/source/components/arduino.markdown b/source/components/arduino.markdown
index 3a02b4cb1c4..651b0517184 100644
--- a/source/components/arduino.markdown
+++ b/source/components/arduino.markdown
@@ -28,8 +28,10 @@ To integrate an Arduino boards with Home Assistant, add the following section to
arduino:
port: /dev/ttyACM0
```
-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*`.
```bash
ls /dev/ttyACM*
@@ -41,49 +43,8 @@ If that is not working, check your `dmesg` or `journalctl -f` output. Keep in mi
A word of caution: The Arduino boards are not storing states. This means that with every initialization the pins are set to off/low.
-## Switch Configuration
+## Building on top of the Arduino component
-Support for switching pins is limited to high/on and low/off of the digital pins. PWM (pin 3,5,6,9,10, and 11 on a Arduino Uno) is not supported yet.
-
-To enable the Arduino switch pins with Home Assistant, add the following section to your `configuration.yaml` file:
-
-```yaml
-# Example configuration.yaml entry
-switch:
- platform: arduino
- pins:
- 11:
- name: Fan Office
- type: digital
- 12:
- name: Light Desk
- type: digital
-```
-
-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.
-
-The name field of the pins array will be used in the frontend.
-
-## Sensor Configuration
-
-The sensor platform allow you to get an numerical values from an analog input pin. Usually between 0 and 1024.
-
-To enable an Arduino sensor with Home Assistant, add the following section to your `configuration.yaml` file:
-
-```yaml
-# Example configuration.yaml entry
-sensor:
- platform: arduino
- pins:
- 1:
- name: Door switch
- type: analog
- 0:
- name: Brightness
- type: analog
-```
-
-The 6 analog pins are numbered from A0 to A5.
-
-The name field of the pins array will be used in the frontend.
+ - [Arduino Sensor](/components/sensor.arduino.html)
+ - [Arduino Switch](/components/switch.arduino.html)
diff --git a/source/components/automation.markdown b/source/components/automation.markdown
index 8ac0028c5b0..65039a51d46 100644
--- a/source/components/automation.markdown
+++ b/source/components/automation.markdown
@@ -9,143 +9,262 @@ sharing: true
footer: true
---
-This page will talk about automating Home Assistant using the `automation` component. For more advanced ways of automation, see the [create a component]({{site_root}}/developers/creating_components.html) page.
+This page will go into more detail about the various options the `automation` component offers. If
+you haven't yet, read the [getting started page on automation](/getting-started/automation.html).
-Each part of automation consists of two parts: the trigger part and the action part. The final result will look something like this:
+A configuration section of an automation requires a `trigger` and an `action` section. `condition` and
+`condition_type` are optional. To keep this page compact, all following sections will not show the
+full configuration but only the relevant part.
-```
+```yaml
+# Example of entry in configuration.yaml
automation:
- # Optional alias that the logs will use to refer to the entry
- alias: Sunset notification
-
- # Type of trigger and information for the trigger
- platform: state
- state_entity_id: sun.sun
- state_from: 'above_horizon'
- state_to: 'below_horizon'
-
- # Action to be done when trigger activated
- execute_service: notify.NOTIFIER_NAME
- service_data: {"message":"The sun has set"}
-```
-
-## {% linkable_title Setting up triggers %}
-
-#### {% linkable_title Time-based automation %}
-This allows you to trigger actions whenever the time matches your filter. You can setup filters to match on hours, minutes and seconds. Any filter that you omit will match all values.
-
-Here are some example values:
-
-```
- # Match at the start of every hour
- platform: time
- time_minutes: 0
- time_seconds: 0
-
- # Match at 4pm
- platform: time
- time_hours: 16
- time_minutes: 0
- time_seconds: 0
-```
-
-#### {% linkable_title State-based automation %}
-This allows you to trigger actions based on state changes of any entity within Home Assistant. You can omit the `state_from` and `state_to` to match all.
-
-```
- # Match when the sun sets
- platform: state
- state_entity_id: sun.sun
- state_from: 'above_horizon'
- state_to: 'below_horizon'
-
- # Match when a person comes home
- platform: state
- state_entity_id: device_tracker.Paulus_OnePlus_One
- state_from: 'not_home'
- state_to: 'home'
-
- # Match when a light turns on
- platform: state
- state_entity_id: light.Ceiling
- state_from: 'off'
- state_to: 'on'
+ alias: Light on in the evening
+ trigger:
+ - platform: sun
+ event: sunset
+ offset: "-01:00:00"
+ - platform: state
+ entity_id: group.all_devices
+ state: home
+ condition:
+ - platform: state
+ entity_id: group.all_devices
+ state: home
+ - platform: time
+ after: "16:00:00"
+ before: "23:00:00"
+ action:
+ service: homeassistant.turn_on
+ entity_id: group.living_room
```
- Use quotes around your values for state_from and state_to to avoid the YAML parser interpreting some values as booleans.
+All configuration entries have to be sequential. If you have automation:,
+automation 2: and automation 4: then the last one will not be processed.
-All configuration entries have to be sequential. If you have automation:, automation 2: and automation 4: then the last one will not be processed.
+ Use quotes around your values for from and to to avoid the YAML parser
+ interpreting some values as booleans.
+The foscam platform allows you to watch the live stream of your [Foscam](http://www.foscam.com/) IP camera in Home Assistant.
+
+To enable your Foscam IP camera in your installation, add the following to your `configuration.yaml` file:
+
+```yaml
+# Example configuration.yaml entry
+camera:
+ platform: foscam
+ ip: 192.168.0.123
+ name: Door Camera
+ port: 88
+ username: USERNAME
+ password: PASSWORD
+```
+
+Configuration variables:
+
+- **ip** *Required*: The IP address your camera.
+- **port** *Optional*: The port that the camera is running on. The default is 88.
+- **name** *Optional*: This parameter allows you to override the name of your camera.
+- **username** *Required*: The username for accessing your camera.
+- **password** *Required*: The password for accessing your camera.
+
diff --git a/source/components/camera.generic.markdown b/source/components/camera.generic.markdown
index b0d54041383..851b6747bee 100644
--- a/source/components/camera.generic.markdown
+++ b/source/components/camera.generic.markdown
@@ -14,12 +14,21 @@ This component allows you to integrate any IP camera into Home Assistant. It sup
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:
+
```yaml
# Example configuration.yaml entry
camera:
platform: generic
- name: my sample camera
- username: MY_USERNAME
- password: MY_PASSWORD
still_image_url: http://194.218.96.92/jpg/image.jpg
+ name: my sample camera
+ username: USERNAME
+ password: PASSWORD
```
+
+Configuration variables:
+
+- **still_image_url** *Required*: The URL your camera serves the image on, eg. http://192.168.1.21:2112/
+- **name** *Optional*: This parameter allows you to override the name of your camera.
+- **username** *Optional*: The username for accessing your camera.
+- **password** *Optional*: The password for accessing your camera.
diff --git a/source/components/device_tracker.actiontec.markdown b/source/components/device_tracker.actiontec.markdown
index 1e00789a67d..5f89e162c04 100644
--- a/source/components/device_tracker.actiontec.markdown
+++ b/source/components/device_tracker.actiontec.markdown
@@ -12,7 +12,8 @@ footer: true
This platform allows you to detect presence by looking at connected devices to an [Actiontec](http://www.actiontec.com/) device.
-Supported devices:
+Supported devices (tested):
+
- MI424WR (Verizon FIOS)
@@ -26,7 +27,15 @@ device_tracker:
host: YOUR_ROUTER_IP
username: YOUR_ADMIN_USERNAME
password: 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.
+
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.aruba.markdown b/source/components/device_tracker.aruba.markdown
index e609b8efef3..4e43c3fe5af 100644
--- a/source/components/device_tracker.aruba.markdown
+++ b/source/components/device_tracker.aruba.markdown
@@ -9,7 +9,12 @@ sharing: true
footer: true
---
-This platform allows you to detect presence by looking at connected devices to an [Aruba Instant](http://www.arubanetworks.com/products/networking/aruba-instant/) device. This has been tested on an ARUBA AP-105.
+
+This platform allows you to detect presence by looking at connected devices to an [Aruba Instant](http://www.arubanetworks.com/products/networking/aruba-instant/) device.
+
+Supported devices (tested):
+
+- ARUBA AP-105
This device tracker needs telnet to be enabled on the router.
@@ -24,5 +29,11 @@ device_tracker:
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.
+
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.asuswrt.markdown b/source/components/device_tracker.asuswrt.markdown
index 362a30a3a3e..028a94daea2 100644
--- a/source/components/device_tracker.asuswrt.markdown
+++ b/source/components/device_tracker.asuswrt.markdown
@@ -12,6 +12,10 @@ footer: true
This platform offers presence detection by looking at connected devices to a [ASUSWRT](http://event.asus.com/2013/nw/ASUSWRT/) based router.
+
+This device tracker needs telnet to be enabled on the router. +
+ To use an ASUSWRT router in your installation, add the following to your `configuration.yaml` file: ```yaml @@ -23,6 +27,10 @@ device_tracker: password: YOUR_ADMIN_PASSWORD ``` -This device tracker needs telnet to be enabled on the router. +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. 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.ddwrt.markdown b/source/components/device_tracker.ddwrt.markdown index 4435eda1b27..b24aa7ef523 100644 --- a/source/components/device_tracker.ddwrt.markdown +++ b/source/components/device_tracker.ddwrt.markdown @@ -18,9 +18,15 @@ To use a DD-WRRT router in your installation, add the following to your `configu # Example configuration.yaml entry device_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. + 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.luci.markdown b/source/components/device_tracker.luci.markdown index 97c8d709f5e..c56fdadcdce 100644 --- a/source/components/device_tracker.luci.markdown +++ b/source/components/device_tracker.luci.markdown @@ -16,9 +16,15 @@ Before this scanner can be used you have to install the luci RPC package on Open # Example configuration.yaml entry device_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. + 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 3de99d1a31e..4d4e5a0206f 100644 --- a/source/components/device_tracker.markdown +++ b/source/components/device_tracker.markdown @@ -11,22 +11,41 @@ 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: +- [Actiontec](/components/device_tracker.actiontec.html) +- [Aruba](/components/device_tracker.aruba.html) +- [ASUSWRT](/components/device_tracker.asuswrt.html) - [DD-WRT](/components/device_tracker.ddwrt.html) -- [tomato](/components/device_tracker.tomato.html) -- [netgear](/components/device_tracker.netgear.html) - [luci (OpenWRT)](/components/device_tracker.luci.html) +- [netgear](/components/device_tracker.netgear.html) +- [Thomson](/components/device_tracker.thomson.html) +- [tomato](/components/device_tracker.tomato.html) - [TP-Link](/components/device_tracker.tplink.html) -You can also decide to directly scan the network for devices by using the [nmap scanner](/components/device_tracker.nmap_scanner.html). +Alternative trackers: + +- [MQTT](/components/device_tracker.mqtt.html) +- [nmap scanner](/components/device_tracker.nmap_scanner.html) to scan the network for devices +- [Owntrack](/components/device_tracker.owntrack.html) To get started add the following lines to your `configuration.yaml` (example for Netgear): -``` +```yaml +# Example configuration.yaml entry for Netgear device device_tracker: platform: netgear host: 192.168.1.1 username: admin - password: MY_PASSWORD + password: YOUR_PASSWORD + + # Optional configuration + + # If new discovered devices are tracked by default (default: yes) + track_new_devices: yes + # Seconds between each scan for new devices (default: 12) + interval_seconds: 12 + # Seconds to wait till marking someone as not home after not being seen + # (default: 180) + consider_home: 180 ``` -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. +Once tracking, a file will be created in your config dir called `known_devices.yaml`. 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 and set whether the device will be show in the UI when in away state. diff --git a/source/components/device_tracker.mqtt.markdown b/source/components/device_tracker.mqtt.markdown new file mode 100644 index 00000000000..a75bcbf6845 --- /dev/null +++ b/source/components/device_tracker.mqtt.markdown @@ -0,0 +1,24 @@ +--- +layout: page +title: "MQTT device tracker" +description: "Instructions how to use MQTT to track devices in Home Assistant." +date: 2015-09-19 20:41 +sidebar: false +comments: false +sharing: true +footer: true +--- + +
+This platform allows you to detect presence by monitoring a MQTT topic for new locations. To use this
+platform, you specify a unique topic for each device.
+
+```yaml
+# Example configuration.yaml entry
+device_tracker:
+ platform: mqtt
+ qos: 1
+ devices:
+ paulus_oneplus: /location/paulus
+ annetherese_n4: /location/annetherese
+```
diff --git a/source/components/device_tracker.netgear.markdown b/source/components/device_tracker.netgear.markdown
index dc3b59b2bc9..f37594ac958 100644
--- a/source/components/device_tracker.netgear.markdown
+++ b/source/components/device_tracker.netgear.markdown
@@ -16,9 +16,15 @@ This platform allows you to detect presence by looking at connected devices to a
# Example configuration.yaml entry
device_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.
+
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
index de144c8e4a6..ee3ac047cb9 100644
--- a/source/components/device_tracker.nmap_scanner.markdown
+++ b/source/components/device_tracker.nmap_scanner.markdown
@@ -10,15 +10,23 @@ 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`).
+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`).
-If you're on Debian or Ubuntu, you might have to install the packages for arp and nmap. Do so by running `apt-get install net-tools nmap`.
+If you're on Debian or Ubuntu, you might have to install the packages for arp and nmap. Do so by
+running `apt-get install net-tools nmap`.
```
# Example configuration.yaml entry
device_tracker:
platform: nmap_tracker
hosts: 192.168.1.1/24
+ home_interval: 10
```
-See the [device tracker component page](/components/device_tracker.html) for instructions how to configure the people to be tracked.
+`home_interval` is an optional value set in minutes. This will be the number of minutes nmap will not
+scan this device, assuming it is home, in order to preserve the device battery.
+
+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.owntrack.markdown b/source/components/device_tracker.owntrack.markdown
new file mode 100644
index 00000000000..39f055f8495
--- /dev/null
+++ b/source/components/device_tracker.owntrack.markdown
@@ -0,0 +1,21 @@
+---
+layout: page
+title: "Owntrack device tracker"
+description: "Instructions how to use Owntrack to track devices in Home Assistant."
+date: 2015-09-22 07:00
+sidebar: false
+comments: false
+sharing: true
+footer: true
+---
+
+
+This platform allows you to detect presence by monitoring MQTT topics uses by [Owntrack](http://owntracks.org/) for new locations.
+
+To integrate Owntrack in Home Assistant, add the following section to your `configuration.yaml` file:
+
+```yaml
+# Example configuration.yaml entry
+device_tracker:
+ platform: owntracks
+```
diff --git a/source/components/device_tracker.tomato.markdown b/source/components/device_tracker.tomato.markdown
index 89c5f4726c1..b32a7e4f315 100644
--- a/source/components/device_tracker.tomato.markdown
+++ b/source/components/device_tracker.tomato.markdown
@@ -16,10 +16,17 @@ Tomato requires an extra config variable called `http_id`. The value can be obta
# Example configuration.yaml entry
device_tracker:
platform: tomato
- host: 192.168.1.1
- username: admin
- password: PASSWORD
- http_id: ABCDEFG
+ host: YOUR_ROUTER_IP_ADDRESS
+ username: YOUR_ADMIN_USERNAME
+ password: YOUR_ADMIN_PASSWORD
+ http_id: YOUR_HTTP_ID
```
+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.
+- **http_id** (*Required*): The value can be obtained by logging in to the Tomato admin interface and search for `http_id` in the page source code.
+
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.tplink.markdown b/source/components/device_tracker.tplink.markdown
index d10750af4ba..712145c57f5 100644
--- a/source/components/device_tracker.tplink.markdown
+++ b/source/components/device_tracker.tplink.markdown
@@ -21,4 +21,11 @@ device_tracker:
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.
+
+
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/discovery.markdown b/source/components/discovery.markdown
index 64193b2eb88..aca8501c092 100644
--- a/source/components/discovery.markdown
+++ b/source/components/discovery.markdown
@@ -26,3 +26,7 @@ discovery:
```
If you are developing a new platform, please read [how to make your platform discoverable]({{site_root}}/developers/add_new_platform.html#discovery).
+
++There is currently a known issue with running this playform on a 64-bit version of Python. +
diff --git a/source/components/ifttt.markdown b/source/components/ifttt.markdown new file mode 100644 index 00000000000..8cffcb173b9 --- /dev/null +++ b/source/components/ifttt.markdown @@ -0,0 +1,65 @@ +--- +layout: page +title: "IFTTT" +description: "Instructions how to setup IFTTT within Home Assistant." +date: 2015-09-07 18:00 +sidebar: false +comments: false +sharing: true +footer: true +--- +
+[IFTTT](https://ifttt.com) 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. See the [announcement blog post](/blog/2015/09/13/home-assistant-meets-ifttt/) for examples
+how to use it.
+
+```yaml
+# 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](https://ifttt.com/maker).
+
+
+
+Property screen of the Maker Channel
+
+After restarting the server, be sure to watch the console for any logging errors that show up in red, white or yellow. +
+ +### {% linkable_title Testing your trigger %} + +You can use the developer tools to test your [Maker Channel](https://ifttt.com/maker) 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.
+
+
+You need to setup a unique trigger for each event you sent to IFTTT.
+
| + |  |
DHTxx reads the temperature and humidity. |
| - | RFXtrx sensors monitors values from RFXtrx sensors. | +RFXtrx sensors monitors values from RFXtrx devices. |
|
- MQTT allows sending and recieving MQTT messages. | +MQTT allows sending and recieving MQTT messages, incl. switches and sensors. | +
 |
+ aREST sensors observe and switches controls the pins of aREST enabled devices. |
Offers presence detection by looking at connected devices or by scanning the network.
| + | |
Aruba routers | OpenWRT routers | +||||||||||||||||||||||||||
 |
+ Owntrack devices | +||||||||||||||||||||||||||||
|
+ MQTT devices | +||||||||||||||||||||||||||||
|
Netgear routers | @@ -201,14 +216,14 @@ Entities are things that you want to observe within Home Assistant. Support for
|
- Google Cast devices | +Google Cast |
| Kodi | ||
|
+ iTunes | +|
 |
Music Player Daemon (MPD) | @@ -226,6 +246,16 @@ Entities are things that you want to observe within Home Assistant. Support forLogitech Squeezebox |
 |
+ Denon Network Receivers | +|
|
+ Sonos devices | +
Camera allows you to see what going in real-time. Other entities report the current state and/or let you control it.
| IP camera integrates a generic IP camera or image url. | + |
+ Foscam let you see your live stream. | + +
 |
SABnzbd clients monitors queue and download speeds. | @@ -268,7 +302,12 @@ Entities are things that you want to observe within Home Assistant. Support for|
 |
- Command line issues command line commands. | +Command line switches and sensors issues command line commands to do or the get something. | +
|
+ Glances tracks system information on remote hosts. |
](/components/wink.html)
[
](/components/isy994.html)
[
](/components/modbus.html)
-[](/components/arduino.html)
+[](/components/verisure.html)
Support for these devices is provided by the Home Assistant community and not @@ -316,7 +355,7 @@ the manufacturers of these devices.
Those services offers you a wide range of possibilities out-of-box.
 |
- Swiss Public Transport displays Swiss timetable data for traveling. | +Swiss Public Transport displays Swiss timetable data for traveling. | +
|
+ IFTTT allows the triggering of recipes. |
-The logbook component provides a different perspective on the history of your house by showing all the changes that happened to your house in chronological order. [See the demo for a live example](/demo/).
+
+The logbook component provides a different perspective on the history of your house by showing all
+the changes that happened to your house in reverse chronological order.
+[See the demo for a live example](/demo/).
To enable the logbook in your installation, add the following to your `configuration.yaml` file:
@@ -19,4 +21,19 @@ To enable the logbook in your installation, add the following to your `configura
logbook:
```
-
+It is possible to add custom entries to the logbook by using the script component to fire an event.
+
+```
+# Example configuration.yaml entry
+script:
+ add_logbook_entry:
+ alias: Add Logbook
+ sequence:
+ - event: LOGBOOK_ENTRY
+ event_data:
+ name: Kitchen
+ message: is being used
+ # Optional
+ entity_id: light.kitchen
+ domain: light
+```
diff --git a/source/components/media_player.cast.markdown b/source/components/media_player.cast.markdown
index 9b499e34c95..a75f2b25cd5 100644
--- a/source/components/media_player.cast.markdown
+++ b/source/components/media_player.cast.markdown
@@ -14,9 +14,14 @@ Google Cast devices will be automatically discovered if you enable [the discover
Chromecast platform can also be forced to load by adding the following lines to your `configuration.yaml`:
-```
+```yaml
+# Example configuration.yaml entry
media_player:
platform: chromecast
- # Optional. Will scan for devices if left out
host: 192.168.1.9
```
+
+Configuration variables:
+
+- **host** *Optional*: Use only if you don't want to scan for devices.
+
diff --git a/source/components/media_player.denon.markdown b/source/components/media_player.denon.markdown
new file mode 100644
index 00000000000..4fe302ec541
--- /dev/null
+++ b/source/components/media_player.denon.markdown
@@ -0,0 +1,38 @@
+---
+layout: page
+title: "Denon Network Receivers support"
+description: "Instructions how to integrate Denon Network Receivers into Home Assistant."
+date: 2015-09-08 09:00
+sidebar: false
+comments: false
+sharing: true
+footer: true
+---
+
+
+The denon platform allows you to control a [Denon Network Receivers](http://www.denon.co.uk/chg/product/compactsystems/networkmusicsystems/ceolpiccolo) from Home Assistant.
+
+Supported devices:
+
+- Denon DRA-N5
+- Denon RCD-N8 (untested)
+
+To add a Denon Network Receiver to your installation, add the following to your `configuration.yaml` file:
+
+```yaml
+# Example configuration.yaml entry
+media_player:
+ platform: denon
+ host: IP_ADDRESS
+ name: Music station
+```
+Configuration variables:
+
+- **host** (*Required*): IP address of the device. Example: 192.168.1.32
+- **name** (*Optional*): Name of the device
+
+A few notes:
+
+- As long as this module is active and connected, the receiver does not seem to accept additional telnet connections.
+- Be careful with the volume. 50 % or even 100 % are very loud.
+- To be able to wake up the receiver, activate the "remote" setting in the receiver's settings.
diff --git a/source/components/media_player.itunes.markdown b/source/components/media_player.itunes.markdown
new file mode 100644
index 00000000000..0947a4ab791
--- /dev/null
+++ b/source/components/media_player.itunes.markdown
@@ -0,0 +1,35 @@
+---
+layout: page
+title: "iTunes support"
+description: "Instructions how to integrate iTunes into Home Assistant."
+date: 2015-06-22 11:00
+sidebar: false
+comments: false
+sharing: true
+footer: true
+---
+
+
+ The iTunes platform allows you to control [iTunes](http://apple.com/itunes/) from Home Assistant.
+ It uses a 3rd party server that you run on your Mac called
+ [itunes-api](https://github.com/maddox/itunes-api). Play, pause, or skip songs remotely on iTunes
+ running on your Mac.
+
+ Your AirPlay speakers will also be exposed as simple media players inside Home
+ Assistant. They will be available to be turned on or off or set their volume.
+
+To add iTunes to your installation, add the following to your `configuration.yaml` file:
+
+```
+# Example configuration.yaml entry
+media_player:
+ platform: itunes
+ name: iTunes
+ host: http://192.168.1.50
+ port: 8181
+```
+
+Configuration variables:
+
+- **host** *Required*: The URL of the itunes-api API, eg. http://192.168.1.50
+- **port** *Optional*: The PORT that itunes-api is running on.
diff --git a/source/components/media_player.kodi.markdown b/source/components/media_player.kodi.markdown
index 644e1aa1dbe..a0c8251edb4 100644
--- a/source/components/media_player.kodi.markdown
+++ b/source/components/media_player.kodi.markdown
@@ -18,9 +18,15 @@ To add Kodi to your installation, add the following to your `configuration.yaml`
# Example configuration.yaml entry
media_player:
platform: kodi
- name: Kodi
url: http://192.168.0.123/jsonrpc
- user: kodi
- password: my_secure_password
+ name: Kodi
+ user: USERNAME
+ password: PASSWORD
```
+Configuration variables:
+
+- **url** *Required*: The URL of the XBMC/Kodi JSON-RPC API, eg. http://192.168.0.123/jsonrpc
+- **name** *Optional*: The name of the device used in the frontend.
+- **username** *Optional*: The XBMC/Kodi HTTP username.
+- **password** *Optional*: The XBMC/Kodi HTTP password.
diff --git a/source/components/media_player.markdown b/source/components/media_player.markdown
index 7b774d72884..d544225e085 100644
--- a/source/components/media_player.markdown
+++ b/source/components/media_player.markdown
@@ -14,8 +14,10 @@ Interacts with media players on your network.
Currently supported devices:
- [Chromecasts](/components/media_player.cast.html)
-- [Music Player Daemon](/components/media_player.mpd.html)
+- [Denon Network Receivers](/components/media_player.denon.html)
- [Kodi](/components/media_player.kodi.html)
+- [Music Player Daemon](/components/media_player.mpd.html)
+- [Squeezebox](/components/media_player.squeezebox.html)
## Services
diff --git a/source/components/media_player.mpd.markdown b/source/components/media_player.mpd.markdown
index 858fa4b5287..bab5e73fbd0 100644
--- a/source/components/media_player.mpd.markdown
+++ b/source/components/media_player.mpd.markdown
@@ -18,8 +18,15 @@ To add MPD to your installation, add the following to your `configuration.yaml`
# Example configuration.yaml entry
media_player:
platform: mpd
- server: 127.0.0.1
+ server: IP_ADDRESS
port: 6600
location: bedroom
+ password: PASSWORD
```
+Configuration variables:
+
+- **server** *Required*: IP address of the Music Player Daemon. Example: 192.168.1.32
+- **port** *Optional*: Port of the Music Player Daemon, defaults to 6600. Example: 6600
+- **location** *Optional*: Location of your Music Player Daemon.
+- **password** *Optional*: Password for your Music Player Daemon.
diff --git a/source/components/media_player.sonos.markdown b/source/components/media_player.sonos.markdown
new file mode 100644
index 00000000000..6632add1ea7
--- /dev/null
+++ b/source/components/media_player.sonos.markdown
@@ -0,0 +1,22 @@
+---
+layout: page
+title: "Sonos support"
+description: "Instructions how to integrateSonos devices into Home Assistant."
+date: 2015-09-12 13:00
+sidebar: false
+comments: false
+sharing: true
+footer: true
+---
+
+
+The sonos platform allows you to control your [Sonos](http://www.sonos.com) HiFi wireless speakers and audio components from Home Assistant.
+
+To add your Sonos components to your installation, add the following to your `configuration.yaml` file. It will perform auto-discovery of your connected speakers.
+
+```yaml
+# Example configuration.yaml entry
+media_player:
+ platform: sonos
+```
+
diff --git a/source/components/media_player.squeezebox.markdown b/source/components/media_player.squeezebox.markdown
index af69465f39e..0004014e539 100644
--- a/source/components/media_player.squeezebox.markdown
+++ b/source/components/media_player.squeezebox.markdown
@@ -20,7 +20,13 @@ media_player:
platform: squeezebox
host: 192.168.1.21
port: 9090
- username: user
- password: password
+ username: USERNAME
+ password: PASSWORD
```
+Configuration variables:
+
+- **host** *Required*: The host name or address of the Logitech Media Server.
+- **port** *Optional*: Telnet port to Logitech Media Server, default 9090.
+- **username** *Optional*: The username, if password protection is enabled.
+- **password** *Optional*: The password, if password protection is enabled.
diff --git a/source/components/mqtt.markdown b/source/components/mqtt.markdown
index cb5648db31e..fcd0c5b0db0 100644
--- a/source/components/mqtt.markdown
+++ b/source/components/mqtt.markdown
@@ -19,14 +19,22 @@ To integrate MQTT into Home Assistant, add the following section to your `config
# Example configuration.yaml entry
mqtt:
broker: IP_ADDRESS_BROKER
- # All the other options are optional:
port: 1883
+ client_id: home-assistant-1
keepalive: 60
- qos: 0
- username: your_username
- password: your_secret_password
+ username: USERNAME
+ password: PASSWORD
```
+Configuration variables:
+
+- **broker** (*Required*): The IP address of your MQTT broker, e.g. 192.168.1.32.
+- **port** (*Optional*): The network port to connect to. Default is 1883.
+- **client_id** (*Optional*): Client ID that Home Assistant will use. Has to be unique on the server. Default is a random generated one.
+- **keepalive** (*Optional*): The keep alive in seconds for this client. Default is 60.
+- **username** (*Optional*): The username to use with your MQTT broker.
+- **password** (*Optional*): The corresponding password for the username to use with your MQTT broker.
+
The MQTT component has no TLS support at the moment. This means that only plain-text communication is possible.
@@ -35,7 +43,8 @@ The MQTT component has no TLS support at the moment. This means that only plain- - [MQTT Sensor](/components/sensor.mqtt.html) - [MQTT Switch](/components/switch.mqtt.html) - - [MQTT-automation rule](/components/automation.html#mqtt-based-automation). + - [MQTT Device Tracker](/components/device_tracker.mqtt.html) + - [MQTT-automation rule](/components/automation.html#mqtt-based-automation) - Integrating it into a component. See the [MQTT example component](https://github.com/balloob/home-assistant/blob/dev/config/custom_components/mqtt_example.py) how to do this. ## Testing diff --git a/source/components/notify.pushbullet.markdown b/source/components/notify.pushbullet.markdown index 71378ffc913..7ea5f6de797 100644 --- a/source/components/notify.pushbullet.markdown +++ b/source/components/notify.pushbullet.markdown @@ -1,6 +1,6 @@ --- layout: page -title: "Notifications" +title: "PushBullet notification support" description: "Instructions how to add user notifications to Home Assistant." date: 2015-01-20 22:36 sidebar: false diff --git a/source/components/scene.markdown b/source/components/scene.markdown index 5e58283eb39..3581d9233c5 100644 --- a/source/components/scene.markdown +++ b/source/components/scene.markdown @@ -21,4 +21,15 @@ scene: state: on color: [0.33, 0.66] brightness: 200 + + - name: all_lights_on + entities: + group.all_lights: + state: on + + - name: all_lights_off + entities: + group.all_lights: + state: off + ``` diff --git a/source/components/scheduler.markdown b/source/components/scheduler.markdown deleted file mode 100644 index ca78e7521ee..00000000000 --- a/source/components/scheduler.markdown +++ /dev/null @@ -1,53 +0,0 @@ ---- -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 - -Example `schedule.json` - -```json -[ - { - "id": "window_lamps", - "name": "Window lamps", - "description": "Turn on window lamps on sunset and turn off at 22:30", - "days": [0, 1, 2, 3, 4], - "entity_ids": [ - "group.window_lamps" - ], - "events": [ - { - "type": "time", - "service": "switch.turn_off", - "time": "22:30:00" - }, - { - "type": "sun", - "service": "switch.turn_on", - "event": "sunset", - "offset": "-00:45:00" - } - ] - } -] -``` diff --git a/source/components/script.markdown b/source/components/script.markdown index 689bbfc936f..7dc662b1c75 100644 --- a/source/components/script.markdown +++ b/source/components/script.markdown @@ -9,7 +9,8 @@ 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. +The script component 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`. ```yaml # Example configuration.yaml entry @@ -18,6 +19,13 @@ script: wakeup: alias: Wake Up sequence: + - event: logbook_entry + event_data: + name: Paulus + message: is waking up + # Optional + entity_id: device_tracker.paulus + domain: light - alias: Bedroom lights on execute_service: light.turn_on service_data: diff --git a/source/components/sensor.arduino.markdown b/source/components/sensor.arduino.markdown new file mode 100644 index 00000000000..1ff731d8452 --- /dev/null +++ b/source/components/sensor.arduino.markdown @@ -0,0 +1,37 @@ +--- +layout: page +title: "Arduino sensor support" +description: "Instructions how to integrate Arduino boards within Home Assistant." +date: 2015-09-14 18:28 +sidebar: false +comments: false +sharing: true +footer: true +--- + +
+The arduino sensor platform allows allow you to get an numerical values from an analog input pin of an [Arduino](https://www.arduino.cc/) board. Usually the value is between 0 and 1024.
+
+To enable an Arduino sensor with Home Assistant, add the following section to your `configuration.yaml` file:
+
+```yaml
+# Example configuration.yaml entry
+sensor:
+ platform: arduino
+ pins:
+ 1:
+ name: Door switch
+ type: analog
+ 0:
+ name: Brightness
+ type: analog
+```
+
+Configuration variables:
+
+- **pins** (*Required*): Array of pins to use. The number corresponds with the pin numbering schema of your board.
+ - **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.
+
+The 6 analog pins of an Arduino UNO are numbered from A0 to A5.
+
diff --git a/source/components/sensor.arest.markdown b/source/components/sensor.arest.markdown
new file mode 100644
index 00000000000..8b6eef520f8
--- /dev/null
+++ b/source/components/sensor.arest.markdown
@@ -0,0 +1,119 @@
+---
+layout: page
+title: "aREST support"
+description: "Instructions how to integrate aREST sensors within Home Assistant."
+date: 2015-09-07 18:15
+sidebar: false
+comments: false
+sharing: true
+footer: true
+---
+
+
+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](http://arest.io/) RESTful framework.
+
+To use your aREST enabled device in your installation, add the following to your `configuration.yaml` file:
+
+```yaml
+# Example configuration.yaml entry
+sensor:
+ platform: arest
+ resource: http://IP_ADDRESS
+ monitored_variables:
+ - name: temperature
+ unit: '°C'
+ - name: humidity
+ unit: '%'
+```
+
+Configuration variables:
+
+- **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.
+
+```c
+/*
+ This modified sketch is based on the Ethernet example of the aREST
+ (http://arest.io/) library.
+*/
+
+// Libraries
+#include
+A sensor platform that issues specific commands git get data. This might very well become our most platform as it allows anyone to integrate any type of switch into Home Assistant that can be controlled from the command line, including calling other scripts!
+
+To enable it, add the following lines to your `configuration.yaml`:
+
+```yaml
+# Example configuration.yaml entry
+sensor:
+ platform: command_sensor
+ command: SENSOR_COMMAND
+ name: "Command sensor"
+ unit_of_measurement: "°C"
+ correction_factor: 0.4921
+```
+
+Configuration variables:
+
+- **command** (*Required*): The action to take to get the value.
+- **name** (*Optional*): Name of the command sensor.
+- **unit_of_measurement** (*Optional*): Defines the units of measurement of the sensor, if any.
+- **correction_factor** (*Optional*): A float value to do some basic calculations.
+
+## {% linkable_title Examples %}
+
+In this section you find some real life examples of how to use this sensor.
+
+### {% linkable_title Hard drive temperature %}
+
+There are several days to get the temperature of your hard drive. A simple solution is to use [hddtemp](https://savannah.nongnu.org/projects/hddtemp/).
+
+```bash
+hddtemp -n /dev/sda
+```
+
+To use those information, the entry for a sensor in the `configuration.yaml` file will look like this.
+
+```yaml
+# Example configuration.yaml entry
+sensor:
+ platform: command_sensor
+ name: HD Temperature
+ command: "hddtemp -n /dev/sda"
+ unit_of_measurement: "°C"
+```
+
+### {% linkable_title CPU temperature %}
+
+Thanks to the [`proc`](https://en.wikipedia.org/wiki/Procfs) file system various details about a system can be retrieved. Here the CPU temperature
+is of interest. Add something similar to your `configuration.yaml` file:
+
+```yaml
+# Example configuration.yaml entry
+ - platform: command_sensor
+ name: CPU Temperature
+ command: "cat /sys/class/thermal/thermal_zone0/temp"
+ unit_of_measurement: "°C"
+ correction_factor: 0.001
+```
+
+The `correction_factor` will make sure that the value is shown in a useful format in the frontend.
+
+### {% linkable_title Use an external script %}
+
+The example is doing the same as the [aREST sensor](/components/sensor.arest.html) but with an external Python script. It should give you an idea about interacting with devices which are exposing a REST API.
+
+The one-line script to retrieve a value is shown below. Of course would it be possible to use this directly in the `configuration.yaml` file but need extra care about the quotation marks.
+
+```python
+python3 -c "import requests; print(requests.get('http://10.0.0.48/analog/2').json()['return_value'])"
+```
+
+The script (saved as `arest-value.py`) that is used looks like the example below.
+
+```python
+#!/usr/bin/python3
+#
+from requests import get
+response = get('http://10.0.0.48/analog/2')
+print(response.json()['return_value'])
+```
+
+To use the script you need to add something like the following to your `configuration.yaml` file.
+
+```yaml
+# Example configuration.yaml entry
+sensor:
+ platform: command_sensor
+ name: Brightness
+ command: "python3 /path/to/script/arest-value.py"
+ unit_of_measurement: "°C"
+```
+
diff --git a/source/components/sensor.dht.markdown b/source/components/sensor.dht.markdown
index 4feed1facee..3a7df9c5a3e 100644
--- a/source/components/sensor.dht.markdown
+++ b/source/components/sensor.dht.markdown
@@ -9,6 +9,7 @@ sharing: true
footer: true
---
+
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:
@@ -24,6 +25,16 @@ sensor:
- humidity
```
+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/source/components/sensor.efergy.markdown b/source/components/sensor.efergy.markdown
index 7886ef0e459..80d36973fff 100644
--- a/source/components/sensor.efergy.markdown
+++ b/source/components/sensor.efergy.markdown
@@ -25,3 +25,14 @@ sensor:
period: day
currency: $
```
+
+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.
+
diff --git a/source/components/sensor.forecast.markdown b/source/components/sensor.forecast.markdown
index d5c15ef437a..9a2534f9eca 100644
--- a/source/components/sensor.forecast.markdown
+++ b/source/components/sensor.forecast.markdown
@@ -12,7 +12,7 @@ footer: true
The forecast platform uses the [Forecast.io](https://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](https://developer.forecast.io/register).
+You need an API key which is free but requires a [registration](https://developer.forecast.io/register). 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:
@@ -35,4 +35,22 @@ sensor:
- visibility
- ozone
```
-Details about the API are available in the (Forecast.io documentation)[https://developer.forecast.io/docs/v2].
+
+Configuration variables:
+
+- **api_key** (*Required*): Your API key for http://forecast.io/.
+- **display_conditions** array (*Required*): Conditions to display in the frontend.
+ - **summary**: A human-readable text summary.
+ - **precip_type**: The type of precipitation occurring.
+ - **precip_intensity**: The average expected intensity of precipitation occurring.
+ - **temperature**: The current temperature.
+ - **dew_point**: The dew point.
+ - **wind_speed**: The wind speed.
+ - **wind_bearing**: Where the wind is coming from in degrees, with true north at 0° and progressing clockwise.
+ - **cloud_cover**: The percentage of sky occluded by clouds.
+ - **humidity**: The relative humidity.
+ - **pressure**: The sea-level air pressure in millibars.
+ - **visibility**: The average visibility.
+ - **ozone**: The columnar density of total atmospheric ozone in Dobson.
+
+Details about the API are available in the [Forecast.io documentation](https://developer.forecast.io/docs/v2).
diff --git a/source/components/sensor.glances.markdown b/source/components/sensor.glances.markdown
new file mode 100644
index 00000000000..205f179fcf3
--- /dev/null
+++ b/source/components/sensor.glances.markdown
@@ -0,0 +1,68 @@
+---
+layout: page
+title: "Glances sensor support"
+description: "Instructions how to integrate Glances sensors into Home Assistant."
+date: 2015-09-14 19:10
+sidebar: false
+comments: false
+sharing: true
+footer: true
+---
+
+
+The glances sensor platform is consuming the system information provided by the [Glances](https://github.com/nicolargo/glances) API. This enables one to track remote host and display their stats in Home Assistant.
+
+This sensors needs a running isntance of `glances` on the host:
+
+```bash
+glances -w
+Glances web server started on http://0.0.0.0:61208/
+```
+
+To enable the glances sensor, add the following lines to your `configuration.yaml`:
+
+```yaml
+# Example configuration.yaml entry
+sensor:
+ platform: glances
+ name: Glances sensor
+ host: IP_ADDRESS
+ port: 61208
+ resources:
+ - 'disk_use_percent'
+ - 'disk_use'
+ - 'disk_free'
+ - 'memory_use_percent'
+ - 'memory_use'
+ - 'memory_free'
+ - 'swap_use_percent'
+ - 'swap_use'
+ - 'swap_free'
+ - 'processor_load'
+ - 'process_running'
+ - 'process_total'
+ - 'process_thread'
+ - 'process_sleeping'
+```
+
+Configuration variables:
+
+- **host** (*Required*): The IP address of your host, eg. 192.168.1.32.
+- **port** (*Option*): The network port to connect to. Default is 61208.
+- **name** (*Optional*): Name of the Glances sensor.
+- **resources** (*Required*): Entries to monitor.
+ - **'disk_use_percent'**: Used disk space in percent
+ - **'disk_use'**: Used disk space
+ - **'disk_free'**: Free disk space
+ - **'memory_use_percent'**: Used memory in percent
+ - **'memory_use'**: Used memory
+ - **'memory_free'**: Free memory
+ - **'swap_use_percent'**: Used swap space in percent
+ - **'swap_use'**: Used swap space
+ - **'swap_free'**: Free swap space
+ - **'processor_load'**: Load
+ - **'process_running'**: Number of running processes
+ - **'process_total'**: Total number of processes
+ - **'process_thread'**: Number of threads
+ - **'process_sleeping'**: Number of sleeping processes
+
diff --git a/source/components/sensor.mqtt.markdown b/source/components/sensor.mqtt.markdown
index a07f9edb8cd..442d53b4044 100644
--- a/source/components/sensor.mqtt.markdown
+++ b/source/components/sensor.mqtt.markdown
@@ -19,13 +19,15 @@ last known value. Otherwise, the initial state will be undefined.
# Example configuration.yml entry
sensor:
platform: mqtt
- name: "MQTT Sensor"
state_topic: "home/bedroom/temperature"
- unit_of_measurement: "ºC"
+ name: "MQTT Sensor"
+ 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*
-
-unit_of_measurement: Defines the units of measurement of the sensor, if any. *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.
diff --git a/source/components/sensor.mysensors.markdown b/source/components/sensor.mysensors.markdown
index df659179aee..2566cc3fa4a 100644
--- a/source/components/sensor.mysensors.markdown
+++ b/source/components/sensor.mysensors.markdown
@@ -10,7 +10,9 @@ footer: true
---
-Integrate your [MySensors sensors](https://www.mysensors.org) by adding the following to your `configuration.yaml`:
+The [MySensors](https://www.mysensors.org) project combines Arduino boards with NRF24L01 radio boards to build sensor networks.
+
+Integrate your Serial MYSensors Gateway by adding the following to your `configuration.yaml`:
```yaml
# Example configuration.yaml entry
@@ -18,3 +20,11 @@ sensor:
platform: mysensors
port: /dev/ttyACM0
```
+
+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*`.
+
+```bash
+ls /dev/ttyACM*
+```
diff --git a/source/components/sensor.openweathermap.markdown b/source/components/sensor.openweathermap.markdown
index 7c292bc0d9e..4695ee6d5a0 100644
--- a/source/components/sensor.openweathermap.markdown
+++ b/source/components/sensor.openweathermap.markdown
@@ -33,5 +33,19 @@ sensor:
- snow
```
+Configuration variables:
+
+- **api_key** (*Required*): Your API key for http://openweathermap.org/.
+- **forecast** (*Optional*): Enables the forecast. The default is to display the current conditions.
+- **display_conditions** array (*Required*): Conditions to display in the frontend.
+ - **weather**: A human-readable text summary.
+ - **temperature**: The current temperature.
+ - **wind_speed**: The wind speed.
+ - **humidity**: The relative humidity.
+ - **pressure**: The sea-level air pressure in millibars.
+ - **clouds**: Description about cloud coverage.
+ - **rain**: The rain volume.
+ - **snow**: The snow volume
+
Details about the API are available in the [OpenWeatherMap documentation](http://bugs.openweathermap.org/projects/api/wiki).
diff --git a/source/components/sensor.rfxtrx.markdown b/source/components/sensor.rfxtrx.markdown
index c1309abcded..392e8db6210 100644
--- a/source/components/sensor.rfxtrx.markdown
+++ b/source/components/sensor.rfxtrx.markdown
@@ -15,9 +15,14 @@ To enable the RFXtrx sensors in your installation, add the following to your `co
```yaml
# Example configuration.yaml entry
sensor:
- - 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/source/components/sensor.swiss_public_transport.markdown b/source/components/sensor.swiss_public_transport.markdown
index c24cdd5a752..838c3df7a60 100644
--- a/source/components/sensor.swiss_public_transport.markdown
+++ b/source/components/sensor.swiss_public_transport.markdown
@@ -24,7 +24,11 @@ sensor:
platform: swiss_public_transport
from: STATION_ID
to: STATION_ID
-
```
+Configuration variables:
+
+- **from** (*Required*): The ID of the station of the start station.
+- **to** (*Required*): The ID of the station of the end station.
+
The public timetables are coming from [Swiss public transport](http://transport.opendata.ch).
diff --git a/source/components/sensor.systemmonitor.markdown b/source/components/sensor.systemmonitor.markdown
index 99e3784efdf..c545f660281 100644
--- a/source/components/sensor.systemmonitor.markdown
+++ b/source/components/sensor.systemmonitor.markdown
@@ -25,6 +25,13 @@ sensor:
- type: processor_use
```
+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.
| Type (- type:) | Argument (arg:) |
diff --git a/source/components/sensor.transmission.markdown b/source/components/sensor.transmission.markdown
index a28fe5c92f9..d886ea22b2a 100644
--- a/source/components/sensor.transmission.markdown
+++ b/source/components/sensor.transmission.markdown
@@ -16,21 +16,34 @@ The [Transmission](http://www.transmissionbt.com/) platform allows you to monito
# Example configuration.yaml entry
sensor:
platform: transmission
- name: Transmission
host: 192.168.1.26
port: 9091
+ name: Transmission
username: YOUR_USERNAME
password: YOUR_PASSWORD
monitored_variables:
- - type: 'current_status'
- - type: 'download_speed'
- - type: 'upload_speed'
+ - 'current_status'
+ - 'download_speed'
+ - 'upload_speed'
```
+Configuration variables:
+
+- **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.
- 
+ 
+The arduino switch platform allows you to control the digital pins of your [Arduino](https://www.arduino.cc/) board. Support for switching pins is limited to high/on and low/off of the digital pins. PWM (pin 3,5,6,9,10, and 11 on an Arduino Uno) is not supported yet.
+
+To enable the Arduino pins with Home Assistant, add the following section to your `configuration.yaml` file:
+
+```yaml
+# Example configuration.yaml entry
+switch:
+ platform: arduino
+ pins:
+ 11:
+ name: Fan Office
+ type: digital
+ 12:
+ name: Light Desk
+ type: digital
+```
+
+Configuration variables:
+
+- **pins** (*Required*): Array of pins to use. The number corresponds with the pin numbering schema of your board.
+ - **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.
+
diff --git a/source/components/switch.arest.markdown b/source/components/switch.arest.markdown
new file mode 100644
index 00000000000..38b6380d38c
--- /dev/null
+++ b/source/components/switch.arest.markdown
@@ -0,0 +1,40 @@
+---
+layout: page
+title: "aREST switch support"
+description: "Instructions how to integrate aREST switches within Home Assistant."
+date: 2015-09-11 23:15
+sidebar: false
+comments: false
+sharing: true
+footer: true
+---
+
+
+The arest switch platform allows you to toggle pins of your devices (like Arduino boards with a ethernet/wifi connection, the ESP8266, and the Raspberry Pi) running the [aREST](http://arest.io/) RESTful framework.
+
+To use your aREST enabled device in your installation, add the following to your `configuration.yaml` file:
+
+```yaml
+# Example configuration.yaml entry
+switch:
+ platform: arest
+ resource: http://IP_ADDRESS
+ pins:
+ 11:
+ name: Fan Office
+ 12:
+ name: Light Desk
+```
+
+Configuration variables:
+
+- **resource** (*Required*): IP address and schema of the device that is exposing an aREST API, e.g. http://192.168.1.10.
+- **pins** (*Required*): An array with all used pins of your board.
+ - **name** (*Required*): The name of the pin you wish to toggle.
+
+Accessing one of the endpoints (eg. http://192.168.1.10/analog/2/) will give you a JSON response. The interesting part is `return_value` which represents the sensor's data.
+
+```json
+{"return_value": 34, "id": "sensor02", "name": "livingroom", "connected": true}
+```
+
diff --git a/source/components/switch.command_switch.markdown b/source/components/switch.command_switch.markdown
index 407fdee7372..0d4a634c6aa 100644
--- a/source/components/switch.command_switch.markdown
+++ b/source/components/switch.command_switch.markdown
@@ -14,7 +14,7 @@ A switch platform that issues specific commands when it is turned on and off. Th
To enable it, add the following lines to your `configuration.yaml`:
-```
+```yaml
# Example configuration.yaml entry
switch:
platform: command_switch
@@ -23,3 +23,24 @@ switch:
oncmd: switch_command on kitchen
offcmd: switch_command off kitchen
```
+
+Configuration variables:
+
+- **switches** (*Required*): The array that 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.
+
+
+The example below is doing the same as the [aREST switch](/components/switch.arest.html). The commandline tool `[curl](http://curl.haxx.se/)` is used to toogle a pin which is controllable through REST.
+
+```yaml
+# Example configuration.yaml entry
+switch:
+ platform: command_switch
+ switches:
+ arest_pin4:
+ oncmd: "/usr/bin/curl -X GET http://192.168.1.10/digital/4/1"
+ offcmd: "/usr/bin/curl -X GET http://192.168.1.10/digital/4/0"
+```
+
diff --git a/source/components/switch.edimax.markdown b/source/components/switch.edimax.markdown
index cbe99fafe09..5beb4bcf0e8 100644
--- a/source/components/switch.edimax.markdown
+++ b/source/components/switch.edimax.markdown
@@ -23,3 +23,11 @@ switch:
password: YOUR_PASSWORD
name: Edimax Smart Plug
```
+
+Configuration variables:
+
+- **host** (*Required*): The IP address of your Edimax switch, eg. 192.168.1.32
+- **username** (*Required*): Your username for the Edimax switch.
+- **password** (*Required*): Your password for the Edimax switch.
+- **name** (*Optional*): The name to use when displaying this switch.
+
diff --git a/source/components/switch.hikvision.markdown b/source/components/switch.hikvision.markdown
index 942fea08b96..bf19ab5f7eb 100644
--- a/source/components/switch.hikvision.markdown
+++ b/source/components/switch.hikvision.markdown
@@ -18,8 +18,15 @@ To use your Hikvision cam in your installation, add the following to your `confi
# Example configuration.yaml entry
switch:
platform: hikvisioncam
+ host: 192.168.1.32
name: Hikvision Cam 1 Motion Detection
- host: 192.168.1.26
- username: YOUR_USERNAME
- password: YOUR_PASSWORD
+ username: USERNAME
+ password: PASSWORD
```
+
+Configuration variables:
+
+- **host** *Required*: The IP address of your Hikvision camera, eg. 192.168.1.32
+- **name** *Optional*: This parameter allows you to override the name of your camera.
+- **username** *Required*: The username for accessing your Hikvision camera.
+- **password** *Required*: The password to access your Hikvision camera.
diff --git a/source/components/switch.mqtt.markdown b/source/components/switch.mqtt.markdown
index 69a1552806a..ac0ff005e97 100644
--- a/source/components/switch.mqtt.markdown
+++ b/source/components/switch.mqtt.markdown
@@ -25,25 +25,28 @@ Optimistic mode can be forced, even if state topic is available.
Try to enable it, if experiencing incorrect switch operation.
```yaml
-# Example configuration.yml entr
+# Example configuration.yml entry
switch:
platform: mqtt
name: "Bedroom Switch"
state_topic: "home/bedroom/switch1"
command_topic: "home/bedroom/switch1/set"
+ qos: 0
payload_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*
-
-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*
+
+Make sure that your topics match exact. some-topic/ and some-topic are different topics.
+
The TellStick Home Assistant integration allows users to add switches and sensors.
To get started, add the following information to your `configuration.yaml`:
-```YAML
+```yaml
+# Example configuration.yaml entry
switch:
platform: tellstick
@@ -32,3 +34,5 @@ light:
platform: tellstick
```
+
+
diff --git a/source/components/thermostat.nest.markdown b/source/components/thermostat.nest.markdown
index ca75e22a1fb..e4446633758 100644
--- a/source/components/thermostat.nest.markdown
+++ b/source/components/thermostat.nest.markdown
@@ -17,10 +17,15 @@ To set it up, add the following information to your `configuration.yaml` file:
```
thermostat:
platform: nest
- username: myemail@mydomain.com
- password: mypassword
+ username: USERNAME
+ password: PASSWORD
```
+Configuration variables:
+
+- **username** (*Required*): Your Nest username.
+- **password** (*Required*): Your Nest password.
+
diff --git a/source/components/zwave.markdown b/source/components/zwave.markdown
index 26b72d34268..a6c887fd1dc 100644
--- a/source/components/zwave.markdown
+++ b/source/components/zwave.markdown
@@ -31,3 +31,11 @@ As an alternative, the Home Assistant docker image has support for Z-Wave built-
zwave:
usb_path: /dev/ttyUSB0
```
+
+Configuration variables:
+
+- **usb_path** (*Required*): The port where your device is connected to your Home Assistant host.
+
+```bash
+ls /dev/ttyUSB*
+```
diff --git a/source/demo/frontend.html b/source/demo/frontend.html
index d12500c2873..9f0ffe78e3d 100644
--- a/source/demo/frontend.html
+++ b/source/demo/frontend.html
@@ -5087,7 +5087,7 @@ paper-ripple {
console.group&&(console.groupCollapsed("Dispatch: %s",t),console.group("payload"),console.debug(e),console.groupEnd())},e.dispatchError=function(t){console.group&&(console.debug("Dispatch error: "+t),console.groupEnd())},e.storeHandled=function(t,e,n){console.group&&e!==n&&console.debug("Store "+t+" handled action")},e.dispatchEnd=function(t){console.group&&(console.debug("Dispatch done, new state: ",t.toJS()),console.groupEnd())}},function(t,e,n){function r(t,e){this.__prevState=t,this.__evaluator=e,this.__prevValues=i.Map(),this.__observers=[]}var i=n(2),o=n(7),a=n(8);Object.defineProperty(r.prototype,"notifyObservers",{writable:!0,configurable:!0,value:function(t){if(this.__observers.length>0){var e=i.Map();this.__observers.forEach(function(n){var r,i=n.getter,u=o(i),s=this.__prevState;this.__prevValues.has(u)?r=this.__prevValues.get(u):(r=this.__evaluator.evaluate(s,i),this.__prevValues=this.__prevValues.set(u,r));var c=this.__evaluator.evaluate(t,i);a(r,c)||(n.handler.call(null,c),e=e.set(u,c))}.bind(this)),this.__prevValues=e}this.__prevState=t}}),Object.defineProperty(r.prototype,"onChange",{writable:!0,configurable:!0,value:function(t,e){var n={getter:t,handler:e};return this.__observers.push(n),function(){var t=this.__observers.indexOf(n);t>-1&&this.__observers.splice(t,1)}.bind(this)}}),Object.defineProperty(r.prototype,"reset",{writable:!0,configurable:!0,value:function(t){this.__prevState=t,this.__prevValues=i.Map(),this.__observers=[]}}),t.exports=r},function(t,e,n){var r=n(2);t.exports=function(t,e){if(t.hasOwnProperty("__hashCode"))return t.__hashCode;var n=r.fromJS(t).hashCode();return e||(Object.defineProperty(t,"__hashCode",{enumerable:!1,configurable:!1,writable:!1,value:n}),Object.freeze(t)),n}},function(t,e,n){var r=n(2);t.exports=function(t,e){return r.is(t,e)}},function(t,e,n){function r(t){return s(t)&&u(t[t.length-1])}function i(t){return t[t.length-1]}function o(t){return t.slice(0,t.length-1)}function a(t){if(!c(t))throw new Error("Cannot create Getter from KeyPath: "+t);return[t,l]}var u=n(3).isFunction,s=n(3).isArray,c=n(10).isKeyPath,l=function(t){return t};t.exports={isGetter:r,getComputeFn:i,getDeps:o,fromKeyPath:a}},function(t,e,n){var r=n(3).isArray,i=n(3).isFunction;e.isKeyPath=function(t){return r(t)&&!i(t[t.length-1])}},function(t,e,n){function r(){this.__cachedGetters=i.Map({})}var i=n(2),o=n(1).toImmutable,a=n(7),u=n(8),s=n(9).getComputeFn,c=n(9).getDeps,l=n(10).isKeyPath,f=n(9).isGetter,d=!1;Object.defineProperty(r.prototype,"evaluate",{writable:!0,configurable:!0,value:function(t,e){if(l(e))return t.getIn(e);if(!f(e))throw new Error("evaluate must be passed a keyPath or Getter");var n=a(e);if(this.__isCached(t,e))return this.__cachedGetters.getIn([n,"value"]);var r=c(e).map(function(e){return this.evaluate(t,e)}.bind(this));if(this.__hasStaleValue(t,e)){var i=this.__cachedGetters.getIn([n,"args"]);if(u(i,o(r))){var h=this.__cachedGetters.getIn([n,"value"]);return this.__cacheValue(t,e,i,h),h}}if(d===!0)throw d=!1,new Error("Evaluate may not be called within a Getters computeFn");var p;d=!0;try{p=s(e).apply(null,r),d=!1}catch(_){throw d=!1,_}return this.__cacheValue(t,e,r,p),p}}),Object.defineProperty(r.prototype,"__hasStaleValue",{writable:!0,configurable:!0,value:function(t,e){var n=a(e),r=this.__cachedGetters;return r.has(n)&&r.getIn([n,"stateHashCode"])!==t.hashCode()}}),Object.defineProperty(r.prototype,"__cacheValue",{writable:!0,configurable:!0,value:function(t,e,n,r){var u=a(e);this.__cachedGetters=this.__cachedGetters.set(u,i.Map({value:r,args:o(n),stateHashCode:t.hashCode()}))}}),Object.defineProperty(r.prototype,"__isCached",{writable:!0,configurable:!0,value:function(t,e){var n=a(e);return this.__cachedGetters.hasIn([n,"value"])&&this.__cachedGetters.getIn([n,"stateHashCode"])===t.hashCode()}}),Object.defineProperty(r.prototype,"untrack",{writable:!0,configurable:!0,value:function(t){}}),Object.defineProperty(r.prototype,"reset",{writable:!0,configurable:!0,value:function(){this.__cachedGetters=i.Map({})}}),t.exports=r},function(t,e,n){function r(t,e){var n={};return i(e,function(e,r){n[r]=t.evaluate(e)}),n}var i=n(3).each;t.exports=function(t){return{getInitialState:function(){return r(t,this.getDataBindings())},componentDidMount:function(){var e=this;e.__unwatchFns=[],i(this.getDataBindings(),function(n,r){var i=t.observe(n,function(t){var n={};n[r]=t,e.setState(n)});e.__unwatchFns.push(i)})},componentWillUnmount:function(){for(;this.__unwatchFns.length;)this.__unwatchFns.shift()()}}}},function(t,e,n){function r(t){return this instanceof r?(this.__handlers=o({}),t&&a(this,t),void this.initialize()):new r(t)}function i(t){return t instanceof r}var o=n(2).Map,a=n(3).extend,u=n(1).toJS,s=n(1).toImmutable;Object.defineProperty(r.prototype,"initialize",{writable:!0,configurable:!0,value:function(){}}),Object.defineProperty(r.prototype,"getInitialState",{writable:!0,configurable:!0,value:function(){return o()}}),Object.defineProperty(r.prototype,"handle",{writable:!0,configurable:!0,value:function(t,e,n){var r=this.__handlers.get(e);return"function"==typeof r?r.call(this,t,n,e):t}}),Object.defineProperty(r.prototype,"handleReset",{writable:!0,configurable:!0,value:function(t){return this.getInitialState()}}),Object.defineProperty(r.prototype,"on",{writable:!0,configurable:!0,value:function(t,e){this.__handlers=this.__handlers.set(t,e)}}),Object.defineProperty(r.prototype,"serialize",{writable:!0,configurable:!0,value:function(t){return u(t)}}),Object.defineProperty(r.prototype,"deserialize",{writable:!0,configurable:!0,value:function(t){return s(t)}}),t.exports=r,t.exports.isStore=i}])})},function(t,e,n){"use strict";function r(t){return t&&t.__esModule?t:{"default":t}}Object.defineProperty(e,"__esModule",{value:!0});var i=n(2),o=n(175),a=r(o);e["default"]=a["default"](i.reactor),t.exports=e["default"]},function(t,e){"use strict";var n=function(t){var e,n={};if(!(t instanceof Object)||Array.isArray(t))throw new Error("keyMirror(...): Argument must be an object.");for(e in t)t.hasOwnProperty(e)&&(n[e]=e);return n};t.exports=n},function(t,e){"use strict";function n(t){var e=typeof t;return!!t&&("object"==e||"function"==e)}t.exports=n},function(t,e,n){"use strict";function r(t){return t&&t.__esModule?t:{"default":t}}Object.defineProperty(e,"__esModule",{value:!0});var i=n(184),o=r(i);e.callApi=o["default"]},function(t,e,n){"use strict";function r(t){return i(t)?t:Object(t)}var i=n(6);t.exports=r},function(t,e,n){"use strict";var r=n(20),i=n(12),o=n(13),a="[object Array]",u=Object.prototype,s=u.toString,c=r(Array,"isArray"),l=c||function(t){return o(t)&&i(t.length)&&s.call(t)==a};t.exports=l},function(t,e,n){"use strict";function r(t){if(t&&t.__esModule)return t;var e={};if(null!=t)for(var n in t)Object.prototype.hasOwnProperty.call(t,n)&&(e[n]=t[n]);return e["default"]=t,e}function i(t){return t&&t.__esModule?t:{"default":t}}Object.defineProperty(e,"__esModule",{value:!0});var o=n(207),a=i(o),u=n(208),s=r(u),c=a["default"];e.actions=c;var l=s;e.getters=l},function(t,e,n){"use strict";function r(t){return t&&t.__esModule?t:{"default":t}}function i(t){t.registerStores({restApiCache:l["default"]})}function o(t){return[["restApiCache",t.entity],function(t){return!!t}]}function a(t){return[["restApiCache",t.entity],function(t){return t||s.toImmutable({})}]}function u(t){return function(e){return["restApiCache",t.entity,e]}}Object.defineProperty(e,"__esModule",{value:!0}),e.register=i,e.createHasDataGetter=o,e.createEntityMapGetter=a,e.createByIdGetter=u;var s=n(3),c=n(231),l=r(c),f=n(230),d=r(f);e.createApiActions=d["default"]},function(t,e){"use strict";function n(t){return"number"==typeof t&&t>-1&&t%1==0&&r>=t}var r=9007199254740991;t.exports=n},function(t,e){"use strict";function n(t){return!!t&&"object"==typeof t}t.exports=n},function(t,e,n){"use strict";function r(t){return t&&t.__esModule?t:{"default":t}}Object.defineProperty(e,"__esModule",{value:!0});var i=n(1),o=r(i);e["default"]=new o["default"]({is:"partial-base",properties:{narrow:{type:Boolean,value:!1},showMenu:{type:Boolean,value:!1}},computeMenuButtonClass:function(t,e){return!t&&e?"invisible":""},toggleMenu:function(){this.fire("open-menu")}}),t.exports=e["default"]},function(t,e,n){"use strict";function r(t){return t&&t.__esModule?t:{"default":t}}Object.defineProperty(e,"__esModule",{value:!0});var i=n(5),o=r(i);e["default"]=o["default"]({ENTITY_HISTORY_DATE_SELECTED:null,ENTITY_HISTORY_FETCH_START:null,ENTITY_HISTORY_FETCH_ERROR:null,ENTITY_HISTORY_FETCH_SUCCESS:null,RECENT_ENTITY_HISTORY_FETCH_START:null,RECENT_ENTITY_HISTORY_FETCH_ERROR:null,RECENT_ENTITY_HISTORY_FETCH_SUCCESS:null,LOG_OUT:null}),t.exports=e["default"]},function(t,e,n){"use strict";function r(t){return null!=t&&o(i(t))}var i=n(49),o=n(12);t.exports=r},function(t,e,n){"use strict";function r(t){return t&&t.__esModule?t:{"default":t}}Object.defineProperty(e,"__esModule",{value:!0});var i=n(1),o=r(i);n(137),n(58),e["default"]=new o["default"]({is:"state-info",properties:{stateObj:{type:Object}}}),t.exports=e["default"]},function(t,e,n){"use strict";function r(t){return t&&t.__esModule?t:{"default":t}}Object.defineProperty(e,"__esModule",{value:!0});var i=n(5),o=r(i);e["default"]=o["default"]({LOGBOOK_DATE_SELECTED:null,LOGBOOK_ENTRIES_FETCH_START:null,LOGBOOK_ENTRIES_FETCH_ERROR:null,LOGBOOK_ENTRIES_FETCH_SUCCESS:null}),t.exports=e["default"]},function(t,e,n){"use strict";function r(t){if(t&&t.__esModule)return t;var e={};if(null!=t)for(var n in t)Object.prototype.hasOwnProperty.call(t,n)&&(e[n]=t[n]);return e["default"]=t,e}function i(t){return t&&t.__esModule?t:{"default":t}}Object.defineProperty(e,"__esModule",{value:!0});var o=n(232),a=i(o),u=n(79),s=r(u),c=a["default"];e.actions=c;var l=s;e.getters=l},function(t,e,n){"use strict";function r(t,e){var n=null==t?void 0:t[e];return i(n)?n:void 0}var i=n(126);t.exports=r},function(t,e,n){"use strict";function r(t){return t&&t.__esModule?t:{"default":t}}Object.defineProperty(e,"__esModule",{value:!0});var i=n(5),o=r(i);e["default"]=o["default"]({VALIDATING_AUTH_TOKEN:null,VALID_AUTH_TOKEN:null,INVALID_AUTH_TOKEN:null,LOG_OUT:null}),t.exports=e["default"]},function(t,e,n){"use strict";function r(t){if(t&&t.__esModule)return t;var e={};if(null!=t)for(var n in t)Object.prototype.hasOwnProperty.call(t,n)&&(e[n]=t[n]);return e["default"]=t,e}function i(t){return t&&t.__esModule?t:{"default":t}}function o(t){t.registerStores({authAttempt:u["default"],authCurrent:c["default"],rememberAuth:f["default"]})}Object.defineProperty(e,"__esModule",{value:!0}),e.register=o;var a=n(187),u=i(a),s=n(188),c=i(s),l=n(189),f=i(l),d=n(185),h=r(d),p=n(186),_=r(p),v=h;e.actions=v;var y=_;e.getters=y},function(t,e,n){"use strict";function r(t){return t&&t.__esModule?t:{"default":t}}function i(t,e){if(!(t instanceof e))throw new TypeError("Cannot call a class as a function")}function o(t,e){if("function"!=typeof e&&null!==e)throw new TypeError("Super expression must either be null or a function, not "+typeof e);t.prototype=Object.create(e&&e.prototype,{constructor:{value:t,enumerable:!1,writable:!0,configurable:!0}}),e&&(Object.setPrototypeOf?Object.setPrototypeOf(t,e):t.__proto__=e)}Object.defineProperty(e,"__esModule",{value:!0});var a=function(){function t(t,e){var n=[],r=!0,i=!1,o=void 0;try{for(var a,u=t[Symbol.iterator]();!(r=(a=u.next()).done)&&(n.push(a.value),!e||n.length!==e);r=!0);}catch(s){i=!0,o=s}finally{try{!r&&u["return"]&&u["return"]()}finally{if(i)throw o}}return n}return function(e,n){if(Array.isArray(e))return e;if(Symbol.iterator in Object(e))return t(e,n);throw new TypeError("Invalid attempt to destructure non-iterable instance")}}(),u=function(){function t(t,e){for(var n=0;n