The nx584 platform provides integration with GE, Caddx, Interlogix (and other brands) alarm panels that support the NX584 interface module (or have it built in). Supported panels include NX4/6/8/8E. Actual integration is done through pynx584 which is required for this to work.
+
+
To enable this, add the following lines to your configuration.yaml:
host (Optional): This is the host connection string (host:port) for the nx584 server process. If unset, it is assumed to be localhost:5007, which will work if the server process is running on the same system as home-assistant.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/components/alarm_control_panel/index.html b/components/alarm_control_panel/index.html
index 0e062c50c2..3fb7e853df 100644
--- a/components/alarm_control_panel/index.html
+++ b/components/alarm_control_panel/index.html
@@ -149,6 +149,9 @@
APCUPSd status information can be integrated into Home Assistant when the Network Information Server (NIS) is configured.
+
+
Create an apcupsd section in your configuration, optionally containing the following parameters:
+
+
+
host: The hostname/IP address on which the APCUPSd NIS is being served. Default: localhost
+
port: The port on which the APCUPSd NIS is listening. Default: 3551
+
+
+
Example
+
+
Use defaults:
+
+
+
apcupsd:
+
+
+
+
+
Set parameters:
+
+
+
apcupsd:
+ host: 192.168.1.10
+ port: 1234
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/components/automation/index.html b/components/automation/index.html
index 054cf9164e..520d2750da 100644
--- a/components/automation/index.html
+++ b/components/automation/index.html
@@ -524,6 +524,9 @@ INFO [homeassistant.components.automation] Initialized rule Rain is over
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/components/binary_sensor.arest/index.html b/components/binary_sensor.arest/index.html
index 6041b191ee..8a3ff0065d 100644
--- a/components/binary_sensor.arest/index.html
+++ b/components/binary_sensor.arest/index.html
@@ -180,6 +180,9 @@ This sensor is not suitable for fast state changes because there is a high possi
diff --git a/components/binary_sensor.rest/index.html b/components/binary_sensor.rest/index.html
index 97d7ea04e7..7d96d8fa7d 100644
--- a/components/binary_sensor.rest/index.html
+++ b/components/binary_sensor.rest/index.html
@@ -177,6 +177,9 @@ Make sure that the URL matches exactly your endpoint or resource.
diff --git a/components/binary_sensor.rpi_gpio/index.html b/components/binary_sensor.rpi_gpio/index.html
index aa3d8689e9..6f8e90be05 100644
--- a/components/binary_sensor.rpi_gpio/index.html
+++ b/components/binary_sensor.rpi_gpio/index.html
@@ -181,9 +181,15 @@ To avoid having to run Home Assistant as root when using this component, run a R
The bloomsky camera component allows you to view the current photo created by the camera in the BloomSky weather station. This can work in concert with BloomSky sensors.
+
+
To enable this camera in your installation, set up the BloomSky component with your API key and add the following to your configuration.yaml file:
+
+
+
# Example configuration.yaml entry
+camera:
+ platform: bloomsky
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/components/camera.foscam/index.html b/components/camera.foscam/index.html
index 27b2da3a12..7f2c5220eb 100644
--- a/components/camera.foscam/index.html
+++ b/components/camera.foscam/index.html
@@ -164,6 +164,9 @@
diff --git a/components/discovery/index.html b/components/discovery/index.html
index b16e1edba8..c8fa067f7d 100644
--- a/components/discovery/index.html
+++ b/components/discovery/index.html
@@ -185,9 +185,15 @@ There is currently a Category Hub
Home Assistant can give you an interface to control any garage door.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/components/group/index.html b/components/group/index.html
index 925bedddbf..ec5a31f221 100644
--- a/components/group/index.html
+++ b/components/group/index.html
@@ -187,6 +187,9 @@ Example of groups shown as views in the frontend.
diff --git a/components/ifttt.manything/index.html b/components/ifttt.manything/index.html
index 4edd6810f8..614e888c44 100644
--- a/components/ifttt.manything/index.html
+++ b/components/ifttt.manything/index.html
@@ -218,6 +218,9 @@ For ManyThing support, you need to set up an on and off
diff --git a/components/ifttt/index.html b/components/ifttt/index.html
index c62709e231..a28f95faba 100644
--- a/components/ifttt/index.html
+++ b/components/ifttt/index.html
@@ -230,6 +230,9 @@ You need to setup a unique trigger for each event you sent to IFTTT.
diff --git a/components/index.html b/components/index.html
index 6fba03165a..7a6d902a89 100644
--- a/components/index.html
+++ b/components/index.html
@@ -148,6 +148,10 @@ Support for these components is provided by the Home Assistant community.
+ Garage Door
+
+
+
History
@@ -178,10 +182,6 @@ Support for these components is provided by the Home Assistant community.
- Others
-
-
-
Presence Detection
@@ -216,6 +216,42 @@ Support for these components is provided by the Home Assistant community.
The input_select component allows the user to define a list of values that can be selected via the frontend and can be used within conditions of automation.
+
+
To enable this platform, add the following lines to your configuration.yaml:
+
+
+
# Example configuration.yaml entry
+input_select:
+ who_cooks:
+ name: Who cooks today
+ options:
+ - Paulus
+ - Anne Therese
+ initial: Anne Therese
+ icon: mdi:panda
+ living_room_preset:
+ options:
+ - Visitors
+ - Visitors with kids
+ - Home Alone
+
+
+
+
+
Configuration variables:
+
+
+
[alias] (Required): Alias for the input.
+
name (Optional): Friendly name of the input.
+
options array (Optional): List of options to choose from
+
initial (Optional): Initial value when Home Assistant starts.
+
icon (Optional): Icon for entry.
+
+
+
Pick an icon that you can find on materialdesignicons.com to use for your input and prefix the name with mdi:. For example mdi:car, mdi:ambulance, or mdi:motorbike.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/components/insteon_hub/index.html b/components/insteon_hub/index.html
index d9e1567a85..ab79fa24fe 100644
--- a/components/insteon_hub/index.html
+++ b/components/insteon_hub/index.html
@@ -156,6 +156,12 @@
diff --git a/components/media_player.firetv/index.html b/components/media_player.firetv/index.html
index 38b72d77f7..7762189161 100644
--- a/components/media_player.firetv/index.html
+++ b/components/media_player.firetv/index.html
@@ -208,6 +208,9 @@ Note that python-firetv has support for multiple Amazon Fire TV devices. If you
diff --git a/components/media_player.squeezebox/index.html b/components/media_player.squeezebox/index.html
index 3138ec3bbd..2398c68d12 100644
--- a/components/media_player.squeezebox/index.html
+++ b/components/media_player.squeezebox/index.html
@@ -183,6 +183,9 @@ This lets you control Squeezebox hardware like the Classic, Transporter, Duet, B
diff --git a/components/mqtt/index.html b/components/mqtt/index.html
index bd067334b4..cefe5f448e 100644
--- a/components/mqtt/index.html
+++ b/components/mqtt/index.html
@@ -360,6 +360,12 @@ Home Assistant will automatically load the correct certificate if you connect to
persistence (Optional): Enable or disable local persistence of sensor information. If this is disabled, then each sensor will need to send presentation messages after Home Assistant starts. Default is true.
persistence_file (Optional): Path to a file to save sensor information. The file extension determines the file type. Currently supported file types are ‘pickle’ and ‘json’.
version (Optional): Specifies the MySensors protocol version to use. Supports 1.4 and 1.5. Default is 1.4.
+
baud_rate (Optional): Specifies baud rate of the connected gateway.
If you are using an original Arduino the port will be named ttyACM*. The exact number can be determined with the command shown below.
diff --git a/components/notify.free_mobile/index.html b/components/notify.free_mobile/index.html
index 36101b7692..26d18f1614 100644
--- a/components/notify.free_mobile/index.html
+++ b/components/notify.free_mobile/index.html
@@ -199,6 +199,9 @@ If you disable and re-enable the SMS API option, please be sure to update your t
name (Optional): Setting the optional parameter name allows multiple notifiers to be created. The default value is notify. The notifier will bind to the service notify.NOTIFIER_NAME.
+
resource (Required): The resource or endpoint that will recieve the value.
+
method (Optional): The method of the request. Default is GET.
+
message_param_name (Optional): Parameter name for the message. Defaults to message.
+
title_param_name (Optional): Parameter name for the title. Defaults to none.
+
target_param_name (Optional): Parameter name for the target. Defaults to none.
diff --git a/components/notify.smtp/index.html b/components/notify.smtp/index.html
index 3d07181024..1e9564ec24 100644
--- a/components/notify.smtp/index.html
+++ b/components/notify.smtp/index.html
@@ -210,6 +210,9 @@ which need special attention. By default, the usage by external applications, es
The proximity component allows you to monitor the proximity of devices to a particular zone and the direction of travel. The result is an entity created in Home Assistant which maintains the proximity data.
+
+
This component is useful to reduce the number of automation rules required when wanting to perform automations based on locations outside a particular zone. The zone and state based triggers allow similar control but the number of rules grows exponentially when factors such as direction of travel need to be taken into account.
+
+
Some examples of its use include:
+
+
+
Increase thermostat temperature as you near home
+
Decrease temperature the further away from home you travel
+
+
+
The Proximity entity which is created has the following values:
+
+
+
state: Distance from the monitored zone (in km)
+
dir_of_travel: Direction of the closest device to the monitoed zone. Values are:
+
+
‘not set’
+
‘arrived’
+
‘towards’
+
‘away_from’
+
‘unknown’
+
‘stationary’
+
+
+
dist_to_zone: Distance from the monitored zone (in km)
+
+
+
To enable this component in your installation, add the following to your configuration.yaml file:
zone (Optional): The zone to which this component is measuring the distance to. Default is the home zone.
+
ignored_zones array (Optional): Where proximity is not calculated for a device (either the device being monitored or ones being compared (e.g. work or school).
+
devices array (Optional): A list of devices to compare location against to check closeness to the configured zone.
+
tollerance (Optional): The tolerance used to calculate the direction of travel in meters (m) to filter out small GPS coordinate changes.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/components/rfxtrx/index.html b/components/rfxtrx/index.html
index 7996731c96..04b8e9049c 100644
--- a/components/rfxtrx/index.html
+++ b/components/rfxtrx/index.html
@@ -192,6 +192,12 @@ light.a8__0123454041230170
The SCSGate component support the SCSGate device. This a homebrew device allows to interact with the MyHome system from BTicino/Legrande.
+
+
To enable SCSGate in your installation, add the following to your configuration.yaml file:
+
+
+
# Example configuration.yaml entry
+scsgate:
+ device: PATH_TO_DEVICE
+
+
+
+
+
Configuration variables:
+
+
+
device (Required): The path to your device, e.g. /dev/ttyACM0
+
+
+
How to find the scs_id for your devices
+
+
The SCSGate component relies on the scsgate python module.
+
+
This module provides also a command line tool called scs-monitor. This program can be used to find the IDs of your lights, switches and roller shutters and produce the YAML snippet to insert into your configuration.yaml file.
+
+
For more information checkout this section of scsgate’s documentation.
Any of the lines of output from the apcaccess command can be used as a sensor device in Home Assistant. In order to create a sensor for a value, create an entity within a sensor section of your configuration. The following parameters may be used:
+
+
+
name (Required): The name you’d like to give the sensor in Home Assistant.
+
platform (Required): Set to apcupsd.
+
type (Required): The label for the value you’d like to track based on the output of apcaccess. Refer to the examples for ideas.
The bloomsky sensor component allows you to view the measurements made by sensors in the BloomSky weather station. This can work in concert with the BloomSky camera.
+
+
To enable these sensors in your installation, set up the BloomSky component with your API key add the following to your configuration.yaml file:
diff --git a/components/sensor.efergy/index.html b/components/sensor.efergy/index.html
index 86f536af8c..9e5c382608 100644
--- a/components/sensor.efergy/index.html
+++ b/components/sensor.efergy/index.html
@@ -166,9 +166,15 @@ negative number of minutes your timezone is ahead/behind UTC time.
diff --git a/components/sensor.glances/index.html b/components/sensor.glances/index.html
index 5be4dddbc5..46bd5ffcb8 100644
--- a/components/sensor.glances/index.html
+++ b/components/sensor.glances/index.html
@@ -207,9 +207,15 @@ Glances web server started on http://0.0.0.0:61208/
diff --git a/components/sensor.http/index.html b/components/sensor.http/index.html
index 716d2661c3..e0362a9af9 100644
--- a/components/sensor.http/index.html
+++ b/components/sensor.http/index.html
@@ -194,9 +194,15 @@ You should choose a unique device name (DEVICE_NAME) to avoid clashes with other
host (Required): The IP address or hostname of your mFi controller.
+
port (Optional): The port of your mFi controller. Defaults to 6443.
+
username (Required): The mFi admin username.
+
password (Required): The mFi admin user’s password.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/components/sensor.modbus/index.html b/components/sensor.modbus/index.html
index 91e5935968..9454dea44d 100644
--- a/components/sensor.modbus/index.html
+++ b/components/sensor.modbus/index.html
@@ -203,9 +203,15 @@ Each named register will create an integer sensor and each named bit will create
diff --git a/components/sensor.netatmo/index.html b/components/sensor.netatmo/index.html
index 93fdd2efaa..20f1b924d9 100644
--- a/components/sensor.netatmo/index.html
+++ b/components/sensor.netatmo/index.html
@@ -208,9 +208,15 @@ The Home Assistant NetAtmo platform has only be tested with the classic indoor a
diff --git a/components/sensor.rest/index.html b/components/sensor.rest/index.html
index 3d802b0539..ae926da359 100644
--- a/components/sensor.rest/index.html
+++ b/components/sensor.rest/index.html
@@ -238,6 +238,9 @@ Make sure that the URL matches exactly your endpoint or resource.
The splunk component makes it possible to log all state changes to an external Splunk database using Splunk’s HTTP Event Collector feature. You can either use this alone, or with the HomeAssistant for Splunk app. Since the HEC feature is new to Splunk, you will need to use at least version 6.3.
+
+
To use the splunk component in your installation, add the following to your configuration.yaml file:
diff --git a/components/switch.command_switch/index.html b/components/switch.command_switch/index.html
index a8ae56ecf0..663c9de9e6 100644
--- a/components/switch.command_switch/index.html
+++ b/components/switch.command_switch/index.html
@@ -255,12 +255,18 @@ This switch will shutdown your host immediately, there will be no confirmation.
diff --git a/components/switch.hikvision/index.html b/components/switch.hikvision/index.html
index 0ceacd6392..99654eeb9e 100644
--- a/components/switch.hikvision/index.html
+++ b/components/switch.hikvision/index.html
@@ -165,6 +165,9 @@ Currently works using default https port only.
host (Required): The IP address or hostname of your mFi controller.
+
port (Optional): The port of your mFi controller. Defaults to 6443.
+
username (Required): The mFi admin username.
+
password (Required): The mFi admin user’s password.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/components/switch.modbus/index.html b/components/switch.modbus/index.html
index db9fc7758d..7db45cf169 100644
--- a/components/switch.modbus/index.html
+++ b/components/switch.modbus/index.html
@@ -233,12 +233,18 @@ Each named bit will create a switch.
diff --git a/components/switch.rest/index.html b/components/switch.rest/index.html
index 021405a9c7..7799db369e 100644
--- a/components/switch.rest/index.html
+++ b/components/switch.rest/index.html
@@ -165,6 +165,9 @@ Make sure that the URL matches exactly your endpoint or resource.
diff --git a/components/switch.rpi_gpio/index.html b/components/switch.rpi_gpio/index.html
index e4f6f435ee..f51c37c0f7 100644
--- a/components/switch.rpi_gpio/index.html
+++ b/components/switch.rpi_gpio/index.html
@@ -207,12 +207,18 @@ If you are not running Raspbian Jessie, you will need to run Home Assistant as r
The template platform creates switches that combine components.
+
+
For example, if you have a garage door with a toggle switch that operates the motor and a sensor that allows you know whether the door is open or closed, you can combine these into a switch that knows whether the garage door is open or closed.
+
+
This can simplify the gui, and make it easier to write automations. You can mark the components you have combined as hidden so they don’t appear themselves.
+
+
To enable Template switches in your installation, add the following to your configuration.yaml file:
Alternately, wemos that are not discoverable can be statically configured. If you have WeMo devices on subnets other than where Home Assistant is running, and/or devices in a remote location reachable over a VPN, you will need to manually configure them. This is also useful if you wish to disable discovery for some wemos, even if they are local. Example static configuration:
Any WeMo devices that are not statically configured but reachable via discovery will still be added automatically.
+
+
Note that if you use this, you may want to configure your router (or whatever runs your DHCP server) to force your WeMo devices to use a static IP address. Check the DHCP section of your router configuration for this ability.
diff --git a/components/tellduslive/index.html b/components/tellduslive/index.html
index 6ba1be4bb3..33903a440f 100644
--- a/components/tellduslive/index.html
+++ b/components/tellduslive/index.html
@@ -178,6 +178,12 @@ API requests to certain methods are limited to one request every 10 minutes.
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/components/wink/index.html b/components/wink/index.html
index 004fd4310a..a86533a5de 100644
--- a/components/wink/index.html
+++ b/components/wink/index.html
@@ -165,6 +165,9 @@ The Wink hub can only be accessed via the cloud. This means it requires an activ
usb_path (Required): The port where your device is connected to your Home Assistant host.
config_path (Optional): The path to the Python Open Z-Wave configuration files.
+
polling_interval (Optional): The time period in milliseconds between polls of a nodes value.
+
customize (Optional): This attribute contains node-specific override values:
+
+
polling_intensity (Optional): Enables polling of a value and sets the frequency of polling (0=none, 1=every time through the list, 2-every other time, etc)
+
+
To find the path of your Z-Wave stick, run:
@@ -156,6 +166,26 @@ $ pip3 install "cython<0.23"
+
Events
+
+
Some devices can also trigger scene activation events, which can be used in automation scripts (for example the press of a button on a wall switch):
+ 
+
+ 
+
+ 
+
+ 
+
+ 
+
+ 
+
+ 
+
+ 
+
+ 