matterbridge 3.3.7-dev-20251109-a306ab9 → 3.3.7

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