Type Alias Mapping

Mapping: Message<"moddef.v1.Mapping"> & {
    allowedFunctionCodes: number[];
    bitIndex: number;
    bitLength: number;
    bitOffset: number;
    byteOrder: ByteOrder;
    composed?: ComposedMapping;
    lengthRef?: PointRef;
    lengthWords: number;
    modelRelativeOffset: number;
    offset: number;
    signMagnitude: boolean;
    space: AddressSpace;
    storageType: StorageType;
    strideWords: number;
    stringEncoding?: StringEncoding;
    wordOrder: WordOrder;
}

§9, §14, §14.1 Physical location and encoding of a point's raw data.

Type declaration

  • allowedFunctionCodes: number[]

    §7.2

    Generated

    from field: repeated uint32 allowed_function_codes = 11;

  • bitIndex: number

    Generated

    from field: uint32 bit_index = 4;

  • bitLength: number

    Generated

    from field: uint32 bit_length = 15;

  • bitOffset: number

    v0.5 §14 — bit window over the assembled sub-mapping window, for values whose mantissa and exponent share a register word (embedded decade exponent, e.g. Iskra T5/T6, Eaton PXM "GENERAL FORMAT"). LSB = 0, counted across the whole mapped window (as RegisterField §13.1). A sub-value with a bit window sign-extends from bit_length, not the storage width. bit_length = 0 means "no bit window".

    Generated

    from field: uint32 bit_offset = 14;

  • byteOrder: ByteOrder

    Generated

    from field: moddef.v1.ByteOrder byte_order = 5;

  • Optionalcomposed?: ComposedMapping

    Generated

    from field: moddef.v1.ComposedMapping composed = 10;

  • OptionallengthRef?: PointRef

    v0.5 §11.7 — dynamic element/word count for this mapping's read, resolved from another point in the same device profile at read time (e.g. an "Output Message Length" register gating a variable-length signature-blob read). Effective word count = the decoded value of the referenced point, clamped to length_words as an upper bound if length_words is also set. Must resolve within the same device profile (MDE407); must reference an integer-valued point (MDE505); must not form a cycle (MDE506).

    Generated

    from field: moddef.v1.PointRef length_ref = 16;

  • lengthWords: number

    Generated

    from field: uint32 length_words = 3;

  • modelRelativeOffset: number

    v0.4 — offset within a discovered model (§7.3)

    Generated

    from field: uint32 model_relative_offset = 9;

  • offset: number

    Generated

    from field: uint32 offset = 2;

  • signMagnitude: boolean

    v0.4 — sign-magnitude instead of two's complement

    Generated

    from field: bool sign_magnitude = 7;

  • space: AddressSpace

    Generated

    from field: moddef.v1.AddressSpace space = 1;

  • storageType: StorageType

    §14 (composed sub-mappings). Storage type of the sub-value; determines signedness (and width when no bit window is set). Spec'd since v0.4 §14; the field was missing from the schema.

    Generated

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

  • strideWords: number

    v0.4 — repeating-array element stride (§14.1)

    Generated

    from field: uint32 stride_words = 8;

  • OptionalstringEncoding?: StringEncoding

    §15

    Generated

    from field: moddef.v1.StringEncoding string_encoding = 12;

  • wordOrder: WordOrder

    Generated

    from field: moddef.v1.WordOrder word_order = 6;

Generated

from message moddef.v1.Mapping

Settings

Member Visibility