matterbridge 3.0.7 → 3.0.8-dev-20250622-9a6255a
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 +25 -0
- package/bin/matterbridge +2 -0
- package/dist/cli.js +5 -66
- package/dist/clusters/export.js +0 -2
- package/dist/defaultConfigSchema.js +0 -23
- package/dist/deviceManager.js +2 -95
- package/dist/devices/export.js +0 -2
- package/dist/evse.js +9 -65
- package/dist/frontend.js +47 -383
- package/dist/globalMatterbridge.js +0 -20
- package/dist/helpers.js +4 -52
- package/dist/index.js +2 -29
- package/dist/laundryWasher.js +7 -92
- package/dist/logger/export.js +0 -1
- package/dist/matter/behaviors.js +0 -2
- package/dist/matter/clusters.js +0 -2
- package/dist/matter/devices.js +0 -2
- package/dist/matter/endpoints.js +0 -2
- package/dist/matter/export.js +0 -2
- package/dist/matter/types.js +0 -2
- package/dist/matterbridge.js +53 -755
- package/dist/matterbridgeAccessoryPlatform.js +0 -34
- package/dist/matterbridgeBehaviors.js +1 -54
- package/dist/matterbridgeDeviceTypes.js +15 -578
- package/dist/matterbridgeDynamicPlatform.js +0 -34
- package/dist/matterbridgeEndpoint.js +45 -1000
- package/dist/matterbridgeEndpointHelpers.js +12 -206
- package/dist/matterbridgePlatform.js +13 -225
- package/dist/matterbridgeTypes.js +0 -24
- package/dist/pluginManager.js +4 -270
- package/dist/roboticVacuumCleaner.js +9 -84
- package/dist/shelly.js +9 -156
- package/dist/storage/export.js +0 -1
- package/dist/update.js +0 -53
- package/dist/utils/colorUtils.js +2 -205
- package/dist/utils/commandLine.js +0 -53
- package/dist/utils/copyDirectory.js +1 -37
- package/dist/utils/createDirectory.js +0 -31
- package/dist/utils/createZip.js +2 -42
- package/dist/utils/deepCopy.js +0 -38
- package/dist/utils/deepEqual.js +1 -71
- package/dist/utils/export.js +0 -1
- package/dist/utils/hex.js +0 -57
- package/dist/utils/isvalid.js +0 -100
- package/dist/utils/network.js +6 -77
- package/dist/utils/spawn.js +0 -16
- package/dist/utils/wait.js +10 -58
- package/dist/waterHeater.js +5 -65
- package/frontend/build/matterbridge 1250x1250.png +0 -0
- package/frontend/build/matterbridge 624x624.png +0 -0
- package/frontend/package-lock.json +19176 -0
- package/frontend/package.json +79 -0
- package/frontend/public/Shelly.svg +1 -0
- package/frontend/public/bmc-button.svg +22 -0
- package/frontend/public/discord.svg +5 -0
- package/frontend/public/favicon.ico +0 -0
- package/frontend/public/index.html +19 -0
- package/frontend/public/manifest.json +15 -0
- package/frontend/public/matter.png +0 -0
- package/frontend/public/matterbridge 1250x1250.png +0 -0
- package/frontend/public/matterbridge 32x32.png +0 -0
- package/frontend/public/matterbridge 624x624.png +0 -0
- package/frontend/public/matterbridge 64x64.png +0 -0
- package/frontend/public/matterbridge.svg +50 -0
- package/frontend/public/robots.txt +3 -0
- package/npm-shrinkwrap.json +33 -42
- package/package.json +3 -4
- package/dist/cli.d.ts +0 -29
- package/dist/cli.d.ts.map +0 -1
- package/dist/cli.js.map +0 -1
- package/dist/clusters/export.d.ts +0 -2
- package/dist/clusters/export.d.ts.map +0 -1
- package/dist/clusters/export.js.map +0 -1
- package/dist/defaultConfigSchema.d.ts +0 -27
- package/dist/defaultConfigSchema.d.ts.map +0 -1
- package/dist/defaultConfigSchema.js.map +0 -1
- package/dist/deviceManager.d.ts +0 -114
- package/dist/deviceManager.d.ts.map +0 -1
- package/dist/deviceManager.js.map +0 -1
- package/dist/devices/export.d.ts +0 -5
- package/dist/devices/export.d.ts.map +0 -1
- package/dist/devices/export.js.map +0 -1
- package/dist/evse.d.ts +0 -67
- package/dist/evse.d.ts.map +0 -1
- package/dist/evse.js.map +0 -1
- package/dist/frontend.d.ts +0 -256
- package/dist/frontend.d.ts.map +0 -1
- package/dist/frontend.js.map +0 -1
- package/dist/globalMatterbridge.d.ts +0 -32
- package/dist/globalMatterbridge.d.ts.map +0 -1
- package/dist/globalMatterbridge.js.map +0 -1
- package/dist/helpers.d.ts +0 -47
- package/dist/helpers.d.ts.map +0 -1
- package/dist/helpers.js.map +0 -1
- package/dist/index.d.ts +0 -37
- package/dist/index.d.ts.map +0 -1
- package/dist/index.js.map +0 -1
- package/dist/laundryWasher.d.ts +0 -243
- package/dist/laundryWasher.d.ts.map +0 -1
- package/dist/laundryWasher.js.map +0 -1
- package/dist/logger/export.d.ts +0 -2
- package/dist/logger/export.d.ts.map +0 -1
- package/dist/logger/export.js.map +0 -1
- package/dist/matter/behaviors.d.ts +0 -2
- package/dist/matter/behaviors.d.ts.map +0 -1
- package/dist/matter/behaviors.js.map +0 -1
- package/dist/matter/clusters.d.ts +0 -2
- package/dist/matter/clusters.d.ts.map +0 -1
- package/dist/matter/clusters.js.map +0 -1
- package/dist/matter/devices.d.ts +0 -2
- package/dist/matter/devices.d.ts.map +0 -1
- package/dist/matter/devices.js.map +0 -1
- package/dist/matter/endpoints.d.ts +0 -2
- package/dist/matter/endpoints.d.ts.map +0 -1
- package/dist/matter/endpoints.js.map +0 -1
- package/dist/matter/export.d.ts +0 -5
- package/dist/matter/export.d.ts.map +0 -1
- package/dist/matter/export.js.map +0 -1
- package/dist/matter/types.d.ts +0 -3
- package/dist/matter/types.d.ts.map +0 -1
- package/dist/matter/types.js.map +0 -1
- package/dist/matterbridge.d.ts +0 -445
- package/dist/matterbridge.d.ts.map +0 -1
- package/dist/matterbridge.js.map +0 -1
- package/dist/matterbridgeAccessoryPlatform.d.ts +0 -40
- package/dist/matterbridgeAccessoryPlatform.d.ts.map +0 -1
- package/dist/matterbridgeAccessoryPlatform.js.map +0 -1
- package/dist/matterbridgeBehaviors.d.ts +0 -1333
- package/dist/matterbridgeBehaviors.d.ts.map +0 -1
- package/dist/matterbridgeBehaviors.js.map +0 -1
- package/dist/matterbridgeDeviceTypes.d.ts +0 -644
- package/dist/matterbridgeDeviceTypes.d.ts.map +0 -1
- package/dist/matterbridgeDeviceTypes.js.map +0 -1
- package/dist/matterbridgeDynamicPlatform.d.ts +0 -40
- package/dist/matterbridgeDynamicPlatform.d.ts.map +0 -1
- package/dist/matterbridgeDynamicPlatform.js.map +0 -1
- package/dist/matterbridgeEndpoint.d.ts +0 -1145
- package/dist/matterbridgeEndpoint.d.ts.map +0 -1
- package/dist/matterbridgeEndpoint.js.map +0 -1
- package/dist/matterbridgeEndpointHelpers.d.ts +0 -3083
- package/dist/matterbridgeEndpointHelpers.d.ts.map +0 -1
- package/dist/matterbridgeEndpointHelpers.js.map +0 -1
- package/dist/matterbridgePlatform.d.ts +0 -290
- package/dist/matterbridgePlatform.d.ts.map +0 -1
- package/dist/matterbridgePlatform.js.map +0 -1
- package/dist/matterbridgeTypes.d.ts +0 -196
- package/dist/matterbridgeTypes.d.ts.map +0 -1
- package/dist/matterbridgeTypes.js.map +0 -1
- package/dist/pluginManager.d.ts +0 -273
- package/dist/pluginManager.d.ts.map +0 -1
- package/dist/pluginManager.js.map +0 -1
- package/dist/roboticVacuumCleaner.d.ts +0 -102
- package/dist/roboticVacuumCleaner.d.ts.map +0 -1
- package/dist/roboticVacuumCleaner.js.map +0 -1
- package/dist/shelly.d.ts +0 -161
- package/dist/shelly.d.ts.map +0 -1
- package/dist/shelly.js.map +0 -1
- package/dist/storage/export.d.ts +0 -2
- package/dist/storage/export.d.ts.map +0 -1
- package/dist/storage/export.js.map +0 -1
- package/dist/update.d.ts +0 -58
- package/dist/update.d.ts.map +0 -1
- package/dist/update.js.map +0 -1
- package/dist/utils/colorUtils.d.ts +0 -61
- package/dist/utils/colorUtils.d.ts.map +0 -1
- package/dist/utils/colorUtils.js.map +0 -1
- package/dist/utils/commandLine.d.ts +0 -58
- package/dist/utils/commandLine.d.ts.map +0 -1
- package/dist/utils/commandLine.js.map +0 -1
- package/dist/utils/copyDirectory.d.ts +0 -32
- package/dist/utils/copyDirectory.d.ts.map +0 -1
- package/dist/utils/copyDirectory.js.map +0 -1
- package/dist/utils/createDirectory.d.ts +0 -32
- package/dist/utils/createDirectory.d.ts.map +0 -1
- package/dist/utils/createDirectory.js.map +0 -1
- package/dist/utils/createZip.d.ts +0 -38
- package/dist/utils/createZip.d.ts.map +0 -1
- package/dist/utils/createZip.js.map +0 -1
- package/dist/utils/deepCopy.d.ts +0 -31
- package/dist/utils/deepCopy.d.ts.map +0 -1
- package/dist/utils/deepCopy.js.map +0 -1
- package/dist/utils/deepEqual.d.ts +0 -53
- package/dist/utils/deepEqual.d.ts.map +0 -1
- package/dist/utils/deepEqual.js.map +0 -1
- package/dist/utils/export.d.ts +0 -12
- package/dist/utils/export.d.ts.map +0 -1
- package/dist/utils/export.js.map +0 -1
- package/dist/utils/hex.d.ts +0 -48
- package/dist/utils/hex.d.ts.map +0 -1
- package/dist/utils/hex.js.map +0 -1
- package/dist/utils/isvalid.d.ts +0 -102
- package/dist/utils/isvalid.d.ts.map +0 -1
- package/dist/utils/isvalid.js.map +0 -1
- package/dist/utils/network.d.ts +0 -69
- package/dist/utils/network.d.ts.map +0 -1
- package/dist/utils/network.js.map +0 -1
- package/dist/utils/spawn.d.ts +0 -12
- package/dist/utils/spawn.d.ts.map +0 -1
- package/dist/utils/spawn.js.map +0 -1
- package/dist/utils/wait.d.ts +0 -52
- package/dist/utils/wait.d.ts.map +0 -1
- package/dist/utils/wait.js.map +0 -1
- package/dist/waterHeater.d.ts +0 -90
- package/dist/waterHeater.d.ts.map +0 -1
- package/dist/waterHeater.js.map +0 -1
- package/tsconfig.jest.json +0 -8
- package/tsconfig.production.json +0 -13
|
@@ -1,1145 +0,0 @@
|
|
|
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
|
-
* @date 2024-10-01
|
|
7
|
-
* @version 2.1.1
|
|
8
|
-
*
|
|
9
|
-
* Copyright 2024, 2025, 2026 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 { AnsiLogger, LogLevel } from './logger/export.js';
|
|
24
|
-
import { DeviceTypeDefinition, MatterbridgeEndpointOptions } from './matterbridgeDeviceTypes.js';
|
|
25
|
-
import { ActionContext, AtLeastOne, Behavior, ClusterId, Endpoint, EndpointNumber, HandlerFunction, NamedHandler, ServerNode } from '@matter/main';
|
|
26
|
-
import { ClusterType, Semtag } from '@matter/main/types';
|
|
27
|
-
import { PowerSource } from '@matter/main/clusters/power-source';
|
|
28
|
-
import { Identify } from '@matter/main/clusters/identify';
|
|
29
|
-
import { OnOff } from '@matter/main/clusters/on-off';
|
|
30
|
-
import { ColorControl } from '@matter/main/clusters/color-control';
|
|
31
|
-
import { WindowCovering } from '@matter/main/clusters/window-covering';
|
|
32
|
-
import { FanControl } from '@matter/main/clusters/fan-control';
|
|
33
|
-
import { DoorLock } from '@matter/main/clusters/door-lock';
|
|
34
|
-
import { ModeSelect } from '@matter/main/clusters/mode-select';
|
|
35
|
-
import { ValveConfigurationAndControl } from '@matter/main/clusters/valve-configuration-and-control';
|
|
36
|
-
import { PumpConfigurationAndControl } from '@matter/main/clusters/pump-configuration-and-control';
|
|
37
|
-
import { SmokeCoAlarm } from '@matter/main/clusters/smoke-co-alarm';
|
|
38
|
-
import { AirQuality } from '@matter/main/clusters/air-quality';
|
|
39
|
-
import { ConcentrationMeasurement } from '@matter/main/clusters/concentration-measurement';
|
|
40
|
-
import { OperationalState } from '@matter/main/clusters/operational-state';
|
|
41
|
-
import { DeviceEnergyManagement } from '@matter/main/clusters/device-energy-management';
|
|
42
|
-
import { DeviceEnergyManagementMode } from '@matter/main/clusters/device-energy-management-mode';
|
|
43
|
-
import { ResourceMonitoring } from '@matter/main/clusters/resource-monitoring';
|
|
44
|
-
export type PrimitiveTypes = boolean | number | bigint | string | object | undefined | null;
|
|
45
|
-
export type CommandHandlerFunction = (data: {
|
|
46
|
-
request: Record<string, any>;
|
|
47
|
-
cluster: string;
|
|
48
|
-
attributes: Record<string, PrimitiveTypes>;
|
|
49
|
-
endpoint: MatterbridgeEndpoint;
|
|
50
|
-
}) => void | Promise<void>;
|
|
51
|
-
export interface MatterbridgeEndpointCommands {
|
|
52
|
-
identify: HandlerFunction;
|
|
53
|
-
triggerEffect: HandlerFunction;
|
|
54
|
-
on: HandlerFunction;
|
|
55
|
-
off: HandlerFunction;
|
|
56
|
-
toggle: HandlerFunction;
|
|
57
|
-
offWithEffect: HandlerFunction;
|
|
58
|
-
moveToLevel: HandlerFunction;
|
|
59
|
-
moveToLevelWithOnOff: HandlerFunction;
|
|
60
|
-
moveToColor: HandlerFunction;
|
|
61
|
-
moveColor: HandlerFunction;
|
|
62
|
-
stepColor: HandlerFunction;
|
|
63
|
-
moveToHue: HandlerFunction;
|
|
64
|
-
moveHue: HandlerFunction;
|
|
65
|
-
stepHue: HandlerFunction;
|
|
66
|
-
moveToSaturation: HandlerFunction;
|
|
67
|
-
moveSaturation: HandlerFunction;
|
|
68
|
-
stepSaturation: HandlerFunction;
|
|
69
|
-
moveToHueAndSaturation: HandlerFunction;
|
|
70
|
-
moveToColorTemperature: HandlerFunction;
|
|
71
|
-
upOrOpen: HandlerFunction;
|
|
72
|
-
downOrClose: HandlerFunction;
|
|
73
|
-
stopMotion: HandlerFunction;
|
|
74
|
-
goToLiftPercentage: HandlerFunction;
|
|
75
|
-
goToTiltPercentage: HandlerFunction;
|
|
76
|
-
lockDoor: HandlerFunction;
|
|
77
|
-
unlockDoor: HandlerFunction;
|
|
78
|
-
setpointRaiseLower: HandlerFunction;
|
|
79
|
-
step: HandlerFunction;
|
|
80
|
-
changeToMode: HandlerFunction;
|
|
81
|
-
open: HandlerFunction;
|
|
82
|
-
close: HandlerFunction;
|
|
83
|
-
suppressAlarm: HandlerFunction;
|
|
84
|
-
enableDisableAlarm: HandlerFunction;
|
|
85
|
-
selfTestRequest: HandlerFunction;
|
|
86
|
-
resetCounts: HandlerFunction;
|
|
87
|
-
setUtcTime: HandlerFunction;
|
|
88
|
-
setTimeZone: HandlerFunction;
|
|
89
|
-
setDstOffset: HandlerFunction;
|
|
90
|
-
pauseRequest: HandlerFunction;
|
|
91
|
-
resumeRequest: HandlerFunction;
|
|
92
|
-
pause: HandlerFunction;
|
|
93
|
-
stop: HandlerFunction;
|
|
94
|
-
start: HandlerFunction;
|
|
95
|
-
resume: HandlerFunction;
|
|
96
|
-
goHome: HandlerFunction;
|
|
97
|
-
selectAreas: HandlerFunction;
|
|
98
|
-
boost: HandlerFunction;
|
|
99
|
-
cancelBoost: HandlerFunction;
|
|
100
|
-
enableCharging: HandlerFunction;
|
|
101
|
-
disable: HandlerFunction;
|
|
102
|
-
setTemperature: HandlerFunction;
|
|
103
|
-
}
|
|
104
|
-
export interface SerializedMatterbridgeEndpoint {
|
|
105
|
-
pluginName: string;
|
|
106
|
-
deviceName: string;
|
|
107
|
-
serialNumber: string;
|
|
108
|
-
uniqueId: string;
|
|
109
|
-
productId?: number;
|
|
110
|
-
productName?: string;
|
|
111
|
-
vendorId?: number;
|
|
112
|
-
vendorName?: string;
|
|
113
|
-
deviceTypes: DeviceTypeDefinition[];
|
|
114
|
-
endpoint: EndpointNumber | undefined;
|
|
115
|
-
endpointName: string;
|
|
116
|
-
clusterServersId: ClusterId[];
|
|
117
|
-
}
|
|
118
|
-
export declare class MatterbridgeEndpoint extends Endpoint {
|
|
119
|
-
/** The bridge mode of Matterbridge */
|
|
120
|
-
static bridgeMode: 'bridge' | 'childbridge' | '';
|
|
121
|
-
/** The default log level of the new MatterbridgeEndpoints */
|
|
122
|
-
static logLevel: LogLevel;
|
|
123
|
-
/** The logger instance for the MatterbridgeEndpoint */
|
|
124
|
-
log: AnsiLogger;
|
|
125
|
-
/** The plugin name this MatterbridgeEndpoint belongs to */
|
|
126
|
-
plugin: string | undefined;
|
|
127
|
-
/** The configuration URL of the device, if available */
|
|
128
|
-
configUrl: string | undefined;
|
|
129
|
-
deviceName: string | undefined;
|
|
130
|
-
serialNumber: string | undefined;
|
|
131
|
-
uniqueId: string | undefined;
|
|
132
|
-
vendorId: number | undefined;
|
|
133
|
-
vendorName: string | undefined;
|
|
134
|
-
productId: number | undefined;
|
|
135
|
-
productName: string | undefined;
|
|
136
|
-
softwareVersion: number | undefined;
|
|
137
|
-
softwareVersionString: string | undefined;
|
|
138
|
-
hardwareVersion: number | undefined;
|
|
139
|
-
hardwareVersionString: string | undefined;
|
|
140
|
-
productUrl: string;
|
|
141
|
-
/** The server node of the endpoint, if it is a single not bridged endpoint */
|
|
142
|
-
serverNode: ServerNode<ServerNode.RootEndpoint> | undefined;
|
|
143
|
-
/** The name of the first device type of the endpoint (old api compatibility) */
|
|
144
|
-
name: string | undefined;
|
|
145
|
-
/** The code of the first device type of the endpoint (old api compatibility) */
|
|
146
|
-
deviceType: number;
|
|
147
|
-
/** The id of the endpoint (old api compatibility) */
|
|
148
|
-
uniqueStorageKey: string | undefined;
|
|
149
|
-
tagList?: Semtag[];
|
|
150
|
-
/** Maps the DeviceTypeDefinitions with their code */
|
|
151
|
-
readonly deviceTypes: Map<number, DeviceTypeDefinition>;
|
|
152
|
-
/** Command handler for the MatterbridgeEndpoint commands */
|
|
153
|
-
readonly commandHandler: NamedHandler<MatterbridgeEndpointCommands>;
|
|
154
|
-
/**
|
|
155
|
-
* Represents a MatterbridgeEndpoint.
|
|
156
|
-
* @constructor
|
|
157
|
-
* @param {DeviceTypeDefinition | AtLeastOne<DeviceTypeDefinition>} definition - The DeviceTypeDefinition(s) of the endpoint.
|
|
158
|
-
* @param {MatterbridgeEndpointOptions} [options={}] - The options for the device.
|
|
159
|
-
* @param {boolean} [debug=false] - Debug flag.
|
|
160
|
-
*/
|
|
161
|
-
constructor(definition: DeviceTypeDefinition | AtLeastOne<DeviceTypeDefinition>, options?: MatterbridgeEndpointOptions, debug?: boolean);
|
|
162
|
-
/**
|
|
163
|
-
* Loads an instance of the MatterbridgeEndpoint class.
|
|
164
|
-
*
|
|
165
|
-
* @param {DeviceTypeDefinition | AtLeastOne<DeviceTypeDefinition>} definition - The DeviceTypeDefinition(s) of the device.
|
|
166
|
-
* @param {MatterbridgeEndpointOptions} [options={}] - The options for the device.
|
|
167
|
-
* @param {boolean} [debug=false] - Debug flag.
|
|
168
|
-
* @returns {Promise<MatterbridgeEndpoint>} MatterbridgeEndpoint instance.
|
|
169
|
-
*/
|
|
170
|
-
static loadInstance(definition: DeviceTypeDefinition | AtLeastOne<DeviceTypeDefinition>, options?: MatterbridgeEndpointOptions, debug?: boolean): Promise<MatterbridgeEndpoint>;
|
|
171
|
-
/**
|
|
172
|
-
* Get all the device types of this endpoint.
|
|
173
|
-
*
|
|
174
|
-
* @returns {DeviceTypeDefinition[]} The device types of this endpoint.
|
|
175
|
-
*/
|
|
176
|
-
getDeviceTypes(): DeviceTypeDefinition[];
|
|
177
|
-
/**
|
|
178
|
-
* Checks if the provided cluster server is supported by this endpoint.
|
|
179
|
-
*
|
|
180
|
-
* @param {Behavior.Type | ClusterType | ClusterId | string} cluster - The cluster to check.
|
|
181
|
-
* @returns {boolean} True if the cluster server is supported, false otherwise.
|
|
182
|
-
*/
|
|
183
|
-
hasClusterServer(cluster: Behavior.Type | ClusterType | ClusterId | string): boolean;
|
|
184
|
-
/**
|
|
185
|
-
* Checks if the provided attribute server is supported for a given cluster of this endpoint.
|
|
186
|
-
*
|
|
187
|
-
* @param {Behavior.Type | ClusterType | ClusterId | string} cluster - The cluster to check.
|
|
188
|
-
* @param {string} attribute - The attribute name to check.
|
|
189
|
-
* @returns {boolean} True if the attribute server is supported, false otherwise.
|
|
190
|
-
*/
|
|
191
|
-
hasAttributeServer(cluster: Behavior.Type | ClusterType | ClusterId | string, attribute: string): boolean;
|
|
192
|
-
/**
|
|
193
|
-
* Retrieves the initial options for the provided cluster server.
|
|
194
|
-
*
|
|
195
|
-
* @param {Behavior.Type | ClusterType | ClusterId | string} cluster - The cluster to get options for.
|
|
196
|
-
* @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.
|
|
197
|
-
*/
|
|
198
|
-
getClusterServerOptions(cluster: Behavior.Type | ClusterType | ClusterId | string): Record<string, string | number | bigint | boolean | object | null> | undefined;
|
|
199
|
-
/**
|
|
200
|
-
* Retrieves the value of the provided attribute from the given cluster.
|
|
201
|
-
*
|
|
202
|
-
* @param {Behavior.Type | ClusterType | ClusterId | string} cluster - The cluster to retrieve the attribute from.
|
|
203
|
-
* @param {string} attribute - The name of the attribute to retrieve.
|
|
204
|
-
* @param {AnsiLogger} [log] - Optional logger for error and info messages.
|
|
205
|
-
* @returns {any} The value of the attribute, or undefined if the attribute is not found.
|
|
206
|
-
*/
|
|
207
|
-
getAttribute(cluster: Behavior.Type | ClusterType | ClusterId | string, attribute: string, log?: AnsiLogger): any;
|
|
208
|
-
/**
|
|
209
|
-
* Sets the value of an attribute on a cluster server.
|
|
210
|
-
*
|
|
211
|
-
* @param {Behavior.Type | ClusterType | ClusterId | string} clusterId - The ID of the cluster.
|
|
212
|
-
* @param {string} attribute - The name of the attribute.
|
|
213
|
-
* @param {boolean | number | bigint | string | object | null} value - The value to set for the attribute.
|
|
214
|
-
* @param {AnsiLogger} [log] - (Optional) The logger to use for logging errors and information.
|
|
215
|
-
* @returns {Promise<boolean>} - A promise that resolves to a boolean indicating whether the attribute was successfully set.
|
|
216
|
-
*/
|
|
217
|
-
setAttribute(clusterId: Behavior.Type | ClusterType | ClusterId | string, attribute: string, value: boolean | number | bigint | string | object | null, log?: AnsiLogger): Promise<boolean>;
|
|
218
|
-
/**
|
|
219
|
-
* Update the value of an attribute on a cluster server only if the value is different.
|
|
220
|
-
*
|
|
221
|
-
* @param {Behavior.Type | ClusterType | ClusterId | string} cluster - The cluster to set the attribute on.
|
|
222
|
-
* @param {string} attribute - The name of the attribute.
|
|
223
|
-
* @param {boolean | number | bigint | string | object | null} value - The value to set for the attribute.
|
|
224
|
-
* @param {AnsiLogger} [log] - (Optional) The logger to use for logging the update. Errors are logged to the endpoint logger.
|
|
225
|
-
* @returns {Promise<boolean>} - A promise that resolves to a boolean indicating whether the attribute was successfully set.
|
|
226
|
-
*/
|
|
227
|
-
updateAttribute(cluster: Behavior.Type | ClusterType | ClusterId | string, attribute: string, value: boolean | number | bigint | string | object | null, log?: AnsiLogger): Promise<boolean>;
|
|
228
|
-
/**
|
|
229
|
-
* Subscribes to the provided attribute on a cluster.
|
|
230
|
-
*
|
|
231
|
-
* @param {Behavior.Type | ClusterType | ClusterId | string} cluster - The cluster to subscribe the attribute to.
|
|
232
|
-
* @param {string} attribute - The name of the attribute to subscribe to.
|
|
233
|
-
* @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.
|
|
234
|
-
* @param {AnsiLogger} [log] - Optional logger for logging errors and information.
|
|
235
|
-
* @returns {Promise<boolean>} - A boolean indicating whether the subscription was successful.
|
|
236
|
-
*
|
|
237
|
-
* @remarks The listener function (cannot be async) will receive three parameters:
|
|
238
|
-
* - `newValue`: The new value of the attribute.
|
|
239
|
-
* - `oldValue`: The old value of the attribute.
|
|
240
|
-
* - `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.
|
|
241
|
-
*/
|
|
242
|
-
subscribeAttribute(cluster: Behavior.Type | ClusterType | ClusterId | string, attribute: string, listener: (newValue: any, oldValue: any, context: ActionContext) => void, log?: AnsiLogger): Promise<boolean>;
|
|
243
|
-
/**
|
|
244
|
-
* Triggers an event on the specified cluster.
|
|
245
|
-
* @param {ClusterId} cluster - The ID of the cluster.
|
|
246
|
-
* @param {string} event - The name of the event to trigger.
|
|
247
|
-
* @param {Record<string, boolean | number | bigint | string | object | undefined | null>} payload - The payload to pass to the event.
|
|
248
|
-
* @param {AnsiLogger} [log] - Optional logger for logging information.
|
|
249
|
-
* @returns {Promise<boolean>} - A promise that resolves to a boolean indicating whether the event was successfully triggered.
|
|
250
|
-
*/
|
|
251
|
-
triggerEvent(cluster: Behavior.Type | ClusterType | ClusterId | string, event: string, payload: Record<string, boolean | number | bigint | string | object | undefined | null>, log?: AnsiLogger): Promise<boolean>;
|
|
252
|
-
/**
|
|
253
|
-
* Adds cluster servers from the provided server list.
|
|
254
|
-
*
|
|
255
|
-
* @param {ClusterId[]} serverList - The list of cluster IDs to add.
|
|
256
|
-
* @returns {this} The current MatterbridgeEndpoint instance for chaining.
|
|
257
|
-
*/
|
|
258
|
-
addClusterServers(serverList: ClusterId[]): this;
|
|
259
|
-
/**
|
|
260
|
-
* Adds a fixed label to the FixedLabel cluster. If the cluster server is not present, it will be added.
|
|
261
|
-
*
|
|
262
|
-
* @param {string} label - The label to add.
|
|
263
|
-
* @param {string} value - The value of the label.
|
|
264
|
-
* @returns {Promise<this>} The current MatterbridgeEndpoint instance for chaining.
|
|
265
|
-
*/
|
|
266
|
-
addFixedLabel(label: string, value: string): Promise<this>;
|
|
267
|
-
/**
|
|
268
|
-
* Adds a user label to the UserLabel cluster. If the cluster server is not present, it will be added.
|
|
269
|
-
*
|
|
270
|
-
* @param {string} label - The label to add.
|
|
271
|
-
* @param {string} value - The value of the label.
|
|
272
|
-
* @returns {Promise<this>} The current MatterbridgeEndpoint instance for chaining.
|
|
273
|
-
*/
|
|
274
|
-
addUserLabel(label: string, value: string): Promise<this>;
|
|
275
|
-
/**
|
|
276
|
-
* Adds a command handler for the specified command.
|
|
277
|
-
*
|
|
278
|
-
* @param {keyof MatterbridgeEndpointCommands} command - The command to add the handler for.
|
|
279
|
-
* @param {CommandHandlerFunction} handler - The handler function to execute when the command is received.
|
|
280
|
-
* @returns {this} The current MatterbridgeEndpoint instance for chaining.
|
|
281
|
-
*
|
|
282
|
-
* @remarks
|
|
283
|
-
* The handler function will receive an object with the following properties:
|
|
284
|
-
* - `request`: The request object sent with the command.
|
|
285
|
-
* - `cluster`: The id of the cluster that received the command (i.e. "onOff").
|
|
286
|
-
* - `attributes`: The current attributes of the cluster that received the command (i.e. { onOff: true}).
|
|
287
|
-
* - `endpoint`: The MatterbridgeEndpoint instance that received the command.
|
|
288
|
-
*/
|
|
289
|
-
addCommandHandler(command: keyof MatterbridgeEndpointCommands, handler: CommandHandlerFunction): this;
|
|
290
|
-
/**
|
|
291
|
-
* Execute the command handler for the specified command. Used ONLY in Jest tests.
|
|
292
|
-
*
|
|
293
|
-
* @param {keyof MatterbridgeEndpointCommands} command - The command to execute.
|
|
294
|
-
* @param {Record<string, boolean | number | bigint | string | object | null>} [request] - The optional request to pass to the handler function.
|
|
295
|
-
*
|
|
296
|
-
* @deprecated Used ONLY in Jest tests.
|
|
297
|
-
*/
|
|
298
|
-
executeCommandHandler(command: keyof MatterbridgeEndpointCommands, request?: Record<string, boolean | number | bigint | string | object | null>): Promise<void>;
|
|
299
|
-
/**
|
|
300
|
-
* Invokes a behavior command on the specified cluster. Used ONLY in Jest tests.
|
|
301
|
-
*
|
|
302
|
-
* @param {Behavior.Type | ClusterType | ClusterId | string} cluster - The cluster to invoke the command on.
|
|
303
|
-
* @param {string} command - The command to invoke.
|
|
304
|
-
* @param {Record<string, boolean | number | bigint | string | object | null>} [params] - The optional parameters to pass to the command.
|
|
305
|
-
*
|
|
306
|
-
* @deprecated Used ONLY in Jest tests.
|
|
307
|
-
*/
|
|
308
|
-
invokeBehaviorCommand(cluster: Behavior.Type | ClusterType | ClusterId | string, command: keyof MatterbridgeEndpointCommands, params?: Record<string, boolean | number | bigint | string | object | null>): Promise<void>;
|
|
309
|
-
/**
|
|
310
|
-
* Adds the required cluster servers (only if they are not present) for the device types of the specified endpoint.
|
|
311
|
-
*
|
|
312
|
-
* @returns {this} The current MatterbridgeEndpoint instance for chaining.
|
|
313
|
-
*/
|
|
314
|
-
addRequiredClusterServers(): MatterbridgeEndpoint;
|
|
315
|
-
/**
|
|
316
|
-
* Adds the optional cluster servers (only if they are not present) for the device types of the specified endpoint.
|
|
317
|
-
*
|
|
318
|
-
* @returns {this} The current MatterbridgeEndpoint instance for chaining.
|
|
319
|
-
*/
|
|
320
|
-
addOptionalClusterServers(): MatterbridgeEndpoint;
|
|
321
|
-
/**
|
|
322
|
-
* Retrieves all cluster servers.
|
|
323
|
-
*
|
|
324
|
-
* @returns {Behavior.Type[]} An array of all cluster servers.
|
|
325
|
-
*/
|
|
326
|
-
getAllClusterServers(): Behavior.Type[];
|
|
327
|
-
/**
|
|
328
|
-
* Retrieves the names of all cluster servers.
|
|
329
|
-
*
|
|
330
|
-
* @returns {string[]} An array of all cluster server names.
|
|
331
|
-
*/
|
|
332
|
-
getAllClusterServerNames(): string[];
|
|
333
|
-
/**
|
|
334
|
-
* Iterates over each attribute of each cluster server of the device state and calls the provided callback function.
|
|
335
|
-
*
|
|
336
|
-
* @param {Function} callback - The callback function to call with the cluster name, cluster id, attribute name, attribute id and attribute value.
|
|
337
|
-
*/
|
|
338
|
-
forEachAttribute(callback: (clusterName: string, clusterId: number, attributeName: string, attributeId: number, attributeValue: boolean | number | bigint | string | object | null | undefined) => void): void;
|
|
339
|
-
/**
|
|
340
|
-
* Adds a child endpoint with the specified device types and options.
|
|
341
|
-
* If the child endpoint is not already present, it will be created and added.
|
|
342
|
-
* If the child endpoint is already present, the existing child endpoint will be returned.
|
|
343
|
-
*
|
|
344
|
-
* @param {string} endpointName - The name of the new endpoint to add.
|
|
345
|
-
* @param {DeviceTypeDefinition | AtLeastOne<DeviceTypeDefinition>} definition - The device types to add.
|
|
346
|
-
* @param {MatterbridgeEndpointOptions} [options={}] - The options for the endpoint.
|
|
347
|
-
* @param {boolean} [debug=false] - Whether to enable debug logging.
|
|
348
|
-
* @returns {MatterbridgeEndpoint} - The child endpoint that was found or added.
|
|
349
|
-
*
|
|
350
|
-
* @example
|
|
351
|
-
* ```typescript
|
|
352
|
-
* const endpoint = device.addChildDeviceType('Temperature', [temperatureSensor], { tagList: [{ mfgCode: null, namespaceId: LocationTag.Indoor.namespaceId, tag: LocationTag.Indoor.tag, label: null }] }, true);
|
|
353
|
-
* ```
|
|
354
|
-
*/
|
|
355
|
-
addChildDeviceType(endpointName: string, definition: DeviceTypeDefinition | AtLeastOne<DeviceTypeDefinition>, options?: MatterbridgeEndpointOptions, debug?: boolean): MatterbridgeEndpoint;
|
|
356
|
-
/**
|
|
357
|
-
* Adds a child endpoint with one or more device types with the required cluster servers and the specified cluster servers.
|
|
358
|
-
* If the child endpoint is not already present in the childEndpoints, it will be added.
|
|
359
|
-
* If the child endpoint is already present in the childEndpoints, the device types and cluster servers will be added to the existing child endpoint.
|
|
360
|
-
*
|
|
361
|
-
* @param {string} endpointName - The name of the new enpoint to add.
|
|
362
|
-
* @param {DeviceTypeDefinition | AtLeastOne<DeviceTypeDefinition>} definition - The device types to add.
|
|
363
|
-
* @param {ClusterId[]} [serverList=[]] - The list of cluster IDs to include.
|
|
364
|
-
* @param {MatterbridgeEndpointOptions} [options={}] - The options for the device.
|
|
365
|
-
* @param {boolean} [debug=false] - Whether to enable debug logging.
|
|
366
|
-
* @returns {MatterbridgeEndpoint} - The child endpoint that was found or added.
|
|
367
|
-
*
|
|
368
|
-
* @example
|
|
369
|
-
* ```typescript
|
|
370
|
-
* const endpoint = device.addChildDeviceTypeWithClusterServer('Temperature', [temperatureSensor], [], { tagList: [{ mfgCode: null, namespaceId: LocationTag.Indoor.namespaceId, tag: LocationTag.Indoor.tag, label: null }] }, true);
|
|
371
|
-
* ```
|
|
372
|
-
*/
|
|
373
|
-
addChildDeviceTypeWithClusterServer(endpointName: string, definition: DeviceTypeDefinition | AtLeastOne<DeviceTypeDefinition>, serverList?: ClusterId[], options?: MatterbridgeEndpointOptions, debug?: boolean): MatterbridgeEndpoint;
|
|
374
|
-
/**
|
|
375
|
-
* Retrieves a child endpoint by its name.
|
|
376
|
-
*
|
|
377
|
-
* @param {string} endpointName - The name of the endpoint to retrieve.
|
|
378
|
-
* @returns {Endpoint | undefined} The child endpoint with the specified name, or undefined if not found.
|
|
379
|
-
*/
|
|
380
|
-
getChildEndpointByName(endpointName: string): MatterbridgeEndpoint | undefined;
|
|
381
|
-
/**
|
|
382
|
-
* Retrieves a child endpoint by its EndpointNumber.
|
|
383
|
-
*
|
|
384
|
-
* @param {EndpointNumber} endpointNumber - The EndpointNumber of the endpoint to retrieve.
|
|
385
|
-
* @returns {MatterbridgeEndpoint | undefined} The child endpoint with the specified EndpointNumber, or undefined if not found.
|
|
386
|
-
*/
|
|
387
|
-
getChildEndpoint(endpointNumber: EndpointNumber): MatterbridgeEndpoint | undefined;
|
|
388
|
-
/**
|
|
389
|
-
* Get all the child endpoints of this endpoint.
|
|
390
|
-
*
|
|
391
|
-
* @returns {MatterbridgeEndpoint[]} The child endpoints.
|
|
392
|
-
*/
|
|
393
|
-
getChildEndpoints(): MatterbridgeEndpoint[];
|
|
394
|
-
/**
|
|
395
|
-
* Serializes the Matterbridge device into a serialized object.
|
|
396
|
-
*
|
|
397
|
-
* @param pluginName - The name of the plugin.
|
|
398
|
-
* @returns The serialized Matterbridge device object.
|
|
399
|
-
*/
|
|
400
|
-
static serialize(device: MatterbridgeEndpoint): SerializedMatterbridgeEndpoint | undefined;
|
|
401
|
-
/**
|
|
402
|
-
* Deserializes the device into a serialized object.
|
|
403
|
-
*
|
|
404
|
-
* @returns The deserialized MatterbridgeDevice.
|
|
405
|
-
*/
|
|
406
|
-
static deserialize(serializedDevice: SerializedMatterbridgeEndpoint): MatterbridgeEndpoint | undefined;
|
|
407
|
-
/**
|
|
408
|
-
* Creates a default power source wired cluster server.
|
|
409
|
-
*
|
|
410
|
-
* @param wiredCurrentType - The type of wired current (default: PowerSource.WiredCurrentType.Ac)
|
|
411
|
-
* @returns {this} The current MatterbridgeEndpoint instance for chaining.
|
|
412
|
-
*/
|
|
413
|
-
createDefaultPowerSourceWiredClusterServer(wiredCurrentType?: PowerSource.WiredCurrentType): this;
|
|
414
|
-
/**
|
|
415
|
-
* Creates a default power source replaceable battery cluster server.
|
|
416
|
-
*
|
|
417
|
-
* @param batPercentRemaining - The remaining battery percentage (default: 100).
|
|
418
|
-
* @param batChargeLevel - The battery charge level (default: PowerSource.BatChargeLevel.Ok).
|
|
419
|
-
* @param batVoltage - The battery voltage (default: 1500).
|
|
420
|
-
* @param batReplacementDescription - The battery replacement description (default: 'Battery type').
|
|
421
|
-
* @param batQuantity - The battery quantity (default: 1).
|
|
422
|
-
* @returns {this} The current MatterbridgeEndpoint instance for chaining.
|
|
423
|
-
*/
|
|
424
|
-
createDefaultPowerSourceReplaceableBatteryClusterServer(batPercentRemaining?: number, batChargeLevel?: PowerSource.BatChargeLevel, batVoltage?: number, batReplacementDescription?: string, batQuantity?: number): this;
|
|
425
|
-
/**
|
|
426
|
-
* Creates a default power source rechargeable battery cluster server.
|
|
427
|
-
*
|
|
428
|
-
* @param batPercentRemaining - The remaining battery percentage (default: 100).
|
|
429
|
-
* @param batChargeLevel - The battery charge level (default: PowerSource.BatChargeLevel.Ok).
|
|
430
|
-
* @param batVoltage - The battery voltage (default: 1500).
|
|
431
|
-
* @returns {this} The current MatterbridgeEndpoint instance for chaining.
|
|
432
|
-
*/
|
|
433
|
-
createDefaultPowerSourceRechargeableBatteryClusterServer(batPercentRemaining?: number, batChargeLevel?: PowerSource.BatChargeLevel, batVoltage?: number): this;
|
|
434
|
-
/**
|
|
435
|
-
* Setup the default Basic Information Cluster Server attributes for the server node.
|
|
436
|
-
*
|
|
437
|
-
* @param deviceName - The name of the device.
|
|
438
|
-
* @param serialNumber - The serial number of the device.
|
|
439
|
-
* @param vendorId - The vendor ID of the device.
|
|
440
|
-
* @param vendorName - The vendor name of the device.
|
|
441
|
-
* @param productId - The product ID of the device.
|
|
442
|
-
* @param productName - The product name of the device.
|
|
443
|
-
* @param softwareVersion - The software version of the device. Default is 1.
|
|
444
|
-
* @param softwareVersionString - The software version string of the device. Default is 'v.1.0.0'.
|
|
445
|
-
* @param hardwareVersion - The hardware version of the device. Default is 1.
|
|
446
|
-
* @param hardwareVersionString - The hardware version string of the device. Default is 'v.1.0.0'.
|
|
447
|
-
* @returns {this} The current MatterbridgeEndpoint instance for chaining.
|
|
448
|
-
*/
|
|
449
|
-
createDefaultBasicInformationClusterServer(deviceName: string, serialNumber: string, vendorId: number, vendorName: string, productId: number, productName: string, softwareVersion?: number, softwareVersionString?: string, hardwareVersion?: number, hardwareVersionString?: string): this;
|
|
450
|
-
/**
|
|
451
|
-
* Creates a default BridgedDeviceBasicInformationClusterServer for the aggregator endpoints.
|
|
452
|
-
*
|
|
453
|
-
* @param deviceName - The name of the device.
|
|
454
|
-
* @param serialNumber - The serial number of the device.
|
|
455
|
-
* @param vendorId - The vendor ID of the device.
|
|
456
|
-
* @param vendorName - The name of the vendor.
|
|
457
|
-
* @param productName - The name of the product.
|
|
458
|
-
* @param softwareVersion - The software version of the device. Default is 1.
|
|
459
|
-
* @param softwareVersionString - The software version string of the device. Default is 'v.1.0.0'.
|
|
460
|
-
* @param hardwareVersion - The hardware version of the device. Default is 1.
|
|
461
|
-
* @param hardwareVersionString - The hardware version string of the device. Default is 'v.1.0.0'.
|
|
462
|
-
* @returns {this} The current MatterbridgeEndpoint instance for chaining.
|
|
463
|
-
*
|
|
464
|
-
* @remarks The bridgedNode device type must be added to the deviceTypeList of the Descriptor cluster.
|
|
465
|
-
*/
|
|
466
|
-
createDefaultBridgedDeviceBasicInformationClusterServer(deviceName: string, serialNumber: string, vendorId: number, vendorName: string, productName: string, softwareVersion?: number, softwareVersionString?: string, hardwareVersion?: number, hardwareVersionString?: string): this;
|
|
467
|
-
/**
|
|
468
|
-
* Creates a default identify cluster server with the specified identify time and type.
|
|
469
|
-
*
|
|
470
|
-
* @param {number} [identifyTime=0] - The time to identify the server. Defaults to 0.
|
|
471
|
-
* @param {Identify.IdentifyType} [identifyType=Identify.IdentifyType.None] - The type of identification. Defaults to Identify.IdentifyType.None.
|
|
472
|
-
* @returns {this} The current MatterbridgeEndpoint instance for chaining.
|
|
473
|
-
*/
|
|
474
|
-
createDefaultIdentifyClusterServer(identifyTime?: number, identifyType?: Identify.IdentifyType): this;
|
|
475
|
-
/**
|
|
476
|
-
* Creates a default groups cluster server.
|
|
477
|
-
* @returns {this} The current MatterbridgeEndpoint instance for chaining.
|
|
478
|
-
*/
|
|
479
|
-
createDefaultGroupsClusterServer(): this;
|
|
480
|
-
/**
|
|
481
|
-
* Creates a default scenes management cluster server.
|
|
482
|
-
* @returns {this} The current MatterbridgeEndpoint instance for chaining.
|
|
483
|
-
*
|
|
484
|
-
* @remarks The scenes management cluster server is still provisional and so not yet implemented.
|
|
485
|
-
*/
|
|
486
|
-
createDefaultScenesClusterServer(): this;
|
|
487
|
-
/**
|
|
488
|
-
* Creates a default OnOff cluster server for light devices with feature Lighting.
|
|
489
|
-
*
|
|
490
|
-
* @param {boolean} [onOff=false] - The initial state of the OnOff cluster.
|
|
491
|
-
* @param {boolean} [globalSceneControl=false] - The global scene control state.
|
|
492
|
-
* @param {number} [onTime=0] - The on time value.
|
|
493
|
-
* @param {number} [offWaitTime=0] - The off wait time value.
|
|
494
|
-
* @param {OnOff.StartUpOnOff | null} [startUpOnOff=null] - The start-up OnOff state. Null means previous state.
|
|
495
|
-
* @returns {this} The current MatterbridgeEndpoint instance for chaining.
|
|
496
|
-
*/
|
|
497
|
-
createDefaultOnOffClusterServer(onOff?: boolean, globalSceneControl?: boolean, onTime?: number, offWaitTime?: number, startUpOnOff?: OnOff.StartUpOnOff | null): this;
|
|
498
|
-
/**
|
|
499
|
-
* Creates an OnOff cluster server without features.
|
|
500
|
-
*
|
|
501
|
-
* @param {boolean} [onOff=false] - The initial state of the OnOff cluster.
|
|
502
|
-
* @returns {this} The current MatterbridgeEndpoint instance for chaining.
|
|
503
|
-
*/
|
|
504
|
-
createOnOffClusterServer(onOff?: boolean): this;
|
|
505
|
-
/**
|
|
506
|
-
* Creates a DeadFront OnOff cluster server with feature DeadFrontBehavior.
|
|
507
|
-
*
|
|
508
|
-
* @param {boolean} [onOff=false] - The initial state of the OnOff cluster.
|
|
509
|
-
* @returns {this} The current MatterbridgeEndpoint instance for chaining.
|
|
510
|
-
*/
|
|
511
|
-
createDeadFrontOnOffClusterServer(onOff?: boolean): this;
|
|
512
|
-
/**
|
|
513
|
-
* Creates an OffOnly OnOff cluster server with feature OffOnly.
|
|
514
|
-
*
|
|
515
|
-
* @param {boolean} [onOff=false] - The initial state of the OnOff cluster.
|
|
516
|
-
* @returns {this} The current MatterbridgeEndpoint instance for chaining.
|
|
517
|
-
*/
|
|
518
|
-
createOffOnlyOnOffClusterServer(onOff?: boolean): this;
|
|
519
|
-
/**
|
|
520
|
-
* Creates a default level control cluster server for light devices with feature OnOff and Lighting.
|
|
521
|
-
*
|
|
522
|
-
* @param {number} [currentLevel=254] - The current level (default: 254).
|
|
523
|
-
* @param {number} [minLevel=1] - The minimum level (default: 1).
|
|
524
|
-
* @param {number} [maxLevel=254] - The maximum level (default: 254).
|
|
525
|
-
* @param {number | null} [onLevel=null] - The on level (default: null).
|
|
526
|
-
* @param {number | null} [startUpCurrentLevel=null] - The startUp on level (default: null).
|
|
527
|
-
* @returns {this} The current MatterbridgeEndpoint instance for chaining.
|
|
528
|
-
*/
|
|
529
|
-
createDefaultLevelControlClusterServer(currentLevel?: number, minLevel?: number, maxLevel?: number, onLevel?: number | null, startUpCurrentLevel?: number | null): this;
|
|
530
|
-
/**
|
|
531
|
-
* Creates a level control cluster server without features.
|
|
532
|
-
*
|
|
533
|
-
* @param {number} [currentLevel=254] - The current level (default: 254).
|
|
534
|
-
* @param {number | null} [onLevel=null] - The on level (default: null).
|
|
535
|
-
* @returns {this} The current MatterbridgeEndpoint instance for chaining.
|
|
536
|
-
*/
|
|
537
|
-
createLevelControlClusterServer(currentLevel?: number, onLevel?: number | null): this;
|
|
538
|
-
/**
|
|
539
|
-
* Creates a default color control cluster server with features Xy, HueSaturation and ColorTemperature.
|
|
540
|
-
*
|
|
541
|
-
* @param currentX - The current X value (range 0-65279).
|
|
542
|
-
* @param currentY - The current Y value (range 0-65279).
|
|
543
|
-
* @param currentHue - The current hue value (range: 0-254).
|
|
544
|
-
* @param currentSaturation - The current saturation value (range: 0-254).
|
|
545
|
-
* @param colorTemperatureMireds - The color temperature in mireds (default range 147-500).
|
|
546
|
-
* @param colorTempPhysicalMinMireds - The physical minimum color temperature in mireds (default range 147).
|
|
547
|
-
* @param colorTempPhysicalMaxMireds - The physical maximum color temperature in mireds (default range 500).
|
|
548
|
-
* @returns {this} The current MatterbridgeEndpoint instance for chaining.
|
|
549
|
-
*
|
|
550
|
-
* @remarks colorMode and enhancedColorMode persist across restarts.
|
|
551
|
-
* @remarks currentHue and currentSaturation persist across restarts.
|
|
552
|
-
* @remarks currentX and currentY persist across restarts.
|
|
553
|
-
* @remarks colorTemperatureMireds persists across restarts.
|
|
554
|
-
* @remarks startUpColorTemperatureMireds persists across restarts.
|
|
555
|
-
* @remarks coupleColorTempToLevelMinMireds persists across restarts.
|
|
556
|
-
*/
|
|
557
|
-
createDefaultColorControlClusterServer(currentX?: number, currentY?: number, currentHue?: number, currentSaturation?: number, colorTemperatureMireds?: number, colorTempPhysicalMinMireds?: number, colorTempPhysicalMaxMireds?: number): this;
|
|
558
|
-
/**
|
|
559
|
-
* Creates a Xy color control cluster server with feature Xy and ColorTemperature.
|
|
560
|
-
*
|
|
561
|
-
* @param currentX - The current X value.
|
|
562
|
-
* @param currentY - The current Y value.
|
|
563
|
-
* @param colorTemperatureMireds - The color temperature in mireds.
|
|
564
|
-
* @param colorTempPhysicalMinMireds - The physical minimum color temperature in mireds.
|
|
565
|
-
* @param colorTempPhysicalMaxMireds - The physical maximum color temperature in mireds.
|
|
566
|
-
* @returns {this} The current MatterbridgeEndpoint instance for chaining.
|
|
567
|
-
*
|
|
568
|
-
* @remarks
|
|
569
|
-
* From zigbee to matter = Math.max(Math.min(Math.round(x * 65536), 65279), 0)
|
|
570
|
-
*
|
|
571
|
-
* @remarks colorMode and enhancedColorMode persist across restarts.
|
|
572
|
-
* @remarks currentX and currentY persist across restarts.
|
|
573
|
-
* @remarks colorTemperatureMireds persists across restarts.
|
|
574
|
-
* @remarks startUpColorTemperatureMireds persists across restarts.
|
|
575
|
-
* @remarks coupleColorTempToLevelMinMireds persists across restarts.
|
|
576
|
-
*/
|
|
577
|
-
createXyColorControlClusterServer(currentX?: number, currentY?: number, colorTemperatureMireds?: number, colorTempPhysicalMinMireds?: number, colorTempPhysicalMaxMireds?: number): this;
|
|
578
|
-
/**
|
|
579
|
-
* Creates a default hue and saturation control cluster server with feature HueSaturation and ColorTemperature.
|
|
580
|
-
*
|
|
581
|
-
* @param currentHue - The current hue value.
|
|
582
|
-
* @param currentSaturation - The current saturation value.
|
|
583
|
-
* @param colorTemperatureMireds - The color temperature in mireds.
|
|
584
|
-
* @param colorTempPhysicalMinMireds - The physical minimum color temperature in mireds.
|
|
585
|
-
* @param colorTempPhysicalMaxMireds - The physical maximum color temperature in mireds.
|
|
586
|
-
* @returns {this} The current MatterbridgeEndpoint instance for chaining.
|
|
587
|
-
*
|
|
588
|
-
* @remarks colorMode and enhancedColorMode persist across restarts.
|
|
589
|
-
* @remarks currentHue and currentSaturation persist across restarts.
|
|
590
|
-
* @remarks colorTemperatureMireds persists across restarts.
|
|
591
|
-
* @remarks startUpColorTemperatureMireds persists across restarts.
|
|
592
|
-
* @remarks coupleColorTempToLevelMinMireds persists across restarts.
|
|
593
|
-
*/
|
|
594
|
-
createHsColorControlClusterServer(currentHue?: number, currentSaturation?: number, colorTemperatureMireds?: number, colorTempPhysicalMinMireds?: number, colorTempPhysicalMaxMireds?: number): this;
|
|
595
|
-
/**
|
|
596
|
-
* Creates a color temperature color control cluster server with feature ColorTemperature.
|
|
597
|
-
* This cluster server is used for devices that only support color temperature control.
|
|
598
|
-
*
|
|
599
|
-
* @param colorTemperatureMireds - The color temperature in mireds. Defaults to 250.
|
|
600
|
-
* @param colorTempPhysicalMinMireds - The physical minimum color temperature in mireds. Defaults to 147.
|
|
601
|
-
* @param colorTempPhysicalMaxMireds - The physical maximum color temperature in mireds. Defaults to 500.
|
|
602
|
-
* @returns {this} The current MatterbridgeEndpoint instance for chaining.
|
|
603
|
-
*
|
|
604
|
-
* @remarks colorMode and enhancedColorMode persist across restarts.
|
|
605
|
-
* @remarks colorTemperatureMireds persists across restarts.
|
|
606
|
-
* @remarks startUpColorTemperatureMireds persists across restarts.
|
|
607
|
-
* @remarks coupleColorTempToLevelMinMireds persists across restarts.
|
|
608
|
-
*/
|
|
609
|
-
createCtColorControlClusterServer(colorTemperatureMireds?: number, colorTempPhysicalMinMireds?: number, colorTempPhysicalMaxMireds?: number): this;
|
|
610
|
-
/**
|
|
611
|
-
* Configures the color control mode for the device.
|
|
612
|
-
*
|
|
613
|
-
* @param {ColorControl.ColorMode} colorMode - The color mode to set.
|
|
614
|
-
*
|
|
615
|
-
* @remarks colorMode and enhancedColorMode persist across restarts.
|
|
616
|
-
*/
|
|
617
|
-
configureColorControlMode(colorMode: ColorControl.ColorMode): Promise<void>;
|
|
618
|
-
/**
|
|
619
|
-
* Creates a default window covering cluster server with feature Lift and PositionAwareLift.
|
|
620
|
-
*
|
|
621
|
-
* @param {number} positionPercent100ths - The position percentage in 100ths (0-10000). Defaults to 0. Matter uses 10000 = fully closed 0 = fully opened.
|
|
622
|
-
* @param {WindowCovering.WindowCoveringType} type - The type of window covering (default: WindowCovering.WindowCoveringType.Rollershade). Must support feature Lift.
|
|
623
|
-
* @param {WindowCovering.EndProductType} endProductType - The end product type (default: WindowCovering.EndProductType.RollerShade). Must support feature Lift.
|
|
624
|
-
* @returns {this} The current MatterbridgeEndpoint instance for chaining.
|
|
625
|
-
*
|
|
626
|
-
* @remarks mode attributes is writable and persists across restarts.
|
|
627
|
-
* currentPositionLiftPercent100ths persists across restarts.
|
|
628
|
-
* configStatus attributes persists across restarts.
|
|
629
|
-
*/
|
|
630
|
-
createDefaultWindowCoveringClusterServer(positionPercent100ths?: number, type?: WindowCovering.WindowCoveringType, endProductType?: WindowCovering.EndProductType): this;
|
|
631
|
-
/**
|
|
632
|
-
* Creates a default window covering cluster server with features Lift, PositionAwareLift, Tilt, PositionAwareTilt.
|
|
633
|
-
*
|
|
634
|
-
* @param {number} positionLiftPercent100ths - The lift position percentage in 100ths (0-10000). Defaults to 0. Matter uses 10000 = fully closed 0 = fully opened.
|
|
635
|
-
* @param {number} positionTiltPercent100ths - The tilt position percentage in 100ths (0-10000). Defaults to 0. Matter uses 10000 = fully closed 0 = fully opened.
|
|
636
|
-
* @param {WindowCovering.WindowCoveringType} type - The type of window covering (default: WindowCovering.WindowCoveringType.TiltBlindLift). Must support features Lift and Tilt.
|
|
637
|
-
* @param {WindowCovering.EndProductType} endProductType - The end product type (default: WindowCovering.EndProductType.InteriorBlind). Must support features Lift and Tilt.
|
|
638
|
-
* @returns {this} The current MatterbridgeEndpoint instance for chaining.
|
|
639
|
-
*
|
|
640
|
-
* @remarks mode attributes is writable and persists across restarts.
|
|
641
|
-
* currentPositionTiltPercent100ths persists across restarts.
|
|
642
|
-
* configStatus attributes persists across restarts.
|
|
643
|
-
*/
|
|
644
|
-
createDefaultLiftTiltWindowCoveringClusterServer(positionLiftPercent100ths?: number, positionTiltPercent100ths?: number, type?: WindowCovering.WindowCoveringType, endProductType?: WindowCovering.EndProductType): this;
|
|
645
|
-
/**
|
|
646
|
-
* Sets the window covering lift target position as the current position and stops the movement.
|
|
647
|
-
*
|
|
648
|
-
*/
|
|
649
|
-
setWindowCoveringTargetAsCurrentAndStopped(): Promise<void>;
|
|
650
|
-
/**
|
|
651
|
-
* Sets the lift current and target position and the status of a window covering.
|
|
652
|
-
* @param {number} current - The current position of the window covering.
|
|
653
|
-
* @param {number} target - The target position of the window covering.
|
|
654
|
-
* @param {WindowCovering.MovementStatus} status - The movement status of the window covering.
|
|
655
|
-
*/
|
|
656
|
-
setWindowCoveringCurrentTargetStatus(current: number, target: number, status: WindowCovering.MovementStatus): Promise<void>;
|
|
657
|
-
/**
|
|
658
|
-
* Sets the status of the window covering.
|
|
659
|
-
* @param {WindowCovering.MovementStatus} status - The movement status to set.
|
|
660
|
-
*/
|
|
661
|
-
setWindowCoveringStatus(status: WindowCovering.MovementStatus): Promise<void>;
|
|
662
|
-
/**
|
|
663
|
-
* Retrieves the status of the window covering.
|
|
664
|
-
*
|
|
665
|
-
* @returns The global operational status of the window covering or undefined.
|
|
666
|
-
*/
|
|
667
|
-
getWindowCoveringStatus(): WindowCovering.MovementStatus | undefined;
|
|
668
|
-
/**
|
|
669
|
-
* Sets the lift target and current position of the window covering.
|
|
670
|
-
*
|
|
671
|
-
* @param {number} liftPosition - The position to set, specified as a number.
|
|
672
|
-
* @param {number} [tiltPosition] - The tilt position to set, specified as a number.
|
|
673
|
-
*/
|
|
674
|
-
setWindowCoveringTargetAndCurrentPosition(liftPosition: number, tiltPosition?: number): Promise<void>;
|
|
675
|
-
/**
|
|
676
|
-
* Creates a default thermostat cluster server with features Heating, Cooling and AutoMode.
|
|
677
|
-
*
|
|
678
|
-
* @param {number} [localTemperature=23] - The local temperature value in degrees Celsius. Defaults to 23°.
|
|
679
|
-
* @param {number} [occupiedHeatingSetpoint=21] - The occupied heating setpoint value in degrees Celsius. Defaults to 21°.
|
|
680
|
-
* @param {number} [occupiedCoolingSetpoint=25] - The occupied cooling setpoint value in degrees Celsius. Defaults to 25°.
|
|
681
|
-
* @param {number} [minSetpointDeadBand=1] - The minimum setpoint dead band value. Defaults to 1°.
|
|
682
|
-
* @param {number} [minHeatSetpointLimit=0] - The minimum heat setpoint limit value. Defaults to 0°.
|
|
683
|
-
* @param {number} [maxHeatSetpointLimit=50] - The maximum heat setpoint limit value. Defaults to 50°.
|
|
684
|
-
* @param {number} [minCoolSetpointLimit=0] - The minimum cool setpoint limit value. Defaults to 0°.
|
|
685
|
-
* @param {number} [maxCoolSetpointLimit=50] - The maximum cool setpoint limit value. Defaults to 50°.
|
|
686
|
-
* @returns {this} The current MatterbridgeEndpoint instance for chaining.
|
|
687
|
-
*/
|
|
688
|
-
createDefaultThermostatClusterServer(localTemperature?: number, occupiedHeatingSetpoint?: number, occupiedCoolingSetpoint?: number, minSetpointDeadBand?: number, minHeatSetpointLimit?: number, maxHeatSetpointLimit?: number, minCoolSetpointLimit?: number, maxCoolSetpointLimit?: number): this;
|
|
689
|
-
/**
|
|
690
|
-
* Creates a default heating thermostat cluster server with feature Heating.
|
|
691
|
-
* @param {number} [localTemperature] - The local temperature value in degrees Celsius. Defaults to 23°.
|
|
692
|
-
* @param {number} [occupiedHeatingSetpoint] - The occupied heating setpoint value in degrees Celsius. Defaults to 21°.
|
|
693
|
-
* @param {number} [minHeatSetpointLimit] - The minimum heat setpoint limit value. Defaults to 0°.
|
|
694
|
-
* @param {number} [maxHeatSetpointLimit] - The maximum heat setpoint limit value. Defaults to 50°.
|
|
695
|
-
* @returns {this} The current MatterbridgeEndpoint instance for chaining.
|
|
696
|
-
*/
|
|
697
|
-
createDefaultHeatingThermostatClusterServer(localTemperature?: number, occupiedHeatingSetpoint?: number, minHeatSetpointLimit?: number, maxHeatSetpointLimit?: number): this;
|
|
698
|
-
/**
|
|
699
|
-
* Creates a default cooling thermostat cluster server with feature Cooling.
|
|
700
|
-
* @param {number} [localTemperature] - The local temperature value in degrees Celsius. Defaults to 23°.
|
|
701
|
-
* @param {number} [occupiedCoolingSetpoint] - The occupied cooling setpoint value in degrees Celsius. Defaults to 25°.
|
|
702
|
-
* @param {number} [minCoolSetpointLimit] - The minimum cool setpoint limit value. Defaults to 0°.
|
|
703
|
-
* @param {number} [maxCoolSetpointLimit] - The maximum cool setpoint limit value. Defaults to 50°.
|
|
704
|
-
* @returns {this} The current MatterbridgeEndpoint instance for chaining.
|
|
705
|
-
*/
|
|
706
|
-
createDefaultCoolingThermostatClusterServer(localTemperature?: number, occupiedCoolingSetpoint?: number, minCoolSetpointLimit?: number, maxCoolSetpointLimit?: number): this;
|
|
707
|
-
/**
|
|
708
|
-
* Creates a default thermostat user interface configuration cluster server.
|
|
709
|
-
*
|
|
710
|
-
* @remarks
|
|
711
|
-
* The default values are:
|
|
712
|
-
* - temperatureDisplayMode: ThermostatUserInterfaceConfiguration.TemperatureDisplayMode.Celsius (writeble).
|
|
713
|
-
* - keypadLockout: ThermostatUserInterfaceConfiguration.KeypadLockout.NoLockout (writeble).
|
|
714
|
-
* - scheduleProgrammingVisibility: ThermostatUserInterfaceConfiguration.ScheduleProgrammingVisibility.ScheduleProgrammingPermitted (writeble).
|
|
715
|
-
*/
|
|
716
|
-
createDefaultThermostatUserInterfaceConfigurationClusterServer(): this;
|
|
717
|
-
/**
|
|
718
|
-
* Creates a default fan control cluster server with features Auto, and Step.
|
|
719
|
-
*
|
|
720
|
-
* @param {FanControl.FanMode} [fanMode=FanControl.FanMode.Off] - The fan mode to set. Defaults to `FanControl.FanMode.Off`.
|
|
721
|
-
* @param {FanControl.FanModeSequence} [fanModeSequence=FanControl.FanModeSequence.OffLowMedHighAuto] - The fan mode sequence to set. Defaults to `FanControl.FanModeSequence.OffLowMedHighAuto`.
|
|
722
|
-
* @param {number} [percentSetting=0] - The initial percent setting. Defaults to 0.
|
|
723
|
-
* @param {number} [percentCurrent=0] - The initial percent current. Defaults to 0.
|
|
724
|
-
* @returns {this} The current MatterbridgeEndpoint instance for chaining.
|
|
725
|
-
*
|
|
726
|
-
* @remarks
|
|
727
|
-
* - fanmode is writable and persists across reboots.
|
|
728
|
-
* - fanModeSequence is fixed.
|
|
729
|
-
* - percentSetting is writable.
|
|
730
|
-
*/
|
|
731
|
-
createDefaultFanControlClusterServer(fanMode?: FanControl.FanMode, fanModeSequence?: FanControl.FanModeSequence, percentSetting?: number, percentCurrent?: number): this;
|
|
732
|
-
/**
|
|
733
|
-
* Creates a fan control cluster server with features MultiSpeed, Auto, and Step.
|
|
734
|
-
*
|
|
735
|
-
* @param {FanControl.FanMode} [fanMode=FanControl.FanMode.Off] - The fan mode to set. Defaults to `FanControl.FanMode.Off`.
|
|
736
|
-
* @param {number} [percentSetting=0] - The initial percent setting. Defaults to 0.
|
|
737
|
-
* @param {number} [percentCurrent=0] - The initial percent current. Defaults to 0.
|
|
738
|
-
* @param {number} [speedMax=10] - The maximum speed setting. Defaults to 10.
|
|
739
|
-
* @param {number} [speedSetting=0] - The initial speed setting. Defaults to 0.
|
|
740
|
-
* @param {number} [speedCurrent=0] - The initial speed current. Defaults to 0.
|
|
741
|
-
* @returns {this} The current MatterbridgeEndpoint instance for chaining.
|
|
742
|
-
*
|
|
743
|
-
* @remarks
|
|
744
|
-
* - fanmode is writable and persists across reboots.
|
|
745
|
-
* - fanModeSequence is fixed.
|
|
746
|
-
* - percentSetting is writable.
|
|
747
|
-
* - speedMax is fixed.
|
|
748
|
-
* - speedSetting is writable.
|
|
749
|
-
*/
|
|
750
|
-
createMultiSpeedFanControlClusterServer(fanMode?: FanControl.FanMode, fanModeSequence?: FanControl.FanModeSequence, percentSetting?: number, percentCurrent?: number, speedMax?: number, speedSetting?: number, speedCurrent?: number): this;
|
|
751
|
-
/**
|
|
752
|
-
* Creates a base fan control cluster server without features.
|
|
753
|
-
*
|
|
754
|
-
* @param {FanControl.FanMode} [fanMode=FanControl.FanMode.Off] - The fan mode to set. Defaults to `FanControl.FanMode.Off`.
|
|
755
|
-
* @param {FanControl.FanModeSequence} [fanModeSequence=FanControl.FanModeSequence.OffLowMedHigh] - The fan mode sequence to set. Defaults to `FanControl.FanModeSequence.OffLowMedHigh`.
|
|
756
|
-
* @param {number} [percentSetting=0] - The initial percent setting. Defaults to 0.
|
|
757
|
-
* @param {number} [percentCurrent=0] - The initial percent current. Defaults to 0.
|
|
758
|
-
* @returns {this} The current MatterbridgeEndpoint instance for chaining.
|
|
759
|
-
*
|
|
760
|
-
* @remarks
|
|
761
|
-
* fanmode is writable and persists across reboots.
|
|
762
|
-
* fanModeSequence is fixed.
|
|
763
|
-
* percentSetting is writable.
|
|
764
|
-
*/
|
|
765
|
-
createBaseFanControlClusterServer(fanMode?: FanControl.FanMode, fanModeSequence?: FanControl.FanModeSequence, percentSetting?: number, percentCurrent?: number): this;
|
|
766
|
-
/**
|
|
767
|
-
* Creates a default HEPA Filter Monitoring Cluster Server with features Condition and ReplacementProductList.
|
|
768
|
-
* It supports ResourceMonitoring.Feature.Condition and ResourceMonitoring.Feature.ReplacementProductList.
|
|
769
|
-
*
|
|
770
|
-
* @param {ResourceMonitoring.ChangeIndication} changeIndication - The initial change indication. Default is ResourceMonitoring.ChangeIndication.Ok.
|
|
771
|
-
* @param {boolean | undefined} inPlaceIndicator - The in-place indicator. Default is undefined.
|
|
772
|
-
* @param {number | undefined} lastChangedTime - The last changed time (EpochS). Default is undefined.
|
|
773
|
-
*
|
|
774
|
-
* @returns {this} The current MatterbridgeEndpoint instance for chaining.
|
|
775
|
-
*/
|
|
776
|
-
createDefaultHepaFilterMonitoringClusterServer(changeIndication?: ResourceMonitoring.ChangeIndication, inPlaceIndicator?: boolean | undefined, lastChangedTime?: number | undefined): this;
|
|
777
|
-
/**
|
|
778
|
-
* Creates a default Activated Carbon Filter Monitoring Cluster Server with features Condition and ReplacementProductList.
|
|
779
|
-
*
|
|
780
|
-
* @param {ResourceMonitoring.ChangeIndication} changeIndication - The initial change indication. Default is ResourceMonitoring.ChangeIndication.Ok.
|
|
781
|
-
* @param {boolean | undefined} inPlaceIndicator - The in-place indicator. Default is undefined.
|
|
782
|
-
* @param {number | undefined} lastChangedTime - The last changed time (EpochS). Default is undefined.
|
|
783
|
-
*
|
|
784
|
-
* @returns {this} The current MatterbridgeEndpoint instance for chaining.
|
|
785
|
-
*/
|
|
786
|
-
createDefaultActivatedCarbonFilterMonitoringClusterServer(changeIndication?: ResourceMonitoring.ChangeIndication, inPlaceIndicator?: boolean | undefined, lastChangedTime?: number | undefined): this;
|
|
787
|
-
/**
|
|
788
|
-
* Creates a default door lock cluster server.
|
|
789
|
-
*
|
|
790
|
-
* @param {DoorLock.LockState} [lockState=DoorLock.LockState.Locked] - The initial state of the lock (default: Locked).
|
|
791
|
-
* @param {DoorLock.LockType} [lockType=DoorLock.LockType.DeadBolt] - The type of the lock (default: DeadBolt).
|
|
792
|
-
* @returns {this} The current MatterbridgeEndpoint instance for chaining.
|
|
793
|
-
*
|
|
794
|
-
* @remarks
|
|
795
|
-
* 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.
|
|
796
|
-
*/
|
|
797
|
-
createDefaultDoorLockClusterServer(lockState?: DoorLock.LockState, lockType?: DoorLock.LockType): this;
|
|
798
|
-
/**
|
|
799
|
-
* Creates a default Mode Select cluster server.
|
|
800
|
-
*
|
|
801
|
-
* @param {string} description - The description of the mode select cluster.
|
|
802
|
-
* @param {ModeSelect.ModeOption[]} supportedModes - The list of supported modes.
|
|
803
|
-
* @param {number} [currentMode=0] - The current mode (default: 0).
|
|
804
|
-
* @param {number} [startUpMode=0] - The startup mode (default: 0).
|
|
805
|
-
* @returns {this} The current MatterbridgeEndpoint instance for chaining.
|
|
806
|
-
*
|
|
807
|
-
* @remarks
|
|
808
|
-
* endpoint.createDefaultModeSelectClusterServer('Night mode', [{ label: 'Led ON', mode: 0, semanticTags: [] }, { label: 'Led OFF', mode: 1, semanticTags: [] }], 0, 0);
|
|
809
|
-
*/
|
|
810
|
-
createDefaultModeSelectClusterServer(description: string, supportedModes: ModeSelect.ModeOption[], currentMode?: number, startUpMode?: number): this;
|
|
811
|
-
/**
|
|
812
|
-
* Creates the default Valve Configuration And Control cluster server with features Level.
|
|
813
|
-
*
|
|
814
|
-
* @param {ValveConfigurationAndControl.ValveState} [valveState=ValveConfigurationAndControl.ValveState.Closed] - The valve state to set. Defaults to `ValveConfigurationAndControl.ValveState.Closed`.
|
|
815
|
-
* @param {number} [valveLevel=0] - The valve level to set. Defaults to 0.
|
|
816
|
-
* @returns {this} The current MatterbridgeEndpoint instance for chaining.
|
|
817
|
-
*/
|
|
818
|
-
createDefaultValveConfigurationAndControlClusterServer(valveState?: ValveConfigurationAndControl.ValveState, valveLevel?: number): this;
|
|
819
|
-
/**
|
|
820
|
-
* Creates the default PumpConfigurationAndControl cluster server with features ConstantSpeed.
|
|
821
|
-
*
|
|
822
|
-
* @param {PumpConfigurationAndControl.OperationMode} [pumpMode=PumpConfigurationAndControl.OperationMode.Normal] - The pump mode to set. Defaults to `PumpConfigurationAndControl.OperationMode.Normal`.
|
|
823
|
-
* @returns {this} The current MatterbridgeEndpoint instance for chaining.
|
|
824
|
-
*/
|
|
825
|
-
createDefaultPumpConfigurationAndControlClusterServer(pumpMode?: PumpConfigurationAndControl.OperationMode): this;
|
|
826
|
-
/**
|
|
827
|
-
* Creates the default SmokeCOAlarm Cluster Server with features SmokeAlarm and CoAlarm.
|
|
828
|
-
*
|
|
829
|
-
* @param {SmokeCoAlarm.AlarmState} smokeState - The state of the smoke alarm. Defaults to SmokeCoAlarm.AlarmState.Normal.
|
|
830
|
-
* @param {SmokeCoAlarm.AlarmState} coState - The state of the CO alarm. Defaults to SmokeCoAlarm.AlarmState.Normal.
|
|
831
|
-
* @returns {this} The current MatterbridgeEndpoint instance for chaining.
|
|
832
|
-
*/
|
|
833
|
-
createDefaultSmokeCOAlarmClusterServer(smokeState?: SmokeCoAlarm.AlarmState, coState?: SmokeCoAlarm.AlarmState): this;
|
|
834
|
-
/**
|
|
835
|
-
* Creates a smoke only SmokeCOAlarm Cluster Server with features SmokeAlarm.
|
|
836
|
-
*
|
|
837
|
-
* @param {SmokeCoAlarm.AlarmState} smokeState - The state of the smoke alarm. Defaults to SmokeCoAlarm.AlarmState.Normal.
|
|
838
|
-
* @returns {this} The current MatterbridgeEndpoint instance for chaining.
|
|
839
|
-
*/
|
|
840
|
-
createSmokeOnlySmokeCOAlarmClusterServer(smokeState?: SmokeCoAlarm.AlarmState): this;
|
|
841
|
-
/**
|
|
842
|
-
* Creates a co only SmokeCOAlarm Cluster Server with features CoAlarm.
|
|
843
|
-
*
|
|
844
|
-
* @param {SmokeCoAlarm.AlarmState} coState - The state of the CO alarm. Defaults to SmokeCoAlarm.AlarmState.Normal.
|
|
845
|
-
* @returns {this} The current MatterbridgeEndpoint instance for chaining.
|
|
846
|
-
*/
|
|
847
|
-
createCoOnlySmokeCOAlarmClusterServer(coState?: SmokeCoAlarm.AlarmState): this;
|
|
848
|
-
/**
|
|
849
|
-
* Creates a default momentary switch cluster server with features MomentarySwitch, MomentarySwitchRelease, MomentarySwitchLongPress and MomentarySwitchMultiPress.
|
|
850
|
-
*
|
|
851
|
-
* @remarks
|
|
852
|
-
* This method adds a cluster server with default momentary switch features and configuration suitable for (AppleHome) Single Double Long automations.
|
|
853
|
-
* @returns {this} The current MatterbridgeEndpoint instance for chaining.
|
|
854
|
-
*/
|
|
855
|
-
createDefaultSwitchClusterServer(): this;
|
|
856
|
-
/**
|
|
857
|
-
* Creates a default latching switch cluster server with features LatchingSwitch.
|
|
858
|
-
*
|
|
859
|
-
* @remarks
|
|
860
|
-
* This method adds a cluster server with default latching switch features and configuration suitable for a latching switch with 2 positions.
|
|
861
|
-
* @returns {this} The current MatterbridgeEndpoint instance for chaining.
|
|
862
|
-
*/
|
|
863
|
-
createDefaultLatchingSwitchClusterServer(): this;
|
|
864
|
-
/**
|
|
865
|
-
* Triggers a switch event on the specified endpoint.
|
|
866
|
-
*
|
|
867
|
-
* @param {string} event - The type of event to trigger. Possible values are 'Single', 'Double', 'Long' for momentarySwitch and 'Press', 'Release' for latchingSwitch.
|
|
868
|
-
* @param {Endpoint} endpoint - The endpoint on which to trigger the event (default the device endpoint).
|
|
869
|
-
* @returns {boolean} - A boolean indicating whether the event was successfully triggered.
|
|
870
|
-
*/
|
|
871
|
-
triggerSwitchEvent(event: 'Single' | 'Double' | 'Long' | 'Press' | 'Release', log?: AnsiLogger): Promise<boolean>;
|
|
872
|
-
/**
|
|
873
|
-
* Creates a default OperationalState Cluster Server.
|
|
874
|
-
*
|
|
875
|
-
* @param {OperationalState.OperationalStateEnum} operationalState - The initial operational state.
|
|
876
|
-
*
|
|
877
|
-
* @returns {this} The current MatterbridgeEndpoint instance for chaining.
|
|
878
|
-
*/
|
|
879
|
-
createDefaultOperationalStateClusterServer(operationalState?: OperationalState.OperationalStateEnum): this;
|
|
880
|
-
/**
|
|
881
|
-
* Creates a default boolean state cluster server.
|
|
882
|
-
* The stateChange event is enabled.
|
|
883
|
-
*
|
|
884
|
-
* @param {boolean} contact - The state of the cluster. Defaults to true (true = contact).
|
|
885
|
-
* @returns {this} The current MatterbridgeEndpoint instance for chaining.
|
|
886
|
-
*
|
|
887
|
-
* @remarks
|
|
888
|
-
* Water Leak Detector: true = leak, false = no leak
|
|
889
|
-
* Water Freeze Detector: true = freeze, false = no freeze
|
|
890
|
-
* Rain Sensor: true = rain, false = no rain
|
|
891
|
-
* Contact Sensor: true = closed or contact, false = open or no contact
|
|
892
|
-
*/
|
|
893
|
-
createDefaultBooleanStateClusterServer(contact?: boolean): this;
|
|
894
|
-
/**
|
|
895
|
-
* Creates a default boolean state configuration cluster server to be used with the waterFreezeDetector, waterLeakDetector, and rainSensor device types.
|
|
896
|
-
*
|
|
897
|
-
* Features:
|
|
898
|
-
* - Visual
|
|
899
|
-
* - Audible
|
|
900
|
-
* - SensitivityLevel
|
|
901
|
-
*
|
|
902
|
-
* @remarks Supports the enableDisableAlarm command.
|
|
903
|
-
*
|
|
904
|
-
* @param {boolean} [sensorFault=false] - Optional boolean value indicating the sensor fault state. Defaults to `false` if not provided.
|
|
905
|
-
* @param {number} [currentSensitivityLevel=0] - The current sensitivity level. Defaults to `0` if not provided.
|
|
906
|
-
* @param {number} [supportedSensitivityLevels=2] - The number of supported sensitivity levels. Defaults to `2` if not provided (min 2, max 10).
|
|
907
|
-
* @param {number} [defaultSensitivityLevel=0] - The default sensitivity level. Defaults to `0` if not provided.
|
|
908
|
-
* @returns {this} The current MatterbridgeEndpoint instance for chaining.
|
|
909
|
-
*
|
|
910
|
-
*/
|
|
911
|
-
createDefaultBooleanStateConfigurationClusterServer(sensorFault?: boolean, currentSensitivityLevel?: number, supportedSensitivityLevels?: number, defaultSensitivityLevel?: number): this;
|
|
912
|
-
/**
|
|
913
|
-
* Creates a default Device Energy Management Cluster Server with feature PowerForecastReporting and with the specified ESA type, ESA canGenerate, ESA state, and power limits.
|
|
914
|
-
*
|
|
915
|
-
* @param {DeviceEnergyManagement.EsaType} [esaType=DeviceEnergyManagement.EsaType.Other] - The ESA type. Defaults to `DeviceEnergyManagement.EsaType.Other`.
|
|
916
|
-
* @param {boolean} [esaCanGenerate=false] - Indicates if the ESA can generate energy. Defaults to `false`.
|
|
917
|
-
* @param {DeviceEnergyManagement.EsaState} [esaState=DeviceEnergyManagement.EsaState.Online] - The ESA state. Defaults to `DeviceEnergyManagement.EsaState.Online`.
|
|
918
|
-
* @param {number} [absMinPower=0] - The absolute minimum power in mW. Defaults to `0`.
|
|
919
|
-
* @param {number} [absMaxPower=0] - The absolute maximum power in mW. Defaults to `0`.
|
|
920
|
-
* @returns {this} The current MatterbridgeEndpoint instance for chaining.
|
|
921
|
-
*
|
|
922
|
-
* @remarks
|
|
923
|
-
* - The forecast attribute is set to null, indicating that there is no forecast currently available.
|
|
924
|
-
* - The ESA type and canGenerate attributes are fixed and cannot be changed after creation.
|
|
925
|
-
* - The ESA state is set to Online by default.
|
|
926
|
-
* - The absolute minimum and maximum power attributes are set to 0 by default.
|
|
927
|
-
* - For example, a battery storage inverter that can charge its battery at a maximum power of 2000W and can
|
|
928
|
-
* discharge the battery at a maximum power of 3000W, would have a absMinPower: -3000W, absMaxPower: 2000W.
|
|
929
|
-
*/
|
|
930
|
-
createDefaultDeviceEnergyManagementClusterServer(esaType?: DeviceEnergyManagement.EsaType, esaCanGenerate?: boolean, esaState?: DeviceEnergyManagement.EsaState, absMinPower?: number, absMaxPower?: number): this;
|
|
931
|
-
/**
|
|
932
|
-
* Creates a default EnergyManagementMode Cluster Server.
|
|
933
|
-
*
|
|
934
|
-
* @param {number} [currentMode] - The current mode of the EnergyManagementMode cluster. Defaults to mode 1 (DeviceEnergyManagementMode.ModeTag.NoOptimization).
|
|
935
|
-
* @param {EnergyManagementMode.ModeOption[]} [supportedModes] - The supported modes for the DeviceEnergyManagementMode cluster. The attribute is fixed and defaults to a predefined set of cluster modes.
|
|
936
|
-
* @returns {this} The current MatterbridgeEndpoint instance for chaining.
|
|
937
|
-
*
|
|
938
|
-
* @remarks
|
|
939
|
-
* A few examples of Device Energy Management modes and their mode tags are provided below.
|
|
940
|
-
* - For the "No Energy Management (Forecast reporting only)" mode, tags: 0x4000 (NoOptimization).
|
|
941
|
-
* - For the "Device Energy Management" mode, tags: 0x4001 (DeviceOptimization).
|
|
942
|
-
* - For the "Home Energy Management" mode, tags: 0x4001 (DeviceOptimization), 0x4002 (LocalOptimization).
|
|
943
|
-
* - For the "Grid Energy Management" mode, tags: 0x4003 (GridOptimization).
|
|
944
|
-
* - For the "Full Energy Management" mode, tags: 0x4001 (DeviceOptimization), 0x4002 (LocalOptimization), 0x4003 (GridOptimization).
|
|
945
|
-
*/
|
|
946
|
-
createDefaultDeviceEnergyManagementModeClusterServer(currentMode?: number, supportedModes?: DeviceEnergyManagementMode.ModeOption[]): this;
|
|
947
|
-
/**
|
|
948
|
-
* Creates a default Power Topology Cluster Server with feature TreeTopology. Only needed for an electricalSensor device type.
|
|
949
|
-
*
|
|
950
|
-
* @returns {this} The current MatterbridgeEndpoint instance for chaining.
|
|
951
|
-
*/
|
|
952
|
-
createDefaultPowerTopologyClusterServer(): this;
|
|
953
|
-
/**
|
|
954
|
-
* Creates a default Electrical Energy Measurement Cluster Server with features ImportedEnergy, ExportedEnergy, and CumulativeEnergy.
|
|
955
|
-
*
|
|
956
|
-
* @param {number} energyImported - The total consumption value in mW/h.
|
|
957
|
-
* @param {number} energyExported - The total production value in mW/h.
|
|
958
|
-
* @returns {this} The current MatterbridgeEndpoint instance for chaining.
|
|
959
|
-
*/
|
|
960
|
-
createDefaultElectricalEnergyMeasurementClusterServer(energyImported?: number | bigint | null, energyExported?: number | bigint | null): this;
|
|
961
|
-
/**
|
|
962
|
-
* Creates a default Electrical Power Measurement Cluster Server with features AlternatingCurrent.
|
|
963
|
-
*
|
|
964
|
-
* @param {number} voltage - The voltage value in millivolts.
|
|
965
|
-
* @param {number} current - The current value in milliamperes.
|
|
966
|
-
* @param {number} power - The power value in milliwatts.
|
|
967
|
-
* @param {number} frequency - The frequency value in millihertz.
|
|
968
|
-
* @returns {this} The current MatterbridgeEndpoint instance for chaining.
|
|
969
|
-
*/
|
|
970
|
-
createDefaultElectricalPowerMeasurementClusterServer(voltage?: number | bigint | null, current?: number | bigint | null, power?: number | bigint | null, frequency?: number | bigint | null): this;
|
|
971
|
-
/**
|
|
972
|
-
* Creates a default TemperatureMeasurement cluster server.
|
|
973
|
-
*
|
|
974
|
-
* @param {number | null} measuredValue - The measured value of the temperature x 100.
|
|
975
|
-
* @param {number | null} minMeasuredValue - The minimum measured value of the temperature x 100.
|
|
976
|
-
* @param {number | null} maxMeasuredValue - The maximum measured value of the temperature x 100.
|
|
977
|
-
* @returns {this} The current MatterbridgeEndpoint instance for chaining.
|
|
978
|
-
*/
|
|
979
|
-
createDefaultTemperatureMeasurementClusterServer(measuredValue?: number | null, minMeasuredValue?: number | null, maxMeasuredValue?: number | null): this;
|
|
980
|
-
/**
|
|
981
|
-
* Creates a default RelativeHumidityMeasurement cluster server.
|
|
982
|
-
*
|
|
983
|
-
* @param {number | null} measuredValue - The measured value of the relative humidity x 100.
|
|
984
|
-
* @param {number | null} minMeasuredValue - The minimum measured value of the relative humidity x 100.
|
|
985
|
-
* @param {number | null} maxMeasuredValue - The maximum measured value of the relative humidity x 100.
|
|
986
|
-
* @returns {this} The current MatterbridgeEndpoint instance for chaining.
|
|
987
|
-
*/
|
|
988
|
-
createDefaultRelativeHumidityMeasurementClusterServer(measuredValue?: number | null, minMeasuredValue?: number | null, maxMeasuredValue?: number | null): this;
|
|
989
|
-
/**
|
|
990
|
-
* Creates a default PressureMeasurement cluster server.
|
|
991
|
-
*
|
|
992
|
-
* @param {number | null} measuredValue - The measured value for the pressure.
|
|
993
|
-
* @param {number | null} minMeasuredValue - The minimum measured value for the pressure.
|
|
994
|
-
* @param {number | null} maxMeasuredValue - The maximum measured value for the pressure.
|
|
995
|
-
* @returns {this} The current MatterbridgeEndpoint instance for chaining.
|
|
996
|
-
*/
|
|
997
|
-
createDefaultPressureMeasurementClusterServer(measuredValue?: number | null, minMeasuredValue?: number | null, maxMeasuredValue?: number | null): this;
|
|
998
|
-
/**
|
|
999
|
-
* Creates a default IlluminanceMeasurement cluster server.
|
|
1000
|
-
*
|
|
1001
|
-
* @param {number | null} measuredValue - The measured value of illuminance.
|
|
1002
|
-
* @param {number | null} minMeasuredValue - The minimum measured value of illuminance.
|
|
1003
|
-
* @param {number | null} maxMeasuredValue - The maximum measured value of illuminance.
|
|
1004
|
-
* @returns {this} The current MatterbridgeEndpoint instance for chaining.
|
|
1005
|
-
*
|
|
1006
|
-
* @remark The default value for the illuminance measurement is null.
|
|
1007
|
-
* This attribute SHALL indicate the illuminance in Lux (symbol lx) as follows:
|
|
1008
|
-
* • MeasuredValue = 10,000 x log10(illuminance) + 1,
|
|
1009
|
-
* where 1 lx <= illuminance <= 3.576 Mlx, corresponding to a MeasuredValue in the range 1 to 0xFFFE.
|
|
1010
|
-
* • 0 indicates a value of illuminance that is too low to be measured
|
|
1011
|
-
* • null indicates that the illuminance measurement is invalid.
|
|
1012
|
-
*
|
|
1013
|
-
* - Lux to matter = Math.round(Math.max(Math.min(10000 * Math.log10(lux), 0xfffe), 0))
|
|
1014
|
-
* - Matter to Lux = Math.round(Math.max(Math.pow(10, value / 10000), 0))
|
|
1015
|
-
*/
|
|
1016
|
-
createDefaultIlluminanceMeasurementClusterServer(measuredValue?: number | null, minMeasuredValue?: number | null, maxMeasuredValue?: number | null): this;
|
|
1017
|
-
/**
|
|
1018
|
-
* Creates a default FlowMeasurement cluster server.
|
|
1019
|
-
*
|
|
1020
|
-
* @param {number | null} measuredValue - The measured value of the flow in 10 x m3/h.
|
|
1021
|
-
* @param {number | null} minMeasuredValue - The minimum measured value of the flow in 10 x m3/h.
|
|
1022
|
-
* @param {number | null} maxMeasuredValue - The maximum measured value of the flow in 10 x m3/h.
|
|
1023
|
-
* @returns {this} The current MatterbridgeEndpoint instance for chaining.
|
|
1024
|
-
*/
|
|
1025
|
-
createDefaultFlowMeasurementClusterServer(measuredValue?: number | null, minMeasuredValue?: number | null, maxMeasuredValue?: number | null): this;
|
|
1026
|
-
/**
|
|
1027
|
-
* Creates a default OccupancySensing cluster server with feature PassiveInfrared.
|
|
1028
|
-
*
|
|
1029
|
-
* @param {boolean} occupied - A boolean indicating whether the occupancy is occupied or not. Default is false.
|
|
1030
|
-
* @param {number} holdTime - The hold time in seconds. Default is 30.
|
|
1031
|
-
* @param {number} holdTimeMin - The minimum hold time in seconds. Default is 1.
|
|
1032
|
-
* @param {number} holdTimeMax - The maximum hold time in seconds. Default is 300.
|
|
1033
|
-
* @returns {this} The current MatterbridgeEndpoint instance for chaining.
|
|
1034
|
-
*
|
|
1035
|
-
* @remark The default value for the occupancy sensor type is PIR.
|
|
1036
|
-
*/
|
|
1037
|
-
createDefaultOccupancySensingClusterServer(occupied?: boolean, holdTime?: number, holdTimeMin?: number, holdTimeMax?: number): this;
|
|
1038
|
-
/**
|
|
1039
|
-
* Creates a default AirQuality cluster server.
|
|
1040
|
-
*
|
|
1041
|
-
* @param {AirQuality.AirQualityEnum} airQuality The air quality level. Defaults to `AirQuality.AirQualityType.Unknown`.
|
|
1042
|
-
* @returns {this} The current MatterbridgeEndpoint instance for chaining.
|
|
1043
|
-
*/
|
|
1044
|
-
createDefaultAirQualityClusterServer(airQuality?: AirQuality.AirQualityEnum): this;
|
|
1045
|
-
/**
|
|
1046
|
-
* Creates a default TotalVolatileOrganicCompoundsConcentrationMeasurement cluster server with feature NumericMeasurement.
|
|
1047
|
-
*
|
|
1048
|
-
* @param {number | null} measuredValue - The measured value of the concentration.
|
|
1049
|
-
* @param {ConcentrationMeasurement.MeasurementUnit} measurementUnit - The unit of measurement (default to ConcentrationMeasurement.MeasurementUnit.Ppm).
|
|
1050
|
-
* @param {ConcentrationMeasurement.MeasurementMedium} measurementMedium - The unit of measurement (default to ConcentrationMeasurement.MeasurementMedium.Air).
|
|
1051
|
-
* @param {number} [uncertainty] - The uncertainty value (optional).
|
|
1052
|
-
* @returns {this} The current MatterbridgeEndpoint instance for chaining.
|
|
1053
|
-
*/
|
|
1054
|
-
createDefaultTvocMeasurementClusterServer(measuredValue?: number | null, measurementUnit?: ConcentrationMeasurement.MeasurementUnit, measurementMedium?: ConcentrationMeasurement.MeasurementMedium, uncertainty?: number): this;
|
|
1055
|
-
/**
|
|
1056
|
-
* Creates a default TotalVolatileOrganicCompoundsConcentrationMeasurement cluster server with feature LevelIndication.
|
|
1057
|
-
|
|
1058
|
-
* @param {ConcentrationMeasurement.LevelValue} levelValue - The level value of the measurement (default to ConcentrationMeasurement.LevelValue.Unknown).
|
|
1059
|
-
* @param {ConcentrationMeasurement.MeasurementMedium} measurementMedium - The measurement medium (default to ConcentrationMeasurement.MeasurementMedium.Air).
|
|
1060
|
-
* @returns {this} The current MatterbridgeEndpoint instance for chaining.
|
|
1061
|
-
*/
|
|
1062
|
-
createLevelTvocMeasurementClusterServer(levelValue?: ConcentrationMeasurement.LevelValue, measurementMedium?: ConcentrationMeasurement.MeasurementMedium): this;
|
|
1063
|
-
/**
|
|
1064
|
-
* Create a default CarbonMonoxideConcentrationMeasurement cluster server with feature NumericMeasurement.
|
|
1065
|
-
*
|
|
1066
|
-
* @param {number | null} measuredValue - The measured value of the concentration.
|
|
1067
|
-
* @param {ConcentrationMeasurement.MeasurementUnit} measurementUnit - The unit of measurement (default to ConcentrationMeasurement.MeasurementUnit.Ppm).
|
|
1068
|
-
* @param {ConcentrationMeasurement.MeasurementMedium} measurementMedium - The unit of measurement (default to ConcentrationMeasurement.MeasurementMedium.Air).
|
|
1069
|
-
* @returns {this} The current MatterbridgeEndpoint instance for chaining.
|
|
1070
|
-
*/
|
|
1071
|
-
createDefaultCarbonMonoxideConcentrationMeasurementClusterServer(measuredValue?: number | null, measurementUnit?: ConcentrationMeasurement.MeasurementUnit, measurementMedium?: ConcentrationMeasurement.MeasurementMedium): this;
|
|
1072
|
-
/**
|
|
1073
|
-
* Create a default CarbonDioxideConcentrationMeasurement cluster server with feature NumericMeasurement.
|
|
1074
|
-
*
|
|
1075
|
-
* @param {number | null} measuredValue - The measured value of the concentration.
|
|
1076
|
-
* @param {ConcentrationMeasurement.MeasurementUnit} measurementUnit - The unit of measurement (default to ConcentrationMeasurement.MeasurementUnit.Ppm).
|
|
1077
|
-
* @param {ConcentrationMeasurement.MeasurementMedium} measurementMedium - The unit of measurement (default to ConcentrationMeasurement.MeasurementMedium.Air).
|
|
1078
|
-
* @returns {this} The current MatterbridgeEndpoint instance for chaining.
|
|
1079
|
-
*/
|
|
1080
|
-
createDefaultCarbonDioxideConcentrationMeasurementClusterServer(measuredValue?: number | null, measurementUnit?: ConcentrationMeasurement.MeasurementUnit, measurementMedium?: ConcentrationMeasurement.MeasurementMedium): this;
|
|
1081
|
-
/**
|
|
1082
|
-
* Create a default FormaldehydeConcentrationMeasurement cluster server with feature NumericMeasurement.
|
|
1083
|
-
*
|
|
1084
|
-
* @param {number | null} measuredValue - The measured value of the concentration.
|
|
1085
|
-
* @param {ConcentrationMeasurement.MeasurementUnit} measurementUnit - The unit of measurement (default to ConcentrationMeasurement.MeasurementUnit.Ppm).
|
|
1086
|
-
* @param {ConcentrationMeasurement.MeasurementMedium} measurementMedium - The unit of measurement (default to ConcentrationMeasurement.MeasurementMedium.Air).
|
|
1087
|
-
* @returns {this} The current MatterbridgeEndpoint instance for chaining.
|
|
1088
|
-
*/
|
|
1089
|
-
createDefaultFormaldehydeConcentrationMeasurementClusterServer(measuredValue?: number | null, measurementUnit?: ConcentrationMeasurement.MeasurementUnit, measurementMedium?: ConcentrationMeasurement.MeasurementMedium): this;
|
|
1090
|
-
/**
|
|
1091
|
-
* Create a default Pm1ConcentrationMeasurement cluster server with feature NumericMeasurement.
|
|
1092
|
-
*
|
|
1093
|
-
* @param {number | null} measuredValue - The measured value of the concentration.
|
|
1094
|
-
* @param {ConcentrationMeasurement.MeasurementUnit} measurementUnit - The unit of measurement (default to ConcentrationMeasurement.MeasurementUnit.Ppm).
|
|
1095
|
-
* @param {ConcentrationMeasurement.MeasurementMedium} measurementMedium - The unit of measurement (default to ConcentrationMeasurement.MeasurementMedium.Air).
|
|
1096
|
-
* @returns {this} The current MatterbridgeEndpoint instance for chaining.
|
|
1097
|
-
*/
|
|
1098
|
-
createDefaultPm1ConcentrationMeasurementClusterServer(measuredValue?: number | null, measurementUnit?: ConcentrationMeasurement.MeasurementUnit, measurementMedium?: ConcentrationMeasurement.MeasurementMedium): this;
|
|
1099
|
-
/**
|
|
1100
|
-
* Create a default Pm25ConcentrationMeasurement cluster server with feature NumericMeasurement.
|
|
1101
|
-
*
|
|
1102
|
-
* @param {number | null} measuredValue - The measured value of the concentration.
|
|
1103
|
-
* @param {ConcentrationMeasurement.MeasurementUnit} measurementUnit - The unit of measurement (default to ConcentrationMeasurement.MeasurementUnit.Ppm).
|
|
1104
|
-
* @param {ConcentrationMeasurement.MeasurementMedium} measurementMedium - The unit of measurement (default to ConcentrationMeasurement.MeasurementMedium.Air).
|
|
1105
|
-
* @returns {this} The current MatterbridgeEndpoint instance for chaining.
|
|
1106
|
-
*/
|
|
1107
|
-
createDefaultPm25ConcentrationMeasurementClusterServer(measuredValue?: number | null, measurementUnit?: ConcentrationMeasurement.MeasurementUnit, measurementMedium?: ConcentrationMeasurement.MeasurementMedium): this;
|
|
1108
|
-
/**
|
|
1109
|
-
* Create a default Pm10ConcentrationMeasurement cluster server with feature NumericMeasurement.
|
|
1110
|
-
*
|
|
1111
|
-
* @param {number | null} measuredValue - The measured value of the concentration.
|
|
1112
|
-
* @param {ConcentrationMeasurement.MeasurementUnit} measurementUnit - The unit of measurement (default to ConcentrationMeasurement.MeasurementUnit.Ppm).
|
|
1113
|
-
* @param {ConcentrationMeasurement.MeasurementMedium} measurementMedium - The unit of measurement (default to ConcentrationMeasurement.MeasurementMedium.Air).
|
|
1114
|
-
* @returns {this} The current MatterbridgeEndpoint instance for chaining.
|
|
1115
|
-
*/
|
|
1116
|
-
createDefaultPm10ConcentrationMeasurementClusterServer(measuredValue?: number | null, measurementUnit?: ConcentrationMeasurement.MeasurementUnit, measurementMedium?: ConcentrationMeasurement.MeasurementMedium): this;
|
|
1117
|
-
/**
|
|
1118
|
-
* Create a default OzoneConcentrationMeasurement cluster server with feature NumericMeasurement.
|
|
1119
|
-
*
|
|
1120
|
-
* @param {number | null} measuredValue - The measured value of the concentration.
|
|
1121
|
-
* @param {ConcentrationMeasurement.MeasurementUnit} measurementUnit - The unit of measurement (default to ConcentrationMeasurement.MeasurementUnit.Ugm3).
|
|
1122
|
-
* @param {ConcentrationMeasurement.MeasurementMedium} measurementMedium - The unit of measurement (default to ConcentrationMeasurement.MeasurementMedium.Air).
|
|
1123
|
-
* @returns {this} The current MatterbridgeEndpoint instance for chaining.
|
|
1124
|
-
*/
|
|
1125
|
-
createDefaultOzoneConcentrationMeasurementClusterServer(measuredValue?: number | null, measurementUnit?: ConcentrationMeasurement.MeasurementUnit, measurementMedium?: ConcentrationMeasurement.MeasurementMedium): this;
|
|
1126
|
-
/**
|
|
1127
|
-
* Create a default RadonConcentrationMeasurement cluster server with feature NumericMeasurement.
|
|
1128
|
-
*
|
|
1129
|
-
* @param {number | null} measuredValue - The measured value of the concentration.
|
|
1130
|
-
* @param {ConcentrationMeasurement.MeasurementUnit} measurementUnit - The unit of measurement (default to ConcentrationMeasurement.MeasurementUnit.Ppm).
|
|
1131
|
-
* @param {ConcentrationMeasurement.MeasurementMedium} measurementMedium - The unit of measurement (default to ConcentrationMeasurement.MeasurementMedium.Air).
|
|
1132
|
-
* @returns {this} The current MatterbridgeEndpoint instance for chaining.
|
|
1133
|
-
*/
|
|
1134
|
-
createDefaultRadonConcentrationMeasurementClusterServer(measuredValue?: number | null, measurementUnit?: ConcentrationMeasurement.MeasurementUnit, measurementMedium?: ConcentrationMeasurement.MeasurementMedium): this;
|
|
1135
|
-
/**
|
|
1136
|
-
* Create a default NitrogenDioxideConcentrationMeasurement cluster server with feature NumericMeasurement.
|
|
1137
|
-
*
|
|
1138
|
-
* @param {number | null} measuredValue - The measured value of the concentration.
|
|
1139
|
-
* @param {ConcentrationMeasurement.MeasurementUnit} measurementUnit - The unit of measurement (default to ConcentrationMeasurement.MeasurementUnit.Ugm3).
|
|
1140
|
-
* @param {ConcentrationMeasurement.MeasurementMedium} measurementMedium - The unit of measurement (default to ConcentrationMeasurement.MeasurementMedium.Air).
|
|
1141
|
-
* @returns {this} The current MatterbridgeEndpoint instance for chaining.
|
|
1142
|
-
*/
|
|
1143
|
-
createDefaultNitrogenDioxideConcentrationMeasurementClusterServer(measuredValue?: number | null, measurementUnit?: ConcentrationMeasurement.MeasurementUnit, measurementMedium?: ConcentrationMeasurement.MeasurementMedium): this;
|
|
1144
|
-
}
|
|
1145
|
-
//# sourceMappingURL=matterbridgeEndpoint.d.ts.map
|