diff --git a/source/_components/alarm_control_panel.nx584.markdown b/source/_components/alarm_control_panel.nx584.markdown new file mode 100644 index 000000000000..12a070299470 --- /dev/null +++ b/source/_components/alarm_control_panel.nx584.markdown @@ -0,0 +1,29 @@ +--- +layout: page +title: "NX584 Alarm Control Panel" +description: "Instructions how to integrate NX584 into Home Assistant." +date: 2016-02-07 10:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: networx.png +ha_category: Alarm +--- + +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](http://github.com/kk7ds/pynx584) which is required for this to work. + + +To enable this, add the following lines to your `configuration.yaml`: + +```yaml +# Example configuration.yaml entry +alarm_control_panel: + platform: nx584 + host: ADDRESS +``` + +Configuration variables: + +- **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. + diff --git a/source/_components/apcupsd.markdown b/source/_components/apcupsd.markdown new file mode 100644 index 000000000000..16deab840ef0 --- /dev/null +++ b/source/_components/apcupsd.markdown @@ -0,0 +1,35 @@ +--- +layout: page +title: "APCUPSd" +description: "Instructions on how to integrate APCUPSd status with Home Assistant." +date: 2016-02-10 17:11 +sidebar: true +comments: false +sharing: true +footer: true +logo: apcupsd.png +ha_category: Hub +--- + +[APCUPSd](http://www.apcupsd.org/) status information can be integrated into Home Assistant when the Network Information Server (NIS) [is configured](http://www.apcupsd.org/manual/manual.html#nis-server-client-configuration-using-the-net-driver). + +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: + +```yaml +apcupsd: +``` + +Set parameters: + +```yaml +apcupsd: + host: 192.168.1.10 + port: 1234 +``` diff --git a/source/_components/binary_sensor.apcupsd.markdown b/source/_components/binary_sensor.apcupsd.markdown new file mode 100644 index 000000000000..7e346559ae0a --- /dev/null +++ b/source/_components/binary_sensor.apcupsd.markdown @@ -0,0 +1,22 @@ +--- +layout: page +title: APCUPSd Binary Sensor +description: "Instructions on how to set up an APCUPSd binary sensor within Home Assistant." +date: 2016-02-10 18:47 +sidebar: true +comments: false +sharing: true +footer: true +logo: apcupsd.png +ha_category: Binary Sensor +--- + +In addition to the [APCUPSd Sensor](/components/sensor.apcupsd/) devices, you may also create a device which is simply `on` when the UPS status is `ONLINE` and `off` at all other times. + +#### Example + +```yaml +binary_sensor: + - name: UPS Online + platform: apcupsd +``` diff --git a/source/_components/bloomsky.markdown b/source/_components/bloomsky.markdown new file mode 100644 index 000000000000..7b326baf8a40 --- /dev/null +++ b/source/_components/bloomsky.markdown @@ -0,0 +1,27 @@ +--- +layout: page +title: "BloomSky" +description: "Instructions how to integrate the BloomSky within Home Assistant." +date: 2016-02-03 20:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: bloomsky.png +ha_category: Hub +--- + + +The `bloomsky` component allows you to access your [BloomSky](http://www.insteon.com/) weather station's [sensors](/components/sensor.bloomsky) and [camera](/components/camera.bloomsky) from Home Assistant. + +To integrate your BloomSky hub with Home Assistant, add the following section to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +bloomsky: + api_key: YOUR_API_KEY +``` + +Configuration variables: + +- **api_key** *Required*: Your BloomSky API key, obtained from your [BloomSky dashboard](https://dashboard.bloomsky.com) (click `developers` in the bottom left of the screen) diff --git a/source/_components/camera.bloomsky.markdown b/source/_components/camera.bloomsky.markdown new file mode 100644 index 000000000000..4a7e9f4b8bb6 --- /dev/null +++ b/source/_components/camera.bloomsky.markdown @@ -0,0 +1,23 @@ +--- +layout: page +title: "BloomSky Camera" +description: "Instructions how to integrate the BloomSky camera within Home Assistant." +date: 2016-02-03 20:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: bloomsky.png +ha_category: Camera +--- + + +The `bloomsky` camera component allows you to view the current photo created by the camera in the [BloomSky](https://www.bloomsky.com) weather station. This can work in concert with [BloomSky sensors](/components/sensor.bloomsky). + +To enable this camera in your installation, set up the [BloomSky component](/components/bloomsky) with your API key and add the following to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +camera: + platform: bloomsky +``` diff --git a/source/_components/camera.uvc.markdown b/source/_components/camera.uvc.markdown new file mode 100644 index 000000000000..84583a0a05ac --- /dev/null +++ b/source/_components/camera.uvc.markdown @@ -0,0 +1,33 @@ +--- +layout: page +title: "UniFi Video Camera" +description: "Instructions how to integrate UVC cameras within Home Assistant." +date: 2016-02-07 10:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: ubiquiti.png +ha_category: Camera +--- + + +The `uvc` component allows you to integrate [UniFi Video Camera (UVC)](https://www.ubnt.com/unifi-video/unifi-video-camera/) into Home Assistant. + +To enable a UVC camera in your installation, add the following to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +camera: + platform: uvc + nvr: IP_ADDRESS + port: PORT + key: APIKEY +``` + +Configuration variables: + +- **nvr** *Optional*: The IP or hostname of the NVR (Network Video Recorder) server. +- **port** *Optional*: The port number to use for accessing the NVR. +- **key** *Required*: The API key available from the NVR web interface. + diff --git a/source/_components/garage_door.markdown b/source/_components/garage_door.markdown new file mode 100644 index 000000000000..a52f22244a32 --- /dev/null +++ b/source/_components/garage_door.markdown @@ -0,0 +1,12 @@ +--- +layout: page +title: "Garage door" +description: "Instructions how to integrate Garage doors into Home Assistant." +date: 2016-02-12 07:00 +sidebar: true +comments: false +sharing: true +footer: true +--- + +Home Assistant can give you an interface to control any garage door. diff --git a/source/_components/garage_door.wink.markdown b/source/_components/garage_door.wink.markdown new file mode 100644 index 000000000000..423ada3af925 --- /dev/null +++ b/source/_components/garage_door.wink.markdown @@ -0,0 +1,18 @@ +--- +layout: page +title: "Wink Garage door" +description: "Instructions how to setup the Wink garage doors within Home Assistant." +date: 2016-02-12 07:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: wink.png +ha_category: Garage Door +--- + + +The Wink garage door platform allows you to control your [Wink](http://www.wink.com/) enabled garage door. + +The requirement is that you have setup your [Wink hub](/components/light.wink/). + diff --git a/source/_components/influxdb.markdown b/source/_components/influxdb.markdown index be64cc58dc25..32ed6d6ac39b 100644 --- a/source/_components/influxdb.markdown +++ b/source/_components/influxdb.markdown @@ -23,6 +23,8 @@ influxdb: database: DB_TO_STORE_EVENTS username: MY_USERNAME password: MY_PASSWORD + ssl: true + verify_ssl: true ``` Configuration variables: @@ -32,4 +34,5 @@ Configuration variables: - **database** (*Optional*): Name of the database to use. Defaults to `home_assistant`. The database must already exist. - **username** (*Optional*): The username of the database user. - **password** (*Optional*): The password for the database user account. - +- **ssl** (*Optional*): Use https instead of http to connect. Defaults to false. +- **verify_ssl** (*Optional*): Verify SSL certificate for https request. Defaults to false. diff --git a/source/_components/input_select.markdown b/source/_components/input_select.markdown new file mode 100644 index 000000000000..b8e574b91f8a --- /dev/null +++ b/source/_components/input_select.markdown @@ -0,0 +1,44 @@ +--- +layout: page +title: "Input Select" +description: "Instructions how to integrate the Input Select component into Home Assistant." +date: 2016-02-02 17:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: home-assistant.png +ha_category: Automation +--- + +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`: + +```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](https://materialdesignicons.com/) to use for your input and prefix the name with `mdi:`. For example `mdi:car`, `mdi:ambulance`, or `mdi:motorbike`. + diff --git a/source/_components/light.scsgate.markdown b/source/_components/light.scsgate.markdown new file mode 100644 index 000000000000..1a684ee06c41 --- /dev/null +++ b/source/_components/light.scsgate.markdown @@ -0,0 +1,29 @@ +--- +layout: page +title: "SCSGate light" +description: "Instructions how to integrate SCSGate lights into Home Assistant." +date: 2016-01-31 19:30 +sidebar: true +comments: false +sharing: true +footer: true +ha_category: Light +--- + +The SCSGate device can control lights of the BTicino MyHome system. + +To enable SCSGate lights in your installation, add the following to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +light: + platform: scsgate + devices: + living_room: + name: Living Room + scs_id: XXXXX +``` + +Configuration variables: + +- **devices** (*Required*): A list of devices with their name to use in the frontend. diff --git a/source/_components/lock.verisure.markdown b/source/_components/lock.verisure.markdown new file mode 100644 index 000000000000..185e066f3b33 --- /dev/null +++ b/source/_components/lock.verisure.markdown @@ -0,0 +1,18 @@ +--- +layout: page +title: "Verisure Lock" +description: "Instructions how to setup the Verisure locks within Home Assistant." +date: 2016-02-12 06:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: wink.png +ha_category: Lock +--- + + +The Verisure lock platform allows you to control your [Verisure](https://www.verisure.com/) locks. + +The requirement is that you have setup your [Verisure hub](/components/verisure/). + diff --git a/source/_components/media_player.kodi.markdown b/source/_components/media_player.kodi.markdown index b2e95c22e75b..e95acad36311 100644 --- a/source/_components/media_player.kodi.markdown +++ b/source/_components/media_player.kodi.markdown @@ -21,7 +21,8 @@ To add Kodi to your installation, add the following to your `configuration.yaml` # Example configuration.yaml entry media_player: platform: kodi - url: http://192.168.0.123/jsonrpc + host: 192.168.0.123 + port: 8080 name: Kodi user: USERNAME password: PASSWORD @@ -29,7 +30,8 @@ media_player: Configuration variables: -- **url** *Required*: The URL of the XBMC/Kodi JSON-RPC API, eg. http://192.168.0.123/jsonrpc +- **host** *Required*: The host name or address of the device that is running XBMC/Kodi +- **port** *Required*: The port number, default 8080 - **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.samsungtv.markdown b/source/_components/media_player.samsungtv.markdown new file mode 100644 index 000000000000..1c96733e92ce --- /dev/null +++ b/source/_components/media_player.samsungtv.markdown @@ -0,0 +1,25 @@ +--- +layout: page +title: "Samsung TV" +description: "Instructions how to integrate a Samsung TV in Home Assistant." +date: 2016-02-01 19:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: samsung.png +ha_category: Media Player +featured: false +--- + +The `samsungtv` platform allows you to control an [Samsung TV](http://www.samsung.com). + + +To add an Samsung TV to your installation, add the following to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +media_player: + platform: samsungtv +``` + diff --git a/source/_components/mqtt_eventstream.markdown b/source/_components/mqtt_eventstream.markdown index 75f0ab110676..cdbf0ded35d8 100644 --- a/source/_components/mqtt_eventstream.markdown +++ b/source/_components/mqtt_eventstream.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: mqtt.png -ha_category: Others +ha_category: Other --- The `mqtt_eventstream` components two Home Assistant instances via MQTT. diff --git a/source/_components/mysensors.markdown b/source/_components/mysensors.markdown index e5a6c9a84e30..abb9c28030bc 100644 --- a/source/_components/mysensors.markdown +++ b/source/_components/mysensors.markdown @@ -24,8 +24,10 @@ mysensors: gateways: - port: '/dev/ttyUSB0' persistence_file: 'path/mysensors.json' + baud_rate: 38400 - port: '/dev/ttyACM1' persistence_file: 'path/mysensors2.json' + baud_rate: 115200 debug: true persistence: true version: '1.5' @@ -38,6 +40,7 @@ Configuration variables: - **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/source/_components/notify.rest.markdown b/source/_components/notify.rest.markdown new file mode 100644 index 000000000000..27752b6bbe61 --- /dev/null +++ b/source/_components/notify.rest.markdown @@ -0,0 +1,40 @@ +--- +layout: page +title: "REST" +description: "Instructions how to add RESTful notifications to Home Assistant." +date: 2016-02-12 07:00 +sidebar: true +comments: false +sharing: true +footer: true +ha_category: Notifications +--- + + +The `rest` notification platform allows you to deliver [RESTful](https://en.wikipedia.org/wiki/Representational_state_transfer) notifications from Home Assistant to another party. + +To enable the REST notification in your installation, add the following to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +notify: + name: NOTIFIER_NAME + platform: rest + resource: http://IP_ADDRESS/ENDPOINT + method: GET + message_param_name: MESSAGE_PARAMETER_NAME + title_param_name: TITLE_PARAMETER_NAME + target_param_name: TARGET_PARAMETER_NAME +``` + +Configuration variables: + +- **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. + +To use notifications, please see the [getting started with automation page]({{site_root}}/components/automation/). + diff --git a/source/_components/proximity.markdown b/source/_components/proximity.markdown new file mode 100644 index 000000000000..b42a218d4412 --- /dev/null +++ b/source/_components/proximity.markdown @@ -0,0 +1,57 @@ +--- +layout: page +title: "Proximity" +description: "Instructions how to setup Proximity monitoring within Home Assistant." +date: 2016-02-07 10:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: home-assistant.png +ha_category: Organization +--- + +The `proximity` component allows you to monitor the proximity of devices to a particular [zone](/components/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](/components/automation/#zone-trigger) and [state](/components/automation/#state-trigger) 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: + +```yaml +# Example configuration.yaml entry +proximity: + zone: home + ignored_zones: + - twork + - elschool + devices: + - device_tracker.nwaring_nickmobile + - device_tracker.eleanorsiphone + - device_tracker.tsiphone + tolerance: 50 +``` + +Configuration variables: + +- **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. + diff --git a/source/_components/rollershutter.scsgate.markdown b/source/_components/rollershutter.scsgate.markdown new file mode 100644 index 000000000000..7028bbd4d064 --- /dev/null +++ b/source/_components/rollershutter.scsgate.markdown @@ -0,0 +1,30 @@ +--- +layout: page +title: "SCSGate Rollershutter" +description: "Instructions how to integrate SCSGate motorized devices into Home Assistant." +date: 2016-01-31 22:16 +sidebar: true +comments: false +sharing: true +footer: true +ha_category: Rollershutter +--- +The SCSGate device can control motirized roller shutters connected to the BTicino MyHome system. + +To enable SCSGate roller shutters in your installation, add the following to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +rollershutter: + platform: scsgate + devices: + living_room: + name: Living Room + scs_id: XXXXX +``` + +Configuration variables: + +- **devices** (*Required*): A list of devices with their name to use in the frontend. + +**Known limitation:** it is not possible to know the current state of the roller shutter. diff --git a/source/_components/scsgate.markdown b/source/_components/scsgate.markdown new file mode 100644 index 000000000000..545833b84761 --- /dev/null +++ b/source/_components/scsgate.markdown @@ -0,0 +1,33 @@ +--- +layout: page +title: "SCSGate" +description: "Instructions how to integrate SCSGate into Home Assistant." +date: 2016-01-31 19:20 +sidebar: true +comments: false +sharing: true +footer: true +ha_category: Hub +--- + +The SCSGate component support the [SCSGate](https://translate.google.com/translate?hl=en&sl=it&tl=en&u=http%3A%2F%2Fguidopic.altervista.org%2Feibscsgt%2Finterface.html) 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: + +```yaml +# 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](https://github.com/flavio/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](http://scsgate.readthedocs.org/en/latest/?badge=latest#creation-of-a-home-assistant-configuration-file) section of `scsgate`'s documentation. diff --git a/source/_components/sensor.apcupsd.markdown b/source/_components/sensor.apcupsd.markdown new file mode 100644 index 000000000000..2a1d18741d3d --- /dev/null +++ b/source/_components/sensor.apcupsd.markdown @@ -0,0 +1,94 @@ +--- +layout: page +title: APCUPSd Sensor +description: "Instructions on how to set up APCUPSd sensors within Home Assistant." +date: 2016-02-10 18:28 +sidebar: true +comments: false +sharing: true +footer: true +logo: apcupsd.png +ha_category: Sensor +--- + +Any of the lines of output from the [apcaccess](http://linux.die.net/man/8/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. + +#### Example + +Given the following output from `apcaccess`: + +```yaml +APC : 001,051,1149 +DATE : 2016-02-09 17:13:31 +0000 +HOSTNAME : localhost +VERSION : 3.14.12 (29 March 2014) redhat +UPSNAME : netrack +CABLE : Custom Cable Smart +DRIVER : APC Smart UPS (any) +UPSMODE : Stand Alone +STARTTIME: 2016-02-09 16:06:47 +0000 +MODEL : SMART-UPS 1400 +STATUS : TRIM ONLINE +LINEV : 247.0 Volts +LOADPCT : 13.0 Percent +BCHARGE : 100.0 Percent +TIMELEFT : 104.0 Minutes +MBATTCHG : 5 Percent +MINTIMEL : 3 Minutes +MAXTIME : 0 Seconds +MAXLINEV : 249.6 Volts +MINLINEV : 244.4 Volts +OUTPUTV : 218.4 Volts +SENSE : High +DWAKE : 0 Seconds +DSHUTD : 180 Seconds +DLOWBATT : 2 Minutes +LOTRANS : 196.0 Volts +HITRANS : 253.0 Volts +RETPCT : 15.0 Percent +ITEMP : 30.6 C +ALARMDEL : Low Battery +BATTV : 27.6 Volts +LINEFREQ : 50.0 Hz +LASTXFER : High line voltage +NUMXFERS : 0 +TONBATT : 0 Seconds +CUMONBATT: 0 Seconds +XOFFBATT : N/A +SELFTEST : NO +STESTI : 336 +STATFLAG : 0x0500000A +DIPSW : 0x00 +REG1 : 0x00 +REG2 : 0x00 +REG3 : 0x00 +MANDATE : 07/13/99 +SERIALNO : GS9888761008 +BATTDATE : 13/11/15 +NOMOUTV : 230 Volts +NOMBATTV : 24.0 Volts +EXTBATTS : 0 +FIRMWARE : 70.11.I +END APC : 2016-02-09 17:13:46 +0000 +``` + +Use the (case insensitive) values from the left hand column as your `type`: + +```yaml +sensor: + - name: Mains Voltage + platform: apcupsd + type: linev + + - name: UPS Load + platform: apcupsd + type: loadpct + + - name: UPS Temperature + platform: apcupsd + type: itemp +``` diff --git a/source/_components/sensor.bloomsky.markdown b/source/_components/sensor.bloomsky.markdown new file mode 100644 index 000000000000..08a9852e0863 --- /dev/null +++ b/source/_components/sensor.bloomsky.markdown @@ -0,0 +1,42 @@ +--- +layout: page +title: "BloomSky Sensor" +description: "Instructions how to integrate the BloomSky sensors within Home Assistant." +date: 2016-02-03 20:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: bloomsky.png +ha_category: Sensor +--- + + +The `bloomsky` sensor component allows you to view the measurements made by sensors in the [BloomSky](https://www.bloomsky.com) weather station. This can work in concert with the [BloomSky camera](/components/camera.bloomsky). + +To enable these sensors in your installation, set up the [BloomSky component](/components/bloomsky) with your API key add the following to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +sensor: + platform: bloomsky + monitored_conditions: + - Temperature + - Humidity + - Rain + - Pressure + - UVIndex + - Luminance + - Night +``` + +Configuration variables: + +- **monitored_conditions** array *Required*: The sensors that you wish to monitor on all of your devices. Select from these options: + - Humidity + - Luminance + - Night + - Pressure + - Rain + - Temperature + - UVIndex diff --git a/source/_components/sensor.dht.markdown b/source/_components/sensor.dht.markdown index 6b535d2cf67c..271be938f132 100644 --- a/source/_components/sensor.dht.markdown +++ b/source/_components/sensor.dht.markdown @@ -21,6 +21,7 @@ sensor: platform: dht sensor: DHT22 pin: 23 + name: Living Room monitored_conditions: - temperature - humidity @@ -30,6 +31,7 @@ Configuration variables: - **sensor** (*Required*): The sensor type, supported devices are DHT11, DHT22, and AM2302 - **pin** (*Required*): The pin the sensor is connected to. +- **name** (*Optional*): The name of the sensor - **monitored_conditions** array: Conditions to monitor. - **temperature**: - **humidity**: diff --git a/source/_components/sensor.mfi.markdown b/source/_components/sensor.mfi.markdown new file mode 100644 index 000000000000..c7dcc96257a2 --- /dev/null +++ b/source/_components/sensor.mfi.markdown @@ -0,0 +1,35 @@ +--- +layout: page +title: "mFi Sensor" +description: "Instructions how to integrate mFi sensors within Home Assistant." +date: 2016-02-07 10:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: ubiquiti.png +ha_category: Sensor +--- + + +The `mfi` sensor platform to allow you to monitor [mFi mPort interface and sensors](https://www.ubnt.com/mfi/mport/). + +To add this platform to your installation, add the following to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +sensor: + platform: mfi + host: IP_ADDRESS + port: PORT + username: USERNAME + password: PASSWORD +``` + +Configuration variables: + +- **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. + diff --git a/source/_components/splunk.markdown b/source/_components/splunk.markdown new file mode 100644 index 000000000000..12c81cc4ab98 --- /dev/null +++ b/source/_components/splunk.markdown @@ -0,0 +1,32 @@ +--- +layout: page +title: "Splunk" +description: "Record events in Splunk." +date: 2016-02-05 15:31 +sidebar: true +comments: false +sharing: true +footer: true +logo: splunk.png +ha_category: "History" +--- + +The `splunk` component makes it possible to log all state changes to an external [Splunk](http://splunk.com/) database using Splunk's HTTP Event Collector feature. You can either use this alone, or with the HomeAssistant for Splunk [app](https://github.com/miniconfig/splunk-homeassistant). 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: + +```yaml +# Example configuration.yaml entry +splunk: + host: SPLUNK_HOST_IP_ADDRESS_OR_HOST_NAME + port: 8088 + token: B4415DFF-683C-5C6C-3994-4F6D4A5DB03A + SSL: True +``` + +Configuration variables: + +- **host** (*Optional*): IP address or host name of your Splunk host, eg. http://192.168.1.10. Will default to `localhost` if not supplied. +- **port** (*Optional*): Port to use. Defaults to 8088. +- **token** (*Required*): The HTTP Event Collector Token already created in your Splunk instance. +- **SSL** (*Optional*): Use https instead of http to connect. Defaults to False. diff --git a/source/_components/switch.mfi.markdown b/source/_components/switch.mfi.markdown new file mode 100644 index 000000000000..353a6d6a2c04 --- /dev/null +++ b/source/_components/switch.mfi.markdown @@ -0,0 +1,35 @@ +--- +layout: page +title: "mFi Switch" +description: "Instructions how to integrate mFi switches within Home Assistant." +date: 2016-02-07 10:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: ubiquiti.png +ha_category: Switch +--- + + +The `mfi` switch platform to allow you to control [mFi Controllable Power Outlets](https://www.ubnt.com/mfi/mpower/). + +To add this platform to your installation, add the following to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +sensor: + platform: mfi + host: IP_ADDRESS + port: PORT + username: USERNAME + password: PASSWORD +``` + +Configuration variables: + +- **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. + diff --git a/source/_components/switch.scsgate.markdown b/source/_components/switch.scsgate.markdown new file mode 100644 index 000000000000..234f02247aca --- /dev/null +++ b/source/_components/switch.scsgate.markdown @@ -0,0 +1,29 @@ +--- +layout: page +title: "SCSGate switch" +description: "Instructions how to integrate SCSGate switches into Home Assistant." +date: 2016-01-31 22:15 +sidebar: true +comments: false +sharing: true +footer: true +ha_category: Switch +--- + +The SCSGate device can control switches of the BTicino MyHome system. + +To enable SCSGate switches in your installation, add the following to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +switch: + platform: scsgate + devices: + living_room: + name: Living Room + scs_id: XXXXX +``` + +Configuration variables: + +- **devices** (*Required*): A list of devices with their name to use in the frontend. diff --git a/source/_components/switch.template.markdown b/source/_components/switch.template.markdown new file mode 100644 index 000000000000..ab789f34b9e6 --- /dev/null +++ b/source/_components/switch.template.markdown @@ -0,0 +1,103 @@ +--- +layout: page +title: "Template switch" +description: "Instructions how to integrate Template switches into Home Assistant." +date: 2016-02-07 07:00 +sidebar: true +comments: false +sharing: true +footer: true +ha_category: Switch +--- + +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: + +```yaml +# Example configuration.yaml entry +switch: + platform: template + switches: + skylight: + friendly_name: 'Skylight' + value_template: {% raw %}'{{ states.sensor.skylight.state }}'{% endraw %} + turn_on: + service: switch.turn_on + entity_id: switch.skylight_open + turn_off: + service: switch.turn_on + entity_id: switch.skylight_close +``` + +Configuration variables: + +- **switches** array (*Required*): List of your switches. + - **friendly_name** (*Optional*): Name to use in the Frontend. + - **value_template** (*Required*): Defines a [template](/getting-started/templating/) to set the state of the switch. + - **turn_on** (*Required*): Defines an [action](/getting-started/automation/) to run when the switch is turned on. + - **turn_off** (*Required*): Defines an [action](/getting-started/automation/) to run when the switch is turned off. + +## {% linkable_title Examples %} + +In this section you find some real life examples of how to use this switch. + +### {% linkable_title Copy switch %} + +This example shows a switch that copies another switch. + +```yaml +switch: + platform: template + switches: + copy: + value_template: {% raw %}'{{ states.switch.source.state }}'{% endraw %} + turn_on: + service: switch.turn_on + entity_id: switch.source + turn_off: + service: switch.turn_off + entity_id: switch.source +```` + +### {% linkable_title Toggle switch %} + +This example shows a switch that takes its state from a sensor, and toggles a switch. + +```yaml +switch: + platform: template + switches: + blind: + friendly_name: 'Blind' + value_template: {% raw %}'{{ state }}'{% endraw %} + turn_on: + service: switch.toggle + entity_id: switch.blind_toggle + turn_off: + service: switch.toggle + entity_id: switch.blind_toggle +``` + +### {% linkable_title Sensor and two switches %} + +This example shows a switch that takes its state from a sensor, and uses two momentary switches to control a device. + +```yaml +switch: + platform: template + switches: + skylight: + friendly_name: 'Skylight' + value_template: {% raw %}'{{ states.sensor.skylight.state }}'{% endraw %} + turn_on: + service: switch.turn_on + entity_id: switch.skylight_open + turn_off: + service: switch.turn_on + entity_id: switch.skylight_close +``` diff --git a/source/_components/switch.wemo.markdown b/source/_components/switch.wemo.markdown index 1e9560f77eea..9541f7e73b11 100644 --- a/source/_components/switch.wemo.markdown +++ b/source/_components/switch.wemo.markdown @@ -21,3 +21,17 @@ They will be automatically discovered if the discovery component is enabled. switch: platform: wemo ``` + +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: + +```yaml +switch: + platform: wemo + static: + - 192.168.1.23 + - 192.168.52.172 +``` + +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. \ No newline at end of file diff --git a/source/_components/thermostat.honeywell.markdown b/source/_components/thermostat.honeywell.markdown index 554b224734d1..03fa233019a6 100644 --- a/source/_components/thermostat.honeywell.markdown +++ b/source/_components/thermostat.honeywell.markdown @@ -2,7 +2,7 @@ layout: page title: "Honeywell Thermostat" description: "Instructions how to integrate Honeywell thermostats within Home Assistant." -date: 2015-11-09 17:15 +date: 2016-02-07 22:01 sidebar: true comments: false sharing: true @@ -21,6 +21,7 @@ thermostat: platform: honeywell username: YOUR_USERNAME password: YOUR_PASSWORD + region: REGION ``` Configuration variables: @@ -28,3 +29,4 @@ Configuration variables: - **username** (*Required*: The username of an user with access. - **password** (*Required*): The password for your given admin account. - **away_temperature** (*optional*): Heating setpoint when away mode is on. If omitted it defaults to 16.0 deg C. +- **region** (*optional*): Region identifier (either 'eu' or 'us'). Defaults to 'eu' if not provided. diff --git a/source/_components/verisure.markdown b/source/_components/verisure.markdown index 8730ec8382f1..cd1d84f3a319 100644 --- a/source/_components/verisure.markdown +++ b/source/_components/verisure.markdown @@ -17,9 +17,10 @@ Home Assistant has support to integrate your [Verisure](https://www.verisure.com We support: - * Smartplugs - * Reading from thermometers and hygrometers integrated in various devices - * Reading alarm status + * Smartplugs + * Reading from thermometers and hygrometers integrated in various devices + * Reading alarm status + * Locks To integrate Verisure with Home Assistant, add the following section to your `configuration.yaml` file: @@ -32,6 +33,7 @@ verisure: hygrometers: 0 smartplugs: 1 thermometers: 0 + locks: 0 code_digits: 4 ``` @@ -42,6 +44,7 @@ Configuration variables: - **alarm** (*Optional*): Set to 1 to show alarm, 0 to disable. Default 1. - **hygrometers** (*Optional*): Set to 1 to show hygrometers, 0 to disable. Default 1. - **smartplugs** (*Optional*): Set to 1 to show smartplugs, 0 to disable. Default 1. +- **locls** (*Optional*): Set to 1 to show locks, 0 to disable. Default 1. - **thermometers** (*Optional*): Set to 1 to show thermometers, 0 to disable. Default 1. - **code_digits** (*Optional*): Number of digits in PIN code. Default 4. diff --git a/source/_components/weblink.markdown b/source/_components/weblink.markdown new file mode 100644 index 000000000000..5dbcec2d1b41 --- /dev/null +++ b/source/_components/weblink.markdown @@ -0,0 +1,26 @@ +--- +layout: page +title: "Weblink" +description: "Instructions how to setup Links within Home Assistant." +date: 2016-02-02 20:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: +ha_category: Other +--- + +The `weblinks` component allows you to display links in the Home Assistant frontend. + +To use this component in your installation, add the following to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +weblink: + entities: + - name: Router + url: http://192.168.1.1/ + - name: Home Assistant + url: https://home-assistant.io +``` diff --git a/source/_components/zwave.markdown b/source/_components/zwave.markdown index 88a54ac9b73e..7cb6744faf44 100644 --- a/source/_components/zwave.markdown +++ b/source/_components/zwave.markdown @@ -33,15 +33,40 @@ $ pip3 install "cython<0.23" zwave: usb_path: /dev/ttyUSB0 config_path: /usr/local/share/python-openzwave/config + polling_interval: 10000 + customize: + sensor.greenwave_powernode_6_port_energy_10: + polling_intensity: 1 ``` Configuration variables: - **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: ```bash $ ls /dev/ttyUSB* ``` + +#### 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): + +```yaml +# Example configuration.yaml automation entry +automation: + - alias: Turn on Desk light + trigger: + platform: event + event_type: zwave.scene_activated + event_data: + entity_id: zwaveme_zme_wallcs_secure_wall_controller_8 + scene_id: 11 +``` + +The *entity_id* and *scene_id* of all triggered events can be seen in the console output. diff --git a/source/_cookbook/automation_using_timeinterval_inputboolean.markdown b/source/_cookbook/automation_using_timeinterval_inputboolean.markdown new file mode 100644 index 000000000000..02c3cd1a4436 --- /dev/null +++ b/source/_cookbook/automation_using_timeinterval_inputboolean.markdown @@ -0,0 +1,42 @@ +--- +layout: page +title: "Using time interval and input boolean" +description: "Automation to get a random color every 2 minutes that can be turned on/off." +date: 2016-02-07 22:35 +0800 +sidebar: true +comments: false +sharing: true +footer: true +ha_category: Automation Examples +--- + +#### {% linkable_title Change Hue light on interval to random color based on state of a input boolean %} + +_Note, Philips Hue is currently the only light platform that support the random effect._ + +```yaml +input_boolean: + loop_livingcolors: + name: Loop LivingColors + initial: off + icon: mdi:spotlight + +automation: +# Changes Hue light every two minutes to random color if input boolean is set to on +- alias: 'Set LivingColors to random color' + trigger: + platform: time + minutes: '/2' + seconds: 0 + condition: + platform: state + entity_id: input_boolean.loop_livingcolors + state: 'on' + action: + service: light.turn_on + entity_id: light.woonkamer_livingcolors + data: + effect: random + transition: 5 + brightness: 255 +``` diff --git a/source/developers/credits.markdown b/source/developers/credits.markdown index f905195ab226..0a636ef9aee3 100644 --- a/source/developers/credits.markdown +++ b/source/developers/credits.markdown @@ -32,12 +32,16 @@ This page contains a list of people who have contributed in one way or another t - [Carlo Costanzo](https://github.com/CCOSTAN) - [Chris Mulder](https://github.com/chrisvis) - [Daniel Iversen](https://github.com/danielhiversen) +- [Dan Smith](https://github.com/kk7ds) - [Daren Lord](https://github.com/Xorso) - [Dean Galvin](https://github.com/FreekingDean) - [Edwin Smulders](https://github.com/Dutchy-) +- [Ellis Percival](https://github.com/flyte) +- [Eric Rolf](https://github.com/xrolfex) - [ettisan](https://github.com/ettisan) - [Fabian Affolter](https://github.com/fabaff) - [Finbarr Brady](https://github.com/fbradyirl) +- [Flavio Castelli](https://github.com/flavio) - [Geoff Norton](https://github.com/kangaroo) - [goir](https://github.com/goir) - [gottsman](https://github.com/gottsman) @@ -60,6 +64,7 @@ This page contains a list of people who have contributed in one way or another t - [Julien Danjou](https://github.com/jd) - [kennedyshead](https://github.com/kennedyshead) - [kixam](https://github.com/kixam) +- [Lukas Hetzenecker](https://github.com/lukas-hetzenecker) - [Magnus Knutas](https://github.com/MagnusKnutas) - [MakeMeASandwich](https://github.com/MakeMeASandwich) - [Markus Stenberg](https://github.com/fingon) @@ -71,6 +76,7 @@ This page contains a list of people who have contributed in one way or another t - [molobrakos](https://github.com/molobrakos) - [Moon Shot](https://github.com/moonshot) - [Nick Touran](https://github.com/partofthething) +- [Nick Waring](https://github.com/nickwaring) - [Nolan Gilley](https://github.com/nkgilley) - [Oliver van Porten](https://github.com/mcdeck)) - [Pascal Bach](https://github.com/bachp) @@ -85,9 +91,12 @@ This page contains a list of people who have contributed in one way or another t - [Ryan Kraus](https://github.com/rmkraus) - [Ryan Turner](https://github.com/ryanturner) - [sander76](https://github.com/sander76) +- [Sean Dague](https://github.com/sdague) - [sfam](https://github.com/sfam) - [Stefan Jonasson](https://github.com/stefan-jonasson) +- [St. John Johnson](https://github.com/stjohnjohnson) - [TangoAlpha](https://github.com/TangoAlpha) +- [Theb-1](https://github.com/Theb-1) - [Theodor Lindquist](https://github.com/theolind) - [toddeye](https://github.com/toddeye) - [Tom Duijf](https://github.com/tomduijf) diff --git a/source/images/supported_brands/apcupsd.png b/source/images/supported_brands/apcupsd.png new file mode 100644 index 000000000000..8fbad5a0fa8a Binary files /dev/null and b/source/images/supported_brands/apcupsd.png differ diff --git a/source/images/supported_brands/bloomsky.png b/source/images/supported_brands/bloomsky.png new file mode 100644 index 000000000000..3332684dd335 Binary files /dev/null and b/source/images/supported_brands/bloomsky.png differ diff --git a/source/images/supported_brands/networx.png b/source/images/supported_brands/networx.png new file mode 100644 index 000000000000..560e4c96062f Binary files /dev/null and b/source/images/supported_brands/networx.png differ diff --git a/source/images/supported_brands/samsung.png b/source/images/supported_brands/samsung.png new file mode 100644 index 000000000000..fe36a9500b0d Binary files /dev/null and b/source/images/supported_brands/samsung.png differ diff --git a/source/images/supported_brands/splunk.png b/source/images/supported_brands/splunk.png new file mode 100644 index 000000000000..3f30171db7b5 Binary files /dev/null and b/source/images/supported_brands/splunk.png differ diff --git a/source/images/supported_brands/ubiquiti.png b/source/images/supported_brands/ubiquiti.png new file mode 100644 index 000000000000..363b4a617ae1 Binary files /dev/null and b/source/images/supported_brands/ubiquiti.png differ