matterbridge 3.2.9-dev-20250926-85736bb → 3.2.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (284) hide show
  1. package/CHANGELOG.md +2 -2
  2. package/dist/cli.d.ts +26 -0
  3. package/dist/cli.d.ts.map +1 -0
  4. package/dist/cli.js +91 -2
  5. package/dist/cli.js.map +1 -0
  6. package/dist/cliEmitter.d.ts +34 -0
  7. package/dist/cliEmitter.d.ts.map +1 -0
  8. package/dist/cliEmitter.js +30 -0
  9. package/dist/cliEmitter.js.map +1 -0
  10. package/dist/clusters/export.d.ts +2 -0
  11. package/dist/clusters/export.d.ts.map +1 -0
  12. package/dist/clusters/export.js +2 -0
  13. package/dist/clusters/export.js.map +1 -0
  14. package/dist/defaultConfigSchema.d.ts +28 -0
  15. package/dist/defaultConfigSchema.d.ts.map +1 -0
  16. package/dist/defaultConfigSchema.js +24 -0
  17. package/dist/defaultConfigSchema.js.map +1 -0
  18. package/dist/deviceManager.d.ts +112 -0
  19. package/dist/deviceManager.d.ts.map +1 -0
  20. package/dist/deviceManager.js +94 -1
  21. package/dist/deviceManager.js.map +1 -0
  22. package/dist/devices/airConditioner.d.ts +98 -0
  23. package/dist/devices/airConditioner.d.ts.map +1 -0
  24. package/dist/devices/airConditioner.js +57 -0
  25. package/dist/devices/airConditioner.js.map +1 -0
  26. package/dist/devices/batteryStorage.d.ts +48 -0
  27. package/dist/devices/batteryStorage.d.ts.map +1 -0
  28. package/dist/devices/batteryStorage.js +48 -1
  29. package/dist/devices/batteryStorage.js.map +1 -0
  30. package/dist/devices/cooktop.d.ts +60 -0
  31. package/dist/devices/cooktop.d.ts.map +1 -0
  32. package/dist/devices/cooktop.js +55 -0
  33. package/dist/devices/cooktop.js.map +1 -0
  34. package/dist/devices/dishwasher.d.ts +71 -0
  35. package/dist/devices/dishwasher.d.ts.map +1 -0
  36. package/dist/devices/dishwasher.js +57 -0
  37. package/dist/devices/dishwasher.js.map +1 -0
  38. package/dist/devices/evse.d.ts +75 -0
  39. package/dist/devices/evse.d.ts.map +1 -0
  40. package/dist/devices/evse.js +74 -10
  41. package/dist/devices/evse.js.map +1 -0
  42. package/dist/devices/export.d.ts +17 -0
  43. package/dist/devices/export.d.ts.map +1 -0
  44. package/dist/devices/export.js +5 -0
  45. package/dist/devices/export.js.map +1 -0
  46. package/dist/devices/extractorHood.d.ts +46 -0
  47. package/dist/devices/extractorHood.d.ts.map +1 -0
  48. package/dist/devices/extractorHood.js +42 -0
  49. package/dist/devices/extractorHood.js.map +1 -0
  50. package/dist/devices/heatPump.d.ts +47 -0
  51. package/dist/devices/heatPump.d.ts.map +1 -0
  52. package/dist/devices/heatPump.js +50 -2
  53. package/dist/devices/heatPump.js.map +1 -0
  54. package/dist/devices/laundryDryer.d.ts +67 -0
  55. package/dist/devices/laundryDryer.d.ts.map +1 -0
  56. package/dist/devices/laundryDryer.js +62 -3
  57. package/dist/devices/laundryDryer.js.map +1 -0
  58. package/dist/devices/laundryWasher.d.ts +81 -0
  59. package/dist/devices/laundryWasher.d.ts.map +1 -0
  60. package/dist/devices/laundryWasher.js +70 -4
  61. package/dist/devices/laundryWasher.js.map +1 -0
  62. package/dist/devices/microwaveOven.d.ts +168 -0
  63. package/dist/devices/microwaveOven.d.ts.map +1 -0
  64. package/dist/devices/microwaveOven.js +88 -5
  65. package/dist/devices/microwaveOven.js.map +1 -0
  66. package/dist/devices/oven.d.ts +105 -0
  67. package/dist/devices/oven.d.ts.map +1 -0
  68. package/dist/devices/oven.js +85 -0
  69. package/dist/devices/oven.js.map +1 -0
  70. package/dist/devices/refrigerator.d.ts +118 -0
  71. package/dist/devices/refrigerator.d.ts.map +1 -0
  72. package/dist/devices/refrigerator.js +102 -0
  73. package/dist/devices/refrigerator.js.map +1 -0
  74. package/dist/devices/roboticVacuumCleaner.d.ts +112 -0
  75. package/dist/devices/roboticVacuumCleaner.d.ts.map +1 -0
  76. package/dist/devices/roboticVacuumCleaner.js +100 -9
  77. package/dist/devices/roboticVacuumCleaner.js.map +1 -0
  78. package/dist/devices/solarPower.d.ts +40 -0
  79. package/dist/devices/solarPower.d.ts.map +1 -0
  80. package/dist/devices/solarPower.js +38 -0
  81. package/dist/devices/solarPower.js.map +1 -0
  82. package/dist/devices/speaker.d.ts +87 -0
  83. package/dist/devices/speaker.d.ts.map +1 -0
  84. package/dist/devices/speaker.js +84 -0
  85. package/dist/devices/speaker.js.map +1 -0
  86. package/dist/devices/temperatureControl.d.ts +166 -0
  87. package/dist/devices/temperatureControl.d.ts.map +1 -0
  88. package/dist/devices/temperatureControl.js +25 -3
  89. package/dist/devices/temperatureControl.js.map +1 -0
  90. package/dist/devices/waterHeater.d.ts +111 -0
  91. package/dist/devices/waterHeater.d.ts.map +1 -0
  92. package/dist/devices/waterHeater.js +82 -2
  93. package/dist/devices/waterHeater.js.map +1 -0
  94. package/dist/dgram/coap.d.ts +205 -0
  95. package/dist/dgram/coap.d.ts.map +1 -0
  96. package/dist/dgram/coap.js +126 -13
  97. package/dist/dgram/coap.js.map +1 -0
  98. package/dist/dgram/dgram.d.ts +141 -0
  99. package/dist/dgram/dgram.d.ts.map +1 -0
  100. package/dist/dgram/dgram.js +114 -2
  101. package/dist/dgram/dgram.js.map +1 -0
  102. package/dist/dgram/mb_coap.d.ts +24 -0
  103. package/dist/dgram/mb_coap.d.ts.map +1 -0
  104. package/dist/dgram/mb_coap.js +41 -3
  105. package/dist/dgram/mb_coap.js.map +1 -0
  106. package/dist/dgram/mb_mdns.d.ts +24 -0
  107. package/dist/dgram/mb_mdns.d.ts.map +1 -0
  108. package/dist/dgram/mb_mdns.js +80 -15
  109. package/dist/dgram/mb_mdns.js.map +1 -0
  110. package/dist/dgram/mdns.d.ts +290 -0
  111. package/dist/dgram/mdns.d.ts.map +1 -0
  112. package/dist/dgram/mdns.js +299 -137
  113. package/dist/dgram/mdns.js.map +1 -0
  114. package/dist/dgram/multicast.d.ts +67 -0
  115. package/dist/dgram/multicast.d.ts.map +1 -0
  116. package/dist/dgram/multicast.js +62 -1
  117. package/dist/dgram/multicast.js.map +1 -0
  118. package/dist/dgram/unicast.d.ts +56 -0
  119. package/dist/dgram/unicast.d.ts.map +1 -0
  120. package/dist/dgram/unicast.js +54 -0
  121. package/dist/dgram/unicast.js.map +1 -0
  122. package/dist/frontend.d.ts +232 -0
  123. package/dist/frontend.d.ts.map +1 -0
  124. package/dist/frontend.js +428 -34
  125. package/dist/frontend.js.map +1 -0
  126. package/dist/frontendTypes.d.ts +514 -0
  127. package/dist/frontendTypes.d.ts.map +1 -0
  128. package/dist/frontendTypes.js +45 -0
  129. package/dist/frontendTypes.js.map +1 -0
  130. package/dist/globalMatterbridge.d.ts +59 -0
  131. package/dist/globalMatterbridge.d.ts.map +1 -0
  132. package/dist/globalMatterbridge.js +47 -0
  133. package/dist/globalMatterbridge.js.map +1 -0
  134. package/dist/helpers.d.ts +48 -0
  135. package/dist/helpers.d.ts.map +1 -0
  136. package/dist/helpers.js +53 -0
  137. package/dist/helpers.js.map +1 -0
  138. package/dist/index.d.ts +33 -0
  139. package/dist/index.d.ts.map +1 -0
  140. package/dist/index.js +30 -1
  141. package/dist/index.js.map +1 -0
  142. package/dist/logger/export.d.ts +2 -0
  143. package/dist/logger/export.d.ts.map +1 -0
  144. package/dist/logger/export.js +1 -0
  145. package/dist/logger/export.js.map +1 -0
  146. package/dist/matter/behaviors.d.ts +2 -0
  147. package/dist/matter/behaviors.d.ts.map +1 -0
  148. package/dist/matter/behaviors.js +2 -0
  149. package/dist/matter/behaviors.js.map +1 -0
  150. package/dist/matter/clusters.d.ts +2 -0
  151. package/dist/matter/clusters.d.ts.map +1 -0
  152. package/dist/matter/clusters.js +2 -0
  153. package/dist/matter/clusters.js.map +1 -0
  154. package/dist/matter/devices.d.ts +2 -0
  155. package/dist/matter/devices.d.ts.map +1 -0
  156. package/dist/matter/devices.js +2 -0
  157. package/dist/matter/devices.js.map +1 -0
  158. package/dist/matter/endpoints.d.ts +2 -0
  159. package/dist/matter/endpoints.d.ts.map +1 -0
  160. package/dist/matter/endpoints.js +2 -0
  161. package/dist/matter/endpoints.js.map +1 -0
  162. package/dist/matter/export.d.ts +5 -0
  163. package/dist/matter/export.d.ts.map +1 -0
  164. package/dist/matter/export.js +3 -0
  165. package/dist/matter/export.js.map +1 -0
  166. package/dist/matter/types.d.ts +3 -0
  167. package/dist/matter/types.d.ts.map +1 -0
  168. package/dist/matter/types.js +3 -0
  169. package/dist/matter/types.js.map +1 -0
  170. package/dist/matterbridge.d.ts +444 -0
  171. package/dist/matterbridge.d.ts.map +1 -0
  172. package/dist/matterbridge.js +784 -51
  173. package/dist/matterbridge.js.map +1 -0
  174. package/dist/matterbridgeAccessoryPlatform.d.ts +42 -0
  175. package/dist/matterbridgeAccessoryPlatform.d.ts.map +1 -0
  176. package/dist/matterbridgeAccessoryPlatform.js +36 -0
  177. package/dist/matterbridgeAccessoryPlatform.js.map +1 -0
  178. package/dist/matterbridgeBehaviors.d.ts +1747 -0
  179. package/dist/matterbridgeBehaviors.d.ts.map +1 -0
  180. package/dist/matterbridgeBehaviors.js +65 -5
  181. package/dist/matterbridgeBehaviors.js.map +1 -0
  182. package/dist/matterbridgeDeviceTypes.d.ts +761 -0
  183. package/dist/matterbridgeDeviceTypes.d.ts.map +1 -0
  184. package/dist/matterbridgeDeviceTypes.js +630 -17
  185. package/dist/matterbridgeDeviceTypes.js.map +1 -0
  186. package/dist/matterbridgeDynamicPlatform.d.ts +42 -0
  187. package/dist/matterbridgeDynamicPlatform.d.ts.map +1 -0
  188. package/dist/matterbridgeDynamicPlatform.js +36 -0
  189. package/dist/matterbridgeDynamicPlatform.js.map +1 -0
  190. package/dist/matterbridgeEndpoint.d.ts +1534 -0
  191. package/dist/matterbridgeEndpoint.d.ts.map +1 -0
  192. package/dist/matterbridgeEndpoint.js +1398 -58
  193. package/dist/matterbridgeEndpoint.js.map +1 -0
  194. package/dist/matterbridgeEndpointHelpers.d.ts +407 -0
  195. package/dist/matterbridgeEndpointHelpers.d.ts.map +1 -0
  196. package/dist/matterbridgeEndpointHelpers.js +345 -12
  197. package/dist/matterbridgeEndpointHelpers.js.map +1 -0
  198. package/dist/matterbridgePlatform.d.ts +365 -0
  199. package/dist/matterbridgePlatform.d.ts.map +1 -0
  200. package/dist/matterbridgePlatform.js +304 -0
  201. package/dist/matterbridgePlatform.js.map +1 -0
  202. package/dist/matterbridgeTypes.d.ts +197 -0
  203. package/dist/matterbridgeTypes.d.ts.map +1 -0
  204. package/dist/matterbridgeTypes.js +25 -0
  205. package/dist/matterbridgeTypes.js.map +1 -0
  206. package/dist/pluginManager.d.ts +270 -0
  207. package/dist/pluginManager.d.ts.map +1 -0
  208. package/dist/pluginManager.js +249 -3
  209. package/dist/pluginManager.js.map +1 -0
  210. package/dist/shelly.d.ts +174 -0
  211. package/dist/shelly.d.ts.map +1 -0
  212. package/dist/shelly.js +168 -7
  213. package/dist/shelly.js.map +1 -0
  214. package/dist/storage/export.d.ts +2 -0
  215. package/dist/storage/export.d.ts.map +1 -0
  216. package/dist/storage/export.js +1 -0
  217. package/dist/storage/export.js.map +1 -0
  218. package/dist/update.d.ts +75 -0
  219. package/dist/update.d.ts.map +1 -0
  220. package/dist/update.js +69 -0
  221. package/dist/update.js.map +1 -0
  222. package/dist/utils/colorUtils.d.ts +99 -0
  223. package/dist/utils/colorUtils.d.ts.map +1 -0
  224. package/dist/utils/colorUtils.js +97 -2
  225. package/dist/utils/colorUtils.js.map +1 -0
  226. package/dist/utils/commandLine.d.ts +59 -0
  227. package/dist/utils/commandLine.d.ts.map +1 -0
  228. package/dist/utils/commandLine.js +54 -0
  229. package/dist/utils/commandLine.js.map +1 -0
  230. package/dist/utils/copyDirectory.d.ts +33 -0
  231. package/dist/utils/copyDirectory.d.ts.map +1 -0
  232. package/dist/utils/copyDirectory.js +38 -1
  233. package/dist/utils/copyDirectory.js.map +1 -0
  234. package/dist/utils/createDirectory.d.ts +34 -0
  235. package/dist/utils/createDirectory.d.ts.map +1 -0
  236. package/dist/utils/createDirectory.js +33 -0
  237. package/dist/utils/createDirectory.js.map +1 -0
  238. package/dist/utils/createZip.d.ts +39 -0
  239. package/dist/utils/createZip.d.ts.map +1 -0
  240. package/dist/utils/createZip.js +47 -2
  241. package/dist/utils/createZip.js.map +1 -0
  242. package/dist/utils/deepCopy.d.ts +32 -0
  243. package/dist/utils/deepCopy.d.ts.map +1 -0
  244. package/dist/utils/deepCopy.js +39 -0
  245. package/dist/utils/deepCopy.js.map +1 -0
  246. package/dist/utils/deepEqual.d.ts +54 -0
  247. package/dist/utils/deepEqual.d.ts.map +1 -0
  248. package/dist/utils/deepEqual.js +72 -1
  249. package/dist/utils/deepEqual.js.map +1 -0
  250. package/dist/utils/error.d.ts +44 -0
  251. package/dist/utils/error.d.ts.map +1 -0
  252. package/dist/utils/error.js +41 -0
  253. package/dist/utils/error.js.map +1 -0
  254. package/dist/utils/export.d.ts +13 -0
  255. package/dist/utils/export.d.ts.map +1 -0
  256. package/dist/utils/export.js +1 -0
  257. package/dist/utils/export.js.map +1 -0
  258. package/dist/utils/hex.d.ts +89 -0
  259. package/dist/utils/hex.d.ts.map +1 -0
  260. package/dist/utils/hex.js +124 -0
  261. package/dist/utils/hex.js.map +1 -0
  262. package/dist/utils/isvalid.d.ts +103 -0
  263. package/dist/utils/isvalid.d.ts.map +1 -0
  264. package/dist/utils/isvalid.js +101 -0
  265. package/dist/utils/isvalid.js.map +1 -0
  266. package/dist/utils/jestHelpers.d.ts +137 -0
  267. package/dist/utils/jestHelpers.d.ts.map +1 -0
  268. package/dist/utils/jestHelpers.js +153 -3
  269. package/dist/utils/jestHelpers.js.map +1 -0
  270. package/dist/utils/network.d.ts +84 -0
  271. package/dist/utils/network.d.ts.map +1 -0
  272. package/dist/utils/network.js +91 -5
  273. package/dist/utils/network.js.map +1 -0
  274. package/dist/utils/spawn.d.ts +34 -0
  275. package/dist/utils/spawn.d.ts.map +1 -0
  276. package/dist/utils/spawn.js +84 -6
  277. package/dist/utils/spawn.js.map +1 -0
  278. package/dist/utils/wait.d.ts +54 -0
  279. package/dist/utils/wait.d.ts.map +1 -0
  280. package/dist/utils/wait.js +60 -8
  281. package/dist/utils/wait.js.map +1 -0
  282. package/frontend/build/assets/index.js +7 -5
  283. package/npm-shrinkwrap.json +22 -16
  284. package/package.json +2 -1
