Type Alias RegisterField

RegisterField: Message<"moddef.v1.RegisterField"> & {
    bitLength: number;
    bitOffset: number;
    enumRef?: EnumRef;
    fieldId: string;
    name: string;
    storageType: StorageType;
    transform?: Transform;
    unit: string;
    valueType?: ValueType;
}

§13.1 Typed sub-field over a register window (its own type/scale/unit).

Type declaration

  • bitLength: number

    Generated

    from field: uint32 bit_length = 4;

  • bitOffset: number

    LSB = 0, across the whole mapped window

    Generated

    from field: uint32 bit_offset = 3;

  • OptionalenumRef?: EnumRef

    Generated

    from field: moddef.v1.EnumRef enum_ref = 9;

  • fieldId: string

    Generated

    from field: string field_id = 1;

  • name: string

    Generated

    from field: string name = 2;

  • storageType: StorageType

    e.g. BCD for a packed-BCD sub-value

    Generated

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

  • Optionaltransform?: Transform

    Generated

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

  • unit: string

    Generated

    from field: string unit = 8;

  • OptionalvalueType?: ValueType

    Generated

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

Generated

from message moddef.v1.RegisterField

Settings

Member Visibility