Tuya config options (#15388)

Co-authored-by: Franck Nijhof <frenck@frenck.nl>
This commit is contained in:
ollo69 2020-11-08 21:22:10 +01:00 committed by GitHub
parent 398c1b9734
commit 36a6ba0eca
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -17,7 +17,9 @@ ha_codeowners:
- '@ollo69'
---
The `tuya` integration is the main integration to integrate all [Tuya Smart](https://www.tuya.com) related platforms, except the Zigbee hub. You will need your Tuya account information (username, password and account country code) to discover and control devices which related to your account.
The `tuya` integration is the main integration to integrate [Tuya Smart](https://www.tuya.com) related platforms, except the Zigbee hub. You will need your Tuya account information (username, password and account country code) to discover and control devices which related to your account.
**Important**: Not all Tuya devices are supported by the `tuya API` used by this integration. For more details refer to [TuyaHA Library](https://github.com/PaulAnnekov/tuyaha).
There is currently support for the following device types within Home Assistant:
@ -69,6 +71,53 @@ platform:
default: tuya
{% endconfiguration %}
## Integration Options
It is possible to change various behaviors through the integration options, some common for integration and others specific to each `light` and `climate` devices. These can be changed at **Tuya** -> **Options** on the Integrations page.
### Common Options
- **Discovery device polling interval** (default=605): define the interval between 2 consecutive calls to the `API discovery method`, which is used to get the status for all registered devices with a single call. If you set interval value too low, Tuya API will return errors, so it is suggested to use the default value until
you know that it is possible to use lower values.
- **Query device polling interval** (default=120): this option is available only if you have devices that can use the `API query method`.
It defines the interval between 2 consecutive calls to the `API query method`, that is used to get the status for a specific device.
This method is always used when it is available only one device that can use it. If you set interval value too low, Tuya API will return errors
so it is suggested to use the default value until you know that is possible to use lower values.
- **Device that will use the query method**: this option is available only if you have devices that can use the `API query method`.
Because it is not possible to make multiple calls to the `API query method`. If you have more than one device that can use it you can choose which one will use. This will give a better status refresh for this specific device.
- **Device to configure (multi-select list)**: this option is available only if you have a `light` or `climate` device. Selecting a device to
configure to options page related to the device will be opened. You can also select more than one devices to configure them simultaneously,
but all selected devices must be of the same type.
### Light Options
- **Force color support**: when checked force `color support` for devices that do not report this feature.
- **Brightness range**: change the `brightness range` used for the device. Possible options are:
- range 1-255 (default)
- range 10-1000
- **Min color temperature**: set minimum `color temperature` expressed in `kelvin` accepted by the light.
- **Max color temperature**: set maximum `color temperature` expressed in `kelvin` accepted by the light.
- **Max color temperature reported**: set the maximum `color temperature` value reported by the light.
### Climate Options
- **Temperature unit**: change the `temperature unit` used internally by the devices.
- **Temperature values divider**: `all temperatures` reported by device will be divided by this value.
- **Current Temperature value divider**: `current temperature` reported by device will be divided by this value.
- **Min target temperature**: set the minimum allowed `target temperature` for the entity.
- **Max target temperature**: set the maximum allowed `target temperature` for the entity.
## Service
These services are available for the `tuya` component: