zigbee-herdsman
    Preparing search index...

    Interface Parameter

    interface Parameter {
        length?: number;
        max?: number;
        maxExcl?: number;
        maxLen?: number;
        min?: number;
        minExcl?: number;
        minLen?: number;
        name: string;
        special?: [name: string, value: string][];
        type: DataType | BuffaloZclDataType;
    }

    Hierarchy (View Summary)

    Index

    Properties

    length? max? maxExcl? maxLen? min? minExcl? minLen? name special? type

    Properties

    length?: number

    specifies an exact length, generally used for a string.

    max?: number

    sets a maximum that includes the value specified, i.e. a field of this type must be less than or equal to the value

    maxExcl?: number

    sets a maximum that doesn't include the value specified, i.e. a field of this type must be strictly less than the value

    maxLen?: number

    specifies the maximum length that a type must take, generally used for a string or a list/array

    min?: number

    sets a minimum that includes the value specified, i.e. a field of this type must be greater than or equal than the value

    minExcl?: number

    sets a minimum that doesn't include the value specified, i.e. a field of this type must be strictly greater than the value

    minLen?: number

    specifies the minimum length that a type must take, generally used for a string or a list/array

    name: string
    special?: [name: string, value: string][]

    In some cases, a special value is defined by the Zigbee specification. In these cases, the special value along with a descriptor should be defined using this tag. Special values take precedence over other restrictions imposed (e.g. a special value may fall outside the min/max range for the attribute). value is kept as string for easier handling (will be checked on spot if used anyway) though most often is a hex number string (without 0x)

    type: DataType | BuffaloZclDataType

    Settings

    Member Visibility

    On This Page

    Properties