matterbridge 1.6.8-dev.5 → 1.6.8-dev.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +2 -2
- package/dist/cli.d.ts.map +1 -0
- package/dist/cli.js +26 -0
- package/dist/cli.js.map +1 -0
- package/dist/cluster/export.d.ts.map +1 -0
- package/dist/cluster/export.js +2 -0
- package/dist/cluster/export.js.map +1 -0
- package/dist/defaultConfigSchema.d.ts.map +1 -0
- package/dist/defaultConfigSchema.js +23 -0
- package/dist/defaultConfigSchema.js.map +1 -0
- package/dist/deviceManager.d.ts +46 -0
- package/dist/deviceManager.d.ts.map +1 -0
- package/dist/deviceManager.js +26 -1
- package/dist/deviceManager.js.map +1 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +30 -0
- package/dist/index.js.map +1 -0
- package/dist/logger/export.d.ts.map +1 -0
- package/dist/logger/export.js +1 -0
- package/dist/logger/export.js.map +1 -0
- package/dist/matter/export.d.ts.map +1 -0
- package/dist/matter/export.js +1 -0
- package/dist/matter/export.js.map +1 -0
- package/dist/matterbridge.d.ts +473 -0
- package/dist/matterbridge.d.ts.map +1 -0
- package/dist/matterbridge.js +720 -66
- package/dist/matterbridge.js.map +1 -0
- package/dist/matterbridgeAccessoryPlatform.d.ts.map +1 -0
- package/dist/matterbridgeAccessoryPlatform.js +33 -0
- package/dist/matterbridgeAccessoryPlatform.js.map +1 -0
- package/dist/matterbridgeBehaviors.d.ts +116 -0
- package/dist/matterbridgeBehaviors.d.ts.map +1 -0
- package/dist/matterbridgeBehaviors.js +29 -1
- package/dist/matterbridgeBehaviors.js.map +1 -0
- package/dist/matterbridgeDevice.d.ts +1142 -0
- package/dist/matterbridgeDevice.d.ts.map +1 -0
- package/dist/matterbridgeDevice.js +997 -10
- package/dist/matterbridgeDevice.js.map +1 -0
- package/dist/matterbridgeDeviceTypes.d.ts +109 -0
- package/dist/matterbridgeDeviceTypes.d.ts.map +1 -0
- package/dist/matterbridgeDeviceTypes.js +82 -11
- package/dist/matterbridgeDeviceTypes.js.map +1 -0
- package/dist/matterbridgeDynamicPlatform.d.ts.map +1 -0
- package/dist/matterbridgeDynamicPlatform.js +33 -0
- package/dist/matterbridgeDynamicPlatform.js.map +1 -0
- package/dist/matterbridgeEdge.d.ts +90 -0
- package/dist/matterbridgeEdge.d.ts.map +1 -0
- package/dist/matterbridgeEdge.js +529 -0
- package/dist/matterbridgeEdge.js.map +1 -0
- package/dist/matterbridgeEndpoint.d.ts +1134 -0
- package/dist/matterbridgeEndpoint.d.ts.map +1 -0
- package/dist/matterbridgeEndpoint.js +1121 -12
- package/dist/matterbridgeEndpoint.js.map +1 -0
- package/dist/matterbridgePlatform.d.ts +123 -0
- package/dist/matterbridgePlatform.d.ts.map +1 -0
- package/dist/matterbridgePlatform.js +99 -3
- package/dist/matterbridgePlatform.js.map +1 -0
- package/dist/matterbridgeTypes.d.ts.map +1 -0
- package/dist/matterbridgeTypes.js +24 -0
- package/dist/matterbridgeTypes.js.map +1 -0
- package/dist/matterbridgeWebsocket.d.ts.map +1 -0
- package/dist/matterbridgeWebsocket.js +45 -0
- package/dist/matterbridgeWebsocket.js.map +1 -0
- package/dist/pluginManager.d.ts +238 -0
- package/dist/pluginManager.d.ts.map +1 -0
- package/dist/pluginManager.js +238 -3
- package/dist/pluginManager.js.map +1 -0
- package/dist/storage/export.d.ts.map +1 -0
- package/dist/storage/export.js +1 -0
- package/dist/storage/export.js.map +1 -0
- package/dist/utils/colorUtils.d.ts.map +1 -0
- package/dist/utils/colorUtils.js +205 -2
- package/dist/utils/colorUtils.js.map +1 -0
- package/dist/utils/export.d.ts.map +1 -0
- package/dist/utils/export.js +1 -0
- package/dist/utils/export.js.map +1 -0
- package/dist/utils/utils.d.ts +221 -0
- package/dist/utils/utils.d.ts.map +1 -0
- package/dist/utils/utils.js +253 -8
- package/dist/utils/utils.js.map +1 -0
- package/npm-shrinkwrap.json +2 -2
- package/package.json +1 -1
|
@@ -0,0 +1,1142 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file contains the class MatterbridgeDevice.
|
|
3
|
+
*
|
|
4
|
+
* @file matterbridgeDevice.ts
|
|
5
|
+
* @author Luca Liguori
|
|
6
|
+
* @date 2023-12-29
|
|
7
|
+
* @version 2.0.0
|
|
8
|
+
*
|
|
9
|
+
* Copyright 2023, 2024, 2025 Luca Liguori.
|
|
10
|
+
*
|
|
11
|
+
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
12
|
+
* you may not use this file except in compliance with the License.
|
|
13
|
+
* You may obtain a copy of the License at
|
|
14
|
+
*
|
|
15
|
+
* http://www.apache.org/licenses/LICENSE-2.0
|
|
16
|
+
*
|
|
17
|
+
* Unless required by applicable law or agreed to in writing, software
|
|
18
|
+
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
19
|
+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
20
|
+
* See the License for the specific language governing permissions and
|
|
21
|
+
* limitations under the License. *
|
|
22
|
+
*/
|
|
23
|
+
import { AirQuality, BooleanState, BooleanStateConfiguration, ColorControl, ConcentrationMeasurement, DeviceEnergyManagementMode, DoorLock, FanControl, FlowMeasurement, Groups, Identify, IlluminanceMeasurement, LevelControl, ModeSelect, OccupancySensing, OnOff, PowerSource, PressureMeasurement, PumpConfigurationAndControl, RelativeHumidityMeasurement, SmokeCoAlarm, TemperatureMeasurement, Thermostat, ValveConfigurationAndControl, WindowCovering } from '@matter/main/clusters';
|
|
24
|
+
import { ClusterId, EndpointNumber, VendorId, AtLeastOne, MakeMandatory } from '@matter/main';
|
|
25
|
+
import { Device, DeviceTypeDefinition, Endpoint, EndpointOptions } from '@project-chip/matter.js/device';
|
|
26
|
+
import { ClusterServerHandlers } from '@project-chip/matter.js/cluster';
|
|
27
|
+
import { AnsiLogger, LogLevel } from 'node-ansi-logger';
|
|
28
|
+
import { MatterbridgeEndpointOptions } from './matterbridgeDeviceTypes.js';
|
|
29
|
+
interface MatterbridgeDeviceCommands {
|
|
30
|
+
identify: MakeMandatory<ClusterServerHandlers<typeof Identify.Complete>['identify']>;
|
|
31
|
+
triggerEffect: MakeMandatory<ClusterServerHandlers<typeof Identify.Complete>['triggerEffect']>;
|
|
32
|
+
on: MakeMandatory<ClusterServerHandlers<typeof OnOff.Complete>['on']>;
|
|
33
|
+
off: MakeMandatory<ClusterServerHandlers<typeof OnOff.Complete>['off']>;
|
|
34
|
+
toggle: MakeMandatory<ClusterServerHandlers<typeof OnOff.Complete>['toggle']>;
|
|
35
|
+
offWithEffect: MakeMandatory<ClusterServerHandlers<typeof OnOff.Complete>['offWithEffect']>;
|
|
36
|
+
moveToLevel: MakeMandatory<ClusterServerHandlers<typeof LevelControl.Complete>['moveToLevel']>;
|
|
37
|
+
moveToLevelWithOnOff: MakeMandatory<ClusterServerHandlers<typeof LevelControl.Complete>['moveToLevelWithOnOff']>;
|
|
38
|
+
moveToColor: MakeMandatory<ClusterServerHandlers<typeof ColorControl.Complete>['moveToColor']>;
|
|
39
|
+
moveColor: MakeMandatory<ClusterServerHandlers<typeof ColorControl.Complete>['moveColor']>;
|
|
40
|
+
stepColor: MakeMandatory<ClusterServerHandlers<typeof ColorControl.Complete>['stepColor']>;
|
|
41
|
+
moveToHue: MakeMandatory<ClusterServerHandlers<typeof ColorControl.Complete>['moveToHue']>;
|
|
42
|
+
moveHue: MakeMandatory<ClusterServerHandlers<typeof ColorControl.Complete>['moveHue']>;
|
|
43
|
+
stepHue: MakeMandatory<ClusterServerHandlers<typeof ColorControl.Complete>['stepHue']>;
|
|
44
|
+
moveToSaturation: MakeMandatory<ClusterServerHandlers<typeof ColorControl.Complete>['moveToSaturation']>;
|
|
45
|
+
moveSaturation: MakeMandatory<ClusterServerHandlers<typeof ColorControl.Complete>['moveSaturation']>;
|
|
46
|
+
stepSaturation: MakeMandatory<ClusterServerHandlers<typeof ColorControl.Complete>['stepSaturation']>;
|
|
47
|
+
moveToHueAndSaturation: MakeMandatory<ClusterServerHandlers<typeof ColorControl.Complete>['moveToHueAndSaturation']>;
|
|
48
|
+
moveToColorTemperature: MakeMandatory<ClusterServerHandlers<typeof ColorControl.Complete>['moveToColorTemperature']>;
|
|
49
|
+
moveColorTemperature: MakeMandatory<ClusterServerHandlers<typeof ColorControl.Complete>['moveColorTemperature']>;
|
|
50
|
+
stepColorTemperature: MakeMandatory<ClusterServerHandlers<typeof ColorControl.Complete>['stepColorTemperature']>;
|
|
51
|
+
upOrOpen: MakeMandatory<ClusterServerHandlers<typeof WindowCovering.Complete>['upOrOpen']>;
|
|
52
|
+
downOrClose: MakeMandatory<ClusterServerHandlers<typeof WindowCovering.Complete>['downOrClose']>;
|
|
53
|
+
stopMotion: MakeMandatory<ClusterServerHandlers<typeof WindowCovering.Complete>['stopMotion']>;
|
|
54
|
+
goToLiftPercentage: MakeMandatory<ClusterServerHandlers<typeof WindowCovering.Complete>['goToLiftPercentage']>;
|
|
55
|
+
open: MakeMandatory<ClusterServerHandlers<typeof ValveConfigurationAndControl.Complete>['open']>;
|
|
56
|
+
close: MakeMandatory<ClusterServerHandlers<typeof ValveConfigurationAndControl.Complete>['close']>;
|
|
57
|
+
lockDoor: MakeMandatory<ClusterServerHandlers<typeof DoorLock.Complete>['lockDoor']>;
|
|
58
|
+
unlockDoor: MakeMandatory<ClusterServerHandlers<typeof DoorLock.Complete>['unlockDoor']>;
|
|
59
|
+
setpointRaiseLower: MakeMandatory<ClusterServerHandlers<typeof Thermostat.Complete>['setpointRaiseLower']>;
|
|
60
|
+
changeToMode: MakeMandatory<ClusterServerHandlers<typeof DeviceEnergyManagementMode.Complete>['changeToMode']>;
|
|
61
|
+
step: MakeMandatory<ClusterServerHandlers<typeof FanControl.Complete>['step']>;
|
|
62
|
+
suppressAlarm: MakeMandatory<ClusterServerHandlers<typeof BooleanStateConfiguration.Complete>['suppressAlarm']>;
|
|
63
|
+
enableDisableAlarm: MakeMandatory<ClusterServerHandlers<typeof BooleanStateConfiguration.Complete>['enableDisableAlarm']>;
|
|
64
|
+
selfTestRequest: MakeMandatory<ClusterServerHandlers<typeof SmokeCoAlarm.Complete>['selfTestRequest']>;
|
|
65
|
+
}
|
|
66
|
+
export interface SerializedMatterbridgeDevice {
|
|
67
|
+
pluginName: string;
|
|
68
|
+
deviceName: string;
|
|
69
|
+
serialNumber: string;
|
|
70
|
+
uniqueId: string;
|
|
71
|
+
productId?: number;
|
|
72
|
+
productName?: string;
|
|
73
|
+
vendorId?: number;
|
|
74
|
+
vendorName?: string;
|
|
75
|
+
deviceTypes: AtLeastOne<DeviceTypeDefinition>;
|
|
76
|
+
endpoint: EndpointNumber | undefined;
|
|
77
|
+
endpointName: string;
|
|
78
|
+
clusterServersId: ClusterId[];
|
|
79
|
+
}
|
|
80
|
+
declare const MatterbridgeDevice_base: new (definition: DeviceTypeDefinition, options?: EndpointOptions | undefined) => Device & {
|
|
81
|
+
addCommandHandler<K extends keyof MatterbridgeDeviceCommands>(action: K, handler: MatterbridgeDeviceCommands[K]): void;
|
|
82
|
+
removeCommandHandler<K extends keyof MatterbridgeDeviceCommands>(action: K, handler: MatterbridgeDeviceCommands[K]): void;
|
|
83
|
+
_executeHandler<K extends keyof MatterbridgeDeviceCommands>(action: K, ...args: Parameters<MatterbridgeDeviceCommands[K]>): Promise<void>;
|
|
84
|
+
};
|
|
85
|
+
export declare class MatterbridgeDevice extends MatterbridgeDevice_base {
|
|
86
|
+
static bridgeMode: string;
|
|
87
|
+
static logLevel: LogLevel;
|
|
88
|
+
log: AnsiLogger;
|
|
89
|
+
plugin: string | undefined;
|
|
90
|
+
configUrl: string | undefined;
|
|
91
|
+
serialNumber: string | undefined;
|
|
92
|
+
deviceName: string | undefined;
|
|
93
|
+
uniqueId: string | undefined;
|
|
94
|
+
vendorId: number | undefined;
|
|
95
|
+
vendorName: string | undefined;
|
|
96
|
+
productId: number | undefined;
|
|
97
|
+
productName: string | undefined;
|
|
98
|
+
softwareVersion: number | undefined;
|
|
99
|
+
softwareVersionString: string | undefined;
|
|
100
|
+
hardwareVersion: number | undefined;
|
|
101
|
+
hardwareVersionString: string | undefined;
|
|
102
|
+
/**
|
|
103
|
+
* Create a Matterbridge device.
|
|
104
|
+
* @constructor
|
|
105
|
+
* @param {DeviceTypeDefinition | AtLeastOne<DeviceTypeDefinition>} definition - The DeviceTypeDefinition of the device.
|
|
106
|
+
* @param {EndpointOptions} [options={}] - The options for the device.
|
|
107
|
+
* @param {boolean} [debug=false] - The debug level for the device.
|
|
108
|
+
*/
|
|
109
|
+
constructor(definition: DeviceTypeDefinition | AtLeastOne<DeviceTypeDefinition>, options?: EndpointOptions, debug?: boolean);
|
|
110
|
+
/**
|
|
111
|
+
* Loads asyncronously an instance of the MatterbridgeDevice class.
|
|
112
|
+
*
|
|
113
|
+
* @param {DeviceTypeDefinition | AtLeastOne<DeviceTypeDefinition>} definition - The DeviceTypeDefinition of the device.
|
|
114
|
+
* @param {EndpointOptions} [options={}] - The options for the device.
|
|
115
|
+
* @param {boolean} [debug=false] - The debug level for the device.
|
|
116
|
+
* @returns {Promise<MatterbridgeDevice>} A Promise of MatterbridgeDevice instance.
|
|
117
|
+
*/
|
|
118
|
+
static loadInstance(definition: DeviceTypeDefinition | AtLeastOne<DeviceTypeDefinition>, options?: EndpointOptions, debug?: boolean): Promise<MatterbridgeDevice>;
|
|
119
|
+
get maybeNumber(): EndpointNumber | undefined;
|
|
120
|
+
/**
|
|
121
|
+
* Adds a device type to the list of device types of the MatterbridgeDevice endpoint.
|
|
122
|
+
* If the device type is not already present in the list, it will be added.
|
|
123
|
+
*
|
|
124
|
+
* @param {DeviceTypeDefinition} deviceType - The device type to add.
|
|
125
|
+
* @returns {MatterbridgeDevice} The MatterbridgeDevice instance.
|
|
126
|
+
*/
|
|
127
|
+
addDeviceType(deviceType: DeviceTypeDefinition): MatterbridgeDevice;
|
|
128
|
+
/**
|
|
129
|
+
* Adds one or more device types with the required cluster servers and the specified cluster servers.
|
|
130
|
+
*
|
|
131
|
+
* @param {AtLeastOne<DeviceTypeDefinition>} deviceTypes - The device types to add.
|
|
132
|
+
* @param {ClusterId[]} includeServerList - The list of cluster IDs to include.
|
|
133
|
+
* @returns {MatterbridgeDevice} The MatterbridgeDevice instance.
|
|
134
|
+
*/
|
|
135
|
+
addDeviceTypeWithClusterServer(deviceTypes: AtLeastOne<DeviceTypeDefinition>, includeServerList?: ClusterId[]): MatterbridgeDevice;
|
|
136
|
+
/**
|
|
137
|
+
* Adds a child endpoint with the specified device types and options.
|
|
138
|
+
* If the child endpoint is not already present, it will be created and added.
|
|
139
|
+
* If the child endpoint is already present, the device types will be added to the existing child endpoint.
|
|
140
|
+
*
|
|
141
|
+
* @param {string} endpointName - The name of the new endpoint to add.
|
|
142
|
+
* @param {AtLeastOne<DeviceTypeDefinition>} deviceTypes - The device types to add.
|
|
143
|
+
* @param {MatterbridgeEndpointOptions} [options={}] - The options for the endpoint.
|
|
144
|
+
* @param {boolean} [debug=false] - Whether to enable debug logging.
|
|
145
|
+
* @returns {MatterbridgeDevice} - The child endpoint that was found or added.
|
|
146
|
+
*
|
|
147
|
+
* @example
|
|
148
|
+
* ```typescript
|
|
149
|
+
* const endpoint = device.addChildDeviceType('Temperature', [temperatureSensor], { tagList: [{ mfgCode: null, namespaceId: LocationTag.Indoor.namespaceId, tag: LocationTag.Indoor.tag, label: null }] }, true);
|
|
150
|
+
* ```
|
|
151
|
+
*/
|
|
152
|
+
addChildDeviceType(endpointName: string, deviceTypes: AtLeastOne<DeviceTypeDefinition>, options?: MatterbridgeEndpointOptions, debug?: boolean): MatterbridgeDevice;
|
|
153
|
+
/**
|
|
154
|
+
* Adds a child endpoint with one or more device types with the required cluster servers and the specified cluster servers.
|
|
155
|
+
* If the child endpoint is not already present in the childEndpoints, it will be added.
|
|
156
|
+
* If the child endpoint is already present in the childEndpoints, the device types and cluster servers will be added to the existing child endpoint.
|
|
157
|
+
*
|
|
158
|
+
* @param {string} endpointName - The name of the new enpoint to add.
|
|
159
|
+
* @param {AtLeastOne<DeviceTypeDefinition>} deviceTypes - The device types to add.
|
|
160
|
+
* @param {ClusterId[]} [includeServerList=[]] - The list of cluster IDs to include.
|
|
161
|
+
* @param {EndpointOptions} [options={}] - The options for the device.
|
|
162
|
+
* @param {boolean} [debug=false] - Whether to enable debug logging.
|
|
163
|
+
* @returns {MatterbridgeDevice} - The child endpoint that was found or added.
|
|
164
|
+
*
|
|
165
|
+
* @example
|
|
166
|
+
* ```typescript
|
|
167
|
+
* const endpoint = device.addChildDeviceTypeWithClusterServer('Temperature', [temperatureSensor], [], { tagList: [{ mfgCode: null, namespaceId: LocationTag.Indoor.namespaceId, tag: LocationTag.Indoor.tag, label: null }] }, true);
|
|
168
|
+
* ```
|
|
169
|
+
*/
|
|
170
|
+
addChildDeviceTypeWithClusterServer(endpointName: string, deviceTypes: AtLeastOne<DeviceTypeDefinition>, includeServerList?: ClusterId[], options?: MatterbridgeEndpointOptions, debug?: boolean): MatterbridgeDevice;
|
|
171
|
+
/**
|
|
172
|
+
* Adds the required cluster servers (only if they are not present) for the device types of the specified endpoint.
|
|
173
|
+
*
|
|
174
|
+
* @param {Endpoint} endpoint - The endpoint to add the required cluster servers to.
|
|
175
|
+
* @returns {Endpoint} The updated endpoint with the required cluster servers added.
|
|
176
|
+
*/
|
|
177
|
+
addRequiredClusterServers(endpoint: Endpoint): Endpoint;
|
|
178
|
+
/**
|
|
179
|
+
* Adds the optional cluster servers (only if they are not present) for the device types of the specified endpoint.
|
|
180
|
+
*
|
|
181
|
+
* @param {Endpoint} endpoint - The endpoint to add the required cluster servers to.
|
|
182
|
+
* @returns {Endpoint} The updated endpoint with the required cluster servers added.
|
|
183
|
+
*/
|
|
184
|
+
addOptionalClusterServers(endpoint: Endpoint): Endpoint;
|
|
185
|
+
/**
|
|
186
|
+
* Adds cluster servers to the specified endpoint based on the provided server list.
|
|
187
|
+
*
|
|
188
|
+
* @param {Endpoint} endpoint - The endpoint to add cluster servers to.
|
|
189
|
+
* @param {ClusterId[]} includeServerList - The list of cluster IDs to include.
|
|
190
|
+
* @returns {Endpoint} The updated endpoint with the cluster servers added.
|
|
191
|
+
*/
|
|
192
|
+
addClusterServerFromList(endpoint: Endpoint, includeServerList: ClusterId[]): Endpoint;
|
|
193
|
+
/**
|
|
194
|
+
* Retrieves a child endpoint by its name.
|
|
195
|
+
*
|
|
196
|
+
* @param {string} endpointName - The name of the endpoint to retrieve.
|
|
197
|
+
* @returns {Endpoint | undefined} The child endpoint with the specified name, or undefined if not found.
|
|
198
|
+
*/
|
|
199
|
+
getChildEndpointByName(endpointName: string): Endpoint | undefined;
|
|
200
|
+
/**
|
|
201
|
+
* Retrieves the value of the specified attribute from the given endpoint and cluster.
|
|
202
|
+
*
|
|
203
|
+
* @param {ClusterId} clusterId - The ID of the cluster to retrieve the attribute from.
|
|
204
|
+
* @param {string} attribute - The name of the attribute to retrieve.
|
|
205
|
+
* @param {AnsiLogger} [log] - Optional logger for error and info messages.
|
|
206
|
+
* @param {Endpoint} [endpoint] - Optional the child endpoint to retrieve the attribute from.
|
|
207
|
+
* @returns {any} The value of the attribute, or undefined if the attribute is not found.
|
|
208
|
+
*/
|
|
209
|
+
getAttribute(clusterId: ClusterId, attribute: string, log?: AnsiLogger, endpoint?: Endpoint): any;
|
|
210
|
+
/**
|
|
211
|
+
* Sets the value of an attribute on a cluster server endpoint.
|
|
212
|
+
*
|
|
213
|
+
* @param {ClusterId} clusterId - The ID of the cluster.
|
|
214
|
+
* @param {string} attribute - The name of the attribute.
|
|
215
|
+
* @param {any} value - The value to set for the attribute.
|
|
216
|
+
* @param {AnsiLogger} [log] - (Optional) The logger to use for logging errors and information.
|
|
217
|
+
* @param {Endpoint} [endpoint] - (Optional) The endpoint to set the attribute on. If not provided, the attribute will be set on the current endpoint.
|
|
218
|
+
*/
|
|
219
|
+
setAttribute(clusterId: ClusterId, attribute: string, value: any, log?: AnsiLogger, endpoint?: Endpoint): boolean;
|
|
220
|
+
/**
|
|
221
|
+
* Subscribes to an attribute on a cluster.
|
|
222
|
+
*
|
|
223
|
+
* @param {ClusterId} clusterId - The ID of the cluster.
|
|
224
|
+
* @param {string} attribute - The name of the attribute to subscribe to.
|
|
225
|
+
* @param {(newValue: any, oldValue: any) => void} listener - A callback function that will be called when the attribute value changes.
|
|
226
|
+
* @param {AnsiLogger} log - (Optional) An AnsiLogger instance for logging errors and information.
|
|
227
|
+
* @param {Endpoint} endpoint - (Optional) The endpoint to subscribe the attribute on. If not provided, the current endpoint will be used.
|
|
228
|
+
* @returns A boolean indicating whether the subscription was successful.
|
|
229
|
+
*/
|
|
230
|
+
subscribeAttribute(clusterId: ClusterId, attribute: string, listener: (newValue: any, oldValue: any) => void, log?: AnsiLogger, endpoint?: Endpoint): boolean;
|
|
231
|
+
/**
|
|
232
|
+
* Triggers the specified event of the specified cluster from the given endpoint and cluster.
|
|
233
|
+
*
|
|
234
|
+
* @param {ClusterId} clusterId - The ID of the cluster to retrieve the event from.
|
|
235
|
+
* @param {string} event - The name of the event to trigger.
|
|
236
|
+
* @param {Record<string, any>} payload - The payload of the event to trigger.
|
|
237
|
+
* @param {AnsiLogger} [log] - Optional logger for error and info messages.
|
|
238
|
+
* @param {Endpoint} [endpoint] - Optional the child endpoint to retrieve the event from.
|
|
239
|
+
*/
|
|
240
|
+
triggerEvent(clusterId: ClusterId, event: string, payload: Record<string, boolean | number | bigint | string | object | undefined | null>, log?: AnsiLogger, endpoint?: Endpoint): void;
|
|
241
|
+
/**
|
|
242
|
+
* Adds a tag to the tag list of the specified endpoint.
|
|
243
|
+
*
|
|
244
|
+
* @param {Endpoint} endpoint - The endpoint to add the tag to.
|
|
245
|
+
* @param {VendorId | null} mfgCode - The manufacturer code.
|
|
246
|
+
* @param {number} namespaceId - The namespace ID of the tag.
|
|
247
|
+
* @param {number} tag - The tag number.
|
|
248
|
+
* @param {string | null} [label=null] - The label for the tag.
|
|
249
|
+
*
|
|
250
|
+
* @remarks
|
|
251
|
+
* This method is used to add a tag to the tag list of a given endpoint.
|
|
252
|
+
* If the tag list already exists, the new tag is added to the existing list. Otherwise, a new tag list is created with the provided tag.
|
|
253
|
+
*
|
|
254
|
+
* Example usage:
|
|
255
|
+
* ```typescript
|
|
256
|
+
* this.addTagList(endpoint, null, NumberTag.One.namespaceId, NumberTag.One.tag, 'Label');
|
|
257
|
+
* this.addTagList(endpoint, null, SwitchesTag.Custom.namespaceId, SwitchesTag.Custom.tag, 'Label');
|
|
258
|
+
* ```
|
|
259
|
+
*/
|
|
260
|
+
addTagList(endpoint: Endpoint, mfgCode: VendorId | null, namespaceId: number, tag: number, label?: string | null): void;
|
|
261
|
+
/**
|
|
262
|
+
* Serializes the Matterbridge device into a serialized object.
|
|
263
|
+
*
|
|
264
|
+
* @param pluginName - The name of the plugin.
|
|
265
|
+
* @returns The serialized Matterbridge device object.
|
|
266
|
+
*/
|
|
267
|
+
serialize(): SerializedMatterbridgeDevice | undefined;
|
|
268
|
+
/**
|
|
269
|
+
* Deserializes the device into a serialized object.
|
|
270
|
+
*
|
|
271
|
+
* @returns The deserialized MatterbridgeDevice.
|
|
272
|
+
*/
|
|
273
|
+
static deserialize(serializedDevice: SerializedMatterbridgeDevice): MatterbridgeDevice;
|
|
274
|
+
/**
|
|
275
|
+
* Get a default IdentifyCluster server.
|
|
276
|
+
*/
|
|
277
|
+
getDefaultIdentifyClusterServer(identifyTime?: number, identifyType?: Identify.IdentifyType): import("@project-chip/matter.js/cluster").ClusterServerObj<Identify.Cluster>;
|
|
278
|
+
/**
|
|
279
|
+
* Creates a default IdentifyCluster server.
|
|
280
|
+
*/
|
|
281
|
+
createDefaultIdentifyClusterServer(identifyTime?: number, identifyType?: Identify.IdentifyType): this;
|
|
282
|
+
/**
|
|
283
|
+
* Get a default IdentifyCluster server.
|
|
284
|
+
*/
|
|
285
|
+
getDefaultGroupsClusterServer(): import("@project-chip/matter.js/cluster").ClusterServerObj<Groups.Cluster>;
|
|
286
|
+
/**
|
|
287
|
+
* Creates a default groups cluster server and adds it to the device.
|
|
288
|
+
*/
|
|
289
|
+
createDefaultGroupsClusterServer(): this;
|
|
290
|
+
/**
|
|
291
|
+
* Get a default scenes cluster server and adds it to the current instance.
|
|
292
|
+
* @deprecated This method is deprecated.
|
|
293
|
+
*
|
|
294
|
+
*/
|
|
295
|
+
getDefaultScenesClusterServer(): void;
|
|
296
|
+
/**
|
|
297
|
+
* Creates a default scenes cluster server and adds it to the current instance.
|
|
298
|
+
* @deprecated This method is deprecated.
|
|
299
|
+
*/
|
|
300
|
+
createDefaultScenesClusterServer(): this;
|
|
301
|
+
/**
|
|
302
|
+
* Creates a unique identifier based on the provided parameters.
|
|
303
|
+
* @param param1 - The first parameter.
|
|
304
|
+
* @param param2 - The second parameter.
|
|
305
|
+
* @param param3 - The third parameter.
|
|
306
|
+
* @param param4 - The fourth parameter.
|
|
307
|
+
* @returns A unique identifier generated using the MD5 hash algorithm.
|
|
308
|
+
*/
|
|
309
|
+
private createUniqueId;
|
|
310
|
+
/**
|
|
311
|
+
* Get a default Basic Information Cluster Server.
|
|
312
|
+
*
|
|
313
|
+
* @param deviceName - The name of the device.
|
|
314
|
+
* @param serialNumber - The serial number of the device.
|
|
315
|
+
* @param vendorId - The vendor ID of the device.
|
|
316
|
+
* @param vendorName - The vendor name of the device.
|
|
317
|
+
* @param productId - The product ID of the device.
|
|
318
|
+
* @param productName - The product name of the device.
|
|
319
|
+
* @param softwareVersion - The software version of the device. Default is 1.
|
|
320
|
+
* @param softwareVersionString - The software version string of the device. Default is 'v.1.0.0'.
|
|
321
|
+
* @param hardwareVersion - The hardware version of the device. Default is 1.
|
|
322
|
+
* @param hardwareVersionString - The hardware version string of the device. Default is 'v.1.0.0'.
|
|
323
|
+
*/
|
|
324
|
+
getDefaultBasicInformationClusterServer(deviceName: string, serialNumber: string, vendorId: number, vendorName: string, productId: number, productName: string, softwareVersion?: number, softwareVersionString?: string, hardwareVersion?: number, hardwareVersionString?: string): import("@project-chip/matter.js/cluster").ClusterServerObj<import("@matter/main/clusters").BasicInformation.Cluster>;
|
|
325
|
+
/**
|
|
326
|
+
* Creates a default Basic Information Cluster Server.
|
|
327
|
+
*
|
|
328
|
+
* @param deviceName - The name of the device.
|
|
329
|
+
* @param serialNumber - The serial number of the device.
|
|
330
|
+
* @param vendorId - The vendor ID of the device.
|
|
331
|
+
* @param vendorName - The vendor name of the device.
|
|
332
|
+
* @param productId - The product ID of the device.
|
|
333
|
+
* @param productName - The product name of the device.
|
|
334
|
+
* @param softwareVersion - The software version of the device. Default is 1.
|
|
335
|
+
* @param softwareVersionString - The software version string of the device. Default is 'v.1.0.0'.
|
|
336
|
+
* @param hardwareVersion - The hardware version of the device. Default is 1.
|
|
337
|
+
* @param hardwareVersionString - The hardware version string of the device. Default is 'v.1.0.0'.
|
|
338
|
+
*/
|
|
339
|
+
createDefaultBasicInformationClusterServer(deviceName: string, serialNumber: string, vendorId: number, vendorName: string, productId: number, productName: string, softwareVersion?: number, softwareVersionString?: string, hardwareVersion?: number, hardwareVersionString?: string): this | undefined;
|
|
340
|
+
/**
|
|
341
|
+
* Get a default BridgedDeviceBasicInformationClusterServer.
|
|
342
|
+
*
|
|
343
|
+
* @param deviceName - The name of the device.
|
|
344
|
+
* @param serialNumber - The serial number of the device.
|
|
345
|
+
* @param vendorId - The vendor ID of the device.
|
|
346
|
+
* @param vendorName - The name of the vendor.
|
|
347
|
+
* @param productName - The name of the product.
|
|
348
|
+
* @param softwareVersion - The software version of the device. Default is 1.
|
|
349
|
+
* @param softwareVersionString - The software version string of the device. Default is 'v.1.0.0'.
|
|
350
|
+
* @param hardwareVersion - The hardware version of the device. Default is 1.
|
|
351
|
+
* @param hardwareVersionString - The hardware version string of the device. Default is 'v.1.0.0'.
|
|
352
|
+
*/
|
|
353
|
+
getDefaultBridgedDeviceBasicInformationClusterServer(deviceName: string, serialNumber: string, vendorId: number, vendorName: string, productName: string, softwareVersion?: number, softwareVersionString?: string, hardwareVersion?: number, hardwareVersionString?: string): import("@project-chip/matter.js/cluster").ClusterServerObj<import("@matter/main/clusters").BridgedDeviceBasicInformation.Cluster>;
|
|
354
|
+
/**
|
|
355
|
+
* Creates a default BridgedDeviceBasicInformationClusterServer.
|
|
356
|
+
*
|
|
357
|
+
* @param deviceName - The name of the device.
|
|
358
|
+
* @param serialNumber - The serial number of the device.
|
|
359
|
+
* @param vendorId - The vendor ID of the device.
|
|
360
|
+
* @param vendorName - The name of the vendor.
|
|
361
|
+
* @param productName - The name of the product.
|
|
362
|
+
* @param softwareVersion - The software version of the device. Default is 1.
|
|
363
|
+
* @param softwareVersionString - The software version string of the device. Default is 'v.1.0.0'.
|
|
364
|
+
* @param hardwareVersion - The hardware version of the device. Default is 1.
|
|
365
|
+
* @param hardwareVersionString - The hardware version string of the device. Default is 'v.1.0.0'.
|
|
366
|
+
*/
|
|
367
|
+
createDefaultBridgedDeviceBasicInformationClusterServer(deviceName: string, serialNumber: string, vendorId: number, vendorName: string, productName: string, softwareVersion?: number, softwareVersionString?: string, hardwareVersion?: number, hardwareVersionString?: string): this;
|
|
368
|
+
/**
|
|
369
|
+
* Get a default Power Topology Cluster Server.
|
|
370
|
+
*
|
|
371
|
+
* @returns {ClusterServer} - The configured Power Topology Cluster Server.
|
|
372
|
+
*/
|
|
373
|
+
getDefaultPowerTopologyClusterServer(): import("@project-chip/matter.js/cluster").ClusterServerObj<any>;
|
|
374
|
+
/**
|
|
375
|
+
* Get a default Electrical Energy Measurement Cluster Server.
|
|
376
|
+
*
|
|
377
|
+
* @param {number} energy - The total consumption value in mW/h.
|
|
378
|
+
* @returns {ClusterServer} - The configured Electrical Energy Measurement Cluster Server.
|
|
379
|
+
*/
|
|
380
|
+
getDefaultElectricalEnergyMeasurementClusterServer(energy?: number | bigint | null): import("@project-chip/matter.js/cluster").ClusterServerObj<any>;
|
|
381
|
+
/**
|
|
382
|
+
* Get a default Electrical Power Measurement Cluster Server.
|
|
383
|
+
*
|
|
384
|
+
* @param {number} voltage - The voltage value in millivolts.
|
|
385
|
+
* @param {number} current - The current value in milliamperes.
|
|
386
|
+
* @param {number} power - The power value in milliwatts.
|
|
387
|
+
* @param {number} frequency - The frequency value in millihertz.
|
|
388
|
+
* @returns {ClusterServer} - The configured Electrical Power Measurement Cluster Server.
|
|
389
|
+
*/
|
|
390
|
+
getDefaultElectricalPowerMeasurementClusterServer(voltage?: number | bigint | null, current?: number | bigint | null, power?: number | bigint | null, frequency?: number | bigint | null): import("@project-chip/matter.js/cluster").ClusterServerObj<any>;
|
|
391
|
+
/**
|
|
392
|
+
* Creates a default Dummy Thread Network Diagnostics Cluster server.
|
|
393
|
+
* @deprecated This method is deprecated and is only used for testing.
|
|
394
|
+
*
|
|
395
|
+
* @remarks
|
|
396
|
+
* This method adds a cluster server used only to give the networkName to Eve app.
|
|
397
|
+
*
|
|
398
|
+
* @returns void
|
|
399
|
+
*/
|
|
400
|
+
createDefaultDummyThreadNetworkDiagnosticsClusterServer(): void;
|
|
401
|
+
/**
|
|
402
|
+
* Get a default OnOff cluster server for light devices.
|
|
403
|
+
*
|
|
404
|
+
* @param {boolean} [onOff=false] - The initial state of the OnOff cluster.
|
|
405
|
+
* @param {boolean} [globalSceneControl=false] - The global scene control state.
|
|
406
|
+
* @param {number} [onTime=0] - The on time value.
|
|
407
|
+
* @param {number} [offWaitTime=0] - The off wait time value.
|
|
408
|
+
* @param {OnOff.StartUpOnOff | null} [startUpOnOff=null] - The start-up OnOff state. Null means previous state.
|
|
409
|
+
*
|
|
410
|
+
* @returns {ClusterServer} - The configured OnOff cluster server.
|
|
411
|
+
*/
|
|
412
|
+
getDefaultOnOffClusterServer(onOff?: boolean, globalSceneControl?: boolean, onTime?: number, offWaitTime?: number, startUpOnOff?: OnOff.StartUpOnOff | null): import("@project-chip/matter.js/cluster").ClusterServerObj<any>;
|
|
413
|
+
/**
|
|
414
|
+
* Creates a default OnOff cluster server for light devices.
|
|
415
|
+
*
|
|
416
|
+
* @param {boolean} [onOff=false] - The initial state of the OnOff cluster.
|
|
417
|
+
* @param {boolean} [globalSceneControl=false] - The global scene control state.
|
|
418
|
+
* @param {number} [onTime=0] - The on time value.
|
|
419
|
+
* @param {number} [offWaitTime=0] - The off wait time value.
|
|
420
|
+
* @param {OnOff.StartUpOnOff | null} [startUpOnOff=null] - The start-up OnOff state. Null means previous state.
|
|
421
|
+
*/
|
|
422
|
+
createDefaultOnOffClusterServer(onOff?: boolean, globalSceneControl?: boolean, onTime?: number, offWaitTime?: number, startUpOnOff?: OnOff.StartUpOnOff | null): this;
|
|
423
|
+
/**
|
|
424
|
+
* Get a DeadFront OnOff cluster server.
|
|
425
|
+
*
|
|
426
|
+
* @param {boolean} [onOff=false] - The initial state of the OnOff cluster.
|
|
427
|
+
*
|
|
428
|
+
* @returns {ClusterServer} - The configured OnOff cluster server.
|
|
429
|
+
*/
|
|
430
|
+
getDeadFrontOnOffClusterServer(onOff?: boolean): import("@project-chip/matter.js/cluster").ClusterServerObj<any>;
|
|
431
|
+
/**
|
|
432
|
+
* Creates a DeadFront OnOff cluster server.
|
|
433
|
+
*
|
|
434
|
+
* @param {boolean} [onOff=false] - The initial state of the OnOff cluster.
|
|
435
|
+
*/
|
|
436
|
+
createDeadFrontOnOffClusterServer(onOff?: boolean): this;
|
|
437
|
+
/**
|
|
438
|
+
* Get an OnOff cluster server without features.
|
|
439
|
+
*
|
|
440
|
+
* @param {boolean} [onOff=false] - The initial state of the OnOff cluster.
|
|
441
|
+
*
|
|
442
|
+
* @returns {ClusterServer} - The configured OnOff cluster server.
|
|
443
|
+
*/
|
|
444
|
+
getOnOffClusterServer(onOff?: boolean): import("@project-chip/matter.js/cluster").ClusterServerObj<import("@matter/main/types").ClusterType>;
|
|
445
|
+
/**
|
|
446
|
+
* Creates an OnOff cluster server without features.
|
|
447
|
+
*
|
|
448
|
+
* @param {boolean} [onOff=false] - The initial state of the OnOff cluster.
|
|
449
|
+
*/
|
|
450
|
+
createOnOffClusterServer(onOff?: boolean): this;
|
|
451
|
+
/**
|
|
452
|
+
* Get a default level control cluster server.
|
|
453
|
+
*
|
|
454
|
+
* @param currentLevel - The current level (default: 254).
|
|
455
|
+
* @param minLevel - The minimum level (default: 1).
|
|
456
|
+
* @param maxLevel - The maximum level (default: 254).
|
|
457
|
+
* @param onLevel - The on level (default: null).
|
|
458
|
+
* @param startUpCurrentLevel - The startUp on level (default: null).
|
|
459
|
+
*/
|
|
460
|
+
getDefaultLevelControlClusterServer(currentLevel?: number, minLevel?: number, maxLevel?: number, onLevel?: number | null, startUpCurrentLevel?: number | null): import("@project-chip/matter.js/cluster").ClusterServerObj<any>;
|
|
461
|
+
/**
|
|
462
|
+
* Creates a default level control cluster server.
|
|
463
|
+
*
|
|
464
|
+
* @param currentLevel - The current level (default: 254).
|
|
465
|
+
* @param minLevel - The minimum level (default: 1).
|
|
466
|
+
* @param maxLevel - The maximum level (default: 254).
|
|
467
|
+
* @param onLevel - The on level (default: null).
|
|
468
|
+
* @param startUpCurrentLevel - The startUp on level (default: null).
|
|
469
|
+
*/
|
|
470
|
+
createDefaultLevelControlClusterServer(currentLevel?: number, minLevel?: number, maxLevel?: number, onLevel?: number | null, startUpCurrentLevel?: number | null): this;
|
|
471
|
+
/**
|
|
472
|
+
* Get a default color control cluster server with Xy, HueSaturation and ColorTemperature.
|
|
473
|
+
*
|
|
474
|
+
* @param currentX - The current X value.
|
|
475
|
+
* @param currentY - The current Y value.
|
|
476
|
+
* @param currentHue - The current hue value.
|
|
477
|
+
* @param currentSaturation - The current saturation value.
|
|
478
|
+
* @param colorTemperatureMireds - The color temperature in mireds.
|
|
479
|
+
* @param colorTempPhysicalMinMireds - The physical minimum color temperature in mireds.
|
|
480
|
+
* @param colorTempPhysicalMaxMireds - The physical maximum color temperature in mireds.
|
|
481
|
+
*/
|
|
482
|
+
getDefaultColorControlClusterServer(currentX?: number, currentY?: number, currentHue?: number, currentSaturation?: number, colorTemperatureMireds?: number, colorTempPhysicalMinMireds?: number, colorTempPhysicalMaxMireds?: number): import("@project-chip/matter.js/cluster").ClusterServerObj<any>;
|
|
483
|
+
/**
|
|
484
|
+
* Creates a default color control cluster server with Xy, HueSaturation and ColorTemperature.
|
|
485
|
+
*
|
|
486
|
+
* @param currentX - The current X value.
|
|
487
|
+
* @param currentY - The current Y value.
|
|
488
|
+
* @param currentHue - The current hue value.
|
|
489
|
+
* @param currentSaturation - The current saturation value.
|
|
490
|
+
* @param colorTemperatureMireds - The color temperature in mireds.
|
|
491
|
+
* @param colorTempPhysicalMinMireds - The physical minimum color temperature in mireds.
|
|
492
|
+
* @param colorTempPhysicalMaxMireds - The physical maximum color temperature in mireds.
|
|
493
|
+
*/
|
|
494
|
+
createDefaultColorControlClusterServer(currentX?: number, currentY?: number, currentHue?: number, currentSaturation?: number, colorTemperatureMireds?: number, colorTempPhysicalMinMireds?: number, colorTempPhysicalMaxMireds?: number): this;
|
|
495
|
+
/**
|
|
496
|
+
* Get a Xy color control cluster server with Xy and ColorTemperature.
|
|
497
|
+
*
|
|
498
|
+
* @param currentX - The current X value.
|
|
499
|
+
* @param currentY - The current Y value.
|
|
500
|
+
* @param colorTemperatureMireds - The color temperature in mireds.
|
|
501
|
+
* @param colorTempPhysicalMinMireds - The physical minimum color temperature in mireds.
|
|
502
|
+
* @param colorTempPhysicalMaxMireds - The physical maximum color temperature in mireds.
|
|
503
|
+
*/
|
|
504
|
+
getXyColorControlClusterServer(currentX?: number, currentY?: number, colorTemperatureMireds?: number, colorTempPhysicalMinMireds?: number, colorTempPhysicalMaxMireds?: number): import("@project-chip/matter.js/cluster").ClusterServerObj<any>;
|
|
505
|
+
/**
|
|
506
|
+
* Creates a Xy color control cluster server with Xy and ColorTemperature.
|
|
507
|
+
*
|
|
508
|
+
* @param currentX - The current X value.
|
|
509
|
+
* @param currentY - The current Y value.
|
|
510
|
+
* @param colorTemperatureMireds - The color temperature in mireds.
|
|
511
|
+
* @param colorTempPhysicalMinMireds - The physical minimum color temperature in mireds.
|
|
512
|
+
* @param colorTempPhysicalMaxMireds - The physical maximum color temperature in mireds.
|
|
513
|
+
*/
|
|
514
|
+
createXyColorControlClusterServer(currentX?: number, currentY?: number, colorTemperatureMireds?: number, colorTempPhysicalMinMireds?: number, colorTempPhysicalMaxMireds?: number): this;
|
|
515
|
+
/**
|
|
516
|
+
* Get a default hue and saturation control cluster server with HueSaturation and ColorTemperature.
|
|
517
|
+
*
|
|
518
|
+
* @param currentHue - The current hue value.
|
|
519
|
+
* @param currentSaturation - The current saturation value.
|
|
520
|
+
* @param colorTemperatureMireds - The color temperature in mireds.
|
|
521
|
+
* @param colorTempPhysicalMinMireds - The physical minimum color temperature in mireds.
|
|
522
|
+
* @param colorTempPhysicalMaxMireds - The physical maximum color temperature in mireds.
|
|
523
|
+
*/
|
|
524
|
+
getHsColorControlClusterServer(currentHue?: number, currentSaturation?: number, colorTemperatureMireds?: number, colorTempPhysicalMinMireds?: number, colorTempPhysicalMaxMireds?: number): import("@project-chip/matter.js/cluster").ClusterServerObj<any>;
|
|
525
|
+
/**
|
|
526
|
+
* Creates a hue and saturation color control cluster server with HueSaturation and ColorTemperature.
|
|
527
|
+
*
|
|
528
|
+
* @param currentHue - The current hue value.
|
|
529
|
+
* @param currentSaturation - The current saturation value.
|
|
530
|
+
* @param colorTemperatureMireds - The color temperature in mireds.
|
|
531
|
+
* @param colorTempPhysicalMinMireds - The physical minimum color temperature in mireds.
|
|
532
|
+
* @param colorTempPhysicalMaxMireds - The physical maximum color temperature in mireds.
|
|
533
|
+
*/
|
|
534
|
+
createHsColorControlClusterServer(currentHue?: number, currentSaturation?: number, colorTemperatureMireds?: number, colorTempPhysicalMinMireds?: number, colorTempPhysicalMaxMireds?: number): this;
|
|
535
|
+
/**
|
|
536
|
+
* Get a color temperature color control cluster server.
|
|
537
|
+
*
|
|
538
|
+
* @param colorTemperatureMireds - The color temperature in mireds.
|
|
539
|
+
* @param colorTempPhysicalMinMireds - The physical minimum color temperature in mireds.
|
|
540
|
+
* @param colorTempPhysicalMaxMireds - The physical maximum color temperature in mireds.
|
|
541
|
+
*/
|
|
542
|
+
getCtColorControlClusterServer(colorTemperatureMireds?: number, colorTempPhysicalMinMireds?: number, colorTempPhysicalMaxMireds?: number): import("@project-chip/matter.js/cluster").ClusterServerObj<any>;
|
|
543
|
+
/**
|
|
544
|
+
* Creates a color temperature color control cluster server.
|
|
545
|
+
*
|
|
546
|
+
* @param colorTemperatureMireds - The color temperature in mireds.
|
|
547
|
+
* @param colorTempPhysicalMinMireds - The physical minimum color temperature in mireds.
|
|
548
|
+
* @param colorTempPhysicalMaxMireds - The physical maximum color temperature in mireds.
|
|
549
|
+
*/
|
|
550
|
+
createCtColorControlClusterServer(colorTemperatureMireds?: number, colorTempPhysicalMinMireds?: number, colorTempPhysicalMaxMireds?: number): this;
|
|
551
|
+
/**
|
|
552
|
+
* Configures the color control cluster for a device.
|
|
553
|
+
*
|
|
554
|
+
* @remark This method must be called only after creating the cluster with getDefaultCompleteColorControlClusterServer or createDefaultCompleteColorControlClusterServer
|
|
555
|
+
* and before starting the matter server.
|
|
556
|
+
*
|
|
557
|
+
* @deprecated Use configureColorControlMode instead.
|
|
558
|
+
*
|
|
559
|
+
* @param {boolean} hueSaturation - A boolean indicating whether the device supports hue and saturation control.
|
|
560
|
+
* @param {boolean} xy - A boolean indicating whether the device supports XY control.
|
|
561
|
+
* @param {boolean} colorTemperature - A boolean indicating whether the device supports color temperature control.
|
|
562
|
+
* @param {ColorControl.ColorMode} colorMode - An optional parameter specifying the color mode of the device.
|
|
563
|
+
* @param {Endpoint} endpoint - An optional parameter specifying the endpoint to configure. If not provided, the device endpoint will be used.
|
|
564
|
+
*/
|
|
565
|
+
configureColorControlCluster(hueSaturation: boolean, xy: boolean, colorTemperature: boolean, colorMode?: ColorControl.ColorMode, endpoint?: Endpoint): this;
|
|
566
|
+
/**
|
|
567
|
+
* Configures the color control mode for the device.
|
|
568
|
+
*
|
|
569
|
+
* @param {ColorControl.ColorMode} colorMode - The color mode to set.
|
|
570
|
+
* @param {Endpoint} endpoint - The optional endpoint to configure. If not provided, the method will configure the current endpoint.
|
|
571
|
+
*/
|
|
572
|
+
configureColorControlMode(colorMode: ColorControl.ColorMode, endpoint?: Endpoint): this;
|
|
573
|
+
/**
|
|
574
|
+
* Get a default window covering cluster server.
|
|
575
|
+
*
|
|
576
|
+
* @param positionPercent100ths - The position percentage in 100ths (0-10000). Defaults to 0.
|
|
577
|
+
*/
|
|
578
|
+
getDefaultWindowCoveringClusterServer(positionPercent100ths?: number): import("@project-chip/matter.js/cluster").ClusterServerObj<any>;
|
|
579
|
+
/**
|
|
580
|
+
* Creates a default window covering cluster server.
|
|
581
|
+
*
|
|
582
|
+
* @param positionPercent100ths - The position percentage in 100ths (0-10000). Defaults to 0.
|
|
583
|
+
*/
|
|
584
|
+
createDefaultWindowCoveringClusterServer(positionPercent100ths?: number): void;
|
|
585
|
+
/**
|
|
586
|
+
* Sets the window covering target position as the current position and stops the movement.
|
|
587
|
+
* @param {Endpoint} endpoint - The endpoint on which to set the window covering (default the device endpoint).
|
|
588
|
+
*/
|
|
589
|
+
setWindowCoveringTargetAsCurrentAndStopped(endpoint?: Endpoint): void;
|
|
590
|
+
/**
|
|
591
|
+
* Sets the current and target status of a window covering.
|
|
592
|
+
* @param {number} current - The current position of the window covering.
|
|
593
|
+
* @param {number} target - The target position of the window covering.
|
|
594
|
+
* @param {WindowCovering.MovementStatus} status - The movement status of the window covering.
|
|
595
|
+
* @param {Endpoint} endpoint - The endpoint on which to set the window covering (default the device endpoint).
|
|
596
|
+
*/
|
|
597
|
+
setWindowCoveringCurrentTargetStatus(current: number, target: number, status: WindowCovering.MovementStatus, endpoint?: Endpoint): void;
|
|
598
|
+
/**
|
|
599
|
+
* Sets the status of the window covering.
|
|
600
|
+
* @param {WindowCovering.MovementStatus} status - The movement status to set.
|
|
601
|
+
* @param {Endpoint} endpoint - The endpoint on which to set the window covering (default the device endpoint).
|
|
602
|
+
*/
|
|
603
|
+
setWindowCoveringStatus(status: WindowCovering.MovementStatus, endpoint?: Endpoint): void;
|
|
604
|
+
/**
|
|
605
|
+
* Retrieves the status of the window covering.
|
|
606
|
+
* @param {Endpoint} endpoint - The endpoint on which to get the window covering (default the device endpoint).
|
|
607
|
+
*
|
|
608
|
+
* @returns The global operational status of the window covering.
|
|
609
|
+
*/
|
|
610
|
+
getWindowCoveringStatus(endpoint?: Endpoint): WindowCovering.MovementStatus | undefined;
|
|
611
|
+
/**
|
|
612
|
+
* Sets the target and current position of the window covering.
|
|
613
|
+
*
|
|
614
|
+
* @param position - The position to set, specified as a number.
|
|
615
|
+
* @param {Endpoint} endpoint - The endpoint on which to set the window covering (default the device endpoint).
|
|
616
|
+
*/
|
|
617
|
+
setWindowCoveringTargetAndCurrentPosition(position: number, endpoint?: Endpoint): void;
|
|
618
|
+
/**
|
|
619
|
+
* Get a default door lock cluster server.
|
|
620
|
+
*
|
|
621
|
+
* @remarks
|
|
622
|
+
* This method adds a cluster server for a door lock cluster with default settings.
|
|
623
|
+
*
|
|
624
|
+
*/
|
|
625
|
+
getDefaultDoorLockClusterServer(lockState?: DoorLock.LockState, lockType?: DoorLock.LockType): import("@project-chip/matter.js/cluster").ClusterServerObj<import("@matter/main/types").ClusterType>;
|
|
626
|
+
/**
|
|
627
|
+
* Creates a default door lock cluster server.
|
|
628
|
+
*
|
|
629
|
+
* @remarks
|
|
630
|
+
* This method adds a cluster server for a door lock cluster with default settings.
|
|
631
|
+
*
|
|
632
|
+
*/
|
|
633
|
+
createDefaultDoorLockClusterServer(lockState?: DoorLock.LockState, lockType?: DoorLock.LockType): void;
|
|
634
|
+
/**
|
|
635
|
+
* Get a default momentary switch cluster server.
|
|
636
|
+
*
|
|
637
|
+
* @remarks
|
|
638
|
+
* This method adds a cluster server with default momentary switch features and configurations suitable for (AppleHome) Single Double Long automations.
|
|
639
|
+
*/
|
|
640
|
+
getDefaultSwitchClusterServer(): import("@project-chip/matter.js/cluster").ClusterServerObj<any>;
|
|
641
|
+
/**
|
|
642
|
+
* Creates a default momentary switch cluster server.
|
|
643
|
+
*
|
|
644
|
+
* @remarks
|
|
645
|
+
* This method adds a cluster server with default momentary switch features and configurations.
|
|
646
|
+
*/
|
|
647
|
+
createDefaultSwitchClusterServer(): void;
|
|
648
|
+
/**
|
|
649
|
+
* Get a default latching switch cluster server.
|
|
650
|
+
*
|
|
651
|
+
* @remarks
|
|
652
|
+
* This method adds a cluster server with default latching switch features and configuration.
|
|
653
|
+
*/
|
|
654
|
+
getDefaultLatchingSwitchClusterServer(): import("@project-chip/matter.js/cluster").ClusterServerObj<any>;
|
|
655
|
+
/**
|
|
656
|
+
* Creates a default latching switch cluster server.
|
|
657
|
+
*
|
|
658
|
+
* @remarks
|
|
659
|
+
* This method adds a cluster server with default latching switch features and configuration.
|
|
660
|
+
*/
|
|
661
|
+
createDefaultLatchingSwitchClusterServer(): void;
|
|
662
|
+
/**
|
|
663
|
+
* Triggers a switch event on the specified endpoint.
|
|
664
|
+
*
|
|
665
|
+
* @param {string} event - The type of event to trigger. Possible values are 'Single', 'Double', 'Long' for momentarySwitch and 'Press', 'Release' for latchingSwitch.
|
|
666
|
+
* @param {Endpoint} endpoint - The endpoint on which to trigger the event (default the device endpoint).
|
|
667
|
+
* @returns {void}
|
|
668
|
+
*/
|
|
669
|
+
triggerSwitchEvent(event: 'Single' | 'Double' | 'Long' | 'Press' | 'Release', log?: AnsiLogger, endpoint?: Endpoint): boolean;
|
|
670
|
+
/**
|
|
671
|
+
* Retrieves the default mode select cluster server.
|
|
672
|
+
*
|
|
673
|
+
* @param description - The description of the cluster server.
|
|
674
|
+
* @param supportedModes - The supported modes for the cluster server.
|
|
675
|
+
* @param currentMode - The current mode of the cluster server. Defaults to 0.
|
|
676
|
+
* @param startUpMode - The startup mode of the cluster server. Defaults to 0.
|
|
677
|
+
* @returns The default mode select cluster server.
|
|
678
|
+
*/
|
|
679
|
+
getDefaultModeSelectClusterServer(description: string, supportedModes: ModeSelect.ModeOption[], currentMode?: number, startUpMode?: number): import("@project-chip/matter.js/cluster").ClusterServerObj<ModeSelect.Cluster>;
|
|
680
|
+
/**
|
|
681
|
+
* Creates a default mode select cluster server.
|
|
682
|
+
*
|
|
683
|
+
* @remarks
|
|
684
|
+
* This method adds a cluster server for a mode select cluster with default settings.
|
|
685
|
+
*
|
|
686
|
+
* @param endpoint - The endpoint to add the cluster server to. Defaults to `this` if not provided.
|
|
687
|
+
*/
|
|
688
|
+
createDefaultModeSelectClusterServer(description: string, supportedModes: ModeSelect.ModeOption[], currentMode?: number, startUpMode?: number, endpoint?: Endpoint): void;
|
|
689
|
+
/**
|
|
690
|
+
* Get a default occupancy sensing cluster server.
|
|
691
|
+
*
|
|
692
|
+
* @param occupied - A boolean indicating whether the occupancy is occupied or not. Default is false.
|
|
693
|
+
*/
|
|
694
|
+
getDefaultOccupancySensingClusterServer(occupied?: boolean): import("@project-chip/matter.js/cluster").ClusterServerObj<OccupancySensing.Cluster>;
|
|
695
|
+
/**
|
|
696
|
+
* Creates a default occupancy sensing cluster server.
|
|
697
|
+
*
|
|
698
|
+
* @param occupied - A boolean indicating whether the occupancy is occupied or not. Default is false.
|
|
699
|
+
*/
|
|
700
|
+
createDefaultOccupancySensingClusterServer(occupied?: boolean): void;
|
|
701
|
+
/**
|
|
702
|
+
* Get a default Illuminance Measurement Cluster Server.
|
|
703
|
+
*
|
|
704
|
+
* @param measuredValue - The measured value of illuminance.
|
|
705
|
+
*/
|
|
706
|
+
getDefaultIlluminanceMeasurementClusterServer(measuredValue?: number): import("@project-chip/matter.js/cluster").ClusterServerObj<IlluminanceMeasurement.Cluster>;
|
|
707
|
+
/**
|
|
708
|
+
* Creates a default Illuminance Measurement Cluster Server.
|
|
709
|
+
*
|
|
710
|
+
* @param measuredValue - The measured value of illuminance.
|
|
711
|
+
*/
|
|
712
|
+
createDefaultIlluminanceMeasurementClusterServer(measuredValue?: number): void;
|
|
713
|
+
/**
|
|
714
|
+
* Get a default flow measurement cluster server.
|
|
715
|
+
*
|
|
716
|
+
* @param measuredValue - The measured value of the flow in 10 x m/h.
|
|
717
|
+
*/
|
|
718
|
+
getDefaultFlowMeasurementClusterServer(measuredValue?: number): import("@project-chip/matter.js/cluster").ClusterServerObj<FlowMeasurement.Cluster>;
|
|
719
|
+
/**
|
|
720
|
+
* Creates a default flow measurement cluster server.
|
|
721
|
+
*
|
|
722
|
+
* @param measuredValue - The measured value of the of the flow in 10 x m/h.
|
|
723
|
+
*/
|
|
724
|
+
createDefaultFlowMeasurementClusterServer(measuredValue?: number): void;
|
|
725
|
+
/**
|
|
726
|
+
* Get a default temperature measurement cluster server.
|
|
727
|
+
*
|
|
728
|
+
* @param measuredValue - The measured value of the temperature x 100.
|
|
729
|
+
*/
|
|
730
|
+
getDefaultTemperatureMeasurementClusterServer(measuredValue?: number): import("@project-chip/matter.js/cluster").ClusterServerObj<TemperatureMeasurement.Cluster>;
|
|
731
|
+
/**
|
|
732
|
+
* Creates a default temperature measurement cluster server.
|
|
733
|
+
*
|
|
734
|
+
* @param measuredValue - The measured value of the temperature x 100.
|
|
735
|
+
*/
|
|
736
|
+
createDefaultTemperatureMeasurementClusterServer(measuredValue?: number): void;
|
|
737
|
+
/**
|
|
738
|
+
* Get a default RelativeHumidityMeasurementCluster server.
|
|
739
|
+
*
|
|
740
|
+
* @param measuredValue - The measured value of the relative humidity x 100.
|
|
741
|
+
*/
|
|
742
|
+
getDefaultRelativeHumidityMeasurementClusterServer(measuredValue?: number): import("@project-chip/matter.js/cluster").ClusterServerObj<RelativeHumidityMeasurement.Cluster>;
|
|
743
|
+
/**
|
|
744
|
+
* Creates a default RelativeHumidityMeasurementCluster server.
|
|
745
|
+
*
|
|
746
|
+
* @param measuredValue - The measured value of the relative humidity x 100.
|
|
747
|
+
*/
|
|
748
|
+
createDefaultRelativeHumidityMeasurementClusterServer(measuredValue?: number): void;
|
|
749
|
+
/**
|
|
750
|
+
* Get a default Pressure Measurement Cluster Server.
|
|
751
|
+
*
|
|
752
|
+
* @param measuredValue - The measured value for the pressure.
|
|
753
|
+
*/
|
|
754
|
+
getDefaultPressureMeasurementClusterServer(measuredValue?: number): import("@project-chip/matter.js/cluster").ClusterServerObj<PressureMeasurement.Cluster>;
|
|
755
|
+
/**
|
|
756
|
+
* Creates a default Pressure Measurement Cluster Server.
|
|
757
|
+
*
|
|
758
|
+
* @param measuredValue - The measured value for the pressure.
|
|
759
|
+
*/
|
|
760
|
+
createDefaultPressureMeasurementClusterServer(measuredValue?: number): void;
|
|
761
|
+
/**
|
|
762
|
+
* Get a default boolean state cluster server.
|
|
763
|
+
*
|
|
764
|
+
* @param contact - Optional boolean value indicating the contact state. Defaults to `true` if not provided.
|
|
765
|
+
*/
|
|
766
|
+
getDefaultBooleanStateClusterServer(contact?: boolean): import("@project-chip/matter.js/cluster").ClusterServerObj<BooleanState.Cluster>;
|
|
767
|
+
/**
|
|
768
|
+
* Creates a default boolean state configuration cluster server.
|
|
769
|
+
*
|
|
770
|
+
* @param contact - Optional boolean value indicating the contact state. Defaults to `true` if not provided.
|
|
771
|
+
*/
|
|
772
|
+
createDefaultBooleanStateClusterServer(contact?: boolean): void;
|
|
773
|
+
/**
|
|
774
|
+
* Get a default boolean state configuration cluster server.
|
|
775
|
+
*
|
|
776
|
+
* @param contact - Optional boolean value indicating the sensor fault state. Defaults to `false` if not provided.
|
|
777
|
+
*/
|
|
778
|
+
getDefaultBooleanStateConfigurationClusterServer(sensorFault?: boolean): import("@project-chip/matter.js/cluster").ClusterServerObj<any>;
|
|
779
|
+
/**
|
|
780
|
+
* Creates a default boolean state configuration cluster server.
|
|
781
|
+
*
|
|
782
|
+
* @param contact - Optional boolean value indicating the sensor fault state. Defaults to `false` if not provided.
|
|
783
|
+
*/
|
|
784
|
+
createDefaultBooleanStateConfigurationClusterServer(sensorFault?: boolean): void;
|
|
785
|
+
/**
|
|
786
|
+
* Get a default power source replaceable battery cluster server.
|
|
787
|
+
*
|
|
788
|
+
* @param batPercentRemaining - The remaining battery percentage (default: 100).
|
|
789
|
+
* @param batChargeLevel - The battery charge level (default: PowerSource.BatChargeLevel.Ok).
|
|
790
|
+
* @param batVoltage - The battery voltage (default: 1500).
|
|
791
|
+
* @param batReplacementDescription - The battery replacement description (default: 'Battery type').
|
|
792
|
+
* @param batQuantity - The battery quantity (default: 1).
|
|
793
|
+
*/
|
|
794
|
+
getDefaultPowerSourceReplaceableBatteryClusterServer(batPercentRemaining?: number, batChargeLevel?: PowerSource.BatChargeLevel, batVoltage?: number, batReplacementDescription?: string, batQuantity?: number): import("@project-chip/matter.js/cluster").ClusterServerObj<any>;
|
|
795
|
+
/**
|
|
796
|
+
* Creates a default power source replaceable battery cluster server.
|
|
797
|
+
*
|
|
798
|
+
* @param batPercentRemaining - The remaining battery percentage (default: 100).
|
|
799
|
+
* @param batChargeLevel - The battery charge level (default: PowerSource.BatChargeLevel.Ok).
|
|
800
|
+
* @param batVoltage - The battery voltage (default: 1500).
|
|
801
|
+
* @param batReplacementDescription - The battery replacement description (default: 'Battery type').
|
|
802
|
+
* @param batQuantity - The battery quantity (default: 1).
|
|
803
|
+
*/
|
|
804
|
+
createDefaultPowerSourceReplaceableBatteryClusterServer(batPercentRemaining?: number, batChargeLevel?: PowerSource.BatChargeLevel, batVoltage?: number, batReplacementDescription?: string, batQuantity?: number): void;
|
|
805
|
+
/**
|
|
806
|
+
* Get a default power source rechargeable battery cluster server.
|
|
807
|
+
*
|
|
808
|
+
* @param batPercentRemaining - The remaining battery percentage (default: 100).
|
|
809
|
+
* @param batChargeLevel - The battery charge level (default: PowerSource.BatChargeLevel.Ok).
|
|
810
|
+
* @param batVoltage - The battery voltage (default: 1500).
|
|
811
|
+
*/
|
|
812
|
+
getDefaultPowerSourceRechargeableBatteryClusterServer(batPercentRemaining?: number, batChargeLevel?: PowerSource.BatChargeLevel, batVoltage?: number): import("@project-chip/matter.js/cluster").ClusterServerObj<any>;
|
|
813
|
+
/**
|
|
814
|
+
* Creates a default power source rechargeable battery cluster server.
|
|
815
|
+
*
|
|
816
|
+
* @param batPercentRemaining - The remaining battery percentage (default: 100).
|
|
817
|
+
* @param batChargeLevel - The battery charge level (default: PowerSource.BatChargeLevel.Ok).
|
|
818
|
+
* @param batVoltage - The battery voltage (default: 1500).
|
|
819
|
+
*/
|
|
820
|
+
createDefaultPowerSourceRechargeableBatteryClusterServer(batPercentRemaining?: number, batChargeLevel?: PowerSource.BatChargeLevel, batVoltage?: number): void;
|
|
821
|
+
/**
|
|
822
|
+
* Get a default power source wired cluster server.
|
|
823
|
+
*
|
|
824
|
+
* @param wiredCurrentType - The type of wired current (default: PowerSource.WiredCurrentType.Ac)
|
|
825
|
+
*/
|
|
826
|
+
getDefaultPowerSourceWiredClusterServer(wiredCurrentType?: PowerSource.WiredCurrentType): import("@project-chip/matter.js/cluster").ClusterServerObj<any>;
|
|
827
|
+
/**
|
|
828
|
+
* Creates a default power source wired cluster server.
|
|
829
|
+
*
|
|
830
|
+
* @param wiredCurrentType - The type of wired current (default: PowerSource.WiredCurrentType.Ac)
|
|
831
|
+
*/
|
|
832
|
+
createDefaultPowerSourceWiredClusterServer(wiredCurrentType?: PowerSource.WiredCurrentType): void;
|
|
833
|
+
/**
|
|
834
|
+
* @deprecated This function is deprecated by Matter 1.3 spec and will be removed in a future version.
|
|
835
|
+
*/
|
|
836
|
+
createDefaultPowerSourceConfigurationClusterServer(endpointNumber?: number): void;
|
|
837
|
+
/**
|
|
838
|
+
* Get a default air quality cluster server.
|
|
839
|
+
*
|
|
840
|
+
* @param airQuality The air quality type. Defaults to `AirQuality.AirQualityType.Unknown`.
|
|
841
|
+
*/
|
|
842
|
+
getDefaultAirQualityClusterServer(airQuality?: AirQuality.AirQualityEnum): import("@project-chip/matter.js/cluster").ClusterServerObj<any>;
|
|
843
|
+
/**
|
|
844
|
+
* Creates a default air quality cluster server.
|
|
845
|
+
*
|
|
846
|
+
* @param airQuality The air quality type. Defaults to `AirQuality.AirQualityType.Unknown`.
|
|
847
|
+
*/
|
|
848
|
+
createDefaultAirQualityClusterServer(airQuality?: AirQuality.AirQualityEnum): void;
|
|
849
|
+
/**
|
|
850
|
+
* Get a default TVOC measurement cluster server.
|
|
851
|
+
*
|
|
852
|
+
* @param measuredValue - The measured value for TVOC.
|
|
853
|
+
*/
|
|
854
|
+
getDefaultTvocMeasurementClusterServer(measuredValue?: number, measurementUnit?: ConcentrationMeasurement.MeasurementUnit, measurementMedium?: ConcentrationMeasurement.MeasurementMedium): import("@project-chip/matter.js/cluster").ClusterServerObj<any>;
|
|
855
|
+
/**
|
|
856
|
+
* Creates a default TVOC measurement cluster server.
|
|
857
|
+
*
|
|
858
|
+
* @param measuredValue - The measured value for TVOC.
|
|
859
|
+
*/
|
|
860
|
+
createDefaultTvocMeasurementClusterServer(measuredValue?: number, measurementUnit?: ConcentrationMeasurement.MeasurementUnit, measurementMedium?: ConcentrationMeasurement.MeasurementMedium): void;
|
|
861
|
+
/**
|
|
862
|
+
* Get a default heating thermostat cluster server with the specified parameters.
|
|
863
|
+
* @param {number} [localTemperature] - The local temperature value in degrees Celsius. Defaults to 23°.
|
|
864
|
+
* @param {number} [occupiedHeatingSetpoint] - The occupied heating setpoint value in degrees Celsius. Defaults to 21°.
|
|
865
|
+
* @param {number} [minHeatSetpointLimit] - The minimum heat setpoint limit value. Defaults to 0°.
|
|
866
|
+
* @param {number} [maxHeatSetpointLimit] - The maximum heat setpoint limit value. Defaults to 50°.
|
|
867
|
+
* @returns {ThermostatClusterServer} A default thermostat cluster server configured with the specified parameters.
|
|
868
|
+
*/
|
|
869
|
+
getDefaultHeatingThermostatClusterServer(localTemperature?: number, occupiedHeatingSetpoint?: number, minHeatSetpointLimit?: number, maxHeatSetpointLimit?: number): import("@project-chip/matter.js/cluster").ClusterServerObj<any>;
|
|
870
|
+
/**
|
|
871
|
+
* Creates and adds a default heating thermostat cluster server to the device.
|
|
872
|
+
*
|
|
873
|
+
* @param {number} [localTemperature] - The local temperature value in degrees Celsius. Defaults to 23°.
|
|
874
|
+
* @param {number} [occupiedHeatingSetpoint] - The occupied heating setpoint value in degrees Celsius. Defaults to 21°.
|
|
875
|
+
* @param {number} [minHeatSetpointLimit] - The minimum heat setpoint limit value. Defaults to 0°.
|
|
876
|
+
* @param {number} [maxHeatSetpointLimit] - The maximum heat setpoint limit value. Defaults to 50°.
|
|
877
|
+
*/
|
|
878
|
+
createDefaultHeatingThermostatClusterServer(localTemperature?: number, occupiedHeatingSetpoint?: number, minHeatSetpointLimit?: number, maxHeatSetpointLimit?: number): void;
|
|
879
|
+
/**
|
|
880
|
+
* Get a default cooling thermostat cluster server with the specified parameters.
|
|
881
|
+
* @param {number} [localTemperature] - The local temperature value in degrees Celsius. Defaults to 23°.
|
|
882
|
+
* @param {number} [occupiedCoolingSetpoint] - The occupied cooling setpoint value in degrees Celsius. Defaults to 25°.
|
|
883
|
+
* @param {number} [minCoolSetpointLimit] - The minimum cool setpoint limit value. Defaults to 0°.
|
|
884
|
+
* @param {number} [maxCoolSetpointLimit] - The maximum cool setpoint limit value. Defaults to 50°.
|
|
885
|
+
* @returns {ThermostatClusterServer} A default thermostat cluster server configured with the specified parameters.
|
|
886
|
+
*/
|
|
887
|
+
getDefaultCoolingThermostatClusterServer(localTemperature?: number, occupiedCoolingSetpoint?: number, minCoolSetpointLimit?: number, maxCoolSetpointLimit?: number): import("@project-chip/matter.js/cluster").ClusterServerObj<any>;
|
|
888
|
+
/**
|
|
889
|
+
* Creates and adds a default cooling thermostat cluster server to the device.
|
|
890
|
+
*
|
|
891
|
+
* @param {number} [localTemperature] - The local temperature value in degrees Celsius. Defaults to 23°.
|
|
892
|
+
* @param {number} [occupiedCoolingSetpoint] - The occupied cooling setpoint value in degrees Celsius. Defaults to 25°.
|
|
893
|
+
* @param {number} [minCoolSetpointLimit] - The minimum cool setpoint limit value. Defaults to 0°.
|
|
894
|
+
* @param {number} [maxCoolSetpointLimit] - The maximum cool setpoint limit value. Defaults to 50°.
|
|
895
|
+
*/
|
|
896
|
+
createDefaultCoolingThermostatClusterServer(localTemperature?: number, occupiedCoolingSetpoint?: number, minCoolSetpointLimit?: number, maxCoolSetpointLimit?: number): void;
|
|
897
|
+
/**
|
|
898
|
+
* Get a default thermostat cluster server with the specified parameters.
|
|
899
|
+
*
|
|
900
|
+
* @param {number} [localTemperature=23] - The local temperature value in degrees Celsius. Defaults to 23°.
|
|
901
|
+
* @param {number} [occupiedHeatingSetpoint=21] - The occupied heating setpoint value in degrees Celsius. Defaults to 21°.
|
|
902
|
+
* @param {number} [occupiedCoolingSetpoint=25] - The occupied cooling setpoint value in degrees Celsius. Defaults to 25°.
|
|
903
|
+
* @param {number} [minSetpointDeadBand=1] - The minimum setpoint dead band value. Defaults to 1°.
|
|
904
|
+
* @param {number} [minHeatSetpointLimit=0] - The minimum heat setpoint limit value. Defaults to 0°.
|
|
905
|
+
* @param {number} [maxHeatSetpointLimit=50] - The maximum heat setpoint limit value. Defaults to 50°.
|
|
906
|
+
* @param {number} [minCoolSetpointLimit=0] - The minimum cool setpoint limit value. Defaults to 0°.
|
|
907
|
+
* @param {number} [maxCoolSetpointLimit=50] - The maximum cool setpoint limit value. Defaults to 50°.
|
|
908
|
+
* @returns {ThermostatClusterServer} A default thermostat cluster server configured with the specified parameters.
|
|
909
|
+
*/
|
|
910
|
+
getDefaultThermostatClusterServer(localTemperature?: number, occupiedHeatingSetpoint?: number, occupiedCoolingSetpoint?: number, minSetpointDeadBand?: number, minHeatSetpointLimit?: number, maxHeatSetpointLimit?: number, minCoolSetpointLimit?: number, maxCoolSetpointLimit?: number): import("@project-chip/matter.js/cluster").ClusterServerObj<any>;
|
|
911
|
+
/**
|
|
912
|
+
* Creates and adds a default thermostat cluster server to the device.
|
|
913
|
+
*
|
|
914
|
+
* @param {number} [localTemperature=23] - The local temperature value in degrees Celsius. Defaults to 23°.
|
|
915
|
+
* @param {number} [occupiedHeatingSetpoint=21] - The occupied heating setpoint value in degrees Celsius. Defaults to 21°.
|
|
916
|
+
* @param {number} [occupiedCoolingSetpoint=25] - The occupied cooling setpoint value in degrees Celsius. Defaults to 25°.
|
|
917
|
+
* @param {number} [minSetpointDeadBand=1] - The minimum setpoint dead band value. Defaults to 1°.
|
|
918
|
+
* @param {number} [minHeatSetpointLimit=0] - The minimum heat setpoint limit value. Defaults to 0°.
|
|
919
|
+
* @param {number} [maxHeatSetpointLimit=50] - The maximum heat setpoint limit value. Defaults to 50°.
|
|
920
|
+
* @param {number} [minCoolSetpointLimit=0] - The minimum cool setpoint limit value. Defaults to 0°.
|
|
921
|
+
* @param {number} [maxCoolSetpointLimit=50] - The maximum cool setpoint limit value. Defaults to 50°.
|
|
922
|
+
*/
|
|
923
|
+
createDefaultThermostatClusterServer(localTemperature?: number, occupiedHeatingSetpoint?: number, occupiedCoolingSetpoint?: number, minSetpointDeadBand?: number, minHeatSetpointLimit?: number, maxHeatSetpointLimit?: number, minCoolSetpointLimit?: number, maxCoolSetpointLimit?: number): void;
|
|
924
|
+
/**
|
|
925
|
+
* Get a default dummy time sync cluster server. Only needed to create a thermostat.
|
|
926
|
+
*/
|
|
927
|
+
getDefaultTimeSyncClusterServer(): import("@project-chip/matter.js/cluster").ClusterServerObj<any>;
|
|
928
|
+
/**
|
|
929
|
+
* Creates a default dummy time sync cluster server. Only needed to create a thermostat.
|
|
930
|
+
*/
|
|
931
|
+
createDefaultTimeSyncClusterServer(): void;
|
|
932
|
+
/**
|
|
933
|
+
* Returns the default SmokeCOAlarm Cluster Server.
|
|
934
|
+
*
|
|
935
|
+
* @param smokeState - The state of the smoke alarm. Defaults to SmokeCoAlarm.AlarmState.Normal.
|
|
936
|
+
* @param coState - The state of the CO alarm. Defaults to SmokeCoAlarm.AlarmState.Normal.
|
|
937
|
+
* @returns The default SmokeCOAlarmClusterServer.
|
|
938
|
+
*/
|
|
939
|
+
getDefaultSmokeCOAlarmClusterServer(smokeState?: SmokeCoAlarm.AlarmState, coState?: SmokeCoAlarm.AlarmState): import("@project-chip/matter.js/cluster").ClusterServerObj<any>;
|
|
940
|
+
/**
|
|
941
|
+
* Create the default SmokeCOAlarm Cluster Server.
|
|
942
|
+
*
|
|
943
|
+
* @param smokeState - The state of the smoke alarm. Defaults to SmokeCoAlarm.AlarmState.Normal.
|
|
944
|
+
* @param coState - The state of the CO alarm. Defaults to SmokeCoAlarm.AlarmState.Normal.
|
|
945
|
+
* @returns The default SmokeCOAlarmClusterServer.
|
|
946
|
+
*/
|
|
947
|
+
createDefaultSmokeCOAlarmClusterServer(smokeState?: SmokeCoAlarm.AlarmState, coState?: SmokeCoAlarm.AlarmState): void;
|
|
948
|
+
/**
|
|
949
|
+
* Returns the default Carbon Monoxide Concentration Measurement Cluster Server.
|
|
950
|
+
*
|
|
951
|
+
* @param {number} measuredValue - The measured value of the concentration.
|
|
952
|
+
* @param {ConcentrationMeasurement.MeasurementUnit} measurementUnit - The unit of measurement.
|
|
953
|
+
* @param {ConcentrationMeasurement.MeasurementMedium} measurementMedium - The medium of measurement.
|
|
954
|
+
* @returns {ClusterServer} - The default Carbon Monoxide Concentration Measurement Cluster Server.
|
|
955
|
+
*/
|
|
956
|
+
getDefaultCarbonMonoxideConcentrationMeasurementClusterServer(measuredValue?: number, measurementUnit?: ConcentrationMeasurement.MeasurementUnit, measurementMedium?: ConcentrationMeasurement.MeasurementMedium): import("@project-chip/matter.js/cluster").ClusterServerObj<any>;
|
|
957
|
+
/**
|
|
958
|
+
* Create the default Carbon Monoxide Concentration Measurement Cluster Server.
|
|
959
|
+
*
|
|
960
|
+
* @param {number} measuredValue - The measured value of the concentration.
|
|
961
|
+
* @param {ConcentrationMeasurement.MeasurementUnit} measurementUnit - The unit of measurement.
|
|
962
|
+
* @param {ConcentrationMeasurement.MeasurementMedium} measurementMedium - The medium of measurement.
|
|
963
|
+
*/
|
|
964
|
+
createDefaultCarbonMonoxideConcentrationMeasurementClusterServer(measuredValue?: number, measurementUnit?: ConcentrationMeasurement.MeasurementUnit, measurementMedium?: ConcentrationMeasurement.MeasurementMedium): void;
|
|
965
|
+
/**
|
|
966
|
+
* Returns the default Carbon Dioxide Concentration Measurement Cluster Server.
|
|
967
|
+
*
|
|
968
|
+
* @param {number} measuredValue - The measured value of the concentration.
|
|
969
|
+
* @param {ConcentrationMeasurement.MeasurementUnit} measurementUnit - The unit of measurement.
|
|
970
|
+
* @param {ConcentrationMeasurement.MeasurementMedium} measurementMedium - The medium of measurement.
|
|
971
|
+
* @returns {ClusterServer} - The default Carbon Monoxide Concentration Measurement Cluster Server.
|
|
972
|
+
*/
|
|
973
|
+
getDefaultCarbonDioxideConcentrationMeasurementClusterServer(measuredValue?: number, measurementUnit?: ConcentrationMeasurement.MeasurementUnit, measurementMedium?: ConcentrationMeasurement.MeasurementMedium): import("@project-chip/matter.js/cluster").ClusterServerObj<any>;
|
|
974
|
+
/**
|
|
975
|
+
* Create the default Carbon Dioxide Concentration Measurement Cluster Server.
|
|
976
|
+
*
|
|
977
|
+
* @param {number} measuredValue - The measured value of the concentration.
|
|
978
|
+
* @param {ConcentrationMeasurement.MeasurementUnit} measurementUnit - The unit of measurement.
|
|
979
|
+
* @param {ConcentrationMeasurement.MeasurementMedium} measurementMedium - The medium of measurement.
|
|
980
|
+
*/
|
|
981
|
+
createDefaultCarbonDioxideConcentrationMeasurementClusterServer(measuredValue?: number, measurementUnit?: ConcentrationMeasurement.MeasurementUnit, measurementMedium?: ConcentrationMeasurement.MeasurementMedium): void;
|
|
982
|
+
/**
|
|
983
|
+
* Returns the default Formaldehyde Concentration Measurement Cluster Server.
|
|
984
|
+
*
|
|
985
|
+
* @param {number} measuredValue - The measured value of the concentration.
|
|
986
|
+
* @param {ConcentrationMeasurement.MeasurementUnit} measurementUnit - The unit of measurement.
|
|
987
|
+
* @param {ConcentrationMeasurement.MeasurementMedium} measurementMedium - The medium of measurement.
|
|
988
|
+
* @returns {ClusterServer} - The default Carbon Monoxide Concentration Measurement Cluster Server.
|
|
989
|
+
*/
|
|
990
|
+
getDefaultFormaldehydeConcentrationMeasurementClusterServer(measuredValue?: number, measurementUnit?: ConcentrationMeasurement.MeasurementUnit, measurementMedium?: ConcentrationMeasurement.MeasurementMedium): import("@project-chip/matter.js/cluster").ClusterServerObj<any>;
|
|
991
|
+
/**
|
|
992
|
+
* Create the default Formaldehyde Concentration Measurement Cluster Server.
|
|
993
|
+
*
|
|
994
|
+
* @param {number} measuredValue - The measured value of the concentration.
|
|
995
|
+
* @param {ConcentrationMeasurement.MeasurementUnit} measurementUnit - The unit of measurement.
|
|
996
|
+
* @param {ConcentrationMeasurement.MeasurementMedium} measurementMedium - The medium of measurement.
|
|
997
|
+
*/
|
|
998
|
+
createDefaultFormaldehydeConcentrationMeasurementClusterServer(measuredValue?: number, measurementUnit?: ConcentrationMeasurement.MeasurementUnit, measurementMedium?: ConcentrationMeasurement.MeasurementMedium): void;
|
|
999
|
+
/**
|
|
1000
|
+
* Returns the default Pm1 Concentration Measurement Cluster Server.
|
|
1001
|
+
*
|
|
1002
|
+
* @param {number} measuredValue - The measured value of the concentration.
|
|
1003
|
+
* @param {ConcentrationMeasurement.MeasurementUnit} measurementUnit - The unit of measurement.
|
|
1004
|
+
* @param {ConcentrationMeasurement.MeasurementMedium} measurementMedium - The medium of measurement.
|
|
1005
|
+
* @returns {ClusterServer} - The default Carbon Monoxide Concentration Measurement Cluster Server.
|
|
1006
|
+
*/
|
|
1007
|
+
getDefaultPm1ConcentrationMeasurementClusterServer(measuredValue?: number, measurementUnit?: ConcentrationMeasurement.MeasurementUnit, measurementMedium?: ConcentrationMeasurement.MeasurementMedium): import("@project-chip/matter.js/cluster").ClusterServerObj<any>;
|
|
1008
|
+
/**
|
|
1009
|
+
* Create the default Pm1 Concentration Measurement Cluster Server.
|
|
1010
|
+
*
|
|
1011
|
+
* @param {number} measuredValue - The measured value of the concentration.
|
|
1012
|
+
* @param {ConcentrationMeasurement.MeasurementUnit} measurementUnit - The unit of measurement.
|
|
1013
|
+
* @param {ConcentrationMeasurement.MeasurementMedium} measurementMedium - The medium of measurement.
|
|
1014
|
+
*/
|
|
1015
|
+
createDefaultPm1ConcentrationMeasurementClusterServer(measuredValue?: number, measurementUnit?: ConcentrationMeasurement.MeasurementUnit, measurementMedium?: ConcentrationMeasurement.MeasurementMedium): void;
|
|
1016
|
+
/**
|
|
1017
|
+
* Returns the default Pm25 Concentration Measurement Cluster Server.
|
|
1018
|
+
*
|
|
1019
|
+
* @param {number} measuredValue - The measured value of the concentration.
|
|
1020
|
+
* @param {ConcentrationMeasurement.MeasurementUnit} measurementUnit - The unit of measurement.
|
|
1021
|
+
* @param {ConcentrationMeasurement.MeasurementMedium} measurementMedium - The medium of measurement.
|
|
1022
|
+
* @returns {ClusterServer} - The default Carbon Monoxide Concentration Measurement Cluster Server.
|
|
1023
|
+
*/
|
|
1024
|
+
getDefaultPm25ConcentrationMeasurementClusterServer(measuredValue?: number, measurementUnit?: ConcentrationMeasurement.MeasurementUnit, measurementMedium?: ConcentrationMeasurement.MeasurementMedium): import("@project-chip/matter.js/cluster").ClusterServerObj<any>;
|
|
1025
|
+
/**
|
|
1026
|
+
* Create the default Pm25 Concentration Measurement Cluster Server.
|
|
1027
|
+
*
|
|
1028
|
+
* @param {number} measuredValue - The measured value of the concentration.
|
|
1029
|
+
* @param {ConcentrationMeasurement.MeasurementUnit} measurementUnit - The unit of measurement.
|
|
1030
|
+
* @param {ConcentrationMeasurement.MeasurementMedium} measurementMedium - The medium of measurement.
|
|
1031
|
+
*/
|
|
1032
|
+
createDefaultPm25ConcentrationMeasurementClusterServer(measuredValue?: number, measurementUnit?: ConcentrationMeasurement.MeasurementUnit, measurementMedium?: ConcentrationMeasurement.MeasurementMedium): void;
|
|
1033
|
+
/**
|
|
1034
|
+
* Returns the default Pm10 Concentration Measurement Cluster Server.
|
|
1035
|
+
*
|
|
1036
|
+
* @param {number} measuredValue - The measured value of the concentration.
|
|
1037
|
+
* @param {ConcentrationMeasurement.MeasurementUnit} measurementUnit - The unit of measurement.
|
|
1038
|
+
* @param {ConcentrationMeasurement.MeasurementMedium} measurementMedium - The medium of measurement.
|
|
1039
|
+
* @returns {ClusterServer} - The default Carbon Monoxide Concentration Measurement Cluster Server.
|
|
1040
|
+
*/
|
|
1041
|
+
getDefaultPm10ConcentrationMeasurementClusterServer(measuredValue?: number, measurementUnit?: ConcentrationMeasurement.MeasurementUnit, measurementMedium?: ConcentrationMeasurement.MeasurementMedium): import("@project-chip/matter.js/cluster").ClusterServerObj<any>;
|
|
1042
|
+
/**
|
|
1043
|
+
* Create the default Pm10 Concentration Measurement Cluster Server.
|
|
1044
|
+
*
|
|
1045
|
+
* @param {number} measuredValue - The measured value of the concentration.
|
|
1046
|
+
* @param {ConcentrationMeasurement.MeasurementUnit} measurementUnit - The unit of measurement.
|
|
1047
|
+
* @param {ConcentrationMeasurement.MeasurementMedium} measurementMedium - The medium of measurement.
|
|
1048
|
+
*/
|
|
1049
|
+
createDefaultPm10ConcentrationMeasurementClusterServer(measuredValue?: number, measurementUnit?: ConcentrationMeasurement.MeasurementUnit, measurementMedium?: ConcentrationMeasurement.MeasurementMedium): void;
|
|
1050
|
+
/**
|
|
1051
|
+
* Returns the default Ozone Concentration Measurement Cluster Server.
|
|
1052
|
+
*
|
|
1053
|
+
* @param {number} measuredValue - The measured value of the concentration.
|
|
1054
|
+
* @param {ConcentrationMeasurement.MeasurementUnit} measurementUnit - The unit of measurement.
|
|
1055
|
+
* @param {ConcentrationMeasurement.MeasurementMedium} measurementMedium - The medium of measurement.
|
|
1056
|
+
* @returns {ClusterServer} - The default Carbon Monoxide Concentration Measurement Cluster Server.
|
|
1057
|
+
*/
|
|
1058
|
+
getDefaultOzoneConcentrationMeasurementClusterServer(measuredValue?: number, measurementUnit?: ConcentrationMeasurement.MeasurementUnit, measurementMedium?: ConcentrationMeasurement.MeasurementMedium): import("@project-chip/matter.js/cluster").ClusterServerObj<any>;
|
|
1059
|
+
/**
|
|
1060
|
+
* Create the default Ozone Concentration Measurement Cluster Server.
|
|
1061
|
+
*
|
|
1062
|
+
* @param {number} measuredValue - The measured value of the concentration.
|
|
1063
|
+
* @param {ConcentrationMeasurement.MeasurementUnit} measurementUnit - The unit of measurement.
|
|
1064
|
+
* @param {ConcentrationMeasurement.MeasurementMedium} measurementMedium - The medium of measurement.
|
|
1065
|
+
*/
|
|
1066
|
+
createDefaultOzoneConcentrationMeasurementClusterServer(measuredValue?: number, measurementUnit?: ConcentrationMeasurement.MeasurementUnit, measurementMedium?: ConcentrationMeasurement.MeasurementMedium): void;
|
|
1067
|
+
/**
|
|
1068
|
+
* Returns the default Radon Concentration Measurement Cluster Server.
|
|
1069
|
+
*
|
|
1070
|
+
* @param {number} measuredValue - The measured value of the concentration.
|
|
1071
|
+
* @param {ConcentrationMeasurement.MeasurementUnit} measurementUnit - The unit of measurement.
|
|
1072
|
+
* @param {ConcentrationMeasurement.MeasurementMedium} measurementMedium - The medium of measurement.
|
|
1073
|
+
* @returns {ClusterServer} - The default Carbon Monoxide Concentration Measurement Cluster Server.
|
|
1074
|
+
*/
|
|
1075
|
+
getDefaultRadonConcentrationMeasurementClusterServer(measuredValue?: number, measurementUnit?: ConcentrationMeasurement.MeasurementUnit, measurementMedium?: ConcentrationMeasurement.MeasurementMedium): import("@project-chip/matter.js/cluster").ClusterServerObj<any>;
|
|
1076
|
+
/**
|
|
1077
|
+
* Create the default Radon Concentration Measurement Cluster Server.
|
|
1078
|
+
*
|
|
1079
|
+
* @param {number} measuredValue - The measured value of the concentration.
|
|
1080
|
+
* @param {ConcentrationMeasurement.MeasurementUnit} measurementUnit - The unit of measurement.
|
|
1081
|
+
* @param {ConcentrationMeasurement.MeasurementMedium} measurementMedium - The medium of measurement.
|
|
1082
|
+
*/
|
|
1083
|
+
createDefaultRadonConcentrationMeasurementClusterServer(measuredValue?: number, measurementUnit?: ConcentrationMeasurement.MeasurementUnit, measurementMedium?: ConcentrationMeasurement.MeasurementMedium): void;
|
|
1084
|
+
/**
|
|
1085
|
+
* Returns the default Nitrogen Dioxide Concentration Measurement Cluster Server.
|
|
1086
|
+
*
|
|
1087
|
+
* @param {number} measuredValue - The measured value of the concentration.
|
|
1088
|
+
* @param {ConcentrationMeasurement.MeasurementUnit} measurementUnit - The unit of measurement.
|
|
1089
|
+
* @param {ConcentrationMeasurement.MeasurementMedium} measurementMedium - The medium of measurement.
|
|
1090
|
+
* @returns {ClusterServer} - The default Carbon Monoxide Concentration Measurement Cluster Server.
|
|
1091
|
+
*/
|
|
1092
|
+
getDefaultNitrogenDioxideConcentrationMeasurementClusterServer(measuredValue?: number, measurementUnit?: ConcentrationMeasurement.MeasurementUnit, measurementMedium?: ConcentrationMeasurement.MeasurementMedium): import("@project-chip/matter.js/cluster").ClusterServerObj<any>;
|
|
1093
|
+
/**
|
|
1094
|
+
* Create the default Nitrogen Dioxide Concentration Measurement Cluster Server.
|
|
1095
|
+
*
|
|
1096
|
+
* @param {number} measuredValue - The measured value of the concentration.
|
|
1097
|
+
* @param {ConcentrationMeasurement.MeasurementUnit} measurementUnit - The unit of measurement.
|
|
1098
|
+
* @param {ConcentrationMeasurement.MeasurementMedium} measurementMedium - The medium of measurement.
|
|
1099
|
+
*/
|
|
1100
|
+
createDefaultNitrogenDioxideConcentrationMeasurementClusterServer(measuredValue?: number, measurementUnit?: ConcentrationMeasurement.MeasurementUnit, measurementMedium?: ConcentrationMeasurement.MeasurementMedium): void;
|
|
1101
|
+
/**
|
|
1102
|
+
* Returns the default fan control cluster server rev 2.
|
|
1103
|
+
*
|
|
1104
|
+
* @param fanMode The fan mode to set. Defaults to `FanControl.FanMode.Off`.
|
|
1105
|
+
* @returns The default fan control cluster server.
|
|
1106
|
+
*/
|
|
1107
|
+
getDefaultFanControlClusterServer(fanMode?: FanControl.FanMode): import("@project-chip/matter.js/cluster").ClusterServerObj<any>;
|
|
1108
|
+
/**
|
|
1109
|
+
* Create the default fan control cluster server rev 2.
|
|
1110
|
+
*
|
|
1111
|
+
* @param fanMode The fan mode to set. Defaults to `FanControl.FanMode.Off`.
|
|
1112
|
+
* @returns The default fan control cluster server.
|
|
1113
|
+
*/
|
|
1114
|
+
createDefaultFanControlClusterServer(fanMode?: FanControl.FanMode): void;
|
|
1115
|
+
/**
|
|
1116
|
+
* Returns the default Pump Configuration And Control cluster server.
|
|
1117
|
+
*
|
|
1118
|
+
* @param {PumpConfigurationAndControl.OperationMode} [pumpMode=PumpConfigurationAndControl.OperationMode.Normal] - The pump mode to set. Defaults to `PumpConfigurationAndControl.OperationMode.Normal`.
|
|
1119
|
+
* @returns {ClusterServer} - The default Pump Configuration And Control cluster server.
|
|
1120
|
+
*/
|
|
1121
|
+
getDefaultPumpConfigurationAndControlClusterServer(pumpMode?: PumpConfigurationAndControl.OperationMode): import("@project-chip/matter.js/cluster").ClusterServerObj<any>;
|
|
1122
|
+
/**
|
|
1123
|
+
* Creates the default Pump Configuration And Control cluster server.
|
|
1124
|
+
*
|
|
1125
|
+
* @param {PumpConfigurationAndControl.OperationMode} [pumpMode=PumpConfigurationAndControl.OperationMode.Normal] - The pump mode to set. Defaults to `PumpConfigurationAndControl.OperationMode.Normal`.
|
|
1126
|
+
* @returns {void}
|
|
1127
|
+
*/
|
|
1128
|
+
createDefaultPumpConfigurationAndControlClusterServer(pumpMode?: PumpConfigurationAndControl.OperationMode): void;
|
|
1129
|
+
getDefaultValveConfigurationAndControlClusterServer(valveState?: ValveConfigurationAndControl.ValveState, valveLevel?: number): import("@project-chip/matter.js/cluster").ClusterServerObj<any>;
|
|
1130
|
+
/**
|
|
1131
|
+
* Create the default Valve Configuration And Control cluster server rev 2.
|
|
1132
|
+
*
|
|
1133
|
+
* @param {ValveConfigurationAndControl.ValveState} [valveState=ValveConfigurationAndControl.ValveState.Closed] - The valve state to set. Defaults to `ValveConfigurationAndControl.ValveState.Closed`.
|
|
1134
|
+
* @param {number} [valveLevel=0] - The valve level to set. Defaults to 0.
|
|
1135
|
+
* @returns {void}
|
|
1136
|
+
*/
|
|
1137
|
+
createDefaultValveConfigurationAndControlClusterServer(valveState?: ValveConfigurationAndControl.ValveState, valveLevel?: number): void;
|
|
1138
|
+
getDefaultDeviceEnergyManagementClusterServer(): import("@project-chip/matter.js/cluster").ClusterServerObj<any>;
|
|
1139
|
+
getDefaultDeviceEnergyManagementModeClusterServer(): import("@project-chip/matter.js/cluster").ClusterServerObj<DeviceEnergyManagementMode.Cluster>;
|
|
1140
|
+
}
|
|
1141
|
+
export {};
|
|
1142
|
+
//# sourceMappingURL=matterbridgeDevice.d.ts.map
|