Type Alias Point

Point: Message<"moddef.v1.Point"> & {
    access: AccessMode;
    availableIf?: Availability;
    bitFields: BitField[];
    datetime?: DateTimeSpec;
    description: string;
    displayPrecision: number;
    fields: RegisterField[];
    mapping?: Mapping;
    measurand?: MeasurandRef;
    name: string;
    naValues: NaValue[];
    pointId: string;
    recommendedPollPeriodMs: number;
    selectorRef?: SelectorRef;
    storageType: StorageType;
    transform?: Transform;
    unit: string;
    valueType?: ValueType;
    write?: WriteSemantics;
    writeEncoding?: WriteEncoding;
}

§5.3 A user-visible data point exposed by a device.

Type declaration

  • access: AccessMode

    Generated

    from field: moddef.v1.AccessMode access = 10;

  • OptionalavailableIf?: Availability

    v0.4 — conditional presence (§17.1)

    Generated

    from field: moddef.v1.Availability available_if = 65;

  • bitFields: BitField[]

    boolean/enum bit ranges (legacy form)

    Generated

    from field: repeated moddef.v1.BitField bit_fields = 60;

  • Optionaldatetime?: DateTimeSpec

    v0.4 — when primitive=DATETIME (§8.5)

    Generated

    from field: moddef.v1.DateTimeSpec datetime = 63;

  • description: string

    Generated

    from field: string description = 3;

  • displayPrecision: number

    Generated

    from field: uint32 display_precision = 41;

  • fields: RegisterField[]

    v0.4 — typed sub-fields (§13.1)

    Generated

    from field: repeated moddef.v1.RegisterField fields = 61;

  • Optionalmapping?: Mapping

    Generated

    from field: moddef.v1.Mapping mapping = 20;

  • Optionalmeasurand?: MeasurandRef

    Generated

    from field: moddef.v1.MeasurandRef measurand = 50;

  • name: string

    Generated

    from field: string name = 2;

  • naValues: NaValue[]

    v0.4 — unavailable/sentinel (§8.4)

    Generated

    from field: repeated moddef.v1.NaValue na_values = 62;

  • pointId: string

    Generated

    from field: string point_id = 1;

  • recommendedPollPeriodMs: number

    Generated

    from field: uint32 recommended_poll_period_ms = 70;

  • OptionalselectorRef?: SelectorRef

    v0.4 — meaning/scale by register (§10.5)

    Generated

    from field: moddef.v1.SelectorRef selector_ref = 66;

  • storageType: StorageType

    Generated

    from field: moddef.v1.StorageType storage_type = 11;

  • Optionaltransform?: Transform

    Generated

    from field: moddef.v1.Transform transform = 30;

  • unit: string

    Generated

    from field: string unit = 40;

  • OptionalvalueType?: ValueType

    Generated

    from field: moddef.v1.ValueType value_type = 12;

  • Optionalwrite?: WriteSemantics

    §11 write behaviors + constraints

    Generated

    from field: moddef.v1.WriteSemantics write = 80;

  • OptionalwriteEncoding?: WriteEncoding

    v0.4 — distinct write path (§11.5)

    Generated

    from field: moddef.v1.WriteEncoding write_encoding = 64;

Generated

from message moddef.v1.Point

Settings

Member Visibility