zigbee-herdsman/dist/zspec/zcl/zclFrame.d.ts

An open source Zigbee gateway solution with node.js.

import "../../utils/patchBigIntSerialization";
import type { TClusterPayload, TFoundationPayload } from "./definition/clusters-types";
import { Direction, FrameType } from "./definition/enums";
import type { FoundationCommandName, FoundationDefinition } from "./definition/foundation";
import type { Cluster, ClusterName, Command, CustomClusters, Parameter } from "./definition/tstype";
import { ZclHeader } from "./zclHeader";
type ZclPayload = any;
export declare class ZclFrame {
    readonly header: ZclHeader;
    readonly payload: ZclPayload;
    readonly cluster: Cluster;
    readonly command: Command | FoundationDefinition;
    private constructor();
    toString(): string;
    /**
     * Creating
     */
    static create(frameType: FrameType, direction: Direction, disableDefaultResponse: boolean, manufacturerCode: number | undefined, transactionSequenceNumber: number, commandKey: number | string | Command | FoundationDefinition, clusterKey: number | string | Cluster, payload: ZclPayload, customClusters: CustomClusters, reservedBits?: number): ZclFrame;
    toBuffer(): Buffer;
    private writePayloadGlobal;
    private writePayloadCluster;
    /**
     * Parsing
     */
    static fromBuffer(clusterID: number, header: ZclHeader | undefined, buffer: Buffer, customClusters: CustomClusters): ZclFrame;
    private static parsePayload;
    private static parsePayloadCluster;
    private static parsePayloadGlobal;
    /**
     * Utils
     */
    static conditionsValid(parameter: Parameter, entry: ZclPayload, remainingBufferBytes: number | undefined): boolean;
    isCluster(clusterName: FoundationCommandName | ClusterName): boolean;
    isCommand(commandName: FoundationCommandName | "remove" | "add" | "write" | "enrollReq" | "checkin" | "getAlarm" | "arm" | "queryNextImageRequest"): boolean;
}
export interface TZclFrame<Cl extends string, Co extends string> {
    readonly header: ZclHeader;
    readonly payload: TClusterPayload<Cl, Co>;
    readonly cluster: Cluster;
    readonly command: Command;
}
export interface TFoundationZclFrame<Co extends string> {
    readonly header: ZclHeader;
    readonly payload: TFoundationPayload<Co>;
    readonly cluster: Cluster;
    readonly command: FoundationDefinition;
}
export {};
//# sourceMappingURL=zclFrame.d.ts.map