@@ -1,4 +1,29 @@
1
+ /**
2
+ * This file contains the class MatterbridgeDevice.
3
+ *
4
+ * @file matterbridgeDeviceTypes.ts
5
+ * @author Luca Liguori
6
+ * @created 2024-11-08
7
+ * @version 1.0.0
8
+ * @license Apache-2.0
9
+ *
10
+ * Copyright 2024, 2025, 2026 Luca Liguori.
11
+ *
12
+ * Licensed under the Apache License, Version 2.0 (the "License");
13
+ * you may not use this file except in compliance with the License.
14
+ * You may obtain a copy of the License at
15
+ *
16
+ * http://www.apache.org/licenses/LICENSE-2.0
17
+ *
18
+ * Unless required by applicable law or agreed to in writing, software
19
+ * distributed under the License is distributed on an "AS IS" BASIS,
20
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
21
+ * See the License for the specific language governing permissions and
22
+ * limitations under the License.
23
+ */
24
+ // @matter
1
25
  import { DeviceTypeId } from '@matter/main';
26
+ // @matter clusters
2
27
  import { AccountLogin } from '@matter/main/clusters/account-login';
3
28
  import { Actions } from '@matter/main/clusters/actions';
4
29
  import { ActivatedCarbonFilterMonitoring } from '@matter/main/clusters/activated-carbon-filter-monitoring';
@@ -85,15 +110,42 @@ import { WaterHeaterMode } from '@matter/main/clusters/water-heater-mode';
85
110
  import { WindowCovering } from '@matter/main/clusters/window-covering';
