zigbee-herdsman 6.0.1 → 6.0.3

package/src/zspec/zcl/definition/consts.ts

@@ -1,24 +0,0 @@
-/** Mapping of power source bits to descriptive string. */
-export const POWER_SOURCES: Readonly<{[s: number]: string}> = {
-    0: "Unknown",
-    1: "Mains (single phase)",
-    2: "Mains (3 phase)",
-    3: "Battery",
-    4: "DC Source",
-    5: "Emergency mains constantly powered",
-    6: "Emergency mains and transfer switch",
-};
-
-/** Mapping of device type to ID */
-export const ENDPOINT_DEVICE_TYPE: Readonly<{[s: string]: number}> = {
-    ZLLOnOffLight: 0x0000,
-    ZLLOnOffPluginUnit: 0x0010,
-    ZLLDimmableLight: 0x0100,
-    ZLLDimmablePluginUnit: 0x0110,
-    ZLLColorLight: 0x0200,
-    ZLLExtendedColorLight: 0x0210,
-    ZLLColorTemperatureLight: 0x0220,
-    HAOnOffLight: 0x0100,
-    HADimmableLight: 0x0101,
-    HAColorLight: 0x0102,
-};

package/src/zspec/zcl/definition/enums.ts

@@ -1,203 +0,0 @@
-/**
- * This is the specification-defined data types. It should not contain "custom" types and is expected to have [0x00-0xFF] values.
- *
- * - Values of analog types may be added to or subtracted from other values of the same type and are typically
- * used to measure the value of properties in the real world that vary continuously over a range.
- * - Values of discrete data types only have meaning as individual values and may not be added or subtracted.
- */
-export enum DataType {
-    /** length=0 */
-    NO_DATA = 0x00,
-
-    /** class=discrete, length=1 */
-    DATA8 = 0x08,
-    /** class=discrete, length=2 */
-    DATA16 = 0x09,
-    /** class=discrete, length=3 */
-    DATA24 = 0x0a,
-    /** class=discrete, length=4 */
-    DATA32 = 0x0b,
-    /** class=discrete, length=5 */
-    DATA40 = 0x0c,
-    /** class=discrete, length=6 */
-    DATA48 = 0x0d,
-    /** class=discrete, length=7 */
-    DATA56 = 0x0e,
-    /** class=discrete, length=8 */
-    DATA64 = 0x0f,
-    /** 0x00=false, 0x01=true, class=discrete, length=1, non-value=0xFF */
-    BOOLEAN = 0x10,
-
-    /** class=discrete, length=1 */
-    BITMAP8 = 0x18,
-    /** class=discrete, length=2 */
-    BITMAP16 = 0x19,
-    /** class=discrete, length=3 */
-    BITMAP24 = 0x1a,
-    /** class=discrete, length=4 */
-    BITMAP32 = 0x1b,
-    /** class=discrete, length=5 */
-    BITMAP40 = 0x1c,
-    /** class=discrete, length=6 */
-    BITMAP48 = 0x1d,
-    /** class=discrete, length=7 */
-    BITMAP56 = 0x1e,
-    /** class=discrete, length=8 */
-    BITMAP64 = 0x1f,
-    /** class=discrete, length=1, non-value=0xFF */
-    UINT8 = 0x20,
-    /** class=analog, length=2, non-value=0xFFFF */
-    UINT16 = 0x21,
-    /** class=analog, length=3, non-value=0xFFFFFF */
-    UINT24 = 0x22,
-    /** class=analog, length=4, non-value=0xFFFFFFFF */
-    UINT32 = 0x23,
-    /** class=analog, length=5, non-value=0xFFFFFFFFFF */
-    UINT40 = 0x24,
-    /** class=analog, length=6, non-value=0xFFFFFFFFFFFF */
-    UINT48 = 0x25,
-    /** class=analog, length=7, non-value=0xFFFFFFFFFFFFFF */
-    UINT56 = 0x26,
-    /** class=analog, length=8, non-value=0xFFFFFFFFFFFFFFFF */
-    UINT64 = 0x27,
-    /** class=analog, length=1, non-value=0x80 */
-    INT8 = 0x28,
-    /** class=analog, length=2, non-value=0x8000 */
-    INT16 = 0x29,
-    /** class=analog, length=3, non-value=0x800000 */
-    INT24 = 0x2a,
-    /** class=analog, length=4, non-value=0x80000000 */
-    INT32 = 0x2b,
-    /** class=analog, length=5, non-value=0x8000000000 */
-    INT40 = 0x2c,
-    /** class=analog, length=6, non-value=0x800000000000 */
-    INT48 = 0x2d,
-    /** class=analog, length=7, non-value=0x80000000000000 */
-    INT56 = 0x2e,
-    /** class=analog, length=8, non-value=0x8000000000000000 */
-    INT64 = 0x2f,
-    /** class=discrete, length=1, non-value=0xFF */
-    ENUM8 = 0x30,
-    /** class=discrete, length=2, non-value=0xFF */
-    ENUM16 = 0x31,
-
-    /** class=analog, length=2, non-value=NaN */
-    SEMI_PREC = 0x38,
-    /** class=analog, length=4, non-value=NaN */
-    SINGLE_PREC = 0x39,
-    /** class=analog, length=8, non-value=NaN */
-    DOUBLE_PREC = 0x3a,
-
-    /** class=composite, length=0x00-0xFE, non-value=0xFF */
-    OCTET_STR = 0x41,
-    /** class=composite, length=0x00-0xFE, non-value=0xFF */
-    CHAR_STR = 0x42,
-    /** class=composite, length=0x0000-0xFFFE, non-value=0xFFFF */
-    LONG_OCTET_STR = 0x43,
-    /** class=composite, length=0x0000-0xFFFE, non-value=0xFFFF */
-    LONG_CHAR_STR = 0x44,
-
-    /** class=composite, length=variable, non-value=(length=0xFFFF) */
-    ARRAY = 0x48,
-
-    /** class=composite, length=variable, non-value=(length=0xFFFF) */
-    STRUCT = 0x4c,
-
-    /** class=composite, length=max(0xFFFE * DataType) non-value=(length=0xFFFF) */
-    SET = 0x50,
-    /** @see SET Same but allows duplicate values */
-    BAG = 0x51,
-
-    /** Time of Day, @see ZclTimeOfDay , class=analog, length=4, unused-subfield=0xFF, non-value=0xFFFFFFFF */
-    TOD = 0xe0,
-    /** @see ZclDate , class=analog, length=4, unused-subfield=0xFF, non-value=0xFFFFFFFF */
-    DATE = 0xe1,
-    /** Number of seconds since 2000-01-01 00:00:00 UTC, class=analog, length=4, non-value=0xFFFFFFFF */
-    UTC = 0xe2,
-
-    /** Defined in 2.6.1.3 of ZCL spec, class=discrete, length=2, non-value=0xFFFF */
-    CLUSTER_ID = 0xe8,
-    /** Defined in 2.6.1.4 of ZCL spec, class=discrete, length=2, non-value=0xFFFF */
-    ATTR_ID = 0xe9,
-    /** BACnet OID, allow internetworking (format defined in BACnet ref), class=discrete, length=4, non-value=0xFFFFFFFF */
-    BAC_OID = 0xea,
-
-    /** class=discrete, length=8, non-value=0xFFFFFFFFFFFFFFFF */
-    IEEE_ADDR = 0xf0,
-    /** Any 128-bit value, class=discrete, length=16 */
-    SEC_KEY = 0xf1,
-
-    /** length=0 */
-    UNKNOWN = 0xff,
-}
-
-/** @TODO strings for backwards compat in tests. Should be moved to numbers. */
-export enum DataTypeClass {
-    ANALOG = "ANALOG",
-    DISCRETE = "DISCRETE",
-}
-
-export enum BuffaloZclDataType {
-    USE_DATA_TYPE = 1000,
-    LIST_UINT8 = 1001,
-    LIST_UINT16 = 1002,
-    LIST_UINT24 = 1003,
-    LIST_UINT32 = 1004,
-    LIST_ZONEINFO = 1005,
-    EXTENSION_FIELD_SETS = 1006,
-    LIST_THERMO_TRANSITIONS = 1007,
-    BUFFER = 1008,
-    GPD_FRAME = 1009,
-    STRUCTURED_SELECTOR = 1010,
-    LIST_TUYA_DATAPOINT_VALUES = 1011,
-    LIST_MIBOXER_ZONES = 1012,
-    BIG_ENDIAN_UINT24 = 1013,
-    MI_STRUCT = 1014,
-}
-
-/** @TODO strings for backwards compat in tests. Should be moved to numbers. */
-export enum ParameterCondition {
-    MINIMUM_REMAINING_BUFFER_BYTES = "minimumRemainingBufferBytes",
-    BITMASK_SET = "bitMaskSet",
-    BITFIELD_ENUM = "bitFieldEnum",
-    DATA_TYPE_CLASS_EQUAL = "dataTypeValueTypeEquals",
-    FIELD_EQUAL = "fieldEquals",
-    FIELD_GT = "fieldGT",
-}
-
-export enum FrameType {
-    GLOBAL = 0,
-    SPECIFIC = 1,
-}
-
-export enum Direction {
-    CLIENT_TO_SERVER = 0,
-    SERVER_TO_CLIENT = 1,
-}
-
-/**
- * The upper 4 bits of the Indicator subfield for Attributes Structured commands.
- */
-export enum StructuredIndicatorType {
-    /**
-     * Write: Only for attributes of type other than array, structure, set or bag
-     *
-     * Read: Only for attributes of type other than array or structure
-     */
-    Whole = 0x00,
-    /** Add element to the set/bag */
-    WriteAdd = 0x10,
-    /** Remove element from the set/bag */
-    WriteRemove = 0x20,
-}
-
-/** Mapping of descriptive string power to source bits. */
-export enum PowerSource {
-    Unknown = 0,
-    "Mains (single phase)" = 1,
-    "Mains (3 phase)" = 2,
-    Battery = 3,
-    "DC Source" = 4,
-    "Emergency mains constantly powered" = 5,
-    "Emergency mains and transfer switch" = 6,
-}

