mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-21 16:27:19 +00:00
Merge branch 'current' into next
This commit is contained in:
commit
6a460da759
@ -13,6 +13,7 @@
|
|||||||
"ABB Solar PV",
|
"ABB Solar PV",
|
||||||
"ABB",
|
"ABB",
|
||||||
"Abode",
|
"Abode",
|
||||||
|
"AC",
|
||||||
"Acer",
|
"Acer",
|
||||||
"Actiontec",
|
"Actiontec",
|
||||||
"AdGuard Home",
|
"AdGuard Home",
|
||||||
@ -46,6 +47,7 @@
|
|||||||
"APC Smart UPS",
|
"APC Smart UPS",
|
||||||
"apcupsd",
|
"apcupsd",
|
||||||
"APNS",
|
"APNS",
|
||||||
|
"AppDaemon",
|
||||||
"Apple iCloud",
|
"Apple iCloud",
|
||||||
"Apple TV",
|
"Apple TV",
|
||||||
"AppleScript",
|
"AppleScript",
|
||||||
@ -65,27 +67,43 @@
|
|||||||
"AVM FRITZ!Box",
|
"AVM FRITZ!Box",
|
||||||
"AWS",
|
"AWS",
|
||||||
"Axis",
|
"Axis",
|
||||||
|
"BeagleBone",
|
||||||
"Beckhoff",
|
"Beckhoff",
|
||||||
|
"Belkin",
|
||||||
|
"Bluetooth",
|
||||||
|
"Bosch",
|
||||||
"Bravia",
|
"Bravia",
|
||||||
"BSSID",
|
"BSSID",
|
||||||
|
"CalDAV",
|
||||||
|
"CardDAV",
|
||||||
"Cisco IOS",
|
"Cisco IOS",
|
||||||
|
"Daikin",
|
||||||
|
"Danfoss",
|
||||||
"Dark Sky",
|
"Dark Sky",
|
||||||
"Debian",
|
"Debian",
|
||||||
"deCONZ",
|
"deCONZ",
|
||||||
"DNS",
|
"DNS",
|
||||||
"Docker Hub",
|
"Docker Hub",
|
||||||
"Docker",
|
"Docker",
|
||||||
|
"DSMR",
|
||||||
"ecobee",
|
"ecobee",
|
||||||
|
"Efergy",
|
||||||
"Elgato Key Light",
|
"Elgato Key Light",
|
||||||
"Elgato",
|
"Elgato",
|
||||||
"Emoncms",
|
"Emoncms",
|
||||||
"Entur",
|
"Entur",
|
||||||
|
"EPH Controls",
|
||||||
|
"eQ-3 MAX\\!",
|
||||||
|
"eQ-3",
|
||||||
"ESPHome",
|
"ESPHome",
|
||||||
|
"Essent",
|
||||||
"Everspring",
|
"Everspring",
|
||||||
"FFmpeg",
|
"FFmpeg",
|
||||||
"Fibaro",
|
"Fibaro",
|
||||||
|
"Flexit",
|
||||||
"FreeNAS",
|
"FreeNAS",
|
||||||
"FRITZ!Box",
|
"FRITZ!Box",
|
||||||
|
"Genius Hub",
|
||||||
"GitHub",
|
"GitHub",
|
||||||
"Google Assistant",
|
"Google Assistant",
|
||||||
"Google Home",
|
"Google Home",
|
||||||
@ -93,6 +111,8 @@
|
|||||||
"Google",
|
"Google",
|
||||||
"GraphiQL",
|
"GraphiQL",
|
||||||
"GraphQL",
|
"GraphQL",
|
||||||
|
"Growatt",
|
||||||
|
"Heatmiser",
|
||||||
"Home Assistant Companion",
|
"Home Assistant Companion",
|
||||||
"Home Assistant Core",
|
"Home Assistant Core",
|
||||||
"Home Assistant Operating System",
|
"Home Assistant Operating System",
|
||||||
@ -101,9 +121,11 @@
|
|||||||
"Home Assistant Supervisor",
|
"Home Assistant Supervisor",
|
||||||
"Home Assistant",
|
"Home Assistant",
|
||||||
"HomeKit",
|
"HomeKit",
|
||||||
|
"Homematic",
|
||||||
"Honeywell",
|
"Honeywell",
|
||||||
"HTTP",
|
"HTTP",
|
||||||
"HTTPS",
|
"HTTPS",
|
||||||
|
"HVAC",
|
||||||
"iCloud",
|
"iCloud",
|
||||||
"IFTTT",
|
"IFTTT",
|
||||||
"IKEA",
|
"IKEA",
|
||||||
@ -111,11 +133,17 @@
|
|||||||
"iOS",
|
"iOS",
|
||||||
"IoT",
|
"IoT",
|
||||||
"IP",
|
"IP",
|
||||||
|
"iPad",
|
||||||
|
"iPhone",
|
||||||
"ISY994",
|
"ISY994",
|
||||||
"iTunes",
|
"iTunes",
|
||||||
|
"JSON-RPC",
|
||||||
"JSON",
|
"JSON",
|
||||||
|
"JuiceNet",
|
||||||
"Kafka",
|
"Kafka",
|
||||||
"KEF",
|
"KEF",
|
||||||
|
"KNX",
|
||||||
|
"LaCrosse",
|
||||||
"LED",
|
"LED",
|
||||||
"Let's Encrypt",
|
"Let's Encrypt",
|
||||||
"Life360",
|
"Life360",
|
||||||
@ -123,6 +151,7 @@
|
|||||||
"Linky",
|
"Linky",
|
||||||
"Linux",
|
"Linux",
|
||||||
"Lovelace",
|
"Lovelace",
|
||||||
|
"LTE",
|
||||||
"MacBook",
|
"MacBook",
|
||||||
"macOS",
|
"macOS",
|
||||||
"Markdown",
|
"Markdown",
|
||||||
@ -131,31 +160,48 @@
|
|||||||
"MIME",
|
"MIME",
|
||||||
"MJPEG",
|
"MJPEG",
|
||||||
"MQTT",
|
"MQTT",
|
||||||
|
"MySensors",
|
||||||
"NAS",
|
"NAS",
|
||||||
|
"NETGEAR",
|
||||||
"Network Information Server",
|
"Network Information Server",
|
||||||
"NGINX",
|
"NGINX",
|
||||||
"NodeMCU",
|
"NodeMCU",
|
||||||
"Norway",
|
"Norway",
|
||||||
|
"NuHeat",
|
||||||
|
"NZBGet",
|
||||||
|
"OpenTherm",
|
||||||
"OpenWrt",
|
"OpenWrt",
|
||||||
"PayPal",
|
"PayPal",
|
||||||
"PDU",
|
"PDU",
|
||||||
|
"Philips Hue",
|
||||||
"Philips",
|
"Philips",
|
||||||
"PlayStation",
|
"PlayStation",
|
||||||
"Plex Media Server",
|
"Plex Media Server",
|
||||||
"Plex",
|
"Plex",
|
||||||
"PTZ",
|
"PTZ",
|
||||||
|
"pyLoad",
|
||||||
|
"Python",
|
||||||
|
"qBittorrent",
|
||||||
|
"Radarr",
|
||||||
|
"Raspberry Pi",
|
||||||
|
"Remember The Milk",
|
||||||
"REST API",
|
"REST API",
|
||||||
"RFXtrx",
|
"RFXtrx",
|
||||||
"RouterOS",
|
"RouterOS",
|
||||||
|
"rTorrent",
|
||||||
"RTSP",
|
"RTSP",
|
||||||
|
"SABnzbd",
|
||||||
"Samung",
|
"Samung",
|
||||||
|
"Sensibo",
|
||||||
"Sentry",
|
"Sentry",
|
||||||
|
"Siemens",
|
||||||
"Signal Messenger",
|
"Signal Messenger",
|
||||||
"SkyBell",
|
"SkyBell",
|
||||||
"Slack",
|
"Slack",
|
||||||
"SleepIQ",
|
"SleepIQ",
|
||||||
"SmartThings",
|
"SmartThings",
|
||||||
"SMS",
|
"SMS",
|
||||||
|
"Sonarr",
|
||||||
"Sonos",
|
"Sonos",
|
||||||
"Sony",
|
"Sony",
|
||||||
"Spotify",
|
"Spotify",
|
||||||
@ -169,8 +215,10 @@
|
|||||||
"Sure Petcare",
|
"Sure Petcare",
|
||||||
"SwitchBot",
|
"SwitchBot",
|
||||||
"Synology",
|
"Synology",
|
||||||
|
"Tado",
|
||||||
"Tahoma",
|
"Tahoma",
|
||||||
"TCP/IP",
|
"TCP/IP",
|
||||||
|
"TensorFlow",
|
||||||
"Tesla",
|
"Tesla",
|
||||||
"TMB",
|
"TMB",
|
||||||
"Todoist",
|
"Todoist",
|
||||||
@ -201,11 +249,15 @@
|
|||||||
"VIVOTEK",
|
"VIVOTEK",
|
||||||
"Vizio",
|
"Vizio",
|
||||||
"Vultr",
|
"Vultr",
|
||||||
|
"WebDAV",
|
||||||
|
"WeMo",
|
||||||
"Wink",
|
"Wink",
|
||||||
"WLED",
|
"WLED",
|
||||||
"Wunderlist",
|
"Wunderlist",
|
||||||
"WWLLN",
|
"WWLLN",
|
||||||
"Xiaomi",
|
"Xiaomi",
|
||||||
|
"XML-RPC",
|
||||||
|
"XML",
|
||||||
"Yamaha MusicCast",
|
"Yamaha MusicCast",
|
||||||
"Yamaha",
|
"Yamaha",
|
||||||
"YAML",
|
"YAML",
|
||||||
@ -223,32 +275,44 @@
|
|||||||
["2 ?steps? authentication", "two-step authentication"],
|
["2 ?steps? authentication", "two-step authentication"],
|
||||||
["Alarm ?dot ?com", "Alarm.com"],
|
["Alarm ?dot ?com", "Alarm.com"],
|
||||||
["an URL", "a URL"],
|
["an URL", "a URL"],
|
||||||
|
["analyse", "analyze"],
|
||||||
["API['’]?s", "APIs"],
|
["API['’]?s", "APIs"],
|
||||||
["backwards compatible", "backward compatible"],
|
["backwards compatible", "backward compatible"],
|
||||||
|
["behaviour", "behavior"],
|
||||||
|
["cancelled", "canceled"],
|
||||||
["client ?side", "client-side"],
|
["client ?side", "client-side"],
|
||||||
["colour", "color"],
|
["colour", "color"],
|
||||||
|
["config\\b", "configuration"],
|
||||||
["DarkSky", "Dark Sky"],
|
["DarkSky", "Dark Sky"],
|
||||||
["end ?to ?end", "end-to-end"],
|
["end ?to ?end", "end-to-end"],
|
||||||
["FRITZ!? ?Box", "FRITZ!Box"],
|
["FRITZ!? ?Box", "FRITZ!Box"],
|
||||||
|
["grey", "gray"],
|
||||||
|
["Hass\\.?io", "Home Assistant"],
|
||||||
["hass", "Home Assistant"],
|
["hass", "Home Assistant"],
|
||||||
|
["HassOS", "Home Assistant Operating System"],
|
||||||
["he or she", "they"],
|
["he or she", "they"],
|
||||||
["he/she", "they"],
|
["he/she", "they"],
|
||||||
["Home-?Ass?s?iss?tt?ant", "Home Assistant"],
|
["Home-?Ass?s?iss?tt?ant", "Home Assistant"],
|
||||||
["ISY ?994", "ISY994"],
|
["ISY ?994", "ISY994"],
|
||||||
|
["licence", "license"],
|
||||||
|
["licences", "licenses"],
|
||||||
["Mac ?OS", "macOS"],
|
["Mac ?OS", "macOS"],
|
||||||
|
["millimetre", "millimeter"],
|
||||||
|
["motorised", "motorized"],
|
||||||
|
["optimising", "optimizing"],
|
||||||
["OS ?X", "macOS"],
|
["OS ?X", "macOS"],
|
||||||
|
["RaspberryPi", "Raspberry Pi"],
|
||||||
|
["recognise", "recognize"],
|
||||||
|
["recognised", "recognized"],
|
||||||
["repo\\b", "repository"],
|
["repo\\b", "repository"],
|
||||||
["config\\b", "configuration"],
|
["rpi", "Raspberry Pi"],
|
||||||
["Sky Bell", "SkyBell"],
|
["Sky Bell", "SkyBell"],
|
||||||
["Sleep IQ", "SleepIQ"],
|
["Sleep IQ", "SleepIQ"],
|
||||||
["Twill?o", "Twilio"],
|
|
||||||
["analyse", "analyze"],
|
|
||||||
["recognise", "recognize"],
|
|
||||||
["travelled", "traveled"],
|
["travelled", "traveled"],
|
||||||
["licence", "license"],
|
["Twill?o", "Twilio"],
|
||||||
["behaviour", "behavior"],
|
|
||||||
["two ?steps? authentication", "two-step authentication"],
|
["two ?steps? authentication", "two-step authentication"],
|
||||||
["URL['’]?s", "URLs"],
|
["URL['’]?s", "URLs"],
|
||||||
|
["XMLRPC", "XML-RPC"],
|
||||||
["ZWave", "Z-Wave"]
|
["ZWave", "Z-Wave"]
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
|
@ -25,14 +25,14 @@ Before beginning make sure that you have the following:
|
|||||||
- A functional Asterisk PBX setup which is using the default `voicemail` application.
|
- A functional Asterisk PBX setup which is using the default `voicemail` application.
|
||||||
- Both Home Assistant and Asterisk PBX running on the same LAN (or the same server).
|
- Both Home Assistant and Asterisk PBX running on the same LAN (or the same server).
|
||||||
- The Asterisk PBX server has Python 3.5 or newer installed.
|
- The Asterisk PBX server has Python 3.5 or newer installed.
|
||||||
- Administrator access on the Asterisk PBX (for python module installation).
|
- Administrator access on the Asterisk PBX (for Python module installation).
|
||||||
- Account access to the `asterisk` user that runs the Asterisk PBX software.
|
- Account access to the `asterisk` user that runs the Asterisk PBX software.
|
||||||
|
|
||||||
### Installation
|
### Installation
|
||||||
|
|
||||||
1. Apply for a Google API key to enable speech-transcription services
|
1. Apply for a Google API key to enable speech-transcription services
|
||||||
|
|
||||||
2. Install the `asterisk_mbox_server` python module:
|
2. Install the `asterisk_mbox_server` Python module:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
pip3 install asterisk_mbox_server
|
pip3 install asterisk_mbox_server
|
||||||
|
@ -15,9 +15,8 @@ If you are starting Home Assistant for the first time, or you have logged out, y
|
|||||||
|
|
||||||
When you start Home Assistant for the first time the _owner_ user account is created. This account has some special privileges and can:
|
When you start Home Assistant for the first time the _owner_ user account is created. This account has some special privileges and can:
|
||||||
|
|
||||||
- Create and manage other user accounts.
|
- Create and manage other user accounts.
|
||||||
- Configure integrations and other settings (coming soon).
|
- Configure integrations and other settings (coming soon).
|
||||||
- Configure Hass.io (coming soon).
|
|
||||||
|
|
||||||
<div class='note'>
|
<div class='note'>
|
||||||
For the moment, other user accounts will have the same access as the owner account. In the future, non-owner accounts will be able to have restrictions applied.
|
For the moment, other user accounts will have the same access as the owner account. In the future, non-owner accounts will be able to have restrictions applied.
|
||||||
@ -78,11 +77,11 @@ INFO (MainThread) [homeassistant.components.http.auth] You need to use a bearer
|
|||||||
|
|
||||||
While you should hopefully be storing your passwords in a password manager, if you lose the password associated with the owner account the only way to resolve this is to delete *all* the authentication data. You do this by shutting down Home Assistant and deleting the following files from the `.storage/` folder in your [configuration folder](/docs/configuration/):
|
While you should hopefully be storing your passwords in a password manager, if you lose the password associated with the owner account the only way to resolve this is to delete *all* the authentication data. You do this by shutting down Home Assistant and deleting the following files from the `.storage/` folder in your [configuration folder](/docs/configuration/):
|
||||||
|
|
||||||
* `auth`
|
- `auth`
|
||||||
* `auth_provider.homeassistant`
|
- `auth_provider.homeassistant`
|
||||||
* `onboarding`
|
- `onboarding`
|
||||||
* `hassio` (for Hass.io users)
|
- `hassio`
|
||||||
* `cloud` (for nabucasa users)
|
- `cloud`
|
||||||
|
|
||||||
When you start Home Assistant next, you'll be required to set up authentication again.
|
When you start Home Assistant next, you'll be required to set up authentication again.
|
||||||
|
|
||||||
|
@ -9,13 +9,13 @@ The web interface can be found at `http://ip.ad.dre.ss:8123/` - for example if y
|
|||||||
|
|
||||||
The location of the folder differs between operating systems:
|
The location of the folder differs between operating systems:
|
||||||
|
|
||||||
| OS | Path |
|
| OS | Path |
|
||||||
| ------- | -------------------------- |
|
| -------------- | -------------------------- |
|
||||||
| macOS | `~/.homeassistant` |
|
| Home Assistant | `/config` |
|
||||||
| Linux | `~/.homeassistant` |
|
| Docker | `/config` |
|
||||||
| Windows | `%APPDATA%/.homeassistant` |
|
| macOS | `~/.homeassistant` |
|
||||||
| Hass.io | `/config` |
|
| Linux | `~/.homeassistant` |
|
||||||
| Docker | `/config` |
|
| Windows | `%APPDATA%/.homeassistant` |
|
||||||
|
|
||||||
If you want to use a different folder for configuration, use the configuration command line parameter: `hass --config path/to/config`.
|
If you want to use a different folder for configuration, use the configuration command line parameter: `hass --config path/to/config`.
|
||||||
|
|
||||||
|
@ -20,8 +20,8 @@ If you have incorrect entries in your configuration files you can use the [`chec
|
|||||||
|
|
||||||
One of the most common problems with Home Assistant is an invalid `configuration.yaml` or other configuration file.
|
One of the most common problems with Home Assistant is an invalid `configuration.yaml` or other configuration file.
|
||||||
|
|
||||||
- You can test your configuration using the command line with: `hass --script check_config`.
|
- With Home Assistant you can use the [`ha` command](/hassio/commandline/#home-assistant): `ha core check`.
|
||||||
- On Hass.io you can use the [`hassio` command](/hassio/commandline/#home-assistant): `hassio homeassistant check`.
|
- You can test your configuration with Home Assistant Core using the command line with: `hass --script check_config`.
|
||||||
- On Docker you can use `docker exec home-assistant python -m homeassistant --script check_config --config /config` - where `home-assistant` is the name of the container.
|
- On Docker you can use `docker exec home-assistant python -m homeassistant --script check_config --config /config` - where `home-assistant` is the name of the container.
|
||||||
- The configuration files, including `configuration.yaml` must be UTF-8 encoded. If you see error like `'utf-8' codec can't decode byte`, edit the offending configuration and re-save it as UTF-8.
|
- The configuration files, including `configuration.yaml` must be UTF-8 encoded. If you see error like `'utf-8' codec can't decode byte`, edit the offending configuration and re-save it as UTF-8.
|
||||||
- You can verify your configuration's YAML structure using [this online YAML parser](http://yaml-online-parser.appspot.com/) or [YAML Lint](http://www.yamllint.com/).
|
- You can verify your configuration's YAML structure using [this online YAML parser](http://yaml-online-parser.appspot.com/) or [YAML Lint](http://www.yamllint.com/).
|
||||||
|
@ -66,7 +66,9 @@ sensor:
|
|||||||
|
|
||||||
### Environmental variables
|
### Environmental variables
|
||||||
|
|
||||||
You can include values from your system's environment variables with `!env_var`. Note that this will only work in a scenario where it is possible to specify these. Hass.io users are recommended to use `!include` statements instead.
|
On Home Assistant Core installations, you can include values from your system's environment variables with `!env_var`.
|
||||||
|
Note that this will only work for Home Assistant Core installations, in a scenario where it is possible to specify these.
|
||||||
|
Regular Home Assistant users are recommended to use `!include` statements instead.
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
example:
|
example:
|
||||||
|
@ -4,7 +4,7 @@ description: "AppDaemon is a loosely coupled, multithreaded, sandboxed Python ex
|
|||||||
redirect_from: /ecosystem/appdaemon/
|
redirect_from: /ecosystem/appdaemon/
|
||||||
---
|
---
|
||||||
|
|
||||||
AppDaemon is a loosely coupled, multithreaded, sandboxed python execution environment for writing automation apps for Home Assistant.
|
AppDaemon is a loosely coupled, multithreaded, sandboxed Python execution environment for writing automation apps for Home Assistant.
|
||||||
|
|
||||||
# Another Take on Automation
|
# Another Take on Automation
|
||||||
|
|
||||||
|
@ -364,7 +364,7 @@ There are 3 types of callbacks within AppDaemon:
|
|||||||
|
|
||||||
- State Callbacks - react to a change in state
|
- State Callbacks - react to a change in state
|
||||||
- Scheduler Callbacks - react to a specific time or interval
|
- Scheduler Callbacks - react to a specific time or interval
|
||||||
- Event Callbacks - react to specific Home Assistant and Appdaemon events.
|
- Event Callbacks - react to specific Home Assistant and AppDaemon events.
|
||||||
|
|
||||||
All callbacks allow the user to specify additional parameters to be handed to the callback via the standard Python `**kwargs` mechanism for greater flexibility.
|
All callbacks allow the user to specify additional parameters to be handed to the callback via the standard Python `**kwargs` mechanism for greater flexibility.
|
||||||
|
|
||||||
@ -1712,7 +1712,7 @@ if self.noone_home():
|
|||||||
|
|
||||||
### time()
|
### time()
|
||||||
|
|
||||||
Returns a python `time` object representing the current time. Use this in preference to the standard Python ways to discover the current time, especially when using the "Time Travel" feature for testing.
|
Returns a Python `time` object representing the current time. Use this in preference to the standard Python ways to discover the current time, especially when using the "Time Travel" feature for testing.
|
||||||
|
|
||||||
#### Synopsis
|
#### Synopsis
|
||||||
|
|
||||||
@ -1736,7 +1736,7 @@ now = self.time()
|
|||||||
|
|
||||||
### date()
|
### date()
|
||||||
|
|
||||||
Returns a python `date` object representing the current date. Use this in preference to the standard Python ways to discover the current date, especially when using the "Time Travel" feature for testing.
|
Returns a Python `date` object representing the current date. Use this in preference to the standard Python ways to discover the current date, especially when using the "Time Travel" feature for testing.
|
||||||
|
|
||||||
#### Synopsis
|
#### Synopsis
|
||||||
|
|
||||||
@ -1760,7 +1760,7 @@ today = self.date()
|
|||||||
|
|
||||||
### datetime()
|
### datetime()
|
||||||
|
|
||||||
Returns a python `datetime` object representing the current date and time. Use this in preference to the standard Python ways to discover the current time, especially when using the "Time Travel" feature for testing.
|
Returns a Python `datetime` object representing the current date and time. Use this in preference to the standard Python ways to discover the current time, especially when using the "Time Travel" feature for testing.
|
||||||
|
|
||||||
#### Synopsis
|
#### Synopsis
|
||||||
|
|
||||||
@ -2130,4 +2130,4 @@ $ appdaemon -s "2016-06-06 19:16:00" -s "2016-06-06 20:16:00" -t 0
|
|||||||
|
|
||||||
### A Note on Times
|
### A Note on Times
|
||||||
|
|
||||||
Some Apps you write may depend on checking times of events relative to the current time. If you are time traveling this will not work if you use standard python library calls to get the current time and date etc. For this reason, always use the AppDamon supplied `time()`, `date()` and `datetime()` calls, documented earlier. These calls will consult with AppDaemon's internal time rather than the actual time and give you the correct values.
|
Some Apps you write may depend on checking times of events relative to the current time. If you are time traveling this will not work if you use standard Python library calls to get the current time and date etc. For this reason, always use the AppDamon supplied `time()`, `date()` and `datetime()` calls, documented earlier. These calls will consult with AppDaemon's internal time rather than the actual time and give you the correct values.
|
||||||
|
@ -4,6 +4,6 @@ description: "AppDaemon Configuration"
|
|||||||
redirect_from: /ecosystem/appdaemon/configuration/
|
redirect_from: /ecosystem/appdaemon/configuration/
|
||||||
---
|
---
|
||||||
|
|
||||||
the documentation for configuring Appdaemon can be found in its own documentation.
|
the documentation for configuring AppDaemon can be found in its own documentation.
|
||||||
|
|
||||||
https://appdaemon.readthedocs.io/en/latest/CONFIGURE.html
|
https://appdaemon.readthedocs.io/en/latest/CONFIGURE.html
|
||||||
|
@ -5,7 +5,8 @@ description: "A guide to remotely accessing Home Assistant and securing the conn
|
|||||||
|
|
||||||
<div class='note'>
|
<div class='note'>
|
||||||
|
|
||||||
If you are using Hass.io do not use this guide. Instead, use the [DuckDNS add-on](/addons/duckdns/) for Hass.io.
|
This guide is for users running Home Assistant Core.
|
||||||
|
If you are using Home Assistant do not use this guide. Instead, use the [DuckDNS add-on](/addons/duckdns/) for Home Assistant.
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
@ -26,11 +26,11 @@ The certificate **must** be `.pem` extension.
|
|||||||
openssl req -sha256 -newkey rsa:4096 -nodes -keyout privkey.pem -x509 -days 730 -out fullchain.pem
|
openssl req -sha256 -newkey rsa:4096 -nodes -keyout privkey.pem -x509 -days 730 -out fullchain.pem
|
||||||
```
|
```
|
||||||
|
|
||||||
For details about the parameters, please check the OpenSSL documentation. Provide the requested information during the generation process.
|
For details about the parameters, please check the OpenSSL documentation. Provide the requested information during the generation process.
|
||||||
|
|
||||||
At the end you will have two files called `privkey.pem` and `fullchain.pem`. The key and the certificate.
|
At the end you will have two files called `privkey.pem` and `fullchain.pem`. The key and the certificate.
|
||||||
|
|
||||||
Update the `http:` entry in your `configuration.yaml` file and let it point to your created files.
|
Update the `http:` entry in your `configuration.yaml` file and let it point to your created files.
|
||||||
|
|
||||||
Hass.io:
|
Hass.io:
|
||||||
|
|
||||||
@ -52,7 +52,7 @@ A restart of Home Assistant is required for the new certificate to take effect.
|
|||||||
|
|
||||||
If you get any log error about *ssl_key* or *ssl_certificate* that is **not a file for dictionary value** when run Home Assistant, you need to change owner or access permission of the `.pem` files as following:
|
If you get any log error about *ssl_key* or *ssl_certificate* that is **not a file for dictionary value** when run Home Assistant, you need to change owner or access permission of the `.pem` files as following:
|
||||||
|
|
||||||
Hass.io (through Console or SSH plug-in):
|
Home Assistant (through console or SSH add-on):
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
chown root:root fullchain.pem privkey.pem
|
chown root:root fullchain.pem privkey.pem
|
||||||
|
@ -47,13 +47,13 @@ These install options are fully supported by Home Assistant's documentation. For
|
|||||||
|
|
||||||
<div class='note'>
|
<div class='note'>
|
||||||
|
|
||||||
The only installation methods that allow you to use Hass.io Add-ons are the Hass.io image and [manual installer](/hassio/installation/#alternative-install-on-a-generic-linux-host). All other methods only install the base Home Assistant packages, however the software from the add-ons may still usually be installed manually like any other program.
|
The only installation methods that allow you to use Home Assistant Add-ons is using the Home Assistant image and [manual Supervised installer](/hassio/installation/#alternative-install-on-a-generic-linux-host). All other methods only install the base Home Assistant packages, however the software from the add-ons may still usually be installed manually like any other program.
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
**Method**|**You have**|**Recommended for**
|
**Method**|**You have**|**Recommended for**
|
||||||
:-----|:-----|:-----
|
:-----|:-----|:-----
|
||||||
[Hass.io](/hassio/installation/)|Raspberry Pi<br>VM|Anybody
|
[Home Assistant](/hassio/installation/)|Raspberry Pi<br>VM|Anybody
|
||||||
[Docker](/docs/installation/docker/)|Docker|Anybody already running Docker
|
[Docker](/docs/installation/docker/)|Docker|Anybody already running Docker
|
||||||
|
|
||||||
## Alternative installs
|
## Alternative installs
|
||||||
@ -116,6 +116,6 @@ These guides are provided as-is. Some of these install methods are more limited
|
|||||||
<div class='img-container'>
|
<div class='img-container'>
|
||||||
<img src='/images/supported_brands/home-assistant.png' />
|
<img src='/images/supported_brands/home-assistant.png' />
|
||||||
</div>
|
</div>
|
||||||
<div class='title'>Hass.io <br> on generic Linux server</div>
|
<div class='title'>Home Assistant Supervised <br> on generic Linux server</div>
|
||||||
</a>
|
</a>
|
||||||
</div>
|
</div>
|
||||||
|
@ -67,13 +67,13 @@ cd /srv/homeassistant
|
|||||||
python3 -m venv .
|
python3 -m venv .
|
||||||
source bin/activate
|
source bin/activate
|
||||||
```
|
```
|
||||||
Once you have activated the virtual environment (notice the prompt change to `(homeassistant) homeassistant@raspberrypi:/srv/homeassistant $`) you will need to run the following command to install a required python package.
|
Once you have activated the virtual environment (notice the prompt change to `(homeassistant) homeassistant@raspberrypi:/srv/homeassistant $`) you will need to run the following command to install a required Python package.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
python3 -m pip install wheel
|
python3 -m pip install wheel
|
||||||
```
|
```
|
||||||
|
|
||||||
Once you have installed the required python package it is now time to install Home Assistant!
|
Once you have installed the required Python package it is now time to install Home Assistant!
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
pip3 install homeassistant
|
pip3 install homeassistant
|
||||||
|
@ -11,13 +11,13 @@ Synology only provide Python 3.5.1, which is not compatible with Home Assistant
|
|||||||
</div>
|
</div>
|
||||||
|
|
||||||
There are 3 alternatives, when using Home Assistant on Synology NAS:
|
There are 3 alternatives, when using Home Assistant on Synology NAS:
|
||||||
1. using Docker
|
1. Using Home Assistant Core on Docker
|
||||||
2. directly running on DSM
|
2. Directly running Home Assistant Core on DSM
|
||||||
3. using Hass.io in a VM (if you have an Intel based Synology)
|
3. Using the Home Assistant a VM (if you have an Intel based Synology)
|
||||||
|
|
||||||
Option 1 is described on the [Docker installation page](/docs/installation/docker/).
|
Option 1 is described on the [Docker installation page](/docs/installation/docker/).
|
||||||
|
|
||||||
Option 3 uses the Synology Based Virtual Machine Manager. You can import the VDI image to be found at the [Hass.io installation page](/hassio/installation/). Download the image and add it to the image store. The go to "Virtual Machine" in the interface and create a new VM with the image you just added.
|
Option 3 uses the Synology Based Virtual Machine Manager. You can import the VDI image to be found at the [Home Assistant installation page](/hassio/installation/). Download the image and add it to the image store. The go to "Virtual Machine" in the interface and create a new VM with the image you just added.
|
||||||
|
|
||||||
The main benefit from this method is that you can assign Home Assistant its own IP number, so there is no risk regarding TCP/UDP port conflicts. USB dongles an be connected to the VM without the need to install a driver in DSM.
|
The main benefit from this method is that you can assign Home Assistant its own IP number, so there is no risk regarding TCP/UDP port conflicts. USB dongles an be connected to the VM without the need to install a driver in DSM.
|
||||||
|
|
||||||
@ -180,7 +180,7 @@ esac
|
|||||||
|
|
||||||
```
|
```
|
||||||
|
|
||||||
Create links to python folders to make things easier in the future:
|
Create links to Python folders to make things easier in the future:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# ln -s /volume1/@appstore/py3k/usr/local/bin/python3 python3
|
# ln -s /volume1/@appstore/py3k/usr/local/bin/python3 python3
|
||||||
|
@ -6,7 +6,7 @@ redirect_from: /getting-started/updating/
|
|||||||
|
|
||||||
<div class='note warning'>
|
<div class='note warning'>
|
||||||
|
|
||||||
The upgrade process differs depending on the installation you have, so please review the documentation that is specific to your install [Hass.io](/hassio/) or [Virtualenv](/docs/installation/virtualenv/#upgrading-home-assistant).
|
The upgrade process differs depending on the installation you have, so please review the documentation that is specific to your install [Home Assistant](/hassio/) or [Home Assistant Core](/docs/installation/virtualenv/#upgrading-home-assistant).
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
@ -14,29 +14,28 @@ Check what's new in the latest version and potentially impacts your system in [H
|
|||||||
|
|
||||||
<div class='note'>
|
<div class='note'>
|
||||||
|
|
||||||
To avoid permission errors, the upgrade must be run as the same user as the installation was completed, again review the documentation specific to your install [Hass.io](/hassio/) or [Virtualenv](/docs/installation/virtualenv).
|
To avoid permission errors, the upgrade must be run as the same user as the installation was completed, again review the documentation specific to your install [Home Assistant](/hassio/) or [Home Assistant Core](/docs/installation/virtualenv).
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
The default way to update Home Assistant to the latest release, when available, is:
|
The default way to update Home Assistant to the latest release, when available, is:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
$ pip3 install --upgrade homeassistant
|
pip3 install --upgrade homeassistant
|
||||||
```
|
```
|
||||||
|
|
||||||
For a Docker container, simply pull the latest one:
|
For a Docker container, simply pull the latest one:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
$ sudo docker pull homeassistant/home-assistant:latest
|
sudo docker pull homeassistant/home-assistant:latest
|
||||||
```
|
```
|
||||||
|
|
||||||
For a Raspberry Pi Docker container, simply pull the latest one:
|
For a Raspberry Pi Docker container, simply pull the latest one:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
$ sudo docker pull homeassistant/raspberrypi3-homeassistant:latest
|
sudo docker pull homeassistant/raspberrypi3-homeassistant:latest
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
After updating, you must start/restart Home Assistant for the changes to take effect. This means that you will have to restart `hass` itself or the [autostarting](/docs/autostart/) daemon (if applicable). Startup can take considerable amount of time (i.e. minutes) depending on your device. This is because all requirements are updated as well.
|
After updating, you must start/restart Home Assistant for the changes to take effect. This means that you will have to restart `hass` itself or the [autostarting](/docs/autostart/) daemon (if applicable). Startup can take considerable amount of time (i.e. minutes) depending on your device. This is because all requirements are updated as well.
|
||||||
|
|
||||||
[BRUH automation](https://www.bruhautomation.io/) has created [a tutorial video](https://www.youtube.com/watch?v=tuG2rs1Cl2Y) explaining how to upgrade Home Assistant.
|
[BRUH automation](https://www.bruhautomation.io/) has created [a tutorial video](https://www.youtube.com/watch?v=tuG2rs1Cl2Y) explaining how to upgrade Home Assistant.
|
||||||
@ -46,7 +45,7 @@ After updating, you must start/restart Home Assistant for the changes to take ef
|
|||||||
In the event that a Home Assistant version doesn't play well with your hardware setup, you can downgrade to a previous release:
|
In the event that a Home Assistant version doesn't play well with your hardware setup, you can downgrade to a previous release:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
$ pip3 install homeassistant==0.XX.X
|
pip3 install homeassistant==0.XX.X
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Run the beta version
|
#### Run the beta version
|
||||||
@ -54,7 +53,7 @@ $ pip3 install homeassistant==0.XX.X
|
|||||||
If you would like to test next release before anyone else, you can install the beta version released every two weeks:
|
If you would like to test next release before anyone else, you can install the beta version released every two weeks:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
$ pip3 install --pre --upgrade homeassistant
|
pip3 install --pre --upgrade homeassistant
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Run the development version
|
#### Run the development version
|
||||||
@ -69,11 +68,11 @@ If you want to stay on the bleeding-edge Home Assistant development branch, you
|
|||||||
$ pip3 install --upgrade git+git://github.com/home-assistant/home-assistant.git@dev
|
$ pip3 install --upgrade git+git://github.com/home-assistant/home-assistant.git@dev
|
||||||
```
|
```
|
||||||
|
|
||||||
### Update Hass.io installation
|
### Update Home Assistant installation
|
||||||
|
|
||||||
Best practice for updating a Hass.io installation:
|
Best practice for updating a Home Assistant installation:
|
||||||
|
|
||||||
1. Backup your installation, using the snapshot functionality Hass.io offers.
|
1. Backup your installation, using the snapshot functionality Home Assistant offers.
|
||||||
2. Check the release notes for breaking changes on [Home Assistant release notes](https://github.com/home-assistant/home-assistant/releases). Be sure to check all release notes between the version you are running and the one you are upgrading to. Use the search function in your browser (`CTRL + f`) and search for **Breaking Changes**.
|
2. Check the release notes for breaking changes on [Home Assistant release notes](https://github.com/home-assistant/home-assistant/releases). Be sure to check all release notes between the version you are running and the one you are upgrading to. Use the search function in your browser (`CTRL + f`) and search for **Breaking Changes**.
|
||||||
3. Check your configuration using the [Check Home Assistant configuration](/addons/check_config/) add-on.
|
3. Check your configuration using the [Check Home Assistant configuration](/addons/check_config/) add-on.
|
||||||
4. If the check passes, you can safely update. If not, update your configuration accordingly.
|
4. If the check passes, you can safely update. If not, update your configuration accordingly.
|
||||||
|
@ -1,15 +1,18 @@
|
|||||||
---
|
---
|
||||||
title: "MQTT Brokers"
|
title: "MQTT Broker"
|
||||||
description: "Instructions on how to setup MQTT brokers for Home Assistant."
|
description: "Instructions on how to setup a MQTT broker for Home Assistant."
|
||||||
logo: mqtt.png
|
logo: mqtt.png
|
||||||
---
|
---
|
||||||
|
|
||||||
The MQTT integration needs you to run an MQTT broker for Home Assistant to connect to. There are four options, each with various degrees of ease of setup and privacy.
|
The MQTT integration needs you to run an MQTT broker for Home Assistant to connect to.
|
||||||
|
|
||||||
### Run your own
|
### Run your own
|
||||||
|
|
||||||
This is the most private option, but it requires a little bit of work to setup. There are multiple free and open-source brokers to pick from: e.g., [Mosquitto](http://mosquitto.org/), [EMQ](https://github.com/emqx/emqx) or [Mosca](http://www.mosca.io/).
|
This is the most private option, is running your own MQTT broker.
|
||||||
For Hass.io users, the recommended setup method is to use the [Mosquitto MQTT broker addon](/addons/mosquitto).
|
|
||||||
|
The recommended setup method is to use the [Mosquitto MQTT broker addon](/addons/mosquitto).
|
||||||
|
|
||||||
|
## Configuration
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
@ -48,7 +51,7 @@ protocol:
|
|||||||
type: string
|
type: string
|
||||||
certificate:
|
certificate:
|
||||||
required: false
|
required: false
|
||||||
description: Path to the certificate file, e.g., `/home/user/.homeassistant/server.crt`.
|
description: Path to the certificate file, e.g., `/ssl/server.crt`.
|
||||||
type: string
|
type: string
|
||||||
tls_insecure:
|
tls_insecure:
|
||||||
required: false
|
required: false
|
||||||
@ -61,26 +64,6 @@ tls_version:
|
|||||||
type: string
|
type: string
|
||||||
{% endconfiguration %}
|
{% endconfiguration %}
|
||||||
|
|
||||||
<div class='note warning'>
|
|
||||||
|
|
||||||
There is an issue with the Mosquitto package included in Ubuntu 14.04 LTS. Specify `protocol: 3.1` in your MQTT configuration to work around this issue.
|
|
||||||
|
|
||||||
If you get this error `AttributeError: module 'ssl' has no attribute 'PROTOCOL_TLS'` then you need to set `tls_version: '1.2'`.
|
|
||||||
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<div class='note'>
|
|
||||||
|
|
||||||
If you are running a Mosquitto instance on the same server as Home Assistant then you must ensure that the Mosquitto service starts before Home Assistant. For a Linux instance running Systemd (Raspberry Pi, Debian, Ubuntu and others) then you should edit the file `/etc/systemd/system/home-assistant@homeassistant.service` as `root` (e.g., `sudo nano /etc/systemd/system/home-assistant@homeassistant.service`) and add the Mosquitto service:
|
|
||||||
|
|
||||||
```txt
|
|
||||||
[Unit]
|
|
||||||
Description=Home Assistant
|
|
||||||
After=network.target mosquitto.service
|
|
||||||
```
|
|
||||||
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<div class='note'>
|
<div class='note'>
|
||||||
|
|
||||||
If you are running a Mosquitto instance on a different server with proper SSL encryption using a service like Let's Encrypt you may have to set the certificate to the operating systems own `.crt` certificates file. In the instance of Ubuntu this would be `certificate: /etc/ssl/certs/ca-certificates.crt`
|
If you are running a Mosquitto instance on a different server with proper SSL encryption using a service like Let's Encrypt you may have to set the certificate to the operating systems own `.crt` certificates file. In the instance of Ubuntu this would be `certificate: /etc/ssl/certs/ca-certificates.crt`
|
||||||
@ -161,10 +144,6 @@ mqtt:
|
|||||||
As of release 0.92, the embedded broker has been marked as deprecated. This means bugs may not be fixed, and the functionality may be removed in a future release.
|
As of release 0.92, the embedded broker has been marked as deprecated. This means bugs may not be fixed, and the functionality may be removed in a future release.
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div class='note'>
|
|
||||||
Before release 0.76, the embedded broker would use your API password as a password to the MQTT user. This is no longer the case.
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<div class='note warning'>
|
<div class='note warning'>
|
||||||
|
|
||||||
There is [an issue](https://github.com/beerfactory/hbmqtt/issues/62) with the HBMQTT broker and the WebSocket connection that is causing a memory leak. If you experience this issue, consider using another broker like Mosquitto.
|
There is [an issue](https://github.com/beerfactory/hbmqtt/issues/62) with the HBMQTT broker and the WebSocket connection that is causing a memory leak. If you experience this issue, consider using another broker like Mosquitto.
|
||||||
|
@ -7,7 +7,7 @@ As Home Assistant is like every other service or daemon that is running on a com
|
|||||||
|
|
||||||
[Secure your installation](/docs/configuration/securing/) once you've finished with the installation process regardless of your use case.
|
[Secure your installation](/docs/configuration/securing/) once you've finished with the installation process regardless of your use case.
|
||||||
|
|
||||||
Home Assistant is NOT able to change the configuration of your router or firewall. This means that you need to setup [port-forwarding](/docs/configuration/remote/) and adjusting firewall rules if you want to allow access from the internet. By default your frontend and your Hass.io add-ons like Mosquitto, SSH and your Samba shares are only accessible from your local network.
|
Home Assistant is NOT able to change the configuration of your router or firewall. This means that you need to setup [port-forwarding](/docs/configuration/remote/) and adjusting firewall rules if you want to allow access from the internet. By default your frontend and your Home Assistant add-ons like Mosquitto, SSH and your Samba shares are only accessible from your local network.
|
||||||
|
|
||||||
## Server banner
|
## Server banner
|
||||||
|
|
||||||
@ -17,8 +17,6 @@ Further [details about the fingerprint/server banner](/docs/security/webserver/)
|
|||||||
|
|
||||||
The default port of Home Assistant is 8123. This is the port where the [`frontend`](/integrations/frontend/) and the [`API`](/integrations/api/) is served. Both are depending on the [`http`](/integrations/http/) integration which contains the capability to adjust the settings like `server_host` or `server_port`.
|
The default port of Home Assistant is 8123. This is the port where the [`frontend`](/integrations/frontend/) and the [`API`](/integrations/api/) is served. Both are depending on the [`http`](/integrations/http/) integration which contains the capability to adjust the settings like `server_host` or `server_port`.
|
||||||
|
|
||||||
See the [open ports](/docs/security/porosity/) of a Hass.io instance with various add-ons.
|
|
||||||
|
|
||||||
## HTTP SSL/TLS
|
## HTTP SSL/TLS
|
||||||
|
|
||||||
Home Assistant is following the [Mozilla's Operations Security team recommendations](https://wiki.mozilla.org/Security/Server_Side_TLS) for Server side SSL/TLS settings. Home Assistant uses **Modern compatibility** by default. If an user wishes to use **Intermediate compatibility**, this is configurable in the [`http` integration](/integrations/http/).
|
Home Assistant is following the [Mozilla's Operations Security team recommendations](https://wiki.mozilla.org/Security/Server_Side_TLS) for Server side SSL/TLS settings. Home Assistant uses **Modern compatibility** by default. If an user wishes to use **Intermediate compatibility**, this is configurable in the [`http` integration](/integrations/http/).
|
||||||
@ -27,7 +25,7 @@ Home Assistant is following the [Mozilla's Operations Security team recommendati
|
|||||||
|
|
||||||
The SSH connection for [debugging](https://developers.home-assistant.io/docs/en/hassio_debugging.html) on port 22222 is not enabled by default and can only be used with keys.
|
The SSH connection for [debugging](https://developers.home-assistant.io/docs/en/hassio_debugging.html) on port 22222 is not enabled by default and can only be used with keys.
|
||||||
|
|
||||||
If SSH is used with the [SSH server add-on](/addons/ssh/) then the user is responsible for the configuration and security.
|
If SSH is used with the [SSH server add-on](/addons/ssh/) then the user is responsible for the configuration and security.
|
||||||
|
|
||||||
## Source code
|
## Source code
|
||||||
|
|
||||||
|
@ -1,189 +0,0 @@
|
|||||||
---
|
|
||||||
title: "Home Assistant/Hass.io porosity"
|
|
||||||
description: "Use nmap to scan your Home Assistant instance."
|
|
||||||
---
|
|
||||||
|
|
||||||
As a large amount of users are running [Hass.io](/hassio/), here we are using a Raspberry Pi 3 B and Hass.io 0.70.0 to show how Home Assistant looks from the network side. This is not a full blown investigation, just a quick overview.
|
|
||||||
|
|
||||||
The IP address of the Home Assistant machine is 192.168.0.215. The system which is the source of the scans is a machine running Fedora 27 and Nmap 7.60 is used to perform the port scans. Both systems are in the same network.
|
|
||||||
|
|
||||||
## SSH server Add-on
|
|
||||||
|
|
||||||
To get access to Hass.io in secure way, SSH is provided by the [SSH server add-on](/addons/ssh/).
|
|
||||||
|
|
||||||
```bash
|
|
||||||
$ sudo nmap -A -n --reason -Pn -T5 -p1-65535 192.168.0.215
|
|
||||||
|
|
||||||
Starting Nmap 7.60 ( https://nmap.org ) at 2018-05-29 15:08 CEST
|
|
||||||
Nmap scan report for 192.168.0.215
|
|
||||||
Host is up, received arp-response (0.00051s latency).
|
|
||||||
Not shown: 65532 closed ports
|
|
||||||
Reason: 65532 resets
|
|
||||||
PORT STATE SERVICE REASON VERSION
|
|
||||||
22/tcp open ssh syn-ack ttl 63 OpenSSH 7.5 (protocol 2.0)
|
|
||||||
| ssh-hostkey:
|
|
||||||
| 2048 e3:a2:2d:20:3a:67:68:b9:b1:9e:16:fa:48:80:82:96 (RSA)
|
|
||||||
| 256 92:f0:f4:be:4f:44:60:0e:c4:92:8a:cb:34:9e:c5:c2 (ECDSA)
|
|
||||||
|_ 256 09:da:a2:14:cd:c4:69:e9:13:e6:70:64:98:d0:55:0c (EdDSA)
|
|
||||||
8123/tcp open http syn-ack ttl 64 aiohttp 3.1.3 (Python 3.6)
|
|
||||||
|_http-open-proxy: Proxy might be redirecting requests
|
|
||||||
| http-robots.txt: 1 disallowed entry
|
|
||||||
|_/
|
|
||||||
|_http-server-header: Python/3.6 aiohttp/3.1.3
|
|
||||||
|_http-title: Home Assistant
|
|
||||||
22222/tcp open ssh syn-ack ttl 64 Dropbear sshd 2016.74 (protocol 2.0)
|
|
||||||
MAC Address: B8:41:CD:4B:7A:5D (Raspberry Pi Foundation)
|
|
||||||
Device type: general purpose
|
|
||||||
Running: Linux 3.X|4.X
|
|
||||||
OS CPE: cpe:/o:linux:linux_kernel:3 cpe:/o:linux:linux_kernel:4
|
|
||||||
OS details: Linux 3.2 - 4.8
|
|
||||||
Network Distance: 1 hop
|
|
||||||
Service Info: OS: Linux; CPE: cpe:/o:linux:linux_kernel
|
|
||||||
|
|
||||||
TRACEROUTE
|
|
||||||
HOP RTT ADDRESS
|
|
||||||
1 0.51 ms 192.168.0.215
|
|
||||||
|
|
||||||
OS and Service detection performed. Please report any incorrect results at https://nmap.org/submit/ .
|
|
||||||
Nmap done: 1 IP address (1 host up) scanned in 726.23 seconds
|
|
||||||
```
|
|
||||||
|
|
||||||
That port 22 and 8123 are open was expected. On port 22222 is an additional SSH server running. This port is for [debugging](https://developers.home-assistant.io/docs/en/hassio_debugging.html) and supports only a login with a key. This means that you would need to remove the SD card from your Raspberry Pi, create an `authorized_keys` with your SSH public key in it and put the SD Card back in your Pi to get access.
|
|
||||||
|
|
||||||
## Mosquitto MQTT broker Add-on
|
|
||||||
|
|
||||||
While setting up the [Mosquitto MQTT broker add-on](/addons/mosquitto/) no settings were modified, the add-on was running with the default settings.
|
|
||||||
|
|
||||||
```bash
|
|
||||||
$ sudo nmap -A -n --reason -Pn -T5 -p1-65535 192.168.0.215
|
|
||||||
|
|
||||||
Starting Nmap 7.60 ( https://nmap.org ) at 2018-05-29 15:52 CEST
|
|
||||||
Nmap scan report for 192.168.0.215
|
|
||||||
Host is up, received arp-response (0.0011s latency).
|
|
||||||
Not shown: 65532 closed ports
|
|
||||||
Reason: 65532 resets
|
|
||||||
PORT STATE SERVICE REASON VERSION
|
|
||||||
1883/tcp open mosquitto version 1.4.12 syn-ack ttl 63
|
|
||||||
| mqtt-subscribe:
|
|
||||||
| Topics and their most recent payloads:
|
|
||||||
| $SYS/broker/load/connections/5min: 0.39
|
|
||||||
[...]
|
|
||||||
| $SYS/broker/load/connections/15min: 0.13
|
|
||||||
|_ $SYS/broker/clients/total: 2
|
|
||||||
8123/tcp open http syn-ack ttl 64 aiohttp 3.1.3 (Python 3.6)
|
|
||||||
|_http-open-proxy: Proxy might be redirecting requests
|
|
||||||
| http-robots.txt: 1 disallowed entry
|
|
||||||
|_/
|
|
||||||
|_http-server-header: Python/3.6 aiohttp/3.1.3
|
|
||||||
|_http-title: Home Assistant
|
|
||||||
22222/tcp open ssh syn-ack ttl 64 Dropbear sshd 2016.74 (protocol 2.0)
|
|
||||||
MAC Address: B8:41:CD:4B:7A:5D (Raspberry Pi Foundation)
|
|
||||||
Device type: general purpose
|
|
||||||
Running: Linux 3.X|4.X
|
|
||||||
OS CPE: cpe:/o:linux:linux_kernel:3 cpe:/o:linux:linux_kernel:4
|
|
||||||
OS details: Linux 3.2 - 4.8
|
|
||||||
Network Distance: 1 hop
|
|
||||||
Service Info: OS: Linux; CPE: cpe:/o:linux:linux_kernel
|
|
||||||
|
|
||||||
TRACEROUTE
|
|
||||||
HOP RTT ADDRESS
|
|
||||||
1 1.13 ms 192.168.0.215
|
|
||||||
|
|
||||||
OS and Service detection performed. Please report any incorrect results at https://nmap.org/submit/ .
|
|
||||||
Nmap done: 1 IP address (1 host up) scanned in 223.76 seconds
|
|
||||||
```
|
|
||||||
|
|
||||||
To secure MQTT to consider to use certificates and to specify users with password under `logins:` at least. Use port 1883 only in your local network.
|
|
||||||
|
|
||||||
## Samba Add-on
|
|
||||||
|
|
||||||
The [Samba add-on](/addons/samba/) enables one to use a Windows system to access the configuration and other shares. Per default there is no user set. To increase your local security we strongly suggest that you set a username and a password and don't allow guests. A sample configuration could look like the one below.
|
|
||||||
|
|
||||||
A port scan for Hass.io with this add-on will give you the details.
|
|
||||||
|
|
||||||
```bash
|
|
||||||
$ sudo nmap -A -n --reason -Pn -T5 -p1-65535 192.168.0.215
|
|
||||||
|
|
||||||
Starting Nmap 7.60 ( https://nmap.org ) at 2018-05-29 16:29 CEST
|
|
||||||
Host is up, received arp-response (0.00045s latency).
|
|
||||||
Not shown: 65523 closed ports
|
|
||||||
Reason: 65523 resets
|
|
||||||
PORT STATE SERVICE REASON VERSION
|
|
||||||
139/tcp open netbios-ssn syn-ack ttl 64 Samba smbd 3.X - 4.X (workgroup: WORKGROUP)
|
|
||||||
445/tcp open netbios-ssn syn-ack ttl 64 Samba smbd 4.7.3 (workgroup: WORKGROUP)
|
|
||||||
8123/tcp open http syn-ack ttl 64 aiohttp 3.1.3 (Python 3.6)
|
|
||||||
|_http-open-proxy: Proxy might be redirecting requests
|
|
||||||
| http-robots.txt: 1 disallowed entry
|
|
||||||
|_/
|
|
||||||
|_http-server-header: Python/3.6 aiohttp/3.1.3
|
|
||||||
|_http-title: Home Assistant
|
|
||||||
22222/tcp open ssh syn-ack ttl 64 Dropbear sshd 2016.74 (protocol 2.0)
|
|
||||||
MAC Address: B8:41:CD:4B:7A:5D (Raspberry Pi Foundation)
|
|
||||||
Device type: general purpose
|
|
||||||
Running: Linux 3.X|4.X
|
|
||||||
OS CPE: cpe:/o:linux:linux_kernel:3 cpe:/o:linux:linux_kernel:4
|
|
||||||
OS details: Linux 3.2 - 4.8
|
|
||||||
Network Distance: 1 hop
|
|
||||||
Service Info: Host: HASSIO; OS: Linux; CPE: cpe:/o:linux:linux_kernel
|
|
||||||
|
|
||||||
Host script results:
|
|
||||||
|_nbstat: NetBIOS name: HASSIO, NetBIOS user: <unknown>, NetBIOS MAC: <unknown> (unknown)
|
|
||||||
| smb-os-discovery:
|
|
||||||
| OS: Windows 6.1 (Samba 4.7.3)
|
|
||||||
| Computer name: \x00
|
|
||||||
| NetBIOS computer name: HASSIO\x00
|
|
||||||
| Workgroup: WORKGROUP\x00
|
|
||||||
|_ System time: 2018-05-29T16:41:05+02:00
|
|
||||||
| smb-security-mode:
|
|
||||||
| account_used: guest
|
|
||||||
| authentication_level: user
|
|
||||||
| challenge_response: supported
|
|
||||||
|_ message_signing: disabled (dangerous, but default)
|
|
||||||
| smb2-security-mode:
|
|
||||||
| 2.02:
|
|
||||||
|_ Message signing enabled but not required
|
|
||||||
| smb2-time:
|
|
||||||
| date: 2018-05-29 16:41:05
|
|
||||||
|_ start_date: 1601-01-01 00:53:28
|
|
||||||
|
|
||||||
TRACEROUTE
|
|
||||||
HOP RTT ADDRESS
|
|
||||||
1 0.46 ms 192.168.0.215
|
|
||||||
|
|
||||||
OS and Service detection performed. Please report any incorrect results at https://nmap.org/submit/ .
|
|
||||||
Nmap done: 1 IP address (1 host up) scanned in 727.43 seconds
|
|
||||||
```
|
|
||||||
|
|
||||||
139 and 445 are open and it's possible to enumerate the shares. With different tools you will get pretty much the same information.
|
|
||||||
|
|
||||||
```bash
|
|
||||||
$ smbclient -L //192.168.0.215 -U%
|
|
||||||
|
|
||||||
Sharename Type Comment
|
|
||||||
--------- ---- -------
|
|
||||||
config Disk
|
|
||||||
addons Disk
|
|
||||||
share Disk
|
|
||||||
backup Disk
|
|
||||||
IPC$ IPC
|
|
||||||
IPC Service (Samba Home Assistant config share)
|
|
||||||
Reconnecting with SMB1 for workgroup listing.
|
|
||||||
|
|
||||||
Server Comment
|
|
||||||
--------- -------
|
|
||||||
|
|
||||||
Workgroup Master
|
|
||||||
--------- -------
|
|
||||||
WORKGROUP HASSIO
|
|
||||||
```
|
|
||||||
|
|
||||||
But without username and password you can't get access to the configuration file with the settings shown here.
|
|
||||||
|
|
||||||
```json
|
|
||||||
[...]
|
|
||||||
"guest": false,
|
|
||||||
"username": "homeassistant",
|
|
||||||
"password": "homeassistant",
|
|
||||||
"interface": "eth0"
|
|
||||||
}
|
|
||||||
```
|
|
@ -26,7 +26,7 @@ Here is where you [include and exclude](/docs/z-wave/adding/) Z-Wave devices fro
|
|||||||
* **Stop Network** stops the Z-Wave network
|
* **Stop Network** stops the Z-Wave network
|
||||||
* **Soft Reset** tells the controller to do a "soft reset." This is not supposed to lose any data, but different controllers can behave differently to a "soft reset" command, and may cause the Z-Wave network to hang.
|
* **Soft Reset** tells the controller to do a "soft reset." This is not supposed to lose any data, but different controllers can behave differently to a "soft reset" command, and may cause the Z-Wave network to hang.
|
||||||
* **Test Network** tells the controller to send no-op commands to each node and measure the time for a response. In theory, this can also bring back nodes which have been marked "presumed dead".
|
* **Test Network** tells the controller to send no-op commands to each node and measure the time for a response. In theory, this can also bring back nodes which have been marked "presumed dead".
|
||||||
* **Save Configuration** Saves the current cache of the network to zwcfg_[home_id].xml
|
* **Save Configuration** Saves the current cache of the network to `zwcfg_[home_id].xml`.
|
||||||
|
|
||||||
## Z-Wave Node Management
|
## Z-Wave Node Management
|
||||||
|
|
||||||
|
@ -457,7 +457,7 @@ Press circle and plus simultaneously to wake up the device.
|
|||||||
|
|
||||||
<!-- from https://products.z-wavealliance.org/products/2817 -->
|
<!-- from https://products.z-wavealliance.org/products/2817 -->
|
||||||
|
|
||||||
Once you've added the NanoMote to your Z-Wave network, you'll need to update your zwcfg_\*.xml file with the below xml data. Stop Home Assistant and open your zwcfg_\*.xml file (located in your configuration folder). Find the NanoMote device section and then its corresponding `CommandClass` section with id="91". Replace the entire CommandClass section with the below xml data. Save the file and restart Home Assistant.
|
Once you've added the NanoMote to your Z-Wave network, you'll need to update your `zwcfg_*.xml` file with the below XML data. Stop Home Assistant and open your `zwcfg_*.xml` file (located in your configuration folder). Find the NanoMote device section and then its corresponding `CommandClass` section with id="91". Replace the entire CommandClass section with the below XML data. Save the file and restart Home Assistant.
|
||||||
|
|
||||||
```xml
|
```xml
|
||||||
<CommandClass id="91" name="COMMAND_CLASS_CENTRAL_SCENE" version="1" request_flags="4" innif="true" scenecount="0">
|
<CommandClass id="91" name="COMMAND_CLASS_CENTRAL_SCENE" version="1" request_flags="4" innif="true" scenecount="0">
|
||||||
|
@ -21,7 +21,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.
|
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.
|
||||||
|
|
||||||
Note that the older Z-Wave alarm command class version 1 didn't have standardized types, and so each manufacturer specified their own version and type info. With Version 2 the alarm type was standardized to the below list. See the [openzwave alarm command class documents](https://github.com/OpenZWave/open-zwave/wiki/Alarm-Command-Class) for more info. You can see which version your sensor supports via the zwcfg_0x\*.xml file. An example with version 2 support:
|
Note that the older Z-Wave alarm command class version 1 didn't have standardized types, and so each manufacturer specified their own version and type info. With Version 2 the alarm type was standardized to the below list. See the [openzwave alarm command class documents](https://github.com/OpenZWave/open-zwave/wiki/Alarm-Command-Class) for more info. You can see which version your sensor supports via the `zwcfg_0x*.xml` file. An example with version 2 support:
|
||||||
|
|
||||||
```xml
|
```xml
|
||||||
<CommandClass id="113" name="COMMAND_CLASS_ALARM" version="2" request_flags="2" innif="true">
|
<CommandClass id="113" name="COMMAND_CLASS_ALARM" version="2" request_flags="2" innif="true">
|
||||||
|
@ -105,25 +105,25 @@ Ensure you keep a backup of this key. If you have to rebuild your system and don
|
|||||||
|
|
||||||
## First Run
|
## First Run
|
||||||
|
|
||||||
On platforms other than Hass.io and Docker, the compilation and installation of python-openzwave happens when you first enable the Z-Wave component, and can take half an hour or more on a Raspberry Pi. When you upgrade Home Assistant and python-openzwave is also upgraded, this will also result in a delay while the new version is compiled and installed.
|
On platforms other than Home Assistant and Docker, the compilation and installation of python-openzwave happens when you first enable the Z-Wave component, and can take half an hour or more on a Raspberry Pi. When you upgrade Home Assistant and python-openzwave is also upgraded, this will also result in a delay while the new version is compiled and installed.
|
||||||
|
|
||||||
The first run after adding a device is when the `zwave` integration will take time to initialize the entities, some entities may appear with incomplete names. Running a network heal may speed up this process.
|
The first run after adding a device is when the `zwave` integration will take time to initialize the entities, some entities may appear with incomplete names. Running a network heal may speed up this process.
|
||||||
|
|
||||||
## Platform specific instructions
|
## Platform specific instructions
|
||||||
|
|
||||||
### Hass.io
|
### Home Assistant
|
||||||
|
|
||||||
You do not need to install any software to use Z-Wave.
|
You do not need to install any software to use Z-Wave.
|
||||||
|
|
||||||
If the path of `/dev/ttyACM0` doesn't work, look in the *System* section of the *Supervisor* menu. There you'll find a *Hardware* button which will list all the hardware found.
|
If the path of `/dev/ttyACM0` doesn't work, look in the *System* section of the *Supervisor* menu. There you'll find a *Hardware* button which will list all the hardware found.
|
||||||
|
|
||||||
You can also check what hardware has been found using the [`hassio` command](/hassio/commandline/#hardware):
|
You can also check what hardware has been found using the [`ha` command](/hassio/commandline/#hardware):
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
hassio hardware info
|
ha hardware info
|
||||||
```
|
```
|
||||||
|
|
||||||
If you did an alternative install of Hass.io on Linux (e.g. installing Ubuntu, then Docker, then Hass.io) then the `modemmanager` package will interfere with any Z-Wave (or Zigbee) stick and should be removed or disabled in the host OS. Failure to do so will result in random failures of those components, e.g. dead or unreachable Z-Wave nodes, most notably right after Home Assistant restarts. Connect to your host OS via SSH, then you can disable with `sudo systemctl disable ModemManager` and remove with `sudo apt-get purge modemmanager` (commands are for Debian/Ubuntu).
|
If you did an alternative install of Home Assistant on Linux (e.g. installing Ubuntu, then Docker, then Home Assistant Supervised) then the `modemmanager` package will interfere with any Z-Wave (or Zigbee) stick and should be removed or disabled in the host OS. Failure to do so will result in random failures of those components, e.g. dead or unreachable Z-Wave nodes, most notably right after Home Assistant restarts. Connect to your host OS via SSH, then you can disable with `sudo systemctl disable ModemManager` and remove with `sudo apt-get purge modemmanager` (commands are for Debian/Ubuntu).
|
||||||
|
|
||||||
### Docker
|
### Docker
|
||||||
|
|
||||||
@ -149,7 +149,7 @@ The `modemmanager` package will interfere with any Z-Wave (or Zigbee) stick and
|
|||||||
|
|
||||||
On the Raspberry Pi you will need to enable the serial interface in the `raspi-config` tool before you can add Z-Wave to Home Assistant. Make sure to reboot the Raspberry Pi for the setting to take effect.
|
On the Raspberry Pi you will need to enable the serial interface in the `raspi-config` tool before you can add Z-Wave to Home Assistant. Make sure to reboot the Raspberry Pi for the setting to take effect.
|
||||||
|
|
||||||
#### Linux
|
#### Linux with Home Assistant Core
|
||||||
|
|
||||||
On Debian Linux platforms there are dependencies you will need to have installed ahead of time (included in `systemd-devel` on Fedora/RHEL systems):
|
On Debian Linux platforms there are dependencies you will need to have installed ahead of time (included in `systemd-devel` on Fedora/RHEL systems):
|
||||||
|
|
||||||
|
@ -1,11 +1,13 @@
|
|||||||
---
|
---
|
||||||
title: "Home Assistant vs. Hass.io"
|
title: "Home Assistant vs. Home Assistant Core"
|
||||||
description: "Home Assistant vs. Hass.io"
|
description: "Home Assistant vs. Home Assistant Core"
|
||||||
ha_category: Installation
|
ha_category: Installation
|
||||||
---
|
---
|
||||||
|
|
||||||
Home Assistant is a Python program, in simple words. It can be run on various operating systems and provide the ability to track, control and automate your devices. When people talking about Home Assistant they usually refer to a standalone [installation method](/docs/installation/).
|
Home Assistant Core is a Python program, in simple words. It can be run on various operating systems and provide the ability to track, control and automate your devices.
|
||||||
|
When people talking about Home Assistant Core they usually refer to a standalone [installation method](/docs/installation/).
|
||||||
|
|
||||||
[Hass.io](/hassio/) is a combination of Home Assistant and tools which allows one to run it easily on a Raspberry Pi and other platforms without setting up an operating system first. Hass.io is an all-in one-solution and has a management user interface that can be used from the Home Assistant frontend. This interface is not present in a standalone setup of Home Assistant.
|
[Home Assistant](/hassio/) is a combination of Home Assistant Core and tools which allows one to run it easily on a Raspberry Pi and other platforms without setting up an operating system first.
|
||||||
|
Home Assistant is an all-in one-solution and has a management user interface that can be used from the Home Assistant frontend. This interface is not present in a Home Assistant Core setup.
|
||||||
|
|
||||||
Be aware that add-ons are only available in Hass.io, due to the way Hass.io is installed.
|
Be aware that add-ons are only available in regular Home Assistant installations.
|
||||||
|
@ -148,7 +148,6 @@
|
|||||||
<li>
|
<li>
|
||||||
{% active_link /docs/security/webserver/ Web server fingerprint %}
|
{% active_link /docs/security/webserver/ Web server fingerprint %}
|
||||||
</li>
|
</li>
|
||||||
<li>{% active_link /docs/security/porosity/ Porosity %}</li>
|
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li>
|
<li>
|
||||||
|
@ -19,7 +19,7 @@ The built-in Alexa integration allows you to integrate Home Assistant into Alexa
|
|||||||
|
|
||||||
- Amazon Developer Account. You can sign on [here](https://developer.amazon.com).
|
- Amazon Developer Account. You can sign on [here](https://developer.amazon.com).
|
||||||
- An [AWS account](https://aws.amazon.com/free/) is need if you want to use Alexa Custom Skill API. Part of your Alexa Custom Skill will be hosted on [AWS Lambda](https://aws.amazon.com/lambda/pricing/). However you don't need worry the cost, AWS Lambda allow free to use up to 1 millions requests and 1GB outbound data transfer per month.
|
- An [AWS account](https://aws.amazon.com/free/) is need if you want to use Alexa Custom Skill API. Part of your Alexa Custom Skill will be hosted on [AWS Lambda](https://aws.amazon.com/lambda/pricing/). However you don't need worry the cost, AWS Lambda allow free to use up to 1 millions requests and 1GB outbound data transfer per month.
|
||||||
- The Alexa Custom Skill API also needs your Home Assistant instance to be accessible from the internet via HTTPS on port 443 using a certificate signed by [an Amazon approved certificate authority](https://ccadb-public.secure.force.com/mozilla/IncludedCACertificateReport), this is so account linking can take place. Read more on [our blog](/blog/2015/12/13/setup-encryption-using-lets-encrypt/) about how to set up encryption for Home Assistant. When running Hass.io using the [Duck DNS](/addons/duckdns/) add-on is the easiest method.
|
- The Alexa Custom Skill API also needs your Home Assistant instance to be accessible from the internet via HTTPS on port 443 using a certificate signed by [an Amazon approved certificate authority](https://ccadb-public.secure.force.com/mozilla/IncludedCACertificateReport), this is so account linking can take place. Read more on [our blog](/blog/2015/12/13/setup-encryption-using-lets-encrypt/) about how to set up encryption for Home Assistant. When running Home Assistant using the [Duck DNS](/addons/duckdns/) add-on is the easiest method.
|
||||||
|
|
||||||
### Create Your Amazon Alexa Custom Skill
|
### Create Your Amazon Alexa Custom Skill
|
||||||
|
|
||||||
|
@ -47,7 +47,7 @@ Steps to Integrate an Amazon Alexa Smart Home Skill with Home Assistant:
|
|||||||
|
|
||||||
## Requirements
|
## Requirements
|
||||||
|
|
||||||
- The Alexa Smart Home API requires your Home Assistant instance to be accessible from the internet via HTTPS on port 443 using an SSL/TLS certificate. A self-signed certificate will work, but a certificate signed by [an Amazon approved certificate authority](https://ccadb-public.secure.force.com/mozilla/IncludedCACertificateReport) is recommended. Read more on [our blog](/blog/2015/12/13/setup-encryption-using-lets-encrypt/) about how to set up encryption for Home Assistant. When running Hass.io using the [Duck DNS](/addons/duckdns/) add-on is the easiest method.
|
- The Alexa Smart Home API requires your Home Assistant instance to be accessible from the internet via HTTPS on port 443 using an SSL/TLS certificate. A self-signed certificate will work, but a certificate signed by [an Amazon approved certificate authority](https://ccadb-public.secure.force.com/mozilla/IncludedCACertificateReport) is recommended. Read more on [our blog](/blog/2015/12/13/setup-encryption-using-lets-encrypt/) about how to set up encryption for Home Assistant. When running Home Assistant using the [Duck DNS](/addons/duckdns/) add-on is the easiest method.
|
||||||
- Amazon Developer Account. Sign up [here](https://developer.amazon.com).
|
- Amazon Developer Account. Sign up [here](https://developer.amazon.com).
|
||||||
- An [Amazon Web Services (AWS)](https://aws.amazon.com/free/) account is required to host the Lambda function for your Alexa Smart Home Skill. [AWS Lambda](https://aws.amazon.com/lambda/pricing/) is free to use for up to 1-million requests and 1GB outbound data transfer per month.
|
- An [Amazon Web Services (AWS)](https://aws.amazon.com/free/) account is required to host the Lambda function for your Alexa Smart Home Skill. [AWS Lambda](https://aws.amazon.com/lambda/pricing/) is free to use for up to 1-million requests and 1GB outbound data transfer per month.
|
||||||
|
|
||||||
|
@ -24,9 +24,9 @@ Almond consists of three parts:
|
|||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
### Hass.io installation
|
### Home Assistant add-on installation
|
||||||
|
|
||||||
To install Almond Server on Hass.io, go to Hass.io App Store, search for Almond and click on Install. Once started, it will initiate a configuration flow to finish set up in Home Assistant. You can find it on the integrations page in the configuration panel.
|
To install Almond Server, go to the Home Assistant add-on store, search for Almond and click on Install. Once started, it will initiate a configuration flow to finish set up in Home Assistant. You can find it on the integrations page in the configuration panel.
|
||||||
|
|
||||||
### Manual installation
|
### Manual installation
|
||||||
|
|
||||||
|
@ -180,7 +180,7 @@ Prior to Home Assistant 0.101, this approach did not work well for newer devices
|
|||||||
|
|
||||||
The second option is to use an ADB server to connect to your Android TV and Fire TV devices.
|
The second option is to use an ADB server to connect to your Android TV and Fire TV devices.
|
||||||
|
|
||||||
For Hass.io users, you can install the [Android Debug Bridge](https://github.com/hassio-addons/addon-adb/blob/master/README.md) addon. Using this approach, Home Assistant will send the ADB commands to the server, which will then send them to the Android TV / Fire TV device and report back to Home Assistant. To use this option, add the `adb_server_ip` option to your configuration. If you are running the server on the same machine as Home Assistant, you can use `127.0.0.1` for this value.
|
For Home Assistant users, you can install the [Android Debug Bridge](https://github.com/hassio-addons/addon-adb/blob/master/README.md) addon. Using this approach, Home Assistant will send the ADB commands to the server, which will then send them to the Android TV / Fire TV device and report back to Home Assistant. To use this option, add the `adb_server_ip` option to your configuration. If you are running the server on the same machine as Home Assistant, you can use `127.0.0.1` for this value.
|
||||||
|
|
||||||
## ADB Troubleshooting
|
## ADB Troubleshooting
|
||||||
|
|
||||||
|
@ -17,9 +17,9 @@ There is currently support for the following device types within Home Assistant:
|
|||||||
- [Binary Sensor](#binary-sensor)
|
- [Binary Sensor](#binary-sensor)
|
||||||
- [Sensor](#sensor)
|
- [Sensor](#sensor)
|
||||||
|
|
||||||
## Hass.io Installation
|
## Home Assistant add-on installation
|
||||||
|
|
||||||
Install this [unofficial add-on](https://github.com/korylprince/hassio-apcupsd/) to use this integration with Hass.io. Keep in mind that we can't give you support for this add-on.
|
Install this [unofficial add-on](https://github.com/korylprince/hassio-apcupsd/) to use this integration with Home Assistant. Keep in mind that we can't give you support for this add-on.
|
||||||
|
|
||||||
After installation, follow the instructions on the GitHub page to configure the plugin. Then continue to follow the integration configurations below.
|
After installation, follow the instructions on the GitHub page to configure the plugin. Then continue to follow the integration configurations below.
|
||||||
|
|
||||||
@ -47,7 +47,7 @@ port:
|
|||||||
|
|
||||||
<div class='note'>
|
<div class='note'>
|
||||||
|
|
||||||
If you get `ConnectionRefusedError: Connection refused` errors in the Home Assistant logs, ensure the [Apcupsd](http://www.apcupsd.org/) configuration directives used by its Network Information Server is set to permit connections from all addresses [NISIP 0.0.0.0](http://www.apcupsd.org/manual/manual.html#configuration-directives-used-by-the-network-information-server), else non-local addesses will not connect. This includes Hass.io running in Docker, even when hosted on the same machine or a virtual machine.
|
If you get `ConnectionRefusedError: Connection refused` errors in the Home Assistant logs, ensure the [Apcupsd](http://www.apcupsd.org/) configuration directives used by its Network Information Server is set to permit connections from all addresses [NISIP 0.0.0.0](http://www.apcupsd.org/manual/manual.html#configuration-directives-used-by-the-network-information-server), else non-local addresses will not connect.
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
@ -16,9 +16,9 @@ The `beewi_smartclim` sensor platform allows one to monitor room or external tem
|
|||||||
|
|
||||||
Depending on the operating system you're running, you have to configure the proper Bluetooth backend on your system:
|
Depending on the operating system you're running, you have to configure the proper Bluetooth backend on your system:
|
||||||
|
|
||||||
- On [Hass.io](/hassio/installation/): `beewi_smartclim` will work out of the box as long as the host supports Bluetooth (like the Raspberry Pi does).
|
- `beewi_smartclim` will work out of the box as long as the host supports Bluetooth (like the Raspberry Pi does).
|
||||||
- On a [generic Docker installation](/docs/installation/docker/): Works out of the box with `--net=host` and properly configured Bluetooth on the host.
|
- Using [Home Assistant Core on Docker installation](/docs/installation/docker/): Works out of the box with `--net=host` and properly configured Bluetooth on the host.
|
||||||
- On other Linux systems:
|
- On other Home Assistant Core systems:
|
||||||
- Preferred solution: Install the `bluepy` and `btlewrap` library (via pip). When using a virtual environment, make sure to use install the library in the right one.
|
- Preferred solution: Install the `bluepy` and `btlewrap` library (via pip). When using a virtual environment, make sure to use install the library in the right one.
|
||||||
- Fallback solution: Install `btlewrap` library (via pip) and `gatttool` via your package manager. Depending on the distribution, the package name might be: `bluez`, `bluetooth` or `bluez-deprecated`.
|
- Fallback solution: Install `btlewrap` library (via pip) and `gatttool` via your package manager. Depending on the distribution, the package name might be: `bluez`, `bluetooth` or `bluez-deprecated`.
|
||||||
- Windows and macOS are currently not supported by the `btlewrap` library.
|
- Windows and macOS are currently not supported by the `btlewrap` library.
|
||||||
|
@ -21,7 +21,7 @@ sudo apt install bluetooth
|
|||||||
Before you get started with this platform, please note that:
|
Before you get started with this platform, please note that:
|
||||||
|
|
||||||
- This platform is incompatible with Windows
|
- This platform is incompatible with Windows
|
||||||
- This platform requires access to the bluetooth stack, see [Rootless Setup section](#rootless-setup) for further information
|
- This platform requires access to the Bluetooth stack, see [Rootless Setup section](#rootless-setup) for further information
|
||||||
|
|
||||||
To use the Bluetooth tracker in your installation, add the following to your `configuration.yaml` file:
|
To use the Bluetooth tracker in your installation, add the following to your `configuration.yaml` file:
|
||||||
|
|
||||||
|
@ -31,10 +31,10 @@ request_rssi:
|
|||||||
type: boolean
|
type: boolean
|
||||||
default: false
|
default: false
|
||||||
device_id:
|
device_id:
|
||||||
description: The ID of the bluetooth adapter to be used by the tracker, e.g., use `0` for `hci0`, `1` for `hci1`, and so on.
|
description: The ID of the Bluetooth adapter to be used by the tracker, e.g., use `0` for `hci0`, `1` for `hci1`, and so on.
|
||||||
required: false
|
required: false
|
||||||
type: integer
|
type: integer
|
||||||
default: "`-1` (The first available bluetooth adapter)"
|
default: "`-1` (The first available Bluetooth adapter)"
|
||||||
{% endconfiguration %}
|
{% endconfiguration %}
|
||||||
|
|
||||||
In some cases it can be that your device is not discovered. In that case let your phone scan for Bluetooth devices while you restart Home Assistant. Just hit `Scan` on your phone all the time until Home Assistant is fully restarted and the device should appear in `known_devices.yaml`.
|
In some cases it can be that your device is not discovered. In that case let your phone scan for Bluetooth devices while you restart Home Assistant. Just hit `Scan` on your phone all the time until Home Assistant is fully restarted and the device should appear in `known_devices.yaml`.
|
||||||
|
@ -180,9 +180,9 @@ group:
|
|||||||
- sensor.bme680_sensor_air_quality
|
- sensor.bme680_sensor_air_quality
|
||||||
```
|
```
|
||||||
|
|
||||||
## Directions for enabling I2C interface on Hass.io
|
## Directions for enabling I2C interface on the Home Assistant Operating System
|
||||||
|
|
||||||
Follow the instructions here to [enable I2C on Hass.io.](/hassio/enable_i2c/).
|
Follow the instructions here to [enable I2C here.](/hassio/enable_i2c/).
|
||||||
|
|
||||||
## Directions for installing SMBus support on Raspberry Pi
|
## Directions for installing SMBus support on Raspberry Pi
|
||||||
|
|
||||||
@ -190,7 +190,7 @@ Enable I2C interface with the Raspberry Pi configuration utility:
|
|||||||
|
|
||||||
```bash
|
```bash
|
||||||
# pi user environment: Enable I2C interface
|
# pi user environment: Enable I2C interface
|
||||||
$ sudo raspi-config
|
sudo raspi-config
|
||||||
```
|
```
|
||||||
|
|
||||||
Select `Interfacing options->I2C` choose `<Yes>` and hit `Enter`, then go to `Finish` and you'll be prompted to reboot.
|
Select `Interfacing options->I2C` choose `<Yes>` and hit `Enter`, then go to `Finish` and you'll be prompted to reboot.
|
||||||
@ -199,13 +199,13 @@ Install dependencies to use the `smbus-cffi` module and add your `homeassistant`
|
|||||||
|
|
||||||
```bash
|
```bash
|
||||||
# pi user environment: Install I2C dependencies and utilities
|
# pi user environment: Install I2C dependencies and utilities
|
||||||
$ sudo apt-get install build-essential libi2c-dev i2c-tools python-dev libffi-dev
|
sudo apt-get install build-essential libi2c-dev i2c-tools python-dev libffi-dev
|
||||||
|
|
||||||
# pi user environment: Add homeassistant user to the I2C group
|
# pi user environment: Add homeassistant user to the I2C group
|
||||||
$ sudo addgroup homeassistant i2c
|
sudo addgroup homeassistant i2c
|
||||||
|
|
||||||
# pi user environment: Reboot Raspberry Pi to apply changes
|
# pi user environment: Reboot Raspberry Pi to apply changes
|
||||||
$ sudo reboot
|
sudo reboot
|
||||||
```
|
```
|
||||||
|
|
||||||
### Check the I2C address of the sensor
|
### Check the I2C address of the sensor
|
||||||
@ -213,10 +213,11 @@ $ sudo reboot
|
|||||||
After installing `i2c-tools`, a new utility is available to scan the addresses of the connected sensors:
|
After installing `i2c-tools`, a new utility is available to scan the addresses of the connected sensors:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
$ /usr/sbin/i2cdetect -y 1
|
/usr/sbin/i2cdetect -y 1
|
||||||
```
|
```
|
||||||
|
|
||||||
It will output a table like this:
|
It will output a table like this:
|
||||||
|
|
||||||
```text
|
```text
|
||||||
0 1 2 3 4 5 6 7 8 9 a b c d e f
|
0 1 2 3 4 5 6 7 8 9 a b c d e f
|
||||||
00: -- -- -- -- -- -- -- -- -- -- -- -- --
|
00: -- -- -- -- -- -- -- -- -- -- -- -- --
|
||||||
|
@ -495,7 +495,7 @@ First get or learn all the remotes you want to add to Home Assistant in E-Contro
|
|||||||
|
|
||||||
4. Install Requirements
|
4. Install Requirements
|
||||||
|
|
||||||
Run `pip install simplejson`. You must install simplejson in the same python version you will use to run the scripts. You can ensure that the current version is installed by attempting to install again and confirming that you see "Requirement already satisfied".
|
Run `pip install simplejson`. You must install `simplejson` in the same Python version you will use to run the scripts. You can ensure that the current version is installed by attempting to install again and confirming that you see "Requirement already satisfied".
|
||||||
|
|
||||||
5. Get the data from the device
|
5. Get the data from the device
|
||||||
|
|
||||||
@ -526,15 +526,15 @@ First get or learn all the remotes you want to add to Home Assistant in E-Contro
|
|||||||
2. Install Requirements
|
2. Install Requirements
|
||||||
|
|
||||||
- Download and install Python 2.7 on your windows PC.
|
- Download and install Python 2.7 on your windows PC.
|
||||||
- Run `pip install simplejson`. You must install simplejson in the same python version you will use to run the scripts. You can ensure that the current version is installed by attempting to install again and confirming that you see "Requirement already satisfied".
|
- Run `pip install simplejson`. You must install `simplejson` in the same Python version you will use to run the scripts. You can ensure that the current version is installed by attempting to install again and confirming that you see "Requirement already satisfied".
|
||||||
- Download and install [iBackup Viewer](https://www.imactools.com/iphonebackupviewer/).
|
- Download and install [iBackup Viewer](https://www.imactools.com/iphonebackupviewer/).
|
||||||
- Download [these](https://github.com/NightRang3r/Broadlink-e-control-db-dump) GitHub files. Make sure you place them in the \Python27 path in Windows. Be sure that the getBroadlinkSharedData.py from the download is in this directory.
|
- Download [these](https://github.com/NightRang3r/Broadlink-e-control-db-dump) GitHub files. Make sure you place them in the \Python27 path in Windows. Be sure that the getBroadlinkSharedData.py from the download is in this directory.
|
||||||
|
|
||||||
3. Plug your iphone into your windows PC, open iTunes and create a non-encrypted backup of your device.
|
3. Plug your iPhone into your Windows PC, open iTunes and create a non-encrypted backup of your device.
|
||||||
|
|
||||||
4. Open iBackup viewer then select the iOS backup that you created. Navigate to the App icon and then scroll until you find e-control.app, select this. Select and extract the files jsonButton, jsonIrCode and jsonSublr; they will be located in the Documents/SharedData section. Put these in the same location as the getBroadlinkSharedData.py.
|
4. Open iBackup viewer then select the iOS backup that you created. Navigate to the App icon and then scroll until you find e-control.app, select this. Select and extract the files jsonButton, jsonIrCode and jsonSublr; they will be located in the Documents/SharedData section. Put these in the same location as the getBroadlinkSharedData.py.
|
||||||
|
|
||||||
5. Now open a Command Prompt and navigate to the directory where the aforementioned files are located e.g. C:\Python27. Now run the command python getBroadlinkSharedData.py, you should see something like this:
|
5. Now open a Command Prompt and navigate to the directory where the aforementioned files are located e.g., `C:\Python27`. Now run the command `python getBroadlinkSharedData.py`, you should see something like this:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
C:\Python27>python getBroadlinkSharedData.py
|
C:\Python27>python getBroadlinkSharedData.py
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
---
|
---
|
||||||
title: CalDav
|
title: CalDAV
|
||||||
description: Instructions on how to integrate a WebDav calendar into Home Assistant.
|
description: Instructions on how to integrate a WebDav calendar into Home Assistant.
|
||||||
ha_category:
|
ha_category:
|
||||||
- Calendar
|
- Calendar
|
||||||
@ -7,22 +7,22 @@ ha_iot_class: Cloud Polling
|
|||||||
ha_release: '0.60'
|
ha_release: '0.60'
|
||||||
---
|
---
|
||||||
|
|
||||||
The `caldav` platform allows you to connect to your WebDav calendar and generate
|
The `caldav` platform allows you to connect to your WebDAV calendar and generate
|
||||||
binary sensors. A different sensor will be created for each individual calendar,
|
binary sensors. A different sensor will be created for each individual calendar,
|
||||||
or you can specify custom calendars which match a criteria you define (more on
|
or you can specify custom calendars which match a criteria you define (more on
|
||||||
that below). These sensors will be `on` if you have an on going event in that
|
that below). These sensors will be `on` if you have an on going event in that
|
||||||
calendar or `off` if the event is later in time, or if there is no event at all.
|
calendar or `off` if the event is later in time, or if there is no event at all.
|
||||||
The WebDav calendar get updated roughly every 15 minutes.
|
The WebDAV calendar get updated roughly every 15 minutes.
|
||||||
|
|
||||||
### Prerequisites
|
### Prerequisites
|
||||||
|
|
||||||
You need to have a CalDav server and credentials for it. This integration was
|
You need to have a CalDAV server and credentials for it. This integration was
|
||||||
tested against [Baikal](http://sabre.io/baikal/) but any integration complying
|
tested against [Baikal](http://sabre.io/baikal/) but any integration complying
|
||||||
with the RFC4791 should work. [Nextcloud](https://nextcloud.com/)
|
with the RFC4791 should work. [Nextcloud](https://nextcloud.com/)
|
||||||
and [Owncloud](https://owncloud.org/) work fine.
|
and [Owncloud](https://owncloud.org/) work fine.
|
||||||
|
|
||||||
You might need some additional system packages to compile the
|
You might need some additional system packages to compile the
|
||||||
Python caldav library. On a Debian based system, install them by:
|
Python CalDAV library. On a Debian based system, install them by:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
$ sudo apt-get install libxml2-dev libxslt1-dev zlib1g-dev
|
$ sudo apt-get install libxml2-dev libxslt1-dev zlib1g-dev
|
||||||
@ -30,7 +30,7 @@ $ sudo apt-get install libxml2-dev libxslt1-dev zlib1g-dev
|
|||||||
|
|
||||||
### Basic Setup
|
### Basic Setup
|
||||||
|
|
||||||
To integrate a WebDav calendar in Home Assistant,
|
To integrate a WebDAV calendar in Home Assistant,
|
||||||
add the following section to your `configuration.yaml` file:
|
add the following section to your `configuration.yaml` file:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
|
@ -215,7 +215,7 @@ Turn climate device on. This is only supported if the climate device supports be
|
|||||||
|
|
||||||
### Service `climate.turn_off`
|
### Service `climate.turn_off`
|
||||||
|
|
||||||
Turn climate device off. This is only supported if the climate device has the hvac mode `off`.
|
Turn climate device off. This is only supported if the climate device has the HVAC mode `off`.
|
||||||
|
|
||||||
| Service data attribute | Optional | Description |
|
| Service data attribute | Optional | Description |
|
||||||
| ---------------------- | -------- | ----------- |
|
| ---------------------- | -------- | ----------- |
|
||||||
|
@ -26,7 +26,7 @@ There is currently support for the following device types within Home Assistant:
|
|||||||
## Supported hardware
|
## Supported hardware
|
||||||
|
|
||||||
- The European versions of the Wifi Controller Unit (BRP069A41, 42, 43, 45), which is powered by the [Daikin Online Controller](https://play.google.com/store/apps/details?id=eu.daikin.remoapp) application. The new versions of WiFi Controller Unit (BRP069Bxx) also should work but it have to be confirmed by users. Tested and working device is BRP069B45.
|
- The European versions of the Wifi Controller Unit (BRP069A41, 42, 43, 45), which is powered by the [Daikin Online Controller](https://play.google.com/store/apps/details?id=eu.daikin.remoapp) application. The new versions of WiFi Controller Unit (BRP069Bxx) also should work but it have to be confirmed by users. Tested and working device is BRP069B45.
|
||||||
- The Australian version of the Daikin Wifi Controller Unit BRP072A42. Confirmed working on a Daikin Cora Series Reverse Cycle Split System Air Conditioner 2.5kW Cooling FTXM25QVMA with operation mode, temp, fan swing (3d, horizontal, vertical) which is powered by the [DAIKIN Mobile Controller](https://itunes.apple.com/au/app/daikin-mobile-controller/id917168708?mt=8) ([Android version](https://play.google.com/store/apps/details?id=eu.daikin.remoapp)) application.
|
- The Australian version of the Daikin Wifi Controller Unit BRP072A42. Confirmed working on a Daikin Cora Series Reverse Cycle Split System Air Conditioner 2.5kW Cooling FTXM25QVMA with operation mode, temp, fan swing (3d, horizontal, vertical) which is powered by the [Daikin Mobile Controller](https://itunes.apple.com/au/app/daikin-mobile-controller/id917168708?mt=8) ([Android version](https://play.google.com/store/apps/details?id=eu.daikin.remoapp)) application.
|
||||||
- The Australian version of the Daikin Wifi Controller for **AirBase** units (BRP15B61), which is powered by the [Daikin Airbase](https://play.google.com/store/apps/details?id=au.com.daikin.airbase) application.
|
- The Australian version of the Daikin Wifi Controller for **AirBase** units (BRP15B61), which is powered by the [Daikin Airbase](https://play.google.com/store/apps/details?id=au.com.daikin.airbase) application.
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
|
@ -230,9 +230,9 @@ automation:
|
|||||||
|
|
||||||
{% endraw %}
|
{% endraw %}
|
||||||
|
|
||||||
### Appdaemon
|
### AppDaemon
|
||||||
|
|
||||||
#### Appdaemon event helper
|
#### AppDaemon event helper
|
||||||
|
|
||||||
Helper app that creates a sensor `sensor.deconz_event` with a state that represents the id from the last event and an attribute to show the event data.
|
Helper app that creates a sensor `sensor.deconz_event` with a state that represents the id from the last event and an attribute to show the event data.
|
||||||
|
|
||||||
@ -277,7 +277,7 @@ class DeconzHelper(hass.Hass):
|
|||||||
|
|
||||||
Note: the event will not be visible before one event gets sent.
|
Note: the event will not be visible before one event gets sent.
|
||||||
|
|
||||||
#### Appdaemon remote template
|
#### AppDaemon remote template
|
||||||
|
|
||||||
{% raw %}
|
{% raw %}
|
||||||
|
|
||||||
@ -313,7 +313,7 @@ class RemoteControl(hass.Hass):
|
|||||||
|
|
||||||
{% endraw %}
|
{% endraw %}
|
||||||
|
|
||||||
#### Appdaemon IKEA Tradfri remote template
|
#### AppDaemon IKEA Tradfri remote template
|
||||||
|
|
||||||
Community app from [Teachingbirds](https://community.home-assistant.io/u/teachingbirds/summary). This app uses an IKEA Tradfri remote to control Sonos speakers with play/pause, volume up and down, next and previous track.
|
Community app from [Teachingbirds](https://community.home-assistant.io/u/teachingbirds/summary). This app uses an IKEA Tradfri remote to control Sonos speakers with play/pause, volume up and down, next and previous track.
|
||||||
|
|
||||||
|
@ -31,7 +31,7 @@ devices:
|
|||||||
keys:
|
keys:
|
||||||
mac_address:
|
mac_address:
|
||||||
required: true
|
required: true
|
||||||
description: The bluetooth address of the switch.
|
description: The Bluetooth address of the switch.
|
||||||
type: list
|
type: list
|
||||||
keys:
|
keys:
|
||||||
name:
|
name:
|
||||||
|
@ -10,7 +10,7 @@ ha_config_flow: true
|
|||||||
|
|
||||||
The `dialogflow` integration is designed to be used with the [webhook](https://dialogflow.com/docs/fulfillment#webhook) integration of [Dialogflow](https://dialogflow.com/). When a conversation ends with a user, Dialogflow sends an action and parameters to the webhook.
|
The `dialogflow` integration is designed to be used with the [webhook](https://dialogflow.com/docs/fulfillment#webhook) integration of [Dialogflow](https://dialogflow.com/). When a conversation ends with a user, Dialogflow sends an action and parameters to the webhook.
|
||||||
|
|
||||||
To be able to receive messages from DialogFlow, your Home Assistant instance needs to be accessible from the web ([Hass.io instructions](/addons/duckdns/)) and you need to have the `base_url` configured for the HTTP integration ([docs](/integrations/http/#base_url)). Dialogflow will return fallback answers if your server does not answer or takes too long (more than 5 seconds).
|
To be able to receive messages from DialogFlow, your Home Assistant instance needs to be accessible from the web and you need to have the `base_url` configured for the HTTP integration ([docs](/integrations/http/#base_url)). Dialogflow will return fallback answers if your server does not answer or takes too long (more than 5 seconds).
|
||||||
|
|
||||||
Dialogflow could be [integrated](https://dialogflow.com/docs/integrations/) with many popular messaging, virtual assistant and IoT platforms.
|
Dialogflow could be [integrated](https://dialogflow.com/docs/integrations/) with many popular messaging, virtual assistant and IoT platforms.
|
||||||
|
|
||||||
|
@ -22,7 +22,7 @@ Home Assistant can discover and automatically configure [zeroconf](https://en.wi
|
|||||||
* [Linn / Openhome](/integrations/openhome)
|
* [Linn / Openhome](/integrations/openhome)
|
||||||
* [Logitech Harmony Hub](/integrations/harmony)
|
* [Logitech Harmony Hub](/integrations/harmony)
|
||||||
* [Logitech media server (Squeezebox)](/integrations/squeezebox)
|
* [Logitech media server (Squeezebox)](/integrations/squeezebox)
|
||||||
* [Netgear routers](/integrations/netgear)
|
* [NETGEAR routers](/integrations/netgear)
|
||||||
* [Panasonic Viera](/integrations/panasonic_viera)
|
* [Panasonic Viera](/integrations/panasonic_viera)
|
||||||
* [Philips Hue](/integrations/hue)
|
* [Philips Hue](/integrations/hue)
|
||||||
* [Plex Media Server](/integrations/plex#media-player)
|
* [Plex Media Server](/integrations/plex#media-player)
|
||||||
@ -81,7 +81,7 @@ Valid values for ignore are:
|
|||||||
* `harmony`: Logitech Harmony Hub
|
* `harmony`: Logitech Harmony Hub
|
||||||
* `igd`: Internet Gateway Device
|
* `igd`: Internet Gateway Device
|
||||||
* `logitech_mediaserver`: Logitech media server (Squeezebox)
|
* `logitech_mediaserver`: Logitech media server (Squeezebox)
|
||||||
* `netgear_router`: Netgear routers
|
* `netgear_router`: NETGEAR routers
|
||||||
* `octoprint`: Octoprint
|
* `octoprint`: Octoprint
|
||||||
* `openhome`: Linn / Openhome
|
* `openhome`: Linn / Openhome
|
||||||
* `panasonic_viera`: Panasonic Viera
|
* `panasonic_viera`: Panasonic Viera
|
||||||
|
@ -25,7 +25,7 @@ media_player:
|
|||||||
|
|
||||||
{% configuration %}
|
{% configuration %}
|
||||||
url:
|
url:
|
||||||
description: The URL to the device description .xml file, e.g., `http://192.168.0.10:9197/description.xml`.
|
description: The URL to the device description XML file, e.g., `http://192.168.0.10:9197/description.xml`.
|
||||||
required: true
|
required: true
|
||||||
type: string
|
type: string
|
||||||
listen_ip:
|
listen_ip:
|
||||||
|
@ -16,7 +16,7 @@ You need to have DOODS running somewhere. It's easiest to run as a Docker contai
|
|||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
|
|
||||||
The configuration loosely follows the tensorflow configuration. To enable this platform in your installation, add the following to your `configuration.yaml` file:
|
The configuration loosely follows the TensorFlow configuration. To enable this platform in your installation, add the following to your `configuration.yaml` file:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
|
@ -9,6 +9,12 @@ ha_release: 0.55
|
|||||||
|
|
||||||
With the DuckDNS integration you can keep your DuckDNS record up to date. DuckDNS is a free dynamic DNS service that allows you to point a subdomain under `duckdns.org` at your computer.
|
With the DuckDNS integration you can keep your DuckDNS record up to date. DuckDNS is a free dynamic DNS service that allows you to point a subdomain under `duckdns.org` at your computer.
|
||||||
|
|
||||||
|
<div class='note'>
|
||||||
|
|
||||||
|
If you are running the Home Assistant DuckDNS add-on this integration is not required. The add-on will keep your IP updated with DuckDNS.
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
|
|
||||||
To use the integration in your installation, add the following to your `configuration.yaml` file:
|
To use the integration in your installation, add the following to your `configuration.yaml` file:
|
||||||
@ -39,9 +45,3 @@ Set the TXT record of your DuckDNS subdomain.
|
|||||||
| ---------------------- | -------- | ----------- |
|
| ---------------------- | -------- | ----------- |
|
||||||
| `txt` | no | Payload for the TXT record. |
|
| `txt` | no | Payload for the TXT record. |
|
||||||
|
|
||||||
|
|
||||||
<div class='note'>
|
|
||||||
|
|
||||||
If you are running the Hass.io [DuckDNS add-on](/addons/duckdns/) this integration is not required. The add-on will keep your IP updated with DuckDNS.
|
|
||||||
|
|
||||||
</div>
|
|
||||||
|
@ -19,7 +19,7 @@ As this platform uses `bluez` to scan for Bluetooth LE devices **a Linux OS with
|
|||||||
sudo apt-get install libbluetooth-dev
|
sudo apt-get install libbluetooth-dev
|
||||||
```
|
```
|
||||||
|
|
||||||
Scanning for Bluetooth LE devices also requires special permissions. To grant these to the python executable execute the following:
|
Scanning for Bluetooth LE devices also requires special permissions. To grant these to the Python executable execute the following:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
sudo apt-get install libcap2-bin
|
sudo apt-get install libcap2-bin
|
||||||
|
@ -14,7 +14,7 @@ Integrate your [Efergy](https://efergy.com) meter information into Home Assistan
|
|||||||
|
|
||||||
To get an app token:
|
To get an app token:
|
||||||
|
|
||||||
1. Log in to your efergy account
|
1. Log in to your Efergy account
|
||||||
2. Go to the Settings page
|
2. Go to the Settings page
|
||||||
3. Click on App tokens
|
3. Click on App tokens
|
||||||
4. Click "Add token"
|
4. Click "Add token"
|
||||||
@ -69,7 +69,7 @@ monitored_variables:
|
|||||||
amount:
|
amount:
|
||||||
description: The amount of energy consumed over a given period.
|
description: The amount of energy consumed over a given period.
|
||||||
current_values:
|
current_values:
|
||||||
description: This returns the current energy usage of each device on your account, as `efergy_\<sid of device\>`. If you only have one device in your account, this is effectively the same as instant_readings.
|
description: This returns the current energy usage of each device on your account. If you only have one device in your account, this is effectively the same as `instant_readings`.
|
||||||
period:
|
period:
|
||||||
description: Some variables take a period argument. Valid options are "day", "week", "month", and "year".
|
description: Some variables take a period argument. Valid options are "day", "week", "month", and "year".
|
||||||
required: false
|
required: false
|
||||||
|
@ -152,11 +152,11 @@ Verify that the URLs above are using port 80, rather than port 8300 (i.e. `http:
|
|||||||
|
|
||||||
### Platform specific instructions
|
### Platform specific instructions
|
||||||
|
|
||||||
#### Hass.io and Docker
|
#### Home Assistant and Home Assistant Core on Docker
|
||||||
|
|
||||||
No further actions are required
|
No further actions are required
|
||||||
|
|
||||||
#### Python venv
|
#### Home Assistant Core in a Python venv
|
||||||
|
|
||||||
An additional step is required to run Home Assistant as a non-root user and use port 80.
|
An additional step is required to run Home Assistant as a non-root user and use port 80.
|
||||||
|
|
||||||
|
@ -11,13 +11,8 @@ The `ffmpeg` integration allows other Home Assistant integrations to process vid
|
|||||||
|
|
||||||
<div class='note'>
|
<div class='note'>
|
||||||
|
|
||||||
You need the `ffmpeg` binary in your system path. On Debian 8 or Raspbian (Jessie) you can install it from [debian-backports](https://backports.debian.org/Instructions/). If you want [hardware acceleration](https://trac.ffmpeg.org/wiki/HWAccelIntro) support on a Raspberry Pi, you will need to build from source by yourself. Windows binaries are available on the [FFmpeg](http://www.ffmpeg.org/) website.
|
If you are running Home Assistant Core in a Python environment, you'll need have the `ffmpeg` binary in your system path.
|
||||||
</div>
|
On Debian 8 or Raspbian (Jessie) you can install it from [debian-backports](https://backports.debian.org/Instructions/). If you want [hardware acceleration](https://trac.ffmpeg.org/wiki/HWAccelIntro) support on a Raspberry Pi, you will need to build from source by yourself. Windows binaries are available on the [FFmpeg](http://www.ffmpeg.org/) website.
|
||||||
|
|
||||||
<div class='note'>
|
|
||||||
|
|
||||||
If you are using [Hass.io](/hassio/) then just move forward to the configuration as all requirements are already fulfilled.
|
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
@ -37,7 +32,7 @@ ffmpeg_bin:
|
|||||||
{% endconfiguration %}
|
{% endconfiguration %}
|
||||||
|
|
||||||
### Raspbian Debian Jessie Lite Installations
|
### Raspbian Debian Jessie Lite Installations
|
||||||
To get the binary on Raspbian Debian Jessie Lite on a RPi you need to perform the following:
|
To get the binary on Raspbian Debian Jessie Lite on a Raspberry Pi you need to perform the following:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
sudo echo "deb http://ftp.debian.org/debian jessie-backports main" >> /etc/apt/sources.list
|
sudo echo "deb http://ftp.debian.org/debian jessie-backports main" >> /etc/apt/sources.list
|
||||||
|
@ -91,7 +91,7 @@ camera:
|
|||||||
content_type: 'image/svg+xml'
|
content_type: 'image/svg+xml'
|
||||||
```
|
```
|
||||||
|
|
||||||
### Local image with Hass.io
|
### Local image
|
||||||
|
|
||||||
You can show a static image with this platform. Just place the image here: `/config/www/your_image.png`
|
You can show a static image with this platform. Just place the image here: `/config/www/your_image.png`
|
||||||
|
|
||||||
|
@ -87,7 +87,7 @@ precision:
|
|||||||
|
|
||||||
Time for `min_cycle_duration` and `keep_alive` must be set as "hh:mm:ss" or it must contain at least one of the following entries: `days:`, `hours:`, `minutes:`, `seconds:` or `milliseconds:`. Alternatively, it can be an integer that represents time in seconds.
|
Time for `min_cycle_duration` and `keep_alive` must be set as "hh:mm:ss" or it must contain at least one of the following entries: `days:`, `hours:`, `minutes:`, `seconds:` or `milliseconds:`. Alternatively, it can be an integer that represents time in seconds.
|
||||||
|
|
||||||
Currently the `generic_thermostat` climate platform supports 'heat', 'cool' and 'off' hvac modes. You can force your `generic_thermostat` to avoid starting by setting HVAC mode to 'off'.
|
Currently the `generic_thermostat` climate platform supports 'heat', 'cool' and 'off' HVAC modes. You can force your `generic_thermostat` to avoid starting by setting HVAC mode to 'off'.
|
||||||
|
|
||||||
Please note that when changing the preset mode to away, you will force a target temperature change as well that will get restored once the preset mode is set to none again.
|
Please note that when changing the preset mode to away, you will force a target temperature change as well that will get restored once the preset mode is set to none again.
|
||||||
|
|
||||||
|
@ -24,7 +24,7 @@ $ sudo glances -w
|
|||||||
Glances web server started on http://0.0.0.0:61208/
|
Glances web server started on http://0.0.0.0:61208/
|
||||||
```
|
```
|
||||||
|
|
||||||
Check if you are able to access the API located at `http://IP_ADRRESS:61208/api/3`. Don't use `-s` as this will start the XMLRPC server on port 61209. Home Assistant only supports the REST API of GLANCES.
|
Check if you are able to access the API located at `http://IP_ADRRESS:61208/api/3`. Don't use `-s` as this will start the XML-RPC server on port 61209. Home Assistant only supports the REST API of GLANCES.
|
||||||
|
|
||||||
The details about your memory usage is provided as a JSON response. If so, you are good to proceed.
|
The details about your memory usage is provided as a JSON response. If so, you are good to proceed.
|
||||||
|
|
||||||
|
@ -18,14 +18,10 @@ The computer running Home Assistant must support CEC, and of course be connected
|
|||||||
|
|
||||||
### libcec
|
### libcec
|
||||||
|
|
||||||
|
This section only applies to users of Home Assistant Core in a Python virtual environment.
|
||||||
|
|
||||||
[libcec](https://github.com/Pulse-Eight/libcec) must be installed for this integration to work. Follow the installation instructions for your environment, provided at the link. `libcec` installs Python 3 bindings by default as a system Python module. If you are running Home Assistant in a [Python virtual environment](/docs/installation/virtualenv/), make sure it can access the system module, by either symlinking it or using the `--system-site-packages` flag.
|
[libcec](https://github.com/Pulse-Eight/libcec) must be installed for this integration to work. Follow the installation instructions for your environment, provided at the link. `libcec` installs Python 3 bindings by default as a system Python module. If you are running Home Assistant in a [Python virtual environment](/docs/installation/virtualenv/), make sure it can access the system module, by either symlinking it or using the `--system-site-packages` flag.
|
||||||
|
|
||||||
<div class='note'>
|
|
||||||
|
|
||||||
If you are using [Hass.io](/hassio/) then just move forward to the configuration as all requirements are already fulfilled.
|
|
||||||
|
|
||||||
</div>
|
|
||||||
|
|
||||||
#### Symlinking into virtual environment
|
#### Symlinking into virtual environment
|
||||||
|
|
||||||
Create a symlink to the `cec` installation including the _cec.so file. Keep in mind different installation methods will result in different locations of cec.
|
Create a symlink to the `cec` installation including the _cec.so file. Keep in mind different installation methods will result in different locations of cec.
|
||||||
|
@ -12,7 +12,7 @@ ha_codeowners:
|
|||||||
|
|
||||||
The `heatmiser` climate platform let you control [Heatmiser DT/DT-E/PRT/PRT-E](https://www.heatmisershop.co.uk/room-thermostats/) thermostats from Heatmiser. The module itself is currently setup to work over a RS232 -> RS485 converter, therefore it connects over IP.
|
The `heatmiser` climate platform let you control [Heatmiser DT/DT-E/PRT/PRT-E](https://www.heatmisershop.co.uk/room-thermostats/) thermostats from Heatmiser. The module itself is currently setup to work over a RS232 -> RS485 converter, therefore it connects over IP.
|
||||||
|
|
||||||
Further work would be required to get this setup to connect over Wifi, but the HeatmiserV3 python module being used is a full implementation of the V3 protocol.
|
Further work would be required to get this setup to connect over Wi-Fi, but the HeatmiserV3 Python module being used is a full implementation of the V3 protocol.
|
||||||
|
|
||||||
To set it up, add the following information to your `configuration.yaml` file:
|
To set it up, add the following information to your `configuration.yaml` file:
|
||||||
|
|
||||||
|
@ -44,7 +44,7 @@ Since CCU Version 3, the internal firewalls are enabled by default. You have to
|
|||||||
If you want to see if a specific device you have is supported, head over to the [pyhomematic](https://github.com/danielperna84/pyhomematic/tree/master/pyhomematic/devicetypes) repository and browse through the source code. A dictionary with the device identifiers (e.g., HM-Sec-SC-2) can be found within the relevant modules near the bottom. If your device is not supported, feel free to contribute.
|
If you want to see if a specific device you have is supported, head over to the [pyhomematic](https://github.com/danielperna84/pyhomematic/tree/master/pyhomematic/devicetypes) repository and browse through the source code. A dictionary with the device identifiers (e.g., HM-Sec-SC-2) can be found within the relevant modules near the bottom. If your device is not supported, feel free to contribute.
|
||||||
|
|
||||||
We automatically detect all devices we currently support and try to generate useful names. If you enable name-resolving, we try to fetch names from Metadata (Homegear), via JSON-RPC or the XML-API you may have installed on your CCU. Since this may fail this is disabled by default.
|
We automatically detect all devices we currently support and try to generate useful names. If you enable name-resolving, we try to fetch names from Metadata (Homegear), via JSON-RPC or the XML-API you may have installed on your CCU. Since this may fail this is disabled by default.
|
||||||
You can manually rename the created entities by using Home Assistant's [Customizing](/docs/configuration/customizing-devices/) feature. With it you are also able to hide entities you don't want to see in the UI. The HomeMatic integration is also supported by the [Entity Registry](https://developers.home-assistant.io/docs/en/entity_registry_index.html), which allows you to change the friendly name and the entity ID directly in the Home Assistant UI.
|
You can manually rename the created entities by using Home Assistant's [Customizing](/docs/configuration/customizing-devices/) feature. With it you are also able to hide entities you don't want to see in the UI. The Homematic integration is also supported by the [Entity Registry](https://developers.home-assistant.io/docs/en/entity_registry_index.html), which allows you to change the friendly name and the entity ID directly in the Home Assistant UI.
|
||||||
|
|
||||||
To set up the component, add the following information to your `configuration.yaml` file:
|
To set up the component, add the following information to your `configuration.yaml` file:
|
||||||
|
|
||||||
@ -81,7 +81,7 @@ Configuration variables (interface):
|
|||||||
|
|
||||||
{% configuration %}
|
{% configuration %}
|
||||||
host:
|
host:
|
||||||
description: IP address or Hostname of CCU/Homegear device or Hass.io add-on.
|
description: IP address or hostname of CCU/Homegear device or Home Assistant add-on.
|
||||||
required: true
|
required: true
|
||||||
type: string
|
type: string
|
||||||
port:
|
port:
|
||||||
@ -223,7 +223,7 @@ The values of variables are polled from the CCU/Homegear in an interval of 30 se
|
|||||||
|
|
||||||
### Events
|
### Events
|
||||||
|
|
||||||
When HomeMatic devices change their state or some other internal value, the CCU/Homegear sends event messages to Home Assistant. These events are automatically parsed and the entities in Home Assistant are updated. However, you can also manually use these events to trigger automations. Two event-types are available:
|
When Homematic devices change their state or some other internal value, the CCU/Homegear sends event messages to Home Assistant. These events are automatically parsed and the entities in Home Assistant are updated. However, you can also manually use these events to trigger automations. Two event-types are available:
|
||||||
|
|
||||||
- **homematic.keypress**: For devices with buttons, see information below
|
- **homematic.keypress**: For devices with buttons, see information below
|
||||||
- **homematic.impulse**: For impulse sensors
|
- **homematic.impulse**: For impulse sensors
|
||||||
@ -263,9 +263,9 @@ You can test whether your button works within Home Assistant if you look at the
|
|||||||
|
|
||||||
It may happen that "your_nice_name" is not resolved correctly; the according message (#2 in the above example) will be missing. This might be due to secure communication between your HM interface and the HM device. You can change the communication from "secure" to "standard" within your HM-interface to solve that issue (in "Einstellungen" - "Geräte" find your device and change "Übertragungsmodus" from secure to standard) - not recommended for devices that should have secure communication.
|
It may happen that "your_nice_name" is not resolved correctly; the according message (#2 in the above example) will be missing. This might be due to secure communication between your HM interface and the HM device. You can change the communication from "secure" to "standard" within your HM-interface to solve that issue (in "Einstellungen" - "Geräte" find your device and change "Übertragungsmodus" from secure to standard) - not recommended for devices that should have secure communication.
|
||||||
|
|
||||||
#### `homematic.keypress` events for HomeMatic IP devices
|
#### `homematic.keypress` events for Homematic IP devices
|
||||||
|
|
||||||
To get the `homematic.keypress` event for some HomeMatic IP devices like WRC2 / WRC6 (wall switch) or SPDR (passage sensor) or the KRC4 (key ring remote control) you have to temporary create an empty program for each channel in the CCU:
|
To get the `homematic.keypress` event for some Homematic IP devices like WRC2 / WRC6 (wall switch) or SPDR (passage sensor) or the KRC4 (key ring remote control) you have to temporary create an empty program for each channel in the CCU:
|
||||||
|
|
||||||
1. In the menu of your CCU's admin panel go to `Programs and connections` > `Programs & CCU connection`
|
1. In the menu of your CCU's admin panel go to `Programs and connections` > `Programs & CCU connection`
|
||||||
2. Go to `New` in the footer menu
|
2. Go to `New` in the footer menu
|
||||||
@ -325,7 +325,7 @@ action:
|
|||||||
|
|
||||||
#### Advanced examples
|
#### Advanced examples
|
||||||
|
|
||||||
If you are familiar with the internals of HomeMatic devices, you can manually set values on the devices. This can serve as a workaround if support for a device is currently not available, or only limited functionality has been implemented.
|
If you are familiar with the internals of Homematic devices, you can manually set values on the devices. This can serve as a workaround if support for a device is currently not available, or only limited functionality has been implemented.
|
||||||
Using this service provides you direct access to the setValue-method of the primary connection. If you have multiple hosts, you may select the one hosting a specific device by providing the proxy-parameter with a value equivalent to the name you have chosen. In the example configuration from above `rf`, `wired` and `ip` would be valid values.
|
Using this service provides you direct access to the setValue-method of the primary connection. If you have multiple hosts, you may select the one hosting a specific device by providing the proxy-parameter with a value equivalent to the name you have chosen. In the example configuration from above `rf`, `wired` and `ip` would be valid values.
|
||||||
|
|
||||||
Manually turn on a switch actor:
|
Manually turn on a switch actor:
|
||||||
@ -402,7 +402,7 @@ action:
|
|||||||
|
|
||||||
#### Detecting lost connections
|
#### Detecting lost connections
|
||||||
|
|
||||||
When the connection to your HomeMatic CCU or Homegear is lost, Home Assistant will stop getting updates from devices. This may happen after rebooting the CCU for example. Due to the nature of the communication protocol this cannot be handled automatically, so you must call *homematic.reconnect* in this case. That's why it is usually a good idea to check if your HomeMatic integrations are still updated properly, in order to detect connection losses. This can be done in several ways through an automation:
|
When the connection to your Homematic CCU or Homegear is lost, Home Assistant will stop getting updates from devices. This may happen after rebooting the CCU for example. Due to the nature of the communication protocol this cannot be handled automatically, so you must call *homematic.reconnect* in this case. That's why it is usually a good idea to check if your Homematic integrations are still updated properly, in order to detect connection losses. This can be done in several ways through an automation:
|
||||||
|
|
||||||
- If you have a sensor which you know will be updated frequently (e.g., an outdoor temperature sensor, voltage sensor or light sensor) you could set up a helper binary sensor and an automation like this:
|
- If you have a sensor which you know will be updated frequently (e.g., an outdoor temperature sensor, voltage sensor or light sensor) you could set up a helper binary sensor and an automation like this:
|
||||||
|
|
||||||
@ -445,7 +445,7 @@ When the connection to your HomeMatic CCU or Homegear is lost, Home Assistant wi
|
|||||||
obj.State(now);
|
obj.State(now);
|
||||||
```
|
```
|
||||||
|
|
||||||
The HomeMatic CCU will execute all active programs which meet their conditions (none in this case) on every reboot.
|
The Homematic CCU will execute all active programs which meet their conditions (none in this case) on every reboot.
|
||||||
|
|
||||||
3. Set up a template sensor in Home Assistant, which contains the value of the system variable:
|
3. Set up a template sensor in Home Assistant, which contains the value of the system variable:
|
||||||
|
|
||||||
|
@ -121,7 +121,7 @@ Within this delay the device registration should be completed in the App, otherw
|
|||||||
* Floor Heating Actuator – 10x channels, 230V (*HMIP-FAL230-C10*)
|
* Floor Heating Actuator – 10x channels, 230V (*HMIP-FAL230-C10*)
|
||||||
* Floor Heating Actuator – 6x channels, 24V (*HMIP-FAL24-C6*)
|
* Floor Heating Actuator – 6x channels, 24V (*HMIP-FAL24-C6*)
|
||||||
* Floor Heating Actuator – 10x channels, 24V (*HMIP-FAL24-C10*)
|
* Floor Heating Actuator – 10x channels, 24V (*HMIP-FAL24-C10*)
|
||||||
* Floor Heating Actuator – 12x channels, motorised (*HMIP-FALMOT-C12*)
|
* Floor Heating Actuator – 12x channels, motorized (*HMIP-FALMOT-C12*)
|
||||||
|
|
||||||
* homematicip_cloud.cover
|
* homematicip_cloud.cover
|
||||||
* Shutter actuator for brand-mount (*HmIP-BROLL*)
|
* Shutter actuator for brand-mount (*HmIP-BROLL*)
|
||||||
|
@ -22,7 +22,7 @@ There is currently support for the following device types within Home Assistant:
|
|||||||
|
|
||||||
<div class='note'>
|
<div class='note'>
|
||||||
|
|
||||||
Don't use option `server_host` on a Hass.io installation!
|
The option option `server_host` should only be used on a Home Assistant Core installation!
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
@ -14,7 +14,7 @@ ha_config_flow: true
|
|||||||
|
|
||||||
## Sending events from IFTTT to Home Assistant
|
## Sending events from IFTTT to Home Assistant
|
||||||
|
|
||||||
To be able to receive events from IFTTT, your Home Assistant instance needs to be accessible from the web ([Hass.io instructions](/addons/duckdns/)) and you need to have the `base_url` configured for the HTTP integration ([docs](/integrations/http/#base_url)).
|
To be able to receive events from IFTTT, your Home Assistant instance needs to be accessible from the web and you need to have the `base_url` configured for the HTTP integration ([docs](/integrations/http/#base_url)).
|
||||||
|
|
||||||
### Setting up the integration
|
### Setting up the integration
|
||||||
|
|
||||||
|
@ -54,7 +54,7 @@ automation:
|
|||||||
|
|
||||||
The following event attributes will be present (platform-dependent): `entity_id`, `name`, `confidence`, `age`, `gender`, `motion`, `glasses`
|
The following event attributes will be present (platform-dependent): `entity_id`, `name`, `confidence`, `age`, `gender`, `motion`, `glasses`
|
||||||
|
|
||||||
## scan_interval and Optimising Resources
|
## scan_interval and optimizing Resources
|
||||||
|
|
||||||
Image processing integrations process the image from a camera at a fixed period given by the `scan_interval`. This leads to excessive processing if the image on the camera hasn't changed, as the default `scan_interval` is 10 seconds. You can override this by adding to your configuration `scan_interval: 10000` (setting the interval to 10,000 seconds), and then call the `image_processing.scan` service when you actually want to perform processing.
|
Image processing integrations process the image from a camera at a fixed period given by the `scan_interval`. This leads to excessive processing if the image on the camera hasn't changed, as the default `scan_interval` is 10 seconds. You can override this by adding to your configuration `scan_interval: 10000` (setting the interval to 10,000 seconds), and then call the `image_processing.scan` service when you actually want to perform processing.
|
||||||
|
|
||||||
|
@ -38,7 +38,7 @@ The `juicenet` sensor platform allows you to get data from your [JuiceNet](https
|
|||||||
|
|
||||||
### Added sensors
|
### Added sensors
|
||||||
|
|
||||||
These sensors will be added for each juicenet device in your account:
|
These sensors will be added for each JuiceNet device in your account:
|
||||||
|
|
||||||
- Status
|
- Status
|
||||||
- Temperature (inside the device)
|
- Temperature (inside the device)
|
||||||
|
@ -34,4 +34,4 @@ pip3 install [package name]
|
|||||||
|
|
||||||
x64 Windows users may have trouble installing pywin through pip. Using an [executable installer](https://sourceforge.net/projects/pywin32/files/pywin32/) should work around this issue.
|
x64 Windows users may have trouble installing pywin through pip. Using an [executable installer](https://sourceforge.net/projects/pywin32/files/pywin32/) should work around this issue.
|
||||||
|
|
||||||
[Similar installers](https://www.lfd.uci.edu/~gohlke/pythonlibs/#pyhook) (unofficial) for pyhook have been ported to python 3.4 and should help with x64 pip issues with pyhook.
|
[Similar installers](https://www.lfd.uci.edu/~gohlke/pythonlibs/#pyhook) (unofficial) for pyhook have been ported to Python 3.4 and should help with x64 pip issues with pyhook.
|
||||||
|
@ -52,7 +52,7 @@ device_name:
|
|||||||
type: string
|
type: string
|
||||||
{% endconfiguration %}
|
{% endconfiguration %}
|
||||||
|
|
||||||
Either `device_name` or `device_descriptor` must be present in the configuration entry. Indicating a device name is useful in case of repeating disconnections and re-connections of the device (for example, a bluetooth keyboard): the local input device file might change, thus breaking the configuration, while the name remains the same.
|
Either `device_name` or `device_descriptor` must be present in the configuration entry. Indicating a device name is useful in case of repeating disconnections and re-connections of the device (for example, a Bluetooth keyboard): the local input device file might change, thus breaking the configuration, while the name remains the same.
|
||||||
In case of presence of multiple devices of the same model, `device_descriptor` must be used.
|
In case of presence of multiple devices of the same model, `device_descriptor` must be used.
|
||||||
|
|
||||||
A list of possible device descriptors and names is reported in the debug log at startup when the device indicated in the configuration entry could not be found.
|
A list of possible device descriptors and names is reported in the debug log at startup when the device indicated in the configuration entry could not be found.
|
||||||
@ -96,7 +96,7 @@ automation:
|
|||||||
entity_id: light.all
|
entity_id: light.all
|
||||||
```
|
```
|
||||||
|
|
||||||
`device_descriptor` or `device_name` may be specificed in the trigger so the automation will be fired only for that keyboard. This is especially useful if you wish to use several bluetooth remotes to control different devices. Omit them to ensure the same key triggers the automation for all keyboards/remotes.
|
`device_descriptor` or `device_name` may be specificed in the trigger so the automation will be fired only for that keyboard. This is especially useful if you wish to use several Bluetooth remotes to control different devices. Omit them to ensure the same key triggers the automation for all keyboards/remotes.
|
||||||
|
|
||||||
## Disconnections
|
## Disconnections
|
||||||
|
|
||||||
|
@ -138,7 +138,7 @@ payload:
|
|||||||
type: [integer, list]
|
type: [integer, list]
|
||||||
{% endconfiguration %}
|
{% endconfiguration %}
|
||||||
|
|
||||||
### Exposing sensor values or time to knx bus
|
### Exposing sensor values or time to KNX bus
|
||||||
|
|
||||||
KNX integration is able to expose time or sensor values to KNX bus. The integration will broadcast any change of the exposed value to the KNX bus and answer read requests to the specified group address:
|
KNX integration is able to expose time or sensor values to KNX bus. The integration will broadcast any change of the exposed value to the KNX bus and answer read requests to the specified group address:
|
||||||
|
|
||||||
|
@ -96,7 +96,7 @@ sensor:
|
|||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
To setup a lacrosse sensor with multiple sensors, add the following to your `configuration.yaml` file:
|
To setup a LaCrosse sensor with multiple sensors, add the following to your `configuration.yaml` file:
|
||||||
|
|
||||||
{% raw %}
|
{% raw %}
|
||||||
```yaml
|
```yaml
|
||||||
|
@ -14,7 +14,7 @@ The `knx` integration must be configured correctly to use this integration, see
|
|||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
The `knx light` integration is used as an interface to control knx actuators for lighting applications such as:
|
The `knx light` integration is used as an interface to control KNX actuators for lighting applications such as:
|
||||||
|
|
||||||
- switching actuators
|
- switching actuators
|
||||||
- dimming actuators
|
- dimming actuators
|
||||||
|
@ -43,16 +43,16 @@ logger:
|
|||||||
logs:
|
logs:
|
||||||
# log level for HA core
|
# log level for HA core
|
||||||
homeassistant.core: fatal
|
homeassistant.core: fatal
|
||||||
|
|
||||||
# log level for MQTT integration
|
# log level for MQTT integration
|
||||||
homeassistant.components.mqtt: warning
|
homeassistant.components.mqtt: warning
|
||||||
|
|
||||||
# log level for all python scripts
|
# log level for all python scripts
|
||||||
homeassistant.components.python_script: warning
|
homeassistant.components.python_script: warning
|
||||||
|
|
||||||
# individual log level for this python script
|
# individual log level for this python script
|
||||||
homeassistant.components.python_script.my_new_script.py: debug
|
homeassistant.components.python_script.my_new_script.py: debug
|
||||||
|
|
||||||
# log level for SmartThings lights
|
# log level for SmartThings lights
|
||||||
homeassistant.components.smartthings.light: info
|
homeassistant.components.smartthings.light: info
|
||||||
|
|
||||||
@ -69,7 +69,7 @@ logger:
|
|||||||
|
|
||||||
The log entries are in the form
|
The log entries are in the form
|
||||||
*timestamp* *log-level* *thread* [**namespace**] *message*
|
*timestamp* *log-level* *thread* [**namespace**] *message*
|
||||||
where **namespace** is the *<component_namespace>* currently logging.
|
where **namespace** is the *<component_namespace>* currently logging.
|
||||||
|
|
||||||
{% configuration %}
|
{% configuration %}
|
||||||
default:
|
default:
|
||||||
@ -87,12 +87,12 @@ where **namespace** is the *<component_namespace>* currently logging.
|
|||||||
type: string
|
type: string
|
||||||
{% endconfiguration %}
|
{% endconfiguration %}
|
||||||
|
|
||||||
In the example, do note the difference between 'glances_api' and 'homeassistant.components.glances' namespaces,
|
In the example, do note the difference between 'glances_api' and 'homeassistant.components.glances' namespaces,
|
||||||
both of which are at root. They are logged by different APIs.
|
both of which are at root. They are logged by different APIs.
|
||||||
|
|
||||||
If you want to know the namespaces in your own environment then check your log files on startup.
|
If you want to know the namespaces in your own environment then check your log files on startup.
|
||||||
You will see INFO log messages from homeassistant.loader stating `loaded <component> from <namespace>`.
|
You will see INFO log messages from homeassistant.loader stating `loaded <component> from <namespace>`.
|
||||||
Those are the namespaces available for you to set a `log level` against.
|
Those are the namespaces available for you to set a `log level` against.
|
||||||
|
|
||||||
### Log Levels
|
### Log Levels
|
||||||
|
|
||||||
@ -144,11 +144,10 @@ The log information are stored in the
|
|||||||
and you can read it with the command-line tool `cat` or follow it dynamically
|
and you can read it with the command-line tool `cat` or follow it dynamically
|
||||||
with `tail -f`.
|
with `tail -f`.
|
||||||
|
|
||||||
If you are a Hass.io user, you can use the example below, when logged in through
|
You can use the example below, when logged in through the [SSH add-on](/addons/ssh/):
|
||||||
the [SSH add-on](/addons/ssh/):
|
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
$ tail -f /config/home-assistant.log
|
tail -f /config/home-assistant.log
|
||||||
```
|
```
|
||||||
|
|
||||||
On Docker you can use your host command line directly - follow the logs dynamically with:
|
On Docker you can use your host command line directly - follow the logs dynamically with:
|
||||||
|
@ -8,7 +8,7 @@ ha_release: 0.38
|
|||||||
ha_config_flow: true
|
ha_config_flow: true
|
||||||
---
|
---
|
||||||
|
|
||||||
To be able to receive webhooks from Mailgun, your Home Assistant instance needs to be accessible from the web ([Hass.io instructions](/addons/duckdns/)) and you need to have the `base_url` configured for the HTTP integration ([docs](/integrations/http/#base_url)).
|
To be able to receive webhooks from Mailgun, your Home Assistant instance needs to be accessible from the web and you need to have the `base_url` configured for the HTTP integration ([docs](/integrations/http/#base_url)).
|
||||||
|
|
||||||
To set it up, go to the integrations page in the configuration screen and find Mailgun. Click on configure. Follow the instructions on the screen to configure Mailgun.
|
To set it up, go to the integrations page in the configuration screen and find Mailgun. Click on configure. Follow the instructions on the screen to configure Mailgun.
|
||||||
|
|
||||||
|
@ -65,7 +65,7 @@ commands:
|
|||||||
required: false
|
required: false
|
||||||
type: string
|
type: string
|
||||||
expression:
|
expression:
|
||||||
description: "Specifies a regular expression (in python regexp syntax) that the bot should listen to. The bot will react to any message that matches the regular expression."
|
description: "Specifies a regular expression (in Python regexp syntax) that the bot should listen to. The bot will react to any message that matches the regular expression."
|
||||||
required: false
|
required: false
|
||||||
type: string
|
type: string
|
||||||
name:
|
name:
|
||||||
|
@ -16,7 +16,7 @@ The `mcp23017` integration is the base for all related mcp23017 platforms in Hom
|
|||||||
|
|
||||||
For more details about the MCP23017 I2C I/O port expander you can find its datasheet here: [MCP23017](https://www.microchip.com/wwwproducts/en/MCP23017).
|
For more details about the MCP23017 I2C I/O port expander you can find its datasheet here: [MCP23017](https://www.microchip.com/wwwproducts/en/MCP23017).
|
||||||
|
|
||||||
If you are using Hass.io on HassOS you can’t use existing methods to enable the I2C bus on a Raspberry Pi, you will have to [enable the I2C interface in the Hass.io configuration](https://github.com/home-assistant/hassos/blob/dev/Documentation/boards/raspberrypi.md#i2c) using a USB stick. To accomplish that, follow this step by step instructions: [Enable HassOS i2c](https://www.home-assistant.io/hassio/enable_i2c).
|
If you are using the Home Assistant Operating System you can’t use existing methods to enable the I2C bus on a Raspberry Pi, you will have to [enable the I2C interface manually](https://github.com/home-assistant/hassos/blob/dev/Documentation/boards/raspberrypi.md#i2c) using a USB stick. To accomplish that, follow this step by step instructions: [Enable Home Assistant Operating System i2c](https://www.home-assistant.io/hassio/enable_i2c).
|
||||||
|
|
||||||
## Binary Sensor
|
## Binary Sensor
|
||||||
|
|
||||||
|
@ -32,6 +32,7 @@ sensor:
|
|||||||
- **temperature**
|
- **temperature**
|
||||||
|
|
||||||
Full example:
|
Full example:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
sensor:
|
sensor:
|
||||||
- platform: mhz19
|
- platform: mhz19
|
||||||
@ -42,7 +43,7 @@ sensor:
|
|||||||
- temperature
|
- temperature
|
||||||
```
|
```
|
||||||
|
|
||||||
## Raspberry Pi 3(+) GPIO UART and Hass.io
|
## Raspberry Pi GPIO UART and the Home Assistant Operating System
|
||||||
|
|
||||||
To directly connect the sensor on the GPIO pins of a RPi, first append the following to `config.txt` in the boot directory:
|
To directly connect the sensor on the GPIO pins of a RPi, first append the following to `config.txt` in the boot directory:
|
||||||
|
|
||||||
|
@ -19,8 +19,8 @@ There are "Chinese" and "International" versions available and there is a [repor
|
|||||||
|
|
||||||
Before configuring Home Assistant you need a Bluetooth backend and the MAC address of your sensor. Depending on your operating system, you may have to configure the proper Bluetooth backend for your system:
|
Before configuring Home Assistant you need a Bluetooth backend and the MAC address of your sensor. Depending on your operating system, you may have to configure the proper Bluetooth backend for your system:
|
||||||
|
|
||||||
- On [Hass.io](/hassio/installation/): Miflora will work out of the box.
|
- On [Home Assistant](/hassio/installation/): Miflora will work out of the box.
|
||||||
- On a [generic Docker installation](/docs/installation/docker/): Works out of the box with `--net=host` and properly configured Bluetooth on the host.
|
- On [Home Assistant Core on Docker](/docs/installation/docker/): Works out of the box with `--net=host` and properly configured Bluetooth on the host.
|
||||||
- On other Linux systems:
|
- On other Linux systems:
|
||||||
- Preferred solution: Install the `bluepy` library (via pip). When using a virtual environment, make sure to install the library in the right one.
|
- Preferred solution: Install the `bluepy` library (via pip). When using a virtual environment, make sure to install the library in the right one.
|
||||||
- Fallback solution: Install `gatttool` via your package manager. Depending on the distribution, the package name might be: `bluez`, `bluetooth`, `bluez-deprecated`
|
- Fallback solution: Install `gatttool` via your package manager. Depending on the distribution, the package name might be: `bluez`, `bluetooth`, `bluez-deprecated`
|
||||||
|
@ -14,8 +14,8 @@ The `mitemp_bt` sensor platform allows one to monitor room temperature and humid
|
|||||||
|
|
||||||
Depending on the operating system you're running, you have to configure the proper Bluetooth backend on your system:
|
Depending on the operating system you're running, you have to configure the proper Bluetooth backend on your system:
|
||||||
|
|
||||||
- On [Hass.io](/hassio/installation/): `mitemp_bt` will work out of the box as long as the host supports Bluetooth (like the Raspberry Pi does).
|
- On [Home Assistant](/hassio/installation/): `mitemp_bt` will work out of the box as long as the host supports Bluetooth (like the Raspberry Pi does).
|
||||||
- On a [generic Docker installation](/docs/installation/docker/): Works out of the box with `--net=host` and properly configured Bluetooth on the host.
|
- On a [Home Assistant Core on Docker](/docs/installation/docker/): Works out of the box with `--net=host` and properly configured Bluetooth on the host.
|
||||||
- On other Linux systems:
|
- On other Linux systems:
|
||||||
- Preferred solution: Install the `bluepy` and `btlewrap` library (via pip). When using a virtual environment, make sure to use install the library in the right one.
|
- Preferred solution: Install the `bluepy` and `btlewrap` library (via pip). When using a virtual environment, make sure to use install the library in the right one.
|
||||||
- Fallback solution: Install `btlewrap` library (via pip) and `gatttool` via your package manager. Depending on the distribution, the package name might be: `bluez`, `bluetooth` or `bluez-deprecated`.
|
- Fallback solution: Install `btlewrap` library (via pip) and `gatttool` via your package manager. Depending on the distribution, the package name might be: `bluez`, `bluetooth` or `bluez-deprecated`.
|
||||||
|
@ -308,19 +308,19 @@ monitored_conditions:
|
|||||||
The following conditions are available by device:
|
The following conditions are available by device:
|
||||||
|
|
||||||
- Nest Home:
|
- Nest Home:
|
||||||
- eta: Estimated time of arrival.
|
- `eta`: Estimated time of arrival.
|
||||||
- security\_state: `ok` or `deter`. [Security State](#security-state). Only available when Nest Camera exists.
|
- `security_state`: `ok` or `deter`. [Security State](#security-state). Only available when Nest Camera exists.
|
||||||
- Nest Thermostat:
|
- Nest Thermostat:
|
||||||
- humidity
|
- `humidity`
|
||||||
- preset\_mode
|
- `preset_mode`
|
||||||
- temperature
|
- `temperature`
|
||||||
- target
|
- `target`
|
||||||
- hvac\_state: The currently active state of the HVAC system, `heat`, `cool` or `off` (previously `heating`, `cooling` or `off`).
|
- `hvac_state`: The currently active state of the HVAC system, `heat`, `cool` or `off` (previously `heating`, `cooling` or `off`).
|
||||||
- Nest Protect:
|
- Nest Protect:
|
||||||
- co\_status: `Ok`, `Warning` or `Emergency`
|
- `co_status`: `Ok`, `Warning` or `Emergency`
|
||||||
- smoke\_status: `Ok`, `Warning` or `Emergency`
|
- `smoke_status`: `Ok`, `Warning` or `Emergency`
|
||||||
- battery\_health: `Ok` or `Replace`
|
- `battery_health`: `Ok` or `Replace`
|
||||||
- color\_status: `gray`, `green`, `yellow` or `red`. Indicates device status by color in the Nest app UI. It is an aggregate condition for battery+smoke+CO states, and reflects the actual color indicators displayed in the Nest app.
|
- `color_status`: `gray`, `green`, `yellow` or `red`. Indicates device status by color in the Nest app UI. It is an aggregate condition for battery+smoke+CO states, and reflects the actual color indicators displayed in the Nest app.
|
||||||
- Nest Camera: none
|
- Nest Camera: none
|
||||||
|
|
||||||
## Security State
|
## Security State
|
||||||
|
@ -8,7 +8,7 @@ ha_iot_class: Local Polling
|
|||||||
ha_release: pre 0.7
|
ha_release: pre 0.7
|
||||||
---
|
---
|
||||||
|
|
||||||
This platform allows you to detect presence by looking at connected devices to a [Netgear](https://www.netgear.com/) device.
|
This platform allows you to detect presence by looking at connected devices to a [NETGEAR](https://www.netgear.com/) device.
|
||||||
|
|
||||||
<div class='note'>
|
<div class='note'>
|
||||||
|
|
||||||
@ -49,7 +49,7 @@ password:
|
|||||||
required: true
|
required: true
|
||||||
type: string
|
type: string
|
||||||
devices:
|
devices:
|
||||||
description: If provided only specified devices will be reported. Can be MAC address or the device name as reported in the Netgear UI.
|
description: If provided only specified devices will be reported. Can be MAC address or the device name as reported in the NETGEAR UI.
|
||||||
required: false
|
required: false
|
||||||
type: list
|
type: list
|
||||||
exclude:
|
exclude:
|
||||||
@ -67,6 +67,7 @@ When `accesspoints` is specified an extra device will be reported for each devic
|
|||||||
The use of `devices` or `exclude` is recommended when using `accesspoints` to avoid having a lot of entries.
|
The use of `devices` or `exclude` is recommended when using `accesspoints` to avoid having a lot of entries.
|
||||||
|
|
||||||
List of models that are known to use port 80:
|
List of models that are known to use port 80:
|
||||||
|
|
||||||
- Nighthawk X4S - AC2600 (R7800)
|
- Nighthawk X4S - AC2600 (R7800)
|
||||||
- Orbi
|
- Orbi
|
||||||
- XR500
|
- XR500
|
||||||
|
@ -11,7 +11,7 @@ ha_category:
|
|||||||
ha_iot_class: Local Polling
|
ha_iot_class: Local Polling
|
||||||
---
|
---
|
||||||
|
|
||||||
The Netgear LTE integration for Home Assistant allows you to observe and control [Netgear LTE modems](https://www.netgear.com/home/products/mobile-broadband/lte-modems/default.aspx).
|
The NETGEAR LTE integration for Home Assistant allows you to observe and control [NETGEAR LTE modems](https://www.netgear.com/home/products/mobile-broadband/lte-modems/default.aspx).
|
||||||
|
|
||||||
There is currently support for the following device types within Home Assistant:
|
There is currently support for the following device types within Home Assistant:
|
||||||
|
|
||||||
@ -27,7 +27,6 @@ Splitting of long SMS messages is not supported so notifications can contain a m
|
|||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
|
|
||||||
To enable the integration, add the following lines to your `configuration.yaml` file:
|
To enable the integration, add the following lines to your `configuration.yaml` file:
|
||||||
@ -184,6 +183,7 @@ This service can set modem configuration options (otherwise available in the mod
|
|||||||
The following automation example processes incoming SMS messages with the [Conversation](/integrations/conversation/) integration and then deletes the message from the inbox.
|
The following automation example processes incoming SMS messages with the [Conversation](/integrations/conversation/) integration and then deletes the message from the inbox.
|
||||||
|
|
||||||
{% raw %}
|
{% raw %}
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
automation:
|
automation:
|
||||||
- alias: SMS conversation
|
- alias: SMS conversation
|
||||||
@ -199,4 +199,5 @@ automation:
|
|||||||
host: '{{ trigger.event.data.host }}'
|
host: '{{ trigger.event.data.host }}'
|
||||||
sms_id: '{{ trigger.event.data.sms_id }}'
|
sms_id: '{{ trigger.event.data.sms_id }}'
|
||||||
```
|
```
|
||||||
|
|
||||||
{% endraw %}
|
{% endraw %}
|
||||||
|
@ -13,11 +13,11 @@ As an alternative to the router-based device tracking, it is possible to directl
|
|||||||
Please keep in mind that modern smart phones will usually turn off WiFi when they are idle. Simple trackers like this may not be reliable on their own.
|
Please keep in mind that modern smart phones will usually turn off WiFi when they are idle. Simple trackers like this may not be reliable on their own.
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
You might have to install the packages for `arp` and `nmap`. On Debian based hosts (for example Raspbian) do so by running `$ sudo apt-get install net-tools nmap`. On a Fedora host run `$ sudo dnf -y install nmap`.
|
|
||||||
|
|
||||||
<div class='note'>
|
<div class='note'>
|
||||||
|
|
||||||
If you are using [Hass.io](/hassio/) then just move forward to the configuration as all requirements are already fulfilled.
|
If you are running Home Assistant Core in a Python virtual environment, you might have to install the packages for `arp` and `nmap`.
|
||||||
|
On Debian based hosts (for example Raspbian) do so by running `sudo apt-get install net-tools nmap`.
|
||||||
|
On a Fedora host run `sudo dnf -y install nmap`.
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
@ -78,6 +78,7 @@ device_tracker:
|
|||||||
- 10.0.0.2
|
- 10.0.0.2
|
||||||
- 10.0.0.15
|
- 10.0.0.15
|
||||||
```
|
```
|
||||||
|
|
||||||
In the above example, Nmap will be call with the process:
|
In the above example, Nmap will be call with the process:
|
||||||
`nmap -oX - 192.168.1.1/24 10.0.0.2 10.0.0.15 -F --host-timeout 5s`
|
`nmap -oX - 192.168.1.1/24 10.0.0.2 10.0.0.15 -F --host-timeout 5s`
|
||||||
|
|
||||||
@ -88,10 +89,11 @@ An example of how the Nmap scanner can be customized:
|
|||||||
On Linux systems (such as Hass.io) you can extend the functionality of Nmap, without having to run it as root, by using *Linux capabilities*. Be sure to specify the full path to wherever you installed Nmap:
|
On Linux systems (such as Hass.io) you can extend the functionality of Nmap, without having to run it as root, by using *Linux capabilities*. Be sure to specify the full path to wherever you installed Nmap:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
$ sudo setcap cap_net_raw,cap_net_admin,cap_net_bind_service+eip /usr/bin/nmap
|
sudo setcap cap_net_raw,cap_net_admin,cap_net_bind_service+eip /usr/bin/nmap
|
||||||
```
|
```
|
||||||
|
|
||||||
And you can set up the device tracker as
|
And you can set up the device tracker as
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
- platform: nmap_tracker
|
- platform: nmap_tracker
|
||||||
hosts: 192.168.1.1-25
|
hosts: 192.168.1.1-25
|
||||||
|
@ -27,7 +27,7 @@ The 1-Wire bus can be connected directly to the IO pins of Raspberry Pi or using
|
|||||||
## Raspberry Pi setup
|
## Raspberry Pi setup
|
||||||
|
|
||||||
In order to setup 1-Wire support on Raspberry Pi, you'll need to edit `/boot/config.txt` following [this documentation](https://www.waveshare.com/wiki/Raspberry_Pi_Tutorial_Series:_1-Wire_DS18B20_Sensor#Enable_1-Wire).
|
In order to setup 1-Wire support on Raspberry Pi, you'll need to edit `/boot/config.txt` following [this documentation](https://www.waveshare.com/wiki/Raspberry_Pi_Tutorial_Series:_1-Wire_DS18B20_Sensor#Enable_1-Wire).
|
||||||
To edit `/boot/config.txt` on Hass.io use [this documentation](https://developers.home-assistant.io/docs/en/hassio_debugging.html) to enable SSH and edit `/mnt/boot/config.txt` via `vi`.
|
To edit `/boot/config.txt` on the Home Assistant Operating System, use [this documentation](https://developers.home-assistant.io/docs/en/hassio_debugging.html) to enable SSH and edit `/mnt/boot/config.txt` via `vi`.
|
||||||
|
|
||||||
## Interface adapter setup
|
## Interface adapter setup
|
||||||
|
|
||||||
@ -49,6 +49,7 @@ Connect to your database using the instructions from [Database section](/docs/ba
|
|||||||
```sql
|
```sql
|
||||||
SELECT entity_id, COUNT(*) as count FROM states GROUP BY entity_id ORDER BY count DESC LIMIT 10;
|
SELECT entity_id, COUNT(*) as count FROM states GROUP BY entity_id ORDER BY count DESC LIMIT 10;
|
||||||
```
|
```
|
||||||
|
|
||||||
Alter the names of sensors using the following examples:
|
Alter the names of sensors using the following examples:
|
||||||
|
|
||||||
```sql
|
```sql
|
||||||
|
@ -88,7 +88,7 @@ If your source is not listed above, and you want to figure out how to format tha
|
|||||||
onkyo --host 192.168.0.100 source=query
|
onkyo --host 192.168.0.100 source=query
|
||||||
```
|
```
|
||||||
|
|
||||||
To find your receivers max volume use the onkyo-eiscp python module set the receiver to its maximum volume
|
To find your receivers max volume use the onkyo-eiscp Python module set the receiver to its maximum volume
|
||||||
(don't do this whilst playing something!) and run:
|
(don't do this whilst playing something!) and run:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
@ -8,7 +8,7 @@ ha_release: 0.36
|
|||||||
---
|
---
|
||||||
|
|
||||||
[OpenALPR](https://www.openalpr.com/) integration for Home Assistant allows you
|
[OpenALPR](https://www.openalpr.com/) integration for Home Assistant allows you
|
||||||
to process licences plates from a camera. You can use them to open a garage door
|
to process license plates from a camera. You can use them to open a garage door
|
||||||
or trigger any other [automation](/integrations/automation/).
|
or trigger any other [automation](/integrations/automation/).
|
||||||
|
|
||||||
For using the result inside an automation rule,
|
For using the result inside an automation rule,
|
||||||
|
@ -8,7 +8,7 @@ ha_release: 0.36
|
|||||||
---
|
---
|
||||||
|
|
||||||
[OpenALPR](https://www.openalpr.com/) integration for Home Assistant allows you
|
[OpenALPR](https://www.openalpr.com/) integration for Home Assistant allows you
|
||||||
to process licences plates from a camera. You can use them to open a garage door
|
to process license plates from a camera. You can use them to open a garage door
|
||||||
or trigger any other [automation](/integrations/automation/).
|
or trigger any other [automation](/integrations/automation/).
|
||||||
|
|
||||||
For using the result inside an automation rule, take a look at the
|
For using the result inside an automation rule, take a look at the
|
||||||
|
@ -30,7 +30,7 @@ image_processing:
|
|||||||
- **source** array (*Required*): List of image sources.
|
- **source** array (*Required*): List of image sources.
|
||||||
- **entity_id** (*Required*): A camera entity id to get picture from.
|
- **entity_id** (*Required*): A camera entity id to get picture from.
|
||||||
- **name** (*Optional*): This parameter allows you to override the name of your `image_processing` entity.
|
- **name** (*Optional*): This parameter allows you to override the name of your `image_processing` entity.
|
||||||
- **classifier** (*Optional*): Dictionary of name to path to the classifier xml file. If this field is not provided, a face classifier will be downloaded from OpenCV's GitHub repository.
|
- **classifier** (*Optional*): Dictionary of name to path to the classifier XML file. If this field is not provided, a face classifier will be downloaded from OpenCV's GitHub repository.
|
||||||
|
|
||||||
**classifier** may also be defined as a dictionary of names to classifier configurations:
|
**classifier** may also be defined as a dictionary of names to classifier configurations:
|
||||||
|
|
||||||
@ -42,6 +42,6 @@ image_processing:
|
|||||||
scale: 1.1f
|
scale: 1.1f
|
||||||
```
|
```
|
||||||
|
|
||||||
- **file** (*Required*): The path to the classifier xml file.
|
- **file** (*Required*): The path to the classifier XML file.
|
||||||
- **scale** (*Optional*): The scale to perform when processing, this is a `float` value that must be greater than or equal to `1.0`, default is `1.1`.
|
- **scale** (*Optional*): The scale to perform when processing, this is a `float` value that must be greater than or equal to `1.0`, default is `1.1`.
|
||||||
- **neighbors** (*Optional*): The minimum number of neighbors required for a match, default is `4`. The higher this number, the more picky the matching will be; lower the number, the more false positives you may experience.
|
- **neighbors** (*Optional*): The minimum number of neighbors required for a match, default is `4`. The higher this number, the more picky the matching will be; lower the number, the more false positives you may experience.
|
||||||
|
@ -513,8 +513,8 @@ Possible modes and their meaning for the GPIO pins are listed here:
|
|||||||
|
|
||||||
Possible LED modes and their meaning are listed here:
|
Possible LED modes and their meaning are listed here:
|
||||||
|
|
||||||
* R. Receiving an Opentherm message from the thermostat or boiler.
|
* R. Receiving an OpenTherm message from the thermostat or boiler.
|
||||||
* X. Transmitting an Opentherm message to the thermostat or boiler.
|
* X. Transmitting an OpenTherm message to the thermostat or boiler.
|
||||||
* T. Transmitting or receiving a message on the thermostat interface.
|
* T. Transmitting or receiving a message on the thermostat interface.
|
||||||
* B. Transmitting or receiving a message on the boiler interface.
|
* B. Transmitting or receiving a message on the boiler interface.
|
||||||
* O. Remote setpoint override is active.
|
* O. Remote setpoint override is active.
|
||||||
|
@ -36,7 +36,7 @@ token:
|
|||||||
|
|
||||||
## Generating a token
|
## Generating a token
|
||||||
|
|
||||||
A simple way to generate a `token` for a new sensor is to run this snippet of python code in your Home Assistant virtual environment:
|
A simple way to generate a `token` for a new sensor is to run this snippet of Python code in your Home Assistant virtual environment:
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
$ pip3 install pyotp
|
$ pip3 install pyotp
|
||||||
|
@ -26,7 +26,7 @@ pi_hole:
|
|||||||
{% configuration %}
|
{% configuration %}
|
||||||
host:
|
host:
|
||||||
description: >
|
description: >
|
||||||
The hostname (and port), e.g. '192.168.0.3:4865' of the host where Pi-hole is running. Hass.io add-on users should be sure to specify port `4865`.
|
The hostname (and port), e.g. '192.168.0.3:4865' of the host where Pi-hole is running. Home Assistant add-on users should be sure to specify port `4865`.
|
||||||
required: true
|
required: true
|
||||||
type: string
|
type: string
|
||||||
name:
|
name:
|
||||||
@ -62,7 +62,7 @@ api_key:
|
|||||||
|
|
||||||
### Full examples
|
### Full examples
|
||||||
|
|
||||||
Single Pi-hole running via Hass.io add-on:
|
Single Pi-hole running via Home Assistant add-on:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
pi_hole:
|
pi_hole:
|
||||||
@ -105,7 +105,7 @@ Disables configured Pi-hole(s) for the specified amount of time.
|
|||||||
|
|
||||||
| Service data attribute | Required | Type | Description |
|
| Service data attribute | Required | Type | Description |
|
||||||
| ---------------------- | -------- | -------- | ----------- |
|
| ---------------------- | -------- | -------- | ----------- |
|
||||||
| `duration` | `True` | timedelta | Time for which Pi-hole should be disabled |
|
| `duration` | `True` | timedelta | Time for which Pi-hole should be disabled |
|
||||||
| `name` | `False` | string | If preset, disables the named Pi-hole, otherwise, disables all configured Pi-holes |
|
| `name` | `False` | string | If preset, disables the named Pi-hole, otherwise, disables all configured Pi-holes |
|
||||||
|
|
||||||
_Note: This service requires `api_key` to be specified in the configuration._
|
_Note: This service requires `api_key` to be specified in the configuration._
|
||||||
|
@ -39,14 +39,14 @@ The `ps4` integration allows you to control a
|
|||||||
The PlayStation 4 integration requires the use of privileged ports to work correctly, specifically UDP port 987 and TCP port 997. Depending on your OS of your Home Assistant instance, you may need to allow usage of privileged ports manually.
|
The PlayStation 4 integration requires the use of privileged ports to work correctly, specifically UDP port 987 and TCP port 997. Depending on your OS of your Home Assistant instance, you may need to allow usage of privileged ports manually.
|
||||||
|
|
||||||
<div class='note warning'>
|
<div class='note warning'>
|
||||||
Do not run your <b>Home Assistant</b> instance itself as <b>root</b> or with <b>root/sudo privileges</b> to accomplish this. This would create a security risk for your host system.
|
Do not run your <b>Home Assistant Core</b> instance itself as <b>root</b> or with <b>root/sudo privileges</b> to accomplish this. This would create a security risk for your host system.
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
There are varying methods to perform this, dependent on your OS that is running Home Assistant. Specifically, your *Python Interpreter*, which runs your Home Assistant instance, needs access to the mentioned ports.
|
There are varying methods to perform this, dependent on your OS that is running Home Assistant. Specifically, your *Python Interpreter*, which runs your Home Assistant instance, needs access to the mentioned ports.
|
||||||
|
|
||||||
<div class='note'>
|
<div class='note'>
|
||||||
|
|
||||||
If your Home Assistant device is running **Hass.io** on **HassOS**, it does not require additional configuration.
|
Additional configuration is only required for Home Assistant Core users **not** running on Docker.
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
@ -88,7 +88,7 @@ To find your system Python path:
|
|||||||
whereis python3.5.3
|
whereis python3.5.3
|
||||||
```
|
```
|
||||||
|
|
||||||
The output which has the directory `/bin/` is likely your system python path which should look like this `/usr/bin/python3.5`
|
The output which has the directory `/bin/` is likely your system Python path which should look like this `/usr/bin/python3.5`
|
||||||
|
|
||||||
- If Home Assistant is installed in a virtual environment, use terminal to `cd` to the root/top directory of your environment and run:
|
- If Home Assistant is installed in a virtual environment, use terminal to `cd` to the root/top directory of your environment and run:
|
||||||
|
|
||||||
|
@ -12,7 +12,7 @@ ha_iot_class: Local Push
|
|||||||
|
|
||||||
The `rpi_gpio` integration is the base for all related GPIO platforms in Home Assistant. For the platform configurations, please check their corresponding sections.
|
The `rpi_gpio` integration is the base for all related GPIO platforms in Home Assistant. For the platform configurations, please check their corresponding sections.
|
||||||
|
|
||||||
The remote RPi and the control computer where Home Assistant is running must be prepared to run remote_rpi_gpio, see details [here](https://gpiozero.readthedocs.io/en/stable/remote_gpio.html).
|
The remote Raspberry Pi and the control computer where Home Assistant is running must be prepared to run remote_rpi_gpio, see details [here](https://gpiozero.readthedocs.io/en/stable/remote_gpio.html).
|
||||||
|
|
||||||
Note that for virtual environments you may need to set an environment variable when starting the environment to set the pin factory, example:
|
Note that for virtual environments you may need to set an environment variable when starting the environment to set the pin factory, example:
|
||||||
|
|
||||||
|
@ -19,9 +19,12 @@ There is currently support for the following device types within Home Assistant:
|
|||||||
|
|
||||||
Set the jumpers on the PiFace board for address 0 (JP1: 1-2, JP2: 1-2).
|
Set the jumpers on the PiFace board for address 0 (JP1: 1-2, JP2: 1-2).
|
||||||
|
|
||||||
## Use with HassOS
|
## Using with the Home Assistant Operating System
|
||||||
|
|
||||||
Note that the PiFace Digital 2 uses the Raspberry Pi SPI port, which is disabled by default when using [HassOS](https://github.com/home-assistant/hassos). When using HassOS, you must mount the SD card on another computer and access the boot partition on the card. Edit the `config.txt` file and add the line `dtparam=spi=on` to the end. This should enable SPI when HassOS is booted and allow Home Assistant to access the PiFace Digital 2 board.
|
Note that the PiFace Digital 2 uses the Raspberry Pi SPI port, which is disabled by default when using the [Home Assistant Operating System](https://github.com/home-assistant/hassos).
|
||||||
|
You must mount the SD card on another computer and access the boot partition on the card. Edit the `config.txt` file and add the line `dtparam=spi=on` to the end.
|
||||||
|
|
||||||
|
This should enable SPI when the Home Assistant Operating System is booted to access the PiFace Digital 2 board.
|
||||||
|
|
||||||
## Binary Sensor
|
## Binary Sensor
|
||||||
|
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
---
|
---
|
||||||
title: rTorrent
|
title: rTorrent
|
||||||
description: Instructions on how to integrate rtorrent sensors within Home Assistant.
|
description: Instructions on how to integrate rTorrent sensors within Home Assistant.
|
||||||
logo: rtorrent.png
|
logo: rtorrent.png
|
||||||
ha_category:
|
ha_category:
|
||||||
- Downloading
|
- Downloading
|
||||||
@ -8,7 +8,7 @@ ha_release: 0.81
|
|||||||
ha_iot_class: Local Polling
|
ha_iot_class: Local Polling
|
||||||
---
|
---
|
||||||
|
|
||||||
The `rtorrent` platform allows you to monitor your downloads with [rtorrent](https://rakshasa.github.io/rtorrent/) from within Home Assistant and setup automations based on the information.
|
The `rtorrent` platform allows you to monitor your downloads with [rTorrent](https://rakshasa.github.io/rtorrent/) from within Home Assistant and setup automations based on the information.
|
||||||
|
|
||||||
To enable this sensor, add the following lines to your `configuration.yaml`:
|
To enable this sensor, add the following lines to your `configuration.yaml`:
|
||||||
|
|
||||||
@ -23,19 +23,19 @@ sensor:
|
|||||||
- 'upload_speed'
|
- 'upload_speed'
|
||||||
```
|
```
|
||||||
|
|
||||||
This sensor requires the rtorrent XMLRPC API exposed on an HTTP interface.
|
This sensor requires the rTorrent XML-RPC API exposed on an HTTP interface.
|
||||||
Note that for security reasons, simply using the SCGI interface (default `localhost:5000`) of rtorrent won't work.
|
Note that for security reasons, simply using the SCGI interface (default `localhost:5000`) of rTorrent won't work.
|
||||||
The [official reference](https://github.com/rakshasa/rtorrent/wiki/RPC-Setup-XMLRPC) describes how to set up that HTTP interface.
|
The [official reference](https://github.com/rakshasa/rtorrent/wiki/RPC-Setup-XMLRPC) describes how to set up that HTTP interface.
|
||||||
|
|
||||||
Alternatively, the [arch-rtorrentvpn](https://github.com/binhex/arch-rtorrentvpn) container can be used with `url` set to `http://admin:rutorrent@127.0.0.1:9080/RPC2`.
|
Alternatively, the [arch-rtorrentvpn](https://github.com/binhex/arch-rtorrentvpn) container can be used with `url` set to `http://admin:rutorrent@127.0.0.1:9080/RPC2`.
|
||||||
|
|
||||||
{% configuration %}
|
{% configuration %}
|
||||||
url:
|
url:
|
||||||
description: The URL to the HTTP endpoint of the rtorrent XMLRPC API.
|
description: The URL to the HTTP endpoint of the rTorrent XML-RPC API.
|
||||||
required: true
|
required: true
|
||||||
type: string
|
type: string
|
||||||
name:
|
name:
|
||||||
description: The name to use when displaying this rtorrent instance.
|
description: The name to use when displaying this rTorrent instance.
|
||||||
required: false
|
required: false
|
||||||
type: string
|
type: string
|
||||||
monitored_variables:
|
monitored_variables:
|
||||||
@ -44,7 +44,7 @@ monitored_variables:
|
|||||||
type: list
|
type: list
|
||||||
keys:
|
keys:
|
||||||
current_status:
|
current_status:
|
||||||
description: The status of your rtorrent daemon.
|
description: The status of your rTorrent daemon.
|
||||||
download_speed:
|
download_speed:
|
||||||
description: The current download speed.
|
description: The current download speed.
|
||||||
upload_speed:
|
upload_speed:
|
||||||
|
@ -37,7 +37,7 @@ host:
|
|||||||
required: true
|
required: true
|
||||||
type: string
|
type: string
|
||||||
port:
|
port:
|
||||||
description: The port of the Samsung Smart TV. If set to 8001, the new websocket connection will be used (required for 2016+ TVs) - for installs other than Hass.io or Docker you may need to install a Python package, see below.
|
description: The port of the Samsung Smart TV. If set to 8001, the new websocket connection will be used (required for 2016+ TVs) - For Home Assistant Core installations, you may need to install a Python package, see below.
|
||||||
required: false
|
required: false
|
||||||
type: integer
|
type: integer
|
||||||
default: automatically detected
|
default: automatically detected
|
||||||
@ -166,11 +166,7 @@ media_content_type: channel
|
|||||||
|
|
||||||
It's possible to switch between the 2 sources `TV` and `HDMI`.
|
It's possible to switch between the 2 sources `TV` and `HDMI`.
|
||||||
|
|
||||||
### Hass.io
|
### Home Assistant & Home Assistant Core on Docker
|
||||||
|
|
||||||
No additional actions are required
|
|
||||||
|
|
||||||
### Docker
|
|
||||||
|
|
||||||
No additional actions are required
|
No additional actions are required
|
||||||
|
|
||||||
|
@ -109,7 +109,7 @@ registers:
|
|||||||
default: int
|
default: int
|
||||||
type: string
|
type: string
|
||||||
structure:
|
structure:
|
||||||
description: "If data_type is custom specify here a double quoted python struct format string to unpack the value. See python documentation for details. Ex: >i."
|
description: "If data_type is custom specify here a double quoted Python struct format string to unpack the value. See Python documentation for details. Ex: >i."
|
||||||
required: false
|
required: false
|
||||||
type: string
|
type: string
|
||||||
{% endconfiguration %}
|
{% endconfiguration %}
|
||||||
|
@ -11,11 +11,9 @@ ha_iot_class: Local Polling
|
|||||||
|
|
||||||
The `seven_segments` image processing platform allows you to read physical seven segments displays through Home Assistant. [`ssocr`](https://www.unix-ag.uni-kl.de/~auerswal/ssocr/) is used to extract the value shown on the display which is observed by a [camera](/integrations/camera/).
|
The `seven_segments` image processing platform allows you to read physical seven segments displays through Home Assistant. [`ssocr`](https://www.unix-ag.uni-kl.de/~auerswal/ssocr/) is used to extract the value shown on the display which is observed by a [camera](/integrations/camera/).
|
||||||
|
|
||||||
<div class='note'>
|
## Home Assistant Core Requirements
|
||||||
|
|
||||||
If you are using [Hass.io](/hassio/) then just move forward to the configuration as all requirements are already fulfilled.
|
If you are running Home Assistant Core in a Python virtual environment, you need to ensure the following requirements are met.
|
||||||
|
|
||||||
</div>
|
|
||||||
|
|
||||||
`ssocr` needs to be available on your system. Check the installation instruction below:
|
`ssocr` needs to be available on your system. Check the installation instruction below:
|
||||||
|
|
||||||
@ -30,6 +28,8 @@ sudo make PREFIX=/usr install # On most systems
|
|||||||
make deb # (Optional) This allows you to make a deb so that you apt is aware of ssocr
|
make deb # (Optional) This allows you to make a deb so that you apt is aware of ssocr
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Configuration
|
||||||
|
|
||||||
To enable the OCR of a seven segment display in your installation, add the following to your `configuration.yaml` file:
|
To enable the OCR of a seven segment display in your installation, add the following to your `configuration.yaml` file:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
@ -105,7 +105,7 @@ source:
|
|||||||
It's suggested that the first attempt to determine the needed parameters is using `ssocr` directly. This may require a couple of iterations to get the result
|
It's suggested that the first attempt to determine the needed parameters is using `ssocr` directly. This may require a couple of iterations to get the result
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
$ ssocr -D erosion crop 390 250 490 280 -t 20 -d 4 seven-seg.png
|
ssocr -D erosion crop 390 250 490 280 -t 20 -d 4 seven-seg.png
|
||||||
```
|
```
|
||||||
|
|
||||||
This would lead to the following entry for the `configuration.yaml` file:
|
This would lead to the following entry for the `configuration.yaml` file:
|
||||||
|
@ -59,7 +59,7 @@ sensors:
|
|||||||
|
|
||||||
### Note
|
### Note
|
||||||
|
|
||||||
Inverter models with newer firmware (and also those using devices like PocketWifi) no longer expose an API when connected to your wireless network, they do however continue to expose it on their own broadcasted SSID. To use this sensor in this case it is necessary to set up a reverse proxy with something like NGINX and use a raspberry pi (or similar) with two network connections (one being Wi-Fi that connects to the inverters SSID).
|
Inverter models with newer firmware (and also those using devices like PocketWifi) no longer expose an API when connected to your wireless network, they do however continue to expose it on their own broadcasted SSID. To use this sensor in this case it is necessary to set up a reverse proxy with something like NGINX and use a Raspberry Pi (or similar) with two network connections (one being Wi-Fi that connects to the inverters SSID).
|
||||||
|
|
||||||
|
|
||||||
Example NGINX configuration
|
Example NGINX configuration
|
||||||
|
@ -17,13 +17,13 @@ The `tado` integration platform is used as an interface to the [my.tado.com](htt
|
|||||||
|
|
||||||
There is currently support for the following device types within Home Assistant:
|
There is currently support for the following device types within Home Assistant:
|
||||||
|
|
||||||
- Climate - for every tado zone.
|
- Climate - for every Tado zone.
|
||||||
- [Presence Detection](#presence-detection)
|
- [Presence Detection](#presence-detection)
|
||||||
- Sensor - for some additional information of the zones.
|
- Sensor - for some additional information of the zones.
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
|
|
||||||
To use your tado thermostats in your installation, add the following to your `configuration.yaml` file:
|
To use your Tado thermostats in your installation, add the following to your `configuration.yaml` file:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry with multiple accounts
|
# Example configuration.yaml entry with multiple accounts
|
||||||
@ -59,7 +59,7 @@ fallback:
|
|||||||
default: true
|
default: true
|
||||||
{% endconfiguration %}
|
{% endconfiguration %}
|
||||||
|
|
||||||
The tado thermostats are internet connected thermostats. There exists an unofficial API at [my.tado.com](https://my.tado.com/), which is used by their website and now by this component.
|
The Tado thermostats are internet connected thermostats. There exists an unofficial API at [my.tado.com](https://my.tado.com/), which is used by their website and now by this component.
|
||||||
|
|
||||||
It currently supports presenting the current temperature, the setting temperature and the current operation mode. Switching the mode is also supported. If no user is at home anymore, the devices are showing the away-state. Switching to away-mode is not supported.
|
It currently supports presenting the current temperature, the setting temperature and the current operation mode. Switching the mode is also supported. If no user is at home anymore, the devices are showing the away-state. Switching to away-mode is not supported.
|
||||||
|
|
||||||
|
@ -33,7 +33,7 @@ To get started, add the devices to your `configuration.yaml` file.
|
|||||||
tellstick:
|
tellstick:
|
||||||
```
|
```
|
||||||
|
|
||||||
For Hass.io users there is a [TellStick add-on](/addons/tellstick/) available.
|
There is a [TellStick add-on](/addons/tellstick/) available in the Home Assistant add-on store.
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry for Hass.io with the TellStick add-on
|
# Example configuration.yaml entry for Hass.io with the TellStick add-on
|
||||||
@ -49,7 +49,7 @@ signal_repetitions:
|
|||||||
type: integer
|
type: integer
|
||||||
default: 1
|
default: 1
|
||||||
host:
|
host:
|
||||||
description: If you run TellStick on another server or with the Hass.io add-on.
|
description: If you run TellStick on another server or with the Home Assistant add-on.
|
||||||
required: inclusive
|
required: inclusive
|
||||||
type: string
|
type: string
|
||||||
port:
|
port:
|
||||||
|
@ -95,10 +95,10 @@ model:
|
|||||||
type: string
|
type: string
|
||||||
default: tensorflow/object_detection/data/mscoco_label_map.pbtxt
|
default: tensorflow/object_detection/data/mscoco_label_map.pbtxt
|
||||||
model_dir:
|
model_dir:
|
||||||
description: Full path to tensorflow models directory.
|
description: Full path to TensorFlow models directory.
|
||||||
required: false
|
required: false
|
||||||
type: string
|
type: string
|
||||||
default: /tensorflow inside configuration
|
default: "`/tensorflow` inside configuration"
|
||||||
area:
|
area:
|
||||||
description: Custom detection area. Only objects fully in this box will be reported. Top of image is 0, bottom is 1. Same left to right.
|
description: Custom detection area. Only objects fully in this box will be reported. Top of image is 0, bottom is 1. Same left to right.
|
||||||
required: false
|
required: false
|
||||||
@ -155,7 +155,7 @@ image_processing:
|
|||||||
- truck
|
- truck
|
||||||
```
|
```
|
||||||
|
|
||||||
## Optimising resources
|
## Optimizing resources
|
||||||
|
|
||||||
[Image processing components](/integrations/image_processing/) process the image from a camera at a fixed period given by the `scan_interval`. This leads to excessive processing if the image on the camera hasn't changed, as the default `scan_interval` is 10 seconds. You can override this by adding to your configuration `scan_interval: 10000` (setting the interval to 10,000 seconds), and then call the `image_processing.scan` service when you actually want to perform processing.
|
[Image processing components](/integrations/image_processing/) process the image from a camera at a fixed period given by the `scan_interval`. This leads to excessive processing if the image on the camera hasn't changed, as the default `scan_interval` is 10 seconds. You can override this by adding to your configuration `scan_interval: 10000` (setting the interval to 10,000 seconds), and then call the `image_processing.scan` service when you actually want to perform processing.
|
||||||
|
|
||||||
@ -171,7 +171,7 @@ image_processing:
|
|||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
# Example advanced automations.yaml entry
|
# Example advanced automations.yaml entry
|
||||||
- alias: Tensorflow scanning
|
- alias: TensorFlow scanning
|
||||||
trigger:
|
trigger:
|
||||||
- platform: state
|
- platform: state
|
||||||
entity_id:
|
entity_id:
|
||||||
|
@ -25,7 +25,7 @@ light:
|
|||||||
|
|
||||||
{% configuration %}
|
{% configuration %}
|
||||||
devices:
|
devices:
|
||||||
description: A list of devices with their bluetooth address.
|
description: A list of devices with their Bluetooth address.
|
||||||
required: false
|
required: false
|
||||||
type: list
|
type: list
|
||||||
keys:
|
keys:
|
||||||
|
@ -54,11 +54,11 @@ Pick an icon that you can find on [materialdesignicons.com](https://materialdesi
|
|||||||
|
|
||||||
| Event | Description |
|
| Event | Description |
|
||||||
| --------------- | ----------- |
|
| --------------- | ----------- |
|
||||||
| timer.cancelled | Fired when a timer has been canceled |
|
| `timer.cancelled` | Fired when a timer has been canceled |
|
||||||
| timer.finished | Fired when a timer has completed |
|
| `timer.finished` | Fired when a timer has completed |
|
||||||
| timer.started | Fired when a timer has been started|
|
| `timer.started` | Fired when a timer has been started|
|
||||||
| timer.restarted | Fired when a timer has been restarted |
|
| `timer.restarted` | Fired when a timer has been restarted |
|
||||||
| timer.paused | Fired when a timer has been paused |
|
| `timer.paused` | Fired when a timer has been paused |
|
||||||
|
|
||||||
## Services
|
## Services
|
||||||
|
|
||||||
|
@ -63,7 +63,7 @@ sensor:
|
|||||||
xshut: 16
|
xshut: 16
|
||||||
```
|
```
|
||||||
|
|
||||||
Several devices may be attached and a GPIO port from RPI is used for reset. XSHUT signal is generated pulsing LOW at initialization and after that, it is kept HIGH all time. This version uses VL53L1X long-range mode that may reach up to 4 meters.
|
Several devices may be attached and a GPIO port from Raspberry Pi is used for reset. XSHUT signal is generated pulsing LOW at initialization and after that, it is kept HIGH all time. This version uses VL53L1X long-range mode that may reach up to 4 meters.
|
||||||
|
|
||||||
## Directions for installing i2c on Raspberry Pi
|
## Directions for installing i2c on Raspberry Pi
|
||||||
|
|
||||||
|
@ -11,7 +11,7 @@ ha_codeowners:
|
|||||||
- '@ludeeus'
|
- '@ludeeus'
|
||||||
---
|
---
|
||||||
|
|
||||||
`Traccar` uses GPS for tracking and has support for over 1500 different types of devices. One option is to track the [Traccar Client](https://www.traccar.org/client/) app on a smartphone via `webhook`. The other option is to connect to an existing [Traccar Server](https://www.traccar.org/server/) installation which is also available as Hass.io addon.
|
`Traccar` uses GPS for tracking and has support for over 1500 different types of devices. One option is to track the [Traccar Client](https://www.traccar.org/client/) app on a smartphone via `webhook`. The other option is to connect to an existing [Traccar Server](https://www.traccar.org/server/) installation which is also available as Home Assistant add-on.
|
||||||
|
|
||||||
## Traccar Client
|
## Traccar Client
|
||||||
|
|
||||||
|
@ -51,7 +51,7 @@ allow_tradfri_groups:
|
|||||||
|
|
||||||
After updating your IKEA Trådfri Gateway firmware it might be necessary to repeat the configuration process. One error you might experience after a firmware update is `Fatal DTLS error: code 115`. If you encounter problems:
|
After updating your IKEA Trådfri Gateway firmware it might be necessary to repeat the configuration process. One error you might experience after a firmware update is `Fatal DTLS error: code 115`. If you encounter problems:
|
||||||
- when configured using the integration: remove the integration through Settings > Integrations > Tradfri > delete (trash can icon)
|
- when configured using the integration: remove the integration through Settings > Integrations > Tradfri > delete (trash can icon)
|
||||||
- with manual configuration: delete the `.tradfri_psk.conf` file in your `/.homeassistant` directory (`/config` directory if using Hass.io or Docker)
|
- with manual configuration: delete the `.tradfri_psk.conf` file in your `/config` directory (`/.homeassistant` directory if using Home Assistant Core)
|
||||||
|
|
||||||
Then restart Home Assistant. When prompted, enter the security key and click *configure*, just like during initial setup.
|
Then restart Home Assistant. When prompted, enter the security key and click *configure*, just like during initial setup.
|
||||||
|
|
||||||
|
@ -39,7 +39,7 @@ auth_token:
|
|||||||
|
|
||||||
After configuring the base Twilio component, add and configure either or both of the [Twilio SMS](/integrations/twilio_sms) and [Twilio Phone](/integrations/twilio_call) integrations to utilize the notification functionality.
|
After configuring the base Twilio component, add and configure either or both of the [Twilio SMS](/integrations/twilio_sms) and [Twilio Phone](/integrations/twilio_call) integrations to utilize the notification functionality.
|
||||||
|
|
||||||
To be able to receive events from Twilio, your Home Assistant instance needs to be accessible from the web ([Hass.io instructions](/addons/duckdns/)) and you need to have the `base_url` configured for the HTTP integration ([docs](/integrations/http/#base_url)).
|
To be able to receive events from Twilio, your Home Assistant instance needs to be accessible from the web and you need to have the `base_url` configured for the HTTP integration ([docs](/integrations/http/#base_url)).
|
||||||
|
|
||||||
To set it up, go to the integrations page in the configuration screen and find Twilio. Click on configure. Follow the instructions on the screen to configure Twilio.
|
To set it up, go to the integrations page in the configuration screen and find Twilio. Click on configure. Follow the instructions on the screen to configure Twilio.
|
||||||
|
|
||||||
|
Some files were not shown because too many files have changed in this diff Show More
Loading…
x
Reference in New Issue
Block a user