mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-19 07:17:14 +00:00
Merge branch 'current' into next
This commit is contained in:
commit
0986c7bbeb
@ -142,13 +142,13 @@ social:
|
|||||||
# Home Assistant release details
|
# Home Assistant release details
|
||||||
current_major_version: 0
|
current_major_version: 0
|
||||||
current_minor_version: 81
|
current_minor_version: 81
|
||||||
current_patch_version: 4
|
current_patch_version: 6
|
||||||
date_released: 2018-11-02
|
date_released: 2018-11-04
|
||||||
|
|
||||||
# Either # or the anchor link to latest release notes in the blog post.
|
# Either # or the anchor link to latest release notes in the blog post.
|
||||||
# Must be prefixed with a # and have double quotes around it.
|
# Must be prefixed with a # and have double quotes around it.
|
||||||
# Major release:
|
# Major release:
|
||||||
patch_version_notes: "#release-0814---november-3"
|
patch_version_notes: "#release-0816---november-4"
|
||||||
# Minor release (Example #release-0431---april-25):
|
# Minor release (Example #release-0431---april-25):
|
||||||
|
|
||||||
# Date we moved to Discourse for comments
|
# Date we moved to Discourse for comments
|
||||||
|
@ -76,6 +76,12 @@ homematic:
|
|||||||
rf:
|
rf:
|
||||||
host: core-homematic
|
host: core-homematic
|
||||||
port: 2001
|
port: 2001
|
||||||
|
wired:
|
||||||
|
host: core-homematic
|
||||||
|
port: 2000
|
||||||
|
hmip:
|
||||||
|
host: core-homematic
|
||||||
|
port: 2001
|
||||||
```
|
```
|
||||||
|
|
||||||
## {% linkable_title Raspberry Pi3 %}
|
## {% linkable_title Raspberry Pi3 %}
|
||||||
@ -85,3 +91,7 @@ With HM-MOD-RPI-PCB you need to add follow into your `config.txt` on boot partit
|
|||||||
```text
|
```text
|
||||||
dtoverlay=pi3-miniuart-bt
|
dtoverlay=pi3-miniuart-bt
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## {% linkable_title HmIP-RFUSB %}
|
||||||
|
|
||||||
|
HassOS > 1.11 support HmIP-RFUSB default and don't need any configuration. If you run a Linux, you need to follow the installation guide from documentation to set up the UART USB interface on your computer.
|
||||||
|
@ -23,10 +23,16 @@ Setup and manage a [Let's Encrypt](https://letsencrypt.org/) certificate. This a
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
Configuration variables:
|
{% configuration %}
|
||||||
|
email:
|
||||||
- **email** (*Required*): Your email address for registration on Let's Encrypt.
|
description: Your email address for registration on Let's Encrypt.
|
||||||
- **domains** (*Required*): A list of domains to create/renew the certificate.
|
required: true
|
||||||
|
type: string
|
||||||
|
domains:
|
||||||
|
description: A list of domains to create/renew the certificate.
|
||||||
|
required: true
|
||||||
|
type: list
|
||||||
|
{% endconfiguration %}
|
||||||
|
|
||||||
## {% linkable_title Home Assistant configuration %}
|
## {% linkable_title Home Assistant configuration %}
|
||||||
|
|
||||||
|
@ -14,13 +14,10 @@ Set up [Mosquitto](https://mosquitto.org/) as MQTT broker.
|
|||||||
|
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"plain": true,
|
|
||||||
"ssl": false,
|
|
||||||
"anonymous": true,
|
|
||||||
"logins": [
|
"logins": [
|
||||||
{"username": "testuser", "password": "mypw"},
|
{"username": "local-user", "password": "mypw"}
|
||||||
{"username": "testuser2", "password": "mypw2"}
|
|
||||||
],
|
],
|
||||||
|
"anonymous": false,
|
||||||
"customize": {
|
"customize": {
|
||||||
"active": false,
|
"active": false,
|
||||||
"folder": "mosquitto"
|
"folder": "mosquitto"
|
||||||
@ -35,23 +32,13 @@ Make sure you use logins and disable anonymous access if you want to secure the
|
|||||||
</p>
|
</p>
|
||||||
|
|
||||||
{% configuration %}
|
{% configuration %}
|
||||||
plain:
|
|
||||||
description: Listen on port 1883 without SSL/TLS.
|
|
||||||
required: false
|
|
||||||
default: true
|
|
||||||
type: boolean
|
|
||||||
ssl:
|
|
||||||
description: Listen on port 8883 with SSL/TLS. This requires certificates.
|
|
||||||
required: false
|
|
||||||
default: false
|
|
||||||
type: boolean
|
|
||||||
anonymous:
|
anonymous:
|
||||||
description: Allow anonymous connections. If *logins* is set, the anonymous user can only read data.
|
description: Allow anonymous connections. If *logins* is set, the anonymous user can only read data.
|
||||||
required: false
|
required: false
|
||||||
default: true
|
default: false
|
||||||
type: boolean
|
type: boolean
|
||||||
logins:
|
logins:
|
||||||
description: A list of users that will be created with *username* and *password*.
|
description: A list of local users that will be created with *username* and *password*. You don't need do this because you can use Home Assistant users too without any configuration.
|
||||||
required: false
|
required: false
|
||||||
type: list
|
type: list
|
||||||
customize:
|
customize:
|
||||||
@ -60,41 +47,17 @@ customize:
|
|||||||
type: [boolean, string]
|
type: [boolean, string]
|
||||||
{% endconfiguration %}
|
{% endconfiguration %}
|
||||||
|
|
||||||
|
### {% linkable_title Home Assistant user management %}
|
||||||
|
|
||||||
|
This add-on is attached to the Home Assistant user system, so mqtt clients can make use of these credentials. Local users may also still be set independently within the configuration options for the add-on. For the internal Hass.io ecosystem we register `homeassistant` and `addons`, so these may not be used as user names.
|
||||||
|
|
||||||
### {% linkable_title Home Assistant configuration %}
|
### {% linkable_title Home Assistant configuration %}
|
||||||
|
|
||||||
To use the Mosquitto as [broker](/docs/mqtt/broker/#run-your-own), add the following entry to the `configuration.yaml` file.
|
To use the Mosquitto as [broker](/docs/mqtt/broker/#run-your-own), go to the integration page and install the configuration with one click. If you have old mqtt settings available, remove this old integration and restart Home Assistant to see the new one.
|
||||||
|
|
||||||
```yaml
|
### {% linkable_title Disable listening on insecure (1883) ports %}
|
||||||
# Example configuration.yaml entry
|
|
||||||
mqtt:
|
|
||||||
broker: core-mosquitto
|
|
||||||
```
|
|
||||||
|
|
||||||
If username and password are set up in add-on, your `configuration.yaml` file should contain that data.
|
Remove the ports from the add-on page network card (set them as blank) to disable them.
|
||||||
|
|
||||||
```yaml
|
|
||||||
mqtt:
|
|
||||||
broker: core-mosquitto
|
|
||||||
username: YOUR_USERNAME
|
|
||||||
password: YOUR_PASSWORD
|
|
||||||
```
|
|
||||||
|
|
||||||
### {% linkable_title Listening simultaneously on SSL/TLS (8883) and insecure (1883) ports %}
|
|
||||||
|
|
||||||
1. Configure SSL/TLS as normal.
|
|
||||||
2. Set `customize` flag to `true` in your configuration.
|
|
||||||
3. Create a file in `/share/mosquitto` named `insecure.conf` with the following contents:
|
|
||||||
|
|
||||||
```text
|
|
||||||
listener 1883
|
|
||||||
protocol mqtt
|
|
||||||
```
|
|
||||||
|
|
||||||
4. Restart MQTT
|
|
||||||
|
|
||||||
<p class='note warning'>
|
|
||||||
It's recommended that you only open your firewall to the SSL/TLS port (8883) and only use the insecure port (1883) for local devices. Also, disable `anonymous:` and set `logins:`.
|
|
||||||
</p>
|
|
||||||
|
|
||||||
### {% linkable_title Access Control Lists (ACLs) %}
|
### {% linkable_title Access Control Lists (ACLs) %}
|
||||||
|
|
||||||
|
@ -13,22 +13,12 @@ featured: true
|
|||||||
This add-on allows you to set up a [Samba](https://samba.org/) server to access Hass.io folders using Windows network shares.
|
This add-on allows you to set up a [Samba](https://samba.org/) server to access Hass.io folders using Windows network shares.
|
||||||
|
|
||||||
<p class='note warning'>
|
<p class='note warning'>
|
||||||
It is <strong>strongly recommended to set a username and password</strong>. By using guest mode, you expose your configuration and secrets to every user in local network.<br />
|
Be careful when setting up port forwarding for remote access. If you don't restrict access by setting a username and strong password, your configuration could be exposed to the entire internet!
|
||||||
Also be careful when setting up port forwarding for remote access. If you don't restrict access by setting a username and password, your configuration could be exposed to the entire internet!
|
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"name": "hassio",
|
|
||||||
"workgroup": "WORKGROUP",
|
"workgroup": "WORKGROUP",
|
||||||
"guest": true,
|
|
||||||
"map": {
|
|
||||||
"config": true,
|
|
||||||
"addons": true,
|
|
||||||
"share": true,
|
|
||||||
"backup": true,
|
|
||||||
"ssl": false
|
|
||||||
},
|
|
||||||
"username": "",
|
"username": "",
|
||||||
"password": "",
|
"password": "",
|
||||||
"interface": "eth0",
|
"interface": "eth0",
|
||||||
@ -41,58 +31,18 @@ Also be careful when setting up port forwarding for remote access. If you don't
|
|||||||
```
|
```
|
||||||
|
|
||||||
{% configuration %}
|
{% configuration %}
|
||||||
name:
|
|
||||||
description: Set netbios name of Hass.io device.
|
|
||||||
required: false
|
|
||||||
default: "`hassio`"
|
|
||||||
type: string
|
|
||||||
workgroup:
|
workgroup:
|
||||||
description: Set network workgroup name.
|
description: Set network workgroup name.
|
||||||
required: false
|
required: false
|
||||||
default: "`WORKGROUP`"
|
default: "`WORKGROUP`"
|
||||||
type: string
|
type: string
|
||||||
guest:
|
|
||||||
description: Allow login without a username or password.
|
|
||||||
required: false
|
|
||||||
default: true
|
|
||||||
type: boolean
|
|
||||||
map:
|
|
||||||
description: Control which folders will be exposed.
|
|
||||||
required: false
|
|
||||||
type: map
|
|
||||||
keys:
|
|
||||||
config:
|
|
||||||
description: The Home Assistant configuration folder
|
|
||||||
required: false
|
|
||||||
default: true
|
|
||||||
type: boolean
|
|
||||||
addons:
|
|
||||||
description: The local custom addons repository
|
|
||||||
required: false
|
|
||||||
default: true
|
|
||||||
type: boolean
|
|
||||||
share:
|
|
||||||
description: The folder that can be accessed by add-ons and Home Assistant
|
|
||||||
required: false
|
|
||||||
default: true
|
|
||||||
type: boolean
|
|
||||||
backup:
|
|
||||||
description: Access to snapshot files
|
|
||||||
required: false
|
|
||||||
default: true
|
|
||||||
type: boolean
|
|
||||||
ssl:
|
|
||||||
description: Certificate storage (Careful! Sharing is set to `false` by default)
|
|
||||||
required: false
|
|
||||||
default: false
|
|
||||||
type: boolean
|
|
||||||
username:
|
username:
|
||||||
description: Username for logging in if guest login is not used.
|
description: Username for logging in if guest login is not used.
|
||||||
required: false
|
required: true
|
||||||
type: string
|
type: string
|
||||||
password:
|
password:
|
||||||
description: Password for `username`. An empty password is not supported.
|
description: Password for `username`. An empty password is not supported.
|
||||||
required: false
|
required: true
|
||||||
type: string
|
type: string
|
||||||
interface:
|
interface:
|
||||||
description: Interface that will start the share. Normally this is `eth0` for ethernet wired connection and `wlan0` for wireless connection. If you are running on an Intel NUC this could also be `enp3s0` for ethernet or `wlp5s0` for wireless connection.
|
description: Interface that will start the share. Normally this is `eth0` for ethernet wired connection and `wlan0` for wireless connection. If you are running on an Intel NUC this could also be `enp3s0` for ethernet or `wlp5s0` for wireless connection.
|
||||||
|
@ -11,7 +11,9 @@ footer: true
|
|||||||
|
|
||||||
[Snips.ai](https://snips.ai/) is an AI-powered voice assistant that runs on the Raspberry Pi 3 and x86 platforms. It runs on-device and is Private by Design.
|
[Snips.ai](https://snips.ai/) is an AI-powered voice assistant that runs on the Raspberry Pi 3 and x86 platforms. It runs on-device and is Private by Design.
|
||||||
|
|
||||||
|
<p class='warning note'>
|
||||||
The Snips add-on depends on the Mosquitto add on to bridge to Home Assistant, so make sure that is installed.
|
The Snips add-on depends on the Mosquitto add on to bridge to Home Assistant, so make sure that is installed.
|
||||||
|
</p>
|
||||||
|
|
||||||
Home Assistant comes with certain Intents builtin to handle common tasks. A complete list of Intents can be found in this wiki [Hass Snips Bundle](https://github.com/tschmidty69/hass-snips-bundle-intents/wiki).
|
Home Assistant comes with certain Intents builtin to handle common tasks. A complete list of Intents can be found in this wiki [Hass Snips Bundle](https://github.com/tschmidty69/hass-snips-bundle-intents/wiki).
|
||||||
|
|
||||||
@ -51,7 +53,6 @@ Now it's time to start Snips for the first time. You can configure the microphon
|
|||||||
|
|
||||||
Configuration variables:
|
Configuration variables:
|
||||||
|
|
||||||
- **mqtt_bridge**: Snips uses MQTT to communicate and defaults to their own broker. Use this config option to bridge their broker to your the Mosquitto add-on.
|
|
||||||
- **assistant**: The name of your custom assistant in `/share`. If no assistant is found then a default assistant will be used.
|
- **assistant**: The name of your custom assistant in `/share`. If no assistant is found then a default assistant will be used.
|
||||||
- **language**: Language. This is used to select the default custom assistant, Currently `en`, `de` and `fr` are supported.
|
- **language**: Language. This is used to select the default custom assistant, Currently `en`, `de` and `fr` are supported.
|
||||||
- **custom_tts**: Whether to use a TTS provider from Home Assistant for a variety of voices.
|
- **custom_tts**: Whether to use a TTS provider from Home Assistant for a variety of voices.
|
||||||
|
@ -10,6 +10,7 @@ footer: true
|
|||||||
logo: http.png
|
logo: http.png
|
||||||
ha_category: Binary Sensor
|
ha_category: Binary Sensor
|
||||||
ha_release: pre 0.7
|
ha_release: pre 0.7
|
||||||
|
ha_qa_scale: internal
|
||||||
---
|
---
|
||||||
|
|
||||||
The HTTP binary sensor is dynamically created with the first request that is made to its URL. You don't have to define it in the configuration first.
|
The HTTP binary sensor is dynamically created with the first request that is made to its URL. You don't have to define it in the configuration first.
|
||||||
|
@ -94,7 +94,7 @@ As you can see, there are 4 custom projects here:
|
|||||||
|
|
||||||
You can mix-and-match these attributes to create all sorts of custom projects. You can even use [IFTTT](https://ifttt.com/todoist) to create a task with a certain label, then have Home Assistant do some kind of automation when a task with that label comes due.
|
You can mix-and-match these attributes to create all sorts of custom projects. You can even use [IFTTT](https://ifttt.com/todoist) to create a task with a certain label, then have Home Assistant do some kind of automation when a task with that label comes due.
|
||||||
|
|
||||||
Home Assistant does its best to determine what task in each project is "most" important, and it's that task which has its state reported. You can access the other tasks you have due soon via the `all_tasks` array (see below).
|
Home Assistant does its best to [determine what task in each project is "most" important](https://github.com/home-assistant/home-assistant/blob/master/homeassistant/components/calendar/todoist.py#L432), and it's that task which has its state reported. You can access the other tasks you have due soon via the `all_tasks` array (see below).
|
||||||
|
|
||||||
### {% linkable_title Sensor attributes %}
|
### {% linkable_title Sensor attributes %}
|
||||||
|
|
||||||
|
@ -153,6 +153,7 @@ automation:
|
|||||||
#### {% linkable_title Appdaemon event helper %}
|
#### {% linkable_title 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.
|
||||||
|
|
||||||
|
Put this in `apps.yaml`:
|
||||||
{% raw %}
|
{% raw %}
|
||||||
```yaml
|
```yaml
|
||||||
deconz_helper:
|
deconz_helper:
|
||||||
@ -160,6 +161,7 @@ deconz_helper:
|
|||||||
class: DeconzHelper
|
class: DeconzHelper
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Put this in `deconz_helper.py`:
|
||||||
```python
|
```python
|
||||||
import appdaemon.plugins.hass.hassapi as hass
|
import appdaemon.plugins.hass.hassapi as hass
|
||||||
import datetime
|
import datetime
|
||||||
@ -179,6 +181,7 @@ class DeconzHelper(hass.Hass):
|
|||||||
```
|
```
|
||||||
{% endraw %}
|
{% endraw %}
|
||||||
|
|
||||||
|
Note: the event will not be visible before one event gets sent.
|
||||||
|
|
||||||
#### {% linkable_title Appdaemon remote template %}
|
#### {% linkable_title Appdaemon remote template %}
|
||||||
|
|
||||||
|
@ -104,7 +104,7 @@ When you exit a zone, Home Assistant will start using location updates to track
|
|||||||
### {% linkable_title Using Owntracks regions - forcing Owntracks to update using iBeacons %}
|
### {% linkable_title Using Owntracks regions - forcing Owntracks to update using iBeacons %}
|
||||||
|
|
||||||
<p class='note'>
|
<p class='note'>
|
||||||
Owntracks v2.0.0 removes support for iBecons on Android.
|
Owntracks v2.0.0 removes support for iBeacons on Android.
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
When run in the usual *significant changes mode* (which is kind to your phone battery), Owntracks sometimes doesn't update your location as quickly as you'd like when you arrive at a zone. This can be annoying if you want to trigger an automation when you get home. You can improve the situation using iBeacons.
|
When run in the usual *significant changes mode* (which is kind to your phone battery), Owntracks sometimes doesn't update your location as quickly as you'd like when you arrive at a zone. This can be annoying if you want to trigger an automation when you get home. You can improve the situation using iBeacons.
|
||||||
|
@ -16,11 +16,6 @@ The `tomato` platform requires an extra config variable called `http_id`. The
|
|||||||
value can be obtained by logging in to the Tomato admin interface and search for
|
value can be obtained by logging in to the Tomato admin interface and search for
|
||||||
`http_id` in the page source code.
|
`http_id` in the page source code.
|
||||||
|
|
||||||
Because of a limitation in Tomato's API, this platform will only track wireless
|
|
||||||
devices. If tracking wired devices like a Philips Hue Hub is necessary, it is
|
|
||||||
possible to use another platform like
|
|
||||||
[NMAP](/components/device_tracker.nmap_tracker/).
|
|
||||||
|
|
||||||
Because of a limitation in Tomato's API, this platform will only track wireless devices.
|
Because of a limitation in Tomato's API, this platform will only track wireless devices.
|
||||||
If tracking wired devices like a Philips Hue Hub is necessary,
|
If tracking wired devices like a Philips Hue Hub is necessary,
|
||||||
it is possible to use another platform like [Nmap](/components/device_tracker.nmap_tracker/).
|
it is possible to use another platform like [Nmap](/components/device_tracker.nmap_tracker/).
|
||||||
|
@ -125,7 +125,7 @@ project_id:
|
|||||||
required: true
|
required: true
|
||||||
type: string
|
type: string
|
||||||
api_key:
|
api_key:
|
||||||
description: Your API key.
|
description: Your Homegraph API key (for the `google_assistant.request_sync` service)
|
||||||
required: false
|
required: false
|
||||||
type: string
|
type: string
|
||||||
expose_by_default:
|
expose_by_default:
|
||||||
|
@ -27,8 +27,18 @@ media_player:
|
|||||||
name: Russound
|
name: Russound
|
||||||
```
|
```
|
||||||
|
|
||||||
Configuration variables:
|
{% configuration %}
|
||||||
|
host:
|
||||||
- **host** (*Required*): The IP of the TCP gateway
|
description: The IP of the TCP gateway.
|
||||||
- **port** (*Optional*): The port of the TCP gateway (default: 9621)
|
required: true
|
||||||
- **name** (*Required*): The name of the device
|
type: string
|
||||||
|
port:
|
||||||
|
description: The port of the TCP gateway.
|
||||||
|
required: false
|
||||||
|
default: 9621
|
||||||
|
type: integer
|
||||||
|
name:
|
||||||
|
description: The name of the device.
|
||||||
|
required: true
|
||||||
|
type: string
|
||||||
|
{% endconfiguration %}
|
||||||
|
@ -145,7 +145,7 @@ remembering to split them per line into your `sources:` configuration.
|
|||||||
### {% linkable_title Change channel through play_media service %}
|
### {% linkable_title Change channel through play_media service %}
|
||||||
|
|
||||||
The `play_media` service can be used in a script to switch to the specified tv
|
The `play_media` service can be used in a script to switch to the specified tv
|
||||||
channel. It selects the best matching cannel according to the `media_content_id`
|
channel. It selects the best matching channel according to the `media_content_id`
|
||||||
parameter:
|
parameter:
|
||||||
|
|
||||||
1. Channel number *(i.e. '1' or '6')*
|
1. Channel number *(i.e. '1' or '6')*
|
||||||
|
@ -12,10 +12,10 @@ ha_category: Notifications
|
|||||||
ha_release: 0.56
|
ha_release: 0.56
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
||||||
The `clickatell` platform uses [Clickatell](https://clickatell.com) to deliver SMS notifications from Home Assistant.
|
The `clickatell` platform uses [Clickatell](https://clickatell.com) to deliver SMS notifications from Home Assistant.
|
||||||
|
|
||||||
### Get your Clickatell API Credentials
|
## {% linkable_title Setup %}
|
||||||
|
|
||||||
Go to your [Clickatell SMS Platform Portal](https://portal.clickatell.com/#/) section and create a new SMS integration. There are three screens of information required to create an integration. Please ensure the following:
|
Go to your [Clickatell SMS Platform Portal](https://portal.clickatell.com/#/) section and create a new SMS integration. There are three screens of information required to create an integration. Please ensure the following:
|
||||||
|
|
||||||
1. Give the new Integration an identification name.
|
1. Give the new Integration an identification name.
|
||||||
@ -25,6 +25,8 @@ Go to your [Clickatell SMS Platform Portal](https://portal.clickatell.com/#/) se
|
|||||||
5. Be aware of the international number format option as this impacts the structure of the phone numbers you provide.
|
5. Be aware of the international number format option as this impacts the structure of the phone numbers you provide.
|
||||||
6. Once you have completed entering your details an API key is generated. Copy the API key.
|
6. Once you have completed entering your details an API key is generated. Copy the API key.
|
||||||
|
|
||||||
|
## {% linkable_title Configuration %}
|
||||||
|
|
||||||
To add Clickatell to your installation, add the following to your Home Assistant `configuration.yaml` file:
|
To add Clickatell to your installation, add the following to your Home Assistant `configuration.yaml` file:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
@ -36,11 +38,20 @@ notify:
|
|||||||
recipient: PHONE_NO
|
recipient: PHONE_NO
|
||||||
```
|
```
|
||||||
|
|
||||||
Configuration variables:
|
{% configuration %}
|
||||||
|
name:
|
||||||
* **name** (Optional): Setting the optional parameter name allows multiple notifiers to be created. The default value is `clickatell`. The notifier will bind to the service notify.NOTIFIER_NAME.
|
description: Setting the optional parameter name allows multiple notifiers to be created. The notifier will bind to the service notify.NOTIFIER_NAME.
|
||||||
* **api_key** (Required): Your API key.
|
required: false
|
||||||
* **recipient** (Required): Your phone number. This is where you want to send your notification SMS messages. e.g., `61444333444`.
|
default: clickatell
|
||||||
|
type: string
|
||||||
|
api_key:
|
||||||
|
description: Your Clicktell API key.
|
||||||
|
required: true
|
||||||
|
type: string
|
||||||
|
recipient:
|
||||||
|
description: Your phone number. This is where you want to send your notification SMS messages. e.g., `61444333444`.
|
||||||
|
required: true
|
||||||
|
type: string
|
||||||
|
{% endconfiguration %}
|
||||||
|
|
||||||
To use notifications, please see the [getting started with automation page](/getting-started/automation/).
|
To use notifications, please see the [getting started with automation page](/getting-started/automation/).
|
||||||
|
@ -12,7 +12,6 @@ ha_category: Notifications
|
|||||||
ha_release: 0.16
|
ha_release: 0.16
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
||||||
[GNTP](http://www.growlforwindows.com/gfw/help/gntp.aspx) is a specification for sending and receiving notifications between computers. The most well known server implementations are [Growl](http://growl.info) for Mac and [Growl for Windows](http://www.growlforwindows.com/gfw/).
|
[GNTP](http://www.growlforwindows.com/gfw/help/gntp.aspx) is a specification for sending and receiving notifications between computers. The most well known server implementations are [Growl](http://growl.info) for Mac and [Growl for Windows](http://www.growlforwindows.com/gfw/).
|
||||||
|
|
||||||
To use GNTP notifications, add the following to your `configuration.yaml` file:
|
To use GNTP notifications, add the following to your `configuration.yaml` file:
|
||||||
@ -26,13 +25,35 @@ notify:
|
|||||||
|
|
||||||
GNTP will attempt to connect to a local server running on port 23053 if no `hostname` is provided.
|
GNTP will attempt to connect to a local server running on port 23053 if no `hostname` is provided.
|
||||||
|
|
||||||
Configuration variables:
|
{% configuration %}
|
||||||
|
name:
|
||||||
- **name** (*Optional*): Setting the optional parameter `name` allows multiple notifiers to be created. The default value is `notify`. The notifier will bind to the service `notify.NOTIFIER_NAME`.
|
description: Setting the optional parameter `name` allows multiple notifiers to be created. The notifier will bind to the service `notify.NOTIFIER_NAME`.
|
||||||
- **app_name** (*Optional*): The application name that will be displayed on every notification and will be registered with the server.
|
required: false
|
||||||
- **app_icon** (*Optional*): The icon that will be displayed on every notification. You can provide an HTTP URL or a `file://` URL. File URLs only work if Home Assistant and the GNTP server are running on the same machine. If no `app_icon` is set a local copy of the Home Assistant logo will be used. If you choose to use an HTTP URL please make the maximum image size 150 px by 150 px as Growl for Mac will sometimes timeout when registering.
|
default: notify
|
||||||
- **hostname** (*Optional*): The hostname or IP address of the GNTP server to contact.
|
type: string
|
||||||
- **password** (*Optional*): The password to authenticate to the GNTP server with.
|
app_name:
|
||||||
- **port** (*Optional*): The port that the GNTP server runs on. The specification states that servers should not allow users to use any port other than 23053 but `port` is provided here just in case.
|
description: The application name that will be displayed on every notification and will be registered with the server.
|
||||||
|
required: false
|
||||||
|
default: HomeAssistant
|
||||||
|
type: string
|
||||||
|
app_icon:
|
||||||
|
description: "The icon that will be displayed on every notification. You can provide an HTTP URL or a `file://` URL. File URLs only work if Home Assistant and the GNTP server are running on the same machine. If no `app_icon` is set a local copy of the Home Assistant logo will be used. If you choose to use an HTTP URL please make the maximum image size 150 px by 150 px as Growl for Mac will sometimes timeout when registering."
|
||||||
|
required: false
|
||||||
|
type: string
|
||||||
|
hostname:
|
||||||
|
description: The hostname or IP address of the GNTP server to contact.
|
||||||
|
required: false
|
||||||
|
default: localhost
|
||||||
|
type: string
|
||||||
|
password:
|
||||||
|
description: The password to authenticate to the GNTP server with.
|
||||||
|
required: false
|
||||||
|
type: string
|
||||||
|
port:
|
||||||
|
description: The port that the GNTP server runs on. The specification states that servers should not allow users to use any port other than 23053 but `port` is provided here just in case.
|
||||||
|
required: false
|
||||||
|
default: 23053
|
||||||
|
type: integer
|
||||||
|
{% endconfiguration %}
|
||||||
|
|
||||||
To use notifications, please see the [getting started with automation page](/getting-started/automation/).
|
To use notifications, please see the [getting started with automation page](/getting-started/automation/).
|
||||||
|
@ -19,14 +19,20 @@ To connect to a Nuimo device add the following section to your `configuration.ya
|
|||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
nuimo_controller:
|
nuimo_controller:
|
||||||
```
|
```
|
||||||
|
|
||||||
Configuration variables:
|
{% configuration %}
|
||||||
|
mac:
|
||||||
- **mac** (*Optional*): Skip discovery and connect to this device address.
|
description: Skip discovery and connect to this device address.
|
||||||
- **name** (*Optional*): To handle more than one device by names, add the name of the device.
|
required: false
|
||||||
|
type: string
|
||||||
|
name:
|
||||||
|
description: To handle more than one device by names, add the name of the device.
|
||||||
|
required: false
|
||||||
|
default: None
|
||||||
|
type: string
|
||||||
|
{% endconfiguration %}
|
||||||
|
|
||||||
Example for testing rotation value and sending to the LED matrix:
|
Example for testing rotation value and sending to the LED matrix:
|
||||||
|
|
||||||
@ -42,7 +48,7 @@ automation Nuimo_rotate_right:
|
|||||||
value_template: {% raw %}'{{ trigger.event.data.value > 100 }}'{% endraw %}
|
value_template: {% raw %}'{{ trigger.event.data.value > 100 }}'{% endraw %}
|
||||||
action:
|
action:
|
||||||
service: nuimo_controller.led_matrix
|
service: nuimo_controller.led_matrix
|
||||||
data:
|
data:
|
||||||
matrix:
|
matrix:
|
||||||
'........
|
'........
|
||||||
0000000.
|
0000000.
|
||||||
@ -52,7 +58,7 @@ automation Nuimo_rotate_right:
|
|||||||
.00.000.
|
.00.000.
|
||||||
.000000.
|
.000000.
|
||||||
.000000.
|
.000000.
|
||||||
........ '
|
........'
|
||||||
interval: 0.5
|
interval: 0.5
|
||||||
```
|
```
|
||||||
|
|
||||||
@ -60,7 +66,7 @@ Troubleshooting:
|
|||||||
|
|
||||||
- use `hcitool lescan` to see the mac address of your device
|
- use `hcitool lescan` to see the mac address of your device
|
||||||
|
|
||||||
- allow non-root user access to Bluetooth LE with `sudo setcap cap_net_raw+eip $(eval readlink -f $(which python))`
|
- allow non-root user access to Bluetooth LE with `sudo setcap cap_net_raw+eip $(eval readlink -f $(which python))`
|
||||||
|
|
||||||
- install the newest version of [pygattlib](https://bitbucket.org/OscarAcena/pygattlib) from the repository, either because there is no binary package for your system or the pip version contains errors, with `pip install hg+https://bitbucket.org/OscarAcena/pygattlib --target $HOME/.homeassistant/deps`.
|
- install the newest version of [pygattlib](https://bitbucket.org/OscarAcena/pygattlib) from the repository, either because there is no binary package for your system or the pip version contains errors, with `pip install hg+https://bitbucket.org/OscarAcena/pygattlib --target $HOME/.homeassistant/deps`.
|
||||||
(Dependencies of pygattlib: `sudo apt-get install pkg-config libboost-python-dev libboost-thread-dev libbluetooth-dev libglib2.0-dev python-dev`)
|
(Dependencies of pygattlib: `sudo apt-get install pkg-config libboost-python-dev libboost-thread-dev libbluetooth-dev libglib2.0-dev python-dev`)
|
||||||
|
@ -14,7 +14,7 @@ ha_iot_class: "Local Push"
|
|||||||
---
|
---
|
||||||
|
|
||||||
The `opentherm_gw` component is used to control the [OpenTherm Gateway](http://otgw.tclcode.com/) from Home Assistant.
|
The `opentherm_gw` component is used to control the [OpenTherm Gateway](http://otgw.tclcode.com/) from Home Assistant.
|
||||||
When enabled, this component will automatically add it's [`climate` entity](/components/climate.opentherm_gw) to Home Assistant.
|
When enabled, this component will automatically add its [`climate` entity](/components/climate.opentherm_gw) to Home Assistant.
|
||||||
|
|
||||||
# {% linkable_title Configuration %}
|
# {% linkable_title Configuration %}
|
||||||
|
|
||||||
|
@ -22,9 +22,64 @@ There is currently support for the following device types within Home Assistant:
|
|||||||
|
|
||||||
The module communicates via Satel's open TCP protocol published on their website. It subscribes for new events coming from alarm system and reacts to them immediately.
|
The module communicates via Satel's open TCP protocol published on their website. It subscribes for new events coming from alarm system and reacts to them immediately.
|
||||||
|
|
||||||
**IMPORTANT:** The library currently doesn't support encrypted connection to your alarm, so you need **to turn off encryption for integration protocol**. In Polish: "koduj integracje" must be unchecked. You will find this setting in your DLOADX program.
|
## {% linkable_title Setup %}
|
||||||
|
|
||||||
|
The library currently doesn't support encrypted connection to your alarm, so you need **to turn off encryption for integration protocol**. In Polish: "koduj integracje" must be unchecked. You will find this setting in your DloadX program.
|
||||||
|
|
||||||
|
A list of all zone IDs can be taken from DloadX program.
|
||||||
|
|
||||||
|
For more information on the available zone types, take a look at the [Binary Sensor](/components/binary_sensor.alarmdecoder/) documentation. Note: If no zones are specified, Home Assistant will not load any binary_sensor components."
|
||||||
|
|
||||||
|
## {% linkable_title Configuration %}
|
||||||
|
|
||||||
|
A `satel_integra` section must be present in the `configuration.yaml` file:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
# Example configuration.yaml entry
|
||||||
|
satel_integra:
|
||||||
|
host: IP_ADDRESS
|
||||||
|
```
|
||||||
|
|
||||||
|
{% configuration %}
|
||||||
|
host:
|
||||||
|
description: The IP address of the Satel Integra ETHM module on your home network, if using socket type.
|
||||||
|
required: true
|
||||||
|
default: localhost
|
||||||
|
type: string
|
||||||
|
port:
|
||||||
|
description: The port on which the ETHM module listens for clients using integration protocol.
|
||||||
|
required: false
|
||||||
|
default: 7094
|
||||||
|
type: integer
|
||||||
|
partition:
|
||||||
|
description: The partition to operate on. Integra can support multiple partitions, this platform only supports one.
|
||||||
|
required: false
|
||||||
|
default: 1
|
||||||
|
type: integer
|
||||||
|
arm_home_mode:
|
||||||
|
description: The mode in which arm Satel Integra when 'arm home' is used. Possible options are `1`,`2` or `3`. For more information on what are the differences between them, please refer to Satel Integra manual.
|
||||||
|
required: false
|
||||||
|
default: 1
|
||||||
|
type: integer
|
||||||
|
zones:
|
||||||
|
description: "This module does not discover currently which zones are actually in use, so it will only monitor the ones defined in the configuration. For each zone, a proper ID must be given as well as its name (does not need to match the one specified in Satel Integra alarm)."
|
||||||
|
required: false
|
||||||
|
type: [integer, list]
|
||||||
|
keys:
|
||||||
|
name:
|
||||||
|
description: Name of the zone.
|
||||||
|
required: true
|
||||||
|
type: string
|
||||||
|
type:
|
||||||
|
description: The zone type.
|
||||||
|
required: false
|
||||||
|
default: motion
|
||||||
|
type: string
|
||||||
|
{% endconfiguration %}
|
||||||
|
|
||||||
|
|
||||||
|
## {% linkable_title Full examples %}
|
||||||
|
|
||||||
A `satel_integra` section must be present in the `configuration.yaml` file and contain the following options as required:
|
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
@ -33,7 +88,6 @@ satel_integra:
|
|||||||
port: 7094
|
port: 7094
|
||||||
partition: 1
|
partition: 1
|
||||||
arm_home_mode: 1
|
arm_home_mode: 1
|
||||||
|
|
||||||
zones:
|
zones:
|
||||||
01:
|
01:
|
||||||
name: 'Bedroom'
|
name: 'Bedroom'
|
||||||
@ -47,19 +101,8 @@ satel_integra:
|
|||||||
113:
|
113:
|
||||||
name: 'Entry door'
|
name: 'Entry door'
|
||||||
type: 'opening'
|
type: 'opening'
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
||||||
Configuration variables:
|
|
||||||
|
|
||||||
- **host** (*Required*): The IP address of the Satel Integra ETHM module on your home network, if using socket type. Default: `localhost`
|
|
||||||
- **port** (*Optional*): The port on which the ETHM module listens for clients using integration protocol. Default: `7094`
|
|
||||||
- **partition** (*Optional*): The partition to operate on. Integra can support multiple partitions, this platform only supports one. Default: `1`
|
|
||||||
- **arm_home_mode** (*Optional*): The mode in which arm Satel Integra when 'arm home' is used. Possible options are `1`,`2` or `3`, default being `1`. For more information on what are the differences between them, please refer to Satel Integra manual.
|
|
||||||
- **zones** (*Optional*): This module does not discover currently which zones are actually in use, so it will only monitor the ones defined in the config. For each zone, a proper ID must be given as well as its name (does not need to match the one specified in Satel Integra alarm). For more information on the available zone types, take a look at the [Binary Sensor](/components/binary_sensor.alarmdecoder/) docs. *Note: If no zones are specified, Home Assistant will not load any binary_sensor components.*
|
|
||||||
|
|
||||||
List of all zone IDs can be taken from DloadX program.
|
|
||||||
|
|
||||||
Having configured the zones, you can use them for automation, such as to react on the movement in your bedroom.
|
Having configured the zones, you can use them for automation, such as to react on the movement in your bedroom.
|
||||||
For example:
|
For example:
|
||||||
|
|
||||||
@ -73,7 +116,5 @@ For example:
|
|||||||
service: input_boolean.turn_on
|
service: input_boolean.turn_on
|
||||||
data:
|
data:
|
||||||
entity_id: input_boolean.movement_detected
|
entity_id: input_boolean.movement_detected
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
||||||
Enjoy!
|
|
||||||
|
@ -13,7 +13,6 @@ ha_release: 0.48
|
|||||||
ha_iot_class: "Local Push"
|
ha_iot_class: "Local Push"
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
||||||
The `bh1750` sensor platform allows you to read the ambient light level in Lux from a [BH1750FVI sensor](http://cpre.kmutnb.ac.th/esl/learning/bh1750-light-sensor/bh1750fvi-e_datasheet.pdf) connected via [I2c](https://en.wikipedia.org/wiki/I²C) bus (SDA, SCL pins). It allows you to use all the resolution modes of the sensor described in its datasheet.
|
The `bh1750` sensor platform allows you to read the ambient light level in Lux from a [BH1750FVI sensor](http://cpre.kmutnb.ac.th/esl/learning/bh1750-light-sensor/bh1750fvi-e_datasheet.pdf) connected via [I2c](https://en.wikipedia.org/wiki/I²C) bus (SDA, SCL pins). It allows you to use all the resolution modes of the sensor described in its datasheet.
|
||||||
|
|
||||||
Tested devices:
|
Tested devices:
|
||||||
@ -30,15 +29,43 @@ sensor:
|
|||||||
- platform: bh1750
|
- platform: bh1750
|
||||||
```
|
```
|
||||||
|
|
||||||
Configuration variables:
|
{% configuration %}
|
||||||
|
name:
|
||||||
- **name** (*Optional*): The name of the sensor
|
description: Name of the sensor.
|
||||||
- **i2c_address** (*Optional*): I2c address of the sensor. It is 0x23 or 0x5C.
|
required: false
|
||||||
- **i2c_bus** (*Optional*): I2c bus where the sensor is. Defaults to 1, for Raspberry Pi 2 and 3.
|
default: BH1750 Light Sensor
|
||||||
- **operation_mode** (*Optional*): Working mode for the sensor. Defaults to `continuous_high_res_mode_1` for continuous measurement and 1 lx resolution.
|
type: string
|
||||||
- **measurement_delay_ms** (*Optional*): Delay time in ms for waiting the sensor to get the measure. Defaults to 120 ms.
|
i2c_address:
|
||||||
- **multiplier** (*Optional*): Correction coefficient to multiply the measured light level. Value between 0.1 and 10. Default is 1.
|
description: I2c address of the sensor. It is 0x23 or 0x5C.
|
||||||
|
required: false
|
||||||
|
default: 0x23
|
||||||
|
type: string
|
||||||
|
i2c_bus:
|
||||||
|
description: I2c bus where the sensor is.
|
||||||
|
required: false
|
||||||
|
default: 1, for Raspberry Pi 2 and 3.
|
||||||
|
type: integer
|
||||||
|
operation_mode:
|
||||||
|
description: Working mode for the sensor.
|
||||||
|
required: false
|
||||||
|
default: continuous_high_res_mode_1
|
||||||
|
type: string
|
||||||
|
sensitivity:
|
||||||
|
description: The sensitivity of the sensor can be a value between 31 and 254.
|
||||||
|
required: false
|
||||||
|
default: 69
|
||||||
|
type: integer
|
||||||
|
measurement_delay_ms:
|
||||||
|
description: Delay time in ms for waiting the sensor to get the measure.
|
||||||
|
required: false
|
||||||
|
default: 120
|
||||||
|
type: integer
|
||||||
|
multiplier:
|
||||||
|
description: Correction coefficient to multiply the measured light level. Value between 0.1 and 10.
|
||||||
|
required: false
|
||||||
|
default: 1
|
||||||
|
type: integer
|
||||||
|
{% endconfiguration %}
|
||||||
|
|
||||||
## {% linkable_title Full Examples %}
|
## {% linkable_title Full Examples %}
|
||||||
|
|
||||||
@ -53,6 +80,7 @@ sensor:
|
|||||||
name: Ambient light
|
name: Ambient light
|
||||||
i2c_address: 0x5C
|
i2c_address: 0x5C
|
||||||
operation_mode: one_time_high_res_mode_1
|
operation_mode: one_time_high_res_mode_1
|
||||||
|
sensitivity: 60
|
||||||
measurement_delay_ms: 200
|
measurement_delay_ms: 200
|
||||||
scan_interval: 25
|
scan_interval: 25
|
||||||
```
|
```
|
||||||
|
@ -59,7 +59,7 @@ display_options:
|
|||||||
timestamp:
|
timestamp:
|
||||||
description: Timestamp
|
description: Timestamp
|
||||||
mined_blocks:
|
mined_blocks:
|
||||||
description: Minded Blocks
|
description: Mined Blocks
|
||||||
blocks_size:
|
blocks_size:
|
||||||
description: Block size
|
description: Block size
|
||||||
total_fees_btc:
|
total_fees_btc:
|
||||||
|
@ -13,7 +13,6 @@ ha_release: 0.48
|
|||||||
ha_iot_class: "Local Push"
|
ha_iot_class: "Local Push"
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
||||||
The `bme280` sensor platform allows you to read temperature, humidity and pressure values of a [Bosch BME280 Environmental sensor](https://cdn-shop.adafruit.com/datasheets/BST-BME280_DS001-10.pdf) connected via [I2c](https://en.wikipedia.org/wiki/I²C) bus (SDA, SCL pins). It allows you to use all the operation modes of the sensor described in its datasheet.
|
The `bme280` sensor platform allows you to read temperature, humidity and pressure values of a [Bosch BME280 Environmental sensor](https://cdn-shop.adafruit.com/datasheets/BST-BME280_DS001-10.pdf) connected via [I2c](https://en.wikipedia.org/wiki/I²C) bus (SDA, SCL pins). It allows you to use all the operation modes of the sensor described in its datasheet.
|
||||||
|
|
||||||
Tested devices:
|
Tested devices:
|
||||||
@ -30,19 +29,63 @@ sensor:
|
|||||||
- platform: bme280
|
- platform: bme280
|
||||||
```
|
```
|
||||||
|
|
||||||
Configuration variables:
|
{% configuration %}
|
||||||
|
name:
|
||||||
- **name** (*Optional*): The name of the sensor
|
description: The name of the sensor.
|
||||||
- **i2c_address** (*Optional*): I2c address of the sensor. It is 0x76 or 0x77.
|
required: false
|
||||||
- **i2c_bus** (*Optional*): I2c bus where the sensor is. Defaults to 1, for Raspberry Pi 2 and 3.
|
default: BME280 Sensor
|
||||||
- **operation_mode** (*Optional*): Power mode for the sensor. Use 2 for forced mode or 3 for normal mode. Defaults to normal mode.
|
type: string
|
||||||
- **time_standby** (*Optional*): Standby time in ms for normal mode of operation as described in the sensor datasheet. Defaults to 5 ms.
|
i2c_address:
|
||||||
- **oversampling_temperature** (*Optional*): Oversampling multiplier as described in the sensor datasheet. Can be 0 (no sampling), 1, 2, 4, 8, or 16. Default is 1.
|
description: I2c address of the sensor. It is 0x76 or 0x77.
|
||||||
- **oversampling_pressure** (*Optional*): Oversampling multiplier as described in the sensor datasheet. Can be 0 (no sampling), 1, 2, 4, 8, or 16. Default is 1.
|
required: false
|
||||||
- **oversampling_humidity** (*Optional*): Oversampling multiplier as described in the sensor datasheet. Can be 0 (no sampling), 1, 2, 4, 8, or 16. Default is 1.
|
default: 0x76
|
||||||
- **filter_mode** (*Optional*): IIR filter coeficient as described in the sensor datasheet. Default is 0, for filter off.
|
type: string
|
||||||
- **delta_temperature** (*Optional*): Absolute delta for temperature correction.
|
i2c_bus:
|
||||||
- **monitored_conditions** array (*Optional*): Conditions to monitor. Available conditions are *temperature*, *humidity* and *pressure*. By default all three are displayed.
|
description: I2c bus where the sensor is.
|
||||||
|
required: false
|
||||||
|
default: 1, for Raspberry Pi 2 and 3.
|
||||||
|
type: integer
|
||||||
|
operation_mode:
|
||||||
|
description: Power mode for the sensor. Use 2 for forced mode or 3 for normal mode.
|
||||||
|
required: false
|
||||||
|
default: 3
|
||||||
|
type: integer
|
||||||
|
time_standby:
|
||||||
|
description: Standby time in ms for normal mode of operation as described in the sensor datasheet.
|
||||||
|
required: false
|
||||||
|
default: 5
|
||||||
|
type: integer
|
||||||
|
oversampling_temperature:
|
||||||
|
description: Oversampling multiplier as described in the sensor datasheet. Can be 0 (no sampling), 1, 2, 4, 8, or 16.
|
||||||
|
required: false
|
||||||
|
default: 1
|
||||||
|
type: integer
|
||||||
|
oversampling_pressure:
|
||||||
|
description: Oversampling multiplier as described in the sensor datasheet. Can be 0 (no sampling), 1, 2, 4, 8, or 16.
|
||||||
|
required: false
|
||||||
|
default: 1
|
||||||
|
type: integer
|
||||||
|
oversampling_humidity:
|
||||||
|
description: Oversampling multiplier as described in the sensor datasheet. Can be 0 (no sampling), 1, 2, 4, 8, or 16.
|
||||||
|
required: false
|
||||||
|
default: 1
|
||||||
|
type: integer
|
||||||
|
filter_mode:
|
||||||
|
description: IIR filter coeficient as described in the sensor datasheet.
|
||||||
|
required: false
|
||||||
|
default: 0
|
||||||
|
type: integer
|
||||||
|
delta_temperature:
|
||||||
|
description: Absolute delta for temperature correction.
|
||||||
|
required: false
|
||||||
|
default: 0
|
||||||
|
type: float
|
||||||
|
monitored_conditions:
|
||||||
|
description: Conditions to monitor. Available conditions are *temperature*, *humidity* and *pressure*.
|
||||||
|
required: false
|
||||||
|
default: All three conditions
|
||||||
|
type: list
|
||||||
|
{% endconfiguration %}
|
||||||
|
|
||||||
## {% linkable_title Full Examples %}
|
## {% linkable_title Full Examples %}
|
||||||
|
|
||||||
|
@ -15,36 +15,55 @@ ha_iot_class: "Cloud Polling"
|
|||||||
|
|
||||||
The `dweet` sensor platform allows you to get details from your devices which are publishing their values to [Dweet.io](https://dweet.io/).
|
The `dweet` sensor platform allows you to get details from your devices which are publishing their values to [Dweet.io](https://dweet.io/).
|
||||||
|
|
||||||
To use Dweet.io in your installation, add the following to your `configuration.yaml` file:
|
## {% linkable_title Configuration %}
|
||||||
|
|
||||||
|
To use Dweet.io sensors in your installation, add the following to your `configuration.yaml` file:
|
||||||
|
|
||||||
|
{% raw %}
|
||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
sensor:
|
sensor:
|
||||||
- platform: dweet
|
- platform: dweet
|
||||||
device: THING_NAME
|
device: THING_NAME
|
||||||
value_template: '{% raw %}{{ value_json.VARIABLE }}{% endraw %}'
|
value_template: '{{ value_json.VARIABLE }}'
|
||||||
```
|
```
|
||||||
|
{% endraw %}
|
||||||
|
|
||||||
Configuration variables:
|
{% configuration %}
|
||||||
|
device:
|
||||||
- **device** (*Required*): Identification of the device (also known as `thing`).
|
description: Identification of the device (also known as `thing`).
|
||||||
- **value_template** (*Required*): The variable to extract a value from the content.
|
required: true
|
||||||
- **name** (*Optional*): Let you overwrite the name of the device in the frontend.
|
type: string
|
||||||
- **unit_of_measurement** (*Optional*): Defines the unit of measurement of the sensor, if any.
|
value_template:
|
||||||
|
description: The variable to extract a value from the content.
|
||||||
|
required: true
|
||||||
|
type: template
|
||||||
|
name:
|
||||||
|
description: Let you overwrite the name of the device in the frontend.
|
||||||
|
required: false
|
||||||
|
default: Dweet.io Sensor
|
||||||
|
type: string
|
||||||
|
unit_of_measurement:
|
||||||
|
description: Defines the unit of measurement of the sensor, if any.
|
||||||
|
required: false
|
||||||
|
type: string
|
||||||
|
{% endconfiguration %}
|
||||||
|
|
||||||
### {% linkable_title Full configuration sample %}
|
### {% linkable_title Full configuration sample %}
|
||||||
|
|
||||||
A full configuration entry could look like the sample below.
|
A full configuration entry could look like the sample below.
|
||||||
|
|
||||||
|
{% raw %}
|
||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
sensor:
|
sensor:
|
||||||
- platform: dweet
|
- platform: dweet
|
||||||
name: Temperature
|
name: Temperature
|
||||||
device: THING_NAME
|
device: THING_NAME
|
||||||
value_template: '{% raw %}{{ value_json.VARIABLE }}{% endraw %}'
|
value_template: '{{ value_json.VARIABLE }}'
|
||||||
unit_of_measurement: "°C"
|
unit_of_measurement: "°C"
|
||||||
```
|
```
|
||||||
|
{% endraw %}
|
||||||
|
|
||||||
### {% linkable_title Interacting with Dweet.io %}
|
### {% linkable_title Interacting with Dweet.io %}
|
||||||
|
|
||||||
@ -53,6 +72,7 @@ You can easily send dweets from the command-line to test your sensor with `curl`
|
|||||||
```bash
|
```bash
|
||||||
$ curl -H 'Content-Type: application/json' -d '{"temperature": 40, "humidity": 65}' https://dweet.io/dweet/for/ha-sensor
|
$ curl -H 'Content-Type: application/json' -d '{"temperature": 40, "humidity": 65}' https://dweet.io/dweet/for/ha-sensor
|
||||||
```
|
```
|
||||||
|
|
||||||
will give you a response like the one below:
|
will give you a response like the one below:
|
||||||
|
|
||||||
```json
|
```json
|
||||||
@ -61,7 +81,7 @@ will give you a response like the one below:
|
|||||||
|
|
||||||
The [dweepy](https://github.com/paddycarey/dweepy) module gives you another option to work with [Dweet.io](https://dweet.io/).
|
The [dweepy](https://github.com/paddycarey/dweepy) module gives you another option to work with [Dweet.io](https://dweet.io/).
|
||||||
|
|
||||||
Send a dweet.
|
Send a dweet.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
$ python3
|
$ python3
|
||||||
@ -76,4 +96,3 @@ Receive the latest dweet.
|
|||||||
>>> dweepy.get_latest_dweet_for('ha-sensor')
|
>>> dweepy.get_latest_dweet_for('ha-sensor')
|
||||||
[{'thing': 'ha-sensor'', 'created': '2015-12-10T09:43:31.133Z', 'content': {'humidity': 65, 'temperature': 40}}]
|
[{'thing': 'ha-sensor'', 'created': '2015-12-10T09:43:31.133Z', 'content': {'humidity': 65, 'temperature': 40}}]
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -31,20 +31,47 @@ sensor:
|
|||||||
- before_offpeak_total
|
- before_offpeak_total
|
||||||
```
|
```
|
||||||
|
|
||||||
Configuration variables:
|
{% configuration %}
|
||||||
|
username:
|
||||||
- **username** (*Required*): Your EBox username.
|
description: Your EBox username.
|
||||||
- **password** (*Required*): Your EBox password.
|
required: true
|
||||||
- **monitored_variables** array (*Required*): Variables to monitor.
|
type: string
|
||||||
- **before_offpeak_download**: Download before offpeak usage
|
password:
|
||||||
- **before_offpeak_upload**: Upload before offpeak usage
|
description: Your EBox password.
|
||||||
- **before_offpeak_total**: Total before offpeak usage
|
required: true
|
||||||
- **offpeak_download**: Download offpeak usage
|
type: string
|
||||||
- **offpeak_upload**: Upload offpeak usage
|
name:
|
||||||
- **offpeak_total**: Total offpeak usage
|
description: The name of the sensor.
|
||||||
- **download**: Download usage
|
required: false
|
||||||
- **upload**: Upload usage
|
default: EBox
|
||||||
- **total**: Total usage
|
type: string
|
||||||
- **balance**: Account balance
|
monitored_variables:
|
||||||
- **limit**: Limit usage
|
description: Variables to monitor.
|
||||||
- **usage**: Percent usage
|
required: true
|
||||||
|
type: list
|
||||||
|
keys:
|
||||||
|
before_offpeak_download:
|
||||||
|
description: Download before offpeak usage
|
||||||
|
before_offpeak_upload:
|
||||||
|
description: Upload before offpeak usage
|
||||||
|
before_offpeak_total:
|
||||||
|
description: Total before offpeak usage
|
||||||
|
offpeak_download:
|
||||||
|
description: Download offpeak usage
|
||||||
|
offpeak_upload:
|
||||||
|
description: Upload offpeak usage
|
||||||
|
offpeak_total:
|
||||||
|
description: Total offpeak usage
|
||||||
|
download:
|
||||||
|
description: Download usage
|
||||||
|
upload:
|
||||||
|
description: Upload usage
|
||||||
|
total:
|
||||||
|
description: Total usage
|
||||||
|
balance:
|
||||||
|
description: Account balance
|
||||||
|
limit:
|
||||||
|
description: Limit usage
|
||||||
|
usage:
|
||||||
|
description: Percent usage
|
||||||
|
{% endconfiguration %}
|
||||||
|
@ -45,16 +45,43 @@ sensor:
|
|||||||
- type: current_values
|
- type: current_values
|
||||||
```
|
```
|
||||||
|
|
||||||
Configuration variables:
|
{% configuration %}
|
||||||
|
app_token:
|
||||||
- **app_token** (*Required*): The App Token for your account.
|
description: The App Token for your account.
|
||||||
- **utc_offset** (*Required*): Some variables (currently only the daily_cost) require that the negative number of minutes your timezone is ahead/behind UTC time.
|
required: true
|
||||||
- **monitored_variables** array (*Required*): Variables to monitor.
|
type: string
|
||||||
- **type** (*Required*): Name of the variable.
|
utc_offset:
|
||||||
- **instant_readings**: Instant energy consumption.
|
description: Some variables (currently only the daily_cost) require that the negative number of minutes your timezone is ahead/behind UTC time.
|
||||||
- **budget**: Monthly budget.
|
required: false
|
||||||
- **cost**: The cost for energy consumption (with the tariff that has been set in Efergy) over a given period.
|
default: 0
|
||||||
- **amount**: The amount of energy consumed over a given period.
|
type: string
|
||||||
- **current_values**: 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.
|
monitored_variables:
|
||||||
- **period** (*Optional*): Some variables take a period argument. Valid options are "day", "week", "month", and "year".
|
description: Variables to monitor.
|
||||||
- **currency** (*Optional*): This is used to display the cost/period as the unit when monitoring the cost. It should correspond to the actual currency used in your dashboard.
|
required: true
|
||||||
|
type: list
|
||||||
|
keys:
|
||||||
|
type:
|
||||||
|
description: Name of the variable.
|
||||||
|
required: true
|
||||||
|
type: list
|
||||||
|
keys:
|
||||||
|
instant_readings:
|
||||||
|
description: Instant energy consumption.
|
||||||
|
budget:
|
||||||
|
description: Monthly budget.
|
||||||
|
cost:
|
||||||
|
description: The cost for energy consumption (with the tariff that has been set in Efergy) over a given period.
|
||||||
|
amount:
|
||||||
|
description: The amount of energy consumed over a given period.
|
||||||
|
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.
|
||||||
|
period:
|
||||||
|
description: Some variables take a period argument. Valid options are "day", "week", "month", and "year".
|
||||||
|
required: false
|
||||||
|
default: year
|
||||||
|
type: string
|
||||||
|
currency:
|
||||||
|
description: This is used to display the cost/period as the unit when monitoring the cost. It should correspond to the actual currency used in your dashboard.
|
||||||
|
required: false
|
||||||
|
type: string
|
||||||
|
{% endconfiguration %}
|
||||||
|
@ -20,7 +20,9 @@ The `fastdotcom` sensor component uses the [Fast.com](https://fast.com/) web ser
|
|||||||
Currently fast.com only supports measuring download bandwidth. If you want to measure bandwidth metrics other then download such as ping and upload, utilize the [speedtest](/components/sensor.speedtest) component.
|
Currently fast.com only supports measuring download bandwidth. If you want to measure bandwidth metrics other then download such as ping and upload, utilize the [speedtest](/components/sensor.speedtest) component.
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
By default, it will run every hour. The user can change the update frequency in the config by defining the minute, hour, and day for a speedtest to run.
|
By default, it will run every hour. The user can change the update frequency in the configuration by defining the minute and hour for a speedtest to run.
|
||||||
|
|
||||||
|
## {% linkable_title Configuration %}
|
||||||
|
|
||||||
To add a Fast.com sensor to your installation, add the following to your `configuration.yaml` file:
|
To add a Fast.com sensor to your installation, add the following to your `configuration.yaml` file:
|
||||||
|
|
||||||
@ -28,11 +30,9 @@ Once per hour, on the hour (default):
|
|||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
sensor:
|
sensor:
|
||||||
- platform: fastdotcom
|
- platform: fastdotcom
|
||||||
```
|
```
|
||||||
|
|
||||||
More examples:
|
|
||||||
|
|
||||||
Every half hour of every day:
|
Every half hour of every day:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
@ -42,14 +42,31 @@ sensor:
|
|||||||
- 0
|
- 0
|
||||||
- 30
|
- 30
|
||||||
```
|
```
|
||||||
Configuration variables:
|
|
||||||
|
|
||||||
- **minute** (*Optional*): Specify the minute(s) of the hour to schedule the speedtest. Use a list for multiple entries. Default is 0.
|
{% configuration %}
|
||||||
- **hour** (*Optional*): Specify the hour(s) of the day to schedule the speedtest. Use a list for multiple entries. Default is None.
|
second:
|
||||||
- **manual** (*Optional*): True or False to turn manual mode on or off. Manual mode will disable scheduled speedtests.
|
description: Specify the second(s) of the hour to schedule the speedtest. Use a list for multiple entries.
|
||||||
|
required: false
|
||||||
|
default: 0
|
||||||
|
type: list
|
||||||
|
minute:
|
||||||
|
description: Specify the minute(s) of the hour to schedule the speedtest. Use a list for multiple entries.
|
||||||
|
required: false
|
||||||
|
default: 0
|
||||||
|
type: list
|
||||||
|
hour:
|
||||||
|
description: Specify the hour(s) of the day to schedule the speedtest. Use a list for multiple entries.
|
||||||
|
required: false
|
||||||
|
type: list
|
||||||
|
manual:
|
||||||
|
description: True or False to turn manual mode on or off. Manual mode will disable scheduled speedtests.
|
||||||
|
required: false
|
||||||
|
default: false
|
||||||
|
type: boolean
|
||||||
|
{% endconfiguration %}
|
||||||
|
|
||||||
There is also a service named `sensor.update_fastdotcom` that you can use to run a fast.com speedtest on demand. You can turn on manual mode to disable the scheduled speedtests.
|
There is also a service named `sensor.update_fastdotcom` that you can use to run a fast.com speedtest on demand. You can turn on manual mode to disable the scheduled speedtests.
|
||||||
|
|
||||||
## Note
|
## {% linkable_title Notes %}
|
||||||
|
|
||||||
- When running on Raspberry Pi, just note that the maximum speed is limited by its 100 Mbit/s LAN adapter.
|
- When running on Raspberry Pi, just note that the maximum speed is limited by its 100 Mbit/s LAN adapter.
|
||||||
|
@ -13,7 +13,6 @@ ha_release: 0.39
|
|||||||
ha_iot_class: "Cloud Polling"
|
ha_iot_class: "Cloud Polling"
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
||||||
Integrate your [Fido](https://www.fido.ca/) account information into Home Assistant.
|
Integrate your [Fido](https://www.fido.ca/) account information into Home Assistant.
|
||||||
|
|
||||||
## {% linkable_title Configuration %}
|
## {% linkable_title Configuration %}
|
||||||
@ -32,9 +31,8 @@ sensor:
|
|||||||
- data_used
|
- data_used
|
||||||
```
|
```
|
||||||
|
|
||||||
Configuration variables:
|
|
||||||
{% configuration %}
|
{% configuration %}
|
||||||
username:
|
username:
|
||||||
description: Your Fido username (your Fido phone number or your email).
|
description: Your Fido username (your Fido phone number or your email).
|
||||||
required: true
|
required: true
|
||||||
type: string
|
type: string
|
||||||
@ -48,7 +46,7 @@ number:
|
|||||||
type: string
|
type: string
|
||||||
monitored_variables:
|
monitored_variables:
|
||||||
description: Variables to monitor.
|
description: Variables to monitor.
|
||||||
required: true
|
required: true
|
||||||
type: list
|
type: list
|
||||||
keys:
|
keys:
|
||||||
fido_dollar:
|
fido_dollar:
|
||||||
|
@ -13,7 +13,6 @@ ha_release: 0.27
|
|||||||
ha_iot_class: "Local Polling"
|
ha_iot_class: "Local Polling"
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
||||||
The `fritzbox_callmonitor` sensor monitors the call monitor exposed by [AVM Fritz!Box](http://avm.de/produkte/fritzbox/) routers on TCP port 1012. It will assume the values `idle`, `ringing`, `dialing` or `talking` with the phone numbers involved contained in the state attributes.
|
The `fritzbox_callmonitor` sensor monitors the call monitor exposed by [AVM Fritz!Box](http://avm.de/produkte/fritzbox/) routers on TCP port 1012. It will assume the values `idle`, `ringing`, `dialing` or `talking` with the phone numbers involved contained in the state attributes.
|
||||||
It can also access the internal phone book of the router to look up the names corresponding to the phone numbers and store them in the state attributes.
|
It can also access the internal phone book of the router to look up the names corresponding to the phone numbers and store them in the state attributes.
|
||||||
|
|
||||||
@ -41,14 +40,40 @@ sensor:
|
|||||||
- platform: fritzbox_callmonitor
|
- platform: fritzbox_callmonitor
|
||||||
```
|
```
|
||||||
|
|
||||||
Configuration variables:
|
{% configuration %}
|
||||||
|
name:
|
||||||
- **host** (*Optional*): The IP address of your router, eg. 192.168.1.1. It is optional since every fritzbox is also reachable by using the IP address 169.254.1.1.
|
description: Give the sensor a friendly name for in the front-end.
|
||||||
- **port** (*Optional*): The TCP port of the call monitor. There is usually no reason to change this.
|
required: false
|
||||||
- **username** (*Optional*): Fritz!Box user's user name. This is required to use the phone book lookup feature. The user needs to have the "voice message, fax message, Fritz!App Fon and call list" permission.
|
default: Phone
|
||||||
- **password** (*Optional*): Fritz!Box user's user password. This is required to use the phone book lookup feature.
|
type: string
|
||||||
- **phonebook** (*Optional*): Numerical ID identifying the phonebook to be used. If there is just one phonebook, this is usually 0.
|
host:
|
||||||
- **prefixes** (*Optional*): In case of a local call, the phone number seen by the router might differ from the one stored in the phone book by an area code, similarly for the international prefix. To remedy this, a list of prefixes, that can be appended to the phone number in case it is not found in the phone book, can be given.
|
description: The IP address of your router, e.g., 192.168.1.1. It is optional since every fritzbox is also reachable by using the IP address 169.254.1.1.
|
||||||
|
required: false
|
||||||
|
default: 169.254.1.1
|
||||||
|
type: string
|
||||||
|
port:
|
||||||
|
description: The TCP port of the call monitor. There is usually no reason to change this.
|
||||||
|
required: false
|
||||||
|
default: 1012
|
||||||
|
type: integer
|
||||||
|
username:
|
||||||
|
description: Fritz!Box user's user name. This is required to use the phone book lookup feature. The user needs to have the "voice message, fax message, Fritz!App Fon and call list" permission.
|
||||||
|
required: false
|
||||||
|
type: string
|
||||||
|
password:
|
||||||
|
description: Fritz!Box user's user password. This is required to use the phone book lookup feature.
|
||||||
|
required: false
|
||||||
|
type: string
|
||||||
|
phonebook:
|
||||||
|
description: Numerical ID identifying the phonebook to be used. If there is just one phonebook, this is usually 0.
|
||||||
|
required: false
|
||||||
|
default: 0
|
||||||
|
type: integer
|
||||||
|
prefixes:
|
||||||
|
description: In case of a local call, the phone number seen by the router might differ from the one stored in the phone book by an area code, similarly for the international prefix. To remedy this, a list of prefixes, that can be appended to the phone number in case it is not found in the phone book, can be given.
|
||||||
|
required: false
|
||||||
|
type: list
|
||||||
|
{% endconfiguration %}
|
||||||
|
|
||||||
## {% linkable_title Examples %}
|
## {% linkable_title Examples %}
|
||||||
|
|
||||||
|
@ -28,9 +28,18 @@ sensor:
|
|||||||
- platform: fritzbox_netmonitor
|
- platform: fritzbox_netmonitor
|
||||||
```
|
```
|
||||||
|
|
||||||
Configuration variables:
|
{% configuration %}
|
||||||
|
host:
|
||||||
- **host** (*Optional*): The IP address of your router, eg. 192.168.1.1. It is optional since every fritzbox is also reachable by using the IP address 169.254.1.1.
|
description: The IP address of your router, e.g., 192.168.1.1. It is optional since every fritzbox is also reachable by using the IP address 169.254.1.1.
|
||||||
|
required: false
|
||||||
|
default: 169.254.1.1
|
||||||
|
type: string
|
||||||
|
name:
|
||||||
|
description: Give the sensor a friendly name for in the front-end.
|
||||||
|
required: false
|
||||||
|
default: fritz_netmonitor
|
||||||
|
type: string
|
||||||
|
{% endconfiguration %}
|
||||||
|
|
||||||
The following statistics will be exposed as attributes.
|
The following statistics will be exposed as attributes.
|
||||||
|
|
||||||
|
@ -11,6 +11,7 @@ logo: http.png
|
|||||||
ha_category: Sensor
|
ha_category: Sensor
|
||||||
ha_release: pre 0.7
|
ha_release: pre 0.7
|
||||||
ha_iot_class: "Local Push"
|
ha_iot_class: "Local Push"
|
||||||
|
ha_qa_scale: internal
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
||||||
|
@ -16,6 +16,10 @@ ha_qa_scale: internal
|
|||||||
|
|
||||||
The `season` sensor will display the current astronomical or meteorological season (Spring, Summer, Autumn, Winter) based on the user's setting in the configuration file.
|
The `season` sensor will display the current astronomical or meteorological season (Spring, Summer, Autumn, Winter) based on the user's setting in the configuration file.
|
||||||
|
|
||||||
|
For information on the difference between astronomical and meteorological seasons please see the link below:
|
||||||
|
|
||||||
|
- [https://www.ncei.noaa.gov/news/meteorological-versus-astronomical-seasons](https://www.ncei.noaa.gov/news/meteorological-versus-astronomical-seasons)
|
||||||
|
|
||||||
All information about how the seasons work was taken from Wikipedia:
|
All information about how the seasons work was taken from Wikipedia:
|
||||||
|
|
||||||
- [https://en.wikipedia.org/wiki/Season#Astronomical](https://en.wikipedia.org/wiki/Season#Astronomical)
|
- [https://en.wikipedia.org/wiki/Season#Astronomical](https://en.wikipedia.org/wiki/Season#Astronomical)
|
||||||
|
@ -12,10 +12,8 @@ ha_category: Sensor
|
|||||||
ha_iot_class: "Local Polling"
|
ha_iot_class: "Local Polling"
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
||||||
The `tellstick` sensor platform allows you to get current meteorological data from a [TellStick](http://www.telldus.se/products/tellstick) device.
|
The `tellstick` sensor platform allows you to get current meteorological data from a [TellStick](http://www.telldus.se/products/tellstick) device.
|
||||||
|
|
||||||
|
|
||||||
To use your TellStick device, you first have to set up your [Tellstick hub](/components/tellstick/) and then add the following to your `configuration.yaml` file:
|
To use your TellStick device, you first have to set up your [Tellstick hub](/components/tellstick/) and then add the following to your `configuration.yaml` file:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
@ -24,12 +22,27 @@ sensor:
|
|||||||
- platform: tellstick
|
- platform: tellstick
|
||||||
```
|
```
|
||||||
|
|
||||||
Configuration variables:
|
{% configuration %}
|
||||||
|
sensor:
|
||||||
- **ID: Name** (*Optional*): Entry for a sensor with the name for it and its ID.
|
description: "Entry for a sensor with the ID and its name, e.g., ID: Name."
|
||||||
- **only_named** (*Optional*): Only show the named sensors. Set to `True` to hide sensors.
|
required: false
|
||||||
- **temperature_scale** (*Optional*): The scale of the temperature value.
|
type: string
|
||||||
- **datatype_mask** (*Optional*): Mask to determine which sensor values to show based on. Please check the [TellCore tellcore.constants documentation](https://tellcore-py.readthedocs.org/en/v1.1.2/constants.html#module-tellcore.constants) for details.
|
only_named:
|
||||||
|
description: Only show the named sensors. Set to `True` to hide sensors.
|
||||||
|
required: false
|
||||||
|
default: false
|
||||||
|
type: boolean
|
||||||
|
temperature_scale:
|
||||||
|
description: The scale of the temperature value.
|
||||||
|
required: false
|
||||||
|
default: °C
|
||||||
|
type: string
|
||||||
|
datatype_mask:
|
||||||
|
description: Mask to determine which sensor values to show based on. Please check the [TellCore tellcore.constants documentation](https://tellcore-py.readthedocs.org/en/v1.1.2/constants.html#module-tellcore.constants) for details.
|
||||||
|
required: false
|
||||||
|
default: 127
|
||||||
|
type: integer
|
||||||
|
{% endconfiguration %}
|
||||||
|
|
||||||
## {% linkable_title Examples %}
|
## {% linkable_title Examples %}
|
||||||
|
|
||||||
|
@ -22,6 +22,8 @@ Supported units:
|
|||||||
- HS110
|
- HS110
|
||||||
- HS200
|
- HS200
|
||||||
|
|
||||||
|
## {% linkable_title Configuration %}
|
||||||
|
|
||||||
To use your TP-Link switch or socket in your installation, add the following to your `configuration.yaml` file:
|
To use your TP-Link switch or socket in your installation, add the following to your `configuration.yaml` file:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
@ -59,3 +61,35 @@ switch:
|
|||||||
- platform: tplink
|
- platform: tplink
|
||||||
host: SECOND_IP_ADDRESS
|
host: SECOND_IP_ADDRESS
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## {% linkable_title Configure Energy Sensors %} ##
|
||||||
|
|
||||||
|
In order to get the power consumption readings from the HS110, you'll have to create a [template sensor](/components/switch.template/). In the example below, change all of the `my_tp_switch`'s to match your switch's entity ID.
|
||||||
|
|
||||||
|
{% raw %}
|
||||||
|
```yaml
|
||||||
|
sensor:
|
||||||
|
- platform: template
|
||||||
|
sensors:
|
||||||
|
my_tp_switch_amps:
|
||||||
|
friendly_name_template: "{{ states.switch.my_tp_switch.name}} Current"
|
||||||
|
value_template: '{{ states.switch.my_tp_switch.attributes["current_a"] | float }}'
|
||||||
|
unit_of_measurement: 'A'
|
||||||
|
my_tp_switch_watts:
|
||||||
|
friendly_name_template: "{{ states.switch.my_tp_switch.name}} Current Consumption"
|
||||||
|
value_template: '{{ states.switch.my_tp_switch.attributes["current_power_w"] | float }}'
|
||||||
|
unit_of_measurement: 'W'
|
||||||
|
my_tp_switch_total_kwh:
|
||||||
|
friendly_name_template: "{{ states.switch.my_tp_switch.name}} Total Consumption"
|
||||||
|
value_template: '{{ states.switch.my_tp_switch.attributes["total_energy_kwh"] | float }}'
|
||||||
|
unit_of_measurement: 'kWh'
|
||||||
|
my_tp_switch_volts:
|
||||||
|
friendly_name_template: "{{ states.switch.my_tp_switch.name}} Voltage"
|
||||||
|
value_template: '{{ states.switch.my_tp_switch.attributes["voltage"] | float }}'
|
||||||
|
unit_of_measurement: 'V'
|
||||||
|
my_tp_switch_today_kwh:
|
||||||
|
friendly_name_template: "{{ states.switch.my_tp_switch.name}} Today's Consuption"
|
||||||
|
value_template: '{{ states.switch.my_tp_switch.attributes["today_energy_kwh"] | float }}'
|
||||||
|
unit_of_measurement: 'kWh'
|
||||||
|
```
|
||||||
|
{% endraw %}
|
||||||
|
@ -44,7 +44,7 @@ password:
|
|||||||
required: true
|
required: true
|
||||||
type: string
|
type: string
|
||||||
scan_interval:
|
scan_interval:
|
||||||
description: API polling interval. Minimal value can't be less then 300.
|
description: API polling interval in seconds. Minimum value can't be less than 300 (5 minutes). Very frequent polling can use battery.
|
||||||
required: false
|
required: false
|
||||||
type: integer
|
type: integer
|
||||||
default: 300
|
default: 300
|
||||||
|
@ -25,15 +25,51 @@ mqtt:
|
|||||||
payload: 'offline'
|
payload: 'offline'
|
||||||
```
|
```
|
||||||
|
|
||||||
Configuration variables:
|
{% configuration %}
|
||||||
|
birth_message:
|
||||||
- **birth_message** (*Optional*):
|
description: Birth Message.
|
||||||
- **topic** (*Required*): The MQTT topic to publish the message.
|
required: false
|
||||||
- **payload** (*Required*): The message content.
|
type: list
|
||||||
- **qos** (*Optional*): The maximum QoS level of the topic. Default is 0.
|
keys:
|
||||||
- **retain** (*Optional*): If the published message should have the retain flag on or not. Defaults to `True`.
|
topic:
|
||||||
- **will_message** (*Optional*):
|
description: The MQTT topic to publish the message.
|
||||||
- **topic** (*Required*): The MQTT topic to publish the message.
|
required: true
|
||||||
- **payload** (*Required*): The message content.
|
type: string
|
||||||
- **qos** (*Optional*): The maximum QoS level of the topic. Default is 0.
|
payload:
|
||||||
- **retain** (*Optional*): If the published message should have the retain flag on or not. Defaults to `True`.
|
description: The message content.
|
||||||
|
required: true
|
||||||
|
type: string
|
||||||
|
qos:
|
||||||
|
description: The maximum QoS level of the topic.
|
||||||
|
required: false
|
||||||
|
default: 0
|
||||||
|
type: integer
|
||||||
|
retain:
|
||||||
|
description: If the published message should have the retain flag on or not.
|
||||||
|
required: false
|
||||||
|
default: true
|
||||||
|
type: boolean
|
||||||
|
will_message:
|
||||||
|
description: Will Message
|
||||||
|
required: false
|
||||||
|
type: list
|
||||||
|
keys:
|
||||||
|
topic:
|
||||||
|
description: The MQTT topic to publish the message.
|
||||||
|
required: true
|
||||||
|
type: string
|
||||||
|
payload:
|
||||||
|
description: The message content.
|
||||||
|
required: true
|
||||||
|
type: string
|
||||||
|
qos:
|
||||||
|
description: The maximum QoS level of the topic.
|
||||||
|
required: false
|
||||||
|
default: 0
|
||||||
|
type: integer
|
||||||
|
retain:
|
||||||
|
description: If the published message should have the retain flag on or not.
|
||||||
|
required: false
|
||||||
|
default: true
|
||||||
|
type: boolean
|
||||||
|
{% endconfiguration %}
|
||||||
|
@ -164,7 +164,7 @@ Home Assistant is not affiliated with CloudMQTT nor will receive any kickbacks.
|
|||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
mqtt:
|
mqtt:
|
||||||
broker: CLOUTMQTT_SERVER
|
broker: CLOUDMQTT_SERVER
|
||||||
port: CLOUDMQTT_PORT
|
port: CLOUDMQTT_PORT
|
||||||
username: CLOUDMQTT_USER
|
username: CLOUDMQTT_USER
|
||||||
password: CLOUDMQTT_PASSWORD
|
password: CLOUDMQTT_PASSWORD
|
||||||
|
@ -20,9 +20,17 @@ mqtt:
|
|||||||
certificate: /home/paulus/dev/addtrustexternalcaroot.crt
|
certificate: /home/paulus/dev/addtrustexternalcaroot.crt
|
||||||
```
|
```
|
||||||
|
|
||||||
Configuration variables:
|
{% configuration %}
|
||||||
|
certificate:
|
||||||
- **certificate** (*Optional*): 'auto' or the certificate authority certificate file that is to be treated as trusted by this client. 'auto' uses the bundled certificates. If a file is specified the file should contain the root certificate of the certificate authority that signed your broker's certificate, but may contain multiple certificates. Example: `/home/user/identrust-root.pem`
|
description: "'auto' or the certificate authority certificate file that is to be treated as trusted by this client. 'auto' uses the bundled certificates. If a file is specified the file should contain the root certificate of the certificate authority that signed your broker's certificate, but may contain multiple certificates. Example: `/home/user/identrust-root.pem`"
|
||||||
- **client_key** (*Optional*): Client key, eg. `/home/user/owntracks/cookie.key`.
|
required: false
|
||||||
- **client_cert** (*Optional*): Client certificate, eg. `/home/user/owntracks/cookie.crt`.
|
type: string
|
||||||
|
client_key:
|
||||||
|
description: Client key, e.g., `/home/user/owntracks/cookie.key`.
|
||||||
|
required: false
|
||||||
|
type: string
|
||||||
|
client_cert:
|
||||||
|
description: Client certificate, e.g., `/home/user/owntracks/cookie.crt`.
|
||||||
|
required: false
|
||||||
|
type: string
|
||||||
|
{% endconfiguration %}
|
||||||
|
@ -82,4 +82,16 @@ data_template:
|
|||||||
temperature: {% raw %}{{ 22 - distance(states.device_tracker.paulus) }}{% endraw %}
|
temperature: {% raw %}{{ 22 - distance(states.device_tracker.paulus) }}{% endraw %}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### {% linkable_title `homeassistant` services %}
|
||||||
|
|
||||||
|
There are four `homeassistant` services that aren't tied to any single domain, these are:
|
||||||
|
|
||||||
|
* `homeassistant.turn_on` - Turns on an entity (that supports being turned on), for example an `automation`, `switch`, etc
|
||||||
|
* `homeassistant.turn_off` - Turns off an entity (that supports being turned off), for example an `automation`, `switch`, etc
|
||||||
|
* `homeassistant.toggle` - Turns off an entity that is on, or turns on an entity that is off (that supports being turned on and off)
|
||||||
|
* `homeassistant.update_entity` - Request the update of an entity, rather than waiting for the next scheduled update, for example [google travel time] sensor, a [template sensor], or a [light]
|
||||||
|
|
||||||
[templating]: /topics/templating/
|
[templating]: /topics/templating/
|
||||||
|
[google travel time]: /components/sensor.google_travel_time/
|
||||||
|
[template sensor]: /components/sensor.template/
|
||||||
|
[light]: /components/light/
|
||||||
|
@ -101,3 +101,6 @@ Even though MQTT in general provides deeper functionality, the developer tools s
|
|||||||
{% linkable_title Info %}
|
{% linkable_title Info %}
|
||||||
|
|
||||||
The Information tab simply provides information about the current installed version, additional links and credits. The tab also contains a section that shows `syslog` information, and the contents of `home-assistant.log` with an option to clear and refresh the logs.
|
The Information tab simply provides information about the current installed version, additional links and credits. The tab also contains a section that shows `syslog` information, and the contents of `home-assistant.log` with an option to clear and refresh the logs.
|
||||||
|
|
||||||
|
The Information tab also allows makes it possible to try out the Lovelace User Interface (UI) by clicking "Try out the new Lovelace UI (experimental)" or set Lovelace as the default UI, so that when the "Overview" link in the Sidebar is selected, the Lovelace UI will load by default.
|
||||||
|
|
||||||
|
@ -122,6 +122,15 @@ _0.81.3 was skipped because it broke LL._
|
|||||||
[switch.flux docs]: /components/switch.flux/
|
[switch.flux docs]: /components/switch.flux/
|
||||||
[weather.smhi docs]: /components/weather.smhi/
|
[weather.smhi docs]: /components/weather.smhi/
|
||||||
|
|
||||||
|
## {% linkable_title Release 0.81.5 - November 3 %}
|
||||||
|
|
||||||
|
- Fix lovelace
|
||||||
|
- Remove FFmpeg input tests (@jjlawren - #18131)
|
||||||
|
|
||||||
|
## {% linkable_title Release 0.81.6 - November 4 %}
|
||||||
|
|
||||||
|
- Bugfix discovery (delete/mqtt) call for Hass.io #18159
|
||||||
|
|
||||||
## {% linkable_title If you need help... %}
|
## {% linkable_title If you need help... %}
|
||||||
|
|
||||||
...don't hesitate to use our very active [forums](https://community.home-assistant.io/) or join us for a little [chat](https://discord.gg/c5DvZ4e). The release notes have comments enabled but it's preferred if you use the former communication channels. Thanks.
|
...don't hesitate to use our very active [forums](https://community.home-assistant.io/) or join us for a little [chat](https://discord.gg/c5DvZ4e). The release notes have comments enabled but it's preferred if you use the former communication channels. Thanks.
|
||||||
|
@ -39,7 +39,7 @@ We will need a few things to get started with installing Home Assistant. For bes
|
|||||||
|
|
||||||
1. Put the SD card in your SD card reader.
|
1. Put the SD card in your SD card reader.
|
||||||
1. Open Etcher, select the Hass.io image and flash it to the SD card.
|
1. Open Etcher, select the Hass.io image and flash it to the SD card.
|
||||||
1. WiFi and Static IP setup only: Format a USB-Stick with name `CONFIG`, create the folder `network` and create the file `my-network`. Copy one of [the examples] to the `my-network` file.
|
1. WiFi and Static IP setup only: Format a USB-Stick with name `CONFIG`, create a folder named `network` and within that folder a file named `my-network`. Copy one of [the examples] to the `my-network` file.
|
||||||
1. Unmount the SD card and remove it from your SD card reader.
|
1. Unmount the SD card and remove it from your SD card reader.
|
||||||
1. Insert the SD card into your Raspberry Pi 3. If you are going to use an Ethernet cable, connect that too.
|
1. Insert the SD card into your Raspberry Pi 3. If you are going to use an Ethernet cable, connect that too.
|
||||||
1. Connect your Raspberry Pi to the power supply, so it turns on.
|
1. Connect your Raspberry Pi to the power supply, so it turns on.
|
||||||
|
Loading…
x
Reference in New Issue
Block a user