Kvaser CanKing GUI Extensions SDK - v7.6.1
    Preparing search index...

    Interface Frame

    A message describing a frame.

    interface Frame {
        canFrameFlags?: CanFrameFlags;
        data: number[];
        deltaTimeUs?: Long;
        dlc: number;
        fixedPosIdentifier?: string;
        hashCode: number;
        id: number;
        linFrameFlags?: LinFrameFlags;
        matchedMessageQualifiedName?: string;
        messageName: string;
        muxValue?: number;
        properties: { [key: string]: FramePropertyValue };
        protocol?: string;
        signalValues: SignalValue[];
        sourceId: string;
        sourceName: string;
        streamId: string;
        timeUs: Long;
        tx: boolean;
    }
    Index
    canFrameFlags? data deltaTimeUs? dlc fixedPosIdentifier? hashCode id linFrameFlags? matchedMessageQualifiedName? messageName muxValue? properties protocol? signalValues sourceId sourceName streamId timeUs tx
    canFrameFlags?: CanFrameFlags

    Special CAN flags

    data: number[]

    Frame data. Uses repeated uint32 rather than bytes because the proto bytes type does not support individual byte access efficiently in the ts-proto generated TypeScript bindings; repeated uint32 provides direct indexed access to each data byte.

    deltaTimeUs?: Long

    Delta time in microseconds since the previous frame with the same fixed pos identifier

    dlc: number

    Frame DLC

    fixedPosIdentifier?: string

    Fixed position frame identifier

    hashCode: number

    Frame hash code, a unique key that identifies the frame

    id: number

    Frame identifier

    linFrameFlags?: LinFrameFlags

    Special LIN flags

    matchedMessageQualifiedName?: string

    Qualified name of the database message this frame was decoded with, absent when no database message matched. This is what lets a client attribute a frame to the exact frame definition it came from, which neither the frame identifier nor the message name can do on their own: PGN lookup matches an identifier the definition does not carry, and message names are only unique within a single database, not across a cluster of them.

    messageName: string

    Frame identifier

    muxValue?: number

    Multiplexing value of the frame, used in multiplexed CAN frames

    properties: { [key: string]: FramePropertyValue }

    Extra properties

    protocol?: string

    Protocol used for this frame

    signalValues: SignalValue[]

    Signal values

    sourceId: string

    Identifier of the source node

    sourceName: string

    Name of the source node

    streamId: string

    Identifier of the stream node

    timeUs: Long

    Timestamp in microseconds when the frame was received or transmitted

    tx: boolean

    Flag indicating if this message was transmitted or received

    Settings
    Member Visibility

    On This Page
    Properties