jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-19 15:26:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

✅ Various markdown, spelling, and grammar fixes (#4457)

Browse Source
This commit is contained in:
Franck Nijhof 2018-01-21 17:36:38 +01:00 committed by Fabian Affolter
parent 9f359d5925
commit 4e8718b123
15 changed files with 61 additions and 64 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
source/_addons/cec_scan.markdown
View File

@ -9,4 +9,4 @@ sharing: true
footer: true
---
Help you to discover the HDMI CEC address. Start the add-on and look into log to see all connected device on HDMI.
Help you to discover the HDMI CEC address. Start the add-on and look into the log to see all connected device on HDMI.

2
source/_addons/check_config.markdown
View File

@ -9,7 +9,7 @@ sharing: true
footer: true
---
You can use this addon to check whether your configuration files are valid against the new version of Home Assistant before you actually update your Home Assistant installation. This will help you avoid errors due to breaking changes, resulting in an smooth update.
You can use this addon to check whether your configuration files are valid against the new version of Home Assistant before you actually update your Home Assistant installation. This addon will help you avoid errors due to breaking changes, resulting in a smooth update.
```json
{

14
source/_addons/configurator.markdown
View File

@ -11,7 +11,7 @@ featured: true
og_image: /images/hassio/screenshots/addon-hass-configurator.png
---
As long as a fully featured configuration GUI for Home Assistant is still under development, you can use this add-on to add a browser based file-editor to your Hass.IO installation. By default it will listen on port `3218` of the host Hass.IO is running on.
As long as a fully featured configuration GUI for Home Assistant is still under development, you can use this add-on to add a browser-based file-editor to your Hass.IO installation. By default it will listen on port `3218` of the host Hass.IO is running on.
More information and a standalone version for regular Home Assistant installations can be found in the [GitHub repository][code].
@ -27,8 +27,8 @@ Screenshot of the HASS Configurator.
- Web-Based editor to modify your files with syntax highlighting.
- Upload and download files.
- Stage and commit changes in Git repositories, create and switch between branches, push to remotes.
- Lists of available triggers, events, entities, conditions and services. Selected element gets inserted into the editor at the last cursor position.
- Restart Home Assistant directly with the click of a button. Reloading groups, automations etc. can be done as well. An API-password is required.
- Lists of available triggers, events, entities, conditions, and services. The selected element gets inserted into the editor at the last cursor position.
- Restart Home Assistant directly with the click of a button. Reloading groups, automations, etc. can be done as well. An API-password is required.
- SSL support.
- Optional authentication and IP filtering for added security.
- Direct links to Home Assistant documentation and icons.
@ -55,15 +55,15 @@ Screenshot of the HASS Configurator.
- **username** (*Optional*): Set a username to access your configuration is protected.
- **password** (*Required*): Set a password for access.
- **ssl** (*Optional*): Enable or Disable SSL for the editor.
- **allowed_networks** (*Optional*): Limit access to the configurator by adding allowed IP addresses / networks to the list.
- **allowed_networks** (*Optional*): Limit access to the configurator by adding allowed IP addresses/networks to the list.
- **banned_ips** (*Optional*): List of statically banned IP addresses.
- **banlimit** (*Optional*): Ban access from IPs after `banlimit` failed login attempts. The default value `0` disables this feature. Restart the add-on to clear the list of banned IP addresses.
- **ignore_pattern** (*Optional*): Files and folders to ignore in the UI.
- **dirsfirst** (*Optional*): List directories before files in the filebrowser.
- **dirsfirst** (*Optional*): List directories before files in the file browser.
### {% linkable_title Embedding into Home-Assistant %}
Using the Home Assistant component [panel_iframe](https://home-assistant.io/components/panel_iframe/) it is possible to embed the configurator directly into Home Assistant, allowing you to modify your configuration within the Home Assistant frontend.
Using the Home Assistant component [panel_iframe](https://home-assistant.io/components/panel_iframe/) it is possible to embed the configurator directly into Home Assistant, allowing you to modify your configuration from within the Home Assistant frontend.
An example configuration would look like this:
@ -76,5 +76,5 @@ panel_iframe:
```
<p class='note warning'>
Be careful when setting up port forwarding to the configurator while embedding into Home Assistant. If you don't restrict access by requiring authentication and / or blocking based on client IP addresses, your configuration will be exposed to the internet!
Be careful when setting up port forwarding to the configurator while embedding into Home Assistant. If you don't restrict access by requiring authentication and/or blocking based on client IP addresses, your configuration will be exposed to the internet!
</p>

6
source/_addons/dnsmasq.markdown
View File

@ -30,7 +30,7 @@ Setup and manage a [Dnsmasq](http://thekelleys.org.uk/dnsmasq/doc.html) DNS serv
Configuration variables:
- **defaults** (*Required*): A list of dns server to forward default requests.
- **defaults** (*Required*): A list of DNS servers to forward default requests to.
- **forwards** (*Optional*): A list of domains that will forward to a specific server.
- **hosts** (*Optional*): A list of hosts to resolve it static.
- **interface** (*Optional*): If a interface is set, it listen only on this interface. Need to set for resinos. Normally is `eth0` for ethernet wired connection and `wlan0` for wireless connection.
- **hosts** (*Optional*): A list of hosts to resolve statically.
- **interface** (*Optional*): If an interface is set, it listens only on this interface. Needs to be set for ResinOS. Normally is `eth0` for ethernet wired connection and `wlan0` for wireless connection.

11
source/_addons/google_assistant.markdown
View File

@ -11,7 +11,7 @@ featured: true
---
<p class='note'>
If you are wanting to integrate your Google Home, or mobile phone running Google Assistant, with Home Assistant then you want the [Google Assistant component](https://home-assistant.io/components/google_assistant/).
If you want to integrate your Google Home, or mobile phone running Google Assistant, with Home Assistant, then you want the [Google Assistant component](https://home-assistant.io/components/google_assistant/).
</p>
[Google Assistant][GoogleAssistant] is an AI-powered voice assistant that runs on the Raspberry Pi and x86 platforms and interact via the [DialogFlow][comp] integration with Home-Assistant. You can also use [Google Actions][GoogleActions] to extend its functionality.
@ -19,8 +19,8 @@ featured: true
To enable access to the Google Assistant API, do the following:
1. In the [Cloud Platform Console][project], go to the Projects page. Select an existing project or create a new project
2. Open the project. In the top of the page search for Google Assistant API or use [this link][API] and enable it.
3. Create an [OAuth Client ID][oauthclient], pick type "Other", click "Create" and download the JSON file by clicking the Download JSON button on the right side.
1. Open the project. In the top of the page search for Google Assistant API or use [this link][API] and enable it.
1. Create an [OAuth Client ID][oauthclient], pick type "Other", click "Create" and download the JSON file by clicking the Download JSON button on the right side.
Now install and activate the [Samba] add-on so you can upload your credential file. Connect to the "share" Samba share and copy your credentials over. Name the file `google_assistant.json`.
@ -52,9 +52,9 @@ Find the microphone and speakers that you want to use and note down their device
The next step is to authenticate your Google account with Google Assistant. Start the add-on and click on the "OPEN WEB UI" button to start authentication.
### Add-On configuration
### Add-on configuration
Configuration example that uses the USB microphone and use the built-in headset audio output on the Raspberry Pi. Note that card and device numbers can differ on your device.
Configuration example that uses the USB microphone and the built-in headset audio output on the Raspberry Pi. Note that card and device numbers can differ on your device.
```json
{
@ -73,7 +73,6 @@ Configuration variables:
Use the Home Assistant [DialogFlow component][comp] to integrate the add-on into Home Assistant.
[GoogleAssistant]: https://assistant.google.com/
[GoogleActions]: https://actions.google.com/
[Samba]: /addons/samba/

14
source/_addons/homematic.markdown
View File

@ -9,9 +9,9 @@ sharing: true
footer: true
---
Set up a [HomeMatic](https://github.com/eq-3/occu) hardware layer. At the moment we don't support hmIP but that is in progress. For learning and handling devices use our internal homematic panel and services (in progress) or use [Homematic-Manager](https://github.com/hobbyquaker/homematic-manager) > 2.0.
Set up a [HomeMatic](https://github.com/eq-3/occu) hardware layer. At the moment we don't support hmIP, but that is in progress. For learning and handling devices use our internal HomeMatic panel and services (in progress) or use [Homematic-Manager](https://github.com/hobbyquaker/homematic-manager) > 2.0.
The logic layer will be Home-Assistant. There is no ReGa or other logic layer installed. You can't import exists configuration, you need new learn it into Home-Assistant.
The logic layer will be Home-Assistant. There is no ReGa or other logic layer installed. You can't import an existing configuration, you'll need re-learn it into Home-Assistant.
Follow devices will be supported and tested:
- [HM-MOD-RPI-PCB](https://www.elv.ch/homematic-funkmodul-fuer-raspberry-pi-bausatz.html)
@ -42,13 +42,13 @@ Configuration variables:
- **wired_enable** (*Require*): Boolean. Enable or disable BidCoS-Wired.
For RF devices
- **type** (*Require*): Device type for RFD service. Look into handbook of your device.
- **device** (*Require*): Device on host.
- **type** (*Require*): Device type for RFD service. Look into the manual of your device.
- **device** (*Require*): Device on the host.
For RF devices
- **serial** (*Require*): Serial number of device.
- **serial** (*Require*): Serial number of the device.
- **key** (*Require*): Encrypted key.
- **ip** (*Require*): IP address of lan gateway.
- **ip** (*Require*): IP address of LAN gateway.
## {% linkable_title Home Assistant configuration %}
@ -64,7 +64,7 @@ homematic:
## {% linkable_title Raspberry Pi3 %}
With HM-MOD-PRI-PCB you need add follow into your `config.txt` on boot partition:
With HM-MOD-PRI-PCB you need to add follow into your `config.txt` on boot partition:
```
dtoverlay=pi3-miniuart-bt
```

4
source/_addons/lets_encrypt.markdown
View File

@ -14,7 +14,7 @@ featured: false
You should not use this if you are also using the [DuckDNS add-on]. The DuckDNS add-on has integrated Let's Encrypt support.
</p>
Setup and manage a [Let's Encrypt](https://letsencrypt.org/) certificate. This will create a certificate on the first run and will auto-renew if the certificate is within 30 days of expiration.
Setup and manage a [Let's Encrypt](https://letsencrypt.org/) certificate. This addon will create a certificate on the first run and will auto-renew if the certificate is within 30 days of expiration.
```json
{
@ -39,6 +39,6 @@ http:
ssl_key: /ssl/privkey.pem
```
If you use another port such as `8123` or a SSL proxy, change the port number.
If you use another port such as `8123` or an SSL proxy, change the port number.
[DuckDNS add-on]: /addons/duckdns/

2
source/_addons/mariadb.markdown
View File

@ -9,7 +9,7 @@ sharing: true
footer: true
---
Set up a [mariadb](https://mariadb.org/) SQL server. It supports multiple databases, users and permission settings. If you want to only connect from inside home assistant use `core-mariadb` as the host address.
Set up a [mariadb](https://mariadb.org/) SQL server. It supports multiple databases, users, and permission settings. If you want to only connect from inside home assistant use `core-mariadb` as the host address.
```json
{

8
source/_addons/mosquitto.markdown
View File

@ -35,10 +35,10 @@ Make sure you use logins and disable anonymous access if you want to secure the
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*.
- **plain** (*Optional*): Listen on port 1883 without SSL/TLS. Defaults to `true`.
- **ssl** (*Optional*): Listen on port 8883 with SSL/TLS. This requires certificates. Defaults to `false`.
- **anonymous** (*Optional*): Allow anonymous connections. If *logins* is set, the anonymous user can only read data. Defaults to `true`.
- **logins** (*Optional*): A list of users that will be created with *username* and *password*.
- **customize** (*Optional*): If you enable it, it reads additional configuration files (`*.conf`) from `/share/mosquitto`.
### {% linkable_title Home Assistant configuration %}

5
source/_addons/nginx_proxy.markdown
View File

@ -9,11 +9,10 @@ sharing: true
footer: true
---
Setup a SSL proxy with NGINX and redirect port 80 to 443. Make sure you have generated a certificate before you start this add-on.
Setup an SSL proxy with NGINX and redirect port 80 to 443. Make sure you have generated a certificate before you start this add-on.
In the `http` section of the `configuration.yaml` file remove `ssl_certificate` and `ssl_key` and don't enter the port in the `base_url` to avoid a HTTP 502 error.
```json
{
"domain": "home.example.com"
@ -25,5 +24,5 @@ Configuration variables:
- **domain** (*Required*): Domain they will proxy run with it.
<p class='note'>
It is possible to deactive port 80 if you need this for things like `emulate_hue`. Remove the host port from Network option of this add-on.
It is possible to deactivate port 80 if you need this for things like `emulate_hue`. Remove the host port from Network option of this add-on.
</p>

10
source/_addons/rpc_shutdown.markdown
View File

@ -9,7 +9,7 @@ sharing: true
footer: true
---
Allow to shutdown a Windows computer with a service call from Home Assistant.
Allows you to shut down a Windows computer with a service call from Home Assistant.
```json
{
@ -23,10 +23,10 @@ Allow to shutdown a Windows computer with a service call from Home Assistant.
}
```
- **computers** (*Required*): A list of computer object to shutdown from Home-Assistant.
- **computers/alias** (*Required*): Set a alias for this record and that is the name for the input.
- **computers/address** (*Required*): IP address or netbios name of the computer for shutdown.
- **computers/credentials** (*Required*): Credentials for logging into computer. Use a `%` as delimiter of username and password.
- **computers** (*Required*): A list of computer objects to shutdown from Home-Assistant.
- **computers/alias** (*Required*): Set an alias for this record which becomes the name for the input.
- **computers/address** (*Required*): IP address or NetBIOS name of the computer for the shutdown.
- **computers/credentials** (*Required*): Credentials for logging into computer. Use a `%` as the delimiter of username and password.
## {% linkable_title Home Assistant %}

8
source/_addons/samba.markdown
View File

@ -1,7 +1,7 @@
---
layout: page
title: "Samba"
description: "Manage your Home Assistant and custom addons over Samba."
description: "Manage your Home Assistant and custom add-ons over Samba."
date: 2017-04-30 13:28
sidebar: true
comments: false
@ -10,7 +10,7 @@ footer: true
featured: true
---
This allows you to set up a [Samba](https://samba.org/) server to access hass.io folders using Windows network shares.
This addon allows you to set up a [Samba](https://samba.org/) server to access hass.io folders using Windows network shares.
```json
{
@ -32,10 +32,10 @@ This allows you to set up a [Samba](https://samba.org/) server to access hass.io
Configuration variables:
- **name** (*Optional*): default `hassio`. Set netbios name of hassio device.
- **name** (*Optional*): default `hassio`. Set NetBIOS name of hassio device.
- **workgroup** (*Optional*): default `WORKGROUP`. Set network workgroup.
- **guest** (*Optional*): Allow login without a username or password. Defaults to `true`.
- **map** (*Optional*): Control which folder will be expose. `config` is for Home Assistant configuration folder. `addons` for local custom repositiory. `share` is a folder that can access from add-ons and Home Assistant too. `backup` for access to snapshot files. `ssl` for certificate storage, be careful with this option! Defaults all to `true`, except for `ssl`.
- **map** (*Optional*): Control which folder will be exposed. `config` is for Home Assistant configuration folder. `addons` for a local custom repository. `share` is a folder that can access from add-ons and Home Assistant too. `backup` for access to snapshot files. `ssl` for certificate storage, be careful with this option! Defaults all to `true`, except for `ssl`.
- **username** (*Optional*): The username for logging in if guest login is not used.
- **password** (*Optional*): Password for `username`. An empty password is not supported.
- **interface** (*Optional*): Interface on that will start the share. Normally is `eth0` for ethernet wired connection and `wlan0` for wireless connection.

8
source/_addons/ssh.markdown
View File

@ -13,16 +13,16 @@ featured: true
Setting up an [SSH](https://openssh.org/) server allows access to your Hass.io folders with any SSH client. It also includes a command-line tool to access the [Hass.io API](https://github.com/home-assistant/hassio/blob/dev/API.md). Try it out:
```bash
$ hassio help
hassio help
```
<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]. It is possible to set a password for login since version 2.0 but for high security use private/public keys. You can not run both variant at same time.
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]. It is possible to set a password for login since version 2.0 but for high security use private/public keys. You can not run both variants at the same time.
In order to start this add-on for the first time, you either need to include an ssh key (enclosed in quotation marks, on a single line without line breaks) or set a password in the options section.
To start this add-on for the first time, you either need to include an ssh key (enclosed in quotation marks, on a single line without line breaks) or set a password in the options section.
```json
{
@ -39,7 +39,7 @@ After logging in, you will find yourself in this add-ons container. The Home Ass
Configuration variables:
- **authorized_keys** (*Optional*): Your public keys for authorized keyfile. Every element will be a line inside that file.
- **authorized_keys** (*Optional*): Your public keys for the authorized key file. Every element will be a line inside that file.
- **password** (*Optional*): Set a password for login. We do not recommend this variant.

15
source/_addons/tellstick.markdown
View File

@ -15,17 +15,17 @@ Setting up the [Tellstick](http://telldus.com) service and tools contained in th
To use this add-on, you first install it from the list of Built-in add-ons in Hass.io.
After installation you are presented with a default and example configuration, to alter this you must follow both the JSON format and also be aligned with the [valid parameters for Tellstick configuration file (tellstick.conf)](https://developer.telldus.com/wiki/TellStick_conf).
After any changes has been made to the configuration you need to restart the add-on for the changes to take effect.
After any changes have been made to the configuration, you need to restart the add-on for the changes to take effect.
Configuration variables:
- **id** (*Required*): This is a number and must be unique for each device.
- **id** (*Required*): A number and must be unique for each device.
- **name** (*Required*): A name for easy identification of the device.
- **protocol** (*Required*): This is the protocol the device uses. More on the different protocols later down.
- **model** (*Optional*): The parameter model is only used by some protocols where there exists different types of devices using the same protocol. This can be dimmers versus non-dimmers, codeswitch versus selflearning etc.
- **model** (*Optional*): The model parameter is only used by some protocols where there exists different types of devices using the same protocol. This can be dimmers versus non-dimmers, codeswitch versus self-learning, etc.
- **house** (*Optional*): Depending on protocol the values here can vary a lot to identify or group per house or type.
- **unit** (*Optional*): Unit identifier, in most cases a value between 1 to 16 and often used in combination with house.
- **fade** (*Optional*): Fade is either `true` or `false` and tells a dimmer if is should fade smooth or instant between values (only for IKEA protocol as it seems).
- **unit** (*Optional*): Unit identifier, in most cases a value between 1 to 16 and often used in combination with the house.
- **fade** (*Optional*): Fade is either `true` or `false` and tells a dimmer if it should fade smooth or instant between values (only for IKEA protocol as it seems).
- **code** (*Optional*): A number series based on ones and zeroes often used for dip-switch based devices.
You will need to add internal communication details to `configuration.yaml` to enable the integration from Hass.io and the add-on.
@ -42,11 +42,10 @@ tellstick:
To add [lights](https://home-assistant.io/components/light.tellstick/), [sensors](https://home-assistant.io/components/sensor.tellstick/) and [switches](https://home-assistant.io/components/switch.tellstick/) you follow the guidelines for each type individually that is [described for Home Assistant](https://home-assistant.io/components/tellstick/)
The add-on will also enable you to interact with tdtool via a Home Assistant services call, see example below for selflearning device.
The add-on will also enable you to interact with the `tdtool` via a Home Assistant services call, see example below for self-learning device.
## {% linkable_title Examples %}
Example for adding more devices in the add-on configuration (note the comma separator between devices):
```json
@ -100,4 +99,4 @@ You can also use this to list devices or sensors and read the output in the add-
- `"function":"bell","device":"x"`: Sends bell command to devices supporting this. ’x’ could either be an integer of the device-id, or the name of the device.
- `"function":"learn","device":"x"`: Sends a special learn command to devices supporting this. This is normaly devices of ’selflearning’ type. ’x’ could either be an integer of the device-id, or the name of the device.
- `"function":"learn","device":"x"`: Sends a special learn command to devices supporting this. This is normally devices of ’selflearning’ type. ’x’ could either be an integer of the device-id, or the name of the device.