Skip to content

0.26 #776

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 64 commits into from
Aug 13, 2016
Merged

0.26 #776

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
64 commits
Select commit Hold shift + click to select a range
9614845
Add warning to the MPC-HC media_player component documentation. (#708)
abcminiuser Jul 31, 2016
4c97678
Locative now work on Android (#715)
boced66 Aug 1, 2016
95176da
Add Facebook page to footer
robbiet480 Jul 30, 2016
dabf5b1
Update 2016-07-30-custom-frontend-panels--jupyter-notebooks--directv.…
balloob Jul 30, 2016
f38c827
Add G+ link
balloob Jul 30, 2016
4605f2e
Update description
balloob Jul 30, 2016
02ee5cd
Fix copy-paste errors. (#705)
corbanmailloux Jul 30, 2016
c941c02
Update hdmi_cec.markdown (#701)
andrew-curtis Jul 30, 2016
0a7f5ba
Fix typo
balloob Jul 31, 2016
467b187
Remove whitespaces
fabaff Aug 1, 2016
86f274f
Add node_event documentation and example. (#722)
mezz64 Aug 3, 2016
64e63e4
Add ac_mode option to thermostat.heat_control docs (#723)
mtreinish Aug 3, 2016
c18453b
added kelvin and mired mode to flux (#703)
HBDK Aug 3, 2016
12ee1f0
Added whitelist option to InfluxDB (#735)
tchellomello Aug 5, 2016
cc4c499
Update z-wave-controllers.markdown
turbokongen Aug 7, 2016
786d4b8
Updates for new options and events for zwave
turbokongen Aug 7, 2016
04350e6
Update z-wave-device-specific.markdown
turbokongen Aug 7, 2016
2132158
Alphabetic sorting
turbokongen Aug 7, 2016
0827a76
Corrected reference to wrong line in code. (#744)
Landrash Aug 7, 2016
45c86f1
Update documentation to show unit system (#717)
Aug 8, 2016
79850a1
Add initial docs for panel_custom (#750)
fabaff Aug 8, 2016
24d3f6a
Add details about math, comparision, and logic (#749)
fabaff Aug 8, 2016
9ba7da1
Proximity List and Configurable Unit of Measure (#698)
Aug 8, 2016
cb6bce4
Update for new panel_custom component (#751)
fabaff Aug 8, 2016
0a2b0e2
Add OhmConnect docs (#754)
robbiet480 Aug 9, 2016
3c1619a
Add docs for the Foursquare component (#755)
robbiet480 Aug 9, 2016
a640264
Docs for new smtp image attachments. (#739)
partofthething Aug 9, 2016
8d1500e
Add new contributors
fabaff Aug 9, 2016
b4047c1
Add changed_by
fabaff Aug 9, 2016
22c3aee
Add initial pm docs
fabaff Aug 9, 2016
6685a41
Remove line breaks
fabaff Aug 9, 2016
8e60223
Add inital 0.26 blog post
fabaff Aug 9, 2016
96d8846
Add link
fabaff Aug 9, 2016
ecb93ab
Add more contributors
fabaff Aug 9, 2016
6bd4946
Markdown fix for release blog. (#757)
partofthething Aug 9, 2016
67382db
Add documentation for new mqtt_json light platform. (#760)
corbanmailloux Aug 10, 2016
2479c68
A single quote snuck in and safety needed some love
robbiet480 Aug 10, 2016
a60c2c2
Revert "A single quote snuck in and safety needed some love"
robbiet480 Aug 10, 2016
32ffdc6
Add ha_release
fabaff Aug 10, 2016
d32e0e5
Add mqtt_json light
fabaff Aug 10, 2016
6776d38
Add new contributor
fabaff Aug 10, 2016
5ee123c
fast.com docs (#764)
nkgilley Aug 11, 2016
939a614
Documentation for serial particulate matter sensors (#765)
Aug 11, 2016
5664262
Merge with already existing docs
fabaff Aug 11, 2016
b52b2b7
Remove old pm docs
fabaff Aug 11, 2016
ea08597
Update
fabaff Aug 11, 2016
1b5233b
Update custom_panel_using_react.markdown (#769)
Danielhiversen Aug 12, 2016
945dd10
Documentation for the pilight component (#743)
DavidLP Aug 13, 2016
8a127d2
add ffmpeg support (#753)
pvizeli Aug 13, 2016
fc17f18
Fix the remaining issues
fabaff Aug 13, 2016
b656a78
Fix remaining issues
fabaff Aug 13, 2016
673a8e6
Update
fabaff Aug 13, 2016
1957efe
Merge branch 'master' into next
balloob Aug 13, 2016
c006cd0
Merge remote-tracking branch 'origin/zwave_updates' into next
balloob Aug 13, 2016
71c92b4
Document structure configuration variable for Nest. (#737)
freerobby Aug 13, 2016
5beb433
Add min_cycle_duration to heat_control documentation (#733)
mtreinish Aug 13, 2016
b0384e9
Add initial docs for GPSD component (#656)
fabaff Aug 13, 2016
af6689d
Sync with PR
fabaff Aug 13, 2016
ffe9e4e
Add Facebook like button to blog sidebar
robbiet480 Aug 13, 2016
89d9f7b
Merge branch 'next' of https://github.com/home-assistant/home-assista…
robbiet480 Aug 13, 2016
8064411
Update blog post
balloob Aug 13, 2016
b95109f
Rename blog post
balloob Aug 13, 2016
3282d11
Update blog name
balloob Aug 13, 2016
67c5bff
shrink logos'
balloob Aug 13, 2016
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions source/_components/alarm_control_panel.verisure.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -17,3 +17,19 @@ The Verisure alarm control panel platform allows you to control your [Verisure](

The requirement is that you have setup your [Verisure hub](/components/verisure/).

The `changed_by` attribute enables one to be able to take different actions depending on who armed/disarmed the alarm in [automation](/getting-started/automation/).

```yaml
automation:
- alias: Alarm status changed
trigger:
- platform: state
entity_id: alarm_control_panel.alarm_1
action:
- service: notify.notify
data_template:
message: >
{% raw %}Alarm changed from {{ trigger.from_state.state }}
to {{ trigger.to_state.state }}
by {{ trigger.to_state.attributes.changed_by }}{% endraw %}
```
44 changes: 44 additions & 0 deletions source/_components/camera.ffmpeg.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
layout: page
title: "FFmpeg Camera"
description: "Instructions how to integrate a Video fees with FFmpeg as cameras within Home Assistant."
date: 2016-08-13 08:00
sidebar: true
comments: false
sharing: true
footer: true
logo: ffmpeg.png
ha_category: Camera
ha_release: 0.26
---


The `ffmpeg` platform allows you to use every video feed with [FFmpeg](http://www.ffmpeg.org/) as camera in Home Assistant.

<p class='note'>
You need a ffmpeg binary in your system path. On debain 8 you can install it from backports. If you want HW support on raspberry you need self build from source. Windows binary are avilable on ffmpeg homepage.
</p>

To enable your FFmpeg feed in your installation, add the following to your `configuration.yaml` file:

```yaml
# Example configuration.yaml entry
camera:
- platform: ffmpeg
input: FFMPEG_SUPPORTED_INPUT
name: FFmpeg
ffmpeg_bin: /usr/bin/ffmpeg
extra_arguments: -q:v 2
```

Configuration variables:

- **input** (*Required*): A ffmpeg compatible input file, stream or feet.
- **name** (*Optional*): This parameter allows you to override the name of your camera.
- **ffmpeg_bin** (*Optional*): Default 'ffmpeg'.
- **extra_arguments** (*Optional*): Extra option they will pass to ffmpeg. i.e. image quality or video filter options.

### {% linkable_title Image quality %}

You can control the `image quality` with [`extra_arguments`](https://www.ffmpeg.org/ffmpeg-codecs.html#jpeg2000) `-q:v 2-32` or with lossless option `-pred 1`.

7 changes: 6 additions & 1 deletion source/_components/device_tracker.locative.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ logo: locative.png
ha_category: Presence Detection
---

This platform allows you to detect presence using [Locative](https://my.locative.io/). Locative is an [open source](https://github.com/LocativeHQ/ios-app) app for iOS that allows users to set up a `GET` or `POST` request when a geofence is entered or exited. This can be configured with Home Assistant to update your location.
This platform allows you to detect presence using [Locative](https://my.locative.io/). Locative is an open source app for [iOS](https://github.com/LocativeHQ/ios-app) and [Android](https://github.com/LocativeHQ/Locative-Android) that allows users to set up a `GET` or `POST` request when a geofence is entered or exited. This can be configured with Home Assistant to update your location.

To integrate Locative in Home Assistant, add the following section to your `configuration.yaml` file:

Expand All @@ -21,6 +21,11 @@ device_tracker:
platform: locative
```

Install on your smartphone:

- [Android](https://play.google.com/store/apps/details?id=io.locative.app)
- [iOS](https://itunes.apple.com/us/app/geofancy/id725198453)

To configure Locative, you must set up the app to send a `GET` request to your Home Assistant server at `http://<ha_server>/api/locative`. Make sure to include the API password if you have configured a password in Home Assistant (add `?api_password=<password>` to the end of the URL). When you enter or exit a geofence, Locative will send a `GET` request to that URL, updating Home Assistant.

<p class='img'>
Expand Down
62 changes: 62 additions & 0 deletions source/_components/foursquare.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
---
layout: page
title: Foursquare
description: "Instructions how to the Foursquare API into Home Assistant."
date: 2016-08-08 17:20
sidebar: true
comments: false
sharing: true
footer: true
logo: foursquare.png
featured: true
ha_category: Other
ha_release: 0.26
ha_iot_class: "Cloud Polling and Cloud Push"
---

The `foursquare` component accepts pushes from the Foursquare [Real-Time API](https://developer.foursquare.com/overview/realtime) and a service to check users in on Swarm.

```yaml
# Example configuration.yaml entry
foursquare:
access_token: "<foursquare access token>"
push_secret: "<foursquare push secret>"
```

Configuration variables:

- **access_token** (*Required*): A Foursquare API access token.
- **push_secret** (*Required*): The push secret that Foursquare provides to you in the app dashboard.

#### {% linkable_title Real-Time API %}

The component accepts pushes from Foursquare at `/api/foursquare`. The route does not require authentication.

Foursquare checkin events can be used out of the box to trigger automation actions, e.g.:

```yaml
automation:
- alias: Trigger action when you check into a venue.
trigger:
platform: event
event_type: foursquare.push
action:
service: script.turn_on
entity_id: script.my_action
```

#### {% linkable_title Check ins %}

To check a user in, use the `foursquare/checkin` service.

Parameters:

- **venueId** (*Required*): The Foursquare venue where the user is checking in.
- **eventId** (*Optional*): The event the user is checking in to.
- **shout** (*Optional*): A message about your check-in. The maximum length of this field is 140 characters.
- **mentions** (*Optional*): Mentions in your check-in. This parameter is a semicolon-delimited list of mentions. A single mention is of the form "start,end,userid", where start is the index of the first character in the shout representing the mention, end is the index of the first character in the shout after the mention, and userid is the userid of the user being mentioned. If userid is prefixed with "fbu-", this indicates a Facebook userid that is being mention. Character indices in shouts are 0-based.
- **broadcast** (*Optional*): "Who to broadcast this check-in to. Accepts a comma-delimited list of values: private (off the grid) or public (share with friends), facebook share on facebook, twitter share on twitter, followers share with followers (celebrity mode users only), If no valid value is found, the default is public."
- **ll** (*Optional*): Latitude and longitude of the user's location. Only specify this field if you have a GPS or other device reported location for the user at the time of check-in.
- **llAcc** (*Optional*): Accuracy of the user's latitude and longitude, in meters.
- **alt** (*Optional*): Altitude of the user's location, in meters.
- **altAcc** (*Optional*): Vertical accuracy of the user's location, in meters.
4 changes: 4 additions & 0 deletions source/_components/influxdb.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,9 @@ influxdb:
blacklist:
- entity.id1
- entity.id2
whitelist:
- entity.id3
- entity.id4
tags:
- instance: prod
```
Expand All @@ -44,5 +47,6 @@ Configuration variables:
- **ssl** (*Optional*): Use https instead of http to connect. Defaults to false.
- **verify_ssl** (*Optional*): Verify SSL certificate for https request. Defaults to false.
- **blacklist** (*Optional*): List of entities not logged to InfluxDB.
- **whitelist** (*Optional*): List of the entities (only) that will be logged to InfluxDB. If not set, all entities will be logged. Values set by the **blacklist** option will prevail.
- **tags** (*Optional*): Tags to mark the data.

82 changes: 82 additions & 0 deletions source/_components/light.mqtt_json.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
---
layout: page
title: "MQTT JSON Light"
description: "Instructions for how to setup MQTT JSON lights within Home Assistant."
date: 2016-08-09 08:30
sidebar: true
comments: false
sharing: true
footer: true
logo: mqtt.png
ha_category: Light
ha_iot_class: "Local Push"
ha_release: 0.26
---


The `mqtt_json` light platform let you control a MQTT-enabled light that can receive [JSON](https://en.wikipedia.org/wiki/JSON) messages.

This platform supports on/off, brightness, RGB colors, transitions, and short/long flashing. The messages sent to/from the lights look similar to this, omitting fields when they aren't needed:

```json
{
"brightness": 255,
"color": {
"g": 255,
"b": 255,
"r": 255
},
"transition": 2,
"state": "ON"
}
```


In an ideal scenario, the MQTT device will have a state topic to publish state changes. If these messages are published with the RETAIN flag, the MQTT light will receive an instant state update after subscription and will start with correct state. Otherwise, the initial state of the light will be off.

When a state topic is not available, the light will work in optimistic mode. In this mode, the light will immediately change state after every command. Otherwise, the light will wait for state confirmation from device (message from `state_topic`).

Optimistic mode can be forced, even if state topic is available. Try enabling it if the light is operating incorrectly.

To enable a light with brightness and RGB support in your installation, add the following to your `configuration.yaml` file:

```yaml
# Example configuration.yaml entry
light:
- platform: mqtt_json
name: mqtt_json_light_1
state_topic: "home/rgb1"
command_topic: "home/rgb1/set"
brightness: true
rgb: true
```

To enable a light with brightness (but no color support) in your installation, add the following to your `configuration.yaml` file:

```yaml
# Example configuration.yaml entry
light:
- platform: mqtt_json
name: mqtt_json_light_1
state_topic: "home/rgb1"
command_topic: "home/rgb1/set"
brightness: true
```

Configuration variables:

- **name** (*Optional*): The name of the light. Default is "MQTT JSON Light."
- **state_topic** (*Optional*): The MQTT topic subscribed to receive state updates.
- **command_topic** (*Required*): The MQTT topic to publish commands to change the light's state.
- **brightness** (*Optional*): Flag that defines if the light supports brightness. Default is false.
- **rgb** (*Optional*): Flag that defines if the light supports RGB colors. Default is false.
- **flash_time_short** (*Optional*): The duration, in seconds, of a "short" flash. Default is 2.
- **flash_time_long** (*Optional*): The duration, in seconds, of a "long" flash. Default is 10.
- **optimistic** (*Optional*): Flag that defines if the light works in optimistic mode. Default is true if no state topic defined, else false.
- **qos** (*Optional*): The maximum QoS level of the state topic. Default is 0 and will also be used to publishing messages.

<p class='note warning'>
Make sure that your topics match exact. `some-topic/` and `some-topic` are different topics.
</p>

A full example of custom lighting using this platform and an ESP8266 microcontroller can be found [here](https://github.com/corbanmailloux/esp-mqtt-rgb-led). It supports on/off, brightness, transitions, RGB colors, and flashing.
6 changes: 6 additions & 0 deletions source/_components/media_player.mpchc.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,12 @@ For this component to function, you will need to enable the Web Interface in the
<img src='{{site_root}}/images/screenshots/mpc-hc.png' />
</p>

If the server running Home Assistant is not the same device that is running MPC-HC, you will need to ensure that the *allow access from localhost only* option is not set.

<p class='note warning'>
The MPC-HC web interface is highly insecure, and allows remote clients full player control file-system access without authentication. Never allow access to the Web UI from outside of your trusted network, and if possible [use a proxy script to restrict control or redact sensitive information](https://github.com/abcminiuser/mpc-hc-webui-proxy).
</p>

To add MPC-HC to your installation, add the following to your `configuration.yaml` file:

```yaml
Expand Down
25 changes: 25 additions & 0 deletions source/_components/nest.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,32 @@ thermostat:
platform: nest
```

```yaml
# Example configuration.yaml entry to show only devices at your vacation home
nest:
username: USERNAME
password: PASSWORD
structure: Vacation

thermostat:
platform: nest
```

```yaml
# Example configuration.yaml entry to show only devices at your vacation and primary homes
nest:
username: USERNAME
password: PASSWORD
structure:
- Vacation
- Primary

thermostat:
platform: nest
```

Configuration variables:

- **username** (*Required*): Your Nest username.
- **password** (*Required*): Your Nest password.
- **structure** (*Optional*): The structure or structures you would like to include devices from. If not specified, this will include all structures in your Nest account.
2 changes: 1 addition & 1 deletion source/_components/notify.aws_lambda.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ The context will look like this:
"latitude": 44.1234,
"location_name": "Home",
"longitude": 5.5678,
"temperature_unit": "°C",
"unit_system": "metric",
"time_zone": "Europe/Zurich",
"version": "0.20.0.dev0"
},
Expand Down
21 changes: 21 additions & 0 deletions source/_components/notify.smtp.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,27 @@ Configuration variables:
- **recipient** (*Required*): Recipient of the notification.
- **starttls** (*Optional*): Enables STARTTLS, eg. 1 or 0. Defaults to 0.

To use the smtp notification, refer to it in an automation or script like in this example:

```yaml
burglar:
alias: Burglar Alarm
sequence:
- service: shell_command.snapshot
- delay:
seconds: 1
- service: notify.NOTIFIER_NAME
data:
title: 'Intruder alert'
message: 'Intruder alert at apartment!!'
data:
images:
- /home/pi/snapshot1.jpg
- /home/pi/snapshot2.jpg
```

The optional **images** field adds in-line image attachments to the email. This sends a text/HTML multi-part message instead of the plain text default.

This platform is fragile and not able to catch all exceptions in a smart way because of the large number of possible configuration combinations.

A combination that will work properly is port 587 and STARTTLS. It's recommended to enable STARTTLS, if possible.
Expand Down
40 changes: 40 additions & 0 deletions source/_components/panel_custom.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
layout: page
title: "Panel Custom"
description: "Instructions how to add customied panels to the frontend of Home Assistant."
date: 2015-08-08 11:00
sidebar: true
comments: false
sharing: true
footer: true
logo: home-assistant.png
ha_category: Frontend
ha_release: 0.26
---


The `panel_custom` support allows you to add additional panels to your Home Assistant frontend. The panels are listed in the sidebar if wished and can be highly customized.

To enable customized panels in your installation, add the following to your `configuration.yaml` file:

```yaml
# Example configuration.yaml entry
panel_custom:
- name: todomvc
sidebar_title: TodoMVC
sidebar_icon: mdi:work
url_path: my-todomvc
webcomponent_path: /home/hass/hello.html
config:
hello: world
```

Configuration variables:

- **name** (*Optional*): Name of the panel.
- **sidebar_title** (*Optional*): Friendly title for the panel in the sidebar. Omitting it means no sidebar entry (but still accessible through the URL).
- **sidebar_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`.
- **url_path** (*Optional*): The URL your panel will be available on. If omitted will default to the panel name.
- **webcomponent_path** (*Optional*): The path to your component. If omitted will default to `<config dir>/panels/<component name>.html`
- **config** (*Optional*): Configuration to be passed into your web component when being instantiated.

Loading