/** * @license * Copyright 2022-2026 Matter.js Authors * SPDX-License-Identifier: Apache-2.0 */ /*** THIS FILE IS GENERATED, DO NOT EDIT ***/ import { IdentifyServer as BaseIdentifyServer } from "../behaviors/identify/IdentifyServer.js"; import { ValveConfigurationAndControlServer as BaseValveConfigurationAndControlServer } from "../behaviors/valve-configuration-and-control/ValveConfigurationAndControlServer.js"; import { FlowMeasurementServer as BaseFlowMeasurementServer } from "../behaviors/flow-measurement/FlowMeasurementServer.js"; import { MutableEndpoint } from "../endpoint/type/MutableEndpoint.js"; import { Identity } from "@matter/general"; /** * This defines conformance to the Water Valve device type. * * ### Cluster Requirements * * #### Identify Cluster * * This cluster is used to identify the device. * * #### Valve Configuration and Control Cluster * * This cluster is used to configure and control (Open/Close) the valve. * * #### Flow Measurement Cluster * * The cluster server, if present, shall be used to report the measured flow through the valve. * * The cluster client, if present, may be used via binding to close a control loop of flow through the valve. * * ### Device implementation recommendations * * #### Start Up Behavior * * The start up behavior of a device with this device type, is currently not specified and is considered manufacturer * specific. This means that the start up behavior and what is considered the "safe state", most suitable for the * specific device, is defined by the manufacturer. * * #### Firmware Update * * When a device with this device type needs to update its firmware (or restart for another reason), it is strongly * recommended to only perform the update/restart when the valve is in its closed state, as well as ignoring any open * request during this update/restart, given the chance a valve can unintentionally be left in the open state, for * longer periods of time. * * @see {@link MatterSpecification.v161.Device} ยง 5.6 */ export interface WaterValveDevice extends Identity { } export declare namespace WaterValveRequirements { /** * The Identify cluster is required by the Matter specification. * * We provide this alias to the default implementation {@link IdentifyServer} for convenience. */ const IdentifyServer: typeof BaseIdentifyServer; /** * The ValveConfigurationAndControl cluster is required by the Matter specification. * * We provide this alias to the default implementation {@link ValveConfigurationAndControlServer} for convenience. */ const ValveConfigurationAndControlServer: typeof BaseValveConfigurationAndControlServer; /** * The FlowMeasurement cluster is optional per the Matter specification. * * We provide this alias to the default implementation {@link FlowMeasurementServer} for convenience. */ const FlowMeasurementServer: typeof BaseFlowMeasurementServer; /** * The FlowMeasurement cluster is optional per the Matter specification. * * We provide this alias to the default implementation {@link FlowMeasurementClient} for convenience. */ const FlowMeasurementClient: import("../behaviors/flow-measurement/FlowMeasurementClient.js").FlowMeasurementClientConstructor; /** * An implementation for each server cluster supported by the endpoint per the Matter specification. */ const server: { mandatory: { Identify: typeof BaseIdentifyServer; ValveConfigurationAndControl: typeof BaseValveConfigurationAndControlServer; }; optional: { FlowMeasurement: typeof BaseFlowMeasurementServer; }; }; /** * A definition for each client cluster supported by the endpoint per the Matter specification. */ const client: { optional: { FlowMeasurement: import("../behaviors/flow-measurement/FlowMeasurementClient.js").FlowMeasurementClientConstructor; }; }; } export declare const WaterValveDeviceDefinition: MutableEndpoint.With, { readonly identify: typeof BaseIdentifyServer; } & { readonly valveConfigurationAndControl: typeof BaseValveConfigurationAndControlServer; }, {}>; export declare const WaterValveDevice: WaterValveDevice; //# sourceMappingURL=water-valve.d.ts.map