mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-16 05:46:52 +00:00
Merge branch 'current' into rc
This commit is contained in:
Franck Nijhof
commit
5d821cfa9e
@ -49,8 +49,8 @@ app_key:
|
||||
## Local API Option
|
||||
|
||||
This integration communicates with Ambient Weather PWS units via the Ambient Weather
|
||||
Cloud. Users wishing to explore a local option are encouraged to explore the
|
||||
[Ecowitt GW1000](https://www.ecowitt.com/shop/goodsDetail/16), a small device that is
|
||||
able to read RF signals directly from the PWS and transmit them to a variety of
|
||||
other applications, including [`ecowitt2mqtt`](https://github.com/bachya/ecowitt2mqtt)
|
||||
(which supports [MQTT Discovery](/docs/mqtt/discovery)).
|
||||
Cloud. Users desiring a local option are encouraged to explore the
|
||||
[Ecowitt](https://www.ecowitt.com) family of devices, which are able to read RF signals
|
||||
directly from the PWS and transmit them to a variety of other applications, including
|
||||
[`ecowitt2mqtt`](https://github.com/bachya/ecowitt2mqtt) (which supports
|
||||
[MQTT Discovery](/docs/mqtt/discovery)).
|
||||
|
||||
@ -30,7 +30,7 @@ The `ecobee` integration lets you control and view sensor data from [ecobee](htt
|
||||
|
||||
You will need to obtain an API key from ecobee's [developer site](https://www.ecobee.com/developers/) to use this integration. To get the key, your thermostat must be registered on ecobee's website (which you likely would have already done while installing your thermostat). Once you have done that, perform the following steps.
|
||||
|
||||
1. Click on the **Become a developer** link on the [developer site](https://www.ecobee.com/developers/).
|
||||
1. Click on the **Become a developer** link on the [developer site](https://www.ecobee.com/home/developer/loginDeveloper.jsp).
|
||||
2. Log in with your ecobee credentials. (Make sure multifactor authentication is disabled to allow login can re-enable after becoming developer.)
|
||||
3. Accept the SDK agreement.
|
||||
4. Fill in the fields.
|
||||
|
||||
@ -23,7 +23,7 @@ ha_platforms:
|
||||
|
||||
The [EnOcean](https://en.wikipedia.org/wiki/EnOcean) standard is supported by many different vendors. There are switches and sensors of many different kinds, and typically they employ energy harvesting to get power such that no batteries are necessary.
|
||||
|
||||
The EnOcean integration adds support for some of these devices. You will need a controller like the [USB300](https://www.enocean.com/en/enocean_modules/usb-300-oem/) in order for it to work.
|
||||
The EnOcean integration adds support for some of these devices. You will need a controller like the [USB300](https://www.enocean.com/en/enocean_modules/usb-300/) in order for it to work.
|
||||
|
||||
There is currently support for the following device types within Home Assistant:
|
||||
|
||||
|
||||
@ -243,7 +243,7 @@ input_number:
|
||||
icon: mdi:clock-start
|
||||
initial: 30
|
||||
min: 0
|
||||
max: 60
|
||||
max: 59
|
||||
step: 10
|
||||
|
||||
automation:
|
||||
|
||||
@ -72,7 +72,7 @@ In the options menu, select *Enable automatic add* to enable automatic addition
|
||||
|
||||
#### Covers
|
||||
|
||||
The RFXtrx integration supports Siemens/LightwaveRF and RFY roller shutters that communicate in the frequency range of 433.92 MHz.
|
||||
The RFXtrx integration supports Siemens/LightwaveRF and Somfy RTS roller shutters that communicate in the frequency range of 433.92 MHz.
|
||||
|
||||
#### Lights
|
||||
|
||||
@ -100,9 +100,9 @@ To manually add a device, in the options window, an event code can be added in t
|
||||
|
||||
See [Generate codes](#generate-codes) how to generate event codes.
|
||||
|
||||
#### RFY
|
||||
#### Somfy RTS
|
||||
|
||||
The [RFXtrx433e](http://www.rfxcom.com/RFXtrx433E-USB-43392MHz-Transceiver/en) is required for RFY support, however, it does not support receive for the RFY protocol - as such devices cannot be automatically added. Instead, configure the device in the [rfxmngr](http://www.rfxcom.com/downloads.htm) tool. Make a note of the assigned ID and Unit Code and then add a device to the configuration with the following id `071a0000[id][unit_code]`. E.g., if the id was `0a` `00` `01`, and the unit code was `01` then the fully qualified id would be `071a00000a000101`, if you set your id/code to single digit in the rfxmngr, e.g., id: `1` `02` `04` and unit code: `1` you will need to add `0` before, so `102031` becomes `071a000001020301`.
|
||||
The [RFXtrx433e](http://www.rfxcom.com/RFXtrx433E-USB-43392MHz-Transceiver/en) or later versions like [RFXtrx433XL](http://www.rfxcom.com/epages/78165469.sf/en_GB/?ObjectPath=/Shops/78165469/Products/18103) is required for support, however, it does not support receive for the Somfy RTS protocol - as such devices cannot be automatically added. Instead, configure the device in the [rfxmngr](http://www.rfxcom.com/downloads.htm) tool. Make a note of the assigned ID and Unit Code and then add a device to the configuration with the following id `071a0000[id][unit_code]`. E.g., if the id was `0a` `00` `01`, and the unit code was `01` then the fully qualified id would be `071a00000a000101`, if you set your id/code to single digit in the rfxmngr, e.g., id: `1` `02` `04` and unit code: `1` you will need to add `0` before, so `102031` becomes `071a000001020301`.
|
||||
|
||||
#### Convert switch event to dimming event
|
||||
|
||||
@ -138,9 +138,9 @@ If a device is missing from the list, close the options window and either make s
|
||||
|
||||
Because the RFXtrx device sends its actions via radio and from most receivers it's impossible to know if the signal was received or not. Therefore you can configure the RFXtrx device to try to send each signal repeatedly.
|
||||
|
||||
#### Device events
|
||||
|
||||
To enable device events, use the checkbox *Enable device event*. See [Events](#events) for more information about device events.
|
||||
<div class='note warning'>
|
||||
The RFXtrx hardware generally handle signal repeats itself, and some protocols are timing sensitive when it comes to signal repeats so in general this should be avoided.
|
||||
</div>
|
||||
|
||||
#### Off Delay
|
||||
|
||||
@ -153,7 +153,7 @@ For those devices, use the *off_delay* parameter. It defines a delay after, whic
|
||||
|
||||
#### Venetian blind mode
|
||||
|
||||
Available only for RFY cover devices. Enables tilt control of venetian blind slats.
|
||||
Available only for Somfy RTS cover devices. Enables tilt control of venetian blind slats.
|
||||
|
||||
Venetian blind motors that control slats tilt can be configured in one of two modes - US (short press of up/down buttons opens/closes the blind, long-press controls tilt angle), or European (short press of up/down buttons controls tilt angle, long-press opens/closes the blind). You can select one of the following settings depending on your blinds:
|
||||
|
||||
@ -353,76 +353,3 @@ If you need to generate codes for switches and lights, you can use a template (u
|
||||
- Launch your Home Assistant and go to the website.
|
||||
- Enable learning mode on your switch (i.e., push learn button or plug it in a wall socket)
|
||||
- Toggle your new switch in the Home Assistant interface
|
||||
|
||||
## Configuration import
|
||||
|
||||
When RFXtrx integration is configured in `configuration.yaml`, the configuration will be imported once. After import, the configuration can be removed from `configuration.yaml`.
|
||||
|
||||
{% configuration %}
|
||||
device:
|
||||
description: "The path to your device, e.g., `/dev/serial/by-id/usb-RFXCOM_RFXtrx433_A1Y0NJGR-if00-port0` or `/dev/ttyUSB0`. Required if you are using a locally connected USB device."
|
||||
required: false
|
||||
type: string
|
||||
host:
|
||||
description: "The hostname the remote RFXtrx is available on if connecting via TCP. If this is set, a port is required."
|
||||
required: false
|
||||
type: string
|
||||
port:
|
||||
description: "The TCP port the remote RFXtrx is available on. If this is set, a host is required."
|
||||
required: false
|
||||
type: integer
|
||||
debug:
|
||||
description: "If you want to receive debug output."
|
||||
required: false
|
||||
default: false
|
||||
type: boolean
|
||||
devices:
|
||||
description: A list of devices.
|
||||
required: false
|
||||
type: map
|
||||
keys:
|
||||
EVENT_CODE:
|
||||
description: An code string describing the device. It may include state, but state will be ignored.
|
||||
required: true
|
||||
type: map
|
||||
keys:
|
||||
device_class:
|
||||
description: Sets the [class of the device](/integrations/binary_sensor/), changing the device state and icon that is displayed on the frontend.
|
||||
required: false
|
||||
type: device_class
|
||||
fire_event:
|
||||
description: Fires an event even if the state is the same as before. Can be used for automations.
|
||||
required: false
|
||||
type: boolean
|
||||
default: false
|
||||
off_delay:
|
||||
description: For binary sensors that only sends 'On' state updates, this variable sets a delay after which the binary sensor state will be updated back to 'Off'.
|
||||
required: false
|
||||
type: integer
|
||||
data_bits:
|
||||
description: Defines how many bits are used for commands inside the data packets sent by the device.
|
||||
required: false
|
||||
type: integer
|
||||
command_on:
|
||||
description: Defines the data bits value that is sent by the device upon an 'On' command.
|
||||
required: false
|
||||
type: string
|
||||
command_off:
|
||||
description: Defines the data bits value that is sent by the device upon an 'Off' command.
|
||||
required: false
|
||||
type: string
|
||||
signal_repetitions:
|
||||
description: Because the RFXtrx device sends its actions via radio and from most receivers it's impossible to know if the signal was received or not. Therefore you can configure the RFXtrx device to try to send each signal repeatedly.
|
||||
required: false
|
||||
type: integer
|
||||
automatic_add:
|
||||
description: To enable the automatic addition of new binary sensors.
|
||||
required: false
|
||||
type: boolean
|
||||
default: false
|
||||
{% endconfiguration %}
|
||||
|
||||
<div class='note warning'>
|
||||
If a device ID consists of only numbers, please make sure to surround it with quotes.
|
||||
This is a known limitation in YAML, because the device ID will be interpreted as a number otherwise.
|
||||
</div>
|
||||
|
||||
@ -50,7 +50,7 @@ There are four options that can be configured for the SwitchBot entities. Settin
|
||||
- `Time between updates (seconds)`: Increase/Decrease the update interval for the device. (Could impact battery life)
|
||||
- `Retry count`: How many times to retry sending commands and retry polling your SwitchBot devices.
|
||||
- `Timeout between retries`: How long to wait before retries.
|
||||
- `How long to scan for advertisement data`: Bluetooth LE uses advertisement data for device statuses and/or attributes. This setting spesifies how long the scan should run.
|
||||
- `How long to scan for advertisement data`: Bluetooth LE uses advertisement data for device statuses and/or attributes. This setting specifies how long the scan should run.
|
||||
|
||||
### Error codes and troubleshooting
|
||||
|
||||
|
||||
@ -112,12 +112,12 @@ sensor:
|
||||
required: true
|
||||
type: template
|
||||
unit_of_measurement:
|
||||
description: "Defines the units of measurement of the sensor, if any. This will also influence the graphical presentation in the history visualization as a continuous value. Sensors with missing `unit_of_measurement` are showing as discrete values."
|
||||
description: "Defines the units of measurement of the sensor, if any. This will also display the value based on the user profile Number Format setting and influence the graphical presentation in the history visualization as a continuous value."
|
||||
required: false
|
||||
type: string
|
||||
default: None
|
||||
state_class:
|
||||
description: The [state_class](https://developers.home-assistant.io/docs/core/entity/sensor#available-state-classes) of the sensor.
|
||||
description: "The [state_class](https://developers.home-assistant.io/docs/core/entity/sensor#available-state-classes) of the sensor. This will also display the value based on the user profile Number Format setting and influence the graphical presentation in the history visualization as a continuous value."
|
||||
required: false
|
||||
type: string
|
||||
default: None
|
||||
@ -673,7 +673,7 @@ sensor:
|
||||
required: false
|
||||
type: string
|
||||
unit_of_measurement:
|
||||
description: "Defines the units of measurement of the sensor, if any. This will also influence the graphical presentation in the history visualization as a continuous value. Sensors with missing `unit_of_measurement` are showing as discrete values."
|
||||
description: "Defines the units of measurement of the sensor, if any. This will also display the value based on the user profile Number Format setting and influence the graphical presentation in the history visualization as a continuous value."
|
||||
required: false
|
||||
type: string
|
||||
default: None
|
||||
|
||||
@ -51,9 +51,15 @@ The Xiaomi Miio integration supports the following devices:
|
||||
|
||||
Most Xiaomi Miio devices support configuration using the Home Assistant UI,
|
||||
except for the [Xiaomi device tracker](#xiaomi-device-tracker-xiaomi-mi-wifi-repeater-2)
|
||||
and [Xiaomi IR Remote](#xiaomi-ir-remote).
|
||||
and [Xiaomi IR Remote](#xiaomi-ir-remote). Please read the linked sections for those devices for more information.
|
||||
|
||||
Please read the linked sections for those devices for more information.
|
||||
Devices need to be set up using the Mi Home app and not vendor-specific apps (e.g. Roborock).
|
||||
|
||||
<div class='note'>
|
||||
|
||||
For more complex network setups (e.g. VLANs), reference the [following documentation](https://python-miio.readthedocs.io/en/latest/troubleshooting.html#discover-devices-across-subnets) for additional information.
|
||||
|
||||
</div>
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
|
||||
@ -9,7 +9,7 @@ og_image: /images/state-of-the-open-home/social.png
|
||||
|
||||
|
||||
Where: YouTube<br>
|
||||
When: Saturday, December 11, at 11am PST / 8pm CET
|
||||
When: Saturday, December 11, at 11am PST / 8pm CET ([in other timezones](https://www.timeanddate.com/worldclock/fixedtime.html?msg=State+of+the+Open+Home&iso=20211211T19))
|
||||
|
||||
For over 8 years we've been working on the open home. We envision the open home as one where you are in control of the technology, your data and who can access it. At the State of the Open Home 2021 we will present on the progress we made this year in making the open home a viable choice for everyone.
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user