86
111
  export var DeviceClasses;
87
112
  (function (DeviceClasses) {
113
+ /** Node device type. */
88
114
  DeviceClasses["Node"] = "Node";
115
+ /**
116
+ * Application device type.
117
+ * Application devices types are typically the most datatype endpoints on a node and in the network.
118
+ */
89
119
  DeviceClasses["App"] = "App";
120
+ /**
121
+ * Utility device type.
122
+ * A Utility device type supports configuration and settings.
123
+ */
90
124
  DeviceClasses["Utility"] = "Utility";
125
+ /**
126
+ * Simple device type.
127
+ * A Simple device type supports local control that is persistent, independent, and unsupervised.
128
+ */
91
129
  DeviceClasses["Simple"] = "Simple";
130
+ /**
131
+ * Dynamic device type.
132
+ * A Dynamic device type supports intelligent and supervisory services, such as commissioning,
133
+ * monitoring, trend analysis, scheduling and central management. A dynamic device type is an
134
+ * application device type.
135
+ */
92
136
  DeviceClasses["Dynamic"] = "Dynamic";
137
+ /** There exists a client application cluster on the endpoint. */
93
138
  DeviceClasses["Client"] = "Client";
139
+ /** There exists a server application cluster on the endpoint. */
94
140
  DeviceClasses["Server"] = "Server";
141
+ /** The device type is composed of 2 or more device types. */
95
142
  DeviceClasses["Composed"] = "Composed";
143
+ /** The endpoint and at least one of its sibling endpoints have an overlap in application device type(s). */
96
144
  DeviceClasses["Duplicate"] = "Duplicate";
145
+ /**
146
+ * The endpoint represents a Bridged Device, for which information about the state of
147
+ * its power source is available to the Bridge
148
+ */
97
149
  DeviceClasses["BridgedPowerSourceInfo"] = "BridgedPowerSourceInfo";
98
150
  })(DeviceClasses || (DeviceClasses = {}));
99
151
  export const DeviceTypeDefinition = ({ name, code, deviceClass, revision, requiredServerClusters = [], optionalServerClusters = [], requiredClientClusters = [], optionalClientClusters = [], }) => ({
@@ -106,13 +158,14 @@ export const DeviceTypeDefinition = ({ name, code, deviceClass, revision, requir
106
158
  requiredClientClusters,
107
159
  optionalClientClusters,
108
160
  });
161
+ // Chapter 2. Utility device types
109
162
  export const rootNode = DeviceTypeDefinition({
110
163
  name: 'MA-rootNode',
111
164
  code: 0x0016,
112
165
  deviceClass: DeviceClasses.Node,
113
166
  revision: 3,
114
- requiredServerClusters: [],
115
- optionalServerClusters: [],
167
+ requiredServerClusters: [], // Intentionally left empty
168
+ optionalServerClusters: [], // Intentionally left empty
116
169
  });
117
170
  export const powerSource = DeviceTypeDefinition({
118
171
  name: 'MA-powerSource',
@@ -142,6 +195,27 @@ export const OTAProvider = DeviceTypeDefinition({
142
195
  requiredClientClusters: [OtaSoftwareUpdateRequestor.Cluster.id],
143
196
  optionalClientClusters: [],
144
197
  });
198
+ /**
199
+ 2.5.3. Conditions
200
+ Please see the Base Device Type definition for conformance tags.
201
+ This device type SHALL only be used for Nodes which have a device type of Bridge.
202
+
203
+ 2.5.5. Cluster Requirements
204
+ Each endpoint supporting this device type SHALL include these clusters based on the conformance
205
+ defined below.
206
+ - 0x0039 Bridged Device Basic Information Server
207
+
208
+ 2.5.6. Endpoint Composition
209
+ • A Bridged Node endpoint SHALL support one of the following composition patterns:
210
+ ◦ Separate Endpoints: All application device types are supported on separate endpoints, and
211
+ not on the Bridged Node endpoint. The Bridged Node endpoint’s Descriptor cluster PartsList
212
+ attribute SHALL indicate a list of all endpoints representing the functionality of the bridged
213
+ device, including the endpoints supporting the application device types, i.e. the full-family
214
+ pattern defined in the System Model specification.
215
+ ◦ One Endpoint: Both the Bridged Node and one or more application device types are sup
216
+ ported on the same endpoint (following application device type rules). Endpoint composi
217
+ tion SHALL conform to the application device type(s) definition
218
+ */
145
219
  export const bridgedNode = DeviceTypeDefinition({
146
220
  name: 'MA-bridgedNode',
147
221
  code: 0x0013,
@@ -150,6 +224,17 @@ export const bridgedNode = DeviceTypeDefinition({
150
224
  requiredServerClusters: [BridgedDeviceBasicInformation.Cluster.id],
151
225
  optionalServerClusters: [PowerSource.Cluster.id, EcosystemInformation.Cluster.id, AdministratorCommissioning.Cluster.id],
152
226
  });
227
+ /**
228
+ * An Electrical Sensor device measures the electrical power and/or energy being imported and/or
229
+ * exported.
230
+ * It is a utility device type that provides information about the electrical power and/or energy
231
+ * consumption and generation.
232
+ *
233
+ * 2.6.3. Device Type Requirements
234
+ * Electrical measurements made by either the Electrical Power Measurement cluster, the Electrical
235
+ * Energy Measurement cluster, or both SHALL apply to the endpoints indicated by the Power Topology
236
+ * cluster.
237
+ */
153
238
  export const electricalSensor = DeviceTypeDefinition({
154
239
  name: 'MA-electricalSensor',
155
240
  code: 0x0510,
@@ -158,6 +243,10 @@ export const electricalSensor = DeviceTypeDefinition({
158
243
  requiredServerClusters: [PowerTopology.Cluster.id],
159
244
  optionalServerClusters: [ElectricalPowerMeasurement.Cluster.id, ElectricalEnergyMeasurement.Cluster.id],
160
245
  });
246
+ /**
247
+ * A Device Energy Management device provides reporting and optionally adjustment of the electrical
248
+ * power planned on being consumed or produced by the device.
249
+ */
161
250
  export const deviceEnergyManagement = DeviceTypeDefinition({
162
251
  name: 'MA-deviceEnergyManagement',
163
252
  code: 0x050d,
@@ -166,77 +255,194 @@ export const deviceEnergyManagement = DeviceTypeDefinition({
166
255
  requiredServerClusters: [DeviceEnergyManagement.Cluster.id],
167
256
  optionalServerClusters: [DeviceEnergyManagementMode.Cluster.id],
168
257
  });
258
+ // Chapter 4. Lightning device types
259
+ /**
260
+ * Element Requirements:
261
+ * - Identify Command TriggerEffect
262
+ * - Scenes Management Command CopyScene
263
+ * - On/Off Feature Lighting
264
+ * - Level Control Feature OnOff
265
+ * - Level Control Feature Lighting
266
+ * - Level Control Attribute CurrentLevel 1 to 254
267
+ * - Level Control Attribute MinLevel 1
268
+ * - Level Control Attribute MaxLevel 254
269
+ */
169
270
  export const onOffLight = DeviceTypeDefinition({
170
271
  name: 'MA-onofflight',
171
272
  code: 0x0100,
172
273
  deviceClass: DeviceClasses.Simple,
173
274
  revision: 3,
174
- requiredServerClusters: [Identify.Cluster.id, Groups.Cluster.id, OnOff.Cluster.id],
275
+ requiredServerClusters: [Identify.Cluster.id, Groups.Cluster.id, /* ScenesManagement.Cluster.id,*/ OnOff.Cluster.id],
175
276
  optionalServerClusters: [LevelControl.Cluster.id],
176
277
  });
278
+ /**
279
+ * Element Requirements:
280
+ * - Identify Command TriggerEffect
281
+ * - Scenes Management Command CopyScene
282
+ * - On/Off Feature Lighting
283
+ * - Level Control Feature OnOff
284
+ * - Level Control Feature Lighting
285
+ * - Level Control Attribute CurrentLevel 1 to 254
286
+ * - Level Control Attribute MinLevel 1
287
+ * - Level Control Attribute MaxLevel 254
288
+ */
177
289
  export const dimmableLight = DeviceTypeDefinition({
178
290
  name: 'MA-dimmablelight',
179
291
  code: 0x0101,
180
292
  deviceClass: DeviceClasses.Simple,
181
293
  revision: 3,
182
- requiredServerClusters: [Identify.Cluster.id, Groups.Cluster.id, OnOff.Cluster.id, LevelControl.Cluster.id],
294
+ requiredServerClusters: [Identify.Cluster.id, Groups.Cluster.id, /* ScenesManagement.Cluster.id,*/ OnOff.Cluster.id, LevelControl.Cluster.id],
183
295
  optionalServerClusters: [],
184
296
  });
297
+ /**
298
+ * Element Requirements:
299
+ * - Identify Command TriggerEffect
300
+ * - Scenes Management Command CopyScene
301
+ * - On/Off Feature Lighting
302
+ * - Level Control Feature OnOff
303
+ * - Level Control Feature Lighting
304
+ * - Level Control Attribute CurrentLevel 1 to 254
305
+ * - Level Control Attribute MinLevel 1
306
+ * - Level Control Attribute MaxLevel 254
307
+ * - Color Control Feature ColorTemperature
308
+ * - Color Control Attribute RemainingTime
309
+ */
185
310
  export const colorTemperatureLight = DeviceTypeDefinition({
186
311
  name: 'MA-colortemperaturelight',
187
312
  code: 0x010c,
188
313
  deviceClass: DeviceClasses.Simple,
189
314
  revision: 4,
190
- requiredServerClusters: [Identify.Cluster.id, Groups.Cluster.id, OnOff.Cluster.id, LevelControl.Cluster.id, ColorControl.Cluster.id],
315
+ requiredServerClusters: [Identify.Cluster.id, Groups.Cluster.id, /* ScenesManagement.Cluster.id,*/ OnOff.Cluster.id, LevelControl.Cluster.id, ColorControl.Cluster.id],
191
316
  optionalServerClusters: [],
192
317
  });
318
+ /**
319
+ * Element Requirements:
320
+ * - Identify Command TriggerEffect
321
+ * - Scenes Management Command CopyScene
322
+ * - On/Off Feature Lighting
323
+ * - Level Control Feature OnOff
324
+ * - Level Control Feature Lighting
325
+ * - Level Control Attribute CurrentLevel 1 to 254
326
+ * - Level Control Attribute MinLevel 1
327
+ * - Level Control Attribute MaxLevel 254
328
+ * - Color Control Feature XY
329
+ * - Color Control Feature ColorTemperature
330
+ * - Color Control Attribute RemainingTime
331
+ */
193
332
  export const extendedColorLight = DeviceTypeDefinition({
194
333
  name: 'MA-extendedcolorlight',
195
334
  code: 0x010d,
196
335
  deviceClass: DeviceClasses.Simple,
197
336
  revision: 4,
198
- requiredServerClusters: [Identify.Cluster.id, Groups.Cluster.id, OnOff.Cluster.id, LevelControl.Cluster.id, ColorControl.Cluster.id],
337
+ requiredServerClusters: [Identify.Cluster.id, Groups.Cluster.id, /* ScenesManagement.Cluster.id,*/ OnOff.Cluster.id, LevelControl.Cluster.id, ColorControl.Cluster.id],
199
338
  optionalServerClusters: [],
200
339
  });
340
+ // Chapter 5. Smart plugs/Outlets and other Actuators device types
341
+ /**
342
+ * Element Requirements:
343
+ * - Identify Command TriggerEffect
344
+ * - Scenes Management Command CopyScene
345
+ * - On/Off Feature Lighting
346
+ * - Level Control Feature OnOff
347
+ * - Level Control Feature Lighting
348
+ * - Level Control Attribute CurrentLevel 1 to 254
349
+ * - Level Control Attribute MinLevel 1
350
+ * - Level Control Attribute MaxLevel 254
351
+ */
201
352
  export const onOffOutlet = DeviceTypeDefinition({
202
353
  name: 'MA-onoffpluginunit',
203
354
  code: 0x010a,
204
355
  deviceClass: DeviceClasses.Simple,
205
356
  revision: 3,
206
- requiredServerClusters: [Identify.Cluster.id, Groups.Cluster.id, OnOff.Cluster.id],
357
+ requiredServerClusters: [Identify.Cluster.id, Groups.Cluster.id, /* ScenesManagement.Cluster.id,*/ OnOff.Cluster.id],
207
358
  optionalServerClusters: [LevelControl.Cluster.id],
208
359
  });
360
+ /**
361
+ * Element Requirements:
362
+ * - Identify Command TriggerEffect
363
+ * - Scenes Management Command CopyScene
364
+ * - On/Off Feature Lighting
365
+ * - Level Control Feature OnOff
366
+ * - Level Control Feature Lighting
367
+ * - Level Control Attribute CurrentLevel 1 to 254
368
+ * - Level Control Attribute MinLevel 1
369
+ * - Level Control Attribute MaxLevel 254
370
+ */
209
371
  export const dimmableOutlet = DeviceTypeDefinition({
210
372
  name: 'MA-dimmablepluginunit',
211
373
  code: 0x010b,
212
374
  deviceClass: DeviceClasses.Simple,
213
375
  revision: 4,
214
- requiredServerClusters: [Identify.Cluster.id, Groups.Cluster.id, OnOff.Cluster.id, LevelControl.Cluster.id],
376
+ requiredServerClusters: [Identify.Cluster.id, Groups.Cluster.id, /* ScenesManagement.Cluster.id,*/ OnOff.Cluster.id, LevelControl.Cluster.id],
215
377
  optionalServerClusters: [],
216
378
  });
379
+ /**
380
+ * A Mounted On/Off Control is a fixed device that provides power to another device that is plugged
381
+ * into it, and is capable of switching that provided power on or off.
382
+ * It is a simple device type that does not require any client clusters.
383
+ * Element Requirements:
384
+ * - Identify Command TriggerEffect
385
+ * - Scenes Management Command CopyScene
386
+ * - On/Off Feature Lighting
387
+ * - Level Control Feature OnOff
388
+ * - Level Control Feature Lighting
389
+ * - Level Control Attribute CurrentLevel 1 to 254
390
+ * - Level Control Attribute MinLevel 1
391
+ * - Level Control Attribute MaxLevel 254
392
+ */
217
393
  export const onOffMountedSwitch = DeviceTypeDefinition({
218
394
  name: 'MA-onoffmountedswitch',
219
395
  code: 0x010f,
220
396
  deviceClass: DeviceClasses.Simple,
221
397
  revision: 1,
222
- requiredServerClusters: [Identify.Cluster.id, Groups.Cluster.id, OnOff.Cluster.id],
398
+ requiredServerClusters: [Identify.Cluster.id, Groups.Cluster.id, /* ScenesManagement.Cluster.id,*/ OnOff.Cluster.id],
223
399
  optionalServerClusters: [LevelControl.Cluster.id],
224
400
  });
401
+ /**
402
+ * A Mounted Dimmable Load Control is a fixed device that provides power to another device that is
403
+ * plugged into it, and is capable of being switched on or off and have its level adjusted. The Mounted
404
+ * Dimmable Load Control is typically used to control a conventional non-communicating light
405
+ * through its mains connection using phase cutting.
406
+ * It is a simple device type that does not require any client clusters.
407
+ * Element Requirements:
408
+ * - Identify Command TriggerEffect
409
+ * - Scenes Management Command CopyScene
410
+ * - On/Off Feature Lighting
411
+ * - Level Control Feature OnOff
412
+ * - Level Control Feature Lighting
413
+ * - Level Control Attribute CurrentLevel 1 to 254
414
+ * - Level Control Attribute MinLevel 1
415
+ * - Level Control Attribute MaxLevel 254
416
+ */
225
417
  export const dimmableMountedSwitch = DeviceTypeDefinition({
226
418
  name: 'MA-dimmablemountedswitch',
227
419
  code: 0x0110,
228
420
  deviceClass: DeviceClasses.Simple,
229
421
  revision: 1,
230
- requiredServerClusters: [Identify.Cluster.id, Groups.Cluster.id, OnOff.Cluster.id, LevelControl.Cluster.id],
422
+ requiredServerClusters: [Identify.Cluster.id, Groups.Cluster.id, /* ScenesManagement.Cluster.id,*/ OnOff.Cluster.id, LevelControl.Cluster.id],
231
423
  optionalServerClusters: [],
232
424
  });
425
+ /**
426
+ * Remark:
427
+ * On/Off Cluster:
428
+ * - Off If the pump is powered on, store the current level then immediately power it off.
429
+ * - On If the pump is powered off, power it on and move immediately to the level stored by a previous Off command. If no such level has been stored,
430
+ * move immediately to the maximum level allowed for the pump.
431
+ * - Toggle If the pump is powered on, proceed as for the Off command. If the device is powered off, proceed as for the On command.
432
+ *
433
+ * LevelControl cluster:
434
+ * Level Setpoint Meaning
435
+ * 0 N/A Pump is stopped,
436
+ * 1–200 Level / 2 (0.5–100.0%) Pump setpoint in percent
437
+ * 201–255 100.0% Pump setpoint is 100.0%
438
+ */
233
439
  export const pumpDevice = DeviceTypeDefinition({
234
440
  name: 'MA-pump',
235
441
  code: 0x303,
236
442
  deviceClass: DeviceClasses.Simple,
237
443
  revision: 3,
238
444
  requiredServerClusters: [OnOff.Cluster.id, PumpConfigurationAndControl.Cluster.id, Identify.Cluster.id],
239
- optionalServerClusters: [LevelControl.Cluster.id, Groups.Cluster.id, TemperatureMeasurement.Cluster.id, PressureMeasurement.Cluster.id, FlowMeasurement.Cluster.id],
445
+ optionalServerClusters: [LevelControl.Cluster.id, Groups.Cluster.id, /* ScenesManagement.Cluster.id, */ TemperatureMeasurement.Cluster.id, PressureMeasurement.Cluster.id, FlowMeasurement.Cluster.id],
240
446
  });
241
447
  export const waterValve = DeviceTypeDefinition({
242
448
  name: 'MA-waterValve',
@@ -246,29 +452,33 @@ export const waterValve = DeviceTypeDefinition({
246
452
  requiredServerClusters: [Identify.Cluster.id, ValveConfigurationAndControl.Cluster.id],
247
453
  optionalServerClusters: [FlowMeasurement.Cluster.id],
248
454
  });
455
+ // Chapter 6. Switches and Controls device types
456
+ // Custom device types without client clusters (not working in Alexa)
249
457
  export const onOffSwitch = DeviceTypeDefinition({
250
458
  name: 'MA-onoffswitch',
251
459
  code: 0x0103,
252
460
  deviceClass: DeviceClasses.Simple,
253
461
  revision: 3,
254
462
  requiredServerClusters: [Identify.Cluster.id, OnOff.Cluster.id],
255
- optionalServerClusters: [Groups.Cluster.id],
463
+ optionalServerClusters: [Groups.Cluster.id /* , ScenesManagement.Cluster.id*/],
256
464
  });
465
+ // Custom device types without client clusters (not working in Alexa)
257
466
  export const dimmableSwitch = DeviceTypeDefinition({
258
467
  name: 'MA-dimmableswitch',
259
468
  code: 0x0104,
260
469
  deviceClass: DeviceClasses.Simple,
261
470
  revision: 3,
262
471
  requiredServerClusters: [Identify.Cluster.id, OnOff.Cluster.id, LevelControl.Cluster.id],
263
- optionalServerClusters: [Groups.Cluster.id],
472
+ optionalServerClusters: [Groups.Cluster.id /* , ScenesManagement.Cluster.id*/],
264
473
  });
474
+ // Custom device types without client clusters (not working in Alexa)
265
475
  export const colorTemperatureSwitch = DeviceTypeDefinition({
266
476
  name: 'MA-colortemperatureswitch',
267
477
  code: 0x0105,
268
478
  deviceClass: DeviceClasses.Simple,
269
479
  revision: 3,
270
480
  requiredServerClusters: [Identify.Cluster.id, Groups.Cluster.id, OnOff.Cluster.id, LevelControl.Cluster.id, ColorControl.Cluster.id],
271
- optionalServerClusters: [Groups.Cluster.id],
481
+ optionalServerClusters: [Groups.Cluster.id /* , ScenesManagement.Cluster.id*/],
272
482
  });
273
483
  export const genericSwitch = DeviceTypeDefinition({
274
484
  name: 'MA-genericswitch',
@@ -278,6 +488,11 @@ export const genericSwitch = DeviceTypeDefinition({
278
488
  requiredServerClusters: [Identify.Cluster.id, Switch.Cluster.id],
279
489
  optionalServerClusters: [],
280
490
  });
491
+ // Chapter 7. Sensor device types
492
+ /**
493
+ * Closed or contact: state true
494
+ * Open or no contact: state false
495
+ */
281
496
  export const contactSensor = DeviceTypeDefinition({
282
497
  name: 'MA-contactsensor',
283
498
  code: 0x0015,
@@ -329,6 +544,7 @@ export const humiditySensor = DeviceTypeDefinition({
329
544
  revision: 2,
330
545
  requiredServerClusters: [Identify.Cluster.id, RelativeHumidityMeasurement.Cluster.id],
331
546
  });
547
+ // Remark: A Smoke CO Alarm device type SHALL support an instance of a Power Source device type on some endpoint.
332
548
  export const smokeCoAlarm = DeviceTypeDefinition({
333
549
  name: 'MA-smokeCoAlarm',
334
550
  code: 0x0076,
@@ -382,6 +598,15 @@ export const rainSensor = DeviceTypeDefinition({
382
598
  requiredServerClusters: [Identify.Cluster.id, BooleanState.Cluster.id],
383
599
  optionalServerClusters: [BooleanStateConfiguration.Cluster.id],
384
600
  });
601
+ // Chapter 8. Closures device types
602
+ /**
603
+ * A Door Lock is a device used to secure a door. It is possible to actuate a door lock either by means of a manual or a remote method.
604
+ * Element Requirements:
605
+ *
606
+ * - AccessControl Attribute Extension
607
+ * - DoorLock Feature User
608
+ * - DoorLock Attribute AlarmMask
609
+ */
385
610
  export const doorLockDevice = DeviceTypeDefinition({
386
611
  name: 'MA-doorLock',
387
612
  code: 0xa,
@@ -398,6 +623,15 @@ export const coverDevice = DeviceTypeDefinition({
398
623
  requiredServerClusters: [Identify.Cluster.id, WindowCovering.Cluster.id],
399
624
  optionalServerClusters: [Groups.Cluster.id],
400
625
  });
626
+ // Chapter 9. HVAC device types
627
+ /**
628
+ * A Thermostat device is capable of having either built-in or separate sensors for temperature,
629
+ * humidity or occupancy. It allows the desired temperature to be set either remotely or locally. The
630
+ * thermostat is capable of sending heating and/or cooling requirement notifications to a heating/cooling
631
+ * unit (for example, an indoor air handler) or is capable of including a mechanism to control a
632
+ * heating or cooling unit directly.
633
+ *
634
+ */
401
635
  export const thermostatDevice = DeviceTypeDefinition({
402
636
  name: 'MA-thermostat',
403
637
  code: 0x301,
@@ -406,6 +640,25 @@ export const thermostatDevice = DeviceTypeDefinition({
406
640
  requiredServerClusters: [Identify.Cluster.id, Thermostat.Cluster.id],
407
641
  optionalServerClusters: [Groups.Cluster.id, ThermostatUserInterfaceConfiguration.Cluster.id, EnergyPreference.Cluster.id],
408
642
  });
643
+ /**
644
+ * A Fan device is typically standalone or mounted on a ceiling or wall and is used to circulate air in a room.
645
+ * Remark: it may have a thermostat device type.
646
+ * Additional device types MAY also be included in device compositions.
647
+ * Element Requirements:
648
+ * The FanControl cluster must have the FanModeSequence attribute.
649
+ *
650
+ * The On/Off cluster is independent from the Fan Control Cluster’s FanMode attribute, which also
651
+ * includes an Off setting.
652
+ * If the FanMode attribute of the Fan Control cluster is set to a value other than Off when the OnOff
653
+ * attribute of the On/Off cluster transitions from TRUE to FALSE, it may be desirable to restore the
654
+ * FanMode, SpeedSetting and PercentSetting attribute values of the Fan Control cluster when the OnOff
655
+ * attribute of the On/Off cluster later transitions from FALSE to TRUE. If the FanMode is set to Off when
656
+ * the device is turned off, this information is lost, as the SpeedSetting and PercentSetting will be set to
657
+ * zero. Using the On/Off cluster alongside the Fan Control cluster allows the FanMode, SpeedSetting and
658
+ * PercentSetting to remain unchanged when the device is turned off. In this case, the On/Off cluster
659
+ * would be set to Off, and the SpeedCurrent and PercentCurrent set to zero, without changing FanMode,
660
+ * SpeedSetting and PercentSetting.
661
+ */
409
662
  export const fanDevice = DeviceTypeDefinition({
410
663
  name: 'MA-fan',
411
664
  code: 0x2b,
@@ -414,6 +667,35 @@ export const fanDevice = DeviceTypeDefinition({
414
667
  requiredServerClusters: [Identify.Cluster.id, Groups.Cluster.id, FanControl.Cluster.id],
415
668
  optionalServerClusters: [OnOff.Cluster.id],
416
669
  });
670
+ /**
671
+ * An Air Purifier is a standalone device that is designed to clean the air in a room.
672
+ * It is a device that has a fan to control the air speed while it is operating. Optionally, it can report on
673
+ * the condition of its filters.
674
+ *
675
+ * Remark:
676
+ * An Air Purifier MAY expose elements of its functionality through one or more additional device
677
+ * types on different endpoints. All devices used in compositions SHALL adhere to the disambiguation
678
+ * requirements of the System Model. Other device types, not explicitly listed in the table, MAY also be
679
+ * included in device compositions but are not considered part of the core functionality of the device.
680
+ * 0x0301 Thermostat O
681
+ * 0x0302 Temperature Sensor O
682
+ * 0x0307 Humidity Sensor O
683
+ * 0x002C Air Quality Sensor O
684
+ *
685
+ * Cluster Restrictions:
686
+ * The On/Off cluster is independent from the Fan Control Cluster’s FanMode attribute, which also
687
+ * includes an Off setting.
688
+ * If the FanMode attribute of the Fan Control cluster is set to a value other than Off when the OnOff
689
+ * attribute of the On/Off cluster transitions from TRUE to FALSE, it may be desirable to restore the
690
+ * FanMode, SpeedSetting and PercentSetting attribute values of the Fan Control cluster when the OnOff
691
+ * attribute of the On/Off cluster later transitions from FALSE to TRUE. If the FanMode is set to Off when
692
+ * the device is turned off, this information is lost, as the SpeedSetting and PercentSetting will be set to
693
+ * zero. Using the On/Off cluster alongside the Fan Control cluster allows the FanMode, SpeedSetting and
694
+ * PercentSetting to remain unchanged when the device is turned off. In this case, the On/Off cluster
695
+ * would be set to Off, and the SpeedCurrent and PercentCurrent set to zero, without changing FanMode,
696
+ * SpeedSetting and PercentSetting.
697
+ *
698
+ */
417
699
  export const airPurifier = DeviceTypeDefinition({
418
700
  name: 'MA-airPurifier',
419
701
  code: 0x2d,
@@ -422,6 +704,26 @@ export const airPurifier = DeviceTypeDefinition({
422
704
  requiredServerClusters: [Identify.Cluster.id, FanControl.Cluster.id],
423
705
  optionalServerClusters: [Groups.Cluster.id, OnOff.Cluster.id, HepaFilterMonitoring.Cluster.id, ActivatedCarbonFilterMonitoring.Cluster.id],
424
706
  });
707
+ // Chapter 10. Media Device Types
708
+ /**
709
+ * 10.2. A Basic Video Player has playback controls (play, pause, etc.) and keypad remote controls (up, down, number input),
710
+ * but is not able to launch arbitrary content applications. It is a commissionable node.
711
+ *
712
+ * Required server clusters (minimum features per spec):
713
+ * - Media Playback (media playback controls)
714
+ * - Keypad Input (remote key events)
715
+ * - On/Off (basic power control)
716
+ *
717
+ * Optional server clusters (additional capabilities commonly implemented):
718
+ * - Audio Output (speaker selection / volume endpoints)
719
+ * - Channel (linear channel navigation)
720
+ * - Target Navigator (high level app / target navigation)
721
+ * - Media Input (input source selection)
722
+ * - Low Power (power saving / wake logic)
723
+ * - Wake On LAN (remote wake capabilities)
724
+ * - Messages (device messaging / notifications)
725
+ * - Content Control (parental or content access control)
726
+ */
425
727
  export const basicVideoPlayer = DeviceTypeDefinition({
426
728
  name: 'MA-basicVideoPlayer',
427
729
  code: 0x0028,
@@ -430,6 +732,29 @@ export const basicVideoPlayer = DeviceTypeDefinition({
430
732
  requiredServerClusters: [OnOff.Cluster.id, MediaPlayback.Cluster.id, KeypadInput.Cluster.id],
431
733
  optionalServerClusters: [WakeOnLan.Cluster.id, Channel.Cluster.id, TargetNavigator.Cluster.id, MediaInput.Cluster.id, LowPower.Cluster.id, AudioOutput.Cluster.id, ContentControl.Cluster.id, Messages.Cluster.id],
432
734
  });
735
+ /**
736
+ * 10.3. A Casting Video Player supports Basic Video Player features and content launching features.
737
+ * It is a Commissioner and can launch Content Apps (Content Launcher cluster) and optionally expose
738
+ * an Application Launcher cluster when acting as a Content App Platform.
739
+ *
740
+ * Required server clusters (minimum features per spec):
741
+ * - Media Playback (playback controls)
742
+ * - Keypad Input (remote key events)
743
+ * - Content Launcher (content launching capability)
744
+ * - On/Off (basic power control)
745
+ *
746
+ * Optional server clusters (additional capabilities):
747
+ * - Application Launcher (hosting content apps)
748
+ * - Account Login (account / session association)
749
+ * - Audio Output (output / volume endpoints)
750
+ * - Channel (linear channel navigation)
751
+ * - Target Navigator (high level target navigation)
752
+ * - Media Input (input source selection)
753
+ * - Low Power (power saving / wake logic)
754
+ * - Wake On LAN (remote wake capabilities)
755
+ * - Messages (device messaging / notifications)
756
+ * - Content Control (parental or content access control)
757
+ */
433
758
  export const castingVideoPlayer = DeviceTypeDefinition({
434
759
  name: 'MA-castingVideoPlayer',
435
760
  code: 0x0023,
@@ -449,6 +774,12 @@ export const castingVideoPlayer = DeviceTypeDefinition({
449
774
  Messages.Cluster.id,
450
775
  ],
451
776
  });
777
+ /**
778
+ * 10.4. A Speaker device type controls the speaker.
779
+ * unmute/mute, the On/Off cluster SHALL be used. A value of TRUE for the OnOff attribute
780
+ * SHALL represent the volume on (not muted) state, while a value of FALSE SHALL represent the volume
781
+ * off (muted) state. For volume level control, the Level cluster SHALL be used.
782
+ */
452
783
  export const speakerDevice = DeviceTypeDefinition({
453
784
  name: 'MA-speaker',
454
785
  code: 0x0022,
@@ -457,6 +788,7 @@ export const speakerDevice = DeviceTypeDefinition({
457
788
  requiredServerClusters: [OnOff.Cluster.id, LevelControl.Cluster.id],
458
789
  optionalServerClusters: [],
459
790
  });
791
+ // Chapter 11. Generic Device Types
460
792
  export const modeSelect = DeviceTypeDefinition({
461
793
  name: 'MA-modeselect',
462
794
  code: 0x27,
@@ -464,6 +796,37 @@ export const modeSelect = DeviceTypeDefinition({
464
796
  revision: 1,
465
797
  requiredServerClusters: [ModeSelect.Cluster.id],
466
798
  });
799
+ /**
800
+ * This device type aggregates endpoints as a collection. Clusters on the endpoint indicating this
801
+ * device type provide functionality for the collection of descendant endpoints present in the PartsList
802
+ * of the endpoint’s descriptor, for example the Actions cluster.
803
+ *
804
+ * Endpoint Composition:
805
+ * An Aggregator endpoint’s Descriptor cluster PartsList attribute SHALL list the collection of all endpoints
806
+ * aggregated by the Aggregator device type, i.e. the full-family pattern defined in the System Model specification.
807
+ *
808
+ * Disambiguation:
809
+ * If the Duplicate condition applies to child endpoints of an Aggregator endpoint that represent multiple
810
+ * independent bridged devices, the endpoints SHOULD make available metadata to allow a
811
+ * client to disambiguate distinct bridged devices with an overlap in application device types.
812
+ *
813
+ * Typically this is done using the NodeLabel attribute of the Bridged Device Basic Information cluster
814
+ * - thus reusing the naming information which the bridge already has to allow disambiguation to the
815
+ * user when using a direct user interface to the bridge.
816
+ *
817
+ * Actions cluster (9.14 Matter specification):
818
+ * If a Bridge has (such) information on topology or logical grouping, it SHOULD expose such information
819
+ * in the EndpointLists attribute of an Actions cluster (the ActionLists of which MAY be empty if
820
+ * no actions are exposed). 9.12 Matter specification
821
+ *
822
+ * 9.12.5. New features for Bridged Devices
823
+ * Bridged Devices can have their software updated independently of the Bridge, through Bridge Manufacturer-
824
+ * specific means. These updates MAY result in one or more changes to their capabilities,
825
+ * such as supported clusters and/or attributes, for an endpoint. Like every Matter Node, every endpoint
826
+ * on the Bridge’s Node contains a Descriptor cluster that contains attributes for the device types
827
+ * (DeviceTypeList), endpoints (PartsList) and supported clusters (ServerList and ClientList). Nodes
828
+ * that wish to be notified of such changes SHOULD monitor changes of these attributes.
829
+ */
467
830
  export const aggregator = DeviceTypeDefinition({
468
831
  name: 'MA-aggregator',
469
832
  code: 0x000e,
@@ -473,6 +836,29 @@ export const aggregator = DeviceTypeDefinition({
473
836
  optionalServerClusters: [Actions.Cluster.id, Identify.Cluster.id, CommissionerControl.Cluster.id],
474
837
  });
475
838
  export const bridge = aggregator;
839
+ // Chapter 12. Robotic Device Types
840
+ /**
841
+ * A Robotic Vacuum Cleaner is a device that is capable of cleaning floors and other surfaces
842
+ * in a home or office environment. It is typically a mobile device that can navigate around
843
+ * obstacles and can be controlled remotely.
844
+ *
845
+ * Cluster Usage:
846
+ * The RVC Operational State cluster’s OperationalState attribute SHALL be updated according to the
847
+ * state of the device, and therefore it SHOULD be used for monitoring purposes.
848
+ *
849
+ * To attempt starting a cleaning operation, the RVC Run Mode cluster can be sent a ChangeToMode
850
+ * command with the NewMode field set to a mode that has the Cleaning mode tag associated with it.
851
+ *
852
+ * To attempt stopping a cleaning operation, the RVC Run Mode cluster can be sent a ChangeToMode
853
+ * command with the NewMode field set to a mode that has the Idle mode tag associated with it.
854
+ *
855
+ * To attempt pausing a cleaning operation, the RVC Operational State cluster can be sent a Pause command.
856
+ *
857
+ * To attempt resuming a cleaning operation, the RVC Operational State cluster can be sent a Resume
858
+ * command.
859
+ *
860
+ *
861
+ */
476
862
  export const roboticVacuumCleaner = DeviceTypeDefinition({
477
863
  name: 'MA-roboticvacuumcleaner',
478
864
  code: 0x74,
@@ -481,6 +867,11 @@ export const roboticVacuumCleaner = DeviceTypeDefinition({
481
867
  requiredServerClusters: [Identify.Cluster.id, RvcRunMode.Cluster.id, RvcOperationalState.Cluster.id],
482
868
  optionalServerClusters: [RvcCleanMode.Cluster.id, ServiceArea.Cluster.id],
483
869
  });
870
+ // Chapter 13. Appliances device types
871
+ /**
872
+ * Cluster Restrictions:
873
+ * On/Off Cluster: the DF (Dead Front) feature is required
874
+ */
484
875
  export const laundryWasher = DeviceTypeDefinition({
485
876
  name: 'MA-laundrywasher',
486
877
  code: 0x73,
@@ -489,6 +880,13 @@ export const laundryWasher = DeviceTypeDefinition({
489
880
  requiredServerClusters: [OperationalState.Cluster.id],
490
881
  optionalServerClusters: [Identify.Cluster.id, LaundryWasherMode.Cluster.id, OnOff.Cluster.id, LaundryWasherControls.Cluster.id, TemperatureControl.Cluster.id],
491
882
  });
883
+ /**
884
+ * A refrigerator represents a device that contains one or more cabinets that are capable of chilling or freezing food.
885
+ * A Refrigerator SHALL be composed of at least one endpoint with the Temperature Controlled Cabinet device type.
886
+ *
887
+ * Device Type Requirements:
888
+ * 0x0071 Temperature Controlled Cabinet
889
+ */
492
890
  export const refrigerator = DeviceTypeDefinition({
493
891
  name: 'MA-refrigerator',
494
892
  code: 0x70,
@@ -497,6 +895,23 @@ export const refrigerator = DeviceTypeDefinition({
497
895
  requiredServerClusters: [Identify.Cluster.id, RefrigeratorAndTemperatureControlledCabinetMode.Cluster.id, RefrigeratorAlarm.Cluster.id],
498
896
  optionalServerClusters: [],
499
897
  });
898
+ /**
899
+ * A Room Air Conditioner is a device with the primary function of controlling the air temperature in a single room.
900
+ *
901
+ * A Room Air Conditioner MAY have zero or more of each device type listed in this table subject to
902
+ * the conformance column of the table. All devices used in compositions SHALL adhere to the disambiguation
903
+ * requirements of the System Model. Additional device types not listed in this table MAY also be included in device compositions.
904
+ * 0x0302 Temperature Sensor O
905
+ * 0x0307 Humidity Sensor O
906
+ *
907
+ * Remark:
908
+ * The DF (Dead Front) feature is required for the On/Off cluster in this device type:
909
+ * - Thermostat LocalTemperature null
910
+ * - Temperature Measurement MeasuredValue null
911
+ * - Relative Humidity Measurement MeasuredValue null
912
+ * - Fan Control SpeedSetting null
913
+ * - Fan Control PercentSetting null
914
+ */
500
915
  export const airConditioner = DeviceTypeDefinition({
501
916
  name: 'MA-airConditioner',
502
917
  code: 0x72,
@@ -505,12 +920,22 @@ export const airConditioner = DeviceTypeDefinition({
505
920
  requiredServerClusters: [Identify.Cluster.id, OnOff.Cluster.id, Thermostat.Cluster.id],
506
921
  optionalServerClusters: [
507
922
  Groups.Cluster.id,
923
+ /* ScenesManagement.Cluster.id,*/
508
924
  FanControl.Cluster.id,
509
925
  ThermostatUserInterfaceConfiguration.Cluster.id,
510
926
  TemperatureMeasurement.Cluster.id,
511
927
  RelativeHumidityMeasurement.Cluster.id,
512
928
  ],
513
929
  });
930
+ /**
931
+ * A Temperature Controlled Cabinet only exists composed as part of another device type. It represents
932
+ * a single cabinet that is capable of having its temperature controlled. Such a cabinet may be
933
+ * chilling or freezing food, for example as part of a refrigerator, freezer, wine chiller, or other similar
934
+ * device. Equally, such a cabinet may be warming or heating food, for example as part of an oven,
935
+ * range, or similar device.
936
+ * Conditions:
937
+ * Cooler The device has cooling functionality.
938
+ */
514
939
  export const temperatureControlledCabinetCooler = DeviceTypeDefinition({
515
940
  name: 'MA-temperaturecontrolledcabinetcooler',
516
941
  code: 0x71,
@@ -519,6 +944,15 @@ export const temperatureControlledCabinetCooler = DeviceTypeDefinition({
519
944
  requiredServerClusters: [TemperatureControl.Cluster.id, RefrigeratorAndTemperatureControlledCabinetMode.Cluster.id],
520
945
  optionalServerClusters: [TemperatureMeasurement.Cluster.id],
521
946
  });
947
+ /**
948
+ * A Temperature Controlled Cabinet only exists composed as part of another device type. It represents
949
+ * a single cabinet that is capable of having its temperature controlled. Such a cabinet may be
950
+ * chilling or freezing food, for example as part of a refrigerator, freezer, wine chiller, or other similar
951
+ * device. Equally, such a cabinet may be warming or heating food, for example as part of an oven,
952
+ * range, or similar device.
953
+ * Conditions:
954
+ * Heater The device has heating functionality.
955
+ */
522
956
  export const temperatureControlledCabinetHeater = DeviceTypeDefinition({
523
957
  name: 'MA-temperaturecontrolledcabinetheater',
524
958
  code: 0x71,
@@ -527,6 +961,10 @@ export const temperatureControlledCabinetHeater = DeviceTypeDefinition({
527
961
  requiredServerClusters: [TemperatureControl.Cluster.id, OvenMode.Cluster.id, OvenCavityOperationalState.Cluster.id],
528
962
  optionalServerClusters: [TemperatureMeasurement.Cluster.id],
529
963
  });
964
+ /**
965
+ * Cluster Restrictions:
966
+ * On/Off Cluster: the DF (Dead Front) feature is required
967
+ */
530
968
  export const dishwasher = DeviceTypeDefinition({
531
969
  name: 'MA-dishwasher',
532
970
  code: 0x75,
@@ -535,6 +973,10 @@ export const dishwasher = DeviceTypeDefinition({
535
973
  requiredServerClusters: [OperationalState.Cluster.id],
536
974
  optionalServerClusters: [Identify.Cluster.id, OnOff.Cluster.id, TemperatureControl.Cluster.id, DishwasherMode.Cluster.id, DishwasherAlarm.Cluster.id],
537
975
  });
976
+ /**
977
+ * Cluster Restrictions:
978
+ * On/Off Cluster: the DF (Dead Front) feature is required
979
+ */
538
980
  export const laundryDryer = DeviceTypeDefinition({
539
981
  name: 'MA-laundrydryer',
540
982
  code: 0x7c,
@@ -543,6 +985,13 @@ export const laundryDryer = DeviceTypeDefinition({
543
985
  requiredServerClusters: [OperationalState.Cluster.id],
544
986
  optionalServerClusters: [Identify.Cluster.id, LaundryWasherMode.Cluster.id, OnOff.Cluster.id, LaundryDryerControls.Cluster.id, TemperatureControl.Cluster.id],
545
987
  });
988
+ /**
989
+ * A Cook Surface device type represents a heating object on a cooktop or other similar device. It
990
+ * SHALL only be used when composed as part of another device type (cooktop).
991
+ *
992
+ * Cluster Restrictions:
993
+ * The OffOnly feature is required for the On/Off cluster in this device type due to safety requirements.
994
+ */
546
995
  export const cookSurface = DeviceTypeDefinition({
547
996
  name: 'MA-cooksurface',
548
997
  code: 0x77,
@@ -551,6 +1000,18 @@ export const cookSurface = DeviceTypeDefinition({
551
1000
  requiredServerClusters: [TemperatureControl.Cluster.id, TemperatureMeasurement.Cluster.id],
552
1001
  optionalServerClusters: [OnOff.Cluster.id],
553
1002
  });
1003
+ /**
1004
+ * A cooktop is a cooking surface that heats food either by transferring currents from an electromagnetic
1005
+ * field located below the glass surface directly to the magnetic induction cookware placed
1006
+ * above or through traditional gas or electric burners.
1007
+ *
1008
+ * Device Type Requirements:
1009
+ * A Cooktop SHALL be composed of zero or more endpoints with the Cook Surface device type as defined by the conformance below.
1010
+ * 0x0077 Cook Surface min 1 O
1011
+ *
1012
+ * Cluster Restrictions:
1013
+ * The OffOnly feature is required for the On/Off cluster in this device type due to safety requirements.
1014
+ */
554
1015
  export const cooktop = DeviceTypeDefinition({
555
1016
  name: 'MA-cooktop',
556
1017
  code: 0x78,
@@ -559,6 +1020,15 @@ export const cooktop = DeviceTypeDefinition({
559
1020
  requiredServerClusters: [OnOff.Cluster.id],
560
1021
  optionalServerClusters: [Identify.Cluster.id],
561
1022
  });
1023
+ /**
1024
+ * An oven represents a device that contains one or more cabinets, and optionally a single cooktop, that are all capable of heating food.
1025
+ * An oven is always defined via endpoint composition.
1026
+ * Conditions:
1027
+ * An Oven SHALL have the Heater condition applied to at least one endpoint containing the Temperature Control Cluster.
1028
+ * Device Type Requirements:
1029
+ * - 0x0071 Temperature Controlled Cabinet min 1
1030
+ * - 0x0078 Cooktop
1031
+ */
562
1032
  export const oven = DeviceTypeDefinition({
563
1033
  name: 'MA-oven',
564
1034
  code: 0x7b,
@@ -567,6 +1037,18 @@ export const oven = DeviceTypeDefinition({
567
1037
  requiredServerClusters: [Identify.Cluster.id],
568
1038
  optionalServerClusters: [],
569
1039
  });
1040
+ /**
1041
+ * An Extractor Hood is a device that is generally installed above a cooking surface in residential kitchens.
1042
+ * Additional device types not listed in this table MAY also be included in device compositions.
1043
+ * Device Type Requirements:
1044
+ * 0x0100+ On/Off Light+ O
1045
+ *
1046
+ *
1047
+ * Element Requirements:
1048
+ * - 0x0202 Fan Control Feature Rocking X
1049
+ * - 0x0202 Fan Control Feature Wind X
1050
+ * - 0x0202 Fan Control Feature AirflowDirection X
1051
+ */
570
1052
  export const extractorHood = DeviceTypeDefinition({
571
1053
  name: 'MA-extractorhood',
572
1054
  code: 0x7a,
@@ -575,6 +1057,12 @@ export const extractorHood = DeviceTypeDefinition({
575
1057
  requiredServerClusters: [FanControl.Cluster.id],
576
1058
  optionalServerClusters: [Identify.Cluster.id, HepaFilterMonitoring.Cluster.id, ActivatedCarbonFilterMonitoring.Cluster.id],
577
1059
  });
1060
+ /**
1061
+ * A Microwave Oven is a device with the primary function of heating foods and beverages using a magnetron.
1062
+ * A Microwave Oven is a device which at a minimum is capable of being started and stopped and of setting a power level.
1063
+ * A Microwave Oven MAY also support additional capabilities via endpoint composition.
1064
+ *
1065
+ */
578
1066
  export const microwaveOven = DeviceTypeDefinition({
579
1067
  name: 'MA-microwaveoven',
580
1068
  code: 0x79,
@@ -583,6 +1071,26 @@ export const microwaveOven = DeviceTypeDefinition({
583
1071
  requiredServerClusters: [OperationalState.Cluster.id, MicrowaveOvenMode.Cluster.id, MicrowaveOvenControl.Cluster.id],
584
1072
  optionalServerClusters: [Identify.Cluster.id, FanControl.Cluster.id],
585
1073
  });
1074
+ // Chapter 14. Energy Device Types
1075
+ /**
1076
+ * An EVSE (Electric Vehicle Supply Equipment) is a device that allows an EV (Electric Vehicle) to be
1077
+ * connected to the mains electricity supply to allow it to be charged (or discharged in case of Vehicle
1078
+ * to Grid / Vehicle to Home applications).
1079
+ *
1080
+ * 14.1.5. Device Type Requirements
1081
+ * An EVSE SHALL be composed of at least one endpoint with device types as defined by the conformance
1082
+ * below. There MAY be more endpoints with other device types existing in the EVSE.
1083
+ * - ID Name Constraint Conformance
1084
+ * - 0x0011 Power Source min 1 M
1085
+ * - 0x0510 Electrical Sensor min 1 M
1086
+ * - 0x050D Device Energy Management min 1 M
1087
+ *
1088
+ * The Electrical Sensor device SHALL include both the Electrical Energy Measurement and Electrical
1089
+ * Power Measurement clusters, measuring the total energy and power of the EVSE.
1090
+ *
1091
+ * The Device Energy Management cluster included in the Device Energy Management device SHALL
1092
+ * support the Power Forecast Reporting (PFR) feature.
1093
+ */
586
1094
  export const evse = DeviceTypeDefinition({
587
1095
  name: 'MA-evse',
588
1096
  code: 0x050c,
@@ -591,6 +1099,39 @@ export const evse = DeviceTypeDefinition({
591
1099
  requiredServerClusters: [EnergyEvse.Cluster.id, EnergyEvseMode.Cluster.id],
592
1100
  optionalServerClusters: [Identify.Cluster.id, TemperatureMeasurement.Cluster.id],
593
1101
  });
1102
+ /**
1103
+ * A water heater is a device that is generally installed in properties to heat water for showers, baths etc.
1104
+ * A Water Heater is always defined via endpoint composition.
1105
+ *
1106
+ * 14.2.5. Device Type Requirements
1107
+ * A Water Heater SHALL be composed of at least one endpoint with device types as defined by the
1108
+ * conformance below. There MAY be more endpoints with other device types existing in the Water Heater.
1109
+ * - ID Name Constraint Conformance
1110
+ * - 0x0011 Power Source O
1111
+ * - 0x0302 Temperature Sensor O
1112
+ * - 0x0510 Electrical Sensor desc
1113
+ * - 0x050D Device Energy Management O
1114
+ *
1115
+ * 14.2.7. Element Requirements
1116
+ * 0x0201 Thermostat Feature Heating M
1117
+ *
1118
+ * The Energy Management feature of the Water Heater cluster SHALL be supported if the Device
1119
+ * Energy Management device type is included.
1120
+ * If Off is a supported SystemMode in the Thermostat cluster, setting the SystemMode of the Thermostat
1121
+ * cluster to Off SHALL set the CurrentMode attribute of the Water Heater Mode cluster to a mode
1122
+ * having the Off mode tag value and vice versa.
1123
+ * At least one entry in the SupportedModes attribute of the Water Heater Mode cluster SHALL
1124
+ * include the Timed mode tag in the ModeTags field list.
1125
+ *
1126
+ * WaterHeaterMode Cluster
1127
+ * 9.6.6.1. SupportedModes Attribute
1128
+ * At least one entry in the SupportedModes attribute SHALL include the Manual mode tag in the
1129
+ * ModeTags field list.
1130
+ * At least one entry in the SupportedModes attribute SHALL include the Off mode tag in the ModeTags
1131
+ * field list.
1132
+ * An entry in the SupportedModes attribute that includes one of an Off, Manual, or Timed tag SHALL
1133
+ * NOT also include an additional instance of any one of these tag types.
1134
+ */
594
1135
  export const waterHeater = DeviceTypeDefinition({
595
1136
  name: 'MA-waterheater',
596
1137
  code: 0x050f,
@@ -599,27 +1140,99 @@ export const waterHeater = DeviceTypeDefinition({
599
1140
  requiredServerClusters: [Thermostat.Cluster.id, WaterHeaterManagement.Cluster.id, WaterHeaterMode.Cluster.id],
600
1141
  optionalServerClusters: [Identify.Cluster.id],
601
1142
  });
1143
+ /**
1144
+ * A Solar Power device is a device that allows a solar panel array, which can optionally be comprised
1145
+ * of a set parallel strings of solar panels, and its associated controller and, if appropriate, inverter, to
1146
+ * be monitored and controlled by an Energy Management System.
1147
+ *
1148
+ * 14.3.5. Device Type Requirements
1149
+ * A Solar Power device SHALL be composed of at least one endpoint with device types as defined by
1150
+ * the conformance below. There MAY be more endpoints with additional instances of these device
1151
+ * types or additional device types existing in the Solar Power device.
1152
+ *
1153
+ * - ID Name Constraint Conformance
1154
+ * - 0x0011 Power Source min 1 M
1155
+ * - 0x0510 Electrical Sensor min 1 M
1156
+ * - 0x050D Device Energy Management O
1157
+ * - 0x0302 Temperature Sensor O
1158
+ *
1159
+ * 14.3.5.1. Cluster Requirements on Composing Device Types
1160
+ *
1161
+ * - 0x0011 Power Source 0x002F Power Source Feature Wired M
1162
+ * - 0x0011 Power Source 0x001D Descriptor Feature TagList M
1163
+ * - 0x0510 Electrical Sensor 0x0090 Electrical Power Measurement M
1164
+ * - 0x0510 Electrical Sensor 0x0090 Electrical Power Measurement Attribute Voltage M
1165
+ * - 0x0510 Electrical Sensor 0x0090 Electrical Power Measurement Attribute ActiveCurrent M
1166
+ * - 0x0510 Electrical Sensor 0x0091 Electrical Energy Measurement M
1167
+ * - 0x0510 Electrical Sensor 0x0091 Electrical Energy Measurement Feature ExportedEnergy M
1168
+ * - 0x050D Device Energy Management 0x0098 Device Energy Management Feature PowerAdjustment M
1169
+ * - 0x0302 Temperature Sensor 0x001D Descriptor Feature TagList M
1170
+ */
602
1171
  export const solarPower = DeviceTypeDefinition({
603
1172
  name: 'MA-solarpower',
604
1173
  code: 0x0017,
605
1174
  deviceClass: DeviceClasses.Simple,
606
1175
  revision: 1,
607
- requiredServerClusters: [],
1176
+ requiredServerClusters: [], // See 14.3.5.1. Cluster Requirements on Composing Device Types
608
1177
  optionalServerClusters: [Identify.Cluster.id],
609
1178
  });
1179
+ /**
1180
+ * A Battery Storage device is a device that allows a DC battery, which can optionally be comprised of
1181
+ * a set parallel strings of battery packs and associated controller, and an AC inverter, to be monitored
1182
+ * and controlled by an Energy Management System in order to manage the peaks and troughs of supply
1183
+ * and demand, and/or to optimize cost of the energy consumed in premises. It is not intended to
1184
+ * be used for a UPS directly supplying a set of appliances, nor for portable battery storage devices.
1185
+ *
1186
+ * 14.4.5. Device Type Requirements
1187
+ * A Battery Storage device SHALL be composed of at least one endpoint with device types as defined by
1188
+ * the conformance below. There MAY be more endpoints with additional instances of these device
1189
+ * types or additional device types existing in the Battery Storage device.
1190
+ * - ID Name Constraint Conformance
1191
+ * - 0x0011 Power Source min 1 M
1192
+ * - 0x0510 Electrical Sensor min 1 M
1193
+ * - 0x050D Device Energy Management M
1194
+ * - 0x0302 Temperature Sensor O
1195
+ * - 0x0017 Solar Power O
1196
+ *
1197
+ * See 14.4.5.1. Cluster Requirements on Composing Device Types
1198
+ */
610
1199
  export const batteryStorage = DeviceTypeDefinition({
611
1200
  name: 'MA-batterystorage',
612
1201
  code: 0x0018,
613
1202
  deviceClass: DeviceClasses.Simple,
614
1203
  revision: 1,
615
- requiredServerClusters: [],
1204
+ requiredServerClusters: [], // See 14.4.5.1. Cluster Requirements on Composing Device Types
616
1205
  optionalServerClusters: [Identify.Cluster.id],
617
1206
  });
1207
+ /**
1208
+ * A Heat Pump device is a device that uses electrical energy to heat either spaces or water tanks using
1209
+ * ground, water or air as the heat source. These typically can heat the air or can pump water via central
1210
+ * heating radiators or underfloor heating systems. It is typical to also heat hot water and store
1211
+ * the heat in a hot water tank.
1212
+ *
1213
+ * 14.5.1. Heat Pump Architecture
1214
+ * A Heat Pump device is always defined via endpoint composition.
1215
+ *
1216
+ * 14.5.5. Device Type Requirements
1217
+ * A Heat Pump device SHALL be composed of at least one endpoint with device types as defined by
1218
+ * the conformance below. There MAY be more endpoints with additional instances of these device
1219
+ * types or additional device types existing in the Heat Pump device.
1220
+ * - ID Name Constraint Conformance
1221
+ * - 0x0011 Power Source M
1222
+ * - 0x0510 Electrical Sensor min 1 M
1223
+ * - 0x050D Device Energy Management M
1224
+ * - 0x0301 Thermostat O
1225
+ * - 0x050f Water Heater O
1226
+ * - 0x0302 Temperature Sensor O
1227
+ *
1228
+ * See 14.5.5.1. Cluster Requirements on Composing Device Types
1229
+ */
618
1230
  export const heatPump = DeviceTypeDefinition({
619
1231
  name: 'MA-heatpump',
620
1232
  code: 0x0309,
621
1233
  deviceClass: DeviceClasses.Simple,
622
1234
  revision: 1,
623
- requiredServerClusters: [],
1235
+ requiredServerClusters: [], // See 14.5.5.1. Cluster Requirements on Composing Device Types
624
1236
  optionalServerClusters: [Identify.Cluster.id, Thermostat.Cluster.id],
625
1237
  });
1238
+ //# sourceMappingURL=matterbridgeDeviceTypes.js.map