package/src/zspec/zcl/definition/foundation.ts

@@ -1,329 +0,0 @@
-import {BuffaloZclDataType, DataType, DataTypeClass, Direction, ParameterCondition} from "./enums";
-import {Status} from "./status";
-import type {ParameterDefinition} from "./tstype";
-
-export type FoundationCommandName =
-    | "read"
-    | "readRsp"
-    | "write"
-    | "writeUndiv"
-    | "writeRsp"
-    | "writeNoRsp"
-    | "configReport"
-    | "configReportRsp"
-    | "readReportConfig"
-    | "readReportConfigRsp"
-    | "report"
-    | "defaultRsp"
-    | "discover"
-    | "discoverRsp"
-    | "readStructured"
-    | "writeStructured"
-    | "writeStructuredRsp"
-    | "discoverCommands"
-    | "discoverCommandsRsp"
-    | "discoverCommandsGen"
-    | "discoverCommandsGenRsp"
-    | "discoverExt"
-    | "discoverExtRsp";
-
-export interface FoundationDefinition {
-    ID: number;
-    parseStrategy: "repetitive" | "flat" | "oneof";
-    parameters: readonly ParameterDefinition[];
-    response?: number;
-}
-
-export const Foundation: Readonly<Record<FoundationCommandName, Readonly<FoundationDefinition>>> = {
-    /** Read Attributes */
-    read: {
-        ID: 0x00,
-        parseStrategy: "repetitive",
-        parameters: [{name: "attrId", type: DataType.UINT16}],
-        response: 0x01, // readRsp
-    },
-    /** Read Attributes Response */
-    readRsp: {
-        ID: 0x01,
-        parseStrategy: "repetitive",
-        parameters: [
-            {name: "attrId", type: DataType.UINT16},
-            {name: "status", type: DataType.UINT8},
-            {name: "dataType", type: DataType.UINT8, conditions: [{type: ParameterCondition.FIELD_EQUAL, field: "status", value: Status.SUCCESS}]},
-            {
-                name: "attrData",
-                type: BuffaloZclDataType.USE_DATA_TYPE,
-                conditions: [{type: ParameterCondition.FIELD_EQUAL, field: "status", value: Status.SUCCESS}],
-            },
-        ],
-    },
-    /** Write Attributes */
-    write: {
-        ID: 0x02,
-        parseStrategy: "repetitive",
-        parameters: [
-            {name: "attrId", type: DataType.UINT16},
-            {name: "dataType", type: DataType.UINT8},
-            {name: "attrData", type: BuffaloZclDataType.USE_DATA_TYPE},
-        ],
-        response: 0x04, // writeRsp
-    },
-    /** Write Attributes Undivided */
-    writeUndiv: {
-        ID: 0x03,
-        parseStrategy: "repetitive",
-        parameters: [
-            {name: "attrId", type: DataType.UINT16},
-            {name: "dataType", type: DataType.UINT8},
-            {name: "attrData", type: BuffaloZclDataType.USE_DATA_TYPE},
-        ],
-    },
-    /** Write Attributes Response */
-    writeRsp: {
-        ID: 0x04,
-        parseStrategy: "repetitive",
-        parameters: [
-            {name: "status", type: DataType.UINT8},
-            {
-                name: "attrId",
-                type: DataType.UINT16,
-                conditions: [{type: ParameterCondition.FIELD_EQUAL, field: "status", reversed: true, value: Status.SUCCESS}],
-            },
-        ],
-    },
-    /** Write Attributes No Response */
-    writeNoRsp: {
-        ID: 0x05,
-        parseStrategy: "repetitive",
-        parameters: [
-            {name: "attrId", type: DataType.UINT16},
-            {name: "dataType", type: DataType.UINT8},
-            {name: "attrData", type: BuffaloZclDataType.USE_DATA_TYPE},
-        ],
-    },
-    /** Configure Reporting */
-    configReport: {
-        ID: 0x06,
-        parseStrategy: "repetitive",
-        parameters: [
-            {name: "direction", type: DataType.UINT8},
-            {name: "attrId", type: DataType.UINT16},
-            {
-                name: "dataType",
-                type: DataType.UINT8,
-                conditions: [{type: ParameterCondition.FIELD_EQUAL, field: "direction", value: Direction.CLIENT_TO_SERVER}],
-            },
-            {
-                name: "minRepIntval",
-                type: DataType.UINT16,
-                conditions: [{type: ParameterCondition.FIELD_EQUAL, field: "direction", value: Direction.CLIENT_TO_SERVER}],
-            },
-            {
-                name: "maxRepIntval",
-                type: DataType.UINT16,
-                conditions: [{type: ParameterCondition.FIELD_EQUAL, field: "direction", value: Direction.CLIENT_TO_SERVER}],
-            },
-            {
-                name: "repChange",
-                type: BuffaloZclDataType.USE_DATA_TYPE,
-                conditions: [
-                    {type: ParameterCondition.FIELD_EQUAL, field: "direction", value: Direction.CLIENT_TO_SERVER},
-                    {type: ParameterCondition.DATA_TYPE_CLASS_EQUAL, value: DataTypeClass.ANALOG},
-                ],
-            },
-            {
-                name: "timeout",
-                type: DataType.UINT16,
-                conditions: [{type: ParameterCondition.FIELD_EQUAL, field: "direction", value: Direction.SERVER_TO_CLIENT}],
-            },
-        ],
-        response: 0x07, // configReportRsp
-    },
-    /** Configure Reporting Response */
-    configReportRsp: {
-        ID: 0x07,
-        parseStrategy: "repetitive",
-        parameters: [
-            {name: "status", type: DataType.UINT8},
-            // minimumRemainingBufferBytes: if direction is present, attrId is also present
-            // https://github.com/Koenkk/zigbee-herdsman/pull/115
-            {name: "direction", type: DataType.UINT8, conditions: [{type: ParameterCondition.MINIMUM_REMAINING_BUFFER_BYTES, value: 3}]},
-            {name: "attrId", type: DataType.UINT16, conditions: [{type: ParameterCondition.MINIMUM_REMAINING_BUFFER_BYTES, value: 2}]},
-        ],
-    },
-    /** Read Reporting Configuration */
-    readReportConfig: {
-        ID: 0x08,
-        parseStrategy: "repetitive",
-        parameters: [
-            {name: "direction", type: DataType.UINT8},
-            {name: "attrId", type: DataType.UINT16},
-        ],
-        response: 0x09, // readReportConfigRsp
-    },
-    /** Read Reporting Configuration Response */
-    readReportConfigRsp: {
-        ID: 0x09,
-        parseStrategy: "repetitive",
-        parameters: [
-            {name: "status", type: DataType.UINT8},
-            {name: "direction", type: DataType.UINT8},
-            {name: "attrId", type: DataType.UINT16},
-            {
-                name: "dataType",
-                type: DataType.UINT8,
-                conditions: [{type: ParameterCondition.FIELD_EQUAL, field: "direction", value: Direction.CLIENT_TO_SERVER}],
-            },
-            {
-                name: "minRepIntval",
-                type: DataType.UINT16,
-                conditions: [{type: ParameterCondition.FIELD_EQUAL, field: "direction", value: Direction.CLIENT_TO_SERVER}],
-            },
-            {
-                name: "maxRepIntval",
-                type: DataType.UINT16,
-                conditions: [{type: ParameterCondition.FIELD_EQUAL, field: "direction", value: Direction.CLIENT_TO_SERVER}],
-            },
-            {
-                name: "repChange",
-                type: BuffaloZclDataType.USE_DATA_TYPE,
-                conditions: [
-                    {type: ParameterCondition.FIELD_EQUAL, field: "direction", value: Direction.CLIENT_TO_SERVER},
-                    {type: ParameterCondition.DATA_TYPE_CLASS_EQUAL, value: DataTypeClass.ANALOG},
-                ],
-            },
-            {
-                name: "timeout",
-                type: DataType.UINT16,
-                conditions: [{type: ParameterCondition.FIELD_EQUAL, field: "direction", value: Direction.SERVER_TO_CLIENT}],
-            },
-        ],
-    },
-    /** Report attributes */
-    report: {
-        ID: 0x0a,
-        parseStrategy: "repetitive",
-        parameters: [
-            {name: "attrId", type: DataType.UINT16},
-            {name: "dataType", type: DataType.UINT8},
-            {name: "attrData", type: BuffaloZclDataType.USE_DATA_TYPE},
-        ],
-    },
-    /** Default Response */
-    defaultRsp: {
-        ID: 0x0b,
-        parseStrategy: "flat",
-        parameters: [
-            {name: "cmdId", type: DataType.UINT8},
-            {name: "statusCode", type: DataType.UINT8},
-        ],
-    },
-    /** Discover Attributes */
-    discover: {
-        ID: 0x0c,
-        parseStrategy: "flat",
-        parameters: [
-            {name: "startAttrId", type: DataType.UINT16},
-            {name: "maxAttrIds", type: DataType.UINT8},
-        ],
-    },
-    /** Discover Attributes Response */
-    discoverRsp: {
-        ID: 0x0d,
-        parseStrategy: "oneof",
-        parameters: [
-            {name: "attrId", type: DataType.UINT16},
-            {name: "dataType", type: DataType.UINT8},
-        ],
-    },
-    /** Read Attributes Structured */
-    readStructured: {
-        ID: 0x0e,
-        parseStrategy: "repetitive",
-        parameters: [
-            {name: "attrId", type: DataType.UINT16},
-            {name: "selector", type: BuffaloZclDataType.STRUCTURED_SELECTOR},
-        ],
-    },
-    /** Write Attributes Structured */
-    writeStructured: {
-        ID: 0x0f,
-        parseStrategy: "repetitive",
-        parameters: [
-            {name: "attrId", type: DataType.UINT16},
-            {name: "selector", type: BuffaloZclDataType.STRUCTURED_SELECTOR},
-            {name: "dataType", type: DataType.UINT8},
-            {name: "elementData", type: BuffaloZclDataType.USE_DATA_TYPE},
-        ],
-        response: 0x10, // writeStructuredRsp
-    },
-    /** Write Attributes Structured response */
-    writeStructuredRsp: {
-        ID: 0x10,
-        parseStrategy: "repetitive",
-        // contains only one SUCCESS record for all written attributes if all written successfully
-        parameters: [
-            {name: "status", type: DataType.UINT8},
-            {
-                name: "attrId",
-                type: DataType.UINT16,
-                conditions: [{type: ParameterCondition.FIELD_EQUAL, field: "status", reversed: true, value: Status.SUCCESS}],
-            },
-            // always one zero-octet if failed attribute not of type array or structure, otherwise can also be zero if no info on which element caused failure
-            {
-                name: "selector",
-                type: BuffaloZclDataType.STRUCTURED_SELECTOR,
-                conditions: [{type: ParameterCondition.FIELD_EQUAL, field: "status", reversed: true, value: Status.SUCCESS}],
-            },
-        ],
-    },
-    /** Discover Commands Received */
-    discoverCommands: {
-        ID: 0x11,
-        parseStrategy: "flat",
-        parameters: [
-            {name: "startCmdId", type: DataType.UINT8},
-            {name: "maxCmdIds", type: DataType.UINT8},
-        ],
-    },
-    /** Discover Commands Received Response */
-    discoverCommandsRsp: {
-        ID: 0x12,
-        parseStrategy: "oneof",
-        parameters: [{name: "cmdId", type: DataType.UINT8}],
-    },
-    /** Discover Commands Generated */
-    discoverCommandsGen: {
-        ID: 0x13,
-        parseStrategy: "flat",
-        parameters: [
-            {name: "startCmdId", type: DataType.UINT8},
-            {name: "maxCmdIds", type: DataType.UINT8},
-        ],
-    },
-    /** Discover Commands Generated Response */
-    discoverCommandsGenRsp: {
-        ID: 0x14,
-        parseStrategy: "oneof",
-        parameters: [{name: "cmdId", type: DataType.UINT8}],
-    },
-    /** Discover Attributes Extended */
-    discoverExt: {
-        ID: 0x15,
-        parseStrategy: "flat",
-        parameters: [
-            {name: "startAttrId", type: DataType.UINT16},
-            {name: "maxAttrIds", type: DataType.UINT8},
-        ],
-    },
-    /** Discover Attributes Extended Response */
-    discoverExtRsp: {
-        ID: 0x16,
-        parseStrategy: "oneof",
-        parameters: [
-            {name: "attrId", type: DataType.UINT16},
-            {name: "dataType", type: DataType.UINT8},
-            {name: "access", type: DataType.UINT8},
-        ],
-    },
-};