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

Merge branch 'current' into next

Browse Source
This commit is contained in:
Franck Nijhof 2023-08-28 16:00:00 +02:00
commit 1168781513
No known key found for this signature in database
GPG Key ID: D62583BA8AB11CA3
27 changed files with 105 additions and 54 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
source/_integrations/alarm_control_panel.mqtt.markdown
View File

@ -231,7 +231,7 @@ payload_trigger:
type: string
default: TRIGGER
qos:
description: The maximum QoS level of the state topic.
description: The maximum QoS level to be used when receiving and publishing messages.
required: false
type: integer
default: 0

2
source/_integrations/binary_sensor.mqtt.markdown
View File

@ -188,7 +188,7 @@ payload_on:
type: string
default: "ON"
qos:
description: The maximum QoS level to be used when receiving messages.
description: The maximum QoS level to be used when receiving and publishing messages.
required: false
type: integer
default: 0

2
source/_integrations/button.mqtt.markdown
View File

@ -169,7 +169,7 @@ payload_press:
type: string
default: "PRESS"
qos:
description: The maximum QoS level of the state topic. Default is 0 and will also be used to publishing messages.
description: The maximum QoS level to be used when receiving and publishing messages.
required: false
type: integer
default: 0

2
source/_integrations/device_tracker.mqtt.markdown
View File

@ -163,7 +163,7 @@ payload_reset:
type: string
default: "None"
qos:
description: The maximum QoS level of the state topic.
description: The maximum QoS level to be used when receiving and publishing messages.
required: false
type: integer
default: 0

2
source/_integrations/device_trigger.mqtt.markdown
View File

@ -27,7 +27,7 @@ payload:
required: false
type: string
qos:
description: The maximum QoS level to be used when receiving messages.
description: The maximum QoS level to be used when receiving and publishing messages.
required: false
type: integer
default: 0

45
source/_integrations/ecovacs.markdown
View File

@ -79,11 +79,7 @@ logger:
The `ecovacs` vacuum platform allows you to monitor and control your Ecovacs Deebot vacuums.
### Vacuum services
The `ecovacs` vacuum platform does not support eithor of the services `vacuum.pause` or `vacuum.start`, it supports the following services instead.
#### Service `vacuum.turn_on`
### Service `vacuum.start`
Start a new cleaning task.
@ -91,7 +87,7 @@ Start a new cleaning task.
|---------------------------|----------|-------------------------------------------------------|
| `entity_id` | yes | Only act on specific vacuum. Use `entity_id: all` to target all. |
#### Service `vacuum.turn_off`
### Service `vacuum.stop`
Stop the current cleaning task and return to the dock.
@ -99,9 +95,42 @@ Stop the current cleaning task and return to the dock.
|---------------------------|----------|-------------------------------------------------------|
| `entity_id` | yes | Only act on specific vacuum. Use `entity_id: all` to target all. |
#### Service `vacuum.start_pause`
### Service `vacuum.pause`
Start, pause or resume a cleaning task.
Pause a cleaning task.
| Service data attribute | Optional | Description |
|---------------------------|----------|-------------------------------------------------------|
| `entity_id` | yes | Only act on specific vacuum. Use `entity_id: all` to target all. |
### Service `vacuum.clean_spot`
Begin a spot cleaning operation.
| Service data attribute | Optional | Description |
|---------------------------|----------|-------------------------------------------------------|
| `entity_id` | yes | Only act on specific vacuum. Use `entity_id: all` to target all. |
### Service `vacuum.locate`
Locate the vacuum.
| Service data attribute | Optional | Description |
|---------------------------|----------|-------------------------------------------------------|
| `entity_id` | yes | Only act on specific vacuum. Use `entity_id: all` to target all. |
### Service `vacuum.set_fan_speed`
Pause a cleaning task.
| Service data attribute | Optional | Description |
|---------------------------|----------|-------------------------------------------------------|
| `entity_id` | yes | Only act on specific vacuum. Use `entity_id: all` to target all. |
| `fan_speed` | no | Fan speed. Values are `normal` or `high`. |
### Service `vacuum.return_to_base`
Return to charging base/dock immediately.
| Service data attribute | Optional | Description |
|---------------------------|----------|-------------------------------------------------------|

