matterbridge 3.2.4-dev-20250830-5c48452 → 3.2.4

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