zigbee-herdsman
    Preparing search index...

    Interface AttributeDefinition

    interface AttributeDefinition {
        client?: true;
        default?: string | number;
        ID: number;
        length?: number;
        manufacturerCode?: number;
        max?: number;
        maxExcl?: number;
        maxLen?: number;
        min?: number;
        minExcl?: number;
        minLen?: number;
        read?: false;
        report?: true;
        required?: true;
        scene?: true;
        special?: [name: string, value: string][];
        type: DataType;
        write?: true;
        writeOptional?: true;
    }

    Hierarchy

    Index

    Properties

    client? default? ID length? manufacturerCode? max? maxExcl? maxLen? min? minExcl? minLen? read? report? required? scene? special? type write? writeOptional?

    Properties

    client?: true

    If attribute is client side

    default?: string | number

    Specifies the default value of an attribute. No Default

    ID: number
    length?: number

    specifies an exact length, generally used for a string.

    manufacturerCode?: number
    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

    read?: false

    If the attribute is readable OTA. Defaults to true. NOTE: marked as R in spec PDF

    report?: true

    If attribute is required to be reportable. Defaults to false. NOTE: marked as P in spec PDF

    required?: true

    If the attribute is mandatory. Defaults to false

    scene?: true

    If attribute is required to be part of the scene extensions. Defaults to false. NOTE: marked as S in spec PDF

    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
    write?: true

    If the attribute is writable OTA. Defaults to false. NOTE: marked as W in spec PDF

    writeOptional?: true

    If the attribute is specified as writable this indicates if the write is required (returns READ_ONLY if not). Defaults to false.

    Settings

    Member Visibility

    On This Page

    Properties