matterbridge
Version:
Matterbridge plugin manager for Matter
60 lines • 2.86 kB
TypeScript
/**
* @description This file contains the Cooktop class.
* @file src/devices/cooktop.ts
* @author Luca Liguori
* @created 2025-05-25
* @version 1.1.0
* @license Apache-2.0
*
* Copyright 2025, 2026, 2027 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 { Semtag } from '@matter/types';
import { MatterbridgeEndpoint } from '../matterbridgeEndpoint.js';
export declare class Cooktop extends MatterbridgeEndpoint {
/**
* Creates an instance of the Cooktop class.
*
* @param {string} name - The name of the cooktop.
* @param {string} serial - The serial number of the cooktop.
*
* @remarks
* 13.8 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.
*
* 13.8.4 A Cooktop SHALL be composed of zero or more endpoints with the Cook Surface device type.
* An Cooktop is always defined via endpoint composition.
* - Use `addSurface` to add one or more surfaces to the cooktop.
*/
constructor(name: string, serial: string);
/**
* Adds a surface to the cooktop.
*
* @param {string} name - The name of the surface.
* @param {Semtag[]} tagList - The tagList associated with the surface.
* @param {number} selectedTemperatureLevel - The selected temperature level as an index of the supportedTemperatureLevels array. Defaults to 2 (which corresponds to 'Level 3').
* @param {string[]} supportedTemperatureLevels - The list of supported temperature levels for the surface. Defaults to ['Level 1', 'Level 2', 'Level 3', 'Level 4', 'Level 5'].
*
* @returns {MatterbridgeEndpoint} The MatterbridgeEndpoint instance representing the surface.
*
* @remarks
* 13.7 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.
*
* The OnOff cluster is off only mandatory for all Cook Surface devices!
*/
addSurface(name: string, tagList: Semtag[], selectedTemperatureLevel?: number, supportedTemperatureLevels?: string[]): MatterbridgeEndpoint;
}
//# sourceMappingURL=cooktop.d.ts.map