matterbridge 3.3.3 → 3.3.4-dev-20251020-4d2dd49

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