Skip to content

Merge documentation update for PR 4981 #1652

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

Closed
wants to merge 9 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions source/_components/binary_sensor.flic.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ Configuration variables:
- **host** (*Optional*): The IP or hostname of the flic service server. (default: `localhost`)
- **port** (*Optional*): The port of the flic service. (default: `5551`)
- **discovery** (*Optional*): If `true`, the component is configured to constantly scan for new buttons. (default: `true`)
- **ignored_click_types**: List of click types whose occurrence should not trigger and `flic_click` event.


#### {% linkable_title Discovery %}
Expand Down Expand Up @@ -61,3 +62,7 @@ Event data:
- **button_name**: The name of the button, that triggered the event.
- **button_address**: The bluetooth address of the button, that triggered the event.
- **click_type**: The type of click. Possible values are `single`, `double` and `hold`.


##### {% linkable_title Ignoring Click Types %}
For some purposes it might make sense to exclude a specific click type from triggering click events. For example when ignoring double clicks, pressing the button twice fast results in two `single` instead of a `double` click event. This is very useful for applications where you want to click fast.
2 changes: 1 addition & 1 deletion source/_components/ha.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ sharing: true
footer: true
logo: home-assistant.png
ha_category: Release
ha_release: 0.35
ha_release: 0.36
---

Details about the latest release can always be found at:
Expand Down
41 changes: 34 additions & 7 deletions source/_components/sensor.broadlink.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -13,16 +13,27 @@ ha_release: 0.35
---


The `broadlink` sensor platform let you monitor data from an RM2 and A1 E-air.
There is currently no support for the cloud API.
The `broadlink` sensor platform let you monitor data from an RM2 and A1 E-air. There is currently no support for the cloud API.

To enable it, add the following lines to your `configuration.yaml`:

```yaml
# Example configuration.yaml entry
switch:
- platform: broadlink
host: IP_ADDRESS
mac: 'MAC_ADDRESS'
monitored_conditions:
- 'temperature'
```

Configuration options:
- **name** (*Optional*): Default BL. Sensor name
- **update_interval** (*Optional*): Default 300. Time in seconds to fetch data from sensors

- **host** (*Required*): The hostname/IP address to connect to.
- **mac** (*Required*): Device mac address.
- **timeout** (*Optional*): Timeout in seconds for the connection to the device
- **name** (*Optional*): Default BL. Sensor name
- **update_interval** (*Optional*): Time in seconds to fetch data from sensors. Default 300.
- **timeout** (*Optional*): Timeout in seconds for the connection to the device.
- **monitored_conditions** array (*Required*): States to monitor.
- 'temperature'
- 'humidity'
Expand All @@ -33,9 +44,10 @@ Configuration options:
To set it up, add the following information to your `configuration.yaml` file:

Obtain sensor data from an A1:

```yaml
sensor:
platform: broadlink
- platform: broadlink
update_interval: 60
host: IP_ADDRESS
mac: 'MAC_ADDRESS'
Expand All @@ -48,12 +60,27 @@ sensor:
```

Obtain temperature data from an RM2:

```yaml
sensor:
platform: broadlink
- platform: broadlink
update_interval: 60
host: IP_ADDRESS
mac: 'MAC_ADDRESS'
monitored_conditions:
- temperature
```

### {% linkable_title Microsoft Windows installation %}

<p class='note'>
The pycrypto library needs to be available on your platform. On a typical windows sysytem `pip install pycrypto` will fail, as a compiler needs to be installed first.
</p>

The quickest way around this is to use a pre-built binary, e.g. from https://github.com/sfbahr/PyCrypto-Wheels

Be sure to get the correct 64 or 32-bit binary for your system, the full commandline will look something like the sample below for a 64-bit system:

