inventoresed
Version:
Z-Wave driver written entirely in JavaScript/TypeScript
1,293 lines (1,247 loc) • 694 kB
Markdown
## API Report File for "@zwave-js/cc"
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
/// <reference types="node" />
import { AllOrNone } from '@zwave-js/shared/safe';
import type { AllOrNone as AllOrNone_2 } from '@zwave-js/shared';
import { ApplicationNodeInformation } from '@zwave-js/core/safe';
import { CommandClasses } from '@zwave-js/core/safe';
import { CommandClasses as CommandClasses_2 } from '@zwave-js/core';
import { ConfigurationMetadata } from '@zwave-js/core/safe';
import { ConfigValue } from '@zwave-js/core/safe';
import { ConfigValueFormat } from '@zwave-js/core/safe';
import { DataRate } from '@zwave-js/core';
import { DataRate as DataRate_2 } from '@zwave-js/core/safe';
import { DSTInfo } from '@zwave-js/core';
import { Duration } from '@zwave-js/core/safe';
import { Duration as Duration_2 } from '@zwave-js/core';
import { EncapsulationFlags } from '@zwave-js/core';
import { EncapsulationFlags as EncapsulationFlags_2 } from '@zwave-js/core/safe';
import { FLiRS } from '@zwave-js/core';
import { FLiRS as FLiRS_2 } from '@zwave-js/core/safe';
import type { GenericDeviceClass } from '@zwave-js/config';
import { ICommandClass } from '@zwave-js/core';
import { IVirtualEndpoint } from '@zwave-js/core';
import { IVirtualEndpoint as IVirtualEndpoint_2 } from '@zwave-js/core/safe';
import { IZWaveEndpoint } from '@zwave-js/core/safe';
import { IZWaveEndpoint as IZWaveEndpoint_2 } from '@zwave-js/core';
import { IZWaveNode } from '@zwave-js/core/safe';
import { IZWaveNode as IZWaveNode_2 } from '@zwave-js/core';
import { JSONObject } from '@zwave-js/shared';
import { Maybe } from '@zwave-js/core/safe';
import { Maybe as Maybe_2 } from '@zwave-js/core';
import type { Message } from '@zwave-js/serial';
import { MessageOrCCLogEntry } from '@zwave-js/core';
import { MessageOrCCLogEntry as MessageOrCCLogEntry_2 } from '@zwave-js/core/safe';
import { MessageOrigin } from '@zwave-js/serial';
import { MeterScale } from '@zwave-js/config';
import { MulticastCC } from '@zwave-js/core';
import { MulticastDestination } from '@zwave-js/core';
import { NODE_ID_BROADCAST } from '@zwave-js/core';
import { NodeInformationFrame } from '@zwave-js/core';
import { NodeProtocolInfoAndDeviceClass } from '@zwave-js/core';
import { NodeType } from '@zwave-js/core';
import { OnlyMethods } from '@zwave-js/shared';
import type { ParamInfoMap } from '@zwave-js/config';
import { ProtocolVersion } from '@zwave-js/core';
import { ReadonlyObjectKeyMap } from '@zwave-js/shared/safe';
import { Scale } from '@zwave-js/config';
import type { Scale as Scale_2 } from '@zwave-js/config/safe';
import { SecurityClass } from '@zwave-js/core';
import { SecurityManager } from '@zwave-js/core';
import { SecurityManager2 } from '@zwave-js/core';
import { SendCommandOptions } from '@zwave-js/core';
import { SinglecastCC } from '@zwave-js/core';
import { SinglecastCC as SinglecastCC_2 } from '@zwave-js/core/safe';
import type { SpecificDeviceClass } from '@zwave-js/config';
import { SupervisionResult } from '@zwave-js/core/safe';
import { SupervisionResult as SupervisionResult_2 } from '@zwave-js/core';
import { SupervisionStatus } from '@zwave-js/core/safe';
import { Timeout } from '@zwave-js/core/safe';
import { TXReport } from '@zwave-js/core';
import { TypedClassDecorator } from '@zwave-js/shared/safe';
import { TypedClassDecorator as TypedClassDecorator_2 } from '@zwave-js/shared';
import type { TypedPropertyDecorator } from '@zwave-js/shared';
import { ValueChangeOptions } from '@zwave-js/core';
import { ValueDB } from '@zwave-js/core';
import { ValueID } from '@zwave-js/core';
import { ValueID as ValueID_2 } from '@zwave-js/core/safe';
import { ValueMetadata } from '@zwave-js/core';
import { ValueMetadata as ValueMetadata_2 } from '@zwave-js/core/safe';
import type { ZWaveApplicationHost } from '@zwave-js/host/safe';
import type { ZWaveApplicationHost as ZWaveApplicationHost_2 } from '@zwave-js/host';
import { ZWaveDataRate } from '@zwave-js/core';
import { ZWaveDataRate as ZWaveDataRate_2 } from '@zwave-js/core/safe';
import { ZWaveErrorCodes } from '@zwave-js/core';
import type { ZWaveHost } from '@zwave-js/host';
import type { ZWaveHost as ZWaveHost_2 } from '@zwave-js/host/safe';
import { ZWaveLibraryTypes } from '@zwave-js/core/safe';
// Warning: (ae-missing-release-tag) "addAssociations" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
function addAssociations(applHost: ZWaveApplicationHost, endpoint: IZWaveEndpoint, group: number, destinations: AssociationAddress[]): Promise<void>;
// Warning: (ae-missing-release-tag) "AlarmSensorCC" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export class AlarmSensorCC extends CommandClass {
// (undocumented)
ccCommand: AlarmSensorCommand;
// (undocumented)
protected createMetadataForSensorType(applHost: ZWaveApplicationHost, sensorType: AlarmSensorType): void;
// (undocumented)
interview(applHost: ZWaveApplicationHost): Promise<void>;
// (undocumented)
refreshValues(applHost: ZWaveApplicationHost): Promise<void>;
}
// Warning: (ae-missing-release-tag) "AlarmSensorCCGet" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export class AlarmSensorCCGet extends AlarmSensorCC {
// Warning: (ae-forgotten-export) The symbol "AlarmSensorCCGetOptions" needs to be exported by the entry point index.d.ts
constructor(host: ZWaveHost_2, options: CommandClassDeserializationOptions | AlarmSensorCCGetOptions);
// (undocumented)
sensorType: AlarmSensorType;
// (undocumented)
serialize(): Buffer;
// (undocumented)
toLogEntry(applHost: ZWaveApplicationHost): MessageOrCCLogEntry_2;
}
// Warning: (ae-missing-release-tag) "AlarmSensorCCReport" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export class AlarmSensorCCReport extends AlarmSensorCC {
constructor(host: ZWaveHost_2, options: CommandClassDeserializationOptions);
// (undocumented)
readonly duration: number | undefined;
// (undocumented)
persistValues(applHost: ZWaveApplicationHost): boolean;
// (undocumented)
readonly sensorType: AlarmSensorType;
// (undocumented)
readonly severity: number | undefined;
// (undocumented)
readonly state: boolean;
// (undocumented)
toLogEntry(applHost: ZWaveApplicationHost): MessageOrCCLogEntry_2;
}
// Warning: (ae-missing-release-tag) "AlarmSensorCCSupportedGet" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export class AlarmSensorCCSupportedGet extends AlarmSensorCC {
}
// Warning: (ae-missing-release-tag) "AlarmSensorCCSupportedReport" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export class AlarmSensorCCSupportedReport extends AlarmSensorCC {
constructor(host: ZWaveHost_2, options: CommandClassDeserializationOptions);
// (undocumented)
persistValues(applHost: ZWaveApplicationHost): boolean;
// (undocumented)
get supportedSensorTypes(): readonly AlarmSensorType[];
// (undocumented)
toLogEntry(applHost: ZWaveApplicationHost): MessageOrCCLogEntry_2;
}
// Warning: (ae-missing-release-tag) "AlarmSensorCCValues" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export const AlarmSensorCCValues: Readonly<{
supportedSensorTypes: {
readonly id: {
commandClass: (typeof CommandClasses)["Alarm Sensor"];
property: "supportedSensorTypes";
};
readonly endpoint: (endpoint?: number | undefined) => {
readonly commandClass: (typeof CommandClasses)["Alarm Sensor"];
readonly endpoint: number;
readonly property: "supportedSensorTypes";
};
readonly is: (valueId: ValueID_2) => boolean;
readonly meta: {
readonly type: "any";
readonly readable: true;
readonly writeable: true;
};
readonly options: {
readonly minVersion: 1;
readonly stateful: true;
readonly secret: false;
readonly supportsEndpoints: true;
readonly autoCreate: true;
readonly internal: true;
};
};
duration: ((sensorType: AlarmSensorType) => {
readonly id: {
commandClass: (typeof CommandClasses)["Alarm Sensor"];
property: "duration";
propertyKey: AlarmSensorType;
};
readonly endpoint: (endpoint?: number | undefined) => {
readonly commandClass: (typeof CommandClasses)["Alarm Sensor"];
readonly endpoint: number;
readonly property: "duration";
readonly propertyKey: AlarmSensorType;
};
readonly meta: {
readonly unit: "s";
readonly label: `${string} duration`;
readonly description: "For how long the alarm should be active";
readonly ccSpecific: {
readonly sensorType: AlarmSensorType;
};
readonly writeable: false;
readonly type: "number";
readonly readable: true;
};
}) & {
is: (valueId: ValueID_2) => boolean;
readonly options: {
readonly internal: false;
readonly minVersion: 1;
readonly secret: false;
readonly stateful: true;
readonly supportsEndpoints: true;
readonly autoCreate: true;
};
};
severity: ((sensorType: AlarmSensorType) => {
readonly id: {
commandClass: (typeof CommandClasses)["Alarm Sensor"];
property: "severity";
propertyKey: AlarmSensorType;
};
readonly endpoint: (endpoint?: number | undefined) => {
readonly commandClass: (typeof CommandClasses)["Alarm Sensor"];
readonly endpoint: number;
readonly property: "severity";
readonly propertyKey: AlarmSensorType;
};
readonly meta: {
readonly min: 1;
readonly max: 100;
readonly unit: "%";
readonly label: `${string} severity`;
readonly ccSpecific: {
readonly sensorType: AlarmSensorType;
};
readonly writeable: false;
readonly type: "number";
readonly readable: true;
};
}) & {
is: (valueId: ValueID_2) => boolean;
readonly options: {
readonly internal: false;
readonly minVersion: 1;
readonly secret: false;
readonly stateful: true;
readonly supportsEndpoints: true;
readonly autoCreate: true;
};
};
state: ((sensorType: AlarmSensorType) => {
readonly id: {
commandClass: (typeof CommandClasses)["Alarm Sensor"];
property: "state";
propertyKey: AlarmSensorType;
};
readonly endpoint: (endpoint?: number | undefined) => {
readonly commandClass: (typeof CommandClasses)["Alarm Sensor"];
readonly endpoint: number;
readonly property: "state";
readonly propertyKey: AlarmSensorType;
};
readonly meta: {
readonly label: `${string} state`;
readonly description: "Whether the alarm is active";
readonly ccSpecific: {
readonly sensorType: AlarmSensorType;
};
readonly writeable: false;
readonly type: "boolean";
readonly readable: true;
};
}) & {
is: (valueId: ValueID_2) => boolean;
readonly options: {
readonly internal: false;
readonly minVersion: 1;
readonly secret: false;
readonly stateful: true;
readonly supportsEndpoints: true;
readonly autoCreate: true;
};
};
}>;
// Warning: (tsdoc-undefined-tag) The TSDoc tag "@publicAPI" is not defined in this configuration
// Warning: (ae-missing-release-tag) "AlarmSensorCommand" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export enum AlarmSensorCommand {
// (undocumented)
Get = 1,
// (undocumented)
Report = 2,
// (undocumented)
SupportedGet = 3,
// (undocumented)
SupportedReport = 4
}
// Warning: (tsdoc-undefined-tag) The TSDoc tag "@publicAPI" is not defined in this configuration
// Warning: (ae-missing-release-tag) "AlarmSensorType" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export enum AlarmSensorType {
// (undocumented)
"General Purpose" = 0,
// (undocumented)
"Water Leak" = 5,
// (undocumented)
Any = 255,
// (undocumented)
CO = 2,
// (undocumented)
CO2 = 3,
// (undocumented)
Heat = 4,
// (undocumented)
Smoke = 1
}
// Warning: (tsdoc-undefined-tag) The TSDoc tag "@publicAPI" is not defined in this configuration
// Warning: (ae-missing-release-tag) "AlarmSensorValueMetadata" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type AlarmSensorValueMetadata = ValueMetadata_2 & {
ccSpecific: {
sensorType: AlarmSensorType;
};
};
// Warning: (tsdoc-undefined-tag) The TSDoc tag "@publicAPI" is not defined in this configuration
// Warning: (ae-missing-release-tag) "API" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public
export const API: <TTarget extends CCAPI>(cc: CommandClasses_2) => TypedClassDecorator_2<TTarget>;
// Warning: (ae-missing-release-tag) "APIConstructor" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type APIConstructor<T extends CCAPI = CCAPI> = new (applHost: ZWaveApplicationHost_2, endpoint: IZWaveEndpoint_2 | IVirtualEndpoint) => T;
// Warning: (ae-missing-release-tag) "APIMethodsOf" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type APIMethodsOf<CC extends CommandClasses_2> = Omit<OnlyMethods<CCToAPI<CC>>, "isSetValueOptimistic" | "isSupported" | "supportsCommand" | "withOptions" | "withTXReport">;
// Warning: (tsdoc-undefined-tag) The TSDoc tag "@publicAPI" is not defined in this configuration
// Warning: (ae-missing-release-tag) "assertValidCCs" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export function assertValidCCs(container: ICommandClassContainer): void;
// Warning: (tsdoc-undefined-tag) The TSDoc tag "@publicAPI" is not defined in this configuration
// Warning: (ae-missing-release-tag) "AssociationAddress" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export interface AssociationAddress {
// (undocumented)
endpoint?: number;
// (undocumented)
nodeId: number;
}
// Warning: (ae-missing-release-tag) "AssociationCC" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export class AssociationCC extends CommandClass {
// (undocumented)
ccCommand: AssociationCommand;
// (undocumented)
determineRequiredCCInterviews(): readonly CommandClasses[];
static getAllDestinationsCached(applHost: ZWaveApplicationHost, endpoint: IZWaveEndpoint): ReadonlyMap<number, readonly AssociationAddress[]>;
static getGroupCountCached(applHost: ZWaveApplicationHost, endpoint: IZWaveEndpoint): number;
static getMaxNodesCached(applHost: ZWaveApplicationHost, endpoint: IZWaveEndpoint, groupId: number): number;
// (undocumented)
interview(applHost: ZWaveApplicationHost): Promise<void>;
// (undocumented)
refreshValues(applHost: ZWaveApplicationHost): Promise<void>;
}
// Warning: (ae-missing-release-tag) "AssociationCCGet" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export class AssociationCCGet extends AssociationCC {
// Warning: (ae-forgotten-export) The symbol "AssociationCCGetOptions" needs to be exported by the entry point index.d.ts
constructor(host: ZWaveHost_2, options: CommandClassDeserializationOptions | AssociationCCGetOptions);
// (undocumented)
groupId: number;
// (undocumented)
serialize(): Buffer;
// (undocumented)
toLogEntry(applHost: ZWaveApplicationHost): MessageOrCCLogEntry_2;
}
// Warning: (ae-missing-release-tag) "AssociationCCRemove" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export class AssociationCCRemove extends AssociationCC {
// Warning: (ae-forgotten-export) The symbol "AssociationCCRemoveOptions" needs to be exported by the entry point index.d.ts
constructor(host: ZWaveHost_2, options: CommandClassDeserializationOptions | (AssociationCCRemoveOptions & CCCommandOptions));
// (undocumented)
groupId?: number;
// (undocumented)
nodeIds?: number[];
// (undocumented)
serialize(): Buffer;
// (undocumented)
toLogEntry(applHost: ZWaveApplicationHost): MessageOrCCLogEntry_2;
}
// Warning: (ae-missing-release-tag) "AssociationCCReport" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export class AssociationCCReport extends AssociationCC {
constructor(host: ZWaveHost_2, options: CommandClassDeserializationOptions);
// (undocumented)
expectMoreMessages(): boolean;
// (undocumented)
getPartialCCSessionId(): Record<string, any> | undefined;
// (undocumented)
get groupId(): number;
// (undocumented)
get maxNodes(): number;
// (undocumented)
mergePartialCCs(applHost: ZWaveApplicationHost, partials: AssociationCCReport[]): void;
// (undocumented)
get nodeIds(): readonly number[];
// (undocumented)
get reportsToFollow(): number;
// (undocumented)
toLogEntry(applHost: ZWaveApplicationHost): MessageOrCCLogEntry_2;
}
// Warning: (ae-missing-release-tag) "AssociationCCSet" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export class AssociationCCSet extends AssociationCC {
// Warning: (ae-forgotten-export) The symbol "AssociationCCSetOptions" needs to be exported by the entry point index.d.ts
constructor(host: ZWaveHost_2, options: CommandClassDeserializationOptions | AssociationCCSetOptions);
// (undocumented)
groupId: number;
// (undocumented)
nodeIds: number[];
// (undocumented)
serialize(): Buffer;
// (undocumented)
toLogEntry(applHost: ZWaveApplicationHost): MessageOrCCLogEntry_2;
}
// Warning: (ae-missing-release-tag) "AssociationCCSupportedGroupingsGet" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export class AssociationCCSupportedGroupingsGet extends AssociationCC {
}
// Warning: (ae-missing-release-tag) "AssociationCCSupportedGroupingsReport" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export class AssociationCCSupportedGroupingsReport extends AssociationCC {
constructor(host: ZWaveHost_2, options: CommandClassDeserializationOptions);
// (undocumented)
get groupCount(): number;
// (undocumented)
toLogEntry(applHost: ZWaveApplicationHost): MessageOrCCLogEntry_2;
}
// Warning: (ae-missing-release-tag) "AssociationCCValues" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export const AssociationCCValues: Readonly<{
nodeIds: ((groupId: number) => {
readonly id: {
commandClass: CommandClasses.Association;
property: "nodeIds";
propertyKey: number;
};
readonly endpoint: (endpoint?: number | undefined) => {
readonly commandClass: CommandClasses.Association;
readonly endpoint: number;
readonly property: "nodeIds";
readonly propertyKey: number;
};
readonly meta: {
readonly type: "any";
readonly readable: true;
readonly writeable: true;
};
}) & {
is: (valueId: ValueID_2) => boolean;
readonly options: {
readonly minVersion: 1;
readonly stateful: true;
readonly secret: false;
readonly supportsEndpoints: true;
readonly autoCreate: true;
readonly internal: true;
};
};
maxNodes: ((groupId: number) => {
readonly id: {
commandClass: CommandClasses.Association;
property: "maxNodes";
propertyKey: number;
};
readonly endpoint: (endpoint?: number | undefined) => {
readonly commandClass: CommandClasses.Association;
readonly endpoint: number;
readonly property: "maxNodes";
readonly propertyKey: number;
};
readonly meta: {
readonly type: "any";
readonly readable: true;
readonly writeable: true;
};
}) & {
is: (valueId: ValueID_2) => boolean;
readonly options: {
readonly minVersion: 1;
readonly stateful: true;
readonly secret: false;
readonly supportsEndpoints: true;
readonly autoCreate: true;
readonly internal: true;
};
};
groupCount: {
readonly id: {
commandClass: CommandClasses.Association;
property: "groupCount";
};
readonly endpoint: (endpoint?: number | undefined) => {
readonly commandClass: CommandClasses.Association;
readonly endpoint: number;
readonly property: "groupCount";
};
readonly is: (valueId: ValueID_2) => boolean;
readonly meta: {
readonly type: "any";
readonly readable: true;
readonly writeable: true;
};
readonly options: {
readonly minVersion: 1;
readonly stateful: true;
readonly secret: false;
readonly supportsEndpoints: true;
readonly autoCreate: true;
readonly internal: true;
};
};
hasLifeline: {
readonly id: {
commandClass: CommandClasses.Association;
property: "hasLifeline";
};
readonly endpoint: (endpoint?: number | undefined) => {
readonly commandClass: CommandClasses.Association;
readonly endpoint: number;
readonly property: "hasLifeline";
};
readonly is: (valueId: ValueID_2) => boolean;
readonly meta: {
readonly type: "any";
readonly readable: true;
readonly writeable: true;
};
readonly options: {
readonly minVersion: 1;
readonly stateful: true;
readonly secret: false;
readonly supportsEndpoints: true;
readonly autoCreate: true;
readonly internal: true;
};
};
}>;
// Warning: (tsdoc-undefined-tag) The TSDoc tag "@publicAPI" is not defined in this configuration
// Warning: (ae-missing-release-tag) "AssociationCommand" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export enum AssociationCommand {
// (undocumented)
Get = 2,
// (undocumented)
Remove = 4,
// (undocumented)
Report = 3,
// (undocumented)
Set = 1,
// (undocumented)
SupportedGroupingsGet = 5,
// (undocumented)
SupportedGroupingsReport = 6
}
// Warning: (tsdoc-undefined-tag) The TSDoc tag "@publicAPI" is not defined in this configuration
// Warning: (ae-missing-release-tag) "AssociationGroup" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export interface AssociationGroup {
isLifeline: boolean;
issuedCommands?: ReadonlyMap<CommandClasses, readonly number[]>;
label: string;
maxNodes: number;
multiChannel: boolean;
profile?: AssociationGroupInfoProfile;
}
// Warning: (ae-missing-release-tag) "AssociationGroupInfoCC" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export class AssociationGroupInfoCC extends CommandClass {
// (undocumented)
ccCommand: AssociationGroupInfoCommand;
// (undocumented)
determineRequiredCCInterviews(): readonly CommandClasses[];
// (undocumented)
static findGroupsForIssuedCommand(applHost: ZWaveApplicationHost, endpoint: IZWaveEndpoint, ccId: CommandClasses, command: number): number[];
static getGroupNameCached(applHost: ZWaveApplicationHost, endpoint: IZWaveEndpoint, groupId: number): string | undefined;
static getGroupProfileCached(applHost: ZWaveApplicationHost, endpoint: IZWaveEndpoint, groupId: number): AssociationGroupInfoProfile | undefined;
static getIssuedCommandsCached(applHost: ZWaveApplicationHost, endpoint: IZWaveEndpoint, groupId: number): ReadonlyMap<CommandClasses, readonly number[]> | undefined;
// (undocumented)
interview(applHost: ZWaveApplicationHost): Promise<void>;
// (undocumented)
refreshValues(applHost: ZWaveApplicationHost): Promise<void>;
}
// Warning: (ae-missing-release-tag) "AssociationGroupInfoCCCommandListGet" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export class AssociationGroupInfoCCCommandListGet extends AssociationGroupInfoCC {
// Warning: (ae-forgotten-export) The symbol "AssociationGroupInfoCCCommandListGetOptions" needs to be exported by the entry point index.d.ts
constructor(host: ZWaveHost_2, options: CommandClassDeserializationOptions | AssociationGroupInfoCCCommandListGetOptions);
// (undocumented)
allowCache: boolean;
// (undocumented)
groupId: number;
// (undocumented)
serialize(): Buffer;
// (undocumented)
toLogEntry(applHost: ZWaveApplicationHost): MessageOrCCLogEntry_2;
}
// Warning: (ae-missing-release-tag) "AssociationGroupInfoCCCommandListReport" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export class AssociationGroupInfoCCCommandListReport extends AssociationGroupInfoCC {
constructor(host: ZWaveHost_2, options: CommandClassDeserializationOptions);
// (undocumented)
readonly commands: ReadonlyMap<CommandClasses, readonly number[]>;
// (undocumented)
readonly groupId: number;
// (undocumented)
toLogEntry(applHost: ZWaveApplicationHost): MessageOrCCLogEntry_2;
}
// Warning: (ae-missing-release-tag) "AssociationGroupInfoCCInfoGet" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export class AssociationGroupInfoCCInfoGet extends AssociationGroupInfoCC {
// Warning: (ae-forgotten-export) The symbol "AssociationGroupInfoCCInfoGetOptions" needs to be exported by the entry point index.d.ts
constructor(host: ZWaveHost_2, options: CommandClassDeserializationOptions | AssociationGroupInfoCCInfoGetOptions);
// (undocumented)
groupId?: number;
// (undocumented)
listMode?: boolean;
// (undocumented)
refreshCache: boolean;
// (undocumented)
serialize(): Buffer;
// (undocumented)
toLogEntry(applHost: ZWaveApplicationHost): MessageOrCCLogEntry_2;
}
// Warning: (ae-missing-release-tag) "AssociationGroupInfoCCInfoReport" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export class AssociationGroupInfoCCInfoReport extends AssociationGroupInfoCC {
constructor(host: ZWaveHost_2, options: CommandClassDeserializationOptions);
// Warning: (ae-forgotten-export) The symbol "AssociationGroupInfo" needs to be exported by the entry point index.d.ts
//
// (undocumented)
readonly groups: readonly AssociationGroupInfo[];
// (undocumented)
readonly hasDynamicInfo: boolean;
// (undocumented)
readonly isListMode: boolean;
// (undocumented)
persistValues(applHost: ZWaveApplicationHost): boolean;
// (undocumented)
toLogEntry(applHost: ZWaveApplicationHost): MessageOrCCLogEntry_2;
}
// Warning: (ae-missing-release-tag) "AssociationGroupInfoCCNameGet" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export class AssociationGroupInfoCCNameGet extends AssociationGroupInfoCC {
// Warning: (ae-forgotten-export) The symbol "AssociationGroupInfoCCNameGetOptions" needs to be exported by the entry point index.d.ts
constructor(host: ZWaveHost_2, options: CommandClassDeserializationOptions | AssociationGroupInfoCCNameGetOptions);
// (undocumented)
groupId: number;
// (undocumented)
serialize(): Buffer;
// (undocumented)
toLogEntry(applHost: ZWaveApplicationHost): MessageOrCCLogEntry_2;
}
// Warning: (ae-missing-release-tag) "AssociationGroupInfoCCNameReport" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export class AssociationGroupInfoCCNameReport extends AssociationGroupInfoCC {
constructor(host: ZWaveHost_2, options: CommandClassDeserializationOptions);
// (undocumented)
readonly groupId: number;
// (undocumented)
readonly name: string;
// (undocumented)
persistValues(applHost: ZWaveApplicationHost): boolean;
// (undocumented)
toLogEntry(applHost: ZWaveApplicationHost): MessageOrCCLogEntry_2;
}
// Warning: (ae-missing-release-tag) "AssociationGroupInfoCCValues" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export const AssociationGroupInfoCCValues: Readonly<{
commands: ((groupId: number) => {
readonly id: {
commandClass: (typeof CommandClasses)["Association Group Information"];
property: "issuedCommands";
propertyKey: number;
};
readonly endpoint: (endpoint?: number | undefined) => {
readonly commandClass: (typeof CommandClasses)["Association Group Information"];
readonly endpoint: number;
readonly property: "issuedCommands";
readonly propertyKey: number;
};
readonly meta: {
readonly type: "any";
readonly readable: true;
readonly writeable: true;
};
}) & {
is: (valueId: ValueID_2) => boolean;
readonly options: {
readonly minVersion: 1;
readonly stateful: true;
readonly secret: false;
readonly supportsEndpoints: true;
readonly autoCreate: true;
readonly internal: true;
};
};
groupInfo: ((groupId: number) => {
readonly id: {
commandClass: (typeof CommandClasses)["Association Group Information"];
property: "info";
propertyKey: number;
};
readonly endpoint: (endpoint?: number | undefined) => {
readonly commandClass: (typeof CommandClasses)["Association Group Information"];
readonly endpoint: number;
readonly property: "info";
readonly propertyKey: number;
};
readonly meta: {
readonly type: "any";
readonly readable: true;
readonly writeable: true;
};
}) & {
is: (valueId: ValueID_2) => boolean;
readonly options: {
readonly minVersion: 1;
readonly stateful: true;
readonly secret: false;
readonly supportsEndpoints: true;
readonly autoCreate: true;
readonly internal: true;
};
};
groupName: ((groupId: number) => {
readonly id: {
commandClass: (typeof CommandClasses)["Association Group Information"];
property: "name";
propertyKey: number;
};
readonly endpoint: (endpoint?: number | undefined) => {
readonly commandClass: (typeof CommandClasses)["Association Group Information"];
readonly endpoint: number;
readonly property: "name";
readonly propertyKey: number;
};
readonly meta: {
readonly type: "any";
readonly readable: true;
readonly writeable: true;
};
}) & {
is: (valueId: ValueID_2) => boolean;
readonly options: {
readonly minVersion: 1;
readonly stateful: true;
readonly secret: false;
readonly supportsEndpoints: true;
readonly autoCreate: true;
readonly internal: true;
};
};
hasDynamicInfo: {
readonly id: {
commandClass: (typeof CommandClasses)["Association Group Information"];
property: "hasDynamicInfo";
};
readonly endpoint: (endpoint?: number | undefined) => {
readonly commandClass: (typeof CommandClasses)["Association Group Information"];
readonly endpoint: number;
readonly property: "hasDynamicInfo";
};
readonly is: (valueId: ValueID_2) => boolean;
readonly meta: {
readonly type: "any";
readonly readable: true;
readonly writeable: true;
};
readonly options: {
readonly minVersion: 1;
readonly stateful: true;
readonly secret: false;
readonly supportsEndpoints: true;
readonly autoCreate: true;
readonly internal: true;
};
};
}>;
// Warning: (tsdoc-undefined-tag) The TSDoc tag "@publicAPI" is not defined in this configuration
// Warning: (ae-missing-release-tag) "AssociationGroupInfoCommand" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export enum AssociationGroupInfoCommand {
// (undocumented)
CommandListGet = 5,
// (undocumented)
CommandListReport = 6,
// (undocumented)
InfoGet = 3,
// (undocumented)
InfoReport = 4,
// (undocumented)
NameGet = 1,
// (undocumented)
NameReport = 2
}
// Warning: (tsdoc-undefined-tag) The TSDoc tag "@publicAPI" is not defined in this configuration
// Warning: (ae-missing-release-tag) "AssociationGroupInfoProfile" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export enum AssociationGroupInfoProfile {
// (undocumented)
"Control: Key 01" = 8193,
// (undocumented)
"Control: Key 02" = 8194,
// (undocumented)
"Control: Key 03" = 8195,
// (undocumented)
"Control: Key 04" = 8196,
// (undocumented)
"Control: Key 05" = 8197,
// (undocumented)
"Control: Key 06" = 8198,
// (undocumented)
"Control: Key 07" = 8199,
// (undocumented)
"Control: Key 08" = 8200,
// (undocumented)
"Control: Key 09" = 8201,
// (undocumented)
"Control: Key 10" = 8202,
// (undocumented)
"Control: Key 11" = 8203,
// (undocumented)
"Control: Key 12" = 8204,
// (undocumented)
"Control: Key 13" = 8205,
// (undocumented)
"Control: Key 14" = 8206,
// (undocumented)
"Control: Key 15" = 8207,
// (undocumented)
"Control: Key 16" = 8208,
// (undocumented)
"Control: Key 17" = 8209,
// (undocumented)
"Control: Key 18" = 8210,
// (undocumented)
"Control: Key 19" = 8211,
// (undocumented)
"Control: Key 20" = 8212,
// (undocumented)
"Control: Key 21" = 8213,
// (undocumented)
"Control: Key 22" = 8214,
// (undocumented)
"Control: Key 23" = 8215,
// (undocumented)
"Control: Key 24" = 8216,
// (undocumented)
"Control: Key 25" = 8217,
// (undocumented)
"Control: Key 26" = 8218,
// (undocumented)
"Control: Key 27" = 8219,
// (undocumented)
"Control: Key 28" = 8220,
// (undocumented)
"Control: Key 29" = 8221,
// (undocumented)
"Control: Key 30" = 8222,
// (undocumented)
"Control: Key 31" = 8223,
// (undocumented)
"Control: Key 32" = 8224,
// (undocumented)
"General: Lifeline" = 1,
// (undocumented)
"General: N/A" = 0,
// (undocumented)
"Irrigation: Channel 01" = 27393,
// (undocumented)
"Irrigation: Channel 02" = 27394,
// (undocumented)
"Irrigation: Channel 03" = 27395,
// (undocumented)
"Irrigation: Channel 04" = 27396,
// (undocumented)
"Irrigation: Channel 05" = 27397,
// (undocumented)
"Irrigation: Channel 06" = 27398,
// (undocumented)
"Irrigation: Channel 07" = 27399,
// (undocumented)
"Irrigation: Channel 08" = 27400,
// (undocumented)
"Irrigation: Channel 09" = 27401,
// (undocumented)
"Irrigation: Channel 10" = 27402,
// (undocumented)
"Irrigation: Channel 11" = 27403,
// (undocumented)
"Irrigation: Channel 12" = 27404,
// (undocumented)
"Irrigation: Channel 13" = 27405,
// (undocumented)
"Irrigation: Channel 14" = 27406,
// (undocumented)
"Irrigation: Channel 15" = 27407,
// (undocumented)
"Irrigation: Channel 16" = 27408,
// (undocumented)
"Irrigation: Channel 17" = 27409,
// (undocumented)
"Irrigation: Channel 18" = 27410,
// (undocumented)
"Irrigation: Channel 19" = 27411,
// (undocumented)
"Irrigation: Channel 20" = 27412,
// (undocumented)
"Irrigation: Channel 21" = 27413,
// (undocumented)
"Irrigation: Channel 22" = 27414,
// (undocumented)
"Irrigation: Channel 23" = 27415,
// (undocumented)
"Irrigation: Channel 24" = 27416,
// (undocumented)
"Irrigation: Channel 25" = 27417,
// (undocumented)
"Irrigation: Channel 26" = 27418,
// (undocumented)
"Irrigation: Channel 27" = 27419,
// (undocumented)
"Irrigation: Channel 28" = 27420,
// (undocumented)
"Irrigation: Channel 29" = 27421,
// (undocumented)
"Irrigation: Channel 30" = 27422,
// (undocumented)
"Irrigation: Channel 31" = 27423,
// (undocumented)
"Irrigation: Channel 32" = 27424,
// (undocumented)
"Meter: Cooling" = 12805,
// (undocumented)
"Meter: Electric" = 12801,
// (undocumented)
"Meter: Gas" = 12802,
// (undocumented)
"Meter: Heating" = 12804,
// (undocumented)
"Meter: Water" = 12803,
// (undocumented)
"Notification: Access Control" = 28934,
// (undocumented)
"Notification: Appliance" = 28940,
// (undocumented)
"Notification: Clock" = 28939,
// (undocumented)
"Notification: CO Alarm" = 28930,
// (undocumented)
"Notification: CO2 Alarm" = 28931,
// (undocumented)
"Notification: Emergency Alarm" = 28938,
// (undocumented)
"Notification: Gas alarm" = 28946,
// (undocumented)
"Notification: Heat Alarm" = 28932,
// (undocumented)
"Notification: Home Health" = 28941,
// (undocumented)
"Notification: Home monitoring" = 28950,
// (undocumented)
"Notification: Home Security" = 28935,
// (undocumented)
"Notification: Irrigation" = 28945,
// (undocumented)
"Notification: Light sensor" = 28948,
// (undocumented)
"Notification: Pest Control" = 28947,
// (undocumented)
"Notification: Power Management" = 28936,
// (undocumented)
"Notification: Siren" = 28942,
// (undocumented)
"Notification: Smoke Alarm" = 28929,
// (undocumented)
"Notification: System" = 28937,
// (undocumented)
"Notification: Water Alarm" = 28933,
// (undocumented)
"Notification: Water Quality Monitoring" = 28949,
// (undocumented)
"Notification: Water Valve" = 28943,
// (undocumented)
"Notification: Weather Alarm" = 28944,
// (undocumented)
"Sensor: Acceleration X-axis" = 12596,
// (undocumented)
"Sensor: Acceleration Y-axis" = 12597,
// (undocumented)
"Sensor: Acceleration Z-axis" = 12598,
// (undocumented)
"Sensor: Air flow" = 12562,
// (undocumented)
"Sensor: Air temperature" = 12545,
// (undocumented)
"Sensor: Angle position" = 12565,
// (undocumented)
"Sensor: Applied force on the sensor" = 12615,
// (undocumented)
"Sensor: Atmospheric pressure" = 12552,
// (undocumented)
"Sensor: Barometric pressure" = 12553,
// (undocumented)
"Sensor: Basis metabolic rate (BMR)" = 12594,
// (undocumented)
"Sensor: Blood pressure" = 12589,
// (undocumented)
"Sensor: Body Mass Index (BMI)" = 12595,
// (undocumented)
"Sensor: Boiler water temperature" = 12606,
// (undocumented)
"Sensor: Bone mass" = 12592,
// (undocumented)
"Sensor: Carbon dioxide (CO2) level" = 12561,
// (undocumented)
"Sensor: Carbon monoxide (CO) level" = 12584,
// (undocumented)
"Sensor: Condenser Coil temperature" = 12618,
// (undocumented)
"Sensor: Current" = 12560,
// (undocumented)
"Sensor: Defrost temperature" = 12624,
// (undocumented)
"Sensor: Dew point" = 12555,
// (undocumented)
"Sensor: Direction" = 12551,
// (undocumented)
"Sensor: Discharge Line temperature" = 12621,
// (undocumented)
"Sensor: Discharge Pressure" = 12623,
// (undocumented)
"Sensor: Distance" = 12564,
// (undocumented)
"Sensor: Domestic Hot Water (DHW) temperature" = 12607,
// (undocumented)
"Sensor: Electrical conductivity" = 12573,
// (undocumented)
"Sensor: Electrical resistivity" = 12572,
// (undocumented)
"Sensor: Evaporator Coil temperature" = 12619,
// (undocumented)
"Sensor: Exhaust temperature" = 12609,
// (undocumented)
"Sensor: Fat mass" = 12591,
// (undocumented)
"Sensor: Formaldehyde (CH2O) level" = 12580,
// (undocumented)
"Sensor: Frequency" = 12576,
// (undocumented)
"Sensor: General purpose" = 12546,
// (undocumented)
"Sensor: Heart Rate LF/HF ratio" = 12613,
// (undocumented)
"Sensor: Heart rate" = 12588,
// (undocumented)
"Sensor: Humidity" = 12549,
// (undocumented)
"Sensor: Illuminance" = 12547,
// (undocumented)
"Sensor: Liquid Line temperature" = 12620,
// (undocumented)
"Sensor: Loudness" = 12574,
// (undocumented)
"Sensor: Methane (CH4) density" = 12582,
// (undocumented)
"Sensor: Moisture" = 12575,
// (undocumented)
"Sensor: Motion Direction" = 12614,
// (undocumented)
"Sensor: Muscle mass" = 12590,
// (undocumented)
"Sensor: Outside temperature" = 12608,
// (undocumented)
"Sensor: Particulate Matter 10" = 12603,
// (undocumented)
"Sensor: Particulate Matter 2.5" = 12579,
// (undocumented)
"Sensor: Power" = 12548,
// (undocumented)
"Sensor: Radon concentration" = 12581,
// (undocumented)
"Sensor: Rain rate" = 12556,
// (undocumented)
"Sensor: Relative Modulation level" = 12605,
// (undocumented)
"Sensor: Respiratory rate" = 12604,
// (undocumented)
"Sensor: Return Air temperature" = 12616,
// (undocumented)
"Sensor: RF signal strength" = 12602,
// (undocumented)
"Sensor: Rotation" = 12566,
// (undocumented)
"Sensor: Seismic Intensity" = 12569,
// (undocumented)
"Sensor: Seismic magnitude" = 12570,
// (undocumented)
"Sensor: Smoke density" = 12599,
// (undocumented)
"Sensor: Soil humidity" = 12585,
// (undocumented)
"Sensor: Soil reactivity" = 12586,
// (undocumented)
"Sensor: Soil salinity" = 12587,
// (undocumented)
"Sensor: Soil temperature" = 12568,
// (undocumented)
"Sensor: Solar radiation" = 12554,
// (undocumented)
"Sensor: Suction Pressure" = 12622,
// (undocumented)
"Sensor: Supply Air temperature" = 12617,
// (undocumented)
"Sensor: Tank capacity" = 12563,
// (undocumented)
"Sensor: Target temperature" = 12578,
// (undocumented)
"Sensor: Tide level" = 12557,
// (undocumented)
"Sensor: Time" = 12577,
// (undocumented)
"Sensor: Total body water (TBW)" = 12593,
// (undocumented)
"Sensor: Ultraviolet" = 12571,
// (undocumented)
"Sensor: Velocity" = 12550,
// (undocumented)
"Sensor: Volatile Organic Compound level" = 12583,
// (undocumented)
"Sensor: Voltage" = 12559,
// (undocumented)
"Sensor: Water acidity" = 12611,
// (undocumented)
"Sensor: Water Chlorine level" = 12610,
// (undocumented)
"Sensor: Water flow" = 12600,
// (undocumented)
"Sensor: Water Oxidation reduction potential" = 12612,
// (undocumented)
"Sensor: Water pressure" = 12601,
// (undocumented)
"Sensor: Water temperature" = 12567,
// (undocumented)
"Sensor: Weight" = 12558
}
// Warning: (ae-missing-release-tag) "BarrierOperatorCC" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export class BarrierOperatorCC extends CommandClass {
// (undocumented)
ccCommand: BarrierOperatorCommand;
// (undocumented)
interview(applHost: ZWaveApplicationHost): Promise<void>;
// (undocumented)
refreshValues(applHost: ZWaveApplicationHost): Promise<void>;
}
// Warning: (ae-missing-release-tag) "BarrierOperatorCCEventSignalingGet" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export class BarrierOperatorCCEventSignalingGet extends BarrierOperatorCC {
// Warning: (ae-forgotten-export) The symbol "BarrierOperatorCCEventSignalingGetOptions" needs to be exported by the entry point index.d.ts
constructor(host: ZWaveHost_2, options: CommandClassDeserializationOptions | BarrierOperatorCCEventSignalingGetOptions);
// (undocumented)
serialize(): Buffer;
// (undocumented)
subsystemType: SubsystemType;
// (undocumented)
toLogEntry(applHost: ZWaveApplicationHost): MessageOrCCLogEntry_2;
}
// Warning: (ae-missing-release-tag) "BarrierOperatorCCEventSignalingReport" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export class BarrierOperatorCCEventSignalingReport extends BarrierOperatorCC {
constructor(host: ZWaveHost_2, options: CommandClassDeserializationOptions);
// (undocumented)
persistValues(applHost: ZWaveApplicationHost): boolean;
// (undocumented)
readonly subsystemState: SubsystemState;
// (undocumented)
readonly subsystemType: SubsystemType;
// (undocumented)
toLogEntry(applHost: ZWaveApplicationHost): MessageOrCCLogEntry_2;
}
// Warning: (ae-missing-release-tag) "BarrierOperatorCCEventSignalingSet" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export class BarrierOperatorCCEventSignalingSet extends BarrierOperatorCC {
// Warning: (ae-forgotten-export) The symbol "BarrierOperatorCCEventSignalingSetOptions" needs to be exported by the entry point index.d.ts
constructor(host: ZWaveHost_2, options: CommandClassDeserializationOptions | BarrierOperatorCCEventSignalingSetOptions);
// (undocumented)
serialize(): Buffer;
// (undocumented)
subsystemState: SubsystemState;
// (undocumented)
subsystemType: SubsystemType;
// (undocumented)
toLogEntry(applHost: ZWaveApplicationHost): MessageOrCCLogEntry_2;
}
// Warning: (ae-missing-release-tag) "BarrierOperatorCCGet" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export class BarrierOperatorCCGet extends BarrierOperatorCC {
}
// Warning: (ae-missing-release-tag) "BarrierOperatorCCReport" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export class BarrierOperatorCCReport extends BarrierOperatorCC {
constructor(host: ZWaveHost_2, options: CommandClassDeserializationOptions);
// (undocumented)
readonly currentState: BarrierState | undefined;
// (undocumented)
readonly position: number | undefined;
// (undocumented)
toLogEntry(applHost: ZWaveApplicationHost): MessageOrCCLogEntry_2;
}
// Warning: (ae-missing-release-tag) "BarrierOperatorCCSet" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumente