Merge branch 'current' into next
This commit is contained in:
Paulus Schoutsen
commit
2581fb1bcd
71 changed files with 994 additions and 485 deletions
|
|
@ -39,7 +39,7 @@ As "Service Data" we want a simple text that is shown as part of the notificatio
|
|||
}
|
||||
```
|
||||
|
||||
Don't forget to save your new automation rule.
|
||||
Don't forget to save your new automation rule. In order for your saved automation rule to come into effect you will need to go to the **Configuration** page and click on **Reload Automation**.
|
||||
|
||||
## {% linkable_title Updating your configuration to use the editor %}
|
||||
|
||||
|
|
|
|||
|
|
@ -10,7 +10,7 @@ footer: true
|
|||
redirect_from: /getting-started/autostart-systemd/
|
||||
---
|
||||
|
||||
Newer linux distributions are trending towards using `systemd` for managing daemons. Typically, systems based on Fedora, ArchLinux, or Debian (8 or later) use `systemd`. This includes Ubuntu releases including and after 15.04, CentOS, and Red Hat. If you are unsure if your system is using `systemd`, you may check with the following command:
|
||||
Newer Linux distributions are trending towards using `systemd` for managing daemons. Typically, systems based on Fedora, ArchLinux, or Debian (8 or later) use `systemd`. This includes Ubuntu releases including and after 15.04, CentOS, and Red Hat. If you are unsure if your system is using `systemd`, you may check with the following command:
|
||||
|
||||
```bash
|
||||
$ ps -p 1 -o comm=
|
||||
|
|
@ -21,7 +21,7 @@ If the preceding command returns the string `systemd`, continue with the instruc
|
|||
A service file is needed to control Home Assistant with `systemd`. The template below should be created using a text editor. Note, root permissions via `sudo` will likely be needed. The following should be noted to modify the template:
|
||||
|
||||
- `ExecStart` contains the path to `hass` and this may vary. Check with `whereis hass` for the location.
|
||||
- For most systems, the file is `/etc/systemd/system/home-assistant@[your user].service` with [your user] replaced by the user account that Home Assistant will run as - normally `homeassistant`. In particular, this is the case for Ubuntu 16.04.
|
||||
- For most systems, the file is `/etc/systemd/system/home-assistant@[your user].service` with [your user] replaced by the user account that Home Assistant will run as (normally `homeassistant`). In particular, this is the case for Ubuntu 16.04.
|
||||
- If unfamiliar with command-line text editors, `sudo nano -w [filename]` can be used with `[filename]` replaced with the full path to the file. Ex. `sudo nano -w /etc/systemd/system/home-assistant@[your user].service`. After text entered, press CTRL-X then press Y to save and exit.
|
||||
- If you're running Home Assistant in a Python virtual environment or a Docker container, please skip to the appropriate template listed below.
|
||||
|
||||
|
|
@ -127,3 +127,10 @@ Because the log can scroll quite quickly, you can select to view only the error
|
|||
```bash
|
||||
$ sudo journalctl -f -u home-assistant@[your user] | grep -i 'error'
|
||||
```
|
||||
|
||||
When working on Home Assitant, you can easily restart the system and then watch the log output by combining the above commands using `&&`
|
||||
|
||||
```bash
|
||||
$ sudo systemctl restart home-assistant@[your user] && sudo journalctl -f -u home-assistant@[your user]
|
||||
```
|
||||
|
||||
|
|
|
|||
|
|
@ -13,7 +13,7 @@ redirect_from: /getting-started/customizing-devices/
|
|||
By default, all of your devices will be visible and have a default icon determined by their domain. You can customize the look and feel of your front page by altering some of these parameters. This can be done by overriding attributes of specific entities.
|
||||
|
||||
<p class='note'>
|
||||
Be careful not to forget to place `customize`, `customize_domain`, and `customize_glob` inside `homeassistant:` or it will fail.
|
||||
If you implement `customize`, `customize_domain`, or `customize_glob` you must make sure it is done inside of `homeassistant:` or it will fail.
|
||||
</p>
|
||||
|
||||
```yaml
|
||||
|
|
|
|||
|
|
@ -23,8 +23,8 @@ Field | Description
|
|||
`state.domain` | Domain of the entity. Example: `light`.
|
||||
`state.object_id` | Object ID of entity. Example: `kitchen`.
|
||||
`state.name` | Name of the entity. Based on `friendly_name` attribute with fall back to object ID. Example: `Kitchen Ceiling`.
|
||||
`state.last_updated` | Time the state was written to the state machine. Note that writing the exact same state including attributes will not result in this field being updated. Example: `14:10:03 13-03-2016`.
|
||||
`state.last_changed` | Time the state changed. This is not updated when there are only updated attributes. Example: `14:10:03 13-03-2016`.
|
||||
`state.last_updated` | Time the state was written to the state machine. Note that writing the exact same state including attributes will not result in this field being updated. Example: `2017-10-28 08:13:36.715874+00:00`.
|
||||
`state.last_changed` | Time the state changed. This is not updated when there are only updated attributes. Example: `2017-10-28 08:13:36.715874+00:00`.
|
||||
`state.attributes` | A dictionary with extra attributes related to the current state.
|
||||
|
||||
The attributes of an entity are optional. There are a few attributes that are used by Home Assistant for representing the entity in a specific way. Each component will also have it's own attributes to represent extra state data about the entity. For example, the light component has attributes for the current brightness and color of the light. When an attribute is not available, Home Assistant will not write it to the state.
|
||||
|
|
|
|||
|
|
@ -40,8 +40,8 @@ import appdaemon.appapi as appapi
|
|||
class OutsideLights(appapi.AppDaemon):
|
||||
|
||||
def initialize(self):
|
||||
self.run_at_sunrise(self.sunrise_cb, 0)
|
||||
self.run_at_sunset(self.sunset_cb, 0)
|
||||
self.run_at_sunrise(self.sunrise_cb)
|
||||
self.run_at_sunset(self.sunset_cb)
|
||||
|
||||
def sunrise_cb(self, kwargs):
|
||||
self.turn_on(self.args["off_scene"])
|
||||
|
|
|
|||
|
|
@ -44,16 +44,16 @@ When sending a notification:
|
|||
</p>
|
||||
|
||||
## {% linkable_title Definitions %}
|
||||
- Category - A category represents a type of notification that the app might receive. Think of it as a unique group of actions. A categories parameters include:
|
||||
- Action - An action consists of a button title and the information that iOS needs to notify the app when the action is selected. You create separate action objects for distinct action your app supports. An actions parameters include:
|
||||
- Category - A category represents a type of notification that the app might receive. Think of it as a unique group of actions.
|
||||
- Actions - An action consists of a button title and the information that iOS needs to notify the app when the action is selected. You create separate action objects for distinct action your app supports.
|
||||
|
||||
## {% linkable_title Category parameters %}
|
||||
|
||||
- **name** (*Required*): A friendly name for this category.
|
||||
- **identifier** (*Required*): A unique identifier for the category. Must be lowercase and have no special characters or spaces.
|
||||
- **action** (*Required*): A list of actions.
|
||||
- **actions** (*Required*): A list of actions.
|
||||
|
||||
## {% linkable_title Action parameters %}
|
||||
## {% linkable_title Actions parameters %}
|
||||
|
||||
- **identifier** (*Required*): A unique identifier for this action. Must be uppercase and have no special characters or spaces. Only needs to be unique to the category, not unique globally.
|
||||
- **title** (*Required*): The text to display on the button. Keep it short.
|
||||
|
|
|
|||
|
|
@ -10,7 +10,7 @@ footer: true
|
|||
redirect_from: /getting-started/browsers/
|
||||
---
|
||||
|
||||
Home Assistant requires a web browser to show the frontend and supports all major modern browsers. We don't test the web interface against all available browsers but this page tracks different browsers on various operating systems and should help you to pick a browser which works.
|
||||
Home Assistant requires a web browser to show the frontend and supports all major modern browsers. We don't test the web interface against all available browsers but this page tracks different browsers on various operating systems and should help you to pick a browser which works. The "Release" column contains the release number which were tested. This doen't mean that older or newer releases not work.
|
||||
|
||||
If a browser is listed as working but you are still having problems, it is possible that some add-on or extension may be the problem. Some add-ons or extenstion are known to cause issue with the frontend, but it's not possible to test them all. If you are having issues with the frontend displaying correctly, you should disable all your add-ons or extensions and enable them one at a time.
|
||||
|
||||
|
|
@ -37,10 +37,11 @@ We would appreciate if you help to keep this page up-to-date and add feedback.
|
|||
|
||||
| Browser | Release | State | Comments |
|
||||
| :-------------------- |:---------------|:-----------|:-------------------------|
|
||||
| [Firefox] | 55.0 | works | |
|
||||
| [Firefox] | 57.0 | works | |
|
||||
| [Midori] | 0.5.11 | works | |
|
||||
| [Chromium] | 60.0.3112.90 | works | |
|
||||
| [Chromium] | 61.0.3163.100 | works | |
|
||||
| [Conkeror] | 1.0.2 | works | |
|
||||
| [Tor Browser] | 7.0.8 | works | |
|
||||
| [Konqueror] | | unknown | |
|
||||
| [Uzbl] | 0.9.0 | works | |
|
||||
| [Opera] | 42.0.2393.351 | works | |
|
||||
|
|
@ -67,20 +68,22 @@ We would appreciate if you help to keep this page up-to-date and add feedback.
|
|||
|
||||
There are reports that devices running with iOS prior to iOS 10, especially old iPads, are having trouble.
|
||||
|
||||
[Firefox]: https://www.mozilla.org/en-US/firefox/
|
||||
[Midori]: http://midori-browser.org/
|
||||
[Chrome]: https://www.google.com/chrome/
|
||||
[Iridium]: https://iridiumbrowser.de/
|
||||
[Opera]: http://www.opera.com/
|
||||
[Edge]: https://www.microsoft.com/en-us/windows/microsoft-edge
|
||||
[IE]: http://windows.microsoft.com/en-us/internet-explorer/download-ie
|
||||
[Safari]: http://www.apple.com/safari/
|
||||
[Chromium]: https://www.chromium.org/
|
||||
[Conkeror]: http://conkeror.org/
|
||||
[Konqueror]: https://konqueror.org/
|
||||
[Uzbl]: http://www.uzbl.org/
|
||||
[Lynx]: http://lynx.browser.org/
|
||||
[Edge]: https://www.microsoft.com/en-us/windows/microsoft-edge
|
||||
[elinks]: http://elinks.or.cz/
|
||||
[w3m]: http://w3m.sourceforge.net/
|
||||
[Epiphany]: https://wiki.gnome.org/Apps/Web
|
||||
[Firefox]: https://www.mozilla.org/en-US/firefox/
|
||||
[IE]: http://windows.microsoft.com/en-us/internet-explorer/download-ie
|
||||
[Iridium]: https://iridiumbrowser.de/
|
||||
[Konqueror]: https://konqueror.org/
|
||||
[Lynx]: http://lynx.browser.org/
|
||||
[Midori]: http://midori-browser.org/
|
||||
[Opera]: http://www.opera.com/
|
||||
[Safari]: http://www.apple.com/safari/
|
||||
[surf]: http://surf.suckless.org/
|
||||
[Tor Browser]: https://www.torproject.org/
|
||||
[Uzbl]: http://www.uzbl.org/
|
||||
[w3m]: http://w3m.sourceforge.net/
|
||||
|
||||
|
|
|
|||
|
|
@ -17,6 +17,10 @@ The easiest way to install Home Assistant on your Raspberry Pi is by using HASSb
|
|||
3. Ensure your Raspberry Pi has wired access to the internet for the entire process or configure your wireless network settings **before proceeding to step 4**.
|
||||
4. Insert SD card to Raspberry Pi and turn it on. Initial installation of Home Assistant will take about 5 minutes.
|
||||
|
||||
<p class='note'>
|
||||
Please remember to ensure you're using an [appropriate power supply](https://www.raspberrypi.org/help/faqs/#powerReqs) with your Pi. Mobile chargers may not be suitable, since some are designed to only provide the full power with that manufacturer's handsets.
|
||||
</p>
|
||||
|
||||
These instructions are also available as a [video](https://www.youtube.com/watch?v=iIz6XqDwHEk). Additional information is available in this [video](https://www.youtube.com/watch?v=tCGlQSsQ-Mc).
|
||||
|
||||
After initial boot an installer will run in the background and takes around 15 minutes to complete, after it has finished, you will be prompted to login: `hassbian login:`. Installation is complete at this point. The default username is `pi` and the password is `raspberry`.
|
||||
|
|
|
|||
|
|
@ -10,7 +10,11 @@ redirect_from: /getting-started/installation-raspberry-pi-all-in-one/
|
|||
|
||||
The [Raspberry Pi All-In-One Installer](https://github.com/home-assistant/fabric-home-assistant) deploys a complete Home Assistant server including support for MQTT with websockets, Z-Wave, and the OpenZWave Control Panel.
|
||||
|
||||
The only requirement is that you have a Raspberry Pi with a fresh installation of [Raspbian](https://www.raspberrypi.org/downloads/raspbian/) connected to your network.
|
||||
<p class='note'>
|
||||
Please remember to ensure you're using an [appropriate power supply](https://www.raspberrypi.org/help/faqs/#powerReqs) with your Pi. Mobile chargers may not be suitable, since some are designed to only provide the full power with that manufacturer's handsets.
|
||||
</p>
|
||||
|
||||
The only requirement is that you have a Raspberry Pi with a fresh installation of [Raspbian](https://www.raspberrypi.org/downloads/raspbian/) Jessie (Stretch is not supported at this time) connected to your network.
|
||||
|
||||
<p class='note'>
|
||||
Note that as of 2016-11-30 SSH is disabled by default in the official Raspbian images. Adding an empty file called `ssh` to `/boot/` on the FAT32 partition will enable it. More information is on the Raspberry Pi Foundation [Blog](https://www.raspberrypi.org/blog/page/2/?fish#a-security-update-for-raspbian-pixel).
|
||||
|
|
|
|||
|
|
@ -42,7 +42,7 @@ $ sudo usermod -G dialout -a homeassistant
|
|||
|
||||
### {% linkable_title Step 2: Create a directory for Home Assistant %}
|
||||
|
||||
This can be anywhere you want. As example we put it in `/srv`. You also need to change the ownership of the directory to the user you created above (if you created one).
|
||||
This can be anywhere you want. We chose to put it in `/srv`. You also need to change the ownership of the directory to the user you created above (if you created one).
|
||||
|
||||
```bash
|
||||
$ sudo mkdir /srv/homeassistant
|
||||
|
|
|
|||
|
|
@ -9,24 +9,31 @@ sharing: true
|
|||
footer: true
|
||||
---
|
||||
|
||||
To add (include) a Z-Wave [device](/docs/z-wave/devices/) to your system, go to the [Z-Wave control panel](/docs/z-wave/control-panel/) in the Home Assistant frontend and click the **Add Node** button in the *Z-Wave Network Management* card. This will place the controller in inclusion mode, after which you should activate your device to be included by following the instructions provided with the device.
|
||||
## {% linkable_title Adding Non-Secure Devices %}
|
||||
|
||||
<p class='warning'>
|
||||
To add (include) a non-secure Z-Wave [device](/docs/z-wave/devices/) to your system, go to the [Z-Wave control panel](/docs/z-wave/control-panel/) in the Home Assistant frontend and click the **Add Node** button in the *Z-Wave Network Management* card. This will place the controller in inclusion mode, after which you should activate your device to be included by following the instructions provided with the device. Don't use this for secure devices, since this is likely to limit the features the device supports.
|
||||
|
||||
<p class='note warning'>
|
||||
Don't use the OpenZWave control panel (OZWCP), or the physical button on a controller, to add or remove devices. Many devices will only send the information about their capabilities at the time you include them. If you use the OpenZWave control panel, or the button on a device, then Home Assistant won't have that information. Using the physical button on a controller will also result in a non-security inclusion being performed, which may limit the features the device supports.
|
||||
</p>
|
||||
|
||||
When you add a device, it may initially appear without a specific entity ID (eg `zwave.__`) and without other identifying information. Running a *Heal* should help speed this process up, and you'll need to run a *Heal* anyway so that all the devices in your Z-Wave network learn about the new device. You *might* need to restart Home Assistant (not reboot the system) to have the entity ID fully visible.
|
||||
|
||||
## {% linkable_title Adding Security Devices %}
|
||||
## {% linkable_title Adding Secure Devices %}
|
||||
|
||||
Security Z-Wave devices require a network key before being added to the network using the Add Secure Node button in the Z-Wave Network Management card. You must set the *network_key* configuration variable to use a network key before adding these devices. Some devices only expose their full capabilities when included this way, you should always read the manual for your device to find out the recommended inclusion method.
|
||||
Security Z-Wave devices require a network key before being added to the network using the **Add Secure Node** button in the Z-Wave Network Management card. You must set the *network_key* configuration variable to use a network key before adding these devices. Some devices only expose their full capabilities when included this way, you should always read the manual for your device to find out the recommended inclusion method.
|
||||
|
||||
An easy script to generate a random key:
|
||||
```bash
|
||||
cat /dev/urandom | tr -dc '0-9A-F' | fold -w 32 | head -n 1 | sed -e 's/\(..\)/0x\1, /g' -e 's/, $//'
|
||||
```
|
||||
|
||||
<p class='warning'>
|
||||
On macOS, this script will generate a random key:
|
||||
```bash
|
||||
cat /dev/urandom | LC_CTYPE=C tr -dc '0-9A-F' | fold -w 32 | head -n 1 | sed -e 's/\(..\)/0x\1, /g' -e 's/, $//'
|
||||
```
|
||||
|
||||
<p class='note warning'>
|
||||
Ensure you keep a backup of this key. If you have to rebuild your system and don't have a backup of this key, you won't be able to reconnect to any security devices. This may mean you have to do a factory reset on those devices, and your controller, before rebuilding your Z-Wave network.
|
||||
</p>
|
||||
|
||||
|
|
|
|||
|
|
@ -26,6 +26,10 @@ You need to have a [supported Z-Wave USB stick or module](https://github.com/Ope
|
|||
| Vision USB Stick | | | |
|
||||
| ZWave.me UZB1 | ✓ | | |
|
||||
|
||||
<p class='note'>
|
||||
If you're using Hass.io, it's recommended to use a USB stick, not a module. Passing a module through Docker is more complicated than passing a USB stick through.
|
||||
</p>
|
||||
|
||||
## {% linkable_title Stick Alternatives %}
|
||||
|
||||
The alternative to a stick is a hub that supports Z-Wave. Home Assistant supports the following hubs with Z-Wave support:
|
||||
|
|
|
|||
|
|
@ -155,3 +155,4 @@ Double tap off|2|3
|
|||
Triple tap on|1|4
|
||||
Triple tap off|2|4
|
||||
Tap and hold on|1|2
|
||||
Tap and hold off|2|2
|
||||
|
|
|
|||
|
|
@ -25,7 +25,7 @@ This is for a single purpose sensor, multi sensors are explained under Multi Sen
|
|||
|
||||
Devices (usually sensors) that support the Alarm command class will create entities starting with `sensor`, and with some generic suffixes, and a suffix that relates to the supported alarm class. For example, the smoke detector `lounge` will have an entity `sensor.lounge_smoke`, and possibly also `sensor.lounge_alarm_type` and `sensor.lounge_alarm_level`. If the device creates a `binary_sensor` entity, it is recommended to use that rather then the `sensor` entity.
|
||||
|
||||
### {% linkable_title Alarm Type %}
|
||||
### {% linkable_title Alarm Type Entity %}
|
||||
|
||||
- **alarm_type**: Reports the type of the sensor
|
||||
- **0**: General purpose
|
||||
|
|
@ -36,7 +36,7 @@ Devices (usually sensors) that support the Alarm command class will create entit
|
|||
- **5**: Water leak sensor
|
||||
- **6**: Access control
|
||||
|
||||
### {% linkable_title Alarm Level %}
|
||||
### {% linkable_title Alarm Level Entity %}
|
||||
|
||||
The meaning of the `alarm_level` entity depends on the nature of the alarm sensor
|
||||
|
||||
|
|
@ -111,7 +111,7 @@ The meaning of the `alarm_level` entity depends on the nature of the alarm senso
|
|||
- **1**: Wake up
|
||||
- **254**: Unknown event
|
||||
|
||||
### {% linkable_title Access Control %}
|
||||
### {% linkable_title Access Control Entity %}
|
||||
|
||||
- **access_control**: These *may* vary between brands
|
||||
- **22**: Open
|
||||
|
|
@ -135,7 +135,7 @@ binary_sensor:
|
|||
{%- endif -%}{% endraw %}
|
||||
```
|
||||
|
||||
### {% linkable_title Burglar %}
|
||||
### {% linkable_title Burglar Entity %}
|
||||
|
||||
- **burglar**: These *may* vary between brands
|
||||
- **0**: Not active
|
||||
|
|
@ -163,7 +163,7 @@ binary_sensor:
|
|||
{%- endif -%}{% endraw %}
|
||||
```
|
||||
|
||||
### {% linkable_title Source Node ID %}
|
||||
### {% linkable_title Source Node ID Entity %}
|
||||
|
||||
- **sourcenodeid**: Reports the sensor that generated the alarm - this is only valid for Zensor Net based devices
|
||||
|
||||
|
|
|
|||
|
|
@ -16,6 +16,8 @@ On Linux platforms (other than Hass.io) there is one dependency you will need to
|
|||
$ sudo apt-get install libudev-dev
|
||||
```
|
||||
|
||||
On Python 3.6 you may also have to install libpython3.6-dev, and possibly python3.6-dev.
|
||||
|
||||
When installing on macOS you may have to also run the command below ahead of time, replace "x.x" with the version of Python (`$ python3 --version`) you have installed.
|
||||
|
||||
```bash
|
||||
|
|
@ -104,7 +106,7 @@ device_config:
|
|||
|
||||
### {% linkable_title Finding the controller path on Linux %}
|
||||
|
||||
<p class='note'
|
||||
<p class='note'>
|
||||
If you're using Hass.io please follow [these setup instructions](/hassio/zwave/) for finding the controller path.
|
||||
</p>
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue