mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-21 16:27:19 +00:00
Merge branch 'current' into next
This commit is contained in:
Paulus Schoutsen
commit
4039de28dd
@ -140,11 +140,11 @@ social:
|
||||
|
||||
# Home Assistant release details
|
||||
current_major_version: 0
|
||||
current_minor_version: 43
|
||||
current_patch_version: 2
|
||||
date_released: 2017-04-27
|
||||
current_minor_version: 44
|
||||
current_patch_version: 0
|
||||
date_released: 2017-05-06
|
||||
|
||||
# Either # or the anchor link to latest release notes in the blog post.
|
||||
# Must be prefixed with a # and have double quotes around it.
|
||||
# Example #release-0431---april-25
|
||||
patch_version_notes: "#release-0432---april-27"
|
||||
patch_version_notes: ""
|
||||
|
||||
16
source/_components/binary_sensor.maxcube.markdown
Normal file
16
source/_components/binary_sensor.maxcube.markdown
Normal file
@ -0,0 +1,16 @@
|
||||
---
|
||||
layout: page
|
||||
title: "eQ-3 MAX! Cube binary sensors"
|
||||
description: "Instructions on how to integrate eQ-3 MAX! components with Home Assistant via eQ-3 MAX! Cube."
|
||||
date: 2017-02-04 22:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: maxcube.png
|
||||
ha_category: Climate
|
||||
ha_release: "0.40"
|
||||
ha_iot_class: "Local Polling"
|
||||
---
|
||||
|
||||
See instructions at the [main component](/components/maxcube/).
|
||||
16
source/_components/climate.maxcube.markdown
Normal file
16
source/_components/climate.maxcube.markdown
Normal file
@ -0,0 +1,16 @@
|
||||
---
|
||||
layout: page
|
||||
title: "eQ-3 MAX! Cube binary sensors"
|
||||
description: "Instructions on how to integrate eQ-3 MAX! components with Home Assistant via eQ-3 MAX! Cube."
|
||||
date: 2017-02-04 22:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: maxcube.png
|
||||
ha_category: Climate
|
||||
ha_release: "0.40"
|
||||
ha_iot_class: "Local Polling"
|
||||
---
|
||||
|
||||
See instructions at the [main component](/components/maxcube/).
|
||||
@ -7,7 +7,7 @@ sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: OpenCV_Logo.png
|
||||
logo: opencv.png
|
||||
ha_category: Image Processing
|
||||
featured: false
|
||||
ha_release: 0.44
|
||||
|
||||
@ -47,8 +47,8 @@ Configuration variables:
|
||||
|
||||
- **bridges** array (*Required*):
|
||||
- **host** (*Required*): IP address of the device, eg. `192.168.1.32`
|
||||
- **version** (*Optional*): Bridge version (default is `6`). Don't use if you aren't sure.
|
||||
- **port** (*Optional*): Bridge port. Defaults to 5987.
|
||||
- **version** (*Optional*): Bridge version (default is `6`).
|
||||
- **port** (*Optional*): Bridge port. Defaults to 5987. For older bridges than v6 choose `8899`.
|
||||
- **groups** array (*Required*): The list of available groups.
|
||||
- **number** (*Required*): Group number (`1`-`4`). Corresponds to the group number on the remote. These numbers may overlap only if the type is different.
|
||||
- **name** (*Required*): Any name you'd like. Must be unique among all configured groups.
|
||||
@ -58,7 +58,7 @@ Configuration variables:
|
||||
|
||||
Refer to the [light]({{site_root}}/components/light/) documentation for general property usage, but keep in mind the following notes specific to LimitlessLED.
|
||||
|
||||
- **RGBWW**
|
||||
- **RGBWW** (Only supported on v6 bridges)
|
||||
- *Color*: There are 25,856 color possibilities along the LimitlessLED color spectrum. For colors, hue and saturation can be used, but not lightness. If you select a color with lightness, Home Assistant will calculate the nearest valid LimitlessLED color. In white mode the temperature can be set.
|
||||
- *Temperature*: There are 101 temperature steps.
|
||||
- *Brightness*: There are 101 brightness steps.
|
||||
|
||||
@ -57,6 +57,7 @@ Currently known supported models:
|
||||
Currently tested but not working models:
|
||||
|
||||
- J5200 - Unable to see state and unable to control
|
||||
- JU7000 - Unable to see state and unable to control (but port 8001 *is* open)
|
||||
- JU7500 - Unable to see state and unable to control
|
||||
|
||||
If your model is not on the list then give it a test, if everything works correctly then add it to the list on [GitHub](https://github.com/home-assistant/home-assistant.github.io/tree/current/source/_components/media_player.samsungtv.markdown).
|
||||
|
||||
@ -7,7 +7,7 @@ sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: OpenCV_Logo.png
|
||||
logo: opencv.png
|
||||
ha_category: Hub
|
||||
ha_release: 0.44
|
||||
ha_iot_class: "Local Push"
|
||||
|
||||
54
source/_components/plant.markdown
Normal file
54
source/_components/plant.markdown
Normal file
@ -0,0 +1,54 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Plant Observer"
|
||||
description: "Automation component to observe the status of your plants."
|
||||
date: 2017-05-06 08:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
ha_category: Other
|
||||
ha_release: 0.44
|
||||
---
|
||||
|
||||
```yaml
|
||||
plant:
|
||||
simulated_plant:
|
||||
sensors:
|
||||
moisture: sensor.mqtt_plant_moisture
|
||||
battery: sensor.mqtt_plant_battery
|
||||
temperature: sensor.mqtt_plant_temperature
|
||||
conductivity: sensor.mqtt_plant_conductivity
|
||||
brightness: sensor.mqtt_plant_brightness
|
||||
min_moisture: 20
|
||||
max_moisture: 60
|
||||
min_battery: 17
|
||||
min_conductivity: 500
|
||||
min_temperature: 15
|
||||
```
|
||||
|
||||
## Using plain MQTT sensor to get the data
|
||||
|
||||
```yaml
|
||||
sensor:
|
||||
- platform: mqtt
|
||||
name: mqtt_plant_moisture
|
||||
state_topic: test/simulated_plant
|
||||
value_template: '{{ value_json.moisture }}'
|
||||
- platform: mqtt
|
||||
name: mqtt_plant_battery
|
||||
state_topic: test/simulated_plant
|
||||
value_template: '{{ value_json.battery }}'
|
||||
- platform: mqtt
|
||||
name: mqtt_plant_temperature
|
||||
state_topic: test/simulated_plant
|
||||
value_template: '{{ value_json.temperature }}'
|
||||
- platform: mqtt
|
||||
name: mqtt_plant_conductivity
|
||||
state_topic: test/simulated_plant
|
||||
value_template: '{{ value_json.conductivity }}'
|
||||
- platform: mqtt
|
||||
name: mqtt_plant_brightness
|
||||
state_topic: test/simulated_plant
|
||||
value_template: '{{ value_json.brightness }}'
|
||||
```
|
||||
0
source/_components/sensor.ios.markdown
Normal file
0
source/_components/sensor.ios.markdown
Normal file
@ -21,7 +21,7 @@ To use your Mi Flora plant sensor in your installation, add the following to you
|
||||
# Example configuration.yaml entry
|
||||
sensor:
|
||||
- platform: miflora
|
||||
mac: "xx:xx:xx:xx:xx:xx"
|
||||
mac: 'xx:xx:xx:xx:xx:xx'
|
||||
monitored_conditions:
|
||||
- temperature
|
||||
```
|
||||
@ -50,7 +50,7 @@ A full configuration example could looks the one below:
|
||||
# Example configuration.yaml entry
|
||||
sensor:
|
||||
- platform: miflora
|
||||
mac: "xx:xx:xx:xx:xx:xx"
|
||||
mac: 'xx:xx:xx:xx:xx:xx'
|
||||
name: Flower 1
|
||||
force_update: false
|
||||
median: 3
|
||||
|
||||
@ -79,3 +79,19 @@ action:
|
||||
- service: homeassistant.turn_off
|
||||
entity_id: switch.vision_zm1601eu5_battery_operated_siren_switch_9_0
|
||||
```
|
||||
|
||||
An example to show the use of event_data in the action:
|
||||
|
||||
```
|
||||
- alias: 'Kitchen Telegram Speak'
|
||||
trigger:
|
||||
platform: event
|
||||
event_type: telegram_command
|
||||
event_data:
|
||||
command: '/speak'
|
||||
action:
|
||||
- service: notify.kitchen_echo
|
||||
data_template:
|
||||
message: >
|
||||
Message from {% raw %}{{ trigger.event.data["from_first"] }}. {% for state in trigger.event.data["args"] %} {{ state }} {% endfor %}{% endraw %}
|
||||
```
|
||||
|
||||
@ -43,3 +43,5 @@ tts:
|
||||
codec: mp3
|
||||
format: 8khz_8bit_mono
|
||||
```
|
||||
|
||||
Please note, some media_players require a certain format. For example the Sonos requires a format of '44khz_16bit_stereo'
|
||||
|
||||
@ -47,6 +47,8 @@ Configuration variables:
|
||||
- **icon** (*Optional*): Optional icon to show instead of name.
|
||||
- **passive** (*Optional*): Optional boolean to only use the zone for automation and hide it from the UI and not use the zone for device tracker name. Defaults to false.
|
||||
|
||||
To find your latitude / longtitude of a certain place you can use for example [Google Maps](https://www.google.nl/maps/) or [Bing Maps](https://www.bing.com/maps). Just right click and copy the coordinates from there (Bing) or click on the "What is here?" (Google)
|
||||
|
||||
#### {% linkable_title Home zone %}
|
||||
|
||||
If no configuration is given, the `zone` component will create a zone for home. This zone will use location given in the `configuration.yaml` file and have a radius of 100 meters. To override this, create a zone configuration and name it **'Home'**.
|
||||
|
||||
@ -14,15 +14,18 @@ Backing up and regularly syncing your Home Assistant configuration to [Dropbox](
|
||||
|
||||
### {% linkable_title Requirements %}
|
||||
|
||||
You need 2 parts in order to get it working correctly.
|
||||
You need two parts in order to get it working correctly.
|
||||
|
||||
Become the user you run homeassistant from.
|
||||
Become the user that run Home Assistant.
|
||||
|
||||
- A seperate python script that syncs a specific folder. Which can be found [here](https://gist.github.com/riemers/31e3350041fd3e47e489cbc811209d6f)
|
||||
- A seperate Python script that syncs a specific folder. Which can be found [here](https://gist.github.com/riemers/31e3350041fd3e47e489cbc811209d6f)
|
||||
- The excellent [dropbox uploader script](https://github.com/andreafabrizi/Dropbox-Uploader/blob/master/dropbox_uploader.sh) you can grab the .sh file only.
|
||||
|
||||
Download those files to a folder of your liking, after that edit both files and change paths accordingly.
|
||||
### {% linkable_title Step 1: Linking your dropbox account %}
|
||||
|
||||
In the Python script you can specify which files and directories should be excluded. This allows you to skip `secrets.yaml` or the `deps` folder.
|
||||
|
||||
### {% linkable_title Step 1: Linking your Dropbox account %}
|
||||
|
||||
```bash
|
||||
$ chmod +x dropbox_uploader.sh
|
||||
@ -30,16 +33,16 @@ $ ./dropbox_uploader.sh
|
||||
```
|
||||
Follow the instructions you see on your screen.
|
||||
|
||||
### {% linkable_title Step 2: Running the dropbox uploader %}
|
||||
### {% linkable_title Step 2: Running the Dropbox uploader %}
|
||||
|
||||
Go to the folder you have placed dropbox.py.
|
||||
Go to the folder you have placed `dropbox.py`.
|
||||
|
||||
```bash
|
||||
$ python dropbox.py
|
||||
```
|
||||
|
||||
The first time can take a lot of time since it will upload all your files!
|
||||
Do note, this will **backup your passwords to dropbox too**
|
||||
Do note, this will **backup your passwords to Dropbox**.
|
||||
|
||||
### {% linkable_title Automate the backup %}
|
||||
|
||||
@ -49,5 +52,3 @@ Add it to your crontab, edit the **path/to** part.
|
||||
```bash
|
||||
$ (crontab -l 2>/dev/null; echo "0 3 * * * python /path/to/dropbox.py") | crontab -
|
||||
```
|
||||
|
||||
_The python script is very crude, there is room for improvement with regards to not backing up certain files like cache or files that will be installed by HA again after reinstall. But it gets the job done._
|
||||
|
||||
@ -12,12 +12,14 @@ redirect_from: /getting-started/hassbian-customization/
|
||||
|
||||
To allow you to customize your installation further, we have included a tool called `hassbian-config`. This tool comes with a set of packages that can easily be installed for easier customization of your Home Assistant installation.
|
||||
|
||||
- Install Samba. Allows anyone on your network to edit your configuration from any computer. This share is unsecured and it's usage is not recommended if you share your network with others.
|
||||
- Install Libcec. Adds local [HDMI CEC support][cec].
|
||||
- Install Mosquitto MQTT server. Installs the latest Mosquitto package and client tools from the Mosquitto projects offical repository. Now includes websocket support.
|
||||
- Install Open Z-Wave. Installs Open Z-Wave and prepares for using a USB or GPIO ZWave controller.
|
||||
- Install Hue. hue: Configures the Python executable to allow usage of low numbered ports for use with Emulated Hue component thats used with Amazon Echo, Google Home and Mycroft.ai.
|
||||
- Install Tellstick. Installs the Tellstick package for controling and using a connected Tellstick.
|
||||
- Install Hue. Configures the Python executable to allow usage of low numbered ports for use with Emulated Hue component thats used with Amazon Echo, Google Home and Mycroft.ai.
|
||||
- Install Mosquitto MQTT server. Installs the latest Mosquitto package and client tools from the Mosquitto projects official repository. Now includes websocket support.
|
||||
- Install Libcec. Adds local [HDMI CEC support][cec].
|
||||
- Install Open Z-Wave-pip. Installs Python Open Z-Wave from a pip package. This is the quickest and recommended way of installing Z-Wave support but does not OZWCP pre-installed.
|
||||
- Install Open Z-Wave. Installs Python Open Z-Wave and OZWCP from git.
|
||||
- Install Samba. Allows anyone on your network to edit your configuration from any computer. This share is unsecured and it's usage is not recommended if you share your network with others.
|
||||
- Install Tellstick. Installs the Tellstick package for controlling and using a connected Tellstick.
|
||||
- Install Tradfri. Installs dependencies for using IKEA Trådfri.
|
||||
|
||||
The tool is available by running `hassbian-config`. To view the available packages run `hassbian-config show` and `sudo hassbian-config install PACKAGENAME`.
|
||||
For more information about this tool have a look at the [hassbian-scripts repository][hassbian-repo].
|
||||
|
||||
@ -24,8 +24,6 @@ There is one dependency you will need to have installed ahead of time:
|
||||
$ sudo apt-get install libudev-dev
|
||||
```
|
||||
|
||||
_Note: The Home Assistant docker image, HASSbian, and the All In One installer all have support for Z-Wave already built-in!_
|
||||
|
||||
### {% linkable_title Configuration %}
|
||||
|
||||
```yaml
|
||||
|
||||
@ -7,16 +7,18 @@
|
||||
<ul>
|
||||
<li>{% active_link /hassio/installation/ Installation %}</li>
|
||||
<li>{% active_link /addons/ Available add-ons %}</li>
|
||||
<li>{% active_link /hassio/architecture/ Architecture %}</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class='divided sidebar-menu'>
|
||||
<li>
|
||||
{% active_link /hassio/development/ Development %}
|
||||
{% active_link /hassio/addon_development/ Add-on Development %}
|
||||
<ul>
|
||||
<li>{% active_link /hassio/architecture/ Architecture %}</li>
|
||||
<li>{% active_link /hassio/create_hassio_addon/ Creating add-ons %}</li>
|
||||
<li>{% active_link /hassio/create_hassio_addon_repository/ Creating add-on repositories %}</li>
|
||||
<li>{% active_link /hassio/addon_config/ Configuration %}</li>
|
||||
<li>{% active_link /hassio/addon_testing/ Local Testing %}</li>
|
||||
<li>{% active_link /hassio/addon_publishing/ Publishing %}</li>
|
||||
<li>{% active_link /hassio/addon_repository/ Repositories %}</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
@ -486,8 +486,6 @@ Experiencing issues introduced by this release? Please report them in our [issue
|
||||
[wemo docs]: /components/wemo/
|
||||
[zwave docs]: /components/zwave/
|
||||
[zwave.node_entity docs]: /components/zwave.node_entity/
|
||||
<<<<<<< HEAD
|
||||
=======
|
||||
[forum]: https://community.home-assistant.io/
|
||||
[gitter]: https://gitter.im/home-assistant/home-assistant
|
||||
[issue]: https://github.com/home-assistant/home-assistant/issues
|
||||
@ -521,4 +519,3 @@ Experiencing issues introduced by this release? Please report them in our [issue
|
||||
[notify.html5 docs]: https://home-assistant.io/components/notify.html5/
|
||||
[notify.telegram docs]: https://home-assistant.io/components/notify.telegram/
|
||||
[telegram_bot.polling docs]: https://home-assistant.io/components/telegram_bot.polling/
|
||||
>>>>>>> current
|
||||
|
||||
@ -21,14 +21,14 @@ With the release of 1.21 a small problem with the OpenZWave build script wasn't
|
||||
|
||||
To allow you to customize your installation further, we have included a tool called `hassbian-config`. This tool comes with a set of packages that can easily be installed for easier customization of your Home Assistant installation. This replaces the `hassbian-scripts` functionality from 1.1.
|
||||
|
||||
- Install Samba. Allows anyone on your network to edit your configuration from any computer. This share is unsecured and it's usage is not recommended if you share your network with others.
|
||||
- Install Libcec. Adds local [HDMI CEC support][cec].
|
||||
- Install Mosquitto MQTT server. Installs the latest Mosquitto package and client tools from the Mosquitto projects official repository. Now includes websocket support.
|
||||
- Install Open Z-Wave-pip. Installs Python Open Z-Wave from a pip package. This is the quickest and recommended way of installing Z-Wave support but does not OZWCP pre-installed.
|
||||
- Install Open Z-Wave. Installs Python Open Z-Wave and OZWCP from git.
|
||||
- Install Tradfri. Installs dependencies for using IKEA Trådfri.
|
||||
- Install Hue. Configures the Python executable to allow usage of low numbered ports for use with Emulated Hue component thats used with Amazon Echo, Google Home and Mycroft.ai.
|
||||
- Install Tellstick. Installs the Tellstick package for controlling and using a connected Tellstick.
|
||||
- Install Mosquitto MQTT server. Installs the latest Mosquitto package and client tools from the Mosquitto projects official repository. Now includes websocket support.
|
||||
- Install Libcec. Adds local [HDMI CEC support][cec].
|
||||
- Install Open Z-Wave-pip. Installs Python Open Z-Wave from a pip package. This is the quickest and recommended way of installing Z-Wave support but does not OZWCP pre-installed.
|
||||
- Install Open Z-Wave. Installs Python Open Z-Wave and OZWCP from git.
|
||||
- Install Samba. Allows anyone on your network to edit your configuration from any computer. This share is unsecured and it's usage is not recommended if you share your network with others.
|
||||
- Install Tellstick. Installs the Tellstick package for controlling and using a connected Tellstick.
|
||||
- Install Tradfri. Installs dependencies for using IKEA Trådfri.
|
||||
|
||||
### {% linkable_title Spring cleaning %}
|
||||
|
||||
|
||||
22
source/_posts/2017-05-05-podcast-init-interview.markdown
Normal file
22
source/_posts/2017-05-05-podcast-init-interview.markdown
Normal file
@ -0,0 +1,22 @@
|
||||
---
|
||||
layout: post
|
||||
title: "Podcast.__init__ interview with Paulus Schoutsen"
|
||||
description: "Tobias Macey interviews our founder Paulus Schoutsen about Home Assistant."
|
||||
date: 2017-05-05 02:00:00
|
||||
date_formatted: "May 5, 2017"
|
||||
author: Paulus Schoutsen
|
||||
author_twitter: balloob
|
||||
comments: true
|
||||
categories: Community
|
||||
og_image: /images/blog/2017-05-podcast-init/podcast_init.png
|
||||
---
|
||||
|
||||
<p class='img'>
|
||||
<a href='https://www.podcastinit.com/'><img src='/images/blog/2017-05-podcast-init/podcast_init.png' /></a>
|
||||
</p>
|
||||
|
||||
Earlier this year I was interviewed by Tobias Macey from [Podcast.\_\_init\_\_][pc-init] about Python and Home Assistant. Just realized that we never shared this on the blog, oops. Here it is, enjoy!
|
||||
|
||||
<script class="podigee-podcast-player" src="//cdn.podigee.com/podcast-player/javascripts/podigee-podcast-player.js" data-configuration="https://www.podcastinit.com?podigee_player=205"></script>
|
||||
|
||||
[pc-init]: https://www.podcastinit.com/
|
||||
487
source/_posts/2017-05-06-zigbee-opencv-dlib.markdown
Normal file
487
source/_posts/2017-05-06-zigbee-opencv-dlib.markdown
Normal file
@ -0,0 +1,487 @@
|
||||
---
|
||||
layout: post
|
||||
title: "Home Assistant 0.44: ZigBee, OpenCV and DLib"
|
||||
description: "Speak natively with Zigbee network, detect faces with OpenCV: 0.44 is here."
|
||||
date: 2017-05-06 01:04:05 +0000
|
||||
date_formatted: "May 6, 2017"
|
||||
author: Paulus Schoutsen
|
||||
author_twitter: balloob
|
||||
comments: true
|
||||
categories: Release-Notes
|
||||
og_image: /images/blog/2017-05-0.44/components.png
|
||||
---
|
||||
|
||||
<a href='/components/#added_in_current_version'><img src='/images/blog/2017-05-0.44/components.png' style='border: 0;box-shadow: none;'></a>
|
||||
|
||||
This release brings some great new integrations. The biggest one is the [native ZigBee integration][zha docs] by [Russell Cloran][@rcloran]. This will allow Home Assistant to natively control Philips Hue lights without the need for a hub! (IKEA Tradfri lights not yet due to implementing a different profile)
|
||||
|
||||
Another great new addition is [OpenCV][opencv docs] by [Teagan Glenn][@teagan42]. So now you'll be able to unlock all the cool stuff from OpenCV right in Home Assistant. And if OpenCV is not your style, you can try out the new [DLib integration][image_processing.dlib_face_identify docs] added by [Pascal Vizeli][@pvizeli] in this release.
|
||||
|
||||
This release also includes a [new component][rss_feed_template docs] to dynamically generate RSS feeds based on a template. This means that any RSS widget on your phone, tablet or computer can now be used to show Home Assistant data!
|
||||
|
||||
Enjoy!
|
||||
|
||||
## {% linkable_title If you need help... %}
|
||||
...don't hesitate to use our very active [forums][forum] or join us for a little [chat][gitter]. The release notes have comments enabled but it's preferred if you use the former communication channels. Thanks.
|
||||
|
||||
## {% linkable_title Reporting Issues %}
|
||||
Experiencing issues introduced by this release? Please report them in our [issue tracker][issue]. Make sure to fill in all fields of the issue template.
|
||||
|
||||
## {% linkable_title New integrations %}
|
||||
|
||||
- Pushbullet notification sensor ([@jotunacorn] - [#7182]) ([sensor.pushbullet docs])
|
||||
- Add https certificate expiry sensor ([@fabfurnari] - [#7272]) ([sensor.cert_expiry docs])
|
||||
- RSS feed template ([@micw] - [#7032]) ([rss_feed_template docs])
|
||||
- Add support for Zigbee Home Automation ([@rcloran] - [#6263]) ([zha docs]) ([binary_sensor.zha docs]) ([light.zha docs]) ([sensor.zha docs]) ([switch.zha docs])
|
||||
- light.blinkt: add support for Blinkt! lights on Raspberry Pi ([@imrehg] - [#7377]) ([light.blinkt docs])
|
||||
- Plant automation ([@ChristianKuehnel] - [#7131]) ([plant docs])
|
||||
- Add Eight sleep component ([@mezz64] - [#7275]) ([eight_sleep docs]) ([binary_sensor.eight_sleep docs]) ([sensor.eight_sleep docs])
|
||||
- OpenGarage support ([@swbradshaw] - [#7338]) ([cover.opengarage docs])
|
||||
- Add Sensibo climate platform ([@andrey-git] - [#7379]) ([climate docs])
|
||||
- Pilight binary sensor components ([@zeltom] - [#6774]) ([binary_sensor.pilight docs])
|
||||
- Opencv ([@Teagan42] - [#7261]) ([opencv docs]) ([image_processing.opencv docs])
|
||||
- Add new sensor: Enviro pHAT ([@imrehg] - [#7427]) ([sensor.envirophat docs])
|
||||
- Add support for face recognition with dlib ([@pvizeli] - [#7421]) ([image_processing.dlib_face_detect docs]) ([image_processing.dlib_face_identify docs])
|
||||
|
||||
<!--more-->
|
||||
## {% linkable_title Breaking changes %}
|
||||
|
||||
- Python Open Z-Wave made a release that fixed string processing. This was backwards incompatible. We have updated our code so you'll have to update to the latest Python Open Z-Wave with this release. You can also wait one release, as next release we'll introduce automatic installing of Python Open Z-Wave. ([@keatontaylor] - [#7266]) ([climate.zwave docs]) (breaking change)
|
||||
- InfluxDB configuration to blacklist domains has been updated to allow more features. ([@janLo] - [#7264]) (breaking change)
|
||||
|
||||
```yaml
|
||||
# New format
|
||||
influxdb:
|
||||
exclude:
|
||||
entities:
|
||||
- entity.id1
|
||||
- entity.id2
|
||||
domains:
|
||||
- automation
|
||||
include:
|
||||
entities:
|
||||
- entity.id3
|
||||
- entity.id4
|
||||
```
|
||||
|
||||
- The Automatic device tracker has been converted from polling to websocket push. This requires you to make a change in your Automatic account, see [our documentation for instructions][device_tracker.automatic docs]. ([@armills] - [#7404]) ([device_tracker.automatic docs]) (breaking change)
|
||||
- The LimitlessLED color temperatures have been turned around to work like other lights. To maintain previous colors you must adjust the color_temp value in your light.turn_on calls to 654 minus your old value (for example, 280 becomes 374). ([@amelchio] - [#7359]) (breaking change)
|
||||
- Joao apps will now require an API key to be set for all commands. ([@nkgilley] - [#7443]) ([joaoapps_join docs]) ([notify.joaoapps_join docs]) (breaking change)
|
||||
|
||||
## {% linkable_title All changes %}
|
||||
|
||||
- LIFX light effects ([@amelchio] - [#7145]) ([light.lifx docs])
|
||||
- HassIO API v2 ([@pvizeli] - [#7201])
|
||||
- Capture and log pip install error output ([@postlund] - [#7200])
|
||||
- Support xy_color with LIFX lights ([@amelchio] - [#7208]) ([light.lifx docs])
|
||||
- Update ios.py ([@biacz] - [#7160])
|
||||
- Fix arwn platform to update hass state when events are received ([@sdague] - [#7202])
|
||||
- Issue 6749 updated pylgtv to 0.1.6 to fix thread leak in asyncio loop ([@hmn] - [#7199]) ([media_player.webostv docs]) ([notify.webostv docs])
|
||||
- tradfri: Improve color temp support detection ([@balloob] - [#7211])
|
||||
- Fix tradfri lights ([@MartinHjelmare] - [#7212])
|
||||
- Bump version to 0.44.0.dev0 ([@fabaff] - [#7217])
|
||||
- Pushbullet notification sensor ([@jotunacorn] - [#7182]) ([sensor.pushbullet docs]) (new-platform)
|
||||
- Zwave cover workaround for graber shades. ([@turbokongen] - [#7204]) ([cover.zwave docs])
|
||||
- Fixed typo and clarified details for Lifx effects ([@arsaboo] - [#7226])
|
||||
- Remove superfluous comments and update ordering ([@fabaff] - [#7227]) ([maxcube docs]) ([binary_sensor.maxcube docs]) ([climate.maxcube docs])
|
||||
- lyft sensor: re-enable Prime Time rate attribute ([@drkp] - [#6982]) ([sensor.lyft docs])
|
||||
- Bump a couple of dependencies ([@mjg59] - [#7231]) ([light.avion docs]) ([light.decora docs])
|
||||
- Refactor lyft sensor update ([@armills] - [#7233]) ([sensor.lyft docs])
|
||||
- LIFX: avoid "Unable to remove unknown listener" warning ([@amelchio] - [#7235]) ([light.lifx docs])
|
||||
- Upgrade pygatt to 3.1.1 ([@fabaff] - [#7220])
|
||||
- Upgrade mutagen to 1.37.0 ([@fabaff] - [#7216])
|
||||
- Upgrade speedtest-cli to 1.0.5 ([@fabaff] - [#7215])
|
||||
- Upgrade paho-mqtt to 1.2.3 ([@fabaff] - [#7214])
|
||||
- Upgrade aiohttp_cors to 0.5.3 ([@fabaff] - [#7213])
|
||||
- Use consts and string formatting ([@fabaff] - [#7243]) ([notify.instapush docs])
|
||||
- Pushed to version 0.4.0 of denonavr which also includes experimental support for Marantz receivers ([@scarface-4711] - [#7250])
|
||||
- Add notice regarding submission of analytics ([@craftyguy] - [#7263])
|
||||
- Iterating the dictionary directly ([@fabaff] - [#7251])
|
||||
- Don't use len(SEQUENCE) as condition value ([@fabaff] - [#7249])
|
||||
- Workround for wemo subscription bug. ([@pavoni] - [#7245]) ([wemo docs]) ([switch.wemo docs])
|
||||
- Fix telegram webhooks ([@MartinHjelmare] - [#7236]) ([telegram_bot docs]) ([telegram_bot.webhooks docs])
|
||||
- Work around bad content-type in Hook api response ([@KlaasH] - [#7267]) ([switch.hook docs])
|
||||
- Rfxtrx upgrade lib 0.18 ([@danielhiversen] - [#7273]) ([rfxtrx docs])
|
||||
- WIP: HassIO allow to access to container logs. ([@pvizeli] - [#7271])
|
||||
- Update aiolifx ([@amelchio] - [#7279]) ([light.lifx docs])
|
||||
- Refactor matrix notify service ([@Cadair] - [#7122]) ([notify.matrix docs])
|
||||
- Add support for Ukrainian Language in Google TTS ([@LvivEchoes] - [#7278])
|
||||
- Add https certificate expiry sensor ([@fabfurnari] - [#7272]) ([sensor.cert_expiry docs]) (new-platform)
|
||||
- Fix telegram_polling no first_name or last_name ([@darookee] - [#7281]) ([telegram_bot docs])
|
||||
- Add script to import state events to InfluxDB ([@janLo] - [#7254])
|
||||
- Fix HassIO bug with supervisor update & log ([@pvizeli] - [#7282])
|
||||
- Updating ping binary sensor with Windows support ([@patrickeasters] - [#7253]) ([binary_sensor.ping docs])
|
||||
- Fixes utf-8 encoding no longer required by python-openzwave0.3.3 ([@keatontaylor] - [#7266]) ([climate.zwave docs]) (breaking change)
|
||||
- Recorder: Check for ENTITY_ID key that contains None value ([@balloob] - [#7287]) ([recorder docs])
|
||||
- Upgrade pytradfri to 1.1 ([@balloob] - [#7290])
|
||||
- Adding group control to tradfri light component ([@cyberjunky] - [#7248]) ([light.tradfri docs])
|
||||
- Feature/rss feed template ([@micw] - [#7032]) ([rss_feed_template docs]) (new-platform)
|
||||
- Add support for Zigbee Home Automation ([@rcloran] - [#6263]) ([zha docs]) ([binary_sensor.zha docs]) ([light.zha docs]) ([sensor.zha docs]) ([switch.zha docs]) (new-platform)
|
||||
- Added scene controller support to the vera component, along with proper polling when a vera device needs it ([@alanfischer] - [#7234]) ([vera docs]) ([sensor.vera docs])
|
||||
- Don't stack up error messages, fix link, and ordering ([@fabaff] - [#7291]) ([sensor.cert_expiry docs])
|
||||
- Fix breaking SSL in test HTML5 ([@balloob] - [#7310]) ([notify.html5 docs])
|
||||
- Upgrade pyhomematic, extend device support ([@danielperna84] - [#7303])
|
||||
- Issue 7218 update pylgtv to 0.1.7 ([@hmn] - [#7302]) ([media_player.webostv docs]) ([notify.webostv docs])
|
||||
- Version bump of aioautomatic ([@armills] - [#7300]) ([device_tracker.automatic docs])
|
||||
- Upgrade python-telegram-bot to 5.3.1 ([@fabaff] - [#7311]) ([notify.telegram docs]) ([telegram_bot.polling docs]) ([telegram_bot.webhooks docs])
|
||||
- Disable Open Z-Wave in Docker ([@balloob] - [#7315])
|
||||
- LIFX: use white light when setting a specific temperature ([@amelchio] - [#7256]) ([light.lifx docs])
|
||||
- Allow InfluxDB to blacklist domains ([@janLo] - [#7264]) (breaking change)
|
||||
- Hassio api v3 ([@balloob] - [#7323])
|
||||
- Update frontend ([@balloob] - [#7324])
|
||||
- Reduce color_xy_brightness_to_hsv to color_xy_to_hs ([@amelchio] - [#7320]) ([light.hue docs]) ([light.lifx docs])
|
||||
- Fix broken docker build ([@turbokongen] - [#7316])
|
||||
- Re-enable Open Z-Wave in Dockerfile ([@balloob] - [#7325])
|
||||
- Version bump for automatic ([@armills] - [#7329]) ([device_tracker.automatic docs])
|
||||
- Right fix for Python Open Z-Wave in Docker ([@balloob] - [#7337])
|
||||
- Use four-digits year ([@fabaff] - [#7336])
|
||||
- Allow multiple recipients for SMTP notify ([@amelchio] - [#7319]) ([notify.smtp docs])
|
||||
- Add auxheat to ecobee climate ([@titilambert] - [#6562]) ([climate.ecobee docs])
|
||||
- Properly return self._unit_of_measurement in the unit_of_measurement function ([@robbiet480] - [#7341]) ([sensor.ios docs])
|
||||
- Multiple changes (typo, ordering, docstrings, timeouts) ([@fabaff] - [#7343]) ([cover.garadget docs])
|
||||
- Upgrade Flux led lb to 0.19 ([@danielhiversen] - [#7352]) ([light.flux_led docs])
|
||||
- Add debug logging to pyvera events. ([@pavoni] - [#7364]) ([vera docs])
|
||||
- Upgrade xmltodict to 0.11.0 ([@fabaff] - [#7355])
|
||||
- Upgrade speedtest-cli to 1.0.6 ([@fabaff] - [#7354]) ([sensor.speedtest docs])
|
||||
- Remove global limit on white light temperature ([@amelchio] - [#7206]) ([light docs]) ([light.hue docs]) ([light.zwave docs]) ([switch.flux docs])
|
||||
- Remove state property from alarmdecoder binary sensor ([@balloob] - [#7370]) ([binary_sensor.alarmdecoder docs])
|
||||
- Remove binary sensor platforms implementing state property ([@balloob] - [#7371]) ([binary_sensor.octoprint docs]) ([binary_sensor.workday docs])
|
||||
- Feature/add mikrotik device tracker ([@LvivEchoes] - [#7366])
|
||||
- Netdisco now returns a dictionary while it used to be a tuple, fixed ([@JasonCarter80] - [#7350])
|
||||
- Create knx.py ([@onsmam] - [#7356])
|
||||
- light.sensehat: plugin to control the 8x8 LED matrix on a Sense hat ([@imrehg] - [#7365])
|
||||
- Update docstrings ([@fabaff] - [#7361]) ([ecobee docs]) ([enocean docs]) ([zha docs])
|
||||
- Flux switch: avoid updates when off ([@amelchio] - [#7363]) ([switch.flux docs])
|
||||
- Zoneminder: Fixed undefined index error ([@bah2830] - [#7340])
|
||||
- optimize remote calls and apps on webostv media_player ([@hmn] - [#7191]) ([media_player.webostv docs])
|
||||
- binary_sensor.workday: fix handling of states vs provinces ([@drkp] - [#7162]) ([binary_sensor.workday docs])
|
||||
- Upgrade voluptuous to 0.10.5 ([@fabaff] - [#7107])
|
||||
- Remove ordered_dict validator ([@balloob] - [#7375])
|
||||
- light.blinkt: add support for Blinkt! lights on Raspberry Pi ([@imrehg] - [#7377]) ([light.blinkt docs]) (new-platform)
|
||||
- improve handling of flux_led lights in RGBW mode ([@wuub] - [#7221])
|
||||
- Plant (replacement for MiGardener) ([@ChristianKuehnel] - [#7131]) ([plant docs]) (new-platform)
|
||||
- Add support for shuffle toggling on Spotify component. ([@abmantis] - [#7339]) ([media_player docs]) ([media_player.spotify docs])
|
||||
- Upgrade Ring to 0.1.4 ([@tchellomello] - [#7386])
|
||||
- Updated docstrings ([@arsaboo] - [#7383]) ([camera.netatmo docs])
|
||||
- Fix impulse events, added error event for Homegear ([@danielperna84] - [#7349]) ([homematic docs])
|
||||
- Fix YAML dump ([@balloob] - [#7388])
|
||||
- Migrate updater to aiohttp ([@balloob] - [#7387]) ([updater docs])
|
||||
- Remove path whitelisting for hassio ([@balloob] - [#7399])
|
||||
- Add Eight sleep component ([@mezz64] - [#7275]) ([eight_sleep docs]) ([binary_sensor.eight_sleep docs]) ([sensor.eight_sleep docs]) (new-platform)
|
||||
- OpenGarage support ([@swbradshaw] - [#7338]) ([cover.opengarage docs]) (new-platform)
|
||||
- Clean up requirements ([@andrey-git] - [#7391]) ([nuimo_controller docs]) ([sensor.dht docs]) ([sensor.thinkingcleaner docs]) ([switch.thinkingcleaner docs])
|
||||
- correct MQTT subscription filter ([@amigian74] - [#7269]) ([mqtt docs])
|
||||
- Update docstrings ([@fabaff] - [#7374])
|
||||
- light.blinkt: update brightness control logic ([@imrehg] - [#7389])
|
||||
- Update docstrings ([@fabaff] - [#7405])
|
||||
- Update LIFX default color for breathe/pulse effects ([@amelchio] - [#7407])
|
||||
- LIFX: Add transition option to colorloop effect ([@amelchio] - [#7410])
|
||||
- light.sensehat: brightness control logic update ([@imrehg] - [#7409]) ([light.sensehat docs])
|
||||
- Add Sensibo climate platform ([@andrey-git] - [#7379]) ([climate docs]) (new-platform)
|
||||
- Pilight binary sensor components ([@zeltom] - [#6774]) ([binary_sensor.pilight docs]) (new-platform)
|
||||
- applx suggested fix from issue #6573 ([@wokar] - [#7390]) ([sensor.zamg docs])
|
||||
- remove charset if set in content type header ([@hmn] - [#7411]) ([media_player docs])
|
||||
- Convert automatic device tracker to push updates ([@armills] - [#7404]) ([device_tracker.automatic docs]) (breaking change)
|
||||
- light.piglow update ([@imrehg] - [#7408]) ([light.piglow docs])
|
||||
- Opencv ([@Teagan42] - [#7261]) ([opencv docs]) ([image_processing.opencv docs]) (new-platform)
|
||||
- Fixed extra R in variable name. ([@cyberplant] - [#7418])
|
||||
- Update docstrings ([@fabaff] - [#7420])
|
||||
- ps - fix opencv ([@balloob] - [#7419])
|
||||
- Comment out opencv-python that is not installable on arm ([@andrey-git] - [#7426])
|
||||
- Reverse limitlessled color_temp range ([@amelchio] - [#7359]) (breaking change)
|
||||
- Guard against no content type ([@balloob] - [#7432]) ([media_player docs])
|
||||
- wsock.send_json is a coroutine ([@balloob] - [#7433])
|
||||
- ps - fix websocket yielding pt2 ([@balloob] - [#7434])
|
||||
- Upgrade temperusb to 1.5.3 ([@fabaff] - [#7428])
|
||||
- update for pypi ([@nkgilley] - [#7430])
|
||||
- Add new sensor: Enviro pHAT ([@imrehg] - [#7427]) ([sensor.envirophat docs]) (new-platform)
|
||||
- Added osramlightify groups. ([@deisi] - [#7376]) ([light.osramlightify docs])
|
||||
- Add support for face recognition with dlib ([@pvizeli] - [#7421]) ([image_processing.dlib_face_detect docs]) ([image_processing.dlib_face_identify docs]) ([image_processing.microsoft_face_detect docs]) (new-platform)
|
||||
- Replace pymailgun with pymailgunner ([@pschmitt] - [#7436]) ([notify.mailgun docs])
|
||||
- Suppress logs when octorpint goes offline ([@w1ll1am23] - [#7441]) ([octoprint docs])
|
||||
- Update join ([@nkgilley] - [#7443]) ([joaoapps_join docs]) ([notify.joaoapps_join docs]) (breaking change)
|
||||
- Bump pyvera version - handle malformed json replies in poll thread. ([@pavoni] - [#7440]) ([vera docs])
|
||||
- Fix for broken virtual keys ([@danielperna84] - [#7439]) ([homematic docs])
|
||||
- Get new token to keep pubnub updates working ([@w1ll1am23] - [#7437]) ([wink docs])
|
||||
- Add hass to rfxtrx object ([@danielhiversen] - [#6844])
|
||||
- sensor.envirophat: add missing requirement ([@imrehg] - [#7451]) ([sensor.envirophat docs])
|
||||
|
||||
[#6263]: https://github.com/home-assistant/home-assistant/pull/6263
|
||||
[#6562]: https://github.com/home-assistant/home-assistant/pull/6562
|
||||
[#6774]: https://github.com/home-assistant/home-assistant/pull/6774
|
||||
[#6844]: https://github.com/home-assistant/home-assistant/pull/6844
|
||||
[#6982]: https://github.com/home-assistant/home-assistant/pull/6982
|
||||
[#7032]: https://github.com/home-assistant/home-assistant/pull/7032
|
||||
[#7107]: https://github.com/home-assistant/home-assistant/pull/7107
|
||||
[#7122]: https://github.com/home-assistant/home-assistant/pull/7122
|
||||
[#7131]: https://github.com/home-assistant/home-assistant/pull/7131
|
||||
[#7145]: https://github.com/home-assistant/home-assistant/pull/7145
|
||||
[#7160]: https://github.com/home-assistant/home-assistant/pull/7160
|
||||
[#7162]: https://github.com/home-assistant/home-assistant/pull/7162
|
||||
[#7182]: https://github.com/home-assistant/home-assistant/pull/7182
|
||||
[#7191]: https://github.com/home-assistant/home-assistant/pull/7191
|
||||
[#7199]: https://github.com/home-assistant/home-assistant/pull/7199
|
||||
[#7200]: https://github.com/home-assistant/home-assistant/pull/7200
|
||||
[#7201]: https://github.com/home-assistant/home-assistant/pull/7201
|
||||
[#7202]: https://github.com/home-assistant/home-assistant/pull/7202
|
||||
[#7204]: https://github.com/home-assistant/home-assistant/pull/7204
|
||||
[#7206]: https://github.com/home-assistant/home-assistant/pull/7206
|
||||
[#7208]: https://github.com/home-assistant/home-assistant/pull/7208
|
||||
[#7211]: https://github.com/home-assistant/home-assistant/pull/7211
|
||||
[#7212]: https://github.com/home-assistant/home-assistant/pull/7212
|
||||
[#7213]: https://github.com/home-assistant/home-assistant/pull/7213
|
||||
[#7214]: https://github.com/home-assistant/home-assistant/pull/7214
|
||||
[#7215]: https://github.com/home-assistant/home-assistant/pull/7215
|
||||
[#7216]: https://github.com/home-assistant/home-assistant/pull/7216
|
||||
[#7217]: https://github.com/home-assistant/home-assistant/pull/7217
|
||||
[#7220]: https://github.com/home-assistant/home-assistant/pull/7220
|
||||
[#7221]: https://github.com/home-assistant/home-assistant/pull/7221
|
||||
[#7226]: https://github.com/home-assistant/home-assistant/pull/7226
|
||||
[#7227]: https://github.com/home-assistant/home-assistant/pull/7227
|
||||
[#7231]: https://github.com/home-assistant/home-assistant/pull/7231
|
||||
[#7233]: https://github.com/home-assistant/home-assistant/pull/7233
|
||||
[#7234]: https://github.com/home-assistant/home-assistant/pull/7234
|
||||
[#7235]: https://github.com/home-assistant/home-assistant/pull/7235
|
||||
[#7236]: https://github.com/home-assistant/home-assistant/pull/7236
|
||||
[#7243]: https://github.com/home-assistant/home-assistant/pull/7243
|
||||
[#7245]: https://github.com/home-assistant/home-assistant/pull/7245
|
||||
[#7248]: https://github.com/home-assistant/home-assistant/pull/7248
|
||||
[#7249]: https://github.com/home-assistant/home-assistant/pull/7249
|
||||
[#7250]: https://github.com/home-assistant/home-assistant/pull/7250
|
||||
[#7251]: https://github.com/home-assistant/home-assistant/pull/7251
|
||||
[#7253]: https://github.com/home-assistant/home-assistant/pull/7253
|
||||
[#7254]: https://github.com/home-assistant/home-assistant/pull/7254
|
||||
[#7256]: https://github.com/home-assistant/home-assistant/pull/7256
|
||||
[#7261]: https://github.com/home-assistant/home-assistant/pull/7261
|
||||
[#7263]: https://github.com/home-assistant/home-assistant/pull/7263
|
||||
[#7264]: https://github.com/home-assistant/home-assistant/pull/7264
|
||||
[#7266]: https://github.com/home-assistant/home-assistant/pull/7266
|
||||
[#7267]: https://github.com/home-assistant/home-assistant/pull/7267
|
||||
[#7269]: https://github.com/home-assistant/home-assistant/pull/7269
|
||||
[#7271]: https://github.com/home-assistant/home-assistant/pull/7271
|
||||
[#7272]: https://github.com/home-assistant/home-assistant/pull/7272
|
||||
[#7273]: https://github.com/home-assistant/home-assistant/pull/7273
|
||||
[#7275]: https://github.com/home-assistant/home-assistant/pull/7275
|
||||
[#7278]: https://github.com/home-assistant/home-assistant/pull/7278
|
||||
[#7279]: https://github.com/home-assistant/home-assistant/pull/7279
|
||||
[#7281]: https://github.com/home-assistant/home-assistant/pull/7281
|
||||
[#7282]: https://github.com/home-assistant/home-assistant/pull/7282
|
||||
[#7287]: https://github.com/home-assistant/home-assistant/pull/7287
|
||||
[#7290]: https://github.com/home-assistant/home-assistant/pull/7290
|
||||
[#7291]: https://github.com/home-assistant/home-assistant/pull/7291
|
||||
[#7300]: https://github.com/home-assistant/home-assistant/pull/7300
|
||||
[#7302]: https://github.com/home-assistant/home-assistant/pull/7302
|
||||
[#7303]: https://github.com/home-assistant/home-assistant/pull/7303
|
||||
[#7310]: https://github.com/home-assistant/home-assistant/pull/7310
|
||||
[#7311]: https://github.com/home-assistant/home-assistant/pull/7311
|
||||
[#7315]: https://github.com/home-assistant/home-assistant/pull/7315
|
||||
[#7316]: https://github.com/home-assistant/home-assistant/pull/7316
|
||||
[#7319]: https://github.com/home-assistant/home-assistant/pull/7319
|
||||
[#7320]: https://github.com/home-assistant/home-assistant/pull/7320
|
||||
[#7323]: https://github.com/home-assistant/home-assistant/pull/7323
|
||||
[#7324]: https://github.com/home-assistant/home-assistant/pull/7324
|
||||
[#7325]: https://github.com/home-assistant/home-assistant/pull/7325
|
||||
[#7329]: https://github.com/home-assistant/home-assistant/pull/7329
|
||||
[#7336]: https://github.com/home-assistant/home-assistant/pull/7336
|
||||
[#7337]: https://github.com/home-assistant/home-assistant/pull/7337
|
||||
[#7338]: https://github.com/home-assistant/home-assistant/pull/7338
|
||||
[#7339]: https://github.com/home-assistant/home-assistant/pull/7339
|
||||
[#7340]: https://github.com/home-assistant/home-assistant/pull/7340
|
||||
[#7341]: https://github.com/home-assistant/home-assistant/pull/7341
|
||||
[#7343]: https://github.com/home-assistant/home-assistant/pull/7343
|
||||
[#7349]: https://github.com/home-assistant/home-assistant/pull/7349
|
||||
[#7350]: https://github.com/home-assistant/home-assistant/pull/7350
|
||||
[#7352]: https://github.com/home-assistant/home-assistant/pull/7352
|
||||
[#7354]: https://github.com/home-assistant/home-assistant/pull/7354
|
||||
[#7355]: https://github.com/home-assistant/home-assistant/pull/7355
|
||||
[#7356]: https://github.com/home-assistant/home-assistant/pull/7356
|
||||
[#7359]: https://github.com/home-assistant/home-assistant/pull/7359
|
||||
[#7361]: https://github.com/home-assistant/home-assistant/pull/7361
|
||||
[#7363]: https://github.com/home-assistant/home-assistant/pull/7363
|
||||
[#7364]: https://github.com/home-assistant/home-assistant/pull/7364
|
||||
[#7365]: https://github.com/home-assistant/home-assistant/pull/7365
|
||||
[#7366]: https://github.com/home-assistant/home-assistant/pull/7366
|
||||
[#7370]: https://github.com/home-assistant/home-assistant/pull/7370
|
||||
[#7371]: https://github.com/home-assistant/home-assistant/pull/7371
|
||||
[#7374]: https://github.com/home-assistant/home-assistant/pull/7374
|
||||
[#7375]: https://github.com/home-assistant/home-assistant/pull/7375
|
||||
[#7376]: https://github.com/home-assistant/home-assistant/pull/7376
|
||||
[#7377]: https://github.com/home-assistant/home-assistant/pull/7377
|
||||
[#7379]: https://github.com/home-assistant/home-assistant/pull/7379
|
||||
[#7383]: https://github.com/home-assistant/home-assistant/pull/7383
|
||||
[#7386]: https://github.com/home-assistant/home-assistant/pull/7386
|
||||
[#7387]: https://github.com/home-assistant/home-assistant/pull/7387
|
||||
[#7388]: https://github.com/home-assistant/home-assistant/pull/7388
|
||||
[#7389]: https://github.com/home-assistant/home-assistant/pull/7389
|
||||
[#7390]: https://github.com/home-assistant/home-assistant/pull/7390
|
||||
[#7391]: https://github.com/home-assistant/home-assistant/pull/7391
|
||||
[#7399]: https://github.com/home-assistant/home-assistant/pull/7399
|
||||
[#7404]: https://github.com/home-assistant/home-assistant/pull/7404
|
||||
[#7405]: https://github.com/home-assistant/home-assistant/pull/7405
|
||||
[#7407]: https://github.com/home-assistant/home-assistant/pull/7407
|
||||
[#7408]: https://github.com/home-assistant/home-assistant/pull/7408
|
||||
[#7409]: https://github.com/home-assistant/home-assistant/pull/7409
|
||||
[#7410]: https://github.com/home-assistant/home-assistant/pull/7410
|
||||
[#7411]: https://github.com/home-assistant/home-assistant/pull/7411
|
||||
[#7418]: https://github.com/home-assistant/home-assistant/pull/7418
|
||||
[#7419]: https://github.com/home-assistant/home-assistant/pull/7419
|
||||
[#7420]: https://github.com/home-assistant/home-assistant/pull/7420
|
||||
[#7421]: https://github.com/home-assistant/home-assistant/pull/7421
|
||||
[#7426]: https://github.com/home-assistant/home-assistant/pull/7426
|
||||
[#7427]: https://github.com/home-assistant/home-assistant/pull/7427
|
||||
[#7428]: https://github.com/home-assistant/home-assistant/pull/7428
|
||||
[#7430]: https://github.com/home-assistant/home-assistant/pull/7430
|
||||
[#7432]: https://github.com/home-assistant/home-assistant/pull/7432
|
||||
[#7433]: https://github.com/home-assistant/home-assistant/pull/7433
|
||||
[#7434]: https://github.com/home-assistant/home-assistant/pull/7434
|
||||
[#7436]: https://github.com/home-assistant/home-assistant/pull/7436
|
||||
[#7437]: https://github.com/home-assistant/home-assistant/pull/7437
|
||||
[#7439]: https://github.com/home-assistant/home-assistant/pull/7439
|
||||
[#7440]: https://github.com/home-assistant/home-assistant/pull/7440
|
||||
[#7441]: https://github.com/home-assistant/home-assistant/pull/7441
|
||||
[#7443]: https://github.com/home-assistant/home-assistant/pull/7443
|
||||
[#7451]: https://github.com/home-assistant/home-assistant/pull/7451
|
||||
[@Cadair]: https://github.com/Cadair
|
||||
[@ChristianKuehnel]: https://github.com/ChristianKuehnel
|
||||
[@JasonCarter80]: https://github.com/JasonCarter80
|
||||
[@JshWright]: https://github.com/JshWright
|
||||
[@KlaasH]: https://github.com/KlaasH
|
||||
[@LvivEchoes]: https://github.com/LvivEchoes
|
||||
[@MartinHjelmare]: https://github.com/MartinHjelmare
|
||||
[@Teagan42]: https://github.com/Teagan42
|
||||
[@abmantis]: https://github.com/abmantis
|
||||
[@alanfischer]: https://github.com/alanfischer
|
||||
[@amelchio]: https://github.com/amelchio
|
||||
[@amigian74]: https://github.com/amigian74
|
||||
[@andrey-git]: https://github.com/andrey-git
|
||||
[@armills]: https://github.com/armills
|
||||
[@arsaboo]: https://github.com/arsaboo
|
||||
[@bah2830]: https://github.com/bah2830
|
||||
[@balloob]: https://github.com/balloob
|
||||
[@biacz]: https://github.com/biacz
|
||||
[@craftyguy]: https://github.com/craftyguy
|
||||
[@cribbstechnologies]: https://github.com/cribbstechnologies
|
||||
[@cyberjunky]: https://github.com/cyberjunky
|
||||
[@cyberplant]: https://github.com/cyberplant
|
||||
[@danielhiversen]: https://github.com/danielhiversen
|
||||
[@danielperna84]: https://github.com/danielperna84
|
||||
[@darookee]: https://github.com/darookee
|
||||
[@deisi]: https://github.com/deisi
|
||||
[@drkp]: https://github.com/drkp
|
||||
[@fabaff]: https://github.com/fabaff
|
||||
[@fabfurnari]: https://github.com/fabfurnari
|
||||
[@hmn]: https://github.com/hmn
|
||||
[@imrehg]: https://github.com/imrehg
|
||||
[@janLo]: https://github.com/janLo
|
||||
[@jotunacorn]: https://github.com/jotunacorn
|
||||
[@keatontaylor]: https://github.com/keatontaylor
|
||||
[@mezz64]: https://github.com/mezz64
|
||||
[@micw]: https://github.com/micw
|
||||
[@mjg59]: https://github.com/mjg59
|
||||
[@nkgilley]: https://github.com/nkgilley
|
||||
[@onsmam]: https://github.com/onsmam
|
||||
[@patrickeasters]: https://github.com/patrickeasters
|
||||
[@pavoni]: https://github.com/pavoni
|
||||
[@postlund]: https://github.com/postlund
|
||||
[@pschmitt]: https://github.com/pschmitt
|
||||
[@pvizeli]: https://github.com/pvizeli
|
||||
[@rcloran]: https://github.com/rcloran
|
||||
[@robbiet480]: https://github.com/robbiet480
|
||||
[@scarface-4711]: https://github.com/scarface-4711
|
||||
[@sdague]: https://github.com/sdague
|
||||
[@swbradshaw]: https://github.com/swbradshaw
|
||||
[@tchellomello]: https://github.com/tchellomello
|
||||
[@titilambert]: https://github.com/titilambert
|
||||
[@turbokongen]: https://github.com/turbokongen
|
||||
[@w1ll1am23]: https://github.com/w1ll1am23
|
||||
[@wokar]: https://github.com/wokar
|
||||
[@wuub]: https://github.com/wuub
|
||||
[@zeltom]: https://github.com/zeltom
|
||||
[binary_sensor.alarmdecoder docs]: https://home-assistant.io/components/binary_sensor.alarmdecoder/
|
||||
[binary_sensor.eight_sleep docs]: https://home-assistant.io/components/binary_sensor.eight_sleep/
|
||||
[binary_sensor.maxcube docs]: https://home-assistant.io/components/binary_sensor.maxcube/
|
||||
[binary_sensor.octoprint docs]: https://home-assistant.io/components/binary_sensor.octoprint/
|
||||
[binary_sensor.pilight docs]: https://home-assistant.io/components/binary_sensor.pilight/
|
||||
[binary_sensor.ping docs]: https://home-assistant.io/components/binary_sensor.ping/
|
||||
[binary_sensor.workday docs]: https://home-assistant.io/components/binary_sensor.workday/
|
||||
[binary_sensor.zha docs]: https://home-assistant.io/components/binary_sensor.zha/
|
||||
[camera.netatmo docs]: https://home-assistant.io/components/camera.netatmo/
|
||||
[climate docs]: https://home-assistant.io/components/climate/
|
||||
[climate.ecobee docs]: https://home-assistant.io/components/climate.ecobee/
|
||||
[climate.maxcube docs]: https://home-assistant.io/components/climate.maxcube/
|
||||
[climate.zwave docs]: https://home-assistant.io/components/climate.zwave/
|
||||
[cover.garadget docs]: https://home-assistant.io/components/cover.garadget/
|
||||
[cover.opengarage docs]: https://home-assistant.io/components/cover.opengarage/
|
||||
[cover.zwave docs]: https://home-assistant.io/components/cover.zwave/
|
||||
[device_tracker.automatic docs]: https://home-assistant.io/components/device_tracker.automatic/
|
||||
[device_tracker.zha docs]: https://home-assistant.io/components/device_tracker.zha/
|
||||
[ecobee docs]: https://home-assistant.io/components/ecobee/
|
||||
[eight_sleep docs]: https://home-assistant.io/components/eight_sleep/
|
||||
[enocean docs]: https://home-assistant.io/components/enocean/
|
||||
[homematic docs]: https://home-assistant.io/components/homematic/
|
||||
[image_processing.dlib_face_detect docs]: https://home-assistant.io/components/image_processing.dlib_face_detect/
|
||||
[image_processing.dlib_face_identify docs]: https://home-assistant.io/components/image_processing.dlib_face_identify/
|
||||
[image_processing.microsoft_face_detect docs]: https://home-assistant.io/components/image_processing.microsoft_face_detect/
|
||||
[image_processing.opencv docs]: https://home-assistant.io/components/image_processing.opencv/
|
||||
[joaoapps_join docs]: https://home-assistant.io/components/joaoapps_join/
|
||||
[light docs]: https://home-assistant.io/components/light/
|
||||
[light.avion docs]: https://home-assistant.io/components/light.avion/
|
||||
[light.blinkt docs]: https://home-assistant.io/components/light.blinkt/
|
||||
[light.decora docs]: https://home-assistant.io/components/light.decora/
|
||||
[light.flux_led docs]: https://home-assistant.io/components/light.flux_led/
|
||||
[light.hue docs]: https://home-assistant.io/components/light.hue/
|
||||
[light.lifx docs]: https://home-assistant.io/components/light.lifx/
|
||||
[light.osramlightify docs]: https://home-assistant.io/components/light.osramlightify/
|
||||
[light.piglow docs]: https://home-assistant.io/components/light.piglow/
|
||||
[light.sensehat docs]: https://home-assistant.io/components/light.sensehat/
|
||||
[light.tradfri docs]: https://home-assistant.io/components/light.tradfri/
|
||||
[light.zha docs]: https://home-assistant.io/components/light.zha/
|
||||
[light.zwave docs]: https://home-assistant.io/components/light.zwave/
|
||||
[maxcube docs]: https://home-assistant.io/components/maxcube/
|
||||
[media_player docs]: https://home-assistant.io/components/media_player/
|
||||
[media_player.spotify docs]: https://home-assistant.io/components/media_player.spotify/
|
||||
[media_player.webostv docs]: https://home-assistant.io/components/media_player.webostv/
|
||||
[mqtt docs]: https://home-assistant.io/components/mqtt/
|
||||
[notify.html5 docs]: https://home-assistant.io/components/notify.html5/
|
||||
[notify.instapush docs]: https://home-assistant.io/components/notify.instapush/
|
||||
[notify.joaoapps_join docs]: https://home-assistant.io/components/notify.joaoapps_join/
|
||||
[notify.mailgun docs]: https://home-assistant.io/components/notify.mailgun/
|
||||
[notify.matrix docs]: https://home-assistant.io/components/notify.matrix/
|
||||
[notify.smtp docs]: https://home-assistant.io/components/notify.smtp/
|
||||
[notify.telegram docs]: https://home-assistant.io/components/notify.telegram/
|
||||
[notify.webostv docs]: https://home-assistant.io/components/notify.webostv/
|
||||
[nuimo_controller docs]: https://home-assistant.io/components/nuimo_controller/
|
||||
[octoprint docs]: https://home-assistant.io/components/octoprint/
|
||||
[opencv docs]: https://home-assistant.io/components/opencv/
|
||||
[plant docs]: https://home-assistant.io/components/plant/
|
||||
[recorder docs]: https://home-assistant.io/components/recorder/
|
||||
[rfxtrx docs]: https://home-assistant.io/components/rfxtrx/
|
||||
[rss_feed_template docs]: https://home-assistant.io/components/rss_feed_template/
|
||||
[sensor.cert_expiry docs]: https://home-assistant.io/components/sensor.cert_expiry/
|
||||
[sensor.dht docs]: https://home-assistant.io/components/sensor.dht/
|
||||
[sensor.eight_sleep docs]: https://home-assistant.io/components/sensor.eight_sleep/
|
||||
[sensor.envirophat docs]: https://home-assistant.io/components/sensor.envirophat/
|
||||
[sensor.ios docs]: https://home-assistant.io/components/sensor.ios/
|
||||
[sensor.lyft docs]: https://home-assistant.io/components/sensor.lyft/
|
||||
[sensor.pushbullet docs]: https://home-assistant.io/components/sensor.pushbullet/
|
||||
[sensor.speedtest docs]: https://home-assistant.io/components/sensor.speedtest/
|
||||
[sensor.thinkingcleaner docs]: https://home-assistant.io/components/sensor.thinkingcleaner/
|
||||
[sensor.vera docs]: https://home-assistant.io/components/sensor.vera/
|
||||
[sensor.zamg docs]: https://home-assistant.io/components/sensor.zamg/
|
||||
[sensor.zha docs]: https://home-assistant.io/components/sensor.zha/
|
||||
[switch.flux docs]: https://home-assistant.io/components/switch.flux/
|
||||
[switch.hook docs]: https://home-assistant.io/components/switch.hook/
|
||||
[switch.thinkingcleaner docs]: https://home-assistant.io/components/switch.thinkingcleaner/
|
||||
[switch.wemo docs]: https://home-assistant.io/components/switch.wemo/
|
||||
[switch.zha docs]: https://home-assistant.io/components/switch.zha/
|
||||
[telegram_bot docs]: https://home-assistant.io/components/telegram_bot/
|
||||
[telegram_bot.polling docs]: https://home-assistant.io/components/telegram_bot.polling/
|
||||
[telegram_bot.webhooks docs]: https://home-assistant.io/components/telegram_bot.webhooks/
|
||||
[updater docs]: https://home-assistant.io/components/updater/
|
||||
[vera docs]: https://home-assistant.io/components/vera/
|
||||
[wemo docs]: https://home-assistant.io/components/wemo/
|
||||
[wink docs]: https://home-assistant.io/components/wink/
|
||||
[zha docs]: https://home-assistant.io/components/zha/
|
||||
[forum]: https://community.home-assistant.io/
|
||||
[gitter]: https://gitter.im/home-assistant/home-assistant
|
||||
[issue]: https://github.com/home-assistant/home-assistant/issues
|
||||
@ -10,7 +10,7 @@ footer: true
|
||||
regenerate: true
|
||||
---
|
||||
|
||||
<p>Add-ons are extensions for your Home Assistant installation.</p>
|
||||
<p>Add-ons for Hass.io allows the user to extend the functionality around Home Assistant. This can be running an application that Home Assistant can integrate with (like an MQTT broker) or to share the configuration via Samba for easy editing from other computers. Add-ons can be configured via the Hass.io panel in Home Assistant.</p>
|
||||
|
||||
{% assign addons = site.addons | sort: 'title' %}
|
||||
|
||||
|
||||
111
source/hassio/addon_config.markdown
Normal file
111
source/hassio/addon_config.markdown
Normal file
@ -0,0 +1,111 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Add-On Configuration"
|
||||
description: "Steps on how-to create an add-on for Hass.io."
|
||||
date: 2017-04-30 13:28
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
---
|
||||
|
||||
Each add-on is stored in a folder. The file structure looks like this:
|
||||
|
||||
```
|
||||
addon_name/
|
||||
Dockerfile
|
||||
config.json
|
||||
run.sh
|
||||
```
|
||||
|
||||
## {% linkable_title Add-on script %}
|
||||
|
||||
As with every Docker container, you will need a script to run when the container is started. A user might run many add-ons, so it is encouraged to try to stick to Bash scripts if you're doing simple things.
|
||||
|
||||
When developing your script:
|
||||
|
||||
- `/data` is a volume for persistent storage.
|
||||
- `/data/options.json` contains the user configuration. You can use `jq` inside your shell script to parse this data.
|
||||
|
||||
```bash
|
||||
echo '{ "target": "beer" }' | jq -r ".target"
|
||||
```
|
||||
|
||||
## {% linkable_title Add-on Docker file %}
|
||||
|
||||
All add-ons are based on Alpine Linux 3.5. Hass.io will automatically substitute the right base image based on the machine architecture. The Dockerfile is also required to have a VERSION environment variable which we will substitute with the version of the add-on.
|
||||
|
||||
```
|
||||
FROM %%BASE_IMAGE%%
|
||||
|
||||
ENV VERSION %%VERSION%%
|
||||
ENV LANG C.UTF-8
|
||||
|
||||
# Install requirements for add-on
|
||||
RUN apk add --no-cache jq
|
||||
|
||||
# Copy data for add-on
|
||||
COPY run.sh /
|
||||
RUN chmod a+x /run.sh
|
||||
|
||||
CMD [ "/run.sh" ]
|
||||
```
|
||||
|
||||
## {% linkable_title Add-on config %}
|
||||
|
||||
The config for an add-on is stored in `config.json`.
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "xy",
|
||||
"version": "1.2",
|
||||
"slug": "folder",
|
||||
"description": "long descripton",
|
||||
"startup": "before|after|once",
|
||||
"boot": "auto|manual",
|
||||
"ports": {
|
||||
"123/tcp": 123
|
||||
},
|
||||
"map": ["config", "ssl", "addons", "backup"],
|
||||
"options": {},
|
||||
"schema": {},
|
||||
"image": "repo/{arch}-my-custom-addon"
|
||||
}
|
||||
```
|
||||
|
||||
### {% linkable_title Options / Schema %}
|
||||
|
||||
The `options` dict contains all available options and their default value. Set the default value to `null` if the value is required to be given by the user before the add-on can start. Only non-nested arrays are supported.
|
||||
|
||||
```json
|
||||
{
|
||||
"message": "custom things",
|
||||
"logins": [
|
||||
{ "username": "beer", "password": "123456" },
|
||||
{ "username": "cheep", "password": "654321" }
|
||||
],
|
||||
"random": ["haha", "hihi", "huhu", "hghg"],
|
||||
"link": "http://blebla.com/"
|
||||
}
|
||||
```
|
||||
|
||||
The `schema` looks like `options` but describes how we should validate the user input. For example:
|
||||
|
||||
```json
|
||||
{
|
||||
"message": "str",
|
||||
"logins": [
|
||||
{ "username": "str", "password": "str" }
|
||||
],
|
||||
"random": ["str"],
|
||||
"link": "url"
|
||||
}
|
||||
```
|
||||
|
||||
We support:
|
||||
- str
|
||||
- bool
|
||||
- int
|
||||
- float
|
||||
- email
|
||||
- url
|
||||
14
source/hassio/addon_development.markdown
Normal file
14
source/hassio/addon_development.markdown
Normal file
@ -0,0 +1,14 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Developing an add-on"
|
||||
description: "Steps on how-to create an add-on for Hass.io."
|
||||
date: 2017-04-30 13:28
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
---
|
||||
|
||||
Add-ons for Hass.io allows the user to extend the functionality around Home Assistant. This can be running an application that Home Assistant can integrate with (like an MQTT broker) or to share the configuration via Samba for easy editing from other computers. Add-ons can be configured via the Hass.io panel in Home Assistant.
|
||||
|
||||
Under the hood, add-ons are Docker images published in Docker hub. Developers can create GitHub repositories that contain multiple references to add-ons for easy sharing with the community.
|
||||
51
source/hassio/addon_publishing.markdown
Normal file
51
source/hassio/addon_publishing.markdown
Normal file
@ -0,0 +1,51 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Publishing your add-on"
|
||||
description: "Steps on how-to create an add-on for Hass.io."
|
||||
date: 2017-04-30 13:28
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
---
|
||||
|
||||
At the end, all add-ons are simple docker container. You can use our [build scripts][builder] for automate the hole process our you can build your own docker image and push it manual do a docker hub. Inside your addon `config.json` can you use:
|
||||
```json
|
||||
{
|
||||
"image": "myhub/image-addon-name"
|
||||
}
|
||||
{
|
||||
"image": "myhub/image-{arch}-addon-name"
|
||||
}
|
||||
```
|
||||
|
||||
To specify from where it will load the addon by user installation. With `{arch}` inside image name, you can build your addon for multible architectures.
|
||||
|
||||
Best praxis is to merge change into a branch like `build`. After you push the addon to docker hub, you can merge this branch to master.
|
||||
|
||||
## {% linkable_title Custom Add-ons %}
|
||||
|
||||
You need a docker hub account. It is also possible to use our own docker registrator. Download our [build script][builder] local.
|
||||
|
||||
For a git repository:
|
||||
```bash
|
||||
# Test only:
|
||||
./create_hassio_addon.sh -a amd64 -s addon-slug -r https://github.com/xy/addons -b branchname
|
||||
|
||||
# push do docker hub:
|
||||
./create_hassio_addon.sh -a amd64 -s addon-slug -r https://github.com/xy/addons -b branchname -p
|
||||
|
||||
# create for all supported arch:
|
||||
./create_addon_all.sh -s addon-slug -r https://github.com/xy/addons -b branchname -p
|
||||
```
|
||||
|
||||
For a local repository:
|
||||
```bash
|
||||
# Test only:
|
||||
./create_hassio_addon.sh -a amd64 -s addon-slug -l /home/xy/my_local_repo
|
||||
|
||||
# push do docker hub:
|
||||
./create_hassio_addon.sh -a amd64 -s addon-slug -l /home/xy/my_local_repo -p
|
||||
```
|
||||
|
||||
[builder]: https://github.com/home-assistant/hassio-build/tree/master/build-scripts/addons
|
||||
36
source/hassio/addon_repository.markdown
Normal file
36
source/hassio/addon_repository.markdown
Normal file
@ -0,0 +1,36 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Create an add-on repository"
|
||||
description: "Add-ons repositories."
|
||||
date: 2017-04-30 13:28
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
---
|
||||
|
||||
Add-ons repository can contain one or more add-ons. Each add-on is stored in it's own unique folder. For it to be indentified as a repository, a repository contains a configuration file.
|
||||
|
||||
[Example add-on repository](https://github.com/home-assistant/hassio-addons-example).
|
||||
|
||||
## Installing a repository
|
||||
|
||||
A user can add a repository by going to the Hass.io panel in Home Assistant, clicking on the store icon in the top right, copy/paste the url of your repostory into the repository textarea and click on "Save".
|
||||
|
||||
## Repository configuration
|
||||
|
||||
Each repository is required to contain `repository.json` at the root of the Git repository.
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "Name of repository",
|
||||
"url": "http://www.example/addons",
|
||||
"maintainer": "HomeAssistant Team <info@home-assistant.io>"
|
||||
}
|
||||
```
|
||||
|
||||
| Key | Description |
|
||||
| --- | ----------- |
|
||||
| name | Name of the repository
|
||||
| url | Homepage of the repository. Here you can explain the various add-ons.
|
||||
| maintainer | Contact info of the maintainer.
|
||||
14
source/hassio/addon_testing.markdown
Normal file
14
source/hassio/addon_testing.markdown
Normal file
@ -0,0 +1,14 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Local add-on testing"
|
||||
description: "Instructions how to test your add-on locally."
|
||||
date: 2017-04-30 13:28
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
---
|
||||
|
||||
## {% linkable_title Logs %}
|
||||
|
||||
All stdout and stderr is redirected to the Docker logs. The logs can be fetched from the add-on page inside the Hass.io panel in Home Assistant.
|
||||
@ -1,94 +0,0 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Create an add-on for Hass.io"
|
||||
description: "Steps on how-to create an add-on for Hass.io."
|
||||
date: 2017-04-30 13:28
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
---
|
||||
|
||||
Add-ons are docker container they run a script and do some things. User are able to set a add-on specific options.
|
||||
|
||||
### {% linkable_title Add-on folder %}
|
||||
|
||||
```
|
||||
addon_name:
|
||||
Dockerfile
|
||||
config.json
|
||||
run.sh
|
||||
```
|
||||
|
||||
All add-ons are based on Alpine Linux 3.5. You can use `FROM %%BASE_IMAGE%%` inside your docker file to build the right arch or for automatic build with our scripts.
|
||||
|
||||
Your Docker need also a env variable `VERSION` with the version of the add-on. With our build system include this line:
|
||||
```
|
||||
ENV VERSION %%VERSION%%
|
||||
```
|
||||
|
||||
As a user might run many add-ons, it is encouraged to try to stick to Bash scripts if you're doing simple things.
|
||||
|
||||
### {% linkable_title Add-on config %}
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "xy",
|
||||
"version": "1.2",
|
||||
"slug": "folder",
|
||||
"description": "long descripton",
|
||||
"startup": "before|after|once",
|
||||
"boot": "auto|manual",
|
||||
"ports": {
|
||||
"123/tcp": 123
|
||||
},
|
||||
"map": ["config", "ssl", "addons", "backup"],
|
||||
"options": {},
|
||||
"schema": {},
|
||||
"image": "repo/{arch}-my-custom-addon"
|
||||
}
|
||||
```
|
||||
|
||||
### {% linkable_title Options / Schema %}
|
||||
|
||||
The `options` dict have all available options with default value. If you want to set a value to requered and need to be set from user before it start the addon, set it to null. We support arrays for single deeps.
|
||||
|
||||
```json
|
||||
{
|
||||
"message": "custom things",
|
||||
"logins": [
|
||||
{ "username": "beer", "password": "123456" },
|
||||
{ "username": "cheep", "password": "654321" }
|
||||
],
|
||||
"random": ["haha", "hihi", "huhu", "hghg"],
|
||||
"link": "http://blebla.com/"
|
||||
}
|
||||
```
|
||||
|
||||
The `schmema` look like the `options` but describe how we should validate the user input. For example above:
|
||||
|
||||
```json
|
||||
{
|
||||
"message": "str",
|
||||
"logins": [
|
||||
{ "username": "str", "password": "str" }
|
||||
],
|
||||
"random": ["str"],
|
||||
"link": "url"
|
||||
}
|
||||
```
|
||||
|
||||
We support:
|
||||
- str
|
||||
- bool
|
||||
- int
|
||||
- float
|
||||
- email
|
||||
- url
|
||||
|
||||
### {% linkable_title SSL %}
|
||||
|
||||
Default you can use `fullchain.pem` and `privkey.pem` from `/ssl` for you stuff. Your SSL addon should also create default this files.
|
||||
|
||||
### {% linkable_title Need to know %}
|
||||
`/data` is a volume with a persistant store. `/data/options.json` have the user config inside. You can use `jq` inside shell script to parse this data.
|
||||
@ -1,24 +0,0 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Create an add-on repository for Hass.io"
|
||||
description: "Add-ons repositories."
|
||||
date: 2017-04-30 13:28
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
---
|
||||
|
||||
Look to our example [repository](https://github.com/home-assistant/hassio-addons-example).
|
||||
|
||||
Add-ons repository can have multible add-ons with diferents folders or it can be a single add-on. It is importent that you add the json file to root.
|
||||
|
||||
Add a `repository.json` to the root of your git repository with:
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "Needed, Name of repository",
|
||||
"url": "http://www.example/addons",
|
||||
"maintainer": "HomeAssistant Team <info@home-assistant.io>"
|
||||
}
|
||||
```
|
||||
@ -1,18 +0,0 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Hass.io development"
|
||||
description: "How to get started with Hass.io development."
|
||||
date: 2017-04-30 13:28
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
---
|
||||
|
||||
Seen all the Hass.io stuff and want to built on top of it? That's awesome.
|
||||
|
||||
Before you get started with development, get familiar with [the architecture][arch].
|
||||
|
||||
[Placeholder]
|
||||
|
||||
[arch]: /hassio/architecture/
|
||||
BIN
source/images/blog/2017-05-0.44/components.png
Normal file
BIN
source/images/blog/2017-05-0.44/components.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 33 KiB |
BIN
source/images/blog/2017-05-podcast-init/podcast_init.png
Normal file
BIN
source/images/blog/2017-05-podcast-init/podcast_init.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 62 KiB |
BIN
source/images/supported_brands/opencv.png
Normal file
BIN
source/images/supported_brands/opencv.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 2.3 KiB |
Loading…
x
Reference in New Issue
Block a user