jeena/home-assistant.github.io
1
0
Fork 0
Code Issues Pull requests Projects Packages Wiki Activity Actions

Update Hass.io docs

Browse source
This commit is contained in:
Paulus Schoutsen 2017-07-14 22:56:40 -07:00
parent 419540348d
commit ca80944d74
31 changed files with 248 additions and 74 deletions
Download patch file Download diff file Expand all files Collapse all files

6
source/_addons/bluetooth_bcm43xx.markdown
View file

@ -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.

2
source/_addons/check_config.markdown
View file

@ -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

4
source/_addons/dhcp_server.markdown
View file

@ -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
{

4
source/_addons/dnsmasq.markdown
View file

@ -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.

10
source/_addons/mosquitto.markdown
View file

@ -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
```

2
source/_addons/nginx_proxy.markdown
View file

@ -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
View 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/

27
source/_addons/ssh.markdown
View file

@ -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>