homebridge 2.5.1-beta.2 → 2.5.1-beta.3
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/dist/api.d.ts +253 -35
- package/dist/api.js +93 -5
- package/dist/api.js.map +1 -1
- package/dist/bridgeService.d.ts +63 -6
- package/dist/bridgeService.js +401 -99
- package/dist/bridgeService.js.map +1 -1
- package/dist/childBridgeFork.d.ts +12 -9
- package/dist/childBridgeFork.js +126 -40
- package/dist/childBridgeFork.js.map +1 -1
- package/dist/childBridgeService.d.ts +107 -28
- package/dist/childBridgeService.js +225 -28
- package/dist/childBridgeService.js.map +1 -1
- package/dist/cli.d.ts +0 -1
- package/dist/cli.js +28 -7
- package/dist/cli.js.map +1 -1
- package/dist/externalPortService.d.ts +4 -1
- package/dist/externalPortService.js +16 -4
- package/dist/externalPortService.js.map +1 -1
- package/dist/index.d.ts +36 -10
- package/dist/index.js +20 -4
- package/dist/index.js.map +1 -1
- package/dist/ipcService.d.ts +27 -12
- package/dist/ipcService.js +19 -6
- package/dist/ipcService.js.map +1 -1
- package/dist/logger.d.ts +10 -4
- package/dist/logger.js +27 -14
- package/dist/logger.js.map +1 -1
- package/dist/matter/BaseMatterManager.d.ts +36 -1
- package/dist/matter/BaseMatterManager.js +96 -39
- package/dist/matter/BaseMatterManager.js.map +1 -1
- package/dist/matter/ChildBridgeMatterManager.d.ts +27 -14
- package/dist/matter/ChildBridgeMatterManager.js +220 -62
- package/dist/matter/ChildBridgeMatterManager.js.map +1 -1
- package/dist/matter/ChildBridgeMatterMessageHandler.d.ts +3 -9
- package/dist/matter/ChildBridgeMatterMessageHandler.js +21 -7
- package/dist/matter/ChildBridgeMatterMessageHandler.js.map +1 -1
- package/dist/matter/ClusterCommandMapper.d.ts +21 -14
- package/dist/matter/ClusterCommandMapper.js +143 -84
- package/dist/matter/ClusterCommandMapper.js.map +1 -1
- package/dist/matter/ExternalMatterAccessoryPublisher.d.ts +2 -1
- package/dist/matter/ExternalMatterAccessoryPublisher.js +29 -18
- package/dist/matter/ExternalMatterAccessoryPublisher.js.map +1 -1
- package/dist/matter/MatterAPIImpl.d.ts +62 -41
- package/dist/matter/MatterAPIImpl.js +62 -47
- package/dist/matter/MatterAPIImpl.js.map +1 -1
- package/dist/matter/MatterBridgeManager.d.ts +2 -1
- package/dist/matter/MatterBridgeManager.js +58 -35
- package/dist/matter/MatterBridgeManager.js.map +1 -1
- package/dist/matter/MatterError.d.ts +15 -1
- package/dist/matter/MatterError.js +53 -1
- package/dist/matter/MatterError.js.map +1 -1
- package/dist/matter/MatterPortAllocator.d.ts +6 -1
- package/dist/matter/MatterPortAllocator.js +8 -0
- package/dist/matter/MatterPortAllocator.js.map +1 -1
- package/dist/matter/SwitchAPI.d.ts +0 -1
- package/dist/matter/accessoryCache.d.ts +49 -2
- package/dist/matter/accessoryCache.js +106 -3
- package/dist/matter/accessoryCache.js.map +1 -1
- package/dist/matter/behaviors/BehaviorRegistry.d.ts +39 -12
- package/dist/matter/behaviors/BehaviorRegistry.js +102 -63
- package/dist/matter/behaviors/BehaviorRegistry.js.map +1 -1
- package/dist/matter/behaviors/ClosureControlBehavior.d.ts +0 -19
- package/dist/matter/behaviors/ClosureControlBehavior.js +102 -68
- package/dist/matter/behaviors/ClosureControlBehavior.js.map +1 -1
- package/dist/matter/behaviors/ColorControlBehavior.d.ts +30 -10
- package/dist/matter/behaviors/ColorControlBehavior.js +130 -175
- package/dist/matter/behaviors/ColorControlBehavior.js.map +1 -1
- package/dist/matter/behaviors/DeviceEnergyManagementBehavior.d.ts +3 -6
- package/dist/matter/behaviors/DeviceEnergyManagementBehavior.js +35 -91
- package/dist/matter/behaviors/DeviceEnergyManagementBehavior.js.map +1 -1
- package/dist/matter/behaviors/DoorLockBehavior.d.ts +9 -10
- package/dist/matter/behaviors/DoorLockBehavior.js +41 -62
- package/dist/matter/behaviors/DoorLockBehavior.js.map +1 -1
- package/dist/matter/behaviors/EndpointContext.d.ts +7 -1
- package/dist/matter/behaviors/EndpointContext.js +8 -0
- package/dist/matter/behaviors/EndpointContext.js.map +1 -1
- package/dist/matter/behaviors/EnergyEvseBehavior.d.ts +6 -4
- package/dist/matter/behaviors/EnergyEvseBehavior.js +52 -76
- package/dist/matter/behaviors/EnergyEvseBehavior.js.map +1 -1
- package/dist/matter/behaviors/FanControlBehavior.d.ts +1 -6
- package/dist/matter/behaviors/FanControlBehavior.js +34 -56
- package/dist/matter/behaviors/FanControlBehavior.js.map +1 -1
- package/dist/matter/behaviors/IdentifyBehavior.d.ts +2 -5
- package/dist/matter/behaviors/IdentifyBehavior.js +26 -25
- package/dist/matter/behaviors/IdentifyBehavior.js.map +1 -1
- package/dist/matter/behaviors/KeypadInputBehavior.d.ts +0 -5
- package/dist/matter/behaviors/KeypadInputBehavior.js +18 -13
- package/dist/matter/behaviors/KeypadInputBehavior.js.map +1 -1
- package/dist/matter/behaviors/LevelControlBehavior.d.ts +41 -10
- package/dist/matter/behaviors/LevelControlBehavior.js +173 -191
- package/dist/matter/behaviors/LevelControlBehavior.js.map +1 -1
- package/dist/matter/behaviors/MediaPlaybackBehavior.d.ts +0 -5
- package/dist/matter/behaviors/MediaPlaybackBehavior.js +14 -10
- package/dist/matter/behaviors/MediaPlaybackBehavior.js.map +1 -1
- package/dist/matter/behaviors/OnOffBehavior.d.ts +1 -6
- package/dist/matter/behaviors/OnOffBehavior.js +41 -76
- package/dist/matter/behaviors/OnOffBehavior.js.map +1 -1
- package/dist/matter/behaviors/RegistryManager.d.ts +0 -1
- package/dist/matter/behaviors/RvcCleanModeBehavior.d.ts +0 -5
- package/dist/matter/behaviors/RvcCleanModeBehavior.js +9 -47
- package/dist/matter/behaviors/RvcCleanModeBehavior.js.map +1 -1
- package/dist/matter/behaviors/RvcOperationalStateBehavior.d.ts +5 -8
- package/dist/matter/behaviors/RvcOperationalStateBehavior.js +41 -38
- package/dist/matter/behaviors/RvcOperationalStateBehavior.js.map +1 -1
- package/dist/matter/behaviors/RvcRunModeBehavior.d.ts +3 -14
- package/dist/matter/behaviors/RvcRunModeBehavior.js +4 -50
- package/dist/matter/behaviors/RvcRunModeBehavior.js.map +1 -1
- package/dist/matter/behaviors/ServiceAreaBehavior.d.ts +1 -6
- package/dist/matter/behaviors/ServiceAreaBehavior.js +42 -51
- package/dist/matter/behaviors/ServiceAreaBehavior.js.map +1 -1
- package/dist/matter/behaviors/ThermostatBehavior.d.ts +6 -6
- package/dist/matter/behaviors/ThermostatBehavior.js +83 -106
- package/dist/matter/behaviors/ThermostatBehavior.js.map +1 -1
- package/dist/matter/behaviors/ValveConfigurationAndControlBehavior.d.ts +0 -5
- package/dist/matter/behaviors/ValveConfigurationAndControlBehavior.js +34 -57
- package/dist/matter/behaviors/ValveConfigurationAndControlBehavior.js.map +1 -1
- package/dist/matter/behaviors/WaterHeaterBehavior.d.ts +1 -4
- package/dist/matter/behaviors/WaterHeaterBehavior.js +14 -62
- package/dist/matter/behaviors/WaterHeaterBehavior.js.map +1 -1
- package/dist/matter/behaviors/WindowCoveringBehavior.d.ts +19 -10
- package/dist/matter/behaviors/WindowCoveringBehavior.js +94 -141
- package/dist/matter/behaviors/WindowCoveringBehavior.js.map +1 -1
- package/dist/matter/behaviors/handlerResponse.d.ts +47 -0
- package/dist/matter/behaviors/handlerResponse.js +79 -0
- package/dist/matter/behaviors/handlerResponse.js.map +1 -0
- package/dist/matter/behaviors/handlerScope.d.ts +16 -0
- package/dist/matter/behaviors/handlerScope.js +23 -0
- package/dist/matter/behaviors/handlerScope.js.map +1 -0
- package/dist/matter/behaviors/index.d.ts +0 -3
- package/dist/matter/behaviors/index.js +0 -7
- package/dist/matter/behaviors/index.js.map +1 -1
- package/dist/matter/behaviors/pluginUpdates.d.ts +35 -0
- package/dist/matter/behaviors/pluginUpdates.js +74 -0
- package/dist/matter/behaviors/pluginUpdates.js.map +1 -0
- package/dist/matter/behaviors/revertFailedChange.d.ts +28 -0
- package/dist/matter/behaviors/revertFailedChange.js +40 -0
- package/dist/matter/behaviors/revertFailedChange.js.map +1 -0
- package/dist/matter/behaviors/stateLock.d.ts +20 -0
- package/dist/matter/behaviors/stateLock.js +36 -0
- package/dist/matter/behaviors/stateLock.js.map +1 -0
- package/dist/matter/clusterFeatures.d.ts +0 -1
- package/dist/matter/clusterFeatures.js.map +1 -1
- package/dist/matter/clusterHandlerMap.d.ts +116 -25
- package/dist/matter/clusterHandlerMap.js +8 -0
- package/dist/matter/clusterHandlerMap.js.map +1 -1
- package/dist/matter/clusterStateMap.d.ts +9 -3
- package/dist/matter/clusterTypes.d.ts +66 -7
- package/dist/matter/clusterTypes.js +5 -3
- package/dist/matter/clusterTypes.js.map +1 -1
- package/dist/matter/config.d.ts +2 -3
- package/dist/matter/config.js +30 -31
- package/dist/matter/config.js.map +1 -1
- package/dist/matter/configValidator.d.ts +11 -1
- package/dist/matter/configValidator.js +36 -14
- package/dist/matter/configValidator.js.map +1 -1
- package/dist/matter/errorHandler.d.ts +22 -5
- package/dist/matter/errorHandler.js +62 -17
- package/dist/matter/errorHandler.js.map +1 -1
- package/dist/matter/errors.d.ts +0 -1
- package/dist/matter/index.d.ts +0 -1
- package/dist/matter/ipc-types.d.ts +40 -2
- package/dist/matter/logFormatter.d.ts +17 -1
- package/dist/matter/logFormatter.js +32 -32
- package/dist/matter/logFormatter.js.map +1 -1
- package/dist/matter/managerTypes.d.ts +10 -45
- package/dist/matter/processConfig.d.ts +15 -0
- package/dist/matter/processConfig.js +60 -0
- package/dist/matter/processConfig.js.map +1 -0
- package/dist/matter/server/AccessoryManager.d.ts +83 -19
- package/dist/matter/server/AccessoryManager.js +447 -226
- package/dist/matter/server/AccessoryManager.js.map +1 -1
- package/dist/matter/server/AccessoryQuery.d.ts +3 -3
- package/dist/matter/server/AccessoryQuery.js +40 -12
- package/dist/matter/server/AccessoryQuery.js.map +1 -1
- package/dist/matter/server/BehaviorMap.d.ts +4 -20
- package/dist/matter/server/BehaviorMap.js +4 -28
- package/dist/matter/server/BehaviorMap.js.map +1 -1
- package/dist/matter/server/CommissioningManager.d.ts +3 -16
- package/dist/matter/server/CommissioningManager.js +109 -137
- package/dist/matter/server/CommissioningManager.js.map +1 -1
- package/dist/matter/server/FabricManager.d.ts +9 -22
- package/dist/matter/server/FabricManager.js +32 -170
- package/dist/matter/server/FabricManager.js.map +1 -1
- package/dist/matter/server/ServerConfig.d.ts +0 -5
- package/dist/matter/server/ServerConfig.js +1 -4
- package/dist/matter/server/ServerConfig.js.map +1 -1
- package/dist/matter/server/ServerLifecycle.d.ts +64 -19
- package/dist/matter/server/ServerLifecycle.js +268 -174
- package/dist/matter/server/ServerLifecycle.js.map +1 -1
- package/dist/matter/server/StateManager.d.ts +17 -2
- package/dist/matter/server/StateManager.js +104 -52
- package/dist/matter/server/StateManager.js.map +1 -1
- package/dist/matter/server/index.d.ts +2 -3
- package/dist/matter/server/index.js +2 -2
- package/dist/matter/server/index.js.map +1 -1
- package/dist/matter/server/storageLock.d.ts +35 -0
- package/dist/matter/server/storageLock.js +121 -0
- package/dist/matter/server/storageLock.js.map +1 -0
- package/dist/matter/server.d.ts +20 -22
- package/dist/matter/server.js +129 -66
- package/dist/matter/server.js.map +1 -1
- package/dist/matter/serverHelpers.d.ts +17 -71
- package/dist/matter/serverHelpers.js +88 -207
- package/dist/matter/serverHelpers.js.map +1 -1
- package/dist/matter/sharedTypes.d.ts +7 -2
- package/dist/matter/sharedTypes.js.map +1 -1
- package/dist/matter/types.d.ts +121 -88
- package/dist/matter/types.js +62 -22
- package/dist/matter/types.js.map +1 -1
- package/dist/matter/utils.d.ts +32 -5
- package/dist/matter/utils.js +63 -14
- package/dist/matter/utils.js.map +1 -1
- package/dist/matterExports.d.ts +30 -0
- package/dist/matterExports.js +23 -0
- package/dist/matterExports.js.map +1 -0
- package/dist/platformAccessory.d.ts +54 -9
- package/dist/platformAccessory.js +38 -5
- package/dist/platformAccessory.js.map +1 -1
- package/dist/plugin.d.ts +0 -4
- package/dist/plugin.js +65 -33
- package/dist/plugin.js.map +1 -1
- package/dist/pluginManager.d.ts +38 -4
- package/dist/pluginManager.js +123 -66
- package/dist/pluginManager.js.map +1 -1
- package/dist/server.d.ts +38 -11
- package/dist/server.js +286 -118
- package/dist/server.js.map +1 -1
- package/dist/storageService.d.ts +12 -6
- package/dist/storageService.js +39 -16
- package/dist/storageService.js.map +1 -1
- package/dist/user.d.ts +0 -1
- package/dist/util/errorMessage.d.ts +6 -0
- package/dist/util/errorMessage.js +15 -0
- package/dist/util/errorMessage.js.map +1 -0
- package/dist/util/ipc.d.ts +12 -0
- package/dist/util/ipc.js +25 -0
- package/dist/util/ipc.js.map +1 -0
- package/dist/util/mac.d.ts +1 -2
- package/dist/util/mac.js.map +1 -1
- package/dist/util/pin.d.ts +19 -0
- package/dist/util/pin.js +43 -0
- package/dist/util/pin.js.map +1 -0
- package/dist/util/port.d.ts +11 -0
- package/dist/util/port.js +24 -0
- package/dist/util/port.js.map +1 -0
- package/dist/version.d.ts +0 -1
- package/package.json +28 -17
- package/dist/api.d.ts.map +0 -1
- package/dist/bridgeService.d.ts.map +0 -1
- package/dist/childBridgeFork.d.ts.map +0 -1
- package/dist/childBridgeService.d.ts.map +0 -1
- package/dist/cli.d.ts.map +0 -1
- package/dist/externalPortService.d.ts.map +0 -1
- package/dist/index.d.ts.map +0 -1
- package/dist/ipcService.d.ts.map +0 -1
- package/dist/logger.d.ts.map +0 -1
- package/dist/matter/BaseMatterManager.d.ts.map +0 -1
- package/dist/matter/ChildBridgeMatterManager.d.ts.map +0 -1
- package/dist/matter/ChildBridgeMatterMessageHandler.d.ts.map +0 -1
- package/dist/matter/ClusterCommandMapper.d.ts.map +0 -1
- package/dist/matter/ExternalMatterAccessoryPublisher.d.ts.map +0 -1
- package/dist/matter/MatterAPIImpl.d.ts.map +0 -1
- package/dist/matter/MatterBridgeManager.d.ts.map +0 -1
- package/dist/matter/MatterError.d.ts.map +0 -1
- package/dist/matter/MatterPortAllocator.d.ts.map +0 -1
- package/dist/matter/SwitchAPI.d.ts.map +0 -1
- package/dist/matter/accessoryCache.d.ts.map +0 -1
- package/dist/matter/behaviors/AirQualityBehavior.d.ts +0 -44
- package/dist/matter/behaviors/AirQualityBehavior.d.ts.map +0 -1
- package/dist/matter/behaviors/AirQualityBehavior.js +0 -48
- package/dist/matter/behaviors/AirQualityBehavior.js.map +0 -1
- package/dist/matter/behaviors/BehaviorRegistry.d.ts.map +0 -1
- package/dist/matter/behaviors/ClosureControlBehavior.d.ts.map +0 -1
- package/dist/matter/behaviors/ColorControlBehavior.d.ts.map +0 -1
- package/dist/matter/behaviors/ConcentrationMeasurementBehavior.d.ts +0 -117
- package/dist/matter/behaviors/ConcentrationMeasurementBehavior.d.ts.map +0 -1
- package/dist/matter/behaviors/ConcentrationMeasurementBehavior.js +0 -132
- package/dist/matter/behaviors/ConcentrationMeasurementBehavior.js.map +0 -1
- package/dist/matter/behaviors/DeviceEnergyManagementBehavior.d.ts.map +0 -1
- package/dist/matter/behaviors/DoorLockBehavior.d.ts.map +0 -1
- package/dist/matter/behaviors/EndpointContext.d.ts.map +0 -1
- package/dist/matter/behaviors/EnergyEvseBehavior.d.ts.map +0 -1
- package/dist/matter/behaviors/FanControlBehavior.d.ts.map +0 -1
- package/dist/matter/behaviors/IdentifyBehavior.d.ts.map +0 -1
- package/dist/matter/behaviors/KeypadInputBehavior.d.ts.map +0 -1
- package/dist/matter/behaviors/LevelControlBehavior.d.ts.map +0 -1
- package/dist/matter/behaviors/MediaPlaybackBehavior.d.ts.map +0 -1
- package/dist/matter/behaviors/OnOffBehavior.d.ts.map +0 -1
- package/dist/matter/behaviors/RegistryManager.d.ts.map +0 -1
- package/dist/matter/behaviors/RvcCleanModeBehavior.d.ts.map +0 -1
- package/dist/matter/behaviors/RvcOperationalStateBehavior.d.ts.map +0 -1
- package/dist/matter/behaviors/RvcRunModeBehavior.d.ts.map +0 -1
- package/dist/matter/behaviors/ServiceAreaBehavior.d.ts.map +0 -1
- package/dist/matter/behaviors/ThermostatBehavior.d.ts.map +0 -1
- package/dist/matter/behaviors/ValveConfigurationAndControlBehavior.d.ts.map +0 -1
- package/dist/matter/behaviors/WaterHeaterBehavior.d.ts.map +0 -1
- package/dist/matter/behaviors/WindowCoveringBehavior.d.ts.map +0 -1
- package/dist/matter/behaviors/index.d.ts.map +0 -1
- package/dist/matter/clusterFeatures.d.ts.map +0 -1
- package/dist/matter/clusterHandlerMap.d.ts.map +0 -1
- package/dist/matter/clusterStateMap.d.ts.map +0 -1
- package/dist/matter/clusterTypes.d.ts.map +0 -1
- package/dist/matter/config.d.ts.map +0 -1
- package/dist/matter/configValidator.d.ts.map +0 -1
- package/dist/matter/errorHandler.d.ts.map +0 -1
- package/dist/matter/errors.d.ts.map +0 -1
- package/dist/matter/index.d.ts.map +0 -1
- package/dist/matter/ipc-types.d.ts.map +0 -1
- package/dist/matter/logFormatter.d.ts.map +0 -1
- package/dist/matter/managerTypes.d.ts.map +0 -1
- package/dist/matter/server/AccessoryManager.d.ts.map +0 -1
- package/dist/matter/server/AccessoryQuery.d.ts.map +0 -1
- package/dist/matter/server/BehaviorMap.d.ts.map +0 -1
- package/dist/matter/server/CommissioningManager.d.ts.map +0 -1
- package/dist/matter/server/FabricManager.d.ts.map +0 -1
- package/dist/matter/server/ServerConfig.d.ts.map +0 -1
- package/dist/matter/server/ServerLifecycle.d.ts.map +0 -1
- package/dist/matter/server/StateManager.d.ts.map +0 -1
- package/dist/matter/server/index.d.ts.map +0 -1
- package/dist/matter/server.d.ts.map +0 -1
- package/dist/matter/serverHelpers.d.ts.map +0 -1
- package/dist/matter/sharedTypes.d.ts.map +0 -1
- package/dist/matter/types.d.ts.map +0 -1
- package/dist/matter/utils.d.ts.map +0 -1
- package/dist/platformAccessory.d.ts.map +0 -1
- package/dist/plugin.d.ts.map +0 -1
- package/dist/pluginManager.d.ts.map +0 -1
- package/dist/server.d.ts.map +0 -1
- package/dist/storageService.d.ts.map +0 -1
- package/dist/user.d.ts.map +0 -1
- package/dist/util/mac.d.ts.map +0 -1
- package/dist/version.d.ts.map +0 -1
package/dist/api.d.ts
CHANGED
|
@@ -17,6 +17,16 @@ export type AccessoryName = string;
|
|
|
17
17
|
export type PlatformName = string;
|
|
18
18
|
export type AccessoryIdentifier = string;
|
|
19
19
|
export type PlatformIdentifier = string;
|
|
20
|
+
/**
|
|
21
|
+
* The two kinds of plugin: an accessory plugin or a platform plugin.
|
|
22
|
+
*
|
|
23
|
+
* This is a `const enum`. A plugin built with plain `tsc` gets the value written into its code at
|
|
24
|
+
* compile time. A plugin built with `isolatedModules` or `verbatimModuleSyntax` (esbuild, tsx, swc,
|
|
25
|
+
* Vite) can not use it: TypeScript reports TS2748 ("Cannot access ambient const enums"). Write the text
|
|
26
|
+
* value instead: `'accessory'` or `'platform'`.
|
|
27
|
+
* It stays a `const enum` for now: as a normal enum, every plugin built with plain `tsc` would start
|
|
28
|
+
* to import the `homebridge` package at run time.
|
|
29
|
+
*/
|
|
20
30
|
export declare const enum PluginType {
|
|
21
31
|
ACCESSORY = "accessory",
|
|
22
32
|
PLATFORM = "platform"
|
|
@@ -89,7 +99,18 @@ export interface DynamicPlatformPlugin extends PlatformPlugin {
|
|
|
89
99
|
* It should be used to track cached accessories so the plugin can determine which accessories
|
|
90
100
|
* to re-register and which to remove (if they no longer exist in the external system).
|
|
91
101
|
*
|
|
92
|
-
* This is the Matter equivalent of configureAccessory for HAP accessories
|
|
102
|
+
* This is the Matter equivalent of configureAccessory for HAP accessories, with these differences:
|
|
103
|
+
* - The object is a copy of the cached data, not the live accessory. Its `deviceType` is only
|
|
104
|
+
* the cached name (`{ name, clusterFeatures }`), not a real device type, and its `parts` have
|
|
105
|
+
* no handlers. Read `UUID`, `displayName`, `context` and the device information from it, and
|
|
106
|
+
* build a new accessory to register. Do not pass this object to `registerPlatformAccessories()`.
|
|
107
|
+
* It is fine to pass it to `updatePlatformAccessories()` and `unregisterPlatformAccessories()`.
|
|
108
|
+
* - Every accessory must be registered again at every start (see `registerPlatformAccessories()`).
|
|
109
|
+
* - It is not called for an external accessory (a robot vacuum cleaner): only the accessories
|
|
110
|
+
* of the bridge are cached. Nothing is kept for an external accessory but its pairing.
|
|
111
|
+
* - `context`: the `context` of the registered object is used. The cached context is kept
|
|
112
|
+
* only when the registered object has none (no `context`, or an empty one). To be sure a
|
|
113
|
+
* value is kept, copy the cached `context` into the accessory you register.
|
|
93
114
|
*
|
|
94
115
|
* @param {MatterAccessory} accessory - cached Matter accessory
|
|
95
116
|
*/
|
|
@@ -118,16 +139,29 @@ export interface StaticPlatformPlugin extends PlatformPlugin {
|
|
|
118
139
|
*/
|
|
119
140
|
export interface IndependentPlatformPlugin extends PlatformPlugin {
|
|
120
141
|
}
|
|
142
|
+
/**
|
|
143
|
+
* The events a plugin can listen for on the {@link API} object.
|
|
144
|
+
*
|
|
145
|
+
* This is a `const enum`. A plugin built with plain `tsc` gets the value written into its code at
|
|
146
|
+
* compile time. A plugin built with `isolatedModules` or `verbatimModuleSyntax` (esbuild, tsx, swc,
|
|
147
|
+
* Vite) can not use it: TypeScript reports TS2748 ("Cannot access ambient const enums"). Write the text
|
|
148
|
+
* value instead, which is typed the same: `api.on('didFinishLaunching', ...)`, `api.on('shutdown', ...)`.
|
|
149
|
+
* It stays a `const enum` for now: as a normal enum, every plugin built with plain `tsc` would start
|
|
150
|
+
* to import the `homebridge` package at run time.
|
|
151
|
+
*/
|
|
121
152
|
export declare const enum APIEvent {
|
|
122
153
|
/**
|
|
123
154
|
* Event is fired once homebridge has finished with booting up and initializing all components and plugins.
|
|
124
155
|
* When this event is fired it is possible that the Bridge accessory isn't published yet, if homebridge still needs
|
|
125
|
-
* to wait for some {@
|
|
156
|
+
* to wait for some {@link StaticPlatformPlugin | StaticPlatformPlugins} to finish accessory creation.
|
|
126
157
|
*/
|
|
127
158
|
DID_FINISH_LAUNCHING = "didFinishLaunching",
|
|
128
159
|
/**
|
|
129
160
|
* This event is fired when homebridge gets shutdown. This could be a regular shutdown or an unexpected crash.
|
|
130
161
|
* At this stage all Accessories are already unpublished and all PlatformAccessories are already saved to disk!
|
|
162
|
+
*
|
|
163
|
+
* That is true for HomeKit only. The Matter servers are stopped, and the Matter accessory cache is
|
|
164
|
+
* saved, after this event: Matter accessories are still published while the listeners run.
|
|
131
165
|
*/
|
|
132
166
|
SHUTDOWN = "shutdown"
|
|
133
167
|
}
|
|
@@ -164,18 +198,48 @@ export type MatterWorkTracker = (work: Promise<void>) => void;
|
|
|
164
198
|
* undefined otherwise. Plugins must use optional chaining or guard
|
|
165
199
|
* with `isMatterEnabled()`.
|
|
166
200
|
*
|
|
201
|
+
* How this differs from the HomeKit side of the API:
|
|
202
|
+
* - **Platform plugins only.** Registering and restoring Matter accessories needs
|
|
203
|
+
* a dynamic platform (`api.registerPlatform()`). An accessory plugin
|
|
204
|
+
* (`api.registerAccessory()`) has no way to expose a Matter accessory, and a
|
|
205
|
+
* `matter` block on an accessory child bridge is ignored with a warning.
|
|
206
|
+
* - **The accessory is a plain object, and Homebridge keeps its own copy.**
|
|
207
|
+
* A `PlatformAccessory` is live: change it and HomeKit sees it. A
|
|
208
|
+
* `MatterAccessory` is copied at registration, so changing your object
|
|
209
|
+
* afterwards does nothing. Send state with `updateAccessoryState()`, and a new
|
|
210
|
+
* name, device information or `context` with `updatePlatformAccessories()`.
|
|
211
|
+
* - **There is no `publishExternalAccessories()` for Matter.** Homebridge
|
|
212
|
+
* decides from the device type: a `RoboticVacuumCleaner` is published on its
|
|
213
|
+
* own (its own pairing code), every other type goes on the bridge. A plugin
|
|
214
|
+
* can not choose either way.
|
|
215
|
+
* - **There is no general "a value was written" handler** like HAP's `onSet`.
|
|
216
|
+
* See `MatterAccessory.handlers` for what reaches a plugin.
|
|
217
|
+
* - **Never depend on the `@matter/*` packages in a plugin.** Use what
|
|
218
|
+
* `api.matter` carries (`deviceTypes`, `deviceRequirements`, `clusters`,
|
|
219
|
+
* `status`). A second copy of matter.js in the process has its own classes,
|
|
220
|
+
* so a status error or device type built from it is not recognised by
|
|
221
|
+
* Homebridge's copy, and it costs about 150 MB of memory.
|
|
222
|
+
*
|
|
167
223
|
* @example
|
|
168
224
|
* ```typescript
|
|
169
|
-
* // Defensive pattern (recommended for plugins that work with or without Matter)
|
|
170
|
-
*
|
|
171
|
-
*
|
|
172
|
-
*
|
|
173
|
-
*
|
|
174
|
-
*
|
|
175
|
-
*
|
|
176
|
-
*
|
|
177
|
-
*
|
|
178
|
-
*
|
|
225
|
+
* // Defensive pattern (recommended for plugins that work with or without Matter).
|
|
226
|
+
* // The Matter methods return promises, and a registration is rejected when it can
|
|
227
|
+
* // not be done (for example when the Matter server of the bridge did not start).
|
|
228
|
+
* // Always await them and catch the error: a rejection nobody handles ends Homebridge.
|
|
229
|
+
* try {
|
|
230
|
+
* await api.matter?.registerPlatformAccessories('homebridge-example', 'Example', [{
|
|
231
|
+
* UUID: api.hap.uuid.generate('my-light'),
|
|
232
|
+
* displayName: 'Living Room Light',
|
|
233
|
+
* deviceType: api.matter!.deviceTypes.OnOffLight,
|
|
234
|
+
* manufacturer: 'Example',
|
|
235
|
+
* model: 'Example Light',
|
|
236
|
+
* serialNumber: 'EX-001',
|
|
237
|
+
* context: {},
|
|
238
|
+
* clusters: { onOff: { onOff: false } },
|
|
239
|
+
* }])
|
|
240
|
+
* } catch (error) {
|
|
241
|
+
* log.error('Could not register the Matter accessory:', error)
|
|
242
|
+
* }
|
|
179
243
|
*
|
|
180
244
|
* // Update state when device changes externally
|
|
181
245
|
* await api.matter?.updateAccessoryState(uuid, 'onOff', { onOff: true })
|
|
@@ -202,18 +266,35 @@ export interface MatterAPI {
|
|
|
202
266
|
*
|
|
203
267
|
* @example
|
|
204
268
|
* ```typescript
|
|
205
|
-
* const
|
|
206
|
-
* api.matter?.
|
|
207
|
-
*
|
|
269
|
+
* const UUID = api.matter?.uuid.generate('my-light-unique-id')
|
|
270
|
+
* await api.matter?.registerPlatformAccessories('homebridge-example', 'Example', [{
|
|
271
|
+
* UUID,
|
|
208
272
|
* displayName: 'Living Room Light',
|
|
209
273
|
* // ...
|
|
210
|
-
* })
|
|
274
|
+
* }])
|
|
211
275
|
* ```
|
|
212
276
|
*/
|
|
213
277
|
readonly uuid: HAP['uuid'];
|
|
214
278
|
/**
|
|
215
279
|
* Matter device types for creating accessories.
|
|
216
280
|
* Maps friendly names to Matter.js device types, including stateless controller types like `GenericSwitch`.
|
|
281
|
+
*
|
|
282
|
+
* Most names are the Matter name of the device type (`OnOffLight`,
|
|
283
|
+
* `DimmableLight`, `WindowCovering`). Some are friendlier names for a Matter
|
|
284
|
+
* type that is called something else:
|
|
285
|
+
*
|
|
286
|
+
* | Name here | Matter device type |
|
|
287
|
+
* |---|---|
|
|
288
|
+
* | `OnOffSwitch` | On/Off Light Switch |
|
|
289
|
+
* | `OnOffOutlet` | On/Off Plug-in Unit |
|
|
290
|
+
* | `DimmableOutlet` | Dimmable Plug-in Unit |
|
|
291
|
+
* | `MotionSensor` | Occupancy Sensor |
|
|
292
|
+
* | `LeakSensor` | Water Leak Detector |
|
|
293
|
+
* | `SmokeSensor` | Smoke CO Alarm |
|
|
294
|
+
* | `MediaPlayer` | Basic Video Player |
|
|
295
|
+
*
|
|
296
|
+
* The raw matter.js device types are not on `api.matter`. Compose on top of
|
|
297
|
+
* these with `.with(...)` and {@link deviceRequirements}.
|
|
217
298
|
*/
|
|
218
299
|
readonly deviceTypes: typeof deviceTypes;
|
|
219
300
|
/**
|
|
@@ -232,11 +313,17 @@ export interface MatterAPI {
|
|
|
232
313
|
* api.matter.deviceRequirements.Thermostat.ThermostatServer.with('Heating', 'Cooling'),
|
|
233
314
|
* )
|
|
234
315
|
* ```
|
|
316
|
+
*
|
|
317
|
+
* @since 2.4.0
|
|
235
318
|
*/
|
|
236
319
|
readonly deviceRequirements: typeof deviceRequirements;
|
|
237
320
|
/**
|
|
238
321
|
* Matter clusters - Direct access to Matter.js cluster definitions
|
|
239
322
|
* For advanced use cases requiring low-level cluster access
|
|
323
|
+
*
|
|
324
|
+
* This is the same object as {@link types}, under a second name. It holds
|
|
325
|
+
* the clusters that have enums or feature names a plugin needs, which is
|
|
326
|
+
* fewer than {@link clusterNames} lists.
|
|
240
327
|
*/
|
|
241
328
|
readonly clusters: typeof clusters;
|
|
242
329
|
/**
|
|
@@ -254,6 +341,8 @@ export interface MatterAPI {
|
|
|
254
341
|
* Matter types - Access to Matter.js cluster type definitions and enums
|
|
255
342
|
* Use these for type-safe attribute values (modes, states, etc.)
|
|
256
343
|
*
|
|
344
|
+
* The same object as {@link clusters}. This is the name to prefer for enums.
|
|
345
|
+
*
|
|
257
346
|
* @example
|
|
258
347
|
* ```typescript
|
|
259
348
|
* Fan mode enum
|
|
@@ -288,6 +377,8 @@ export interface MatterAPI {
|
|
|
288
377
|
* }
|
|
289
378
|
* }
|
|
290
379
|
* ```
|
|
380
|
+
*
|
|
381
|
+
* @since 2.3.0
|
|
291
382
|
*/
|
|
292
383
|
readonly status: typeof MatterStatus;
|
|
293
384
|
/**
|
|
@@ -301,8 +392,28 @@ export interface MatterAPI {
|
|
|
301
392
|
* so a restored accessory answers every command with a failure until it is registered again.
|
|
302
393
|
*
|
|
303
394
|
* When an accessory is restored from the cache, its cached state is kept: the `clusters`
|
|
304
|
-
* values passed here are the starting state for a new accessory only.
|
|
305
|
-
*
|
|
395
|
+
* values passed here are the starting state for a new accessory only. One exception: a
|
|
396
|
+
* value the plugin declares differently from the last time it registered the accessory (a
|
|
397
|
+
* new `maxLevel`, a room added to `supportedAreas`) is a new setting, and it is used. To set
|
|
398
|
+
* the current state of a restored accessory, call `updateAccessoryState()` once this promise
|
|
399
|
+
* resolves (#4015).
|
|
400
|
+
*
|
|
401
|
+
* An accessory that can not be registered is logged and skipped, and the promise still
|
|
402
|
+
* resolves (HAP throws for a bad accessory). That is so for one that fails the checks here
|
|
403
|
+
* (`UUID`, `displayName`, `deviceType`, `manufacturer`, `model` and `serialNumber` are all
|
|
404
|
+
* required, and none has a default as in HAP) and for one the bridge refuses (a UUID that is
|
|
405
|
+
* already registered, a value Matter does not allow). The other accessories of the call are
|
|
406
|
+
* registered. The promise is rejected only when nothing can be registered at all: when it is
|
|
407
|
+
* called before Homebridge has finished launching, or when the Matter server of the bridge
|
|
408
|
+
* did not start.
|
|
409
|
+
*
|
|
410
|
+
* A `RoboticVacuumCleaner` is not added to the bridge. It is published on its own, with its
|
|
411
|
+
* own pairing code in the log, because controllers want it that way. There is no method to
|
|
412
|
+
* ask for this for another device type, and none to keep a vacuum on the bridge.
|
|
413
|
+
*
|
|
414
|
+
* Use the names of a platform registered with `api.registerPlatform()`: a wrong
|
|
415
|
+
* `platformName` works for this run, and at the next start the accessory is removed as an
|
|
416
|
+
* orphan, as nothing can be found to hand it back to.
|
|
306
417
|
*
|
|
307
418
|
* @param pluginIdentifier - The plugin identifier (e.g., 'homebridge-example')
|
|
308
419
|
* @param platformName - The platform name (e.g., 'ExamplePlatform')
|
|
@@ -310,22 +421,35 @@ export interface MatterAPI {
|
|
|
310
421
|
*/
|
|
311
422
|
registerPlatformAccessories: (pluginIdentifier: PluginIdentifier, platformName: PlatformName, accessories: MatterAccessory[]) => Promise<void>;
|
|
312
423
|
/**
|
|
313
|
-
* Update Matter platform accessories
|
|
424
|
+
* Update the name, device information and context of Matter platform accessories
|
|
314
425
|
*
|
|
315
|
-
* Use this to update
|
|
316
|
-
*
|
|
426
|
+
* Use this to update accessory information without unregistering and re-registering.
|
|
427
|
+
* This is useful when:
|
|
317
428
|
* - Device name changes in the external system
|
|
318
429
|
* - Firmware version gets updated
|
|
319
430
|
* - Other metadata needs to be refreshed
|
|
320
431
|
*
|
|
321
|
-
* Similar to api.updatePlatformAccessories() for HAP accessories
|
|
432
|
+
* Similar to api.updatePlatformAccessories() for HAP accessories, with one difference:
|
|
433
|
+
* Homebridge holds a copy of a Matter accessory, so a change to your own object reaches
|
|
434
|
+
* Homebridge only through this call.
|
|
322
435
|
*
|
|
323
|
-
*
|
|
436
|
+
* Only these fields are taken from each object: `displayName`, `manufacturer`, `model`,
|
|
437
|
+
* `serialNumber`, `firmwareRevision`, `hardwareRevision`, `softwareVersion` and `context`.
|
|
438
|
+
* A field that is `undefined` is left as it is. They are saved to the cache and sent to
|
|
439
|
+
* controllers at once (a controller may still keep the name its user gave the device).
|
|
440
|
+
* Nothing else is read, so the device type, parts, handlers and cluster state can not be
|
|
441
|
+
* changed this way: use `updateAccessoryState()` for state, and register the accessory
|
|
442
|
+
* again for a new structure.
|
|
443
|
+
*
|
|
444
|
+
* An accessory that is not registered is skipped with a warning. The promise resolves when
|
|
445
|
+
* the bridge has applied the update; a failure is logged, not thrown.
|
|
446
|
+
*
|
|
447
|
+
* @param accessories - Array of Matter accessories to update (each needs its `UUID`)
|
|
324
448
|
*
|
|
325
449
|
* @example
|
|
326
450
|
* ```typescript
|
|
327
451
|
* // Update the display name after it changed in the external system
|
|
328
|
-
* const accessory = cachedAccessories.find(a => a.
|
|
452
|
+
* const accessory = cachedAccessories.find(a => a.UUID === uuid)
|
|
329
453
|
* if (accessory) {
|
|
330
454
|
* accessory.displayName = 'New Name from API'
|
|
331
455
|
* await api.matter?.updatePlatformAccessories([accessory])
|
|
@@ -335,9 +459,25 @@ export interface MatterAPI {
|
|
|
335
459
|
updatePlatformAccessories: (accessories: MatterAccessory[]) => Promise<void>;
|
|
336
460
|
/**
|
|
337
461
|
* Unregister Matter platform accessories by UUID
|
|
462
|
+
*
|
|
463
|
+
* The accessory is taken off the bridge and out of the cache, and what the bridge stored
|
|
464
|
+
* for it is erased, its Matter identity included. An accessory that is not registered is
|
|
465
|
+
* ignored without an error.
|
|
466
|
+
*
|
|
467
|
+
* Unregister an accessory only when it is gone for good. Registering the same UUID again
|
|
468
|
+
* later makes a NEW device as far as a controller can tell: it may lose its room, name and
|
|
469
|
+
* automations there. To change an accessory that stays, use `updatePlatformAccessories()`
|
|
470
|
+
* (name and device information) or register it again WITHOUT unregistering first: Homebridge
|
|
471
|
+
* then rebuilds it and keeps its identity.
|
|
472
|
+
*
|
|
473
|
+
* This also works for an external accessory (a robot vacuum cleaner), which HAP can not
|
|
474
|
+
* unregister. Its own Matter server is stopped and **its pairing is deleted**: registering
|
|
475
|
+
* it again later starts a new device that has to be paired again. An external accessory a
|
|
476
|
+
* plugin simply stops registering keeps its pairing data on disk.
|
|
477
|
+
*
|
|
338
478
|
* @param pluginIdentifier - The plugin identifier
|
|
339
479
|
* @param platformName - The platform name
|
|
340
|
-
* @param accessories - Array of Matter accessories to unregister (only
|
|
480
|
+
* @param accessories - Array of Matter accessories to unregister (only `UUID` is required)
|
|
341
481
|
*/
|
|
342
482
|
unregisterPlatformAccessories: (pluginIdentifier: PluginIdentifier, platformName: PlatformName, accessories: MatterAccessory[]) => Promise<void>;
|
|
343
483
|
/**
|
|
@@ -350,7 +490,12 @@ export interface MatterAPI {
|
|
|
350
490
|
* - Polling results
|
|
351
491
|
*
|
|
352
492
|
* DO NOT use inside handlers - state auto-updates after handlers complete!
|
|
353
|
-
* Similar to HAP's characteristic.updateValue()
|
|
493
|
+
* Similar to HAP's characteristic.updateValue(): the plugin's own handlers are not called for it.
|
|
494
|
+
*
|
|
495
|
+
* The promise resolves when the bridge has applied the update. A failure (an accessory
|
|
496
|
+
* that is not registered, a value Matter does not allow) is logged, not thrown. Called from
|
|
497
|
+
* inside one of the accessory's handlers anyway, it resolves at once and the update is
|
|
498
|
+
* applied after the command: matter.js can hold the cluster's state until the handler returns.
|
|
354
499
|
*
|
|
355
500
|
* @param uuid - The UUID of the accessory
|
|
356
501
|
* @param cluster - The cluster name (use api.matter?.clusterNames for autocomplete)
|
|
@@ -439,12 +584,21 @@ export interface MatterAPI {
|
|
|
439
584
|
* await api.matter?.switch.emit(uuid, 'press')
|
|
440
585
|
* await api.matter?.switch.emit(uuid, 'release')
|
|
441
586
|
* ```
|
|
587
|
+
*
|
|
588
|
+
* @since 2.0.0
|
|
442
589
|
*/
|
|
443
590
|
readonly switch: SwitchAPI;
|
|
444
591
|
}
|
|
445
592
|
export interface API {
|
|
446
593
|
/**
|
|
447
594
|
* The homebridge API version as a floating point number.
|
|
595
|
+
*
|
|
596
|
+
* @deprecated This number has been `2.7` since Homebridge v1.3.0 (November 2020) and has not followed
|
|
597
|
+
* the additions to the API since then, so it can not be used to find out what the API supports.
|
|
598
|
+
* Use {@link versionGreaterOrEqual} (or {@link serverVersion}) instead. The value is kept as it is
|
|
599
|
+
* for plugins that read it.
|
|
600
|
+
* To test for one feature, pass the Homebridge version it arrived in to {@link versionGreaterOrEqual}
|
|
601
|
+
* (the Matter members carry a `@since` tag), or test for the member itself.
|
|
448
602
|
*/
|
|
449
603
|
readonly version: number;
|
|
450
604
|
/**
|
|
@@ -467,9 +621,19 @@ export interface API {
|
|
|
467
621
|
*
|
|
468
622
|
* Safe access patterns:
|
|
469
623
|
* ```typescript
|
|
470
|
-
* api.matter?.registerPlatformAccessories(...)
|
|
624
|
+
* await api.matter?.registerPlatformAccessories(...) // defensive, no-ops when disabled
|
|
471
625
|
* if (api.isMatterEnabled()) {
|
|
472
|
-
* api.matter!.registerPlatformAccessories(...)
|
|
626
|
+
* await api.matter!.registerPlatformAccessories(...) // explicit guard
|
|
627
|
+
* }
|
|
628
|
+
* ```
|
|
629
|
+
*
|
|
630
|
+
* The Matter methods return promises. Await them inside a `try`/`catch`:
|
|
631
|
+
* a rejection that nobody handles ends Homebridge.
|
|
632
|
+
* ```typescript
|
|
633
|
+
* try {
|
|
634
|
+
* await api.matter?.registerPlatformAccessories(...)
|
|
635
|
+
* } catch (error) {
|
|
636
|
+
* log.error('Could not register the Matter accessories:', error)
|
|
473
637
|
* }
|
|
474
638
|
* ```
|
|
475
639
|
*
|
|
@@ -501,10 +665,14 @@ export interface API {
|
|
|
501
665
|
* ```
|
|
502
666
|
* versionGreaterOrEqual("1.2.0"); // will return true
|
|
503
667
|
* versionGreaterOrEqual("1.3.0"); // will return false (the RELEASE version 1.3.0 is bigger than the BETA version 1.3.0-beta.12)
|
|
504
|
-
* versionGreaterOrEqual("1.3.0-beta.8); // will return true
|
|
668
|
+
* versionGreaterOrEqual("1.3.0-beta.8"); // will return true
|
|
505
669
|
* ```
|
|
506
670
|
*
|
|
507
|
-
*
|
|
671
|
+
* The version must be a full semver version (`"2.5.0"`, `"v2.5.0"`, `"2.5.0-beta.1"`).
|
|
672
|
+
* Anything else (`"2"`, `"2.5"`, `"abc"`, `undefined`) makes this method throw a `TypeError`.
|
|
673
|
+
*
|
|
674
|
+
* @param version - a full semver version
|
|
675
|
+
* @throws TypeError when `version` is not a full semver version
|
|
508
676
|
*/
|
|
509
677
|
versionGreaterOrEqual: (version: string) => boolean;
|
|
510
678
|
registerAccessory: ((accessoryName: AccessoryName, constructor: AccessoryPluginConstructor) => void) & ((pluginIdentifier: PluginIdentifier, accessoryName: AccessoryName, constructor: AccessoryPluginConstructor) => void);
|
|
@@ -520,17 +688,29 @@ export interface API {
|
|
|
520
688
|
* meaning as {@link isMatterEnabled}. False only when HAP is disabled outright.
|
|
521
689
|
* Use {@link isHapExternalsOnly} to tell whether bridged accessories will show.
|
|
522
690
|
* @returns true if HAP is in use on this bridge
|
|
691
|
+
* @since 2.5.0
|
|
523
692
|
*/
|
|
524
693
|
isHapEnabled: () => boolean;
|
|
525
694
|
/**
|
|
526
695
|
* Check if this bridge is in HAP externalsOnly mode: the bridge accessory, and
|
|
527
696
|
* so every bridged accessory, is not published, while external accessories are.
|
|
528
697
|
* @returns true if only external HAP accessories publish from this bridge
|
|
698
|
+
* @since 2.5.0
|
|
529
699
|
*/
|
|
530
700
|
isHapExternalsOnly: () => boolean;
|
|
531
701
|
/**
|
|
532
|
-
* Check if
|
|
702
|
+
* Check if this version of Homebridge knows Matter at all.
|
|
703
|
+
*
|
|
704
|
+
* It only compares the version number. It does NOT mean Matter can be used
|
|
705
|
+
* here: it is also true on a bridge with Matter switched off, and when
|
|
706
|
+
* matter.js could not be loaded. To decide whether to use Matter, test
|
|
707
|
+
* `api.matter` (or {@link isMatterEnabled}): the two always agree.
|
|
708
|
+
*
|
|
709
|
+
* The method does not exist on Homebridge 1.x, so a plugin that still
|
|
710
|
+
* supports 1.x has to call it as `api.isMatterAvailable?.()`.
|
|
711
|
+
*
|
|
533
712
|
* @returns true if Homebridge version is >= 2.0.0-alpha.0
|
|
713
|
+
* @since 2.0.0
|
|
534
714
|
*/
|
|
535
715
|
isMatterAvailable: () => boolean;
|
|
536
716
|
/**
|
|
@@ -538,6 +718,7 @@ export interface API {
|
|
|
538
718
|
* For main bridge: returns true if Matter is enabled in `bridge.matter` config
|
|
539
719
|
* For child bridge: returns true if Matter is enabled in the _bridge.matter config
|
|
540
720
|
* @returns true if Matter is enabled
|
|
721
|
+
* @since 2.0.0
|
|
541
722
|
*/
|
|
542
723
|
isMatterEnabled: () => boolean;
|
|
543
724
|
/**
|
|
@@ -545,15 +726,34 @@ export interface API {
|
|
|
545
726
|
* every bridged accessory, is not published, while external accessories are.
|
|
546
727
|
* Only ever true when {@link isMatterEnabled} is.
|
|
547
728
|
* @returns true if only external Matter accessories publish from this bridge
|
|
729
|
+
* @since 2.5.0
|
|
548
730
|
*/
|
|
549
731
|
isMatterExternalsOnly: () => boolean;
|
|
732
|
+
/**
|
|
733
|
+
* Listen for an event of Homebridge: `didFinishLaunching` or `shutdown` (see {@link APIEvent}).
|
|
734
|
+
*/
|
|
550
735
|
on: ((event: 'didFinishLaunching', listener: () => void) => this) & ((event: 'shutdown', listener: () => void) => this);
|
|
736
|
+
/**
|
|
737
|
+
* Like {@link on}, but the listener is called at most once.
|
|
738
|
+
*/
|
|
739
|
+
once: ((event: 'didFinishLaunching', listener: () => void) => this) & ((event: 'shutdown', listener: () => void) => this);
|
|
740
|
+
/**
|
|
741
|
+
* Remove a listener that was added with {@link on} or {@link once}.
|
|
742
|
+
*/
|
|
743
|
+
off: ((event: 'didFinishLaunching', listener: () => void) => this) & ((event: 'shutdown', listener: () => void) => this);
|
|
744
|
+
/**
|
|
745
|
+
* The same as {@link off}.
|
|
746
|
+
*/
|
|
747
|
+
removeListener: ((event: 'didFinishLaunching', listener: () => void) => this) & ((event: 'shutdown', listener: () => void) => this);
|
|
551
748
|
}
|
|
552
749
|
export declare interface HomebridgeAPI {
|
|
553
|
-
on: ((event: 'didFinishLaunching', listener: () => void) => this) & ((event: 'shutdown', listener: () => void) => this) & ((event: InternalAPIEvent.REGISTER_ACCESSORY, listener: (accessoryName: AccessoryName, accessoryConstructor: AccessoryPluginConstructor, pluginIdentifier?: PluginIdentifier) => void) => this) & ((event: InternalAPIEvent.REGISTER_PLATFORM, listener: (platformName: PlatformName, platformConstructor: PlatformPluginConstructor, pluginIdentifier?: PluginIdentifier) => void) => this) & ((event: InternalAPIEvent.PUBLISH_EXTERNAL_ACCESSORIES, listener: (accessories: PlatformAccessory[]) => void) => this) & ((event: InternalAPIEvent.REGISTER_PLATFORM_ACCESSORIES, listener: (accessories: PlatformAccessory[]) => void) => this) & ((event: InternalAPIEvent.UPDATE_PLATFORM_ACCESSORIES, listener: (accessories: PlatformAccessory[]) => void) => this) & ((event: InternalAPIEvent.UNREGISTER_PLATFORM_ACCESSORIES, listener: (accessories: PlatformAccessory[]) => void) => this) & ((event: InternalAPIEvent.PUBLISH_EXTERNAL_MATTER_ACCESSORIES, listener: (accessories: MatterAccessory[], registrationId: string) => void) => this) & ((event: InternalAPIEvent.REGISTER_MATTER_PLATFORM_ACCESSORIES, listener: (pluginIdentifier: PluginIdentifier, platformName: PlatformName, accessories: MatterAccessory[], track?: MatterWorkTracker) => void) => this) & ((event: InternalAPIEvent.UPDATE_MATTER_PLATFORM_ACCESSORIES, listener: (accessories: MatterAccessory[]) => void) => this) & ((event: InternalAPIEvent.UNREGISTER_MATTER_PLATFORM_ACCESSORIES, listener: (pluginIdentifier: PluginIdentifier, platformName: PlatformName, accessories: MatterAccessory[], track?: MatterWorkTracker) => void) => this) & ((event: InternalAPIEvent.UNREGISTER_EXTERNAL_MATTER_ACCESSORIES, listener: (accessories: MatterAccessory[], track?: MatterWorkTracker) => void) => this) & ((event: InternalAPIEvent.UPDATE_MATTER_ACCESSORY_STATE, listener: (uuid: string, cluster: string, attributes: Record<string,
|
|
554
|
-
emit: ((event: 'didFinishLaunching') => boolean) & ((event: 'shutdown') => boolean) & ((event: InternalAPIEvent.REGISTER_ACCESSORY, accessoryName: AccessoryName, accessoryConstructor: AccessoryPluginConstructor, pluginIdentifier?: PluginIdentifier) => boolean) & ((event: InternalAPIEvent.REGISTER_PLATFORM, platformName: PlatformName, platformConstructor: PlatformPluginConstructor, pluginIdentifier?: PluginIdentifier) => boolean) & ((event: InternalAPIEvent.PUBLISH_EXTERNAL_ACCESSORIES, accessories: PlatformAccessory[]) => boolean) & ((event: InternalAPIEvent.REGISTER_PLATFORM_ACCESSORIES, accessories: PlatformAccessory[]) => boolean) & ((event: InternalAPIEvent.UPDATE_PLATFORM_ACCESSORIES, accessories: PlatformAccessory[]) => boolean) & ((event: InternalAPIEvent.UNREGISTER_PLATFORM_ACCESSORIES, accessories: PlatformAccessory[]) => boolean) & ((event: InternalAPIEvent.PUBLISH_EXTERNAL_MATTER_ACCESSORIES, accessories: MatterAccessory[], registrationId: string) => boolean) & ((event: InternalAPIEvent.REGISTER_MATTER_PLATFORM_ACCESSORIES, pluginIdentifier: PluginIdentifier, platformName: PlatformName, accessories: MatterAccessory[], track?: MatterWorkTracker) => boolean) & ((event: InternalAPIEvent.UPDATE_MATTER_PLATFORM_ACCESSORIES, accessories: MatterAccessory[]) => boolean) & ((event: InternalAPIEvent.UNREGISTER_MATTER_PLATFORM_ACCESSORIES, pluginIdentifier: PluginIdentifier, platformName: PlatformName, accessories: MatterAccessory[], track?: MatterWorkTracker) => boolean) & ((event: InternalAPIEvent.UNREGISTER_EXTERNAL_MATTER_ACCESSORIES, accessories: MatterAccessory[], track?: MatterWorkTracker) => boolean) & ((event: InternalAPIEvent.UPDATE_MATTER_ACCESSORY_STATE, uuid: string, cluster: string, attributes: Record<string,
|
|
750
|
+
on: ((event: 'didFinishLaunching', listener: () => void) => this) & ((event: 'shutdown', listener: () => void) => this) & ((event: InternalAPIEvent.REGISTER_ACCESSORY, listener: (accessoryName: AccessoryName, accessoryConstructor: AccessoryPluginConstructor, pluginIdentifier?: PluginIdentifier) => void) => this) & ((event: InternalAPIEvent.REGISTER_PLATFORM, listener: (platformName: PlatformName, platformConstructor: PlatformPluginConstructor, pluginIdentifier?: PluginIdentifier) => void) => this) & ((event: InternalAPIEvent.PUBLISH_EXTERNAL_ACCESSORIES, listener: (accessories: PlatformAccessory[]) => void) => this) & ((event: InternalAPIEvent.REGISTER_PLATFORM_ACCESSORIES, listener: (accessories: PlatformAccessory[]) => void) => this) & ((event: InternalAPIEvent.UPDATE_PLATFORM_ACCESSORIES, listener: (accessories: PlatformAccessory[]) => void) => this) & ((event: InternalAPIEvent.UNREGISTER_PLATFORM_ACCESSORIES, listener: (accessories: PlatformAccessory[]) => void) => this) & ((event: InternalAPIEvent.PUBLISH_EXTERNAL_MATTER_ACCESSORIES, listener: (accessories: MatterAccessory[], registrationId: string) => void) => this) & ((event: InternalAPIEvent.REGISTER_MATTER_PLATFORM_ACCESSORIES, listener: (pluginIdentifier: PluginIdentifier, platformName: PlatformName, accessories: MatterAccessory[], track?: MatterWorkTracker) => void) => this) & ((event: InternalAPIEvent.UPDATE_MATTER_PLATFORM_ACCESSORIES, listener: (accessories: MatterAccessory[], track?: MatterWorkTracker) => void) => this) & ((event: InternalAPIEvent.UNREGISTER_MATTER_PLATFORM_ACCESSORIES, listener: (pluginIdentifier: PluginIdentifier, platformName: PlatformName, accessories: MatterAccessory[], track?: MatterWorkTracker) => void) => this) & ((event: InternalAPIEvent.UNREGISTER_EXTERNAL_MATTER_ACCESSORIES, listener: (accessories: MatterAccessory[], track?: MatterWorkTracker) => void) => this) & ((event: InternalAPIEvent.UPDATE_MATTER_ACCESSORY_STATE, listener: (uuid: string, cluster: string, attributes: Record<string, unknown>, partId?: string, track?: MatterWorkTracker) => void) => this);
|
|
751
|
+
emit: ((event: 'didFinishLaunching') => boolean) & ((event: 'shutdown') => boolean) & ((event: InternalAPIEvent.REGISTER_ACCESSORY, accessoryName: AccessoryName, accessoryConstructor: AccessoryPluginConstructor, pluginIdentifier?: PluginIdentifier) => boolean) & ((event: InternalAPIEvent.REGISTER_PLATFORM, platformName: PlatformName, platformConstructor: PlatformPluginConstructor, pluginIdentifier?: PluginIdentifier) => boolean) & ((event: InternalAPIEvent.PUBLISH_EXTERNAL_ACCESSORIES, accessories: PlatformAccessory[]) => boolean) & ((event: InternalAPIEvent.REGISTER_PLATFORM_ACCESSORIES, accessories: PlatformAccessory[]) => boolean) & ((event: InternalAPIEvent.UPDATE_PLATFORM_ACCESSORIES, accessories: PlatformAccessory[]) => boolean) & ((event: InternalAPIEvent.UNREGISTER_PLATFORM_ACCESSORIES, accessories: PlatformAccessory[]) => boolean) & ((event: InternalAPIEvent.PUBLISH_EXTERNAL_MATTER_ACCESSORIES, accessories: MatterAccessory[], registrationId: string) => boolean) & ((event: InternalAPIEvent.REGISTER_MATTER_PLATFORM_ACCESSORIES, pluginIdentifier: PluginIdentifier, platformName: PlatformName, accessories: MatterAccessory[], track?: MatterWorkTracker) => boolean) & ((event: InternalAPIEvent.UPDATE_MATTER_PLATFORM_ACCESSORIES, accessories: MatterAccessory[], track?: MatterWorkTracker) => boolean) & ((event: InternalAPIEvent.UNREGISTER_MATTER_PLATFORM_ACCESSORIES, pluginIdentifier: PluginIdentifier, platformName: PlatformName, accessories: MatterAccessory[], track?: MatterWorkTracker) => boolean) & ((event: InternalAPIEvent.UNREGISTER_EXTERNAL_MATTER_ACCESSORIES, accessories: MatterAccessory[], track?: MatterWorkTracker) => boolean) & ((event: InternalAPIEvent.UPDATE_MATTER_ACCESSORY_STATE, uuid: string, cluster: string, attributes: Record<string, unknown>, partId?: string, track?: MatterWorkTracker) => boolean);
|
|
555
752
|
}
|
|
556
753
|
export declare class HomebridgeAPI extends EventEmitter implements API {
|
|
754
|
+
/**
|
|
755
|
+
* @deprecated Fixed at `2.7` since Homebridge v1.3.0: it tells a plugin nothing. See {@link API.version}.
|
|
756
|
+
*/
|
|
557
757
|
readonly version = 2.7;
|
|
558
758
|
readonly serverVersion: string;
|
|
559
759
|
readonly user: typeof User;
|
|
@@ -615,6 +815,18 @@ export declare class HomebridgeAPI extends EventEmitter implements API {
|
|
|
615
815
|
* @internal
|
|
616
816
|
*/
|
|
617
817
|
loadMatterAPI(): Promise<void>;
|
|
818
|
+
/**
|
|
819
|
+
* Load the Matter API, and say whether Matter can be used in this run.
|
|
820
|
+
*
|
|
821
|
+
* matter.js may fail to load at all (a package the installer left out, a
|
|
822
|
+
* Node.js version one of its packages does not accept). That must not stop
|
|
823
|
+
* a bridge that also serves HomeKit: the failure is logged once, Matter
|
|
824
|
+
* stays off (`api.matter` is undefined, `isMatterEnabled()` is false) and
|
|
825
|
+
* the caller carries on without it.
|
|
826
|
+
*
|
|
827
|
+
* @internal
|
|
828
|
+
*/
|
|
829
|
+
tryLoadMatterAPI(): Promise<boolean>;
|
|
618
830
|
constructor();
|
|
619
831
|
/**
|
|
620
832
|
* Set bridge-specific HAP enablement before plugin initialization.
|
|
@@ -645,6 +857,12 @@ export declare class HomebridgeAPI extends EventEmitter implements API {
|
|
|
645
857
|
* @internal
|
|
646
858
|
*/
|
|
647
859
|
_setMatterManager(manager: BaseMatterManager | null): void;
|
|
860
|
+
/**
|
|
861
|
+
* Internal method to remember the promise of an external accessory registration
|
|
862
|
+
* Called by MatterAPIImpl before it asks the manager to publish the accessories
|
|
863
|
+
* @internal
|
|
864
|
+
*/
|
|
865
|
+
_addPendingExternalRegistration(registrationId: string, resolve: () => void): void;
|
|
648
866
|
/**
|
|
649
867
|
* Internal method to resolve pending external accessory registrations
|
|
650
868
|
* Called by MatterBridgeManager when external accessories finish publishing
|
|
@@ -673,7 +891,8 @@ export declare class HomebridgeAPI extends EventEmitter implements API {
|
|
|
673
891
|
*/
|
|
674
892
|
isHapExternalsOnly(): boolean;
|
|
675
893
|
/**
|
|
676
|
-
* Check if Matter is available in this version of Homebridge
|
|
894
|
+
* Check if Matter is available in this version of Homebridge (always true on v2)
|
|
895
|
+
* @see API.isMatterAvailable
|
|
677
896
|
* @returns true if Homebridge version satisfies >= 2.0.0-alpha.0
|
|
678
897
|
*/
|
|
679
898
|
isMatterAvailable(): boolean;
|
|
@@ -689,4 +908,3 @@ export declare class HomebridgeAPI extends EventEmitter implements API {
|
|
|
689
908
|
*/
|
|
690
909
|
isMatterExternalsOnly(): boolean;
|
|
691
910
|
}
|
|
692
|
-
//# sourceMappingURL=api.d.ts.map
|