12
source/_integrations/emoncms.markdown
View File

@ -28,6 +28,8 @@ sensor:
As of Feb 2020, the integration will discover all sensors from Emoncms and will use the unit of measurement specified in the Feed from Emoncms, in preference to the one set in the configuration. Tested with [Emoncms](https://github.com/emoncms/emoncms) V10.1.13 - `unit` was added to the API around version V9.9.1.
To write information from Home Assistant to Emoncms, you can use the [`emoncms_history`](/integrations/emoncms_history) integration.
## Configuration variables
{% configuration %}
@ -36,7 +38,7 @@ api_key:
required: true
type: string
url:
description: "The base URL of Emoncms, use <https://emoncms.org> for the cloud-based version. For self-hosted Emoncms or EmonPi you may need a URL of `http://x.x.x.x/emoncms`."
description: "The base URL of Emoncms, use <https://emoncms.org> for the cloud-based version. For self-hosted Emoncms or EmonPi you may need to use a URL of `http://x.x.x.x/emoncms`."
required: true
type: string
id:
@ -82,7 +84,7 @@ If `sensor_names` is used, any feeds with defined names will get those names exa
In this section you find some more examples of how this sensor can be used.
Minimal configuration. All Feeds are added as sensors with the unit of measurement being set by the Emoncms Feed or the default unit.
Minimal configuration. All feeds are added as sensors with the unit of measurement being set by the Emoncms Feed or the default unit.
```yaml
sensor:
@ -107,7 +109,7 @@ sensor:
- 105
```
Display all feeds except feeds with their feed id specified in `exclude_feed_id`.
Display all feeds except feeds with their feed ID specified in `exclude_feed_id`.
```yaml
# Example configuration.yaml entry
@ -122,7 +124,7 @@ sensor:
- 105
```
Display only feeds with their feed id's specified in `include_only_feed_id` and give the feed sensors a name using "sensor_names". You don't have to specify all feeds names in "sensor_names", the remaining sensor names will be chosen based on "id" and the Emoncms `feedid`.
Display only feeds with their feed IDs specified in `include_only_feed_id` and give the feed sensors a name using `sensor_names`. You don't have to specify all feeds names in `sensor_names`, the remaining sensor names will be chosen based on `id` and the Emoncms `feedid`.
```yaml
# Example configuration.yaml entry
@ -162,7 +164,7 @@ sensor:
{% endraw %}
Display feeds from the same Emoncms instance with 2 groups of feeds, different `scan_interval` and a different `unit_of_measurement`.
Display feeds from the same Emoncms instance with 2 groups of feeds, where one has a differing `scan_interval` and the other a differing `unit_of_measurement`.
```yaml
# Example configuration.yaml entry

10
source/_integrations/emoncms_history.markdown
View File

@ -9,7 +9,7 @@ ha_domain: emoncms_history
ha_integration_type: integration
---
The `emoncms_history` integration makes it possible to transfer details collected with Home Assistant to [Emoncms.org](https://emoncms.org/) or your local running Emoncms instance. It will send the data to a specific input node on Emoncms with the entity IDs as a key. Afterwards you can create feeds and dashboards in Emoncms with the collected data.
The `emoncms_history` integration makes it possible to transfer (write) details collected with Home Assistant to [Emoncms.org](https://emoncms.org/) or your local running Emoncms instance. It will send the data to a specific input node on Emoncms with the entity IDs as a key. Afterwards you can create feeds and dashboards in Emoncms with the collected data.
To use the `emoncms_history` integration in your installation, add the following to your `configuration.yaml` file:
@ -24,17 +24,19 @@ emoncms_history:
- sensor.owm_wind_speed
```
To read information from Emoncms to Home Assistant, you can use the [`emoncms`](/integrations/emoncms) integration.
{% configuration %}
api_key:
description: Your Emoncms write API key
description: The write API key for your Emoncms user.
required: true
type: string
url:
description: The root URL of your Emoncms installation. (Use `https://emoncms.org` for the cloud based version)
description: "The base URL of Emoncms, use <https://emoncms.org> for the cloud-based version. For self-hosted Emoncms or EmonPi you may need a URL of `http://x.x.x.x/emoncms`."
required: true
type: string
inputnode:
description: Input node that will be used inside Emoncms. Please make sure you use a dedicated, not used before, node for this integration!
description: Input node that will be used inside Emoncms. Please make sure you use a dedicated, not used before, node for this integration!
required: true
type: integer
whitelist:

2
source/_integrations/event.mqtt.markdown
View File

@ -160,7 +160,7 @@ payload_not_available:
type: string
default: offline
qos:
description: The maximum QoS level of the state topic. Default is 0 and will also be used to publishing messages.
description: The maximum QoS level to be used when receiving and publishing messages.
required: false
type: integer
default: 0

2
source/_integrations/fan.mqtt.markdown
View File

@ -270,7 +270,7 @@ preset_modes:
type: [list]
default: []
qos:
description: The maximum QoS level of the state topic.
description: The maximum QoS level to be used when receiving and publishing messages.
required: false
type: integer
default: 0

2
source/_integrations/humidifier.mqtt.markdown
View File

@ -262,7 +262,7 @@ modes:
type: [list]
default: []
qos:
description: The maximum QoS level of the state topic.
description: The maximum QoS level to be used when receiving and publishing messages.
required: false
type: integer
default: 0

6
source/_integrations/light.mqtt.markdown
View File

@ -295,7 +295,7 @@ payload_on:
type: string
default: "ON"
qos:
description: The maximum QoS level of the state topic.
description: The maximum QoS level to be used when receiving and publishing messages.
required: false
type: integer
default: 0
@ -692,7 +692,7 @@ payload_not_available:
type: string
default: offline
qos:
description: The maximum QoS level of the state topic.
description: The maximum QoS level to be used when receiving and publishing messages.
required: false
type: integer
default: 0
@ -1054,7 +1054,7 @@ payload_not_available:
type: string
default: offline
qos:
description: The maximum QoS level of the state topic.
description: The maximum QoS level to be used when receiving and publishing messages.
required: false
type: integer
default: 0

2
source/_integrations/lock.mqtt.markdown
View File

@ -193,7 +193,7 @@ payload_open:
type: string
default: OPEN
qos:
description: The maximum QoS level of the state topic. It will also be used for messages published to command topic.
description: The maximum QoS level to be used when receiving and publishing messages.
required: false
type: integer
default: 0

2
source/_integrations/manual_mqtt.markdown
View File

@ -128,7 +128,7 @@ command_topic:
required: true
type: string
qos:
description: The maximum QoS level for subscribing and publishing to MQTT messages.
description: The maximum QoS level to be used when receiving and publishing messages.
required: false
type: integer
default: 0

33
source/_integrations/modbus.markdown
View File

@ -372,6 +372,8 @@ modbus entities are grouped below each modbus communication entry.
All modbus entities have the following parameters:
Please refer to [Parameter usage](#parameters-usage-matrix) for conflicting parameters.
{% configuration %}
address:
description: "Address of coil/register."
@ -460,6 +462,7 @@ For that reason, many devices (especially older ones) do not share the coil addr
and this `input` would read from a different address space than `coil`. The problem is present in devices with
shared address space and are a frequent cause of problems when configuring entities.
Please refer to [Parameter usage](#parameters-usage-matrix) for conflicting parameters.
{% configuration %}
binary_sensors:
@ -551,6 +554,8 @@ The master configuration like device_class are automatically copied to the slave
The Modbus climate platform allows you to monitor a thermostat or heaters as well as set a target temperature.
Please refer to [Parameter usage](#parameters-usage-matrix) for conflicting parameters.
{% configuration %}
climates:
description: "A list of all climate entities in this modbus instance."
@ -773,6 +778,8 @@ Cover that uses `input_type: coil` is not able to determine intermediary states
If your cover uses `input_type: holding` (default) to send commands, it can also read the intermediary states. To adjust which value represents what state, you can fine-tune the optional state attributes, like `state_open`. These optional state values are also used for specifying values written into the register. If you specify an optional status_register attribute, cover states will be read from status_register instead of the register used for sending commands.
Please refer to [Parameter usage](#parameters-usage-matrix) for conflicting parameters.
{% configuration %}
covers:
description: "A list of all cover entities configured for this connection."
@ -958,6 +965,7 @@ modbus:
The `modbus` fan platform allows you to control [Modbus](http://www.modbus.org/) coils or registers.
Please refer to [Parameter usage](#parameters-usage-matrix) for conflicting parameters.
{% configuration %}
fans:
@ -1064,6 +1072,8 @@ modbus:
The `modbus` light platform allows you to control [Modbus](http://www.modbus.org/) coils or registers.
Please refer to [Parameter usage](#parameters-usage-matrix) for conflicting parameters.
{% configuration %}
lights:
description: "A list of all light entities in this modbus instance."
@ -1170,6 +1180,7 @@ modbus:
The `modbus` sensor allows you to gather data from [Modbus](http://www.modbus.org/) registers.
Please refer to [Parameter usage](#parameters-usage-matrix) for conflicting parameters.
{% configuration %}
sensors:
@ -1371,6 +1382,8 @@ modbus:
The `modbus` switch platform allows you to control [Modbus](http://www.modbus.org/) coils or registers.
Please refer to [Parameter usage](#parameters-usage-matrix) for conflicting parameters.
{% configuration %}
switches:
description: "A list of all switches in this modbus instance."
@ -1502,19 +1515,19 @@ modbus:
state_off: 1
```
## Parameters usage matrix:
## Parameters usage matrix
Some parameters exclude other parameters, the following tables show what can be combined:
| Datatype: | custom | string | <type>16 | <type>32 | <type>64 |
| --------------- | ------ | ------ | -------- | -------- | -------- |
| count | Yes | Yes | No | No | No |
| structure | Yes | No | No | No | No |
| slave_count | No | No | Yes | Yes | Yes |
| swap: none | Yes | Yes | Yes | Yes | Yes |
| swap: byte | No | No | Yes | Yes | Yes |
| swap: word | No | No | No | Yes | Yes |
| swap: word_byte | No | No | No | Yes | Yes |
| Datatype: | custom | string | *16 | *32 | *64 |
| --------------- | ------ | ------ | --- | --- | --- |
| count | Yes | Yes | No | No | No |
| structure | Yes | No | No | No | No |
| slave_count | No | No | Yes | Yes | Yes |
| swap: none | Yes | Yes | Yes | Yes | Yes |
| swap: byte | No | No | Yes | Yes | Yes |
| swap: word | No | No | No | Yes | Yes |
| swap: word_byte | No | No | No | Yes | Yes |
# modbus services

2
source/_integrations/number.mqtt.markdown
View File

@ -172,7 +172,7 @@ payload_reset:
type: string
default: '"None"'
qos:
description: The maximum QoS level of the state topic. Default is 0 and will also be used to publishing messages.
description: The maximum QoS level to be used when receiving and publishing messages.
required: false
type: integer
default: 0

11
source/_integrations/opensky.markdown
View File

@ -20,9 +20,9 @@ The OpenSky integration allows one to track overhead flights in a given region.
{% configuration_basic %}
latitude:
description: The latitude of the center of the area to track.
description: The latitude of the center of the area to track. Defaulted with the home's latitude.
longitude:
description: The latitude of the center of the area to track.
description: The latitude of the center of the area to track. Defaulted with the home's longitude.
radius:
description: The radius in meters around the latitude/longitude point to track.
altitude:
@ -34,11 +34,16 @@ altitude:
- **opensky_entry**: Fired when a flight enters the region.
- **opensky_exit**: Fired when a flight exits the region.
Both events have four attributes:
Both events have two attributes in common:
- **sensor**: Name of `opensky` sensor that fired the event.
- **callsign**: Callsign of the flight.
**opensky_entry** has 4 additional attributes:
- **altitude**: Altitude of the flight in meters.
- **latitude**: Latitude of the flight in decimal.
- **longitude**: Longitude of the flight in decimal.
- **icao24**: The ICAO 24-bit address of the aircraft's transponder.
To receive notifications of the entering flights using the [Home Assistant Companion App](https://companion.home-assistant.io/), add the following lines to your `configuration.yaml` file:

2
source/_integrations/scene.mqtt.markdown
View File

@ -161,7 +161,7 @@ payload_on:
type: string
default: "ON"
qos:
description: The maximum QoS level of the state topic. Default is 0 and will also be used to publishing messages.
description: The maximum QoS level to be used when receiving and publishing messages.
required: false
type: integer
default: 0

2
source/_integrations/select.mqtt.markdown
View File

@ -162,7 +162,7 @@ options:
required: true
type: list
qos:
description: The maximum QoS level of the state topic. Default is 0 and will also be used to publishing messages.
description: The maximum QoS level to be used when receiving and publishing messages.
required: false
type: integer
default: 0

2
source/_integrations/sensor.mqtt.markdown
View File

@ -176,7 +176,7 @@ suggested_display_precision:
required: false
type: integer
qos:
description: The maximum QoS level of the state topic.
description: The maximum QoS level to be used when receiving and publishing messages.
required: false
type: integer
default: 0

2
source/_integrations/siren.mqtt.markdown
View File

@ -190,7 +190,7 @@ payload_on:
type: string
default: "ON"
qos:
description: The maximum QoS level of the state topic. Default is 0 and will also be used to publishing messages.
description: The maximum QoS level to be used when receiving and publishing messages.
required: false
type: integer
default: 0

2
source/_integrations/switch.mqtt.markdown
View File

@ -182,7 +182,7 @@ payload_on:
type: string
default: "ON"
qos:
description: The maximum QoS level of the state topic. Default is 0 and will also be used to publishing messages.
description: The maximum QoS level to be used when receiving and publishing messages.
required: false
type: integer
default: 0

2
source/_integrations/switchbot.markdown
View File

@ -53,7 +53,7 @@ Please note, device names configured in the SwitchBot app are not transferred in
- [Color Bulb (WoBulb)](https://switch-bot.com/pages/switchbot-color-bulb)
- [Bot (WoHand)](https://switch-bot.com/pages/switchbot-bot)
- [Contact Sensor (WoContact)](https://switch-bot.com/pages/switchbot-contact-sensor)
- [Curtain (WoCurtain)](https://switch-bot.com/pages/switchbot-curtain)
- [Curtain (WoCurtain)](https://switch-bot.com/pages/switchbot-curtain) (version 1 & 2)
- [Humidifier (WoHumi)](https://eu.switch-bot.com/products/switchbot-smart-humidifier)
- Light Strip (WoStrip)
- [Meter](https://switch-bot.com/pages/switchbot-meter)/[Meter Plus 70BB](https://switch-bot.com/pages/switchbot-meter-plus) (WoSensorTH)

2
source/_integrations/syncthing.markdown
View File

@ -24,7 +24,7 @@ The Syncthing integration allows you to monitor states of your synced folders fr
## Prerequisites
To set up the monitoring you need to get an **API key**. Open the Syncthing web
interface(e.g., `http://127.0.0.1:8384`) in the browser and go to **Actions** -> **Settings**. You will find
interface (e.g., `http://127.0.0.1:8384`) in the browser and go to **Actions** > **Settings**. You will find
the key on the right of the settings dialog.
{% include integrations/config_flow.md %}

2
source/_integrations/text.mqtt.markdown
View File

@ -163,7 +163,7 @@ pattern:
required: false
type: string
qos:
description: The maximum QoS level of the state topic. Default is 0 and will also be used to publishing messages.
description: The maximum QoS level to be used when receiving and publishing messages.
required: false
type: integer
default: 0

2
source/_integrations/update.mqtt.markdown
View File

@ -166,7 +166,7 @@ payload_install:
required: false
type: string
qos:
description: The maximum QoS level of the state topic. Default is 0 and will also be used to publishing messages.
description: The maximum QoS level to be used when receiving and publishing messages.
required: false
type: integer
default: 0

2
source/_integrations/vacuum.mqtt.markdown
View File

@ -167,7 +167,7 @@ payload_stop:
type: string
default: stop
qos:
description: The maximum QoS level of the state topic.
description: The maximum QoS level to be used when receiving and publishing messages.
required: false
type: integer
default: 0