matterbridge 3.2.4 → 3.2.5-dev-20250831-732330c

package/dist/matterbridgeDeviceTypes.d.ts

@@ -1,709 +0,0 @@
-/**
- * This file contains the class MatterbridgeDevice.
- *
- * @file matterbridgeDeviceTypes.ts
- * @author Luca Liguori
- * @created 2024-11-08
- * @version 1.0.0
- * @license Apache-2.0
- *
- * Copyright 2024, 2025, 2026 Luca Liguori.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-import { ClusterId, DeviceTypeId, EndpointNumber } from '@matter/main';
-import { Semtag } from '@matter/main/types';
-export declare enum DeviceClasses {
-    /** Node device type. */
-    Node = "Node",
-    /**
-     * Application device type.
-     * Application devices types are typically the most datatype endpoints on a node and in the network.
-     */
-    App = "App",
-    /**
-     * Utility device type.
-     * A Utility device type supports configuration and settings.
-     */
-    Utility = "Utility",
-    /**
-     * Simple device type.
-     * A Simple device type supports local control that is persistent, independent, and unsupervised.
-     */
-    Simple = "Simple",
-    /**
-     * Dynamic device type.
-     * A Dynamic device type supports intelligent and supervisory services, such as commissioning,
-     * monitoring, trend analysis, scheduling and central management. A dynamic device type is an
-     * application device type.
-     */
-    Dynamic = "Dynamic",
-    /** There exists a client application cluster on the endpoint. */
-    Client = "Client",
-    /** There exists a server application cluster on the endpoint. */
-    Server = "Server",
-    /** The device type is composed of 2 or more device types. */
-    Composed = "Composed",
-    /** The endpoint and at least one of its sibling endpoints have an overlap in application device type(s). */
-    Duplicate = "Duplicate",
-    /**
-     * The endpoint represents a Bridged Device, for which information about the state of
-     * its power source is available to the Bridge
-     */
-    BridgedPowerSourceInfo = "BridgedPowerSourceInfo"
-}
-export interface DeviceTypeDefinition {
-    name: string;
-    code: DeviceTypeId;
-    deviceClass: DeviceClasses;
-    revision: number;
-    requiredServerClusters: ClusterId[];
-    optionalServerClusters: ClusterId[];
-    requiredClientClusters: ClusterId[];
-    optionalClientClusters: ClusterId[];
-}
-export declare const DeviceTypeDefinition: ({ name, code, deviceClass, revision, requiredServerClusters, optionalServerClusters, requiredClientClusters, optionalClientClusters, }: {
-    name: string;
-    code: number;
-    deviceClass: DeviceClasses;
-    revision: number;
-    requiredServerClusters?: ClusterId[];
-    optionalServerClusters?: ClusterId[];
-    requiredClientClusters?: ClusterId[];
-    optionalClientClusters?: ClusterId[];
-}) => DeviceTypeDefinition;
-/**
- *  MatterbridgeEndpointOptions interface is used to define the options for a Matterbridge endpoint.
- *
- *  @remarks
- *  - tagList?: Semtag[]. It is used to disambiguate the sibling child endpoints (9.2.3. Disambiguation rule).
- *    - mfgCode: VendorId | null,
- *    - namespaceId: number,
- *    - tag: number,
- *    - label: string | undefined | null
- *  - mode?: 'server' | 'matter'. It is used to activate a special mode for the endpoint.
- *  - id?: string. It is the unique storage key for the endpoint.
- *  - number?: EndpointNumber. It is the endpoint number for the endpoint.
- */
-export interface MatterbridgeEndpointOptions extends EndpointOptions {
-    /**
-     *  The semantic tags array for the endpoint.
-     *  The tagList is used to disambiguate the sibling child endpoints (9.2.3. Disambiguation rule).
-     *  The tagList is used to identify the endpoint and to provide additional information about the endpoint.
-     *
-     *  @remarks
-     *    - mfgCode: VendorId | null,
-     *    - namespaceId: number,
-     *    - tag: number,
-     *    - label: string | undefined | null
-     */
-    tagList?: Semtag[];
-    /**
-     * Activates a special mode for this endpoint.
-     * - 'server': it creates the device server node and add the device as Matter device that needs to be paired individually.
-     *   In this case the Matterbridge bridge mode (bridge or childbridge) is not relevant. The device is independent.
-     *
-     * - 'matter': it adds the device directly to the Matterbridge server node as Matter device alongside the aggregator. In this case the implementation must respect
-     *   the 9.2.3. Disambiguation rule (i.e. use taglist if needed cause the device doesn't have nodeLabel).
-     *   Furthermore the device will be a part of the bridge (i.e. will have the same name and will be in the same room).
-     *   See 9.12.2.2. Native Matter functionality in Bridge.
-     *
-     * @remarks
-     * Always use createDefaultBasicInformationClusterServer() to create the BasicInformation cluster server when using mode 'server' or 'matter'.
-     */
-    mode?: 'server' | 'matter';
-    /**
-     * The unique storage key for the endpoint.
-     * If not provided, a default key will be used.
-     */
-    id?: string;
-    /**
-     * The endpoint number for the endpoint.
-     * If not provided, the endpoint will be created with the next available endpoint number.
-     * If provided, the endpoint will be created with the specified endpoint number.
-     */
-    number?: EndpointNumber;
-}
-/**
- *  EndpointOptions interface is used to define the options for an endpoint.
- *
- * @deprecated Use `MatterbridgeEndpointOptions` instead.
- */
-export interface EndpointOptions {
-    /**
-     * Old API compatibility replaced by number.
-     *
-     * @deprecated Use `number` instead.
-     */
-    endpointId?: EndpointNumber;
-    /**
-     * Old API compatibility replaced by id.
-     *
-     * @deprecated Use `id` instead.
-     */
-    uniqueStorageKey?: string;
-}
-export declare const powerSource: DeviceTypeDefinition;
-export declare const OTARequestor: DeviceTypeDefinition;
-export declare const OTAProvider: DeviceTypeDefinition;
-/**
-  2.5.3. Conditions
-  Please see the Base Device Type definition for conformance tags.
-  This device type SHALL only be used for Nodes which have a device type of Bridge.
- 
-  2.5.5. Cluster Requirements
-  Each endpoint supporting this device type SHALL include these clusters based on the conformance
-  defined below.
-  -  0x0039 Bridged Device Basic Information Server
- 
-  2.5.6. Endpoint Composition
-  • A Bridged Node endpoint SHALL support one of the following composition patterns:
-  ◦ Separate Endpoints: All application device types are supported on separate endpoints, and
-    not on the Bridged Node endpoint. The Bridged Node endpoint’s Descriptor cluster PartsList
-    attribute SHALL indicate a list of all endpoints representing the functionality of the bridged
-    device, including the endpoints supporting the application device types, i.e. the full-family
-    pattern defined in the System Model specification.
-  ◦ One Endpoint: Both the Bridged Node and one or more application device types are sup
-    ported on the same endpoint (following application device type rules). Endpoint composi
-    tion SHALL conform to the application device type(s) definition
- */
-export declare const bridgedNode: DeviceTypeDefinition;
-/**
- * An Electrical Sensor device measures the electrical power and/or energy being imported and/or
- * exported.
- * It is a utility device type that provides information about the electrical power and/or energy
- * consumption and generation.
- *
- *  2.6.3. Device Type Requirements
- *  Electrical measurements made by either the Electrical Power Measurement cluster, the Electrical
- *  Energy Measurement cluster, or both SHALL apply to the endpoints indicated by the Power Topology
- *  cluster.
- */
-export declare const electricalSensor: DeviceTypeDefinition;
-/**
- * A Device Energy Management device provides reporting and optionally adjustment of the electrical
- * power planned on being consumed or produced by the device.
- */
-export declare const deviceEnergyManagement: DeviceTypeDefinition;
-/**
- * Element Requirements:
- * - Identify Command TriggerEffect
- * - Scenes Management Command CopyScene
- * - On/Off Feature Lighting
- * - Level Control Feature OnOff
- * - Level Control Feature Lighting
- * - Level Control Attribute CurrentLevel 1 to 254
- * - Level Control Attribute MinLevel 1
- * - Level Control Attribute MaxLevel 254
- */
-export declare const onOffLight: DeviceTypeDefinition;
-/**
- * Element Requirements:
- * - Identify Command TriggerEffect
- * - Scenes Management Command CopyScene
- * - On/Off Feature Lighting
- * - Level Control Feature OnOff
- * - Level Control Feature Lighting
- * - Level Control Attribute CurrentLevel 1 to 254
- * - Level Control Attribute MinLevel 1
- * - Level Control Attribute MaxLevel 254
- */
-export declare const dimmableLight: DeviceTypeDefinition;
-/**
- * Element Requirements:
- * - Identify Command TriggerEffect
- * - Scenes Management Command CopyScene
- * - On/Off Feature Lighting
- * - Level Control Feature OnOff
- * - Level Control Feature Lighting
- * - Level Control Attribute CurrentLevel 1 to 254
- * - Level Control Attribute MinLevel 1
- * - Level Control Attribute MaxLevel 254
- * - Color Control Feature ColorTemperature
- * - Color Control Attribute RemainingTime
- */
-export declare const colorTemperatureLight: DeviceTypeDefinition;
-/**
- * Element Requirements:
- * - Identify Command TriggerEffect
- * - Scenes Management Command CopyScene
- * - On/Off Feature Lighting
- * - Level Control Feature OnOff
- * - Level Control Feature Lighting
- * - Level Control Attribute CurrentLevel 1 to 254
- * - Level Control Attribute MinLevel 1
- * - Level Control Attribute MaxLevel 254
- * - Color Control Feature XY
- * - Color Control Feature ColorTemperature
- * - Color Control Attribute RemainingTime
- */
-export declare const extendedColorLight: DeviceTypeDefinition;
-/**
- * Element Requirements:
- * - Identify Command TriggerEffect
- * - Scenes Management Command CopyScene
- * - On/Off Feature Lighting
- * - Level Control Feature OnOff
- * - Level Control Feature Lighting
- * - Level Control Attribute CurrentLevel 1 to 254
- * - Level Control Attribute MinLevel 1
- * - Level Control Attribute MaxLevel 254
- */
-export declare const onOffOutlet: DeviceTypeDefinition;
-/**
- * Element Requirements:
- * - Identify Command TriggerEffect
- * - Scenes Management Command CopyScene
- * - On/Off Feature Lighting
- * - Level Control Feature OnOff
- * - Level Control Feature Lighting
- * - Level Control Attribute CurrentLevel 1 to 254
- * - Level Control Attribute MinLevel 1
- * - Level Control Attribute MaxLevel 254
- */
-export declare const dimmableOutlet: DeviceTypeDefinition;
-/**
- * A Mounted On/Off Control is a fixed device that provides power to another device that is plugged
- * into it, and is capable of switching that provided power on or off.
- * It is a simple device type that does not require any client clusters.
- * Element Requirements:
- * - Identify Command TriggerEffect
- * - Scenes Management Command CopyScene
- * - On/Off Feature Lighting
- * - Level Control Feature OnOff
- * - Level Control Feature Lighting
- * - Level Control Attribute CurrentLevel 1 to 254
- * - Level Control Attribute MinLevel 1
- * - Level Control Attribute MaxLevel 254
- */
-export declare const onOffMountedSwitch: DeviceTypeDefinition;
-/**
- * A Mounted Dimmable Load Control is a fixed device that provides power to another device that is
- * plugged into it, and is capable of being switched on or off and have its level adjusted. The Mounted
- * Dimmable Load Control is typically used to control a conventional non-communicating light
- * through its mains connection using phase cutting.
- * It is a simple device type that does not require any client clusters.
- * Element Requirements:
- * - Identify Command TriggerEffect
- * - Scenes Management Command CopyScene
- * - On/Off Feature Lighting
- * - Level Control Feature OnOff
- * - Level Control Feature Lighting
- * - Level Control Attribute CurrentLevel 1 to 254
- * - Level Control Attribute MinLevel 1
- * - Level Control Attribute MaxLevel 254
- */
-export declare const dimmableMountedSwitch: DeviceTypeDefinition;
-/**
- *  Remark:
- *  On/Off Cluster:
- *    - Off If the pump is powered on, store the current level then immediately power it off.
- *    - On If the pump is powered off, power it on and move immediately to the level stored by a previous Off command. If no such level has been stored,
- *      move immediately to the maximum level allowed for the pump.
- *    - Toggle If the pump is powered on, proceed as for the Off command. If the device is powered off, proceed as for the On command.
- *
- *  LevelControl cluster:
- *    Level   Setpoint                Meaning
- *    0       N/A                     Pump is stopped,
- *    1–200   Level / 2 (0.5–100.0%)  Pump setpoint in percent
- *    201–255 100.0%                  Pump setpoint is 100.0%
- */
-export declare const pumpDevice: DeviceTypeDefinition;
-export declare const waterValve: DeviceTypeDefinition;
-export declare const onOffSwitch: DeviceTypeDefinition;
-export declare const dimmableSwitch: DeviceTypeDefinition;
-export declare const colorTemperatureSwitch: DeviceTypeDefinition;
-export declare const genericSwitch: DeviceTypeDefinition;
-/**
- * Closed or contact: state true
- * Open or no contact: state false
- */
-export declare const contactSensor: DeviceTypeDefinition;
-export declare const lightSensor: DeviceTypeDefinition;
-export declare const occupancySensor: DeviceTypeDefinition;
-export declare const temperatureSensor: DeviceTypeDefinition;
-export declare const pressureSensor: DeviceTypeDefinition;
-export declare const flowSensor: DeviceTypeDefinition;
-export declare const humiditySensor: DeviceTypeDefinition;
-export declare const smokeCoAlarm: DeviceTypeDefinition;
-export declare const airQualitySensor: DeviceTypeDefinition;
-export declare const waterFreezeDetector: DeviceTypeDefinition;
-export declare const waterLeakDetector: DeviceTypeDefinition;
-export declare const rainSensor: DeviceTypeDefinition;
-/**
- * A Door Lock is a device used to secure a door. It is possible to actuate a door lock either by means of a manual or a remote method.
- * Element Requirements:
- *
- * - AccessControl Attribute Extension
- * - DoorLock Feature User
- * - DoorLock Attribute AlarmMask
- */
-export declare const doorLockDevice: DeviceTypeDefinition;
-export declare const coverDevice: DeviceTypeDefinition;
-/**
- * A Thermostat device is capable of having either built-in or separate sensors for temperature,
- * humidity or occupancy. It allows the desired temperature to be set either remotely or locally. The
- * thermostat is capable of sending heating and/or cooling requirement notifications to a heating/cooling
- * unit (for example, an indoor air handler) or is capable of including a mechanism to control a
- * heating or cooling unit directly.
- *
- */
-export declare const thermostatDevice: DeviceTypeDefinition;
-/**
- * A Fan device is typically standalone or mounted on a ceiling or wall and is used to circulate air in a room.
- *  Remark: it may have a thermostat device type.
- *  Additional device types MAY also be included in device compositions.
- * Element Requirements:
- *  The FanControl cluster must have the FanModeSequence attribute.
- *
- * The On/Off cluster is independent from the Fan Control Cluster’s FanMode attribute, which also
- * includes an Off setting.
- * If the FanMode attribute of the Fan Control cluster is set to a value other than Off when the OnOff
- * attribute of the On/Off cluster transitions from TRUE to FALSE, it may be desirable to restore the
- * FanMode, SpeedSetting and PercentSetting attribute values of the Fan Control cluster when the OnOff
- * attribute of the On/Off cluster later transitions from FALSE to TRUE. If the FanMode is set to Off when
- * the device is turned off, this information is lost, as the SpeedSetting and PercentSetting will be set to
- * zero. Using the On/Off cluster alongside the Fan Control cluster allows the FanMode, SpeedSetting and
- * PercentSetting to remain unchanged when the device is turned off. In this case, the On/Off cluster
- * would be set to Off, and the SpeedCurrent and PercentCurrent set to zero, without changing FanMode,
- * SpeedSetting and PercentSetting.
- */
-export declare const fanDevice: DeviceTypeDefinition;
-/**
- * An Air Purifier is a standalone device that is designed to clean the air in a room.
- * It is a device that has a fan to control the air speed while it is operating. Optionally, it can report on
- * the condition of its filters.
- *
- * Remark:
- * An Air Purifier MAY expose elements of its functionality through one or more additional device
- * types on different endpoints. All devices used in compositions SHALL adhere to the disambiguation
- * requirements of the System Model. Other device types, not explicitly listed in the table, MAY also be
- * included in device compositions but are not considered part of the core functionality of the device.
- * 0x0301 Thermostat O
- * 0x0302 Temperature Sensor O
- * 0x0307 Humidity Sensor O
- * 0x002C Air Quality Sensor O
- *
- * Cluster Restrictions:
- * The On/Off cluster is independent from the Fan Control Cluster’s FanMode attribute, which also
- * includes an Off setting.
- * If the FanMode attribute of the Fan Control cluster is set to a value other than Off when the OnOff
- * attribute of the On/Off cluster transitions from TRUE to FALSE, it may be desirable to restore the
- * FanMode, SpeedSetting and PercentSetting attribute values of the Fan Control cluster when the OnOff
- * attribute of the On/Off cluster later transitions from FALSE to TRUE. If the FanMode is set to Off when
- * the device is turned off, this information is lost, as the SpeedSetting and PercentSetting will be set to
- * zero. Using the On/Off cluster alongside the Fan Control cluster allows the FanMode, SpeedSetting and
- * PercentSetting to remain unchanged when the device is turned off. In this case, the On/Off cluster
- * would be set to Off, and the SpeedCurrent and PercentCurrent set to zero, without changing FanMode,
- * SpeedSetting and PercentSetting.
- *
- */
-export declare const airPurifier: DeviceTypeDefinition;
-export declare const modeSelect: DeviceTypeDefinition;
-/**
- * This device type aggregates endpoints as a collection. Clusters on the endpoint indicating this
- * device type provide functionality for the collection of descendant endpoints present in the PartsList
- * of the endpoint’s descriptor, for example the Actions cluster.
- *
- * Endpoint Composition:
- * An Aggregator endpoint’s Descriptor cluster PartsList attribute SHALL list the collection of all endpoints
- * aggregated by the Aggregator device type, i.e. the full-family pattern defined in the System Model specification.
- *
- * Disambiguation:
- * If the Duplicate condition applies to child endpoints of an Aggregator endpoint that represent multiple
- * independent bridged devices, the endpoints SHOULD make available metadata to allow a
- * client to disambiguate distinct bridged devices with an overlap in application device types.
- *
- * Typically this is done using the NodeLabel attribute of the Bridged Device Basic Information cluster
- * - thus reusing the naming information which the bridge already has to allow disambiguation to the
- * user when using a direct user interface to the bridge.
- *
- * Actions cluster (9.14 Matter specification):
- * If a Bridge has (such) information on topology or logical grouping, it SHOULD expose such information
- * in the EndpointLists attribute of an Actions cluster (the ActionLists of which MAY be empty if
- * no actions are exposed). 9.12 Matter specification
- *
- * 9.12.5. New features for Bridged Devices
- * Bridged Devices can have their software updated independently of the Bridge, through Bridge Manufacturer-
- * specific means. These updates MAY result in one or more changes to their capabilities,
- * such as supported clusters and/or attributes, for an endpoint. Like every Matter Node, every endpoint
- * on the Bridge’s Node contains a Descriptor cluster that contains attributes for the device types
- * (DeviceTypeList), endpoints (PartsList) and supported clusters (ServerList and ClientList). Nodes
- * that wish to be notified of such changes SHOULD monitor changes of these attributes.
- */
-export declare const aggregator: DeviceTypeDefinition;
-export declare const bridge: DeviceTypeDefinition;
-/**
- * A Robotic Vacuum Cleaner is a device that is capable of cleaning floors and other surfaces
- * in a home or office environment. It is typically a mobile device that can navigate around
- * obstacles and can be controlled remotely.
- *
- * Cluster Usage:
- * The RVC Operational State cluster’s OperationalState attribute SHALL be updated according to the
- * state of the device, and therefore it SHOULD be used for monitoring purposes.
- *
- * To attempt starting a cleaning operation, the RVC Run Mode cluster can be sent a ChangeToMode
- * command with the NewMode field set to a mode that has the Cleaning mode tag associated with it.
- *
- * To attempt stopping a cleaning operation, the RVC Run Mode cluster can be sent a ChangeToMode
- * command with the NewMode field set to a mode that has the Idle mode tag associated with it.
- *
- * To attempt pausing a cleaning operation, the RVC Operational State cluster can be sent a Pause command.
- *
- * To attempt resuming a cleaning operation, the RVC Operational State cluster can be sent a Resume
- * command.
- *
- *
- */
-export declare const roboticVacuumCleaner: DeviceTypeDefinition;
-/**
- * Cluster Restrictions:
- * On/Off Cluster: the DF (Dead Front) feature is required
- */
-export declare const laundryWasher: DeviceTypeDefinition;
-/**
- * A refrigerator represents a device that contains one or more cabinets that are capable of chilling or freezing food.
- * A Refrigerator SHALL be composed of at least one endpoint with the Temperature Controlled Cabinet device type.
- *
- * Device Type Requirements:
- * 0x0071 Temperature Controlled Cabinet
- */
-export declare const refrigerator: DeviceTypeDefinition;
-/**
- * A Room Air Conditioner is a device with the primary function of controlling the air temperature in a single room.
- *
- * A Room Air Conditioner MAY have zero or more of each device type listed in this table subject to
- * the conformance column of the table. All devices used in compositions SHALL adhere to the disambiguation
- * requirements of the System Model. Additional device types not listed in this table MAY also be included in device compositions.
- *  0x0302 Temperature Sensor O
- *  0x0307 Humidity Sensor O
- *
- *  Remark:
- *  The DF (Dead Front) feature is required for the On/Off cluster in this device type:
- *  - Thermostat                      LocalTemperature    null
- *  - Temperature Measurement         MeasuredValue       null
- *  - Relative Humidity Measurement   MeasuredValue       null
- *  - Fan Control                     SpeedSetting        null
- *  - Fan Control                     PercentSetting      null
- */
-export declare const airConditioner: DeviceTypeDefinition;
-/**
- * A Temperature Controlled Cabinet only exists composed as part of another device type. It represents
- * a single cabinet that is capable of having its temperature controlled. Such a cabinet may be
- * chilling or freezing food, for example as part of a refrigerator, freezer, wine chiller, or other similar
- * device. Equally, such a cabinet may be warming or heating food, for example as part of an oven,
- * range, or similar device.
- * Conditions:
- * Cooler The device has cooling functionality.
- */
-export declare const temperatureControlledCabinetCooler: DeviceTypeDefinition;
-/**
- * A Temperature Controlled Cabinet only exists composed as part of another device type. It represents
- * a single cabinet that is capable of having its temperature controlled. Such a cabinet may be
- * chilling or freezing food, for example as part of a refrigerator, freezer, wine chiller, or other similar
- * device. Equally, such a cabinet may be warming or heating food, for example as part of an oven,
- * range, or similar device.
- * Conditions:
- * Heater The device has heating functionality.
- */
-export declare const temperatureControlledCabinetHeater: DeviceTypeDefinition;
-/**
- * Cluster Restrictions:
- * On/Off Cluster: the DF (Dead Front) feature is required
- */
-export declare const dishwasher: DeviceTypeDefinition;
-/**
- * Cluster Restrictions:
- * On/Off Cluster: the DF (Dead Front) feature is required
- */
-export declare const laundryDryer: DeviceTypeDefinition;
-/**
- * A Cook Surface device type represents a heating object on a cooktop or other similar device. It
- * SHALL only be used when composed as part of another device type (cooktop).
- *
- * Cluster Restrictions:
- * The OffOnly feature is required for the On/Off cluster in this device type due to safety requirements.
- */
-export declare const cookSurface: DeviceTypeDefinition;
-/**
- * A cooktop is a cooking surface that heats food either by transferring currents from an electromagnetic
- * field located below the glass surface directly to the magnetic induction cookware placed
- * above or through traditional gas or electric burners.
- *
- * Device Type Requirements:
- * A Cooktop SHALL be composed of zero or more endpoints with the Cook Surface device type as defined by the conformance below.
- *  0x0077 Cook Surface min 1 O
- *
- * Cluster Restrictions:
- * The OffOnly feature is required for the On/Off cluster in this device type due to safety requirements.
- */
-export declare const cooktop: DeviceTypeDefinition;
-/**
- * An oven represents a device that contains one or more cabinets, and optionally a single cooktop, that are all capable of heating food.
- * An oven is always defined via endpoint composition.
- * Conditions:
- * An Oven SHALL have the Heater condition applied to at least one endpoint containing the Temperature Control Cluster.
- * Device Type Requirements:
- * - 0x0071 Temperature Controlled Cabinet min 1
- * - 0x0078 Cooktop
- */
-export declare const oven: DeviceTypeDefinition;
-/**
- * An Extractor Hood is a device that is generally installed above a cooking surface in residential kitchens.
- * Additional device types not listed in this table MAY also be included in device compositions.
- * Device Type Requirements:
- * 0x0100+ On/Off Light+ O
- *
- *
- * Element Requirements:
- * - 0x0202 Fan Control Feature Rocking X
- * - 0x0202 Fan Control Feature Wind X
- * - 0x0202 Fan Control Feature AirflowDirection X
- */
-export declare const extractorHood: DeviceTypeDefinition;
-/**
- * A Microwave Oven is a device with the primary function of heating foods and beverages using a magnetron.
- * A Microwave Oven is a device which at a minimum is capable of being started and stopped and of setting a power level.
- * A Microwave Oven MAY also support additional capabilities via endpoint composition.
- *
- */
-export declare const microwaveOven: DeviceTypeDefinition;
-/**
- * An EVSE (Electric Vehicle Supply Equipment) is a device that allows an EV (Electric Vehicle) to be
- * connected to the mains electricity supply to allow it to be charged (or discharged in case of Vehicle
- * to Grid / Vehicle to Home applications).
- *
- * 14.1.5. Device Type Requirements
- * An EVSE SHALL be composed of at least one endpoint with device types as defined by the conformance
- * below. There MAY be more endpoints with other device types existing in the EVSE.
- * - ID     Name                        Constraint    Conformance
- * - 0x0011 Power Source                min 1         M
- * - 0x0510 Electrical Sensor           min 1         M
- * - 0x050D Device Energy Management    min 1         M
- *
- * The Electrical Sensor device SHALL include both the Electrical Energy Measurement and Electrical
- * Power Measurement clusters, measuring the total energy and power of the EVSE.
- *
- * The Device Energy Management cluster included in the Device Energy Management device SHALL
- * support the Power Forecast Reporting (PFR) feature.
- */
-export declare const evse: DeviceTypeDefinition;
-/**
- * A water heater is a device that is generally installed in properties to heat water for showers, baths etc.
- * A Water Heater is always defined via endpoint composition.
- *
- * 14.2.5. Device Type Requirements
- * A Water Heater SHALL be composed of at least one endpoint with device types as defined by the
- * conformance below. There MAY be more endpoints with other device types existing in the Water Heater.
- * - ID     Name                        Constraint    Conformance
- * - 0x0011 Power Source                              O
- * - 0x0302 Temperature Sensor                        O
- * - 0x0510 Electrical Sensor                         desc
- * - 0x050D Device Energy Management                  O
- *
- * 14.2.7. Element Requirements
- * 0x0201 Thermostat Feature Heating M
- *
- * The Energy Management feature of the Water Heater cluster SHALL be supported if the Device
- * Energy Management device type is included.
- * If Off is a supported SystemMode in the Thermostat cluster, setting the SystemMode of the Thermostat
- * cluster to Off SHALL set the CurrentMode attribute of the Water Heater Mode cluster to a mode
- * having the Off mode tag value and vice versa.
- * At least one entry in the SupportedModes attribute of the Water Heater Mode cluster SHALL
- * include the Timed mode tag in the ModeTags field list.
- *
- * WaterHeaterMode Cluster
- * 9.6.6.1. SupportedModes Attribute
- * At least one entry in the SupportedModes attribute SHALL include the Manual mode tag in the
- * ModeTags field list.
- * At least one entry in the SupportedModes attribute SHALL include the Off mode tag in the ModeTags
- * field list.
- * An entry in the SupportedModes attribute that includes one of an Off, Manual, or Timed tag SHALL
- * NOT also include an additional instance of any one of these tag types.
- */
-export declare const waterHeater: DeviceTypeDefinition;
-/**
- * A Solar Power device is a device that allows a solar panel array, which can optionally be comprised
- * of a set parallel strings of solar panels, and its associated controller and, if appropriate, inverter, to
- * be monitored and controlled by an Energy Management System.
- *
- * 14.3.5. Device Type Requirements
- * A Solar Power device SHALL be composed of at least one endpoint with device types as defined by
- * the conformance below. There MAY be more endpoints with additional instances of these device
- * types or additional device types existing in the Solar Power device.
- *
- * - ID     Name                        Constraint    Conformance
- * - 0x0011 Power Source                min 1         M
- * - 0x0510 Electrical Sensor           min 1         M
- * - 0x050D Device Energy Management                  O
- * - 0x0302 Temperature Sensor                        O
- *
- * 14.3.5.1. Cluster Requirements on Composing Device Types
- *
- * - 0x0011 Power Source 0x002F Power Source Feature Wired M
- * - 0x0011 Power Source 0x001D Descriptor Feature TagList M
- * - 0x0510 Electrical Sensor 0x0090 Electrical Power Measurement M
- * - 0x0510 Electrical Sensor 0x0090 Electrical Power Measurement Attribute Voltage M
- * - 0x0510 Electrical Sensor 0x0090 Electrical Power Measurement Attribute ActiveCurrent M
- * - 0x0510 Electrical Sensor 0x0091 Electrical Energy Measurement M
- * - 0x0510 Electrical Sensor 0x0091 Electrical Energy Measurement Feature ExportedEnergy M
- * - 0x050D Device Energy Management 0x0098 Device Energy Management Feature PowerAdjustment M
- * - 0x0302 Temperature Sensor 0x001D Descriptor Feature TagList M
- */
-export declare const solarPower: DeviceTypeDefinition;
-/**
- * A Battery Storage device is a device that allows a DC battery, which can optionally be comprised of
- * a set parallel strings of battery packs and associated controller, and an AC inverter, to be monitored
- * and controlled by an Energy Management System in order to manage the peaks and troughs of supply
- * and demand, and/or to optimize cost of the energy consumed in premises. It is not intended to
- * be used for a UPS directly supplying a set of appliances, nor for portable battery storage devices.
- *
- * 14.4.5. Device Type Requirements
- * A Battery Storage device SHALL be composed of at least one endpoint with device types as defined by
- * the conformance below. There MAY be more endpoints with additional instances of these device
- * types or additional device types existing in the Battery Storage device.
- * - ID     Name                        Constraint    Conformance
- * - 0x0011 Power Source                min 1         M
- * - 0x0510 Electrical Sensor           min 1         M
- * - 0x050D Device Energy Management                  M
- * - 0x0302 Temperature Sensor                        O
- * - 0x0017 Solar Power                               O
- *
- * See 14.4.5.1. Cluster Requirements on Composing Device Types
- */
-export declare const batteryStorage: DeviceTypeDefinition;
-/**
- * A Heat Pump device is a device that uses electrical energy to heat either spaces or water tanks using
- * ground, water or air as the heat source. These typically can heat the air or can pump water via central
- * heating radiators or underfloor heating systems. It is typical to also heat hot water and store
- * the heat in a hot water tank.
- *
- * 14.5.1. Heat Pump Architecture
- * A Heat Pump device is always defined via endpoint composition.
- *
- * 14.5.5. Device Type Requirements
- * A Heat Pump device SHALL be composed of at least one endpoint with device types as defined by
- * the conformance below. There MAY be more endpoints with additional instances of these device
- * types or additional device types existing in the Heat Pump device.
- * - ID     Name                        Constraint    Conformance
- * - 0x0011 Power Source                              M
- * - 0x0510 Electrical Sensor           min 1         M
- * - 0x050D Device Energy Management                  M
- * - 0x0301 Thermostat                                O
- * - 0x050f Water Heater                              O
- * - 0x0302 Temperature Sensor                        O
- *
- * See 14.5.5.1. Cluster Requirements on Composing Device Types
- */
-export declare const heatPump: DeviceTypeDefinition;
-//# sourceMappingURL=matterbridgeDeviceTypes.d.ts.map