```bash
pip install --use-wheel --no-index --find-links=https://github.com/sfbahr/PyCrypto-Wheels/raw/master/pycrypto-2.6.1-cp35-none-win_amd64.whl pycrypto
```
3 changes: 2 additions & 1 deletion source/_components/sensor.fastdotcom.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -46,5 +46,6 @@ Configuration variables:
- **minute** (*Optional*): Specify the minute(s) of the hour to schedule the speedtest. Use a list for multiple entries. Default is 0.
- **hour** (*Optional*): Specify the hour(s) of the day to schedule the speedtest. Use a list for multiple entries. Default is None.
- **day** (*Optional*): Specify the day(s) of the month to schedule the speedtest. Use a list for multiple entries. Default is None.
- **manual** (*Optional*): True or False to turn manual mode on or off. Manual mode will disable scheduled speedtests.

There is also a service named `sensor.update_fastdotcom` that you can use to run a fast.com speedtest on demand.
There is also a service named `sensor.update_fastdotcom` that you can use to run a fast.com speedtest on demand. You can turn on manual mode to disable the scheduled speedtests.
54 changes: 54 additions & 0 deletions source/_components/sensor.hydroquebec.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
---
layout: page
title: "Hydro-Québec"
description: "Instructions how to integrate Hydro-Québec consumption profile within Home Assistant."
date: 2016-12-10 0:15
sidebar: true
comments: false
sharing: true
footer: true
logo: hydroquebec.svg
ha_category: Energy
ha_release: 0.35
ha_iot_class: "Cloud Polling"
---


