matterbridge 3.2.6-dev-20250906-4b022a0 → 3.2.6

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 (279) hide show
  1. package/CHANGELOG.md +3 -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 +83 -0
  83. package/dist/devices/speaker.d.ts.map +1 -0
  84. package/dist/devices/speaker.js +80 -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 +313 -0
  123. package/dist/frontend.d.ts.map +1 -0
  124. package/dist/frontend.js +450 -24
  125. package/dist/frontend.js.map +1 -0
  126. package/dist/globalMatterbridge.d.ts +59 -0
  127. package/dist/globalMatterbridge.d.ts.map +1 -0
  128. package/dist/globalMatterbridge.js +47 -0
  129. package/dist/globalMatterbridge.js.map +1 -0
  130. package/dist/helpers.d.ts +48 -0
  131. package/dist/helpers.d.ts.map +1 -0
  132. package/dist/helpers.js +53 -0
  133. package/dist/helpers.js.map +1 -0
  134. package/dist/index.d.ts +33 -0
  135. package/dist/index.d.ts.map +1 -0
  136. package/dist/index.js +30 -1
  137. package/dist/index.js.map +1 -0
  138. package/dist/jest-utils/jestHelpers.d.ts +103 -0
  139. package/dist/jest-utils/jestHelpers.d.ts.map +1 -0
  140. package/dist/jest-utils/jestHelpers.js +124 -2
  141. package/dist/jest-utils/jestHelpers.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 +457 -0
  171. package/dist/matterbridge.d.ts.map +1 -0
  172. package/dist/matterbridge.js +821 -90
  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 +1351 -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 +1438 -0
  191. package/dist/matterbridgeEndpoint.d.ts.map +1 -0
  192. package/dist/matterbridgeEndpoint.js +1301 -54
  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 +379 -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 +198 -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/network.d.ts +84 -0
  267. package/dist/utils/network.d.ts.map +1 -0
  268. package/dist/utils/network.js +91 -5
  269. package/dist/utils/network.js.map +1 -0
  270. package/dist/utils/spawn.d.ts +33 -0
  271. package/dist/utils/spawn.d.ts.map +1 -0
  272. package/dist/utils/spawn.js +40 -0
  273. package/dist/utils/spawn.js.map +1 -0
  274. package/dist/utils/wait.d.ts +54 -0
  275. package/dist/utils/wait.d.ts.map +1 -0
  276. package/dist/utils/wait.js +60 -8
  277. package/dist/utils/wait.js.map +1 -0
  278. package/npm-shrinkwrap.json +2 -2
  279. package/package.json +2 -1
@@ -1,5 +1,30 @@
1
+ /**
2
+ * This file contains the class MatterbridgeEndpoint that extends the Endpoint class from the Matter.js library.
3
+ *
4
+ * @file matterbridgeEndpoint.ts
5
+ * @author Luca Liguori
6
+ * @created 2024-10-01
7
+ * @version 2.1.1
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 { Endpoint, Lifecycle, MutableEndpoint, NamedHandler, SupportedBehaviors, UINT16_MAX, UINT32_MAX, VendorId } from '@matter/main';
2
26
  import { getClusterNameById, MeasurementType } from '@matter/main/types';
27
+ // @matter clusters
3
28
  import { Descriptor } from '@matter/main/clusters/descriptor';
4
29
  import { PowerSource } from '@matter/main/clusters/power-source';
5
30
  import { BridgedDeviceBasicInformation } from '@matter/main/clusters/bridged-device-basic-information';
@@ -26,6 +51,7 @@ import { ThermostatUserInterfaceConfiguration } from '@matter/main/clusters/ther
26
51
  import { OperationalState } from '@matter/main/clusters/operational-state';
27
52
  import { DeviceEnergyManagement } from '@matter/main/clusters/device-energy-management';
28
53
  import { DeviceEnergyManagementMode } from '@matter/main/clusters/device-energy-management-mode';
54
+ // @matter behaviors
29
55
  import { DescriptorServer } from '@matter/main/behaviors/descriptor';
30
56
  import { PowerSourceServer } from '@matter/main/behaviors/power-source';
31
57
  import { BridgedDeviceBasicInformationServer } from '@matter/main/behaviors/bridged-device-basic-information';
@@ -57,16 +83,35 @@ import { TotalVolatileOrganicCompoundsConcentrationMeasurementServer } from '@ma
57
83
  import { FanControlServer } from '@matter/main/behaviors/fan-control';
58
84
  import { ResourceMonitoring } from '@matter/main/clusters/resource-monitoring';
59
85
  import { ThermostatUserInterfaceConfigurationServer } from '@matter/main/behaviors/thermostat-user-interface-configuration';
86
+ // AnsiLogger module
60
87
  import { AnsiLogger, CYAN, YELLOW, db, debugStringify, hk, or, zb } from './logger/export.js';
61
88
  import { isValidNumber, isValidObject, isValidString } from './utils/export.js';
62
89
  import { MatterbridgeServer, MatterbridgeIdentifyServer, MatterbridgeOnOffServer, MatterbridgeLevelControlServer, MatterbridgeColorControlServer, MatterbridgeLiftWindowCoveringServer, MatterbridgeLiftTiltWindowCoveringServer, MatterbridgeThermostatServer, MatterbridgeFanControlServer, MatterbridgeDoorLockServer, MatterbridgeModeSelectServer, MatterbridgeValveConfigurationAndControlServer, MatterbridgeSmokeCoAlarmServer, MatterbridgeBooleanStateConfigurationServer, MatterbridgeSwitchServer, MatterbridgeOperationalStateServer, MatterbridgeDeviceEnergyManagementModeServer, MatterbridgeDeviceEnergyManagementServer, MatterbridgeActivatedCarbonFilterMonitoringServer, MatterbridgeHepaFilterMonitoringServer, } from './matterbridgeBehaviors.js';
63
90
  import { addClusterServers, addFixedLabel, addOptionalClusterServers, addRequiredClusterServers, addUserLabel, createUniqueId, getBehavior, getBehaviourTypesFromClusterClientIds, getBehaviourTypesFromClusterServerIds, getDefaultOperationalStateClusterServer, getDefaultFlowMeasurementClusterServer, getDefaultIlluminanceMeasurementClusterServer, getDefaultPressureMeasurementClusterServer, getDefaultRelativeHumidityMeasurementClusterServer, getDefaultTemperatureMeasurementClusterServer, getDefaultOccupancySensingClusterServer, lowercaseFirstLetter, updateAttribute, getClusterId, getAttributeId, setAttribute, getAttribute, checkNotLatinCharacters, generateUniqueId, subscribeAttribute, invokeBehaviorCommand, triggerEvent, featuresFor, } from './matterbridgeEndpointHelpers.js';
64
91
  export class MatterbridgeEndpoint extends Endpoint {
65
- static logLevel = "info";
92
+ /** The default log level of the new MatterbridgeEndpoints */
93
+ static logLevel = "info" /* LogLevel.INFO */;
94
+ /**
95
+ * Activates a special mode for this endpoint.
96
+ * - 'server': it creates the device server node and add the device as Matter device that needs to be paired individually.
97
+ * In this case the bridge mode is not relevant. The device is autonomous. The main use case is a workaround for the Apple Home rvc issue.
98
+ *
99
+ * - 'matter': it adds the device directly to the bridge server node as Matter device. In this case the implementation must respect
100
+ * the 9.2.3. Disambiguation rule (i.e. use taglist if needed cause the device doesn't have nodeLabel).
101
+ * Furthermore the device will be a part of the bridge (i.e. will have the same name and will be in the same room).
102
+ * See 9.12.2.2. Native Matter functionality in Bridge.
103
+ *
104
+ * @remarks
105
+ * Always use createDefaultBasicInformationClusterServer() to create the BasicInformation cluster server.
106
+ */
66
107
  mode = undefined;
108
+ /** The server node of the endpoint, if it is a single not bridged endpoint */
67
109
  serverNode;
110
+ /** The logger instance for the MatterbridgeEndpoint */
68
111
  log;
112
+ /** The plugin name this MatterbridgeEndpoint belongs to */
69
113
  plugin = undefined;
114
+ /** The configuration URL of the device, if available */
70
115
  configUrl = undefined;
71
116
  deviceName = undefined;
72
117
  serialNumber = undefined;
