mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-24 17:57:14 +00:00
Update Hass.io docs
This commit is contained in:
Paulus Schoutsen
parent
419540348d
commit
ca80944d74
@ -1,7 +1,7 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Bluetooth BCM43xx"
|
||||
description: "Activate bluetooth for bcm43xx"
|
||||
description: "Activate the BCM43xx Bluetooth chipset on a Raspberry Pi 3."
|
||||
date: 2017-04-30 13:28
|
||||
sidebar: true
|
||||
comments: false
|
||||
@ -9,4 +9,6 @@ sharing: true
|
||||
footer: true
|
||||
---
|
||||
|
||||
Start Bluetooth for BCM43xx chipset on startup. Like Raspberry Pi3
|
||||
Start this add-on to activate the BCM43xx Bluetooth chipset.
|
||||
|
||||
Supported platforms: Raspberry Pi 3.
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Check Home Assistant configuration"
|
||||
description: "Check Home Assistant configuration against a new version"
|
||||
description: "Check your current Home Assistant configuration against a new version"
|
||||
date: 2017-04-30 13:28
|
||||
sidebar: true
|
||||
comments: false
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
---
|
||||
layout: page
|
||||
title: "DHCP server"
|
||||
description: "A simple dhcp server"
|
||||
description: "A simple DHCP server."
|
||||
date: 2017-04-30 13:28
|
||||
sidebar: true
|
||||
comments: false
|
||||
@ -9,7 +9,7 @@ sharing: true
|
||||
footer: true
|
||||
---
|
||||
|
||||
Create a simple DHCP server for your network and allow set fix ip for some devices.
|
||||
Create a simple DHCP server for your network and allow setting fixed IPs for devices.
|
||||
|
||||
```json
|
||||
{
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Dnsmasq"
|
||||
description: "A simple dns server with benefits."
|
||||
description: "A simple DNS server."
|
||||
date: 2017-04-30 13:28
|
||||
sidebar: true
|
||||
comments: false
|
||||
@ -9,7 +9,7 @@ sharing: true
|
||||
footer: true
|
||||
---
|
||||
|
||||
Setup and manage a [Dnsmasq](http://thekelleys.org.uk/dnsmasq/doc.html) dns server. This allow your to manipulate some dns requests. I.e. that inside your network, your homeassistant domain will resolve with a internal address.
|
||||
Setup and manage a [Dnsmasq](http://thekelleys.org.uk/dnsmasq/doc.html) DNS server. This allows you to manipulate DNS requests. For example, you can have your Home Assistant domain resolve with an internal address inside your network.
|
||||
|
||||
<p class='note info'>
|
||||
`interface` options are for resinos based installation. On other system you can set it to `""`, for listen on every interface.
|
||||
|
||||
@ -22,9 +22,19 @@ Set up a [mosquitto](https://mosquitto.org/) MQTT broker.
|
||||
}
|
||||
```
|
||||
|
||||
<p class='note'>Make sure you use logins and disable anonymous access if you want to secure the system.</p>
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **plain** (*Optional*): Listen to broker on port 1883 without SSL/TLS. Defaults to `true`.
|
||||
- **ssl** (*Optional*): Listen to broker on port 8883 with SSL/TLS. This requires certificates. Defaults to `false`.
|
||||
- **anonymous** (*Optional*): Allow anonymous connection. If *logins* is set, anonymous user can only read data. Defaults to `true`.
|
||||
- **logins** (*Optional*): A list of user that will be created with *username* and *password*.
|
||||
|
||||
### {% linkable_title Home Assistant configuration %}
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
mqtt:
|
||||
broker: 172.17.0.1
|
||||
```
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Nginx SSL proxy"
|
||||
description: "Nginx HomeAssistant SSL proxy"
|
||||
description: "Nginx Home Assistant SSL proxy"
|
||||
date: 2017-04-30 13:28
|
||||
sidebar: true
|
||||
comments: false
|
||||
|
||||
74
source/_addons/snips.markdown
Normal file
74
source/_addons/snips.markdown
Normal file
@ -0,0 +1,74 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Snips.ai"
|
||||
description: "Enhance your Hass.io installation with a local voice assistant."
|
||||
date: 2017-04-30 13:28
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
---
|
||||
|
||||
[Snips.ai] is an AI-powered voice assistant that runs on the Raspberry Pi 3 and x86 platforms. It runs on-device and is Private by Design.
|
||||
|
||||
To get started, follow [their tutorial] to create an assistant and download the training data.
|
||||
|
||||
Now install and activate the [Samba] add-on so you can upload your training data. Connect to the "share" Samba share and copy your training data over. Name the file `assistant.zip`.
|
||||
|
||||
Now it's time to start Snips for the first time. When the Snips add-on starts, it will output your audio devices:
|
||||
|
||||
```plain
|
||||
**** List of PLAYBACK Hardware Devices ****
|
||||
card 0: ALSA [bcm2835 ALSA], device 0: bcm2835 ALSA [bcm2835 ALSA]
|
||||
Subdevices: 8/8
|
||||
Subdevice #0: subdevice #0
|
||||
Subdevice #1: subdevice #1
|
||||
Subdevice #2: subdevice #2
|
||||
Subdevice #3: subdevice #3
|
||||
Subdevice #4: subdevice #4
|
||||
Subdevice #5: subdevice #5
|
||||
Subdevice #6: subdevice #6
|
||||
Subdevice #7: subdevice #7
|
||||
card 0: ALSA [bcm2835 ALSA], device 1: bcm2835 ALSA [bcm2835 IEC958/HDMI]
|
||||
Subdevices: 1/1
|
||||
Subdevice #0: subdevice #0
|
||||
```
|
||||
|
||||
You need to use this information to configure the `mic` and `speaker` configuration options. The format is `<card #>,<device #>`. On a Raspberry Pi 3, `0,0` is the built-in headset port, `0,1` is the HDMI port.
|
||||
|
||||
Now that you've found the microphone and speaker addresses, it's time to configure Snips and restart the add-on.
|
||||
|
||||
### Add-On configuration
|
||||
|
||||
```json
|
||||
{
|
||||
"mic": "1,0",
|
||||
"speaker": "1,0",
|
||||
"assistant": "assistant.zip",
|
||||
"mqtt_bridge": {
|
||||
"active": true,
|
||||
"host": "172.17.0.1",
|
||||
"port": 1883,
|
||||
"user": "",
|
||||
"password": ""
|
||||
},
|
||||
}
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **mqtt_bridge** (*Optional*): Snips uses MQTT to communicate and defaults to their own broker. Use this config option to bridge their broker to your own.
|
||||
- **mic**: This is the hardware address of your microphone. Look at the Snips
|
||||
|
||||
### {% linkable_title Home Assistant configuration %}
|
||||
|
||||
Use the Home Assistant [Snips.ai component][comp] to integrate the add-on into Home Assistant.
|
||||
|
||||
```yaml
|
||||
snips:
|
||||
```
|
||||
|
||||
[Snips.ai]: https://snips.ai/
|
||||
[their tutorial]: https://github.com/snipsco/snips-platform-documentation/wiki/2.-Running-your-first-end-to-end-assistant
|
||||
[Samba]: /addons/samba/
|
||||
[comp]: /components/snips/
|
||||
@ -1,7 +1,7 @@
|
||||
---
|
||||
layout: page
|
||||
title: "SSH Server"
|
||||
description: "Allow logging in remotely to your server using SSH."
|
||||
description: "Allow logging in remotely to Hass.io using SSH."
|
||||
date: 2017-04-30 13:28
|
||||
sidebar: true
|
||||
comments: false
|
||||
@ -9,7 +9,11 @@ sharing: true
|
||||
footer: true
|
||||
---
|
||||
|
||||
Setting up an [SSH](https://openssh.org/) server allows access to your Hass.io folders with any SSH client. To use this add-on, you must have a private/public key to log in. To generate them, follow the [instructions for Windows][win] and [these for other platforms][other].
|
||||
Setting up an [SSH](https://openssh.org/) server allows access to your Hass.io folders with any SSH client.
|
||||
|
||||
<p class='note'>This add-on will not enable you to install packages or do anything as root. This is not allowed with Hass.io.</p>
|
||||
|
||||
To use this add-on, you must have a private/public key to log in. To generate them, follow the [instructions for Windows][win] and [these for other platforms][other].
|
||||
|
||||
```json
|
||||
{
|
||||
@ -26,21 +30,4 @@ Configuration variables:
|
||||
[win]: https://www.digitalocean.com/community/tutorials/how-to-create-ssh-keys-with-putty-to-connect-to-a-vps
|
||||
[other]: https://help.github.com/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent/
|
||||
|
||||
<p class='note'>
|
||||
This add-on is not compatible when you installed Hass.io via the generic Linux installer.
|
||||
|
||||
If you're coming from Rasbian or similar, use `root` rather than `pi` when connecting via ssh or else you will get this error.
|
||||
|
||||
```bash
|
||||
Permission denied (publickey,keyboard-interactive)
|
||||
```
|
||||
</p>
|
||||
|
||||
<p class='note'>
|
||||
If you install this addon you can use `sshfs` as well to access files from a remote system where you have git and your favourite editing tools installed.
|
||||
|
||||
```bash
|
||||
$ mkdir ~/ha_config
|
||||
$ sshfs -o allow_other,defer_permissions root@h[your_hassio_ip]:/config ~/ha_config
|
||||
```
|
||||
</p>
|
||||
<p class='note'>This add-on is not compatible when you installed Hass.io via the generic Linux installer.</p>
|
||||
|
||||
@ -12,7 +12,7 @@ redirect_from: /getting-started/automation-troubleshooting/
|
||||
|
||||
You can verify that your automation rules are being initialized correctly by watching both the realtime logs (`homeassistant.log` in the configuration directory) and also the [Logbook](/components/logbook/). The realtime logs will show the rules being initialized (once for each trigger), example:
|
||||
|
||||
```plain
|
||||
```text
|
||||
INFO [homeassistant.components.automation] Initialized rule Rainy Day
|
||||
INFO [homeassistant.components.automation] Initialized rule Rainy Day
|
||||
INFO [homeassistant.components.automation] Initialized rule Rainy Day
|
||||
|
||||
@ -34,7 +34,7 @@
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
{% active_link /developers/add_new_platform/ Support a new device (as a platform) %}
|
||||
{% active_link /developers/add_new_platform/ Creating a new platform (to support a new device) %}
|
||||
<ul>
|
||||
<li>{% active_link /developers/code_review_platform/ Checklist creating a platform %}</li>
|
||||
<li>{% active_link /developers/platform_example_sensor/ Example sensor platform %}</li>
|
||||
@ -72,13 +72,29 @@
|
||||
<li>{% active_link /developers/frontend_creating_custom_ui/ Add Custom UI %}</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
{% active_link /developers/hassio/architecture/ Hass.io architecture %}
|
||||
<ul>
|
||||
<li>{% active_link /developers/hassio/debugging/ Debugging Hass.io %}</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
{% active_link /developers/hassio/addon_development/ Hass.io Add-on Development %}
|
||||
<ul>
|
||||
<li>{% active_link /developers/hassio/addon_tutorial/ Tutorial: Making your first add-on %}</li>
|
||||
<li>{% active_link /developers/hassio/addon_config/ Configuration %}</li>
|
||||
<li>{% active_link /developers/hassio/addon_testing/ Local Testing %}</li>
|
||||
<li>{% active_link /developers/hassio/addon_publishing/ Publishing %}</li>
|
||||
<li>{% active_link /developers/hassio/addon_repository/ Repositories %}</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
{% active_link /developers/api/ API %}
|
||||
<ul>
|
||||
<li>{% active_link https://dev-docs.home-assistant.io/en/dev/ Home Assistant API %}</li>
|
||||
<li>{% active_link https://dev-docs.home-assistant.io/en/dev/ Python API %}</li>
|
||||
<li>{% active_link /developers/websocket_api/ Websocket API %}</li>
|
||||
<li>{% active_link /developers/rest_api/ RESTful API %}</li>
|
||||
<li>{% active_link /developers/python_api/ Python API %}</li>
|
||||
<li>{% active_link /developers/rest_api/ REST API %}</li>
|
||||
<li>{% active_link /developers/python_api/ Python REST API %}</li>
|
||||
<li>{% active_link /developers/server_sent_events/ Server-sent events %}</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
@ -8,24 +8,21 @@
|
||||
<li>{% active_link /hassio/installation/ Installation %}</li>
|
||||
<li>{% active_link /addons/ Available add-ons %}</li>
|
||||
<li>{% active_link /hassio/installing_third_party_addons/ Installing third-party add-ons %}</li>
|
||||
<li>{% active_link /hassio/external_storage/ External storage %}</li>
|
||||
<li>{% active_link /hassio/run_local/ Execute local things %}</li>
|
||||
<li>{% active_link /hassio/architecture/ Architecture %}</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class='divided sidebar-menu'>
|
||||
<li>
|
||||
{% active_link /hassio/addon_development/ Add-on Development %}
|
||||
Advanced
|
||||
<ul>
|
||||
<li>{% active_link /hassio/addon_tutorial/ Tutorial: Making your first add-on %}</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>
|
||||
<li>{% active_link /hassio/zwave/ Z-Wave %}</li>
|
||||
<li>{% active_link /hassio/external_storage/ External storage %}</li>
|
||||
<li>{% active_link /hassio/run_local/ Execute local things %}</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>{% active_link /hassio/debugging/ Debugging Hass.io %}</li>
|
||||
</ul>
|
||||
<ul class='divided sidebar-menu'>
|
||||
<li><a href='/developers/hassio/addon_development/'>Looking to create an add-on?</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
@ -16,6 +16,13 @@ regenerate: true
|
||||
|
||||
<ul>
|
||||
{% for addon in addons %}
|
||||
<li><a href='{{ addon.url }}'>{{ addon.title }}</a></li>
|
||||
<li>
|
||||
<a href='{{ addon.url }}'>{{ addon.title }}</a><br>
|
||||
{{ addon.description }}
|
||||
</li>
|
||||
{% endfor %}
|
||||
</ul>
|
||||
|
||||
<p>
|
||||
Check the Hass.io forums for <a href='https://community.home-assistant.io/tags/hassio-repository'>add-on repositories managed by the community</a>.
|
||||
</p>
|
||||
|
||||
@ -11,8 +11,8 @@ footer: true
|
||||
|
||||
Home Assistant provides various APIs. For detail please refer to [Home Assistant API](https://dev-docs.home-assistant.io/en/dev/) documentation.
|
||||
|
||||
* [Python API](https://dev-docs.home-assistant.io/)
|
||||
* [Websocket API](/developers/websocket_api/)
|
||||
* [RESTful API](/developers/rest_api/)
|
||||
* [Python API](/developers/python_api/)
|
||||
* [REST API](/developers/rest_api/)
|
||||
* [Python REST API](/developers/python_api/)
|
||||
* [Server-sent events](/developers/server_sent_events/)
|
||||
|
||||
|
||||
@ -32,22 +32,22 @@ These components provide small pieces of home automation logic or involve servic
|
||||
|
||||
For example, the [`device_sun_light_trigger` component](/components/device_sun_light_trigger/) tracks the state of devices and the sun to make sure that the lights are turned on when it gets dark and people are home. The component uses logic like this:
|
||||
|
||||
```plain
|
||||
In the event that device 'Paulus Nexus 5' changes to the 'Home' state:
|
||||
If the sun has set and the lights are not on:
|
||||
Turn on the lights
|
||||
```text
|
||||
In the event that device 'Paulus Nexus 5' changes to the 'Home' state:
|
||||
If the sun has set and the lights are not on:
|
||||
Turn on the lights
|
||||
```
|
||||
|
||||
```plain
|
||||
In the event that the combined state of all tracked devices changes to 'Not Home':
|
||||
If the lights are on:
|
||||
Turn off the lights
|
||||
```text
|
||||
In the event that the combined state of all tracked devices changes to 'Not Home':
|
||||
If the lights are on:
|
||||
Turn off the lights
|
||||
```
|
||||
|
||||
```plain
|
||||
In the event of the sun setting:
|
||||
If the lights are off and the combined state of all tracked device equals 'Home':
|
||||
Turn on the lights
|
||||
```text
|
||||
In the event of the sun setting:
|
||||
If the lights are off and the combined state of all tracked device equals 'Home':
|
||||
Turn on the lights
|
||||
```
|
||||
|
||||
Look [here](https://github.com/home-assistant/home-assistant/blob/master/config/custom_components/example.py) for a comprehensive example of a home automation component.
|
||||
|
||||
@ -7,6 +7,7 @@ sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
redirect_from: /hassio/addon_config/
|
||||
---
|
||||
|
||||
Each add-on is stored in a folder. The file structure looks like this:
|
||||
@ -7,8 +7,17 @@ sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
redirect_from: /hassio/addon_development/
|
||||
---
|
||||
|
||||
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](https://hub.docker.com/). Developers can create [GitHub](https://github.com) repositories that contain multiple references to add-ons for easy sharing with the community.
|
||||
|
||||
<ol>
|
||||
<li><a href='/developers/hassio/addon_tutorial/'>Tutorial: Making your first add-on</a></li>
|
||||
<li><a href='/developers/hassio/addon_config/'>Configuration</a></li>
|
||||
<li><a href='/developers/hassio/addon_testing/'>Local Testing</a></li>
|
||||
<li><a href='/developers/hassio/addon_publishing/'>Publishing</a></li>
|
||||
<li><a href='/developers/hassio/addon_repository/'>Repositories</a></li>
|
||||
</ol>
|
||||
@ -7,6 +7,7 @@ sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
redirect_from: /hassio/addon_publishing/
|
||||
---
|
||||
|
||||
There are two different ways of publishing add-ons. One is to publish pre-build containers to Docker Hub and the other option is to have users build the containers locally on their Hass.io instance.
|
||||
@ -7,6 +7,7 @@ sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
redirect_from: /hassio/addon_repository/
|
||||
---
|
||||
|
||||
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.
|
||||
@ -7,6 +7,7 @@ sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
redirect_from: /hassio/addon_testing/
|
||||
---
|
||||
|
||||
The fastest way to develop add-ons is by adding them to your local add-on repository. To access your local add-on repository, install either the [Samba add-on] or [SSH add-on].
|
||||
@ -7,6 +7,7 @@ sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
redirect_from: /hassio/addon_tutorial/
|
||||
---
|
||||
|
||||
So you've got Home Assistant going and you've been enjoying the built-in add-ons but you're missing this one application. Time to make your own add-on! In Hass.io 0.24 we introduced the option to have local add-ons be build on your device. This is great for developing new add-ons locally.
|
||||
@ -203,4 +204,4 @@ Refresh the add-on store and re-install your add-on. You will now see the option
|
||||
- [Learn more about the available schema options.](/hassio/addon_config/#options--schema)
|
||||
- [See how options.json can be used inside `run.sh`](https://github.com/home-assistant/hassio-addons/blob/master/mosquitto/run.sh#L4-L6)
|
||||
|
||||
### [Next step: Add-on config reference »](/hassio/addon_config/)
|
||||
### [Next step: Add-on config reference »](/developers/hassio/addon_config/)
|
||||
@ -7,6 +7,7 @@ sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
redirect_from: /hassio/architecture/
|
||||
---
|
||||
|
||||
<p class='img'>
|
||||
@ -7,8 +7,15 @@ sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
redirect_from: /hassio/debugging/
|
||||
---
|
||||
|
||||
<p class='note warning'>
|
||||
This section is not for users. Use the [SSH add-on] to SSH into Hass.io. This is for <b>developers</b> of Hass.io. Do not ask for support if you are using these options.
|
||||
</p>
|
||||
|
||||
[SSH add-on]: /addons/ssh/
|
||||
|
||||
The following debug tips and tricks are for people who are running the Hass.io image and are working on the base image. If you use the generic Linux installer script, you should be able to access your host and logs as per your host.
|
||||
|
||||
## {% linkable_title SSH access to the host %}
|
||||
@ -9,4 +9,33 @@ sharing: true
|
||||
footer: true
|
||||
---
|
||||
|
||||
Hass.io turns your Raspberry Pi (or other device) into the ultimate Home Automation hub. It takes away all the hassle of installing Home Assistant and related applications and keeping them up to date. Updates to the operating system, Home Assistant, and any add-ons can be done via the Home Assistant UI with a single click.
|
||||
Hass.io turns your Raspberry Pi (or other device) into the ultimate home automation hub powered by Home Assistant. With Hass.io you can focus on integrating your devices and writing automations.
|
||||
|
||||
[Go to the installation instructions »][install]
|
||||
|
||||
The advantages of using Hass.io:
|
||||
|
||||
- Free and open source
|
||||
- Optimized for the Raspberry Pi
|
||||
- 100% local home automation
|
||||
- Easy installation and updates (powered by [ResinOS] and [Docker])
|
||||
- Management user interface integrated into Home Assistant
|
||||
- Easily create and restore full backups of your whole configuration.
|
||||
- One click install of many popular add-ons including voice assistant via [Snips.ai], encryption via [Let's Encrypt] and dynamic DNS via [Duck DNS].<br><br>[Browse available add-ons »][all]
|
||||
- Active community that is helpful and sharing add-ons including AppDaemon, Homebridge and InfluxDB.<br><br>[Browse the forums »][forums]<br>[Join the Hass.io chat »][chat]<br>[Browse community add-on repositories »][comm-add-ons]
|
||||
|
||||
<p class='img'>
|
||||
<img src='/images/hassio/screenshots/dashboard.png'>
|
||||
Hass.io dashboard
|
||||
</p>
|
||||
|
||||
[Snips.ai]: /addons/snips/
|
||||
[Let's Encrypt]: /addons/lets_encrypt/
|
||||
[Duck DNS]: /addons/duckdns/
|
||||
[forums]: https://community.home-assistant.io/c/hass-io
|
||||
[comm-add-ons]: https://community.home-assistant.io/tags/hassio-repository
|
||||
[all]: /addons/
|
||||
[chat]: https://discord.gg/K3UVxJd
|
||||
[ResinOS]: https://resinos.io/
|
||||
[Docker]: https://www.docker.com/
|
||||
[install]: /hassio/installation/
|
||||
|
||||
@ -9,26 +9,29 @@ sharing: true
|
||||
footer: true
|
||||
---
|
||||
|
||||
Hass.io images are available for all available Raspberry Pi and intel nuc platforms.
|
||||
Hass.io images are available for all available Raspberry Pi and Intel NUC platforms.
|
||||
|
||||
- Download the appropriate image for your Raspberry Pi / intel nuc:
|
||||
- [Raspberry Pi / Zero][pi1]
|
||||
- [Raspberry Pi 2][pi2]
|
||||
- [Raspberry Pi 3][pi3]
|
||||
- [Intel Nuc][nuc]
|
||||
- [Intel NUC][nuc]
|
||||
- Flash the downloaded image to an SD card using [Etcher].
|
||||
- Optional - Setup the WiFi or static ip: On the SD-card, edit the `system-connections/resin-sample` file and follow the [ResinOS howto][resinos-network].
|
||||
- Insert SD card to Raspberry Pi and turn it on. On first boot, it downloads the latest version of Home Assistant which takes ~20 minutes (slower/faster depending on the platform).
|
||||
- You will be able to reach your installation at [http://hassio.local:8123][local].
|
||||
- Enable either the [Samba add-on][samba] or the [SSH add-on][ssh] to manage your configuration.
|
||||
|
||||
<p class='note'>
|
||||
If you copy over your existing Home Assistant configuration, make sure to enable the Hass.io panel by adding either `discovery:` or `hassio:` to your configuration.
|
||||
</p>
|
||||
|
||||
### {% linkable_title Alternative: install on generic Linux server %}
|
||||
## {% linkable_title Alternative: install on generic Linux server %}
|
||||
|
||||
For advanced users, it is also possible to try Hass.io on your Linux server or inside a VM. To do so, [follow these instructions][linux].
|
||||
|
||||
<p class='note'>When you use this installation method, some add-ons will not be available and the documentation might not work for your installation.</p>
|
||||
|
||||
[Etcher]: https://etcher.io/
|
||||
[resinos-network]: https://docs.resin.io/deployment/network/2.0.0/
|
||||
[pi1]: https://github.com/home-assistant/hassio-build/releases/download/0.8/resinos-hassio-0.8-raspberrypi.img.bz2
|
||||
@ -37,3 +40,5 @@ For advanced users, it is also possible to try Hass.io on your Linux server or i
|
||||
[nuc]: https://github.com/home-assistant/hassio-build/releases/download/0.8/resinos-hassio-0.8-intel-nuc.img.bz2
|
||||
[linux]: https://github.com/home-assistant/hassio-build/tree/master/install#install-hassio
|
||||
[local]: http://hassio.local:8123
|
||||
[samba]: /addons/samba/
|
||||
[ssh]: /addons/ssh/
|
||||
|
||||
@ -9,7 +9,11 @@ sharing: true
|
||||
footer: true
|
||||
---
|
||||
|
||||
Hass.io allows anyone to create add-on repositories to easily share their add-ons for Hass.io. To try this locally, you can use our example add-on repository at `https://github.com/home-assistant/hassio-addons-example`.
|
||||
Hass.io allows anyone to create add-on repositories to easily share their add-ons for Hass.io. To try this locally, you can use our example add-on repository at
|
||||
|
||||
```text
|
||||
https://github.com/home-assistant/hassio-addons-example
|
||||
```
|
||||
|
||||
<p class='note warning'>
|
||||
Home Assistant cannot guarantee the quality or security of third party add-ons. Use at your own risk.
|
||||
@ -27,4 +31,4 @@ Add the urls of repositories (one per line) and then press "Save". A new card fo
|
||||
|
||||
### {% linkable_title Help: Repository is not showing up %}
|
||||
|
||||
If you have added a repository but it's not showing up, it means that the repository contains invalid configuration. Go to the Hass.io panel -> Supervisor card -> View logs and scroll to the bottom. It should tell you what went wrong. Report this information to the repository author.
|
||||
If you have added a repository but it's not showing up, it means that the repository contains invalid configuration. Go to the Hass.io panel -> Three dot menu -> Advanced Settings -> Supervisor card -> View logs and scroll to the bottom. It should tell you what went wrong. Report this information to the repository author.
|
||||
|
||||
@ -9,15 +9,19 @@ sharing: true
|
||||
footer: true
|
||||
---
|
||||
|
||||
On a normal Home Assistant installation you have access to the base machine and can install or add scripts that you can call with a `command_line` sensor/switch. Since Hass.IO uses Docker, you can not use this old way to perform local stuff. On its face, it looks quite restrictive, but it makes the whole system stable.
|
||||
Hass.io is a managed environment. This means that you're unable to install applications that you can embed into Home Assistant using the `command_line` sensor/switch.
|
||||
|
||||
However, if you need to run a script to read data for a sensor or send commands to other devices on Hass.IO, you can do that with a add-on or on inside the Home Assistant container with a custom component. Here is one way to accomplish that using an add-on. For custom component, look at the [devoloper site][custom-component] and also read the [add-ons tutorial][addons-tutorial]. Now you can get started with your custom component in the right way.
|
||||
There are two options if you need to run a script to read data from a sensor or send commands to other devices on Hass.IO.
|
||||
|
||||
First you need install a MQTT broker. You can use our [MQTT broker add-on][mqtt-addon]. Make sure you use logins and disable anonymous access if you want to secure the system. We provide no Hass.IO way to exchange data, that will be not realy good for security and is also to slow to exchange data between containers or stop and go stuff. That is the reason why we use a mqtt broker for it.
|
||||
First option is to write a custom component for Home Assistant. Using Python you can communicate with your device. For custom component, look at the [devoloper site][custom-component].
|
||||
|
||||
The second option is to make a local add-on for Hass.io that sends the data to Home Assistant via MQTT. Before we dive into this, read up on [Hass.io add-on development][addons-tutorial].
|
||||
|
||||
For security and speed, Hass.io does not provide a way for containers to communicate directly. So the first step is to set up a communication channel. We're going to use MQTT for this using the [MQTT broker add-on][mqtt-addon].
|
||||
|
||||
### {% linkable_title Sensors %}
|
||||
|
||||
Short story of that caption: We loop in our script to fetch data and push it to MQTT and wait until next process is ready. Here is a basic example and structure for that process.
|
||||
We loop in our script to fetch data and push it to MQTT and wait until next process is ready. Here is a basic example and structure for that process.
|
||||
|
||||
Our Dockerfile need to install:
|
||||
|
||||
@ -26,6 +30,7 @@ RUN apk --no-cache add jq mosquitto-clients
|
||||
```
|
||||
|
||||
Now we can process it with `run.sh`:
|
||||
|
||||
```bash
|
||||
#!/bin/bash
|
||||
set -e
|
||||
@ -52,11 +57,11 @@ do
|
||||
|
||||
sleep "$WAIT_TIME"
|
||||
done
|
||||
|
||||
```
|
||||
|
||||
### {% linkable_title Commands %}
|
||||
Short story of that caption: We wait for incoming data from MQTT broker. We can also use an `input_boolean` that triggers an automation to publish a custom command to MQTT topic that can process multiple things in one add-on.
|
||||
|
||||
We wait for incoming data from MQTT broker. We can also use an `input_boolean` that triggers an automation to publish a custom command to MQTT topic that can process multiple things in one add-on.
|
||||
|
||||
Our Dockerfile need to install:
|
||||
|
||||
@ -88,10 +93,9 @@ do
|
||||
fi
|
||||
|
||||
done < <(mosquitto_sub -h "$MQTT_SERVER" -p "$MQTT_PORT" -u "$USER" -P "$PASSWORD" -t "$TOPIC" -q 1)
|
||||
|
||||
```
|
||||
|
||||
|
||||
[MQTT-addon]: /addons/mosquitto/
|
||||
[custom-component]: /developers/component_loading/
|
||||
[addons-tutorial]: /hassio/addon_tutorial/
|
||||
[addons-tutorial]: /developers/hassio/addon_tutorial/
|
||||
|
||||
17
source/hassio/zwave.markdown
Normal file
17
source/hassio/zwave.markdown
Normal file
@ -0,0 +1,17 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Z-Wave"
|
||||
description: "Instructions on how-to use Z-Wave with Hass.io."
|
||||
date: 2017-04-30 13:28
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
---
|
||||
|
||||
To enable Z-Wave, plug your Z-Wave USB stick into your Raspberry Pi 3 and add the following to your `configuration.yaml`:
|
||||
|
||||
```yaml
|
||||
zwave:
|
||||
usb_path: /dev/ttyACM0
|
||||
```
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 7.8 KiB |
BIN
source/images/hassio/screenshots/dashboard.png
Normal file
BIN
source/images/hassio/screenshots/dashboard.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 13 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 34 KiB After Width: | Height: | Size: 25 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 7.8 KiB After Width: | Height: | Size: 26 KiB |
Loading…
x
Reference in New Issue
Block a user