|
@@ -20,7 +20,7 @@ The name should also indicate to the user what type of device it is.
|
|
|
|
|
|
|
|
### `legacy_type`
|
|
### `legacy_type`
|
|
|
|
|
|
|
|
-// Optional, deprecated. //
|
|
|
|
|
|
|
+*Optional, deprecated.*
|
|
|
|
|
|
|
|
The `legacy_type` is a transitional link back to an old name the device
|
|
The `legacy_type` is a transitional link back to an old name the device
|
|
|
was known by. It is used in the migration process to migrate old
|
|
was known by. It is used in the migration process to migrate old
|
|
@@ -29,7 +29,7 @@ for the device. New devices should not define this.
|
|
|
|
|
|
|
|
### `products`
|
|
### `products`
|
|
|
|
|
|
|
|
-// Optional, for future use. //
|
|
|
|
|
|
|
+*Optional, for future use.*
|
|
|
|
|
|
|
|
A list of products that this config applies to. Each product in the list must
|
|
A list of products that this config applies to. Each product in the list must
|
|
|
have an `id` specified, which corresponds to the productId or productKey
|
|
have an `id` specified, which corresponds to the productId or productKey
|
|
@@ -53,7 +53,7 @@ The configuration for entities is detailed in its own section below.
|
|
|
|
|
|
|
|
### `secondary_entities`
|
|
### `secondary_entities`
|
|
|
|
|
|
|
|
-//Optional.//
|
|
|
|
|
|
|
+*Optional.*
|
|
|
|
|
|
|
|
This contains a list of additional Home Assistant entities
|
|
This contains a list of additional Home Assistant entities
|
|
|
providing additional functionality beyond the capabilities of the primary
|
|
providing additional functionality beyond the capabilities of the primary
|
|
@@ -77,7 +77,7 @@ secondary entities, so only basic functionality is implemented.
|
|
|
|
|
|
|
|
### `deprecated`
|
|
### `deprecated`
|
|
|
|
|
|
|
|
-//Optional//
|
|
|
|
|
|
|
+*Optional*
|
|
|
|
|
|
|
|
This is used to mark an entity as deprecated. This is mainly
|
|
This is used to mark an entity as deprecated. This is mainly
|
|
|
for older devices that were implemented when only climate devices were
|
|
for older devices that were implemented when only climate devices were
|
|
@@ -88,7 +88,7 @@ The value of this should indicated what to use instead.
|
|
|
|
|
|
|
|
### `class`
|
|
### `class`
|
|
|
|
|
|
|
|
-//Optional.//
|
|
|
|
|
|
|
+*Optional.*
|
|
|
|
|
|
|
|
For some entity types, a device `class` can be set, for example `switch`
|
|
For some entity types, a device `class` can be set, for example `switch`
|
|
|
entities can have a class of `outlet`. This may slightly alter the UI
|
|
entities can have a class of `outlet`. This may slightly alter the UI
|
|
@@ -98,7 +98,7 @@ also the state that off and on values translate to in the UI.
|
|
|
|
|
|
|
|
### `category`
|
|
### `category`
|
|
|
|
|
|
|
|
-//Optional.//
|
|
|
|
|
|
|
+*Optional.*
|
|
|
|
|
|
|
|
This specifies the `entity category` of the entity. Entities can be categorized
|
|
This specifies the `entity category` of the entity. Entities can be categorized
|
|
|
as `config` or `diagnostic` to restrict where they appear automatically in
|
|
as `config` or `diagnostic` to restrict where they appear automatically in
|
|
@@ -114,7 +114,7 @@ The configuration of DPS entries is detailed in its own section below.
|
|
|
|
|
|
|
|
### `name`
|
|
### `name`
|
|
|
|
|
|
|
|
-//Optional.//
|
|
|
|
|
|
|
+*Optional.*
|
|
|
|
|
|
|
|
The name associated with this entity can be set here. If no name is set,
|
|
The name associated with this entity can be set here. If no name is set,
|
|
|
it will inherit the name at the top level. This is mostly useful for
|
|
it will inherit the name at the top level. This is mostly useful for
|
|
@@ -124,7 +124,7 @@ name may not be sufficient to describe the function.
|
|
|
|
|
|
|
|
### `mode`
|
|
### `mode`
|
|
|
|
|
|
|
|
-//Optional. For number entities, default="auto", for others, None
|
|
|
|
|
|
|
+*Optional. For number entities, default="auto", for others, None*
|
|
|
|
|
|
|
|
For number entities, this can be used to force `slider` or `box` as the
|
|
For number entities, this can be used to force `slider` or `box` as the
|
|
|
input method. The default `auto` uses a slider if the range is small enough,
|
|
input method. The default `auto` uses a slider if the range is small enough,
|
|
@@ -160,7 +160,7 @@ to use a secondary entity for that.
|
|
|
|
|
|
|
|
### `readonly`
|
|
### `readonly`
|
|
|
|
|
|
|
|
-//Optional.//
|
|
|
|
|
|
|
+*Optional.*
|
|
|
|
|
|
|
|
A boolean setting to mark attributes as readonly. If not specified, the
|
|
A boolean setting to mark attributes as readonly. If not specified, the
|
|
|
default is `false`. If set to `true`, the attributes will be reported
|
|
default is `false`. If set to `true`, the attributes will be reported
|
|
@@ -168,7 +168,7 @@ to Home Assistant, but no functionality for setting them will be exposed.
|
|
|
|
|
|
|
|
### `mapping`
|
|
### `mapping`
|
|
|
|
|
|
|
|
-//Optional.//
|
|
|
|
|
|
|
+*Optional.*
|
|
|
This can be used to define a list of additional rules that modify the DPS
|
|
This can be used to define a list of additional rules that modify the DPS
|
|
|
to Home Assistant attribute mapping to something other than a one to one
|
|
to Home Assistant attribute mapping to something other than a one to one
|
|
|
copy.
|
|
copy.
|
|
@@ -180,7 +180,7 @@ defined in their own section below.
|
|
|
|
|
|
|
|
### `hidden`
|
|
### `hidden`
|
|
|
|
|
|
|
|
-//Optional.//
|
|
|
|
|
|
|
+*Optional.*
|
|
|
This can be used to define DPS that do not directly expose Home Assistant
|
|
This can be used to define DPS that do not directly expose Home Assistant
|
|
|
attributes. When set to **true**, no attribute will be sent. A `name` should
|
|
attributes. When set to **true**, no attribute will be sent. A `name` should
|
|
|
still be specified and the attribute can be referenced as a `constraint`
|
|
still be specified and the attribute can be referenced as a `constraint`
|
|
@@ -196,7 +196,7 @@ is set to Eco.
|
|
|
|
|
|
|
|
### `range`
|
|
### `range`
|
|
|
|
|
|
|
|
-//Optional.//
|
|
|
|
|
|
|
+*Optional.*
|
|
|
|
|
|
|
|
For integer attributes that are not readonly, a range can be set with `min`
|
|
For integer attributes that are not readonly, a range can be set with `min`
|
|
|
and `max` values that will limit the values that the user can enter in the
|
|
and `max` values that will limit the values that the user can enter in the
|
|
@@ -204,7 +204,7 @@ Home Assistant UI. This can also be set in a `mapping` or `conditions` block.
|
|
|
|
|
|
|
|
### `unit`
|
|
### `unit`
|
|
|
|
|
|
|
|
-//Optional. default="C" for temperature dps on climate devices, None for sensors.//
|
|
|
|
|
|
|
+*Optional. default="C" for temperature dps on climate devices, None for sensors.*
|
|
|
|
|
|
|
|
For temperature dps, some devices will use Fahrenhiet. This needs to be
|
|
For temperature dps, some devices will use Fahrenhiet. This needs to be
|
|
|
indicated back to HomeAssistant by defining `unit` as "F". For sensor
|
|
indicated back to HomeAssistant by defining `unit` as "F". For sensor
|
|
@@ -214,7 +214,7 @@ equivalents, other units are currently ASCII so can be easily entered directly).
|
|
|
|
|
|
|
|
### `class`
|
|
### `class`
|
|
|
|
|
|
|
|
-//Optional. default=None.//
|
|
|
|
|
|
|
+*Optional. default=None.*
|
|
|
|
|
|
|
|
For sensors, this sets the state class of the sensor (measurement, total
|
|
For sensors, this sets the state class of the sensor (measurement, total
|
|
|
or total_increasing)
|
|
or total_increasing)
|
|
@@ -231,8 +231,9 @@ elements.
|
|
|
|
|
|
|
|
### `dps_val`
|
|
### `dps_val`
|
|
|
|
|
|
|
|
-//Optional, if not provided, the rule is a default that will apply to all
|
|
|
|
|
-values not covered by their own dps_val rule.//
|
|
|
|
|
|
|
+*Optional, if not provided, the rule is a default that will apply to all
|
|
|
|
|
+values not covered by their own dps_val rule.*
|
|
|
|
|
+
|
|
|
`dps_val` defines the DPS value that each
|
|
`dps_val` defines the DPS value that each
|
|
|
rule in the list applies to. This can be used to map specific values from the
|
|
rule in the list applies to. This can be used to map specific values from the
|
|
|
Tuya protocol into attribute values that have specific meaning in Home
|
|
Tuya protocol into attribute values that have specific meaning in Home
|
|
@@ -245,7 +246,8 @@ instead of "mdi:radiator" when in that mode.
|
|
|
|
|
|
|
|
### `value`
|
|
### `value`
|
|
|
|
|
|
|
|
-//Optional.//
|
|
|
|
|
|
|
+*Optional.*
|
|
|
|
|
+
|
|
|
This can be used to set the attribute value seen by Home Assistant to something
|
|
This can be used to set the attribute value seen by Home Assistant to something
|
|
|
different than the DPS value from the Tuya protocol. Normally it will be used
|
|
different than the DPS value from the Tuya protocol. Normally it will be used
|
|
|
with `dps_val` to map from one value to another. It could also be used at top
|
|
with `dps_val` to map from one value to another. It could also be used at top
|
|
@@ -253,7 +255,7 @@ level to override all values, but I can't imagine a useful purpose for that.
|
|
|
|
|
|
|
|
### `scale`
|
|
### `scale`
|
|
|
|
|
|
|
|
-//Optional, default=1//
|
|
|
|
|
|
|
+*Optional, default=1*
|
|
|
|
|
|
|
|
This can be used in an `integer` dps mapping to scale the values. For example
|
|
This can be used in an `integer` dps mapping to scale the values. For example
|
|
|
some climate devices represent the temperature as an integer in tenths of
|
|
some climate devices represent the temperature as an integer in tenths of
|
|
@@ -264,7 +266,7 @@ of 0.03.
|
|
|
|
|
|
|
|
### `step`
|
|
### `step`
|
|
|
|
|
|
|
|
-//Optional, default=1//
|
|
|
|
|
|
|
+*Optional, default=1*
|
|
|
|
|
|
|
|
This can be used in an `integer` dps mapping to make values jump by a specific
|
|
This can be used in an `integer` dps mapping to make values jump by a specific
|
|
|
step. It can also be set in a conditions block so that the steps change only
|
|
step. It can also be set in a conditions block so that the steps change only
|
|
@@ -273,14 +275,16 @@ only allows settings that are divisible by 10, so a step of 10 would be set.
|
|
|
|
|
|
|
|
### `icon`
|
|
### `icon`
|
|
|
|
|
|
|
|
-//Optional.//
|
|
|
|
|
|
|
+*Optional.*
|
|
|
|
|
+
|
|
|
This can be used to override the icon. Most useful with a `dps_val` which
|
|
This can be used to override the icon. Most useful with a `dps_val` which
|
|
|
indicates a change from normal operating mode, such as "fan-only",
|
|
indicates a change from normal operating mode, such as "fan-only",
|
|
|
"defrosting", "tank-full" or some error state.
|
|
"defrosting", "tank-full" or some error state.
|
|
|
|
|
|
|
|
### `icon_priority`
|
|
### `icon_priority`
|
|
|
|
|
|
|
|
-//Optional. Default 10. Lower numbers mean higher priorities.//
|
|
|
|
|
|
|
+*Optional. Default 10. Lower numbers mean higher priorities.*
|
|
|
|
|
+
|
|
|
When a number of rules on different attributes define `icon` changes, you
|
|
When a number of rules on different attributes define `icon` changes, you
|
|
|
may need to control which have priority over the others. For example,
|
|
may need to control which have priority over the others. For example,
|
|
|
if the device is off, probably it is more important to indicate that than
|
|
if the device is off, probably it is more important to indicate that than
|
|
@@ -294,7 +298,8 @@ icon will be displayed.
|
|
|
|
|
|
|
|
### `value_redirect`
|
|
### `value_redirect`
|
|
|
|
|
|
|
|
-//Optional.//
|
|
|
|
|
|
|
+*Optional.*
|
|
|
|
|
+
|
|
|
When `value_redirect` is set, the value of the attribute and any attempt to
|
|
When `value_redirect` is set, the value of the attribute and any attempt to
|
|
|
set it will be redirected to the named attribute instead of the current one.
|
|
set it will be redirected to the named attribute instead of the current one.
|
|
|
|
|
|
|
@@ -307,7 +312,8 @@ Home Assistant.
|
|
|
|
|
|
|
|
### `value_mirror`
|
|
### `value_mirror`
|
|
|
|
|
|
|
|
-//Optional.//
|
|
|
|
|
|
|
+*Optional.*
|
|
|
|
|
+
|
|
|
When `value_mirror` is set, the value of the attribute will be redirected to
|
|
When `value_mirror` is set, the value of the attribute will be redirected to
|
|
|
the current value of the named attribute. Unlike `value_redirect`, this does
|
|
the current value of the named attribute. Unlike `value_redirect`, this does
|
|
|
not redirect attempts to set the dps to the redirected dps, but when used in
|
|
not redirect attempts to set the dps to the redirected dps, but when used in
|
|
@@ -320,7 +326,8 @@ have a mapping that mirrors the value of the configuration dps.
|
|
|
|
|
|
|
|
### `invalid`
|
|
### `invalid`
|
|
|
|
|
|
|
|
-//Optional. Boolean, default false.//
|
|
|
|
|
|
|
+*Optional. Boolean, default false.*
|
|
|
|
|
+
|
|
|
Invalid set to true allows an attribute to temporarily be set read-only in
|
|
Invalid set to true allows an attribute to temporarily be set read-only in
|
|
|
some conditions. Rather than passing requests to set the attribute through
|
|
some conditions. Rather than passing requests to set the attribute through
|
|
|
to the Tuya protocol, attempts to set it will throw an error while it meets
|
|
to the Tuya protocol, attempts to set it will throw an error while it meets
|
|
@@ -333,13 +340,15 @@ control when the preset is in sleep mode (since sleep mode should force low).
|
|
|
|
|
|
|
|
### `constraint`
|
|
### `constraint`
|
|
|
|
|
|
|
|
-//Optional. Always paired with `conditions`.//
|
|
|
|
|
|
|
+*Optional. Always paired with `conditions`.*
|
|
|
|
|
+
|
|
|
If a rule depends on an attribute other than the current one, then `constraint`
|
|
If a rule depends on an attribute other than the current one, then `constraint`
|
|
|
can be used to specify the element that `conditions` applies to.
|
|
can be used to specify the element that `conditions` applies to.
|
|
|
|
|
|
|
|
### `conditions`
|
|
### `conditions`
|
|
|
|
|
|
|
|
-//Optional. Always paired with `constraint.`//
|
|
|
|
|
|
|
+*Optional. Always paired with `constraint.`*
|
|
|
|
|
+
|
|
|
Conditions defines a list of rules that are applied based on the `constraint`
|
|
Conditions defines a list of rules that are applied based on the `constraint`
|
|
|
attribute. The contents are the same as Mapping Rules, but `dps_val` applies
|
|
attribute. The contents are the same as Mapping Rules, but `dps_val` applies
|
|
|
to the attribute specified by `constraint`. All others act on the current
|
|
to the attribute specified by `constraint`. All others act on the current
|