Integrate your [Hydro-Québec](https://www.hydroquebec.com/portail/) consumption profile information into Home Assistant.

```yaml
# Example configuration.yaml entry
ensor:
- platform: hydroquebec
username: MYUSERNAME
password: MYPASSWORD
monitored_variables:
- period_total_bill
- period_length
- period_total_days
- period_mean_daily_bill
- period_mean_daily_consumption
- period_total_consumption
- period_lower_price_consumption
- period_higher_price_consumption
- yesterday_total_consumption
- yesterday_lower_price_consumption
- yesterday_higher_price_consumption
```

Configuration variables:

- **username** (*Required*): The App Token for your account.
- **password** (*Required*): The App Token for your account.
- **monitored_variables** array (*Required*): Variables to monitor.
- **period_total_bill** : Current period bill
- **period_length**: Current period length
- **period_total_days**: Total number of days in this period
- **period_mean_daily_bill**: Period daily average bill
- **period_mean_daily_consumption**: Period daily average consumption
- **period_total_consumption**: Total Consumption
- **period_lower_price_consumption**: Period Lower price consumption
- **period_higher_price_consumption**: Period Higher price consumption
- **yesterday_total_consumption**: Yesterday total consumption
- **yesterday_lower_price_consumption**: Yesterday lower price consumption
- **yesterday_higher_price_consumption**: Yesterday higher price consumption
1 change: 1 addition & 0 deletions source/_components/sensor.nest.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ The following conditions are available by device:
- operation\_mode
- temperature
- target
- hvac\_state: The currently active state of the HVAC system, `heating`, `cooling`, or `off`.
- Nest Protect:
- co\_status
- smoke\_status
Expand Down
1 change: 1 addition & 0 deletions source/_components/sensor.sonarr.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ Configuration variables:
- **diskspace**: Available disk space.
- **host** (*Optional*): The host Sonarr is running on (Default: localhost).
- **port** (*Optional*): The port Sonarr is running on (Default: 8989).
- **urlbase** (*Optional*): The base URL Sonarr is running under (Default: /).
- **days** (*Optional*): How many days to look ahead for the upcoming sensor, 1 means today only (Default: 1).
- **included_paths** (*Optional*): Array of filepaths to include when calculating diskspace. Leave blank to include all.
- **unit**: (*Optional*): The unit to display disk space in (Default: GB).
Expand Down
4 changes: 3 additions & 1 deletion source/_components/sensor.speedtest.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -41,10 +41,12 @@ Configuration variables:
- **minute** (*Optional*): Specify the minute(s) of the hour to schedule the speedtest. Use a list for multiple entries. Default is 0.
- **hour** (*Optional*): Specify the hour(s) of the day to schedule the speedtest. Use a list for multiple entries. Default is None.
- **day** (*Optional*): Specify the day(s) of the month to schedule the speedtest. Use a list for multiple entries. Default is None.
- **manual** (*Optional*): True or False to turn manual mode on or off. Manual mode will disable scheduled speedtests.

This component uses [speedtest-cli](https://github.com/sivel/speedtest-cli) to gather network performance data from Speedtest.net. Please be aware of the potential [inconsistencies](https://github.com/sivel/speedtest-cli#inconsistency) that this component may display.

When Home Assistant first starts up, the values of the speedtest will show as `Unknown`. You can use the service `sensor.update_speedtest` to run a manual speedtest and populate the data or just wait for the next regularly scheduled test.
When Home Assistant first starts up, the values of the speedtest will show as `Unknown`. You can use the service `sensor.update_speedtest` to run a manual speedtest and populate the data or just wait for the next regularly scheduled test. You can turn on manual mode to disable the scheduled speedtests.


## {% linkable_title Examples %}

Expand Down
2 changes: 1 addition & 1 deletion source/_components/switch.broadlink.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ switch:
```

Configuration variables:

- **host** (*Required*): The hostname/IP address to connect to.
- **mac** (*Required*): Device mac address.
- **timeout** (*Optional*): Timeout in seconds for the connection to the device
Expand All @@ -39,7 +40,6 @@ Configuration variables:
- **command_off** (*Required*): Base64 encoded packet from RM device to take for off.



How to obtain IR/RF packets?

Choose Call Service from the Developer Tools. Choose the service broadlink/learn_command from the list of Available services: and hit CALL SERVICE. Press the button on your remote with in 20 seconds. The packet will be printed in the log and as a persistent notification.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,14 @@ categories: Release-Notes
og_image: /images/blog/2016-12-0.35/social.png
---

5000 stars on GitHub, 2000 people in out Gitter chatroom and over a million monthly pageviews. I don't think we could wish for a better place to be at the end of 2016. Feels like an early Christmas present! Our early one for you is 0.35. It's not a single thing inside a nice wrapping, more like several little gifts inside the 0.35 box.
5000 stars on GitHub, 2000 people in out Gitter chatroom and over a million monthly page views. I don't think we could wish for a better place to be at the end of 2016. Feels like an early Christmas present! Our early one for you is 0.35. It's not a single thing inside a nice wrapping, more like several little gifts inside the 0.35 box.

This will be the last release of 2016 as our developers are taking a well deserved break. We will be back in 2017!

## {% linkable_title Text to Speech %}
With the addition of a [text-to-speech][tts] component by [@pvizeli] we have been able to bring Home Assistant to a whole new level. The text-to-speech component will take in any text and will play it on a media player that supports to play media. We have tested this on Sonos, Chromecast, and Google Home.

https://www.youtube.com/watch?v=Ke0QuoJ4tRM
[https://www.youtube.com/watch?v=Ke0QuoJ4tRM](https://www.youtube.com/watch?v=Ke0QuoJ4tRM)

## {% linkable_title Call for help with HASSbian (our Raspberry Pi image) %}
In an effort to make Home Assistant, we're planning to extend the things that people can do out of the box with HASSbian, our Raspberry Pi image. As you might know, the image is currently maintained by [@Landrash]. However he also spends a lot of time on improving the docs and helping out with a ton of other things.
Expand All @@ -40,7 +40,7 @@ The [GPSLogger](https://home-assistant.io/components/device_tracker.gpslogger/)
- Sensor: Support weather conditions from Austrian [ZAMG][zamg] ([@mjl])
- Verisure: Add Verisure smartcam capture service ([@turbokongen])
- Binary sensor: [Flic][flic] button support added ([@soldag])
- Sensor: Support for [SenseHat][sensehat] ([@farminf])
- Sensor: Support for [Sense HAT][sensehat] ([@farminf])
- Binary sensor: [Hikvision][hikvision] binary sensor support ([@mezz64])
- [Text-to-speech][tts] support ([@pvizeli])
- Sensor: Support for Broadlink [sensors][bl-sensor] ([@Danielhiversen])
Expand Down
50 changes: 50 additions & 0 deletions source/images/supported_brands/hydroquebec.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.