Skip to content

Commit 7ae9d11

Browse files
committed
Update README
1 parent 92293b8 commit 7ae9d11

File tree

1 file changed

+11
-7
lines changed

1 file changed

+11
-7
lines changed

README.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -97,9 +97,11 @@ Indicates the timeout, in seconds, to permit new Zigbee devices to join, once en
9797

9898
### `device_config`
9999

100+
# TODO document wildcards
101+
100102
Allows specifying static configuration for particular Zigbee devices. Each entry in the dictionary is the (friendly)
101-
name of a device associated to a configuration dictionary. See [Device Configuration](#device-configuration) for details
102-
on the available configuration options.
103+
name of a device associated to a configuration dictionary or a wildcard pattern that friendly names of devices must
104+
match. See [Device Configuration](#device-configuration) for details on the available configuration options.
103105

104106
* type: `dictionary`
105107
* default: `{}`
@@ -122,11 +124,12 @@ for details.
122124

123125
### `force_port_properties`
124126

125-
By default, exposed capabilities with category set to `config` or `diagnostic` will be treated as an attribute of the
126-
corresponding qToggle control port. This option allows specifying a list of property names that will be associated to
127-
dedicated qToggle ports, regardless of their category (see
127+
By default, exposed capabilities with category set to `config` or `diagnostic`, along with exposed options, will be
128+
treated as attributes of the corresponding qToggle control port. This option allows specifying a list of property names
129+
that will be associated to dedicated qToggle ports, regardless of their category (see
128130
[zigbee2mqtt exposes](https://www.zigbee2mqtt.io/guide/usage/exposes.html#exposes) for details). Capability (property)
129-
names are dot separated when they are part of a composite type (e.g. `color.hue`).
131+
names are dot separated when they are part of a composite type (e.g. `color.hue`). Wildcards are also supported (e.g.
132+
`color.*` will match all the properties inside the `color` composite type).
130133

131134
* type: `[string]`
132135
* default: `[]`
@@ -137,7 +140,8 @@ By default, exposed capabilities with no category set will be treated as standal
137140
specifying a list of property names that will become attributes of the corresponding control port, regardless of their
138141
category (see
139142
[zigbee2mqtt exposes](https://www.zigbee2mqtt.io/guide/usage/exposes.html#exposes) for details). Capability (property)
140-
names are dot separated when they are part of a composite type (e.g. `color.hue`).
143+
names are dot separated when they are part of a composite type (e.g. `color.hue`). Wildcards are also supported (e.g.
144+
`color.*` will match all the properties inside the `color` composite type).
141145

142146
* type: `[string]`
143147
* default: `[]`

0 commit comments

Comments
 (0)