@@ -80,14 +125,28 @@ export class MatterbridgeEndpoint extends Endpoint {
80
125
  hardwareVersion = undefined;
81
126
  hardwareVersionString = undefined;
82
127
  productUrl = 'https://www.npmjs.com/package/matterbridge';
128
+ /** The name of the first device type of the endpoint (old api compatibility) */
83
129
  name = undefined;
130
+ /** The code of the first device type of the endpoint (old api compatibility) */
84
131
  deviceType = undefined;
132
+ /** The original id (with spaces and .) of the endpoint (old api compatibility) */
85
133
  uniqueStorageKey = undefined;
86
134
  tagList = undefined;
135
+ /** Maps the DeviceTypeDefinitions with their code */
87
136
  deviceTypes = new Map();
137
+ /** Command handler for the MatterbridgeEndpoint commands */
88
138
  commandHandler = new NamedHandler();
139
+ /**
140
+ * Represents a MatterbridgeEndpoint.
141
+ *
142
+ * @class MatterbridgeEndpoint
143
+ * @param {DeviceTypeDefinition | AtLeastOne<DeviceTypeDefinition>} definition - The DeviceTypeDefinition(s) of the endpoint.
144
+ * @param {MatterbridgeEndpointOptions} [options] - The options for the device.
145
+ * @param {boolean} [debug] - Debug flag.
146
+ */
89
147
  constructor(definition, options = {}, debug = false) {
90
148
  let deviceTypeList = [];
149
+ // Get the first DeviceTypeDefinition
91
150
  let firstDefinition;
92
151
  if (Array.isArray(definition)) {
93
152
  firstDefinition = definition[0];
@@ -100,6 +159,7 @@ export class MatterbridgeEndpoint extends Endpoint {
100
159
  firstDefinition = definition;
101
160
  deviceTypeList = [{ deviceType: firstDefinition.code, revision: firstDefinition.revision }];
102
161
  }
162
+ // Convert the first DeviceTypeDefinition to an EndpointType.Options
103
163
  const deviceTypeDefinitionV8 = {
104
164
  name: firstDefinition.name.replace('-', '_'),
105
165
  deviceType: firstDefinition.code,
@@ -118,17 +178,20 @@ export class MatterbridgeEndpoint extends Endpoint {
118
178
  behaviors: options.tagList ? SupportedBehaviors(DescriptorServer.with(Descriptor.Feature.TagList)) : SupportedBehaviors(DescriptorServer),
119
179
  };
120
180
  const endpointV8 = MutableEndpoint(deviceTypeDefinitionV8);
181
+ // Check if the uniqueStorageKey is valid
121
182
  if (options.uniqueStorageKey && checkNotLatinCharacters(options.uniqueStorageKey)) {
122
183
  options.uniqueStorageKey = generateUniqueId(options.uniqueStorageKey);
123
184
  }
124
185
  if (options.id && checkNotLatinCharacters(options.id)) {
125
186
  options.id = generateUniqueId(options.id);
126
187
  }
188
+ // Convert the options to an Endpoint.Options
127
189
  const optionsV8 = {
128
190
  id: options.uniqueStorageKey?.replace(/[ .]/g, ''),
129
191
  number: options.endpointId,
130
192
  descriptor: options.tagList ? { tagList: options.tagList, deviceTypeList } : { deviceTypeList },
131
193
  };
194
+ // Override the deprecated uniqueStorageKey && endpointId with id and number if provided
132
195
  if (options.id !== undefined) {
133
196
  optionsV8.id = options.id.replace(/[ .]/g, '');
134
197
  }
@@ -148,16 +211,53 @@ export class MatterbridgeEndpoint extends Endpoint {
148
211
  }
149
212
  else
150
213
  this.deviceTypes.set(firstDefinition.code, firstDefinition);
151
- this.log = new AnsiLogger({ logName: options.uniqueStorageKey ?? 'MatterbridgeEndpoint', logTimestampFormat: 4, logLevel: debug === true ? "debug" : MatterbridgeEndpoint.logLevel });
214
+ // console.log('MatterbridgeEndpoint.option', options);
215
+ // console.log('MatterbridgeEndpoint.endpointV8', endpointV8);
216
+ // console.log('MatterbridgeEndpoint.optionsV8', optionsV8);
217
+ // Create the logger
218
+ this.log = new AnsiLogger({ logName: options.uniqueStorageKey ?? 'MatterbridgeEndpoint', logTimestampFormat: 4 /* TimestampFormat.TIME_MILLIS */, logLevel: debug === true ? "debug" /* LogLevel.DEBUG */ : MatterbridgeEndpoint.logLevel });
152
219
  this.log.debug(`${YELLOW}new${db} MatterbridgeEndpoint: ${zb}${'0x' + firstDefinition.code.toString(16).padStart(4, '0')}${db}-${zb}${firstDefinition.name}${db} mode: ${CYAN}${this.mode}${db} id: ${CYAN}${optionsV8.id}${db} number: ${CYAN}${optionsV8.number}${db} taglist: ${CYAN}${options.tagList ? debugStringify(options.tagList) : 'undefined'}${db}`);
220
+ // Add MatterbridgeServer
153
221
  this.behaviors.require(MatterbridgeServer, { log: this.log, commandHandler: this.commandHandler });
154
222
  }
223
+ /**
224
+ * Loads an instance of the MatterbridgeEndpoint class.
225
+ *
226
+ * @param {DeviceTypeDefinition | AtLeastOne<DeviceTypeDefinition>} definition - The DeviceTypeDefinition(s) of the device.
227
+ * @param {MatterbridgeEndpointOptions} [options] - The options for the device.
228
+ * @param {boolean} [debug] - Debug flag.
229
+ * @returns {Promise<MatterbridgeEndpoint>} MatterbridgeEndpoint instance.
230
+ */
155
231
  static async loadInstance(definition, options = {}, debug = false) {
156
232
  return new MatterbridgeEndpoint(definition, options, debug);
157
233
  }
234
+ /**
235
+ * Get all the device types of this endpoint.
236
+ *
237
+ * @returns {DeviceTypeDefinition[]} The device types of this endpoint.
238
+ */
158
239
  getDeviceTypes() {
159
240
  return Array.from(this.deviceTypes.values());
160
241
  }
242
+ /**
243
+ * Checks if the provided cluster server is supported by this endpoint.
244
+ *
245
+ * @param {Behavior.Type | ClusterType | ClusterId | string} cluster - The cluster to check.
246
+ * @returns {boolean} True if the cluster server is supported, false otherwise.
247
+ *
248
+ * @example
249
+ *
250
+ * The following examples are all valid ways to check if the 'OnOff' cluster server is supported by the endpoint:
251
+ * ```typescript
252
+ * if(device.hasClusterServer(OnOffBehavior)) ...
253
+ * if(device.hasClusterServer(OnOffServer)) ...
254
+ * if(device.hasClusterServer(OnOffCluster)) ...
255
+ * if(device.hasClusterServer(OnOff.Cluster)) ...
256
+ * if(device.hasClusterServer(OnOff.Cluster.id)) ...
257
+ * if(device.hasClusterServer('OnOff')) ...
258
+ * ```
259
+ * The last has the advantage of being able to check for clusters without imports. Just use the name found in the Matter specs.
260
+ */
161
261
  hasClusterServer(cluster) {
162
262
  const behavior = getBehavior(this, cluster);
163
263
  if (behavior)
@@ -165,6 +265,26 @@ export class MatterbridgeEndpoint extends Endpoint {
165
265
  else
166
266
  return false;
167
267
  }
268
+ /**
269
+ * Checks if the provided attribute server is supported for a given cluster of this endpoint.
270
+ *
271
+ * @param {Behavior.Type | ClusterType | ClusterId | string} cluster - The cluster to check.
272
+ * @param {string} attribute - The attribute name to check.
273
+ * @returns {boolean} True if the attribute server is supported, false otherwise.
274
+ *
275
+ * @example
276
+ *
277
+ * The following examples are all valid ways to check if the 'onOff' attribute of the 'OnOff' cluster server is supported by the endpoint:
278
+ * ```typescript
279
+ * if(device.hasAttributeServer(OnOffBehavior, 'onOff')) ...
280
+ * if(device.hasAttributeServer(OnOffServer, 'onOff')) ...
281
+ * if(device.hasAttributeServer(OnOffCluster, 'onOff')) ...
282
+ * if(device.hasAttributeServer(OnOff.Cluster, 'onOff')) ...
283
+ * if(device.hasAttributeServer(OnOff.Cluster.id, 'onOff')) ...
284
+ * if(device.hasAttributeServer('OnOff', 'onOff')) ...
285
+ * ```
286
+ * The last has the advantage of being able to check for clusters attributes without imports. Just use the names found in the Matter specs.
287
+ */
168
288
  hasAttributeServer(cluster, attribute) {
169
289
  const behavior = getBehavior(this, cluster);
170
290
  if (!behavior || !this.behaviors.supported[behavior.id])
@@ -173,82 +293,279 @@ export class MatterbridgeEndpoint extends Endpoint {
173
293
  const defaults = this.behaviors.defaultsFor(behavior);
174
294
  return lowercaseFirstLetter(attribute) in options || lowercaseFirstLetter(attribute) in defaults;
175
295
  }
296
+ /**
297
+ * Retrieves the initial options for the provided cluster server.
298
+ *
299
+ * @param {Behavior.Type | ClusterType | ClusterId | string} cluster - The cluster to get options for.
300
+ * @returns {Record<string, boolean | number | bigint | string | object | null> | undefined} The options for the provided cluster server, or undefined if the cluster is not supported.
301
+ */
176
302
  getClusterServerOptions(cluster) {
177
303
  const behavior = getBehavior(this, cluster);
178
304
  if (!behavior)
179
305
  return undefined;
180
306
  return this.behaviors.optionsFor(behavior);
181
307
  }
308
+ /**
309
+ * Retrieves the value of the provided attribute from the given cluster.
310
+ *
311
+ * @param {Behavior.Type | ClusterType | ClusterId | string} cluster - The cluster to retrieve the attribute from.
312
+ * @param {string} attribute - The name of the attribute to retrieve.
313
+ * @param {AnsiLogger} [log] - Optional logger for error and info messages.
314
+ * @returns {any} The value of the attribute, or undefined if the attribute is not found.
315
+ *
316
+ * @example
317
+ *
318
+ * The following examples are all valid ways to retrieve the 'onOff' attribute of the 'OnOff' cluster server:
319
+ * ```typescript
320
+ * device.getAttribute(OnOffBehavior, 'onOff')
321
+ * device.getAttribute(OnOffServer, 'onOff')
322
+ * device.getAttribute(OnOffCluster, 'onOff')
323
+ * device.getAttribute(OnOff.Cluster, 'onOff')
324
+ * device.getAttribute(OnOff.Cluster.id, 'onOff')
325
+ * device.getAttribute('OnOff', 'onOff')
326
+ * ```
327
+ * The last has the advantage of being able to retrieve cluster attributes without imports. Just use the names found in the Matter specs.
328
+ */
329
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
182
330
  getAttribute(cluster, attribute, log) {
183
331
  return getAttribute(this, cluster, attribute, log);
184
332
  }
333
+ /**
334
+ * Sets the value of an attribute on a cluster server.
335
+ *
336
+ * @param {Behavior.Type | ClusterType | ClusterId | string} clusterId - The ID of the cluster.
337
+ * @param {string} attribute - The name of the attribute.
338
+ * @param {boolean | number | bigint | string | object | null} value - The value to set for the attribute.
339
+ * @param {AnsiLogger} [log] - (Optional) The logger to use for logging errors and information.
340
+ * @returns {Promise<boolean>} - A promise that resolves to a boolean indicating whether the attribute was successfully set.
341
+ *
342
+ * @example
343
+ *
344
+ * The following examples are all valid ways to set the 'onOff' attribute of the 'OnOff' cluster server:
345
+ * ```typescript
346
+ * await device.setAttribute(OnOffBehavior, 'onOff', true)
347
+ * await device.setAttribute(OnOffServer, 'onOff', true)
348
+ * await device.setAttribute(OnOffCluster, 'onOff', true)
349
+ * await device.setAttribute(OnOff.Cluster, 'onOff', true)
350
+ * await device.setAttribute(OnOff.Cluster.id, 'onOff', true)
351
+ * await device.setAttribute('OnOff', 'onOff', true)
352
+ * ```
353
+ * The last has the advantage of being able to set cluster attributes without imports. Just use the names found in the Matter specs.
354
+ */
185
355
  async setAttribute(clusterId, attribute, value, log) {
186
356
  return await setAttribute(this, clusterId, attribute, value, log);
187
357
  }
358
+ /**
359
+ * Update the value of an attribute on a cluster server only if the value is different.
360
+ *
361
+ * @param {Behavior.Type | ClusterType | ClusterId | string} cluster - The cluster to set the attribute on.
362
+ * @param {string} attribute - The name of the attribute.
363
+ * @param {boolean | number | bigint | string | object | null} value - The value to set for the attribute.
364
+ * @param {AnsiLogger} [log] - (Optional) The logger to use for logging the update. Errors are logged to the endpoint logger.
365
+ * @returns {Promise<boolean>} - A promise that resolves to a boolean indicating whether the attribute was successfully set.
366
+ *
367
+ * @example
368
+ *
369
+ * The following examples are all valid ways to update the 'onOff' attribute of the 'OnOff' cluster server:
370
+ * ```typescript
371
+ * await device.updateAttribute(OnOffBehavior, 'onOff', true)
372
+ * await device.updateAttribute(OnOffServer, 'onOff', true)
373
+ * await device.updateAttribute(OnOffCluster, 'onOff', true)
374
+ * await device.updateAttribute(OnOff.Cluster, 'onOff', true)
375
+ * await device.updateAttribute(OnOff.Cluster.id, 'onOff', true)
376
+ * await device.updateAttribute('OnOff', 'onOff', true)
377
+ * ```
378
+ * The last has the advantage of being able to update cluster attributes without imports. Just use the names found in the Matter specs.
379
+ */
188
380
  async updateAttribute(cluster, attribute, value, log) {
189
381
  return await updateAttribute(this, cluster, attribute, value, log);
190
382
  }
383
+ /**
384
+ * Subscribes to the provided attribute on a cluster.
385
+ *
386
+ * @param {Behavior.Type | ClusterType | ClusterId | string} cluster - The cluster to subscribe the attribute to.
387
+ * @param {string} attribute - The name of the attribute to subscribe to.
388
+ * @param {(newValue: any, oldValue: any, context: ActionContext) => void} listener - A callback function that will be called when the attribute value changes. When context.offline === true then the change is locally generated and not from the controller.
389
+ * @param {AnsiLogger} [log] - Optional logger for logging errors and information.
390
+ * @returns {Promise<boolean>} - A boolean indicating whether the subscription was successful.
391
+ *
392
+ * @remarks
393
+ * The listener function (cannot be async!) will receive three parameters:
394
+ * - `newValue`: The new value of the attribute.
395
+ * - `oldValue`: The old value of the attribute.
396
+ * - `context`: The action context, which includes information about the action that triggered the change. When context.offline === true then the change is locally generated and not from the controller.
397
+ */
398
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
191
399
  async subscribeAttribute(cluster, attribute, listener, log) {
192
400
  return await subscribeAttribute(this, cluster, attribute, listener, log);
193
401
  }
402
+ /**
403
+ * Triggers an event on the specified cluster.
404
+ *
405
+ * @param {ClusterId} cluster - The ID of the cluster.
406
+ * @param {string} event - The name of the event to trigger.
407
+ * @param {Record<string, boolean | number | bigint | string | object | undefined | null>} payload - The payload to pass to the event.
408
+ * @param {AnsiLogger} [log] - Optional logger for logging information.
409
+ * @returns {Promise<boolean>} - A promise that resolves to a boolean indicating whether the event was successfully triggered.
410
+ */
194
411
  async triggerEvent(cluster, event, payload, log) {
195
412
  return await triggerEvent(this, cluster, event, payload, log);
196
413
  }
414
+ /**
415
+ * Adds cluster servers from the provided server list.
416
+ *
417
+ * @param {ClusterId[]} serverList - The list of cluster IDs to add.
418
+ * @returns {this} The current MatterbridgeEndpoint instance for chaining.
419
+ */
197
420
  addClusterServers(serverList) {
198
421
  addClusterServers(this, serverList);
199
422
  return this;
200
423
  }
424
+ /**
425
+ * Adds a fixed label to the FixedLabel cluster. If the cluster server is not present, it will be added.
426
+ *
427
+ * @param {string} label - The label to add.
428
+ * @param {string} value - The value of the label.
429
+ * @returns {Promise<this>} The current MatterbridgeEndpoint instance for chaining.
430
+ */
201
431
  async addFixedLabel(label, value) {
202
432
  await addFixedLabel(this, label, value);
203
433
  return this;
204
434
  }
435
+ /**
436
+ * Adds a user label to the UserLabel cluster. If the cluster server is not present, it will be added.
437
+ *
438
+ * @param {string} label - The label to add.
439
+ * @param {string} value - The value of the label.
440
+ * @returns {Promise<this>} The current MatterbridgeEndpoint instance for chaining.
441
+ */
205
442
  async addUserLabel(label, value) {
206
443
  await addUserLabel(this, label, value);
207
444
  return this;
208
445
  }
446
+ /**
447
+ * Adds a command handler for the specified command.
448
+ *
449
+ * @param {keyof MatterbridgeEndpointCommands} command - The command to add the handler for.
450
+ * @param {CommandHandlerFunction} handler - The handler function to execute when the command is received.
451
+ * @returns {this} The current MatterbridgeEndpoint instance for chaining.
452
+ *
453
+ * @remarks
454
+ * The handler function will receive an object with the following properties:
455
+ * - `request`: The request object sent with the command.
456
+ * - `cluster`: The id of the cluster that received the command (i.e. "onOff").
457
+ * - `attributes`: The current attributes of the cluster that received the command (i.e. { onOff: true}).
458
+ * - `endpoint`: The MatterbridgeEndpoint instance that received the command.
459
+ */
209
460
  addCommandHandler(command, handler) {
210
461
  this.commandHandler.addHandler(command, handler);
211
462
  return this;
212
463
  }
464
+ /**
465
+ * Execute the command handler for the specified command. Used ONLY in Jest tests.
466
+ *
467
+ * @param {keyof MatterbridgeEndpointCommands} command - The command to execute.
468
+ * @param {Record<string, boolean | number | bigint | string | object | null>} [request] - The optional request to pass to the handler function.
469
+ * @param {string} [cluster] - The optional cluster to pass to the handler function.
470
+ * @param {Record<string, boolean | number | bigint | string | object | null>} [attributes] - The optional attributes to pass to the handler function.
471
+ * @param {MatterbridgeEndpoint} [endpoint] - The optional MatterbridgeEndpoint instance to pass to the handler function
472
+ *
473
+ * @deprecated Used ONLY in Jest tests.
474
+ */
213
475
  async executeCommandHandler(command, request, cluster, attributes, endpoint) {
214
476
  await this.commandHandler.executeHandler(command, { request, cluster, attributes, endpoint });
215
477
  }
478
+ /**
479
+ * Invokes a behavior command on the specified cluster. Used ONLY in Jest tests.
480
+ *
481
+ * @param {Behavior.Type | ClusterType | ClusterId | string} cluster - The cluster to invoke the command on.
482
+ * @param {string} command - The command to invoke.
483
+ * @param {Record<string, boolean | number | bigint | string | object | null>} [params] - The optional parameters to pass to the command.
484
+ *
485
+ * @deprecated Used ONLY in Jest tests.
486
+ */
216
487
  async invokeBehaviorCommand(cluster, command, params) {
217
488
  await invokeBehaviorCommand(this, cluster, command, params);
218
489
  }
490
+ /**
491
+ * Adds the required cluster servers (only if they are not present) for the device types of the specified endpoint.
492
+ *
493
+ * @returns {this} The current MatterbridgeEndpoint instance for chaining.
494
+ */
219
495
  addRequiredClusterServers() {
220
496
  addRequiredClusterServers(this);
221
497
  return this;
222
498
  }
499
+ /**
500
+ * Adds the optional cluster servers (only if they are not present) for the device types of the specified endpoint.
501
+ *
502
+ * @returns {this} The current MatterbridgeEndpoint instance for chaining.
503
+ */
223
504
  addOptionalClusterServers() {
224
505
  addOptionalClusterServers(this);
225
506
  return this;
226
507
  }
508
+ /**
509
+ * Retrieves all cluster servers.
510
+ *
511
+ * @returns {Behavior.Type[]} An array of all cluster servers.
512
+ */
227
513
  getAllClusterServers() {
228
514
  return Object.values(this.behaviors.supported);
229
515
  }
516
+ /**
517
+ * Retrieves the names of all cluster servers.
518
+ *
519
+ * @returns {string[]} An array of all cluster server names.
520
+ */
230
521
  getAllClusterServerNames() {
231
522
  return Object.keys(this.behaviors.supported);
232
523
  }
524
+ /**
525
+ * Iterates over each attribute of each cluster server of the device state and calls the provided callback function.
526
+ *
527
+ * @param {Function} callback - The callback function to call with the cluster name, cluster id, attribute name, attribute id and attribute value.
528
+ */
233
529
  forEachAttribute(callback) {
234
530
  if (!this.lifecycle.isReady || this.construction.status !== Lifecycle.Status.Active)
235
531
  return;
236
532
  for (const [clusterName, clusterAttributes] of Object.entries(this.state)) {
533
+ // Skip if the key / cluster name is a number, cause they are double indexed.
237
534
  if (!isNaN(Number(clusterName)))
238
535
  continue;
239
536
  for (const [attributeName, attributeValue] of Object.entries(clusterAttributes)) {
537
+ // Skip if the behavior has no associated cluster (i.e. matterbridge server)
240
538
  const clusterId = getClusterId(this, clusterName);
241
539
  if (clusterId === undefined) {
540
+ // this.log.debug(`***forEachAttribute: cluster ${clusterName} not found`);
242
541
  continue;
243
542
  }
543
+ // Skip if the attribute is not present in the ClusterBehavior.Type. Also skip if the attribute it is an internal state.
244
544
  const attributeId = getAttributeId(this, clusterName, attributeName);
245
545
  if (attributeId === undefined) {
546
+ // this.log.debug(`***forEachAttribute: attribute ${clusterName}.${attributeName} not found`);
246
547
  continue;
247
548
  }
248
549
  callback(clusterName, clusterId, attributeName, attributeId, attributeValue);
249
550
  }
250
551
  }
251
552
  }
553
+ /**
554
+ * Adds a child endpoint with the specified device types and options.
555
+ * If the child endpoint is not already present, it will be created and added.
556
+ * If the child endpoint is already present, the existing child endpoint will be returned.
557
+ *
558
+ * @param {string} endpointName - The name of the new endpoint to add.
559
+ * @param {DeviceTypeDefinition | AtLeastOne<DeviceTypeDefinition>} definition - The device types to add.
560
+ * @param {MatterbridgeEndpointOptions} [options] - The options for the endpoint.
561
+ * @param {boolean} [debug] - Whether to enable debug logging.
562
+ * @returns {MatterbridgeEndpoint} - The child endpoint that was found or added.
563
+ *
564
+ * @example
565
+ * ```typescript
566
+ * const endpoint = device.addChildDeviceType('Temperature', [temperatureSensor], { tagList: [{ mfgCode: null, namespaceId: LocationTag.Indoor.namespaceId, tag: LocationTag.Indoor.tag, label: null }] }, true);
567
+ * ```
568
+ */
252
569
  addChildDeviceType(endpointName, definition, options = {}, debug = false) {
253
570
  this.log.debug(`addChildDeviceType: ${CYAN}${endpointName}${db}`);
254
571
  let alreadyAdded = false;
@@ -288,6 +605,23 @@ export class MatterbridgeEndpoint extends Endpoint {
288
605
  }
289
606
  return child;
290
607
  }
608
+ /**
609
+ * Adds a child endpoint with one or more device types with the required cluster servers and the specified cluster servers.
610
+ * If the child endpoint is not already present in the childEndpoints, it will be added.
611
+ * If the child endpoint is already present in the childEndpoints, the device types and cluster servers will be added to the existing child endpoint.
612
+ *
613
+ * @param {string} endpointName - The name of the new enpoint to add.
614
+ * @param {DeviceTypeDefinition | AtLeastOne<DeviceTypeDefinition>} definition - The device types to add.
615
+ * @param {ClusterId[]} [serverList] - The list of cluster IDs to include.
616
+ * @param {MatterbridgeEndpointOptions} [options] - The options for the device.
617
+ * @param {boolean} [debug] - Whether to enable debug logging.
618
+ * @returns {MatterbridgeEndpoint} - The child endpoint that was found or added.
619
+ *
620
+ * @example
621
+ * ```typescript
622
+ * const endpoint = device.addChildDeviceTypeWithClusterServer('Temperature', [temperatureSensor], [], { tagList: [{ mfgCode: null, namespaceId: LocationTag.Indoor.namespaceId, tag: LocationTag.Indoor.tag, label: null }] }, true);
623
+ * ```
624
+ */
291
625
  addChildDeviceTypeWithClusterServer(endpointName, definition, serverList = [], options = {}, debug = false) {
292
626
  this.log.debug(`addChildDeviceTypeWithClusterServer: ${CYAN}${endpointName}${db}`);
293
627
  let alreadyAdded = false;
@@ -350,15 +684,39 @@ export class MatterbridgeEndpoint extends Endpoint {
350
684
  }
351
685
  return child;
352
686
  }
687
+ /**
688
+ * Retrieves a child endpoint by its name.
689
+ *
690
+ * @param {string} endpointName - The name of the endpoint to retrieve.
691
+ * @returns {Endpoint | undefined} The child endpoint with the specified name, or undefined if not found.
692
+ */
353
693
  getChildEndpointByName(endpointName) {
354
694
  return this.parts.find((part) => part.id === endpointName);
355
695
  }
696
+ /**
697
+ * Retrieves a child endpoint by its EndpointNumber.
698
+ *
699
+ * @param {EndpointNumber} endpointNumber - The EndpointNumber of the endpoint to retrieve.
700
+ * @returns {MatterbridgeEndpoint | undefined} The child endpoint with the specified EndpointNumber, or undefined if not found.
701
+ */
356
702
  getChildEndpoint(endpointNumber) {
357
703
  return this.parts.find((part) => part.number === endpointNumber);
358
704
  }
705
+ /**
706
+ * Get all the child endpoints of this endpoint.
707
+ *
708
+ * @returns {MatterbridgeEndpoint[]} The child endpoints.
709
+ */
359
710
  getChildEndpoints() {
360
711
  return Array.from(this.parts);
361
712
  }
713
+ /**
714
+ * Serializes the Matterbridge device into a serialized object.
715
+ *
716
+ * @param {MatterbridgeEndpoint} device - The Matterbridge device to serialize.
717
+ *
718
+ * @returns {SerializedMatterbridgeEndpoint | undefined} The serialized Matterbridge device object.
719
+ */
362
720
  static serialize(device) {
363
721
  if (!device.serialNumber || !device.deviceName || !device.uniqueId)
364
722
  return;
@@ -381,9 +739,16 @@ export class MatterbridgeEndpoint extends Endpoint {
381
739
  serialized.clusterServersId.push(BridgedDeviceBasicInformation.Cluster.id);
382
740
  if (behaviorName === 'powerSource')
383
741
  serialized.clusterServersId.push(PowerSource.Cluster.id);
742
+ // serialized.clusterServersId.push(this.behaviors.supported[behaviorName]cluster.id);
384
743
  });
385
744
  return serialized;
386
745
  }
746
+ /**
747
+ * Deserializes the device into a serialized object.
748
+ *
749
+ * @param {SerializedMatterbridgeEndpoint} serializedDevice - The serialized Matterbridge device object.
750
+ * @returns {MatterbridgeEndpoint | undefined} The deserialized Matterbridge device.
751
+ */
387
752
  static deserialize(serializedDevice) {
388
753
  const device = new MatterbridgeEndpoint(serializedDevice.deviceTypes, { uniqueStorageKey: serializedDevice.endpointName, endpointId: serializedDevice.endpoint }, false);
389
754
  device.plugin = serializedDevice.pluginName;
@@ -399,55 +764,126 @@ export class MatterbridgeEndpoint extends Endpoint {
399
764
  device.createDefaultBridgedDeviceBasicInformationClusterServer(serializedDevice.deviceName, serializedDevice.serialNumber, serializedDevice.vendorId ?? 0xfff1, serializedDevice.vendorName ?? 'Matterbridge', serializedDevice.productName ?? 'Matterbridge device');
400
765
  else if (clusterId === PowerSource.Cluster.id)
401
766
  device.createDefaultPowerSourceWiredClusterServer();
767
+ // else addClusterServerFromList(device, [clusterId]);
402
768
  }
403
769
  return device;
404
770
  }
771
+ /**
772
+ * Creates a default power source wired cluster server.
773
+ *
774
+ * @param {PowerSource.WiredCurrentType} wiredCurrentType - The type of wired current (default: PowerSource.WiredCurrentType.Ac)
775
+ * @returns {this} The current MatterbridgeEndpoint instance for chaining.
776
+ *
777
+ * @remarks
778
+ * - order: The order of the power source is a persisted attribute that indicates the order in which the power sources are used.
779
+ * - description: The description of the power source is a fixed attribute that describes the power source type.
780
+ * - wiredCurrentType: The type of wired current is a fixed attribute that indicates the type of wired current used by the power source (AC or DC).
781
+ */
405
782
  createDefaultPowerSourceWiredClusterServer(wiredCurrentType = PowerSource.WiredCurrentType.Ac) {
406
783
  this.behaviors.require(PowerSourceServer.with(PowerSource.Feature.Wired), {
784
+ // Base attributes
407
785
  status: PowerSource.PowerSourceStatus.Active,
408
786
  order: 0,
409
787
  description: wiredCurrentType === PowerSource.WiredCurrentType.Ac ? 'AC Power' : 'DC Power',
410
788
  endpointList: [],
789
+ // Wired feature attributes
411
790
  wiredCurrentType,
412
791
  });
413
792
  return this;
414
793
  }
794
+ /**
795
+ * Creates a default power source replaceable battery cluster server.
796
+ *
797
+ * @param {number} batPercentRemaining - The remaining battery percentage (default: 100).
798
+ * @param {PowerSource.BatChargeLevel} batChargeLevel - The battery charge level (default: PowerSource.BatChargeLevel.Ok).
799
+ * @param {number} batVoltage - The battery voltage (default: 1500).
800
+ * @param {string} batReplacementDescription - The description of the battery replacement (default: 'Battery type').
801
+ * @param {number} batQuantity - The quantity of the battery (default: 1).
802
+ * @param {PowerSource.BatReplaceability} batReplaceability - The replaceability of the battery (default: PowerSource.BatReplaceability.Unspecified).
803
+ * @returns {this} The current MatterbridgeEndpoint instance for chaining.
804
+ *
805
+ * @remarks
806
+ * - order: The order of the power source is a persisted attribute that indicates the order in which the power sources are used.
807
+ * - description: The description of the power source is a fixed attribute that describes the power source type.
808
+ * - batReplaceability: The replaceability of the battery is a fixed attribute that indicates whether the battery is user-replaceable or not.
809
+ * - batReplacementDescription: The description of the battery replacement is a fixed attribute that describes the battery type.
810
+ * - batQuantity: The quantity of the battery is a fixed attribute that indicates how many batteries are present in the device.
811
+ */
415
812
  createDefaultPowerSourceReplaceableBatteryClusterServer(batPercentRemaining = 100, batChargeLevel = PowerSource.BatChargeLevel.Ok, batVoltage = 1500, batReplacementDescription = 'Battery type', batQuantity = 1, batReplaceability = PowerSource.BatReplaceability.UserReplaceable) {
416
813
  this.behaviors.require(PowerSourceServer.with(PowerSource.Feature.Battery, PowerSource.Feature.Replaceable), {
814
+ // Base attributes
417
815
  status: PowerSource.PowerSourceStatus.Active,
418
816
  order: 0,
419
817
  description: 'Primary battery',
420
818
  endpointList: [],
819
+ // Battery feature attributes
421
820
  batVoltage,
422
821
  batPercentRemaining: Math.min(Math.max(batPercentRemaining * 2, 0), 200),
423
822
  batChargeLevel,
424
823
  batReplacementNeeded: false,
425
824
  batReplaceability,
426
825
  activeBatFaults: undefined,
826
+ // Replaceable feature attributes
427
827
  batReplacementDescription,
428
828
  batQuantity,
429
829
  });
430
830
  return this;
431
831
  }
832
+ /**
833
+ * Creates a default power source rechargeable battery cluster server.
834
+ *
835
+ * @param {number} [batPercentRemaining] - The remaining battery percentage (default: 100).
836
+ * @param {PowerSource.BatChargeLevel} [batChargeLevel] - The battery charge level (default: PowerSource.BatChargeLevel.Ok).
837
+ * @param {number} [batVoltage] - The battery voltage in mV (default: 1500).
838
+ * @param {PowerSource.BatReplaceability} [batReplaceability] - The replaceability of the battery (default: PowerSource.BatReplaceability.Unspecified).
839
+ * @returns {this} The current MatterbridgeEndpoint instance for chaining.
840
+ *
841
+ * @remarks
842
+ * - order: The order of the power source is a persisted attribute that indicates the order in which the power sources are used.
843
+ * - description: The description of the power source is a fixed attribute that describes the power source type.
844
+ * - batReplaceability: The replaceability of the battery is a fixed attribute that indicates whether the battery is user-replaceable or not.
845
+ */
432
846
  createDefaultPowerSourceRechargeableBatteryClusterServer(batPercentRemaining = 100, batChargeLevel = PowerSource.BatChargeLevel.Ok, batVoltage = 1500, batReplaceability = PowerSource.BatReplaceability.Unspecified) {
433
847
  this.behaviors.require(PowerSourceServer.with(PowerSource.Feature.Battery, PowerSource.Feature.Rechargeable), {
848
+ // Base attributes
434
849
  status: PowerSource.PowerSourceStatus.Active,
435
850
  order: 0,
436
851
  description: 'Primary battery',
437
852
  endpointList: [],
853
+ // Battery feature attributes
438
854
  batVoltage,
439
855
  batPercentRemaining: Math.min(Math.max(batPercentRemaining * 2, 0), 200),
440
- batTimeRemaining: null,
856
+ batTimeRemaining: null, // Indicates the estimated time in seconds before the battery will no longer be able to provide power to the Node
441
857
  batChargeLevel,
442
858
  batReplacementNeeded: false,
443
859
  batReplaceability,
444
860
  batPresent: true,
445
861
  activeBatFaults: [],
862
+ // Rechargeable feature attributes
446
863
  batChargeState: PowerSource.BatChargeState.IsNotCharging,
447
864
  batFunctionalWhileCharging: true,
448
865
  });
449
866
  return this;
450
867
  }
868
+ /**
869
+ * Setup the default Basic Information Cluster Server attributes for the server node.
870
+ *
871
+ * This method sets the device name, serial number, unique ID, vendor ID, vendor name, product ID, product name, software version, software version string, hardware version and hardware version string.
872
+ *
873
+ * The actual BasicInformationClusterServer is created by the Matterbridge class for device.mode = 'server' and for the device of an AccessoryPlatform.
874
+ *
875
+ * @param {string} deviceName - The name of the device.
876
+ * @param {string} serialNumber - The serial number of the device.
877
+ * @param {number} [vendorId] - The vendor ID of the device. Default is 0xfff1 (Matter Test VendorId).
878
+ * @param {string} [vendorName] - The name of the vendor. Default is 'Matterbridge'.
879
+ * @param {number} [productId] - The product ID of the device. Default is 0x8000 (Matter Test ProductId).
880
+ * @param {string} [productName] - The name of the product. Default is 'Matterbridge device'.
881
+ * @param {number} [softwareVersion] - The software version of the device. Default is 1.
882
+ * @param {string} [softwareVersionString] - The software version string of the device. Default is '1.0.0'.
883
+ * @param {number} [hardwareVersion] - The hardware version of the device. Default is 1.
884
+ * @param {string} [hardwareVersionString] - The hardware version string of the device. Default is '1.0.0'.
885
+ * @returns {this} The current MatterbridgeEndpoint instance for chaining.
886
+ */
451
887
  createDefaultBasicInformationClusterServer(deviceName, serialNumber, vendorId = 0xfff1, vendorName = 'Matterbridge', productId = 0x8000, productName = 'Matterbridge device', softwareVersion = 1, softwareVersionString = '1.0.0', hardwareVersion = 1, hardwareVersionString = '1.0.0') {
452
888
  this.log.logName = deviceName;
453
889
  this.deviceName = deviceName;
@@ -463,6 +899,26 @@ export class MatterbridgeEndpoint extends Endpoint {
463
899
  this.hardwareVersionString = hardwareVersionString;
464
900
  return this;
465
901
  }
902
+ /**
903
+ * Creates a default BridgedDeviceBasicInformationClusterServer for the aggregator endpoints.
904
+ *
905
+ * This method sets the device name, serial number, unique ID, vendor ID, vendor name, product name, software version, software version string, hardware version and hardware version string.
906
+ *
907
+ * @param {string} deviceName - The name of the device.
908
+ * @param {string} serialNumber - The serial number of the device.
909
+ * @param {number} [vendorId] - The vendor ID of the device. Default is 0xfff1 (Matter Test VendorId).
910
+ * @param {string} [vendorName] - The name of the vendor. Default is 'Matterbridge'.
911
+ * @param {string} [productName] - The name of the product. Default is 'Matterbridge device'.
912
+ * @param {number} [softwareVersion] - The software version of the device. Default is 1.
913
+ * @param {string} [softwareVersionString] - The software version string of the device. Default is '1.0.0'.
914
+ * @param {number} [hardwareVersion] - The hardware version of the device. Default is 1.
915
+ * @param {string} [hardwareVersionString] - The hardware version string of the device. Default is '1.0.0'.
916
+ * @returns {this} The current MatterbridgeEndpoint instance for chaining.
917
+ *
918
+ * @remarks
919
+ * - The productId doesn't exist on the BridgedDeviceBasicInformation cluster.
920
+ * - The bridgedNode device type must be added to the deviceTypeList of the Descriptor cluster.
921
+ */
466
922
  createDefaultBridgedDeviceBasicInformationClusterServer(deviceName, serialNumber, vendorId = 0xfff1, vendorName = 'Matterbridge', productName = 'Matterbridge device', softwareVersion = 1, softwareVersionString = '1.0.0', hardwareVersion = 1, hardwareVersionString = '1.0.0') {
467
923
  this.log.logName = deviceName;
468
924
  this.deviceName = deviceName;
@@ -495,6 +951,13 @@ export class MatterbridgeEndpoint extends Endpoint {
495
951
  });
496
952
  return this;
497
953
  }
954
+ /**
955
+ * Creates a default identify cluster server with the specified identify time and type.
956
+ *
957
+ * @param {number} [identifyTime] - The time to identify the server. Defaults to 0.
958
+ * @param {Identify.IdentifyType} [identifyType] - The type of identification. Defaults to Identify.IdentifyType.None.
959
+ * @returns {this} The current MatterbridgeEndpoint instance for chaining.
960
+ */
498
961
  createDefaultIdentifyClusterServer(identifyTime = 0, identifyType = Identify.IdentifyType.None) {
499
962
  this.behaviors.require(MatterbridgeIdentifyServer, {
500
963
  identifyTime,
@@ -502,14 +965,36 @@ export class MatterbridgeEndpoint extends Endpoint {
502
965
  });
503
966
  return this;
504
967
  }
968
+ /**
969
+ * Creates a default groups cluster server.
970
+ *
971
+ * @returns {this} The current MatterbridgeEndpoint instance for chaining.
972
+ */
505
973
  createDefaultGroupsClusterServer() {
506
974
  this.behaviors.require(GroupsServer);
507
975
  return this;
508
976
  }
977
+ /**
978
+ * Creates a default scenes management cluster server.
979
+ *
980
+ * @returns {this} The current MatterbridgeEndpoint instance for chaining.
981
+ *
982
+ * @remarks The scenes management cluster server is still provisional and so not yet implemented.
983
+ */
509
984
  createDefaultScenesClusterServer() {
510
985
  this.behaviors.require(ScenesManagementServer);
511
986
  return this;
512
987
  }
988
+ /**
989
+ * Creates a default OnOff cluster server for light devices with feature Lighting.
990
+ *
991
+ * @param {boolean} [onOff] - The initial state of the OnOff cluster.
992
+ * @param {boolean} [globalSceneControl] - The global scene control state.
993
+ * @param {number} [onTime] - The on time value.
994
+ * @param {number} [offWaitTime] - The off wait time value.
995
+ * @param {OnOff.StartUpOnOff | null} [startUpOnOff] - The start-up OnOff state. Null means previous state.
996
+ * @returns {this} The current MatterbridgeEndpoint instance for chaining.
997
+ */
513
998
  createDefaultOnOffClusterServer(onOff = false, globalSceneControl = false, onTime = 0, offWaitTime = 0, startUpOnOff = null) {
514
999
  this.behaviors.require(MatterbridgeOnOffServer.with(OnOff.Feature.Lighting), {
515
1000
  onOff,
@@ -520,24 +1005,58 @@ export class MatterbridgeEndpoint extends Endpoint {
520
1005
  });
521
1006
  return this;
522
1007
  }
1008
+ /**
1009
+ * Creates an OnOff cluster server without features.
1010
+ *
1011
+ * @param {boolean} [onOff] - The initial state of the OnOff cluster.
1012
+ * @returns {this} The current MatterbridgeEndpoint instance for chaining.
1013
+ */
523
1014
  createOnOffClusterServer(onOff = false) {
524
1015
  this.behaviors.require(MatterbridgeOnOffServer, {
525
1016
  onOff,
526
1017
  });
527
1018
  return this;
528
1019
  }
1020
+ /**
1021
+ * Creates a DeadFront OnOff cluster server with feature DeadFrontBehavior.
1022
+ *
1023
+ * The "dead front" state is linked to the OnOff attribute
1024
+ * in the On/Off cluster having the value False. Thus, the Off command of the On/Off cluster SHALL
1025
+ * move the device into the "dead front" state, the On command of the On/Off cluster SHALL bring the
1026
+ * device out of the "dead front" state, and the device SHALL adhere with the associated requirements
1027
+ * on subscription handling and event reporting.
1028
+ *
1029
+ * @param {boolean} [onOff] - The initial state of the OnOff cluster.
1030
+ * @returns {this} The current MatterbridgeEndpoint instance for chaining.
1031
+ */
529
1032
  createDeadFrontOnOffClusterServer(onOff = false) {
530
1033
  this.behaviors.require(MatterbridgeOnOffServer.with(OnOff.Feature.DeadFrontBehavior), {
531
1034
  onOff,
532
1035
  });
533
1036
  return this;
534
1037
  }
1038
+ /**
1039
+ * Creates an OffOnly OnOff cluster server with feature OffOnly.
1040
+ *
1041
+ * @param {boolean} [onOff] - The initial state of the OnOff cluster.
1042
+ * @returns {this} The current MatterbridgeEndpoint instance for chaining.
1043
+ */
535
1044
  createOffOnlyOnOffClusterServer(onOff = false) {
536
1045
  this.behaviors.require(MatterbridgeOnOffServer.with(OnOff.Feature.OffOnly), {
537
1046
  onOff,
538
1047
  });
539
1048
  return this;
540
1049
  }
1050
+ /**
1051
+ * Creates a default level control cluster server for light devices with feature OnOff and Lighting.
1052
+ *
1053
+ * @param {number} [currentLevel] - The current level (default: 254).
1054
+ * @param {number} [minLevel] - The minimum level (default: 1).
1055
+ * @param {number} [maxLevel] - The maximum level (default: 254).
1056
+ * @param {number | null} [onLevel] - The on level (default: null).
1057
+ * @param {number | null} [startUpCurrentLevel] - The startUp on level (default: null).
1058
+ * @returns {this} The current MatterbridgeEndpoint instance for chaining.
1059
+ */
541
1060
  createDefaultLevelControlClusterServer(currentLevel = 254, minLevel = 1, maxLevel = 254, onLevel = null, startUpCurrentLevel = null) {
542
1061
  this.behaviors.require(MatterbridgeLevelControlServer.with(LevelControl.Feature.OnOff, LevelControl.Feature.Lighting), {
543
1062
  currentLevel,
@@ -553,6 +1072,13 @@ export class MatterbridgeEndpoint extends Endpoint {
553
1072
  });
554
1073
  return this;
555
1074
  }
1075
+ /**
1076
+ * Creates a level control cluster server without features.
1077
+ *
1078
+ * @param {number} [currentLevel] - The current level (default: 254).
1079
+ * @param {number | null} [onLevel] - The on level (default: null).
1080
+ * @returns {this} The current MatterbridgeEndpoint instance for chaining.
1081
+ */
556
1082
  createLevelControlClusterServer(currentLevel = 254, onLevel = null) {
557
1083
  this.behaviors.require(MatterbridgeLevelControlServer, {
558
1084
  currentLevel,
@@ -564,6 +1090,25 @@ export class MatterbridgeEndpoint extends Endpoint {
564
1090
  });
565
1091
  return this;
566
1092
  }
1093
+ /**
1094
+ * Creates a default color control cluster server with features Xy, HueSaturation and ColorTemperature.
1095
+ *
1096
+ * @param {number} currentX - The current X value (range 0-65279).
1097
+ * @param {number} currentY - The current Y value (range 0-65279).
1098
+ * @param {number} currentHue - The current hue value (range: 0-254).
1099
+ * @param {number} currentSaturation - The current saturation value (range: 0-254).
1100
+ * @param {number} colorTemperatureMireds - The color temperature in mireds (default range 147-500).
1101
+ * @param {number} colorTempPhysicalMinMireds - The physical minimum color temperature in mireds (default range 147).
1102
+ * @param {number} colorTempPhysicalMaxMireds - The physical maximum color temperature in mireds (default range 500).
1103
+ * @returns {this} The current MatterbridgeEndpoint instance for chaining.
1104
+ *
1105
+ * @remarks colorMode and enhancedColorMode persist across restarts.
1106
+ * @remarks currentHue and currentSaturation persist across restarts.
1107
+ * @remarks currentX and currentY persist across restarts.
1108
+ * @remarks colorTemperatureMireds persists across restarts.
1109
+ * @remarks startUpColorTemperatureMireds persists across restarts.
1110
+ * @remarks coupleColorTempToLevelMinMireds persists across restarts.
1111
+ */
567
1112
  createDefaultColorControlClusterServer(currentX = 0, currentY = 0, currentHue = 0, currentSaturation = 0, colorTemperatureMireds = 500, colorTempPhysicalMinMireds = 147, colorTempPhysicalMaxMireds = 500) {
568
1113
  this.behaviors.require(MatterbridgeColorControlServer.with(ColorControl.Feature.Xy, ColorControl.Feature.HueSaturation, ColorControl.Feature.ColorTemperature), {
569
1114
  colorMode: ColorControl.ColorMode.CurrentHueAndCurrentSaturation,
@@ -586,6 +1131,25 @@ export class MatterbridgeEndpoint extends Endpoint {
586
1131
  });
587
1132
  return this;
588
1133
  }
1134
+ /**
1135
+ * Creates a Xy color control cluster server with feature Xy and ColorTemperature.
1136
+ *
1137
+ * @param {number} currentX - The current X value (range 0-65279).
1138
+ * @param {number} currentY - The current Y value (range 0-65279).
1139
+ * @param {number} colorTemperatureMireds - The color temperature in mireds (default range 147-500).
1140
+ * @param {number} colorTempPhysicalMinMireds - The physical minimum color temperature in mireds (default range 147).
1141
+ * @param {number} colorTempPhysicalMaxMireds - The physical maximum color temperature in mireds (default range 500).
1142
+ * @returns {this} The current MatterbridgeEndpoint instance for chaining.
1143
+ *
1144
+ * @remarks
1145
+ * From zigbee to matter = Math.max(Math.min(Math.round(x * 65536), 65279), 0)
1146
+ *
1147
+ * @remarks colorMode and enhancedColorMode persist across restarts.
1148
+ * @remarks currentX and currentY persist across restarts.
1149
+ * @remarks colorTemperatureMireds persists across restarts.
1150
+ * @remarks startUpColorTemperatureMireds persists across restarts.
1151
+ * @remarks coupleColorTempToLevelMinMireds persists across restarts.
1152
+ */
589
1153
  createXyColorControlClusterServer(currentX = 0, currentY = 0, colorTemperatureMireds = 500, colorTempPhysicalMinMireds = 147, colorTempPhysicalMaxMireds = 500) {
590
1154
  this.behaviors.require(MatterbridgeColorControlServer.with(ColorControl.Feature.Xy, ColorControl.Feature.ColorTemperature), {
591
1155
  colorMode: ColorControl.ColorMode.CurrentXAndCurrentY,
@@ -606,6 +1170,22 @@ export class MatterbridgeEndpoint extends Endpoint {
606
1170
  });
607
1171
  return this;
608
1172
  }
1173
+ /**
1174
+ * Creates a default hue and saturation control cluster server with feature HueSaturation and ColorTemperature.
1175
+ *
1176
+ * @param {number} currentHue - The current hue value (range: 0-254).
1177
+ * @param {number} currentSaturation - The current saturation value (range: 0-254).
1178
+ * @param {number} colorTemperatureMireds - The color temperature in mireds (default range 147-500).
1179
+ * @param {number} colorTempPhysicalMinMireds - The physical minimum color temperature in mireds (default range 147).
1180
+ * @param {number} colorTempPhysicalMaxMireds - The physical maximum color temperature in mireds (default range 500).
1181
+ * @returns {this} The current MatterbridgeEndpoint instance for chaining.
1182
+ *
1183
+ * @remarks colorMode and enhancedColorMode persist across restarts.
1184
+ * @remarks currentHue and currentSaturation persist across restarts.
1185
+ * @remarks colorTemperatureMireds persists across restarts.
1186
+ * @remarks startUpColorTemperatureMireds persists across restarts.
1187
+ * @remarks coupleColorTempToLevelMinMireds persists across restarts.
1188
+ */
609
1189
  createHsColorControlClusterServer(currentHue = 0, currentSaturation = 0, colorTemperatureMireds = 500, colorTempPhysicalMinMireds = 147, colorTempPhysicalMaxMireds = 500) {
610
1190
  this.behaviors.require(MatterbridgeColorControlServer.with(ColorControl.Feature.HueSaturation, ColorControl.Feature.ColorTemperature), {
611
1191
  colorMode: ColorControl.ColorMode.CurrentHueAndCurrentSaturation,
@@ -626,6 +1206,20 @@ export class MatterbridgeEndpoint extends Endpoint {
626
1206
  });
627
1207
  return this;
628
1208
  }
1209
+ /**
1210
+ * Creates a color temperature color control cluster server with feature ColorTemperature.
1211
+ * This cluster server is used for devices that only support color temperature control.
1212
+ *
1213
+ * @param {number} colorTemperatureMireds - The color temperature in mireds (default range 147-500).
1214
+ * @param {number} colorTempPhysicalMinMireds - The physical minimum color temperature in mireds (default range 147).
1215
+ * @param {number} colorTempPhysicalMaxMireds - The physical maximum color temperature in mireds (default range 500).
1216
+ * @returns {this} The current MatterbridgeEndpoint instance for chaining.
1217
+ *
1218
+ * @remarks colorMode and enhancedColorMode persist across restarts.
1219
+ * @remarks colorTemperatureMireds persists across restarts.
1220
+ * @remarks startUpColorTemperatureMireds persists across restarts.
1221
+ * @remarks coupleColorTempToLevelMinMireds persists across restarts.
1222
+ */
629
1223
  createCtColorControlClusterServer(colorTemperatureMireds = 250, colorTempPhysicalMinMireds = 147, colorTempPhysicalMaxMireds = 500) {
630
1224
  this.behaviors.require(MatterbridgeColorControlServer.with(ColorControl.Feature.ColorTemperature), {
631
1225
  colorMode: ColorControl.ColorMode.ColorTemperatureMireds,
@@ -644,15 +1238,34 @@ export class MatterbridgeEndpoint extends Endpoint {
644
1238
  });
645
1239
  return this;
646
1240
  }
1241
+ /**
1242
+ * Configures the color control mode for the device.
1243
+ *
1244
+ * @param {ColorControl.ColorMode} colorMode - The color mode to set.
1245
+ *
1246
+ * @remarks colorMode and enhancedColorMode persist across restarts.
1247
+ */
647
1248
  async configureColorControlMode(colorMode) {
648
1249
  if (isValidNumber(colorMode, ColorControl.ColorMode.CurrentHueAndCurrentSaturation, ColorControl.ColorMode.ColorTemperatureMireds)) {
649
1250
  await this.setAttribute(ColorControl.Cluster.id, 'colorMode', colorMode, this.log);
650
1251
  await this.setAttribute(ColorControl.Cluster.id, 'enhancedColorMode', colorMode, this.log);
651
1252
  }
652
1253
  }
1254
+ /**
1255
+ * Creates a default window covering cluster server with feature Lift and PositionAwareLift.
1256
+ *
1257
+ * @param {number} positionPercent100ths - The position percentage in 100ths (0-10000). Defaults to 0. Matter uses 10000 = fully closed 0 = fully opened.
1258
+ * @param {WindowCovering.WindowCoveringType} type - The type of window covering (default: WindowCovering.WindowCoveringType.Rollershade). Must support feature Lift.
1259
+ * @param {WindowCovering.EndProductType} endProductType - The end product type (default: WindowCovering.EndProductType.RollerShade). Must support feature Lift.
1260
+ * @returns {this} The current MatterbridgeEndpoint instance for chaining.
1261
+ *
1262
+ * @remarks mode attributes is writable and persists across restarts.
1263
+ * currentPositionLiftPercent100ths persists across restarts.
1264
+ * configStatus attributes persists across restarts.
1265
+ */
653
1266
  createDefaultWindowCoveringClusterServer(positionPercent100ths, type = WindowCovering.WindowCoveringType.Rollershade, endProductType = WindowCovering.EndProductType.RollerShade) {
654
1267
  this.behaviors.require(MatterbridgeLiftWindowCoveringServer.with(WindowCovering.Feature.Lift, WindowCovering.Feature.PositionAwareLift), {
655
- type,
1268
+ type, // Must support feature Lift
656
1269
  numberOfActuationsLift: 0,
657
1270
  configStatus: {
658
1271
  operational: true,
@@ -660,20 +1273,33 @@ export class MatterbridgeEndpoint extends Endpoint {
660
1273
  liftMovementReversed: false,
661
1274
  liftPositionAware: true,
662
1275
  tiltPositionAware: false,
663
- liftEncoderControlled: false,
664
- tiltEncoderControlled: false,
1276
+ liftEncoderControlled: false, // 0 = Timer Controlled 1 = Encoder Controlled
1277
+ tiltEncoderControlled: false, // 0 = Timer Controlled 1 = Encoder Controlled
665
1278
  },
666
1279
  operationalStatus: { global: WindowCovering.MovementStatus.Stopped, lift: WindowCovering.MovementStatus.Stopped, tilt: WindowCovering.MovementStatus.Stopped },
667
- endProductType,
1280
+ endProductType, // Must support feature Lift
668
1281
  mode: { motorDirectionReversed: false, calibrationMode: false, maintenanceMode: false, ledFeedback: false },
669
- targetPositionLiftPercent100ths: positionPercent100ths ?? 0,
670
- currentPositionLiftPercent100ths: positionPercent100ths ?? 0,
1282
+ targetPositionLiftPercent100ths: positionPercent100ths ?? 0, // 0 Fully open 10000 fully closed
1283
+ currentPositionLiftPercent100ths: positionPercent100ths ?? 0, // 0 Fully open 10000 fully closed
671
1284
  });
672
1285
  return this;
673
1286
  }
1287
+ /**
1288
+ * Creates a default window covering cluster server with features Lift, PositionAwareLift, Tilt, PositionAwareTilt.
1289
+ *
1290
+ * @param {number} positionLiftPercent100ths - The lift position percentage in 100ths (0-10000). Defaults to 0. Matter uses 10000 = fully closed 0 = fully opened.
1291
+ * @param {number} positionTiltPercent100ths - The tilt position percentage in 100ths (0-10000). Defaults to 0. Matter uses 10000 = fully closed 0 = fully opened.
1292
+ * @param {WindowCovering.WindowCoveringType} type - The type of window covering (default: WindowCovering.WindowCoveringType.TiltBlindLift). Must support features Lift and Tilt.
1293
+ * @param {WindowCovering.EndProductType} endProductType - The end product type (default: WindowCovering.EndProductType.InteriorBlind). Must support features Lift and Tilt.
1294
+ * @returns {this} The current MatterbridgeEndpoint instance for chaining.
1295
+ *
1296
+ * @remarks mode attributes is writable and persists across restarts.
1297
+ * currentPositionTiltPercent100ths persists across restarts.
1298
+ * configStatus attributes persists across restarts.
1299
+ */
674
1300
  createDefaultLiftTiltWindowCoveringClusterServer(positionLiftPercent100ths, positionTiltPercent100ths, type = WindowCovering.WindowCoveringType.TiltBlindLift, endProductType = WindowCovering.EndProductType.InteriorBlind) {
675
1301
  this.behaviors.require(MatterbridgeLiftTiltWindowCoveringServer.with(WindowCovering.Feature.Lift, WindowCovering.Feature.PositionAwareLift, WindowCovering.Feature.Tilt, WindowCovering.Feature.PositionAwareTilt), {
676
- type,
1302
+ type, // Must support features Lift and Tilt
677
1303
  numberOfActuationsLift: 0,
678
1304
  numberOfActuationsTilt: 0,
679
1305
  configStatus: {
@@ -682,19 +1308,23 @@ export class MatterbridgeEndpoint extends Endpoint {
682
1308
  liftMovementReversed: false,
683
1309
  liftPositionAware: true,
684
1310
  tiltPositionAware: true,
685
- liftEncoderControlled: false,
686
- tiltEncoderControlled: false,
1311
+ liftEncoderControlled: false, // 0 = Timer Controlled 1 = Encoder Controlled
1312
+ tiltEncoderControlled: false, // 0 = Timer Controlled 1 = Encoder Controlled
687
1313
  },
688
1314
  operationalStatus: { global: WindowCovering.MovementStatus.Stopped, lift: WindowCovering.MovementStatus.Stopped, tilt: WindowCovering.MovementStatus.Stopped },
689
- endProductType,
1315
+ endProductType, // Must support features Lift and Tilt
690
1316
  mode: { motorDirectionReversed: false, calibrationMode: false, maintenanceMode: false, ledFeedback: false },
691
- targetPositionLiftPercent100ths: positionLiftPercent100ths ?? 0,
692
- currentPositionLiftPercent100ths: positionLiftPercent100ths ?? 0,
693
- targetPositionTiltPercent100ths: positionTiltPercent100ths ?? 0,
694
- currentPositionTiltPercent100ths: positionTiltPercent100ths ?? 0,
1317
+ targetPositionLiftPercent100ths: positionLiftPercent100ths ?? 0, // 0 Fully open 10000 fully closed
1318
+ currentPositionLiftPercent100ths: positionLiftPercent100ths ?? 0, // 0 Fully open 10000 fully closed
1319
+ targetPositionTiltPercent100ths: positionTiltPercent100ths ?? 0, // 0 Fully open 10000 fully closed
1320
+ currentPositionTiltPercent100ths: positionTiltPercent100ths ?? 0, // 0 Fully open 10000 fully closed
695
1321
  });
696
1322
  return this;
697
1323
  }
1324
+ /**
1325
+ * Sets the window covering lift target position as the current position and stops the movement.
1326
+ *
1327
+ */
698
1328
  async setWindowCoveringTargetAsCurrentAndStopped() {
699
1329
  const position = this.getAttribute(WindowCovering.Cluster.id, 'currentPositionLiftPercent100ths', this.log);
700
1330
  if (isValidNumber(position, 0, 10000)) {
@@ -714,6 +1344,13 @@ export class MatterbridgeEndpoint extends Endpoint {
714
1344
  this.log.debug(`Set WindowCovering currentPositionTiltPercent100ths and targetPositionTiltPercent100ths to ${position} and operationalStatus to Stopped.`);
715
1345
  }
716
1346
  }
1347
+ /**
1348
+ * Sets the lift current and target position and the status of a window covering.
1349
+ *
1350
+ * @param {number} current - The current position of the window covering.
1351
+ * @param {number} target - The target position of the window covering.
1352
+ * @param {WindowCovering.MovementStatus} status - The movement status of the window covering.
1353
+ */
717
1354
  async setWindowCoveringCurrentTargetStatus(current, target, status) {
718
1355
  await this.setAttribute(WindowCovering.Cluster.id, 'currentPositionLiftPercent100ths', current, this.log);
719
1356
  await this.setAttribute(WindowCovering.Cluster.id, 'targetPositionLiftPercent100ths', target, this.log);
@@ -724,6 +1361,11 @@ export class MatterbridgeEndpoint extends Endpoint {
724
1361
  }, this.log);
725
1362
  this.log.debug(`Set WindowCovering currentPositionLiftPercent100ths: ${current}, targetPositionLiftPercent100ths: ${target} and operationalStatus: ${status}.`);
726
1363
  }
1364
+ /**
1365
+ * Sets the status of the window covering.
1366
+ *
1367
+ * @param {WindowCovering.MovementStatus} status - The movement status to set.
1368
+ */
727
1369
  async setWindowCoveringStatus(status) {
728
1370
  await this.setAttribute(WindowCovering.Cluster.id, 'operationalStatus', {
729
1371
  global: status,
@@ -732,6 +1374,11 @@ export class MatterbridgeEndpoint extends Endpoint {
732
1374
  }, this.log);
733
1375
  this.log.debug(`Set WindowCovering operationalStatus: ${status}`);
734
1376
  }
1377
+ /**
1378
+ * Retrieves the status of the window covering.
1379
+ *
1380
+ * @returns {WindowCovering.MovementStatus | undefined} The movement status of the window covering, or undefined if not available.
1381
+ */
735
1382
  getWindowCoveringStatus() {
736
1383
  const status = this.getAttribute(WindowCovering.Cluster.id, 'operationalStatus', this.log);
737
1384
  if (isValidObject(status, 3) && 'global' in status && typeof status.global === 'number') {
@@ -739,6 +1386,12 @@ export class MatterbridgeEndpoint extends Endpoint {
739
1386
  return status.global;
740
1387
  }
741
1388
  }
1389
+ /**
1390
+ * Sets the lift target and current position of the window covering.
1391
+ *
1392
+ * @param {number} liftPosition - The position to set, specified as a number.
1393
+ * @param {number} [tiltPosition] - The tilt position to set, specified as a number.
1394
+ */
742
1395
  async setWindowCoveringTargetAndCurrentPosition(liftPosition, tiltPosition) {
743
1396
  await this.setAttribute(WindowCovering.Cluster.id, 'currentPositionLiftPercent100ths', liftPosition, this.log);
744
1397
  await this.setAttribute(WindowCovering.Cluster.id, 'targetPositionLiftPercent100ths', liftPosition, this.log);
@@ -749,31 +1402,57 @@ export class MatterbridgeEndpoint extends Endpoint {
749
1402
  this.log.debug(`Set WindowCovering currentPositionTiltPercent100ths: ${tiltPosition} and targetPositionTiltPercent100ths: ${tiltPosition}.`);
750
1403
  }
751
1404
  }
1405
+ /**
1406
+ * Creates a default thermostat cluster server with features Heating, Cooling and AutoMode.
1407
+ *
1408
+ * @param {number} [localTemperature] - The local temperature value in degrees Celsius. Defaults to 23°.
1409
+ * @param {number} [occupiedHeatingSetpoint] - The occupied heating setpoint value in degrees Celsius. Defaults to 21°.
1410
+ * @param {number} [occupiedCoolingSetpoint] - The occupied cooling setpoint value in degrees Celsius. Defaults to 25°.
1411
+ * @param {number} [minSetpointDeadBand] - The minimum setpoint dead band value. Defaults to 1°.
1412
+ * @param {number} [minHeatSetpointLimit] - The minimum heat setpoint limit value. Defaults to 0°.
1413
+ * @param {number} [maxHeatSetpointLimit] - The maximum heat setpoint limit value. Defaults to 50°.
1414
+ * @param {number} [minCoolSetpointLimit] - The minimum cool setpoint limit value. Defaults to 0°.
1415
+ * @param {number} [maxCoolSetpointLimit] - The maximum cool setpoint limit value. Defaults to 50°.
1416
+ * @returns {this} The current MatterbridgeEndpoint instance for chaining.
1417
+ */
752
1418
  createDefaultThermostatClusterServer(localTemperature = 23, occupiedHeatingSetpoint = 21, occupiedCoolingSetpoint = 25, minSetpointDeadBand = 1, minHeatSetpointLimit = 0, maxHeatSetpointLimit = 50, minCoolSetpointLimit = 0, maxCoolSetpointLimit = 50) {
753
1419
  this.behaviors.require(MatterbridgeThermostatServer.with(Thermostat.Feature.Heating, Thermostat.Feature.Cooling, Thermostat.Feature.AutoMode), {
754
1420
  localTemperature: localTemperature * 100,
755
1421
  systemMode: Thermostat.SystemMode.Auto,
756
1422
  controlSequenceOfOperation: Thermostat.ControlSequenceOfOperation.CoolingAndHeating,
1423
+ // Thermostat.Feature.Heating
757
1424
  occupiedHeatingSetpoint: occupiedHeatingSetpoint * 100,
758
1425
  minHeatSetpointLimit: minHeatSetpointLimit * 100,
759
1426
  maxHeatSetpointLimit: maxHeatSetpointLimit * 100,
760
1427
  absMinHeatSetpointLimit: minHeatSetpointLimit * 100,
761
1428
  absMaxHeatSetpointLimit: maxHeatSetpointLimit * 100,
1429
+ // Thermostat.Feature.Cooling
762
1430
  occupiedCoolingSetpoint: occupiedCoolingSetpoint * 100,
763
1431
  minCoolSetpointLimit: minCoolSetpointLimit * 100,
764
1432
  maxCoolSetpointLimit: maxCoolSetpointLimit * 100,
765
1433
  absMinCoolSetpointLimit: minCoolSetpointLimit * 100,
766
1434
  absMaxCoolSetpointLimit: maxCoolSetpointLimit * 100,
1435
+ // Thermostat.Feature.AutoMode
767
1436
  minSetpointDeadBand: minSetpointDeadBand * 100,
768
1437
  thermostatRunningMode: Thermostat.ThermostatRunningMode.Off,
769
1438
  });
770
1439
  return this;
771
1440
  }
1441
+ /**
1442
+ * Creates a default heating thermostat cluster server with feature Heating.
1443
+ *
1444
+ * @param {number} [localTemperature] - The local temperature value in degrees Celsius. Defaults to 23°.
1445
+ * @param {number} [occupiedHeatingSetpoint] - The occupied heating setpoint value in degrees Celsius. Defaults to 21°.
1446
+ * @param {number} [minHeatSetpointLimit] - The minimum heat setpoint limit value. Defaults to 0°.
1447
+ * @param {number} [maxHeatSetpointLimit] - The maximum heat setpoint limit value. Defaults to 50°.
1448
+ * @returns {this} The current MatterbridgeEndpoint instance for chaining.
1449
+ */
772
1450
  createDefaultHeatingThermostatClusterServer(localTemperature = 23, occupiedHeatingSetpoint = 21, minHeatSetpointLimit = 0, maxHeatSetpointLimit = 50) {
773
1451
  this.behaviors.require(MatterbridgeThermostatServer.with(Thermostat.Feature.Heating), {
774
1452
  localTemperature: localTemperature * 100,
775
1453
  systemMode: Thermostat.SystemMode.Heat,
776
1454
  controlSequenceOfOperation: Thermostat.ControlSequenceOfOperation.HeatingOnly,
1455
+ // Thermostat.Feature.Heating
777
1456
  occupiedHeatingSetpoint: occupiedHeatingSetpoint * 100,
778
1457
  minHeatSetpointLimit: minHeatSetpointLimit * 100,
779
1458
  maxHeatSetpointLimit: maxHeatSetpointLimit * 100,
@@ -782,11 +1461,21 @@ export class MatterbridgeEndpoint extends Endpoint {
782
1461
  });
783
1462
  return this;
784
1463
  }
1464
+ /**
1465
+ * Creates a default cooling thermostat cluster server with feature Cooling.
1466
+ *
1467
+ * @param {number} [localTemperature] - The local temperature value in degrees Celsius. Defaults to 23°.
1468
+ * @param {number} [occupiedCoolingSetpoint] - The occupied cooling setpoint value in degrees Celsius. Defaults to 25°.
1469
+ * @param {number} [minCoolSetpointLimit] - The minimum cool setpoint limit value. Defaults to 0°.
1470
+ * @param {number} [maxCoolSetpointLimit] - The maximum cool setpoint limit value. Defaults to 50°.
1471
+ * @returns {this} The current MatterbridgeEndpoint instance for chaining.
1472
+ */
785
1473
  createDefaultCoolingThermostatClusterServer(localTemperature = 23, occupiedCoolingSetpoint = 25, minCoolSetpointLimit = 0, maxCoolSetpointLimit = 50) {
786
1474
  this.behaviors.require(MatterbridgeThermostatServer.with(Thermostat.Feature.Cooling), {
787
1475
  localTemperature: localTemperature * 100,
788
1476
  systemMode: Thermostat.SystemMode.Cool,
789
1477
  controlSequenceOfOperation: Thermostat.ControlSequenceOfOperation.CoolingOnly,
1478
+ // Thermostat.Feature.Cooling
790
1479
  occupiedCoolingSetpoint: occupiedCoolingSetpoint * 100,
791
1480
  minCoolSetpointLimit: minCoolSetpointLimit * 100,
792
1481
  maxCoolSetpointLimit: maxCoolSetpointLimit * 100,
@@ -795,6 +1484,20 @@ export class MatterbridgeEndpoint extends Endpoint {
795
1484
  });
796
1485
  return this;
797
1486
  }
1487
+ /**
1488
+ * Creates a default thermostat user interface configuration cluster server.
1489
+ *
1490
+ * @param {ThermostatUserInterfaceConfiguration.TemperatureDisplayMode} [temperatureDisplayMode] - The temperature display mode to set. Defaults to `ThermostatUserInterfaceConfiguration.TemperatureDisplayMode.Celsius`.
1491
+ * @param {ThermostatUserInterfaceConfiguration.KeypadLockout} [keypadLockout] - The keypad lockout mode. Defaults to `ThermostatUserInterfaceConfiguration.KeypadLockout.NoLockout`.
1492
+ * @param {ThermostatUserInterfaceConfiguration.ScheduleProgrammingVisibility} [scheduleProgrammingVisibility] - The schedule programming visibility. Defaults to `ThermostatUserInterfaceConfiguration.ScheduleProgrammingVisibility.ScheduleProgrammingPermitted`.
1493
+ *
1494
+ * @returns {this} The current MatterbridgeEndpoint instance for chaining.
1495
+ * @remarks
1496
+ * The default values are:
1497
+ * - temperatureDisplayMode: ThermostatUserInterfaceConfiguration.TemperatureDisplayMode.Celsius (writable).
1498
+ * - keypadLockout: ThermostatUserInterfaceConfiguration.KeypadLockout.NoLockout (writable).
1499
+ * - scheduleProgrammingVisibility: ThermostatUserInterfaceConfiguration.ScheduleProgrammingVisibility.ScheduleProgrammingPermitted (writable).
1500
+ */
798
1501
  createDefaultThermostatUserInterfaceConfigurationClusterServer(temperatureDisplayMode = ThermostatUserInterfaceConfiguration.TemperatureDisplayMode.Celsius, keypadLockout = ThermostatUserInterfaceConfiguration.KeypadLockout.NoLockout, scheduleProgrammingVisibility = ThermostatUserInterfaceConfiguration.ScheduleProgrammingVisibility.ScheduleProgrammingPermitted) {
799
1502
  this.behaviors.require(ThermostatUserInterfaceConfigurationServer, {
800
1503
  temperatureDisplayMode,
@@ -803,95 +1506,273 @@ export class MatterbridgeEndpoint extends Endpoint {
803
1506
  });
804
1507
  return this;
805
1508
  }
1509
+ /**
1510
+ * Creates a default fan control cluster server with features Auto, and Step and mode Off Low Med High Auto.
1511
+ *
1512
+ * @param {FanControl.FanMode} [fanMode] - The fan mode to set. Defaults to `FanControl.FanMode.Off`.
1513
+ * @param {FanControl.FanModeSequence} [fanModeSequence] - The fan mode sequence to set. Defaults to `FanControl.FanModeSequence.OffLowMedHighAuto`.
1514
+ * @param {number} [percentSetting] - The initial percent setting. Defaults to 0.
1515
+ * @param {number} [percentCurrent] - The initial percent current. Defaults to 0.
1516
+ * @returns {this} The current MatterbridgeEndpoint instance for chaining.
1517
+ *
1518
+ * @remarks
1519
+ * - fanmode is writable and persists across reboots.
1520
+ * - fanModeSequence is fixed.
1521
+ * - percentSetting is writable.
1522
+ */
806
1523
  createDefaultFanControlClusterServer(fanMode = FanControl.FanMode.Off, fanModeSequence = FanControl.FanModeSequence.OffLowMedHighAuto, percentSetting = 0, percentCurrent = 0) {
807
1524
  this.behaviors.require(MatterbridgeFanControlServer.with(FanControl.Feature.Auto, FanControl.Feature.Step), {
808
- fanMode,
809
- fanModeSequence,
810
- percentSetting,
1525
+ // Base fan control attributes
1526
+ fanMode, // Writable and persistent attribute
1527
+ fanModeSequence, // Fixed attribute
1528
+ percentSetting, // Writable attribute
811
1529
  percentCurrent,
812
1530
  });
813
1531
  return this;
814
1532
  }
1533
+ /**
1534
+ * Creates an On Off fan control cluster server without features and mode Off High.
1535
+ *
1536
+ * @param {FanControl.FanMode} [fanMode] - The fan mode to set. Defaults to `FanControl.FanMode.Off`.
1537
+ * @returns {this} The current MatterbridgeEndpoint instance for chaining.
1538
+ *
1539
+ * @remarks
1540
+ * fanmode is writable and persists across reboots.
1541
+ * fanModeSequence is fixed.
1542
+ * percentSetting is writable.
1543
+ */
815
1544
  createOnOffFanControlClusterServer(fanMode = FanControl.FanMode.Off) {
816
1545
  this.behaviors.require(FanControlServer, {
817
- fanMode,
818
- fanModeSequence: FanControl.FanModeSequence.OffHigh,
819
- percentSetting: 0,
1546
+ // Base fan control attributes
1547
+ fanMode, // Writable and persistent attribute
1548
+ fanModeSequence: FanControl.FanModeSequence.OffHigh, // Fixed attribute
1549
+ percentSetting: 0, // Writable attribute
820
1550
  percentCurrent: 0,
821
1551
  });
822
1552
  return this;
823
1553
  }
1554
+ /**
1555
+ * Creates a base fan control cluster server without features and mode Off Low Med High.
1556
+ *
1557
+ * @param {FanControl.FanMode} [fanMode] - The fan mode to set. Defaults to `FanControl.FanMode.Off`.
1558
+ * @param {FanControl.FanModeSequence} [fanModeSequence] - The fan mode sequence to set. Defaults to `FanControl.FanModeSequence.OffLowMedHigh`.
1559
+ * @param {number} [percentSetting] - The initial percent setting. Defaults to 0.
1560
+ * @param {number} [percentCurrent] - The initial percent current. Defaults to 0.
1561
+ * @returns {this} The current MatterbridgeEndpoint instance for chaining.
1562
+ *
1563
+ * @remarks
1564
+ * fanmode is writable and persists across reboots.
1565
+ * fanModeSequence is fixed.
1566
+ * percentSetting is writable.
1567
+ */
824
1568
  createBaseFanControlClusterServer(fanMode = FanControl.FanMode.Off, fanModeSequence = FanControl.FanModeSequence.OffLowMedHigh, percentSetting = 0, percentCurrent = 0) {
825
1569
  this.behaviors.require(FanControlServer, {
826
- fanMode,
827
- fanModeSequence,
828
- percentSetting,
1570
+ // Base fan control attributes
1571
+ fanMode, // Writable and persistent attribute
1572
+ fanModeSequence, // Fixed attribute
1573
+ percentSetting, // Writable attribute
829
1574
  percentCurrent,
830
1575
  });
831
1576
  return this;
832
1577
  }
1578
+ /**
1579
+ * Creates a fan control cluster server with features MultiSpeed, Auto, and Step and mode Off Low Med High Auto.
1580
+ *
1581
+ * @param {FanControl.FanMode} [fanMode] - The fan mode to set. Defaults to `FanControl.FanMode.Off`.
1582
+ * @param {FanControl.FanModeSequence} [fanModeSequence] - The fan mode sequence to set. Defaults to `FanControl.FanModeSequence.OffLowMedHighAuto`.
1583
+ * @param {number} [percentSetting] - The initial percent setting. Defaults to 0.
1584
+ * @param {number} [percentCurrent] - The initial percent current. Defaults to 0.
1585
+ * @param {number} [speedMax] - The maximum speed setting. Defaults to 10.
1586
+ * @param {number} [speedSetting] - The initial speed setting. Defaults to 0.
1587
+ * @param {number} [speedCurrent] - The initial speed current. Defaults to 0.
1588
+ * @returns {this} The current MatterbridgeEndpoint instance for chaining.
1589
+ *
1590
+ * @remarks
1591
+ * - fanmode is writable and persists across reboots.
1592
+ * - fanModeSequence is fixed.
1593
+ * - percentSetting is writable.
1594
+ * - speedMax is fixed.
1595
+ * - speedSetting is writable.
1596
+ */
833
1597
  createMultiSpeedFanControlClusterServer(fanMode = FanControl.FanMode.Off, fanModeSequence = FanControl.FanModeSequence.OffLowMedHighAuto, percentSetting = 0, percentCurrent = 0, speedMax = 10, speedSetting = 0, speedCurrent = 0) {
834
1598
  this.behaviors.require(MatterbridgeFanControlServer.with(FanControl.Feature.MultiSpeed, FanControl.Feature.Auto, FanControl.Feature.Step), {
835
- fanMode,
836
- fanModeSequence,
837
- percentSetting,
1599
+ // Base fan control attributes
1600
+ fanMode, // Writable and persistent attribute
1601
+ fanModeSequence, // Fixed attribute
1602
+ percentSetting, // Writable attribute
838
1603
  percentCurrent,
839
- speedMax,
840
- speedSetting,
1604
+ // MultiSpeed feature
1605
+ speedMax, // Fixed attribute
1606
+ speedSetting, // Writable attribute
841
1607
  speedCurrent,
842
1608
  });
843
1609
  return this;
844
1610
  }
1611
+ /**
1612
+ * Creates a fan control cluster server with features MultiSpeed, Auto, Step, Rock, Wind and AirflowDirection and mode Off Low Med High Auto.
1613
+ *
1614
+ * @param {FanControl.FanMode} [fanMode] - The fan mode to set. Defaults to `FanControl.FanMode.Off`.
1615
+ * @param {FanControl.FanModeSequence} [fanModeSequence] - The fan mode sequence to set. Defaults to `FanControl.FanModeSequence.OffLowMedHighAuto`.
1616
+ * @param {number} [percentSetting] - The initial percent setting. Defaults to 0.
1617
+ * @param {number} [percentCurrent] - The initial percent current. Defaults to 0.
1618
+ * @param {number} [speedMax] - The maximum speed setting. Defaults to 10.
1619
+ * @param {number} [speedSetting] - The initial speed setting. Defaults to 0.
1620
+ * @param {number} [speedCurrent] - The initial speed current. Defaults to 0.
1621
+ * @param {object} [rockSupport] - The rock support configuration.
1622
+ * @param {boolean} rockSupport.rockLeftRight - Indicates support for rocking left to right. Defaults to true.
1623
+ * @param {boolean} rockSupport.rockUpDown - Indicates support for rocking up and down. Defaults to true.
1624
+ * @param {boolean} rockSupport.rockRound - Indicates support for round rocking. Defaults to true.
1625
+ * @param {object} [rockSetting] - The rock setting configuration.
1626
+ * @param {boolean} rockSetting.rockLeftRight - Indicates the current setting for rocking left to right. Defaults to true.
1627
+ * @param {boolean} rockSetting.rockUpDown - Indicates the current setting for rocking up and down. Defaults to true.
1628
+ * @param {boolean} rockSetting.rockRound - Indicates the current setting for round rocking. Defaults to true.
1629
+ * @param {object} [windSupport] - The wind support configuration.
1630
+ * @param {boolean} windSupport.sleepWind - Indicates support for sleep wind. Defaults to true.
1631
+ * @param {boolean} windSupport.naturalWind - Indicates support for natural wind. Defaults to true.
1632
+ * @param {object} [windSetting] - The wind setting configuration.
1633
+ * @param {boolean} windSetting.sleepWind - Indicates the current setting for sleep wind. Defaults to false.
1634
+ * @param {boolean} windSetting.naturalWind - Indicates the current setting for natural wind. Defaults to true.
1635
+ * @param {FanControl.AirflowDirection} [airflowDirection] - The airflow direction. Defaults to `FanControl.AirflowDirection.Forward`.
1636
+ * @returns {this} The current MatterbridgeEndpoint instance for chaining.
1637
+ *
1638
+ * @remarks
1639
+ * - fanmode is writable and persists across reboots.
1640
+ * - fanModeSequence is fixed.
1641
+ * - percentSetting is writable.
1642
+ * - speedMax is fixed.
1643
+ * - speedSetting is writable.
1644
+ * - rockSupport is fixed.
1645
+ * - rockSetting is writable.
1646
+ * - windSupport is fixed.
1647
+ * - windSetting is writable.
1648
+ * - airflowDirection is writable.
1649
+ */
845
1650
  createCompleteFanControlClusterServer(fanMode = FanControl.FanMode.Off, fanModeSequence = FanControl.FanModeSequence.OffLowMedHighAuto, percentSetting = 0, percentCurrent = 0, speedMax = 10, speedSetting = 0, speedCurrent = 0, rockSupport = { rockLeftRight: true, rockUpDown: true, rockRound: true }, rockSetting = { rockLeftRight: true, rockUpDown: false, rockRound: false }, windSupport = { sleepWind: true, naturalWind: true }, windSetting = { sleepWind: false, naturalWind: true }, airflowDirection = FanControl.AirflowDirection.Forward) {
846
1651
  this.behaviors.require(MatterbridgeFanControlServer.with(FanControl.Feature.MultiSpeed, FanControl.Feature.Auto, FanControl.Feature.Step, FanControl.Feature.Rocking, FanControl.Feature.Wind, FanControl.Feature.AirflowDirection), {
847
- fanMode,
848
- fanModeSequence,
849
- percentSetting,
1652
+ // Base fan control attributes
1653
+ fanMode, // Writable and persistent attribute
1654
+ fanModeSequence, // Fixed attribute
1655
+ percentSetting, // Writable attribute
850
1656
  percentCurrent,
851
- speedMax,
852
- speedSetting,
1657
+ // MultiSpeed feature
1658
+ speedMax, // Fixed attribute
1659
+ speedSetting, // Writable attribute
853
1660
  speedCurrent,
854
- rockSupport,
855
- rockSetting,
856
- windSupport,
857
- windSetting,
858
- airflowDirection,
1661
+ // Rocking feature
1662
+ rockSupport, // Fixed attribute
1663
+ rockSetting, // Writable attribute
1664
+ // Wind feature
1665
+ windSupport, // Fixed attribute
1666
+ windSetting, // Writable attribute
1667
+ // AirflowDirection feature
1668
+ airflowDirection, // Writable attribute
859
1669
  });
860
1670
  return this;
861
1671
  }
1672
+ /**
1673
+ * Creates a default HEPA Filter Monitoring Cluster Server with features Condition and ReplacementProductList.
1674
+ * It supports ResourceMonitoring.Feature.Condition, ResourceMonitoring.Feature.Warning, and ResourceMonitoring.Feature.ReplacementProductList.
1675
+ *
1676
+ * @param {number} condition - The initial condition value (range 0-100). Default is 100.
1677
+ * @param {ResourceMonitoring.ChangeIndication} changeIndication - The initial change indication. Default is ResourceMonitoring.ChangeIndication.Ok.
1678
+ * @param {boolean | undefined} inPlaceIndicator - The in-place indicator. Default is true.
1679
+ * @param {number | undefined} lastChangedTime - The last changed time (EpochS). Default is null.
1680
+ * @param {ResourceMonitoring.ReplacementProduct[]} replacementProductList - The list of replacement products. Default is an empty array. It is a fixed attribute.
1681
+ *
1682
+ * @returns {this} The current MatterbridgeEndpoint instance for chaining.
1683
+ *
1684
+ * @remarks
1685
+ * The HEPA Filter Monitoring Cluster Server is used to monitor the status of HEPA filters.
1686
+ * It provides information about the condition of the filter, whether it is in place, and the last time it was changed.
1687
+ * The change indication can be used to indicate if the filter needs to be replaced or serviced.
1688
+ * The replacement product list can be used to provide a list of replacement products for the filter.
1689
+ * The condition attribute is fixed at 100, indicating a healthy filter.
1690
+ * The degradation direction is fixed at ResourceMonitoring.DegradationDirection.Down, indicating that a lower value indicates a worse condition.
1691
+ * The replacement product list is initialized as an empty array.
1692
+ */
862
1693
  createDefaultHepaFilterMonitoringClusterServer(condition = 100, changeIndication = ResourceMonitoring.ChangeIndication.Ok, inPlaceIndicator = true, lastChangedTime = null, replacementProductList = []) {
863
1694
  this.behaviors.require(MatterbridgeHepaFilterMonitoringServer.with(ResourceMonitoring.Feature.Condition, ResourceMonitoring.Feature.Warning, ResourceMonitoring.Feature.ReplacementProductList), {
1695
+ // Feature.Condition
864
1696
  condition,
865
- degradationDirection: ResourceMonitoring.DegradationDirection.Down,
866
- replacementProductList,
1697
+ degradationDirection: ResourceMonitoring.DegradationDirection.Down, // Fixed attribute
1698
+ // Feature.ReplacementProductList
1699
+ replacementProductList, // Fixed attribute
1700
+ // Base attributes
867
1701
  changeIndication,
868
1702
  inPlaceIndicator,
869
- lastChangedTime,
1703
+ lastChangedTime, // Writable and persistent across restarts
870
1704
  });
871
1705
  return this;
872
1706
  }
1707
+ /**
1708
+ * Creates a default Activated Carbon Filter Monitoring Cluster Server with features Condition and ReplacementProductList.
1709
+ * It supports ResourceMonitoring.Feature.Condition, ResourceMonitoring.Feature.Warning, and ResourceMonitoring.Feature.ReplacementProductList.
1710
+ *
1711
+ * @param {number} condition - The initial condition value (range 0-100). Default is 100.
1712
+ * @param {ResourceMonitoring.ChangeIndication} changeIndication - The initial change indication. Default is ResourceMonitoring.ChangeIndication.Ok.
1713
+ * @param {boolean | undefined} inPlaceIndicator - The in-place indicator. Default is undefined.
1714
+ * @param {number | undefined} lastChangedTime - The last changed time (EpochS). Default is undefined.
1715
+ * @param {ResourceMonitoring.ReplacementProduct[]} replacementProductList - The list of replacement products. Default is an empty array. It is a fixed attribute.
1716
+ *
1717
+ * @returns {this} The current MatterbridgeEndpoint instance for chaining.
1718
+ *
1719
+ * @remarks
1720
+ * The Activated Carbon Filter Monitoring Cluster Server is used to monitor the status of activated carbon filters.
1721
+ * It provides information about the condition of the filter, whether it is in place, and the last time it was changed.
1722
+ * The change indication can be used to indicate if the filter needs to be replaced or serviced.
1723
+ * The replacement product list can be used to provide a list of replacement products for the filter.
1724
+ * The condition attribute is fixed at 100, indicating a healthy filter.
1725
+ * The degradation direction is fixed at ResourceMonitoring.DegradationDirection.Down, indicating that a lower value indicates a worse condition.
1726
+ * The replacement product list is initialized as an empty array.
1727
+ */
873
1728
  createDefaultActivatedCarbonFilterMonitoringClusterServer(condition = 100, changeIndication = ResourceMonitoring.ChangeIndication.Ok, inPlaceIndicator = true, lastChangedTime = null, replacementProductList = []) {
874
1729
  this.behaviors.require(MatterbridgeActivatedCarbonFilterMonitoringServer.with(ResourceMonitoring.Feature.Condition, ResourceMonitoring.Feature.Warning, ResourceMonitoring.Feature.ReplacementProductList), {
1730
+ // Feature.Condition
875
1731
  condition,
876
1732
  degradationDirection: ResourceMonitoring.DegradationDirection.Down,
877
- replacementProductList,
1733
+ // Feature.ReplacementProductList
1734
+ replacementProductList, // Fixed attribute
1735
+ // Base attributes
878
1736
  changeIndication,
879
1737
  inPlaceIndicator,
880
- lastChangedTime,
1738
+ lastChangedTime, // Writable and persistent across restarts
881
1739
  });
882
1740
  return this;
883
1741
  }
1742
+ /**
1743
+ * Creates a default door lock cluster server.
1744
+ *
1745
+ * @param {DoorLock.LockState} [lockState] - The initial state of the lock (default: Locked).
1746
+ * @param {DoorLock.LockType} [lockType] - The type of the lock (default: DeadBolt).
1747
+ * @returns {this} The current MatterbridgeEndpoint instance for chaining.
1748
+ *
1749
+ * @remarks
1750
+ * All operating modes NOT supported by a lock SHALL be set to one. The value of the OperatingMode enumeration defines the related bit to be set.
1751
+ */
884
1752
  createDefaultDoorLockClusterServer(lockState = DoorLock.LockState.Locked, lockType = DoorLock.LockType.DeadBolt) {
885
1753
  this.behaviors.require(MatterbridgeDoorLockServer.enable({ events: { doorLockAlarm: true, lockOperation: true, lockOperationError: true } }), {
886
1754
  lockState,
887
1755
  lockType,
888
1756
  actuatorEnabled: false,
889
1757
  operatingMode: DoorLock.OperatingMode.Normal,
1758
+ // Special case of inverted bitmap: add also alwaysSet = 2047
890
1759
  supportedOperatingModes: { normal: false, vacation: true, privacy: true, noRemoteLockUnlock: true, passage: true, alwaysSet: 2047 },
891
1760
  alarmMask: { lockJammed: false, lockFactoryReset: false, lockRadioPowerCycled: false, wrongCodeEntryLimit: false, frontEscutcheonRemoved: false, doorForcedOpen: false },
892
1761
  });
893
1762
  return this;
894
1763
  }
1764
+ /**
1765
+ * Creates a default Mode Select cluster server.
1766
+ *
1767
+ * @param {string} description - The description of the mode select cluster.
1768
+ * @param {ModeSelect.ModeOption[]} supportedModes - The list of supported modes.
1769
+ * @param {number} [currentMode] - The current mode (default: 0).
1770
+ * @param {number} [startUpMode] - The startup mode (default: 0).
1771
+ * @returns {this} The current MatterbridgeEndpoint instance for chaining.
1772
+ *
1773
+ * @remarks
1774
+ * endpoint.createDefaultModeSelectClusterServer('Night mode', [{ label: 'Led ON', mode: 0, semanticTags: [] }, { label: 'Led OFF', mode: 1, semanticTags: [] }], 0, 0);
1775
+ */
895
1776
  createDefaultModeSelectClusterServer(description, supportedModes, currentMode = 0, startUpMode = 0) {
896
1777
  this.behaviors.require(MatterbridgeModeSelectServer, {
897
1778
  description: description,
@@ -902,21 +1783,35 @@ export class MatterbridgeEndpoint extends Endpoint {
902
1783
  });
903
1784
  return this;
904
1785
  }
1786
+ /**
1787
+ * Creates the default Valve Configuration And Control cluster server with features Level.
1788
+ *
1789
+ * @param {ValveConfigurationAndControl.ValveState} [valveState] - The valve state to set. Defaults to `ValveConfigurationAndControl.ValveState.Closed`.
1790
+ * @param {number} [valveLevel] - The valve level to set. Defaults to 0.
1791
+ * @returns {this} The current MatterbridgeEndpoint instance for chaining.
1792
+ */
905
1793
  createDefaultValveConfigurationAndControlClusterServer(valveState = ValveConfigurationAndControl.ValveState.Closed, valveLevel = 0) {
906
1794
  this.behaviors.require(MatterbridgeValveConfigurationAndControlServer.with(ValveConfigurationAndControl.Feature.Level), {
907
1795
  currentState: valveState,
908
1796
  targetState: valveState,
909
1797
  openDuration: null,
910
- defaultOpenDuration: null,
1798
+ defaultOpenDuration: null, // Writable and persistent across restarts
911
1799
  remainingDuration: null,
912
1800
  valveFault: { generalFault: false, blocked: false, leaking: false, notConnected: false, shortCircuit: false, currentExceeded: false },
1801
+ // Feature.Level
913
1802
  currentLevel: valveLevel,
914
1803
  targetLevel: valveLevel,
915
- defaultOpenLevel: 100,
916
- levelStep: 1,
1804
+ defaultOpenLevel: 100, // Writable and persistent across restarts
1805
+ levelStep: 1, // Fixed
917
1806
  });
918
1807
  return this;
919
1808
  }
1809
+ /**
1810
+ * Creates the default PumpConfigurationAndControl cluster server with features ConstantSpeed.
1811
+ *
1812
+ * @param {PumpConfigurationAndControl.OperationMode} [pumpMode] - The pump mode to set. Defaults to `PumpConfigurationAndControl.OperationMode.Normal`.
1813
+ * @returns {this} The current MatterbridgeEndpoint instance for chaining.
1814
+ */
920
1815
  createDefaultPumpConfigurationAndControlClusterServer(pumpMode = PumpConfigurationAndControl.OperationMode.Normal) {
921
1816
  this.behaviors.require(PumpConfigurationAndControlServer.with(PumpConfigurationAndControl.Feature.ConstantSpeed), {
922
1817
  minConstSpeed: null,
@@ -931,6 +1826,13 @@ export class MatterbridgeEndpoint extends Endpoint {
931
1826
  });
932
1827
  return this;
933
1828
  }
1829
+ /**
1830
+ * Creates the default SmokeCOAlarm Cluster Server with features SmokeAlarm and CoAlarm.
1831
+ *
1832
+ * @param {SmokeCoAlarm.AlarmState} smokeState - The state of the smoke alarm. Defaults to SmokeCoAlarm.AlarmState.Normal.
1833
+ * @param {SmokeCoAlarm.AlarmState} coState - The state of the CO alarm. Defaults to SmokeCoAlarm.AlarmState.Normal.
1834
+ * @returns {this} The current MatterbridgeEndpoint instance for chaining.
1835
+ */
934
1836
  createDefaultSmokeCOAlarmClusterServer(smokeState = SmokeCoAlarm.AlarmState.Normal, coState = SmokeCoAlarm.AlarmState.Normal) {
935
1837
  this.behaviors.require(MatterbridgeSmokeCoAlarmServer.with(SmokeCoAlarm.Feature.SmokeAlarm, SmokeCoAlarm.Feature.CoAlarm).enable({
936
1838
  events: { smokeAlarm: true, interconnectSmokeAlarm: false, coAlarm: true, interconnectCoAlarm: false, lowBattery: true, hardwareFault: true, endOfService: true, selfTestComplete: true, alarmMuted: true, muteEnded: true, allClear: true },
@@ -946,6 +1848,12 @@ export class MatterbridgeEndpoint extends Endpoint {
946
1848
  });
947
1849
  return this;
948
1850
  }
1851
+ /**
1852
+ * Creates a smoke only SmokeCOAlarm Cluster Server with features SmokeAlarm.
1853
+ *
1854
+ * @param {SmokeCoAlarm.AlarmState} smokeState - The state of the smoke alarm. Defaults to SmokeCoAlarm.AlarmState.Normal.
1855
+ * @returns {this} The current MatterbridgeEndpoint instance for chaining.
1856
+ */
949
1857
  createSmokeOnlySmokeCOAlarmClusterServer(smokeState = SmokeCoAlarm.AlarmState.Normal) {
950
1858
  this.behaviors.require(MatterbridgeSmokeCoAlarmServer.with(SmokeCoAlarm.Feature.SmokeAlarm).enable({
951
1859
  events: { smokeAlarm: true, interconnectSmokeAlarm: false, coAlarm: false, interconnectCoAlarm: false, lowBattery: true, hardwareFault: true, endOfService: true, selfTestComplete: true, alarmMuted: true, muteEnded: true, allClear: true },
@@ -960,6 +1868,12 @@ export class MatterbridgeEndpoint extends Endpoint {
960
1868
  });
961
1869
  return this;
962
1870
  }
1871
+ /**
1872
+ * Creates a co only SmokeCOAlarm Cluster Server with features CoAlarm.
1873
+ *
1874
+ * @param {SmokeCoAlarm.AlarmState} coState - The state of the CO alarm. Defaults to SmokeCoAlarm.AlarmState.Normal.
1875
+ * @returns {this} The current MatterbridgeEndpoint instance for chaining.
1876
+ */
963
1877
  createCoOnlySmokeCOAlarmClusterServer(coState = SmokeCoAlarm.AlarmState.Normal) {
964
1878
  this.behaviors.require(MatterbridgeSmokeCoAlarmServer.with(SmokeCoAlarm.Feature.CoAlarm).enable({
965
1879
  events: { smokeAlarm: false, interconnectSmokeAlarm: false, coAlarm: true, interconnectCoAlarm: false, lowBattery: true, hardwareFault: true, endOfService: true, selfTestComplete: true, alarmMuted: true, muteEnded: true, allClear: true },
@@ -974,6 +1888,15 @@ export class MatterbridgeEndpoint extends Endpoint {
974
1888
  });
975
1889
  return this;
976
1890
  }
1891
+ /**
1892
+ * Creates a default momentary switch cluster server with features MomentarySwitch, MomentarySwitchRelease, MomentarySwitchLongPress and MomentarySwitchMultiPress
1893
+ * and events initialPress, longPress, shortRelease, longRelease, multiPressOngoing, multiPressComplete.
1894
+ *
1895
+ * @returns {this} The current MatterbridgeEndpoint instance for chaining.
1896
+ *
1897
+ * @remarks
1898
+ * This method adds a cluster server with default momentary switch features and configuration suitable for (AppleHome) Single Double Long automations.
1899
+ */
977
1900
  createDefaultSwitchClusterServer() {
978
1901
  this.behaviors.require(MatterbridgeSwitchServer.with(Switch.Feature.MomentarySwitch, Switch.Feature.MomentarySwitchRelease, Switch.Feature.MomentarySwitchLongPress, Switch.Feature.MomentarySwitchMultiPress).enable({
979
1902
  events: { initialPress: true, longPress: true, shortRelease: true, longRelease: true, multiPressOngoing: true, multiPressComplete: true },
@@ -984,6 +1907,15 @@ export class MatterbridgeEndpoint extends Endpoint {
984
1907
  });
985
1908
  return this;
986
1909
  }
1910
+ /**
1911
+ * Creates a default momentary switch cluster server with feature MomentarySwitch and event initialPress.
1912
+ *
1913
+ * @returns {this} The current MatterbridgeEndpoint instance for chaining.
1914
+ *
1915
+ * @remarks
1916
+ * This method adds a cluster server with default momentary switch features and configuration suitable for a Single press automations.
1917
+ * It is supported by the Home app.
1918
+ */
987
1919
  createDefaultMomentarySwitchClusterServer() {
988
1920
  this.behaviors.require(MatterbridgeSwitchServer.with(Switch.Feature.MomentarySwitch).enable({
989
1921
  events: { initialPress: true },
@@ -993,6 +1925,14 @@ export class MatterbridgeEndpoint extends Endpoint {
993
1925
  });
994
1926
  return this;
995
1927
  }
1928
+ /**
1929
+ * Creates a default latching switch cluster server with features LatchingSwitch.
1930
+ *
1931
+ * @returns {this} The current MatterbridgeEndpoint instance for chaining.
1932
+ *
1933
+ * @remarks
1934
+ * This method adds a cluster server with default latching switch features and configuration suitable for a latching switch with 2 positions.
1935
+ */
996
1936
  createDefaultLatchingSwitchClusterServer() {
997
1937
  this.behaviors.require(SwitchServer.with(Switch.Feature.LatchingSwitch).enable({
998
1938
  events: { switchLatched: true },
@@ -1002,6 +1942,15 @@ export class MatterbridgeEndpoint extends Endpoint {
1002
1942
  });
1003
1943
  return this;
1004
1944
  }
1945
+ /**
1946
+ * Triggers a switch event on the specified endpoint.
1947
+ * We usually use get from real devices something like 'single', 'double', 'long'.
1948
+ * Here we convert it to the Matter sequence of events (taken from Matter specs).
1949
+ *
1950
+ * @param {string} event - The type of event to trigger. Possible values are 'Single', 'Double', 'Long' for momentarySwitch and 'Press', 'Release' for latchingSwitch.
1951
+ * @param {AnsiLogger} log - Optional logger to log the event.
1952
+ * @returns {boolean} - A boolean indicating whether the event was successfully triggered.
1953
+ */
1005
1954
  async triggerSwitchEvent(event, log) {
1006
1955
  if (this.maybeNumber === undefined) {
1007
1956
  this.log.error(`triggerSwitchEvent ${event} error: Endpoint number not assigned on endpoint ${this.maybeId}:${this.maybeNumber}`);
@@ -1063,10 +2012,37 @@ export class MatterbridgeEndpoint extends Endpoint {
1063
2012
  }
1064
2013
  return true;
1065
2014
  }
2015
+ /**
2016
+ * Creates a default OperationalState Cluster Server.
2017
+ *
2018
+ * @param {OperationalState.OperationalStateEnum} operationalState - The initial operational state id.
2019
+ *
2020
+ * @returns {this} The current MatterbridgeEndpoint instance for chaining.
2021
+ *
2022
+ * @remarks
2023
+ * This method adds a cluster server with a default operational state configuration:
2024
+ * - { operationalStateId: OperationalState.OperationalStateEnum.Stopped, operationalStateLabel: 'Stopped' },
2025
+ * - { operationalStateId: OperationalState.OperationalStateEnum.Running, operationalStateLabel: 'Running' },
2026
+ * - { operationalStateId: OperationalState.OperationalStateEnum.Paused, operationalStateLabel: 'Paused' },
2027
+ * - { operationalStateId: OperationalState.OperationalStateEnum.Error, operationalStateLabel: 'Error' },
2028
+ */
1066
2029
  createDefaultOperationalStateClusterServer(operationalState = OperationalState.OperationalStateEnum.Stopped) {
1067
2030
  this.behaviors.require(MatterbridgeOperationalStateServer, getDefaultOperationalStateClusterServer(operationalState));
1068
2031
  return this;
1069
2032
  }
2033
+ /**
2034
+ * Creates a default boolean state cluster server.
2035
+ * The stateChange event is enabled.
2036
+ *
2037
+ * @param {boolean} contact - The state of the cluster. Defaults to true (true = contact).
2038
+ * @returns {this} The current MatterbridgeEndpoint instance for chaining.
2039
+ *
2040
+ * @remarks
2041
+ * Water Leak Detector: true = leak, false = no leak
2042
+ * Water Freeze Detector: true = freeze, false = no freeze
2043
+ * Rain Sensor: true = rain, false = no rain
2044
+ * Contact Sensor: true = closed or contact, false = open or no contact
2045
+ */
1070
2046
  createDefaultBooleanStateClusterServer(contact) {
1071
2047
  this.behaviors.require(BooleanStateServer.enable({
1072
2048
  events: { stateChange: true },
@@ -1075,6 +2051,22 @@ export class MatterbridgeEndpoint extends Endpoint {
1075
2051
  });
1076
2052
  return this;
1077
2053
  }
2054
+ /**
2055
+ * Creates a default boolean state configuration cluster server to be used with the waterFreezeDetector, waterLeakDetector, and rainSensor device types.
2056
+ *
2057
+ * Features:
2058
+ * - Visual
2059
+ * - Audible
2060
+ * - SensitivityLevel
2061
+ *
2062
+ * @remarks Supports the enableDisableAlarm command.
2063
+ *
2064
+ * @param {boolean} [sensorFault] - Optional boolean value indicating the sensor fault state. Defaults to `false` if not provided.
2065
+ * @param {number} [currentSensitivityLevel] - The current sensitivity level. Defaults to `0` if not provided.
2066
+ * @param {number} [supportedSensitivityLevels] - The number of supported sensitivity levels. Defaults to `2` if not provided (min 2, max 10).
2067
+ * @param {number} [defaultSensitivityLevel] - The default sensitivity level. Defaults to `0` if not provided.
2068
+ * @returns {this} The current MatterbridgeEndpoint instance for chaining.
2069
+ */
1078
2070
  createDefaultBooleanStateConfigurationClusterServer(sensorFault = false, currentSensitivityLevel = 0, supportedSensitivityLevels = 2, defaultSensitivityLevel = 0) {
1079
2071
  this.behaviors.require(MatterbridgeBooleanStateConfigurationServer.with(BooleanStateConfiguration.Feature.Visual, BooleanStateConfiguration.Feature.Audible, BooleanStateConfiguration.Feature.SensitivityLevel).enable({
1080
2072
  events: { alarmsStateChanged: true, sensorFault: true },
@@ -1089,18 +2081,51 @@ export class MatterbridgeEndpoint extends Endpoint {
1089
2081
  });
1090
2082
  return this;
1091
2083
  }
2084
+ /**
2085
+ * Creates a default Device Energy Management Cluster Server with feature PowerForecastReporting and with the specified ESA type, ESA canGenerate, ESA state, and power limits.
2086
+ *
2087
+ * @param {DeviceEnergyManagement.EsaType} [esaType] - The ESA type. Defaults to `DeviceEnergyManagement.EsaType.Other`.
2088
+ * @param {boolean} [esaCanGenerate] - Indicates if the ESA can generate energy. Defaults to `false`.
2089
+ * @param {DeviceEnergyManagement.EsaState} [esaState] - The ESA state. Defaults to `DeviceEnergyManagement.EsaState.Online`.
2090
+ * @param {number} [absMinPower] - Indicate the minimum electrical power in mw that the ESA can consume when switched on. Defaults to `0` if not provided.
2091
+ * @param {number} [absMaxPower] - Indicate the maximum electrical power in mw that the ESA can consume when switched on. Defaults to `0` if not provided.
2092
+ * @returns {this} The current MatterbridgeEndpoint instance for chaining.
2093
+ *
2094
+ * @remarks
2095
+ * - The forecast attribute is set to null, indicating that there is no forecast currently available.
2096
+ * - The ESA type and canGenerate attributes are fixed and cannot be changed after creation.
2097
+ * - The ESA state is set to Online by default.
2098
+ * - The absolute minimum and maximum power attributes are set to 0 by default.
2099
+ * - For example, a battery storage inverter that can charge its battery at a maximum power of 2000W and can
2100
+ * discharge the battery at a maximum power of 3000W, would have a absMinPower: -3000W, absMaxPower: 2000W.
2101
+ */
1092
2102
  createDefaultDeviceEnergyManagementClusterServer(esaType = DeviceEnergyManagement.EsaType.Other, esaCanGenerate = false, esaState = DeviceEnergyManagement.EsaState.Online, absMinPower = 0, absMaxPower = 0) {
1093
2103
  this.behaviors.require(MatterbridgeDeviceEnergyManagementServer.with(DeviceEnergyManagement.Feature.PowerForecastReporting, DeviceEnergyManagement.Feature.PowerAdjustment), {
1094
- forecast: null,
1095
- powerAdjustmentCapability: null,
1096
- esaType,
1097
- esaCanGenerate,
2104
+ forecast: null, // A null value indicates that there is no forecast currently available
2105
+ powerAdjustmentCapability: null, // A null value indicates that no power adjustment is currently possible, and nor is any adjustment currently active
2106
+ esaType, // Fixed attribute
2107
+ esaCanGenerate, // Fixed attribute
1098
2108
  esaState,
1099
2109
  absMinPower,
1100
2110
  absMaxPower,
1101
2111
  });
1102
2112
  return this;
1103
2113
  }
2114
+ /**
2115
+ * Creates a default EnergyManagementMode Cluster Server.
2116
+ *
2117
+ * @param {number} [currentMode] - The current mode of the EnergyManagementMode cluster. Defaults to mode 1 (DeviceEnergyManagementMode.ModeTag.NoOptimization).
2118
+ * @param {EnergyManagementMode.ModeOption[]} [supportedModes] - The supported modes for the DeviceEnergyManagementMode cluster. The attribute is fixed and defaults to a predefined set of cluster modes.
2119
+ * @returns {this} The current MatterbridgeEndpoint instance for chaining.
2120
+ *
2121
+ * @remarks
2122
+ * A few examples of Device Energy Management modes and their mode tags are provided below.
2123
+ * - For the "No Energy Management (Forecast reporting only)" mode, tags: 0x4000 (NoOptimization).
2124
+ * - For the "Device Energy Management" mode, tags: 0x4001 (DeviceOptimization).
2125
+ * - For the "Home Energy Management" mode, tags: 0x4001 (DeviceOptimization), 0x4002 (LocalOptimization).
2126
+ * - For the "Grid Energy Management" mode, tags: 0x4003 (GridOptimization).
2127
+ * - For the "Full Energy Management" mode, tags: 0x4001 (DeviceOptimization), 0x4002 (LocalOptimization), 0x4003 (GridOptimization).
2128
+ */
1104
2129
  createDefaultDeviceEnergyManagementModeClusterServer(currentMode, supportedModes) {
1105
2130
  this.behaviors.require(MatterbridgeDeviceEnergyManagementModeServer, {
1106
2131
  supportedModes: supportedModes ?? [
@@ -1121,15 +2146,27 @@ export class MatterbridgeEndpoint extends Endpoint {
1121
2146
  mode: 5,
1122
2147
  modeTags: [{ value: DeviceEnergyManagementMode.ModeTag.DeviceOptimization }, { value: DeviceEnergyManagementMode.ModeTag.LocalOptimization }, { value: DeviceEnergyManagementMode.ModeTag.GridOptimization }],
1123
2148
  },
1124
- ],
2149
+ ], // Fixed attribute
1125
2150
  currentMode: currentMode ?? 1,
1126
2151
  });
1127
2152
  return this;
1128
2153
  }
2154
+ /**
2155
+ * Creates a default Power Topology Cluster Server with feature TreeTopology (the endpoint provides or consumes power to/from itself and its child endpoints). Only needed for an electricalSensor device type.
2156
+ *
2157
+ * @returns {this} The current MatterbridgeEndpoint instance for chaining.
2158
+ */
1129
2159
  createDefaultPowerTopologyClusterServer() {
1130
2160
  this.behaviors.require(PowerTopologyServer.with(PowerTopology.Feature.TreeTopology));
1131
2161
  return this;
1132
2162
  }
2163
+ /**
2164
+ * Creates a default Electrical Energy Measurement Cluster Server with features ImportedEnergy, ExportedEnergy, and CumulativeEnergy.
2165
+ *
2166
+ * @param {number} energyImported - The total consumption value in mW/h.
2167
+ * @param {number} energyExported - The total production value in mW/h.
2168
+ * @returns {this} The current MatterbridgeEndpoint instance for chaining.
2169
+ */
1133
2170
  createDefaultElectricalEnergyMeasurementClusterServer(energyImported = null, energyExported = null) {
1134
2171
  this.behaviors.require(ElectricalEnergyMeasurementServer.with(ElectricalEnergyMeasurement.Feature.ImportedEnergy, ElectricalEnergyMeasurement.Feature.ExportedEnergy, ElectricalEnergyMeasurement.Feature.CumulativeEnergy), {
1135
2172
  accuracy: {
@@ -1145,6 +2182,15 @@ export class MatterbridgeEndpoint extends Endpoint {
1145
2182
  });
1146
2183
  return this;
1147
2184
  }
2185
+ /**
2186
+ * Creates a default Electrical Power Measurement Cluster Server with features AlternatingCurrent.
2187
+ *
2188
+ * @param {number} voltage - The voltage value in millivolts.
2189
+ * @param {number} current - The current value in milliamperes.
2190
+ * @param {number} power - The power value in milliwatts.
2191
+ * @param {number} frequency - The frequency value in millihertz.
2192
+ * @returns {this} The current MatterbridgeEndpoint instance for chaining.
2193
+ */
1148
2194
  createDefaultElectricalPowerMeasurementClusterServer(voltage = null, current = null, power = null, frequency = null) {
1149
2195
  this.behaviors.require(ElectricalPowerMeasurementServer.with(ElectricalPowerMeasurement.Feature.AlternatingCurrent), {
1150
2196
  powerMode: ElectricalPowerMeasurement.PowerMode.Ac,
@@ -1186,36 +2232,127 @@ export class MatterbridgeEndpoint extends Endpoint {
1186
2232
  });
1187
2233
  return this;
1188
2234
  }
2235
+ /**
2236
+ * Creates a default TemperatureMeasurement cluster server.
2237
+ *
2238
+ * @param {number | null} measuredValue - The measured value of the temperature x 100.
2239
+ * @param {number | null} minMeasuredValue - The minimum measured value of the temperature x 100.
2240
+ * @param {number | null} maxMeasuredValue - The maximum measured value of the temperature x 100.
2241
+ * @returns {this} The current MatterbridgeEndpoint instance for chaining.
2242
+ */
1189
2243
  createDefaultTemperatureMeasurementClusterServer(measuredValue = null, minMeasuredValue = null, maxMeasuredValue = null) {
1190
2244
  this.behaviors.require(TemperatureMeasurementServer, getDefaultTemperatureMeasurementClusterServer(measuredValue, minMeasuredValue, maxMeasuredValue));
1191
2245
  return this;
1192
2246
  }
2247
+ /**
2248
+ * Creates a default RelativeHumidityMeasurement cluster server.
2249
+ *
2250
+ * @param {number | null} measuredValue - The measured value of the relative humidity x 100.
2251
+ * @param {number | null} minMeasuredValue - The minimum measured value of the relative humidity x 100.
2252
+ * @param {number | null} maxMeasuredValue - The maximum measured value of the relative humidity x 100.
2253
+ * @returns {this} The current MatterbridgeEndpoint instance for chaining.
2254
+ */
1193
2255
  createDefaultRelativeHumidityMeasurementClusterServer(measuredValue = null, minMeasuredValue = null, maxMeasuredValue = null) {
1194
2256
  this.behaviors.require(RelativeHumidityMeasurementServer, getDefaultRelativeHumidityMeasurementClusterServer(measuredValue, minMeasuredValue, maxMeasuredValue));
1195
2257
  return this;
1196
2258
  }
2259
+ /**
2260
+ * Creates a default PressureMeasurement cluster server.
2261
+ *
2262
+ * @param {number | null} measuredValue - The measured value for the pressure in kPa x 10.
2263
+ * @param {number | null} minMeasuredValue - The minimum measured value for the pressure in kPa x 10.
2264
+ * @param {number | null} maxMeasuredValue - The maximum measured value for the pressure in kPa x 10.
2265
+ * @returns {this} The current MatterbridgeEndpoint instance for chaining.
2266
+ *
2267
+ * @remarks
2268
+ * - MeasuredValue = 10 x Pressure in kPa
2269
+ * - MeasuredValue = 1 x Pressure in hPa
2270
+ * - MeasuredValue = 33.8639 x Pressure in inHg
2271
+ *
2272
+ * Conversion:
2273
+ * - 1 kPa = 10 hPa
2274
+ * - 1 inHg = 33.8639 hPa
2275
+ */
1197
2276
  createDefaultPressureMeasurementClusterServer(measuredValue = null, minMeasuredValue = null, maxMeasuredValue = null) {
1198
2277
  this.behaviors.require(PressureMeasurementServer, getDefaultPressureMeasurementClusterServer(measuredValue, minMeasuredValue, maxMeasuredValue));
1199
2278
  return this;
1200
2279
  }
2280
+ /**
2281
+ * Creates a default IlluminanceMeasurement cluster server.
2282
+ *
2283
+ * @param {number | null} measuredValue - The measured value of illuminance.
2284
+ * @param {number | null} minMeasuredValue - The minimum measured value of illuminance.
2285
+ * @param {number | null} maxMeasuredValue - The maximum measured value of illuminance.
2286
+ * @returns {this} The current MatterbridgeEndpoint instance for chaining.
2287
+ *
2288
+ * @remarks
2289
+ *
2290
+ * The default value for the illuminance measurement is null.
2291
+ *
2292
+ * This attribute SHALL indicate the illuminance in Lux (symbol lx) as follows:
2293
+ * • MeasuredValue = 10,000 x log10(illuminance) + 1,
2294
+ * where 1 lx <= illuminance <= 3.576 Mlx, corresponding to a MeasuredValue in the range 1 to 0xFFFE.
2295
+ * • 0 indicates a value of illuminance that is too low to be measured
2296
+ * • null indicates that the illuminance measurement is invalid.
2297
+ *
2298
+ * - Lux to matter = Math.round(Math.max(Math.min(10000 * Math.log10(lux), 0xfffe), 0))
2299
+ * - Matter to Lux = Math.round(Math.max(Math.pow(10, value / 10000), 0))
2300
+ */
1201
2301
  createDefaultIlluminanceMeasurementClusterServer(measuredValue = null, minMeasuredValue = null, maxMeasuredValue = null) {
1202
2302
  this.behaviors.require(IlluminanceMeasurementServer, getDefaultIlluminanceMeasurementClusterServer(measuredValue, minMeasuredValue, maxMeasuredValue));
1203
2303
  return this;
1204
2304
  }
2305
+ /**
2306
+ * Creates a default FlowMeasurement cluster server.
2307
+ *
2308
+ * @param {number | null} measuredValue - The measured value of the flow in 10 x m3/h.
2309
+ * @param {number | null} minMeasuredValue - The minimum measured value of the flow in 10 x m3/h.
2310
+ * @param {number | null} maxMeasuredValue - The maximum measured value of the flow in 10 x m3/h.
2311
+ * @returns {this} The current MatterbridgeEndpoint instance for chaining.
2312
+ */
1205
2313
  createDefaultFlowMeasurementClusterServer(measuredValue = null, minMeasuredValue = null, maxMeasuredValue = null) {
1206
2314
  this.behaviors.require(FlowMeasurementServer, getDefaultFlowMeasurementClusterServer(measuredValue, minMeasuredValue, maxMeasuredValue));
1207
2315
  return this;
1208
2316
  }
2317
+ /**
2318
+ * Creates a default OccupancySensing cluster server with feature PassiveInfrared.
2319
+ *
2320
+ * @param {boolean} occupied - A boolean indicating whether the occupancy is occupied or not. Default is false.
2321
+ * @param {number} holdTime - The hold time in seconds. Default is 30.
2322
+ * @param {number} holdTimeMin - The minimum hold time in seconds. Default is 1.
2323
+ * @param {number} holdTimeMax - The maximum hold time in seconds. Default is 300.
2324
+ * @returns {this} The current MatterbridgeEndpoint instance for chaining.
2325
+ *
2326
+ * @remarks The default value for the occupancy sensor type is PIR.
2327
+ */
1209
2328
  createDefaultOccupancySensingClusterServer(occupied = false, holdTime = 30, holdTimeMin = 1, holdTimeMax = 300) {
1210
2329
  this.behaviors.require(OccupancySensingServer.with(OccupancySensing.Feature.PassiveInfrared), getDefaultOccupancySensingClusterServer(occupied, holdTime, holdTimeMin, holdTimeMax));
1211
2330
  return this;
1212
2331
  }
2332
+ /**
2333
+ * Creates a default AirQuality cluster server.
2334
+ *
2335
+ * @param {AirQuality.AirQualityEnum} airQuality The air quality level. Defaults to `AirQuality.AirQualityType.Unknown`.
2336
+ * @returns {this} The current MatterbridgeEndpoint instance for chaining.
2337
+ */
1213
2338
  createDefaultAirQualityClusterServer(airQuality = AirQuality.AirQualityEnum.Unknown) {
1214
2339
  this.behaviors.require(AirQualityServer.with(AirQuality.Feature.Fair, AirQuality.Feature.Moderate, AirQuality.Feature.VeryPoor, AirQuality.Feature.ExtremelyPoor), {
1215
2340
  airQuality,
1216
2341
  });
1217
2342
  return this;
1218
2343
  }
2344
+ /**
2345
+ * Creates a default TotalVolatileOrganicCompoundsConcentrationMeasurement cluster server with feature NumericMeasurement.
2346
+ *
2347
+ * @param {number | null} measuredValue - The measured value of the concentration.
2348
+ * @param {ConcentrationMeasurement.MeasurementUnit} measurementUnit - The unit of measurement (default to ConcentrationMeasurement.MeasurementUnit.Ppm).
2349
+ * @param {ConcentrationMeasurement.MeasurementMedium} measurementMedium - The unit of measurement (default to ConcentrationMeasurement.MeasurementMedium.Air).
2350
+ * @param {number} [uncertainty] - The uncertainty value (optional).
2351
+ * @returns {this} The current MatterbridgeEndpoint instance for chaining.
2352
+ *
2353
+ * @remarks
2354
+ * The measurementUnit and the measurementMedium attributes are fixed and cannot be changed after creation.
2355
+ */
1219
2356
  createDefaultTvocMeasurementClusterServer(measuredValue = null, measurementUnit = ConcentrationMeasurement.MeasurementUnit.Ppm, measurementMedium = ConcentrationMeasurement.MeasurementMedium.Air, uncertainty) {
1220
2357
  this.behaviors.require(TotalVolatileOrganicCompoundsConcentrationMeasurementServer.with(ConcentrationMeasurement.Feature.NumericMeasurement), {
1221
2358
  measuredValue,
@@ -1227,6 +2364,16 @@ export class MatterbridgeEndpoint extends Endpoint {
1227
2364
  });
1228
2365
  return this;
1229
2366
  }
2367
+ /**
2368
+ * Creates a default TotalVolatileOrganicCompoundsConcentrationMeasurement cluster server with feature LevelIndication, MediumLevel and CriticalLevel.
2369
+ *
2370
+ * @param {ConcentrationMeasurement.LevelValue} levelValue - The level value of the measurement (default to ConcentrationMeasurement.LevelValue.Unknown).
2371
+ * @param {ConcentrationMeasurement.MeasurementMedium} measurementMedium - The measurement medium (default to ConcentrationMeasurement.MeasurementMedium.Air).
2372
+ * @returns {this} The current MatterbridgeEndpoint instance for chaining.
2373
+ *
2374
+ * @remarks
2375
+ * The measurementMedium attribute is fixed and cannot be changed after creation.
2376
+ */
1230
2377
  createLevelTvocMeasurementClusterServer(levelValue = ConcentrationMeasurement.LevelValue.Unknown, measurementMedium = ConcentrationMeasurement.MeasurementMedium.Air) {
1231
2378
  this.behaviors.require(TotalVolatileOrganicCompoundsConcentrationMeasurementServer.with(ConcentrationMeasurement.Feature.LevelIndication, ConcentrationMeasurement.Feature.MediumLevel, ConcentrationMeasurement.Feature.CriticalLevel), {
1232
2379
  levelValue,
@@ -1234,6 +2381,17 @@ export class MatterbridgeEndpoint extends Endpoint {
1234
2381
  });
1235
2382
  return this;
1236
2383
  }
2384
+ /**
2385
+ * Create a default CarbonMonoxideConcentrationMeasurement cluster server with feature NumericMeasurement.
2386
+ *
2387
+ * @param {number | null} measuredValue - The measured value of the concentration.
2388
+ * @param {ConcentrationMeasurement.MeasurementUnit} measurementUnit - The unit of measurement (default to ConcentrationMeasurement.MeasurementUnit.Ppm).
2389
+ * @param {ConcentrationMeasurement.MeasurementMedium} measurementMedium - The unit of measurement (default to ConcentrationMeasurement.MeasurementMedium.Air).
2390
+ * @returns {this} The current MatterbridgeEndpoint instance for chaining.
2391
+ *
2392
+ * @remarks
2393
+ * The measurementUnit and the measurementMedium attributes are fixed and cannot be changed after creation.
2394
+ */
1237
2395
  createDefaultCarbonMonoxideConcentrationMeasurementClusterServer(measuredValue = null, measurementUnit = ConcentrationMeasurement.MeasurementUnit.Ppm, measurementMedium = ConcentrationMeasurement.MeasurementMedium.Air) {
1238
2396
  this.behaviors.require(CarbonMonoxideConcentrationMeasurementServer.with(ConcentrationMeasurement.Feature.NumericMeasurement), {
1239
2397
  measuredValue,
@@ -1245,6 +2403,17 @@ export class MatterbridgeEndpoint extends Endpoint {
1245
2403
  });
1246
2404
  return this;
1247
2405
  }
2406
+ /**
2407
+ * Create a default CarbonDioxideConcentrationMeasurement cluster server with feature NumericMeasurement.
2408
+ *
2409
+ * @param {number | null} measuredValue - The measured value of the concentration.
2410
+ * @param {ConcentrationMeasurement.MeasurementUnit} measurementUnit - The unit of measurement (default to ConcentrationMeasurement.MeasurementUnit.Ppm).
2411
+ * @param {ConcentrationMeasurement.MeasurementMedium} measurementMedium - The unit of measurement (default to ConcentrationMeasurement.MeasurementMedium.Air).
2412
+ * @returns {this} The current MatterbridgeEndpoint instance for chaining.
2413
+ *
2414
+ * @remarks
2415
+ * The measurementUnit and the measurementMedium attributes are fixed and cannot be changed after creation.
2416
+ */
1248
2417
  createDefaultCarbonDioxideConcentrationMeasurementClusterServer(measuredValue = null, measurementUnit = ConcentrationMeasurement.MeasurementUnit.Ppm, measurementMedium = ConcentrationMeasurement.MeasurementMedium.Air) {
1249
2418
  this.behaviors.require(CarbonDioxideConcentrationMeasurementServer.with(ConcentrationMeasurement.Feature.NumericMeasurement), {
1250
2419
  measuredValue,
@@ -1256,6 +2425,17 @@ export class MatterbridgeEndpoint extends Endpoint {
1256
2425
  });
1257
2426
  return this;
1258
2427
  }
2428
+ /**
2429
+ * Create a default FormaldehydeConcentrationMeasurement cluster server with feature NumericMeasurement.
2430
+ *
2431
+ * @param {number | null} measuredValue - The measured value of the concentration.
2432
+ * @param {ConcentrationMeasurement.MeasurementUnit} measurementUnit - The unit of measurement (default to ConcentrationMeasurement.MeasurementUnit.Ppm).
2433
+ * @param {ConcentrationMeasurement.MeasurementMedium} measurementMedium - The unit of measurement (default to ConcentrationMeasurement.MeasurementMedium.Air).
2434
+ * @returns {this} The current MatterbridgeEndpoint instance for chaining.
2435
+ *
2436
+ * @remarks
2437
+ * The measurementUnit and the measurementMedium attributes are fixed and cannot be changed after creation.
2438
+ */
1259
2439
  createDefaultFormaldehydeConcentrationMeasurementClusterServer(measuredValue = null, measurementUnit = ConcentrationMeasurement.MeasurementUnit.Ppm, measurementMedium = ConcentrationMeasurement.MeasurementMedium.Air) {
1260
2440
  this.behaviors.require(FormaldehydeConcentrationMeasurementServer.with(ConcentrationMeasurement.Feature.NumericMeasurement), {
1261
2441
  measuredValue,
@@ -1267,6 +2447,17 @@ export class MatterbridgeEndpoint extends Endpoint {
1267
2447
  });
1268
2448
  return this;
1269
2449
  }
2450
+ /**
2451
+ * Create a default Pm1ConcentrationMeasurement cluster server with feature NumericMeasurement.
2452
+ *
2453
+ * @param {number | null} measuredValue - The measured value of the concentration.
2454
+ * @param {ConcentrationMeasurement.MeasurementUnit} measurementUnit - The unit of measurement (default to ConcentrationMeasurement.MeasurementUnit.Ppm).
2455
+ * @param {ConcentrationMeasurement.MeasurementMedium} measurementMedium - The unit of measurement (default to ConcentrationMeasurement.MeasurementMedium.Air).
2456
+ * @returns {this} The current MatterbridgeEndpoint instance for chaining.
2457
+ *
2458
+ * @remarks
2459
+ * The measurementUnit and the measurementMedium attributes are fixed and cannot be changed after creation.
2460
+ */
1270
2461
  createDefaultPm1ConcentrationMeasurementClusterServer(measuredValue = null, measurementUnit = ConcentrationMeasurement.MeasurementUnit.Ppm, measurementMedium = ConcentrationMeasurement.MeasurementMedium.Air) {
1271
2462
  this.behaviors.require(Pm1ConcentrationMeasurementServer.with(ConcentrationMeasurement.Feature.NumericMeasurement), {
1272
2463
  measuredValue,
@@ -1278,6 +2469,17 @@ export class MatterbridgeEndpoint extends Endpoint {
1278
2469
  });
1279
2470
  return this;
1280
2471
  }
2472
+ /**
2473
+ * Create a default Pm25ConcentrationMeasurement cluster server with feature NumericMeasurement.
2474
+ *
2475
+ * @param {number | null} measuredValue - The measured value of the concentration.
2476
+ * @param {ConcentrationMeasurement.MeasurementUnit} measurementUnit - The unit of measurement (default to ConcentrationMeasurement.MeasurementUnit.Ppm).
2477
+ * @param {ConcentrationMeasurement.MeasurementMedium} measurementMedium - The unit of measurement (default to ConcentrationMeasurement.MeasurementMedium.Air).
2478
+ * @returns {this} The current MatterbridgeEndpoint instance for chaining.
2479
+ *
2480
+ * @remarks
2481
+ * The measurementUnit and the measurementMedium attributes are fixed and cannot be changed after creation.
2482
+ */
1281
2483
  createDefaultPm25ConcentrationMeasurementClusterServer(measuredValue = null, measurementUnit = ConcentrationMeasurement.MeasurementUnit.Ppm, measurementMedium = ConcentrationMeasurement.MeasurementMedium.Air) {
1282
2484
  this.behaviors.require(Pm25ConcentrationMeasurementServer.with(ConcentrationMeasurement.Feature.NumericMeasurement), {
1283
2485
  measuredValue,
@@ -1289,6 +2491,17 @@ export class MatterbridgeEndpoint extends Endpoint {
1289
2491
  });
1290
2492
  return this;
1291
2493
  }
2494
+ /**
2495
+ * Create a default Pm10ConcentrationMeasurement cluster server with feature NumericMeasurement.
2496
+ *
2497
+ * @param {number | null} measuredValue - The measured value of the concentration.
2498
+ * @param {ConcentrationMeasurement.MeasurementUnit} measurementUnit - The unit of measurement (default to ConcentrationMeasurement.MeasurementUnit.Ppm).
2499
+ * @param {ConcentrationMeasurement.MeasurementMedium} measurementMedium - The unit of measurement (default to ConcentrationMeasurement.MeasurementMedium.Air).
2500
+ * @returns {this} The current MatterbridgeEndpoint instance for chaining.
2501
+ *
2502
+ * @remarks
2503
+ * The measurementUnit and the measurementMedium attributes are fixed and cannot be changed after creation.
2504
+ */
1292
2505
  createDefaultPm10ConcentrationMeasurementClusterServer(measuredValue = null, measurementUnit = ConcentrationMeasurement.MeasurementUnit.Ppm, measurementMedium = ConcentrationMeasurement.MeasurementMedium.Air) {
1293
2506
  this.behaviors.require(Pm10ConcentrationMeasurementServer.with(ConcentrationMeasurement.Feature.NumericMeasurement), {
1294
2507
  measuredValue,
@@ -1300,6 +2513,17 @@ export class MatterbridgeEndpoint extends Endpoint {
1300
2513
  });
1301
2514
  return this;
1302
2515
  }
2516
+ /**
2517
+ * Create a default OzoneConcentrationMeasurement cluster server with feature NumericMeasurement.
2518
+ *
2519
+ * @param {number | null} measuredValue - The measured value of the concentration.
2520
+ * @param {ConcentrationMeasurement.MeasurementUnit} measurementUnit - The unit of measurement (default to ConcentrationMeasurement.MeasurementUnit.Ugm3).
2521
+ * @param {ConcentrationMeasurement.MeasurementMedium} measurementMedium - The unit of measurement (default to ConcentrationMeasurement.MeasurementMedium.Air).
2522
+ * @returns {this} The current MatterbridgeEndpoint instance for chaining.
2523
+ *
2524
+ * @remarks
2525
+ * The measurementUnit and the measurementMedium attributes are fixed and cannot be changed after creation.
2526
+ */
1303
2527
  createDefaultOzoneConcentrationMeasurementClusterServer(measuredValue = null, measurementUnit = ConcentrationMeasurement.MeasurementUnit.Ugm3, measurementMedium = ConcentrationMeasurement.MeasurementMedium.Air) {
1304
2528
  this.behaviors.require(OzoneConcentrationMeasurementServer.with(ConcentrationMeasurement.Feature.NumericMeasurement), {
1305
2529
  measuredValue,
@@ -1311,6 +2535,17 @@ export class MatterbridgeEndpoint extends Endpoint {
1311
2535
  });
1312
2536
  return this;
1313
2537
  }
2538
+ /**
2539
+ * Create a default RadonConcentrationMeasurement cluster server with feature NumericMeasurement.
2540
+ *
2541
+ * @param {number | null} measuredValue - The measured value of the concentration.
2542
+ * @param {ConcentrationMeasurement.MeasurementUnit} measurementUnit - The unit of measurement (default to ConcentrationMeasurement.MeasurementUnit.Ppm).
2543
+ * @param {ConcentrationMeasurement.MeasurementMedium} measurementMedium - The unit of measurement (default to ConcentrationMeasurement.MeasurementMedium.Air).
2544
+ * @returns {this} The current MatterbridgeEndpoint instance for chaining.
2545
+ *
2546
+ * @remarks
2547
+ * The measurementUnit and the measurementMedium attributes are fixed and cannot be changed after creation.
2548
+ */
1314
2549
  createDefaultRadonConcentrationMeasurementClusterServer(measuredValue = null, measurementUnit = ConcentrationMeasurement.MeasurementUnit.Ppm, measurementMedium = ConcentrationMeasurement.MeasurementMedium.Air) {
1315
2550
  this.behaviors.require(RadonConcentrationMeasurementServer.with(ConcentrationMeasurement.Feature.NumericMeasurement), {
1316
2551
  measuredValue,
@@ -1322,6 +2557,17 @@ export class MatterbridgeEndpoint extends Endpoint {
1322
2557
  });
1323
2558
  return this;
1324
2559
  }
2560
+ /**
2561
+ * Create a default NitrogenDioxideConcentrationMeasurement cluster server with feature NumericMeasurement.
2562
+ *
2563
+ * @param {number | null} measuredValue - The measured value of the concentration.
2564
+ * @param {ConcentrationMeasurement.MeasurementUnit} measurementUnit - The unit of measurement (default to ConcentrationMeasurement.MeasurementUnit.Ugm3).
2565
+ * @param {ConcentrationMeasurement.MeasurementMedium} measurementMedium - The unit of measurement (default to ConcentrationMeasurement.MeasurementMedium.Air).
2566
+ * @returns {this} The current MatterbridgeEndpoint instance for chaining.
2567
+ *
2568
+ * @remarks
2569
+ * The measurementUnit and the measurementMedium attributes are fixed and cannot be changed after creation.
2570
+ */
1325
2571
  createDefaultNitrogenDioxideConcentrationMeasurementClusterServer(measuredValue = null, measurementUnit = ConcentrationMeasurement.MeasurementUnit.Ugm3, measurementMedium = ConcentrationMeasurement.MeasurementMedium.Air) {
1326
2572
  this.behaviors.require(NitrogenDioxideConcentrationMeasurementServer.with(ConcentrationMeasurement.Feature.NumericMeasurement), {
1327
2573
  measuredValue,
@@ -1334,3 +2580,4 @@ export class MatterbridgeEndpoint extends Endpoint {
1334
2580
  return this;
1335
2581
  }
1336
2582
  }
2583
+ //# sourceMappingURL=matterbridgeEndpoint.js.map