mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-24 17:57:14 +00:00
✅ Fixes spelling of 'Home Assistant' everywhere (#3524)
This commit is contained in:
Franck Nijhof
Fredrik Lindqvist
parent
664e1bf86e
commit
443904de16
@ -15,7 +15,7 @@ ha_release: 0.35
|
||||
|
||||
The `flic` platform allows you to connect with multiple [flic](https://flic.io) smart buttons.
|
||||
|
||||
The platform does not directly interact with the buttons, but communicates with the flic service that manages the buttons. The service can run on the same instance as home assistant or any other reachable machine. For setup instructions visit the GitHub repository of the service for [Linux](https://github.com/50ButtonsEach/fliclib-linux-hci), [OS X](https://github.com/50ButtonsEach/flic-service-osx) or [Windows](https://github.com/50ButtonsEach/fliclib-windows).
|
||||
The platform does not directly interact with the buttons, but communicates with the flic service that manages the buttons. The service can run on the same instance as Home Assistant or any other reachable machine. For setup instructions visit the GitHub repository of the service for [Linux](https://github.com/50ButtonsEach/fliclib-linux-hci), [OS X](https://github.com/50ButtonsEach/flic-service-osx) or [Windows](https://github.com/50ButtonsEach/fliclib-windows).
|
||||
|
||||
To use your flic buttons in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
|
||||
@ -65,7 +65,7 @@ Configuration variables:
|
||||
- **evl_version** (*Optional*): 3 for evl3, or 4 for evl4. Default: `3`
|
||||
- **keepalive_interval** (*Optional*): This is a periodic heartbeat signal (measured in seconds) sent to your Envisalink board to keep it from restarting. This is required for DSC and Honeywell systems. Defaults to `60` seconds.
|
||||
- **zonedump_interval** (*Optional*): This is an interval (measured in seconds) where the evl will dump out all zone statuses. This is required for Honeywell systems, which do not properly send zone closure events. DSC boards do not technically need this. Default: `30`
|
||||
- **panic_type** (*Optional*): Both DSC and Honeywell boards support a "panic" alarm. This is used when the alarm_trigger service is called in home assistant. This determines which type of panic alarm to raise. Default = Police. Valid values are: Police, Fire, Ambulance
|
||||
- **panic_type** (*Optional*): Both DSC and Honeywell boards support a "panic" alarm. This is used when the alarm_trigger service is called in Home Assistant. This determines which type of panic alarm to raise. Default = Police. Valid values are: Police, Fire, Ambulance
|
||||
- **zones** (*Optional*): Envisalink boards have no way to tell us which zones are actually in use, so each zone must be configured in Home Assistant. For each zone, at least a name must be given. For more information on the available zone types, take a look at the [Binary Sensor](/components/binary_sensor.envisalink/) docs. *Note: If no zones are specified, Home Assistant will not load any binary_sensor components.*
|
||||
- **partitions** (*Optional*): Again, Envisalink boards do not tell us what is in use and what is not, so each partition must be configured with a partition name. If no partition parameter is specified, then no alarm_panel or sensor components are loaded.
|
||||
|
||||
|
||||
@ -52,5 +52,5 @@ Jun 20 19:41:18 androlapin hass[29588]: OSError: [Errno 8] Exec format error
|
||||
1. Go to your `.homeassistant` folder
|
||||
2. Then go to `deps/bluepy` subfolder.
|
||||
3. Then run `make all`
|
||||
4. Restart home assistant
|
||||
4. Restart Home Assistant
|
||||
</p>
|
||||
|
||||
@ -16,11 +16,11 @@ ha_release: pre 0.7
|
||||
|
||||
Philips Hue support is integrated into Home Assistant as a light platform. The preferred way to setup the Philips Hue platform is by enabling the [discovery component](/components/discovery/).
|
||||
|
||||
Once discovered, if you have a custom default view, locate `configurator.philips_hue` in the entities list ( < > ) and add it to a group in `configuration.yaml`. Restart Home Assistant so that the configurator is visible in the Home Assistant dashboard. Once Home Assistant is restarted, locate and click on `configurator.philips_hue` to bring up the initiation dialog. This will prompt you to press the Hue button to register the Hue hub in home assistant. Once complete, the configurator entity isn't needed anymore and can be removed from any visible group in `configuration.yaml`.
|
||||
Once discovered, if you have a custom default view, locate `configurator.philips_hue` in the entities list ( < > ) and add it to a group in `configuration.yaml`. Restart Home Assistant so that the configurator is visible in the Home Assistant dashboard. Once Home Assistant is restarted, locate and click on `configurator.philips_hue` to bring up the initiation dialog. This will prompt you to press the Hue button to register the Hue hub in Home Assistant. Once complete, the configurator entity isn't needed anymore and can be removed from any visible group in `configuration.yaml`.
|
||||
|
||||
When you configure the Hue bridge from Home Assistant, it writes a token to a file in your Home Assistant [configuration directory](/docs/configuration/). That token authenticates the communication with the Hue bridge. This token uses the IP Address of the Hue Bridge. If the IP address for the Hue Bridge changes, you will need to register the Hue Bridge with Home Assistant again. To avoid this you may set up DHCP registration for your Hue Bridge, so that it always has the same IP address.
|
||||
|
||||
Restarting Home Assistant once more should result in the Hue lights listed as "light" entities. Add these light entities to configuration.yaml and restart home assistant once more to complete the installation.
|
||||
Restarting Home Assistant once more should result in the Hue lights listed as "light" entities. Add these light entities to configuration.yaml and restart Home Assistant once more to complete the installation.
|
||||
|
||||
If you want to enable the component without relying on the [discovery component](/components/discovery/), add the following lines to your `configuration.yaml` file:
|
||||
|
||||
|
||||
@ -24,7 +24,7 @@ This component was developed and tested with a Hama [DIR3110] and a Medion [MD 8
|
||||
|
||||
## Configuration
|
||||
|
||||
Your Frontier Silicon based device should be automatically discovered by home assistant. The auto-discovery service assumes that the device uses the default PIN code: *1234*. If you have changed the PIN code, the auto-discovery will fail as home assistant will not be able to connect to the device. You can set the PIN code of your device (depending on manufacturer) under:
|
||||
Your Frontier Silicon based device should be automatically discovered by Home Assistant. The auto-discovery service assumes that the device uses the default PIN code: *1234*. If you have changed the PIN code, the auto-discovery will fail as Home Assistant will not be able to connect to the device. You can set the PIN code of your device (depending on manufacturer) under:
|
||||
|
||||
*MENU button > Main Menu > System setting > Network > NetRemote PIN setup*
|
||||
|
||||
@ -80,8 +80,8 @@ is based on [tiwillam]'s fsapi project. Special thanks to both developers, this
|
||||
## Notes and Limitations
|
||||
|
||||
<p class='note warning'>
|
||||
The Frontier Silicon API does not provide a multi-user environment. There is always a single user (session) controlling a device, which means that once home assistant connects to a device all other sessions will be invalidated. This renders the usage of [UNDOK] almost impossible, as the home assistant component polls the device state every 30 seconds or issues a command by creating a new session.
|
||||
*If you want to prevent home assistant to auto connect to your device, simply change the PIN code of the device to something else than: 1234*
|
||||
The Frontier Silicon API does not provide a multi-user environment. There is always a single user (session) controlling a device, which means that once Home Assistant connects to a device all other sessions will be invalidated. This renders the usage of [UNDOK] almost impossible, as the Home Assistant component polls the device state every 30 seconds or issues a command by creating a new session.
|
||||
*If you want to prevent Home Assistant to auto connect to your device, simply change the PIN code of the device to something else than: 1234*
|
||||
</p>
|
||||
|
||||
[Frontier Silicon chipset]: http://www.frontier-silicon.com/digital-radio-solutions
|
||||
|
||||
@ -183,7 +183,7 @@ Sending a heartbeat from the MySensors device to Home Assistant activates the Sm
|
||||
|
||||
### {% linkable_title Message validation %}
|
||||
|
||||
Messages sent to or from Home Assistant from or to a MySensors device will be validated according to the MySensors [serial API](https://www.mysensors.org/download/serial_api_20). If a message doesn't pass validation, it will be dropped and not be passed forward either to or from home assistant. Make sure you follow the serial API for your version of MySensors when writing your Arduino sketch.
|
||||
Messages sent to or from Home Assistant from or to a MySensors device will be validated according to the MySensors [serial API](https://www.mysensors.org/download/serial_api_20). If a message doesn't pass validation, it will be dropped and not be passed forward either to or from Home Assistant. Make sure you follow the serial API for your version of MySensors when writing your Arduino sketch.
|
||||
|
||||
If you experience dropped messages or that a device is not added to Home Assistant, please turn on debug logging for the `mysensors` component and the `mysensors` package.
|
||||
```yaml
|
||||
|
||||
@ -122,7 +122,7 @@ Configuration variables:
|
||||
- **inline_keyboard** (*Optional*): List of rows of commands, comma-separated, to make a custom inline keyboard with buttons with associated callback data.
|
||||
|
||||
<p class='note'>
|
||||
Since Homeassistant version 0.48 you have to [whitelist the source folder](/docs/configuration/basic/) of the file you want to include in the notification.
|
||||
Since Home Assistant version 0.48 you have to [whitelist the source folder](/docs/configuration/basic/) of the file you want to include in the notification.
|
||||
|
||||
```yaml
|
||||
configuration.yaml
|
||||
|
||||
@ -15,9 +15,9 @@ ha_iot_class: "Local Push"
|
||||
|
||||
[Pilight](https://www.pilight.org/) is a modular and open source solution to communicate with 433 MHz devices and runs on various small form factor computers. A lot of common [protocols](https://wiki.pilight.org/doku.php/protocols) are already available.
|
||||
|
||||
This pilight hub connects to the [pilight-daemon](https://wiki.pilight.org/doku.php/pdaemon) via a socket connection to receive and send codes. Thus home assistant does not have to run on the computer in charge of the RF communication.
|
||||
This pilight hub connects to the [pilight-daemon](https://wiki.pilight.org/doku.php/pdaemon) via a socket connection to receive and send codes. Thus Home Assistant does not have to run on the computer in charge of the RF communication.
|
||||
|
||||
The received and supported RF codes are put on the event bus of home assistant and are therefore directly usable by other components (e.g. automation). Additionally a send service is provided to send RF codes.
|
||||
The received and supported RF codes are put on the event bus of Home Assistant and are therefore directly usable by other components (e.g. automation). Additionally a send service is provided to send RF codes.
|
||||
|
||||
To integrate pilight into Home Assistant, add the following section to your `configuration.yaml` file:
|
||||
|
||||
|
||||
@ -14,7 +14,7 @@ ha_iot_class: depends
|
||||
---
|
||||
|
||||
|
||||
This `pilight` sensor platform for 433 MHz devices uses a value in the message payload as the sensor value. Unique identifiers (e.g. _uuid_) can be set to distinguish between multiple pilight devices. To use a pilight sensor the pilight home assistant hub has to be set up.
|
||||
This `pilight` sensor platform for 433 MHz devices uses a value in the message payload as the sensor value. Unique identifiers (e.g. _uuid_) can be set to distinguish between multiple pilight devices. To use a pilight sensor the pilight Home Assistant hub has to be set up.
|
||||
|
||||
To use your sensor via pilight, make sure it is [supported](https://wiki.pilight.org/doku.php/protocols) and add the following to your `configuration.yaml` file:
|
||||
|
||||
|
||||
@ -24,7 +24,7 @@ switch:
|
||||
automatic_add: True
|
||||
```
|
||||
|
||||
Launch your homeassistant and go the website.
|
||||
Launch your Home Assistant and go the website.
|
||||
Push your remote and your device should be added:
|
||||
|
||||
<p class='img'>
|
||||
@ -62,7 +62,7 @@ If you need to generate codes for switches you can use a template (useful for ex
|
||||
```
|
||||
|
||||
- Use this code to add a new switch in your configuration.yaml
|
||||
- Launch your homeassistant and go the website.
|
||||
- Launch your Home Assistant and go the website.
|
||||
- Enable learning mode on your switch (i.e. push learn button or plug it in a wall socket)
|
||||
- Toggle your new switch in the Home Assistant interface
|
||||
|
||||
|
||||
@ -104,7 +104,7 @@ sensor:
|
||||
command: "python3 occasion.py"
|
||||
```
|
||||
<p class='note'>
|
||||
If you are using docker to run home assistant then the occasion.py script will be placed under /config. Your command should instead be: command: "python3 /command/occasion.py"
|
||||
If you are using docker to run Home Assistant then the occasion.py script will be placed under /config. Your command should instead be: command: "python3 /command/occasion.py"
|
||||
</p>
|
||||
|
||||
|
||||
|
||||
@ -14,7 +14,7 @@ This example demonstrates how you can configure Apache to act as a proxy for Hom
|
||||
|
||||
This is useful if you want to have:
|
||||
|
||||
* a subdomain redirecting to your home assistant instance
|
||||
* a subdomain redirecting to your Home Assistant instance
|
||||
* several subdomain for several instance
|
||||
* HTTPS redirection
|
||||
|
||||
@ -73,8 +73,8 @@ You already have Home Assistant running on http://localhost:8123 and available a
|
||||
You want another instance available at https://countryside.example.org
|
||||
|
||||
You can either :
|
||||
* Create a new user, `bob`, to hold the configuration file in `/home/bob/.homeassistant/configuration.yaml` and run home assistant as this new user
|
||||
* Create another configuration directory in `/home/alice/.homeassistan2/configuration.yaml` and run home assistant using `hass --config /home/alice/.homeassistant2/`
|
||||
* Create a new user, `bob`, to hold the configuration file in `/home/bob/.homeassistant/configuration.yaml` and run Home Assistant as this new user
|
||||
* Create another configuration directory in `/home/alice/.homeassistan2/configuration.yaml` and run Home Assistant using `hass --config /home/alice/.homeassistant2/`
|
||||
|
||||
In both solution, change port number used by modifying `configuration.yaml`
|
||||
|
||||
|
||||
@ -1552,7 +1552,7 @@ The custom event `MODE_CHANGE` would be subscribed to with:
|
||||
self.listen_event(self.mode_event, "MODE_CHANGE")
|
||||
```
|
||||
|
||||
Home Assistant can send these events in a variety of other places - within automations, and also directly from Alexa intents. Home Assistant can also listen for custom events with it's automation component. This can be used to signal from AppDaemon code back to home assistant. Here is a sample automation:
|
||||
Home Assistant can send these events in a variety of other places - within automations, and also directly from Alexa intents. Home Assistant can also listen for custom events with it's automation component. This can be used to signal from AppDaemon code back to Home Assistant. Here is a sample automation:
|
||||
|
||||
```yaml
|
||||
automation:
|
||||
|
||||
@ -31,13 +31,13 @@ module = hello
|
||||
class = HelloWorld
|
||||
```
|
||||
|
||||
- `ha_url` is a reference to your home assistant installation and must include the correct port number and scheme (`http://` or `https://` as appropriate)
|
||||
- `ha_url` is a reference to your Home Assistant installation and must include the correct port number and scheme (`http://` or `https://` as appropriate)
|
||||
- `ha_key` should be set to your key if you have one, otherwise it can be removed.
|
||||
- `logfile` (optional) is the path to where you want `AppDaemon` to keep its main log. When run from the command line this is not used - log messages come out on the terminal. When running as a daemon this is where the log information will go. In the example above I created a directory specifically for AppDaemon to run from, although there is no reason you can't keep it in the `appdaemon` directory of the cloned repository. If `logfile = STDOUT`, output will be sent to stdout instead of stderr when running in the foreground, if not specified, output will be sent to STDOUT.
|
||||
- `errorfile` (optional) is the name of the logfile for errors - this will usually be errors during compilation and execution of the apps. If `errorfile = STDERR` errors will be sent to stderr instead of a file, if not specified, output will be sent to STDERR.
|
||||
- `app_dir` (optional) is the directory the apps are placed in. If not specified, AppDaemon will look first in `~/.homeassistant` then `/etc/appdaemon` for a subdirectory named `apps`
|
||||
- `threads` - the number of dedicated worker threads to create for running the apps. Note, this will bear no resembelance to the number of apps you have, the threads are re-used and only active for as long as required to tun a particular callback or initialization, leave this set to 10 unless you experience thread starvation
|
||||
- `latitude`, `longitude`, `elevation`, `timezone` - should all be copied from your home assistant configuration file
|
||||
- `latitude`, `longitude`, `elevation`, `timezone` - should all be copied from your Home Assistant configuration file
|
||||
- `cert_path` (optional) - path to root CA cert directory - use only if you are using self signed certs.
|
||||
|
||||
The `#Apps` section is the configuration for the Hello World program and should be left in place for initial testing but can be removed later if desired, as other Apps are added, App configuration is described in the [API doc](API.md).
|
||||
|
||||
@ -37,7 +37,7 @@ The app allows you to use your own custom sounds in push notifications. The soun
|
||||
2. Go to the device in iTunes.
|
||||
3. Select "Apps" on the left sidebar.
|
||||
4. Scroll down until you see the section labeled "File Sharing".
|
||||
5. Select HomeAssistant.
|
||||
5. Select Home Assistant.
|
||||
6. Drag and drop properly formatted sounds.
|
||||
7. Click Sync in the lower right.
|
||||
8. Once sync is complete, disconnect the device from the computer.
|
||||
|
||||
@ -13,7 +13,7 @@ This example demonstrates how you can configure NGINX to act as a proxy for Home
|
||||
|
||||
This is useful if you want to have:
|
||||
|
||||
* a subdomain redirecting to your home assistant instance
|
||||
* a subdomain redirecting to your Home Assistant instance
|
||||
* several subdomain for several instance
|
||||
* HTTPS redirection
|
||||
|
||||
@ -63,8 +63,8 @@ You already have Home Assistant running on http://localhost:8123 and available a
|
||||
You want another instance available at https://countryside.example.org
|
||||
|
||||
You can either :
|
||||
* Create a new user, `bob`, to hold the configuration file in `/home/bob/.homeassistant/configuration.yaml` and run home assistant as this new user
|
||||
* Create another configuration directory in `/home/alice/.homeassistan2/configuration.yaml` and run home assistant using `hass --config /home/alice/.homeassistant2/`
|
||||
* Create a new user, `bob`, to hold the configuration file in `/home/bob/.homeassistant/configuration.yaml` and run Home Assistant as this new user
|
||||
* Create another configuration directory in `/home/alice/.homeassistan2/configuration.yaml` and run Home Assistant using `hass --config /home/alice/.homeassistant2/`
|
||||
|
||||
In both solution, change port number used by modifying `configuration.yaml` file.
|
||||
|
||||
|
||||
@ -100,7 +100,7 @@ For a more advanced way to use the output try the following. In configuration.ya
|
||||
scene: !include_dir_list scenes
|
||||
```
|
||||
|
||||
This will tell home assistant to look in the subdirectory `scenes` for yaml files containing scene information. Each file will be named for the scene it will create and should contain information formatted as above. Then simply run Scenegen and redirect its output to the scenes subdirectory:
|
||||
This will tell Home Assistant to look in the subdirectory `scenes` for yaml files containing scene information. Each file will be named for the scene it will create and should contain information formatted as above. Then simply run Scenegen and redirect its output to the scenes subdirectory:
|
||||
|
||||
```
|
||||
$ ./scenegen.py https://<some url> -k <some api key> > scenes/my_new_scene.yaml
|
||||
|
||||
@ -27,7 +27,7 @@ Then install the Python 3.5 package:
|
||||
$ yum install rh-python35
|
||||
```
|
||||
|
||||
Once installed, switch to your homeassistant user (if you've set one up), enable the software collection and check that it has set up the new version of Python:
|
||||
Once installed, switch to your `homeassistant` user (if you've set one up), enable the software collection and check that it has set up the new version of Python:
|
||||
|
||||
```bash
|
||||
$ scl enable rh-python35 bash
|
||||
@ -35,13 +35,13 @@ $ python --version
|
||||
Python 3.5.1
|
||||
```
|
||||
|
||||
You will be in a command shell set up with Python 3.5 as your default version. The virtualenv and pip commands will be correct for this version, so you can now create a virtual environment and install home assistant following the main [instructions](https://home-assistant.io/docs/installation/virtualenv/#step-4-set-up-the-virtualenv).
|
||||
You will be in a command shell set up with Python 3.5 as your default version. The virtualenv and pip commands will be correct for this version, so you can now create a virtual environment and install Home Assistant following the main [instructions](https://home-assistant.io/docs/installation/virtualenv/#step-4-set-up-the-virtualenv).
|
||||
|
||||
You will need to enable the software collection each time you log on before you activate your virtual environment.
|
||||
|
||||
### {% linkable_title Systemd with Software Collections %}
|
||||
|
||||
To autostart homeassistant using systemd follow the main [instructions](https://home-assistant.io/docs/autostart/systemd/) and adjust the template as follows:
|
||||
To autostart Home Assistant using systemd follow the main [instructions](https://home-assistant.io/docs/autostart/systemd/) and adjust the template as follows:
|
||||
|
||||
```
|
||||
[Unit]
|
||||
|
||||
@ -70,5 +70,5 @@ $ iptables-save > /etc/network/iptables.rules # your rules may be saved elsewhe
|
||||
After upgrading to a new version, you may notice your browser gets stuck at the "loading data" login screen. Close the window/tab and go into your browser settings and delete all the cookies for your URL. You can then log back in and it should work.
|
||||
|
||||
Android Chrome
|
||||
chrome -> settings -> site settings -> storage -> search for your URL for home assistant-> "clear & reset"
|
||||
chrome -> settings -> site settings -> storage -> search for your URL for Home Assistant-> "clear & reset"
|
||||
|
||||
|
||||
@ -14,4 +14,4 @@ After upgrading to a new version, you may notice your browser gets stuck at the
|
||||
|
||||
Android Chrome
|
||||
|
||||
chrome -> settings -> site settings -> storage -> search for your URL for home assistant-> "clear & reset"
|
||||
chrome -> settings -> site settings -> storage -> search for your URL for Home Assistant-> "clear & reset"
|
||||
|
||||
@ -15,7 +15,7 @@ og_image: /images/blog/2015-10-esp8266-temp/ha-sensor.png
|
||||
|
||||
I recently learned about the ESP8266, a $5 chip that includes WiFi and is Arduino compatible. This means that all your DIY projects can now be done for a fraction of the price.
|
||||
|
||||
For this tutorial, I'll walk through how to get going with ESP8266, get the temperature and humidity and report it to MQTT where Home Asssistant can pick it up.
|
||||
For this tutorial, I'll walk through how to get going with ESP8266, get the temperature and humidity and report it to MQTT where Home Assistant can pick it up.
|
||||
|
||||
<p class='img'>
|
||||
<img src='/images/blog/2015-10-esp8266-temp/setup.png' />
|
||||
|
||||
@ -97,7 +97,7 @@ usps:
|
||||
1) Log in to your Automatic developer account. In the Automatic Developer Apps Manager, specify the OAuth Redirect URL in the developer page. This should be configured to `<home-assistant-url>/api/automatic/callback`. (Example: `http://hassio.local:8123/api/automatic/callback`) Note that this URL only needs to be accessible from the browser you use to perform the authentication.
|
||||
2) Remove username/password from your automatic device tracker configuration in configuration.yaml.
|
||||
3) If you have authorized your account for `scope:current_location`, add `current_location: true` to your automatic device tracker configuration in configuration.yaml.
|
||||
4) When you restart home assistant, click on the Automatic Configure link in the Configurator card, and follow the instructions to authorize Home Assistant.<br><br>NOTE: Automatic's API is currently not correctly authorizing with refresh tokens, so Step 4 currently needs to be performed after every restart. ([@armills] - [#8962] [#9002]) ([configurator docs]) ([device_tracker.automatic docs]) (breaking change)
|
||||
4) When you restart Home Assistant, click on the Automatic Configure link in the Configurator card, and follow the instructions to authorize Home Assistant.<br><br>NOTE: Automatic's API is currently not correctly authorizing with refresh tokens, so Step 4 currently needs to be performed after every restart. ([@armills] - [#8962] [#9002]) ([configurator docs]) ([device_tracker.automatic docs]) (breaking change)
|
||||
|
||||
## All changes
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user