@kvaser/canking-api 7.3.0 → 7.4.0

package/dist/protos/device_params.d.ts

@@ -48,19 +48,10 @@ export declare enum CanChannelCap {
 }
 export declare function canChannelCapFromJSON(object: any): CanChannelCap;
 export declare function canChannelCapToJSON(object: CanChannelCap): string;
-/** Possible protocols supported by a channel or device. */
-export declare enum Protocols {
-    /** PROTOCOLS_UNSPECIFIED - No protocol is supported. */
-    PROTOCOLS_UNSPECIFIED = 0,
-    /** PROTOCOLS_CAN - CAN protocol. */
-    PROTOCOLS_CAN = 1,
-    /** PROTOCOLS_LIN - LIN protocol. */
-    PROTOCOLS_LIN = 2,
-    UNRECOGNIZED = -1
-}
-export declare function protocolsFromJSON(object: any): Protocols;
-export declare function protocolsToJSON(object: Protocols): string;
-/** Possible events. */
+/**
+ * Possible events.
+ * @internal
+ */
 export declare enum DeviceEvent {
     DEVICE_EVENT_UNSPECIFIED = 0,
     /** DEVICE_EVENT_DEVICES_CHANGED - Raised when the Device collection has changed, will pass the new Device collection as event data */
@@ -94,22 +85,36 @@ export declare function deviceEventToJSON(object: DeviceEvent): string;
  *   data.prescaler  = arbitration.prescaler
  */
 export interface CanBusParams {
+    /** The total number of time quantas (TQ). */
     tq: number;
+    /** The number of time quantas in phase 1. */
     phase1: number;
+    /** The number of time quantas in phase 2. */
     phase2: number;
+    /** The synchronization jump width in time quantas. */
     sjw: number;
+    /** The propagation segment in time quantas. */
     prop: number;
+    /** The prescaler value. */
     prescaler: number;
 }
 /** CAN channel bus parameter limits. */
 export interface CanBusParamLimits {
+    /** Minimum bus parameters for arbitration phase. */
     arbitrationMin: CanBusParams | undefined;
+    /** Maximum bus parameters for arbitration phase. */
     arbitrationMax: CanBusParams | undefined;
+    /** Minimum bus parameters for data phase. */
     dataMin: CanBusParams | undefined;
+    /** Maximum bus parameters for data phase. */
     dataMax: CanBusParams | undefined;
+    /** Indicates if the limits are valid. */
     isValid: boolean;
 }
-/** Bus speed information, used for listing available bus speed settings for CAN. */
+/**
+ * Bus speed information, used for listing available bus speed settings for CAN.
+ * @internal
+ */
 export interface CanBusSpeedInfo {
     /** The target bit rate (measured in bits per second). */
     bitRate: number;
@@ -124,7 +129,10 @@ export interface CanBusSpeedInfo {
     /** Bus parameters for this bus speed. */
     busParams: CanBusParams | undefined;
 }
-/** Bus speed information, used for listing available bus speed settings for CAN FD. */
+/**
+ * Bus speed information, used for listing available bus speed settings for CAN FD.
+ * @internal
+ */
 export interface CanFDBusSpeedInfo {
     /** The target bit rate (measured in bits per second). */
     bitRate: number;
@@ -135,50 +143,79 @@ export interface CanFDBusSpeedInfo {
     /** Bus parameters for this bus speed. */
     busParams: CanBusParams | undefined;
 }
-/** CAN FD bus speed combination, holds one arbitration phase speed together with available data phase speeds. */
+/**
+ * CAN FD bus speed combination, holds one arbitration phase speed together with available data phase speeds.
+ * @internal
+ */
 export interface CanFDBusSpeedCombination {
     arbitrationBusSpeed: CanFDBusSpeedInfo | undefined;
     dataBusSpeeds: CanFDBusSpeedInfo[];
 }
 /** CAN channel capacity. */
 export interface CanChannelCapacity {
+    /** Bus parameter limits for the channel. */
     busParamLimits: CanBusParamLimits | undefined;
+    /** Supported channel capabilities. */
     channelCaps: CanChannelCap[];
     /** Maximum bitrate of the channel. Zero means no limit on bitrate. */
     maxBitRate: number;
+    /** Clock frequency of the channel in Hz. */
     clockFrequency: number;
 }
 /** A channel of any type, could be CAN and/or LIN. */
 export interface Channel {
+    /** The channel number. */
     channelNumber: number;
+    /** The channel number on the device. */
     channelNumberOnDevice: number;
+    /** The channel name. */
     name: string;
-    protocols: Protocols[];
+    /** Supported protocols by the channel. */
+    protocols: string[];
+    /** The channel capacity. */
     canChannelCapacity?: CanChannelCapacity | undefined;
 }
 /** A hardware device. */
 export interface Device {
+    /** The device type/card type. */
     cardType: number;
+    /** The device card number. */
     cardNumber: number;
+    /** The device product code. */
     productCode: string;
+    /** The device serial number. */
     serialNumber: string;
+    /** The device name. */
     name: string;
-    protocols: Protocols[];
+    /** Supported protocols by the device. */
+    protocols: string[];
+    /** The device channels. */
     channels: Channel[];
 }
+/** A collection of devices. */
 export interface Devices {
+    /** The device items. */
     items: Device[];
 }
-/** A request message to get all connected devices. */
+/**
+ * A request message to get all connected devices.
+ * @internal
+ */
 export interface GetDevicesRequest {
     preferences: ApiPreferences | undefined;
     includeVirtual: boolean;
 }
-/** A response on the GetDevices request. */
+/**
+ * A response on the GetDevices request.
+ * @internal
+ */
 export interface GetDevicesResponse {
     devices: Device[];
 }
-/** A request message to get a CAN channel's available bus speeds. */
+/**
+ * A request message to get a CAN channel's available bus speeds.
+ * @internal
+ */
 export interface GetCanChannelBusSpeedsRequest {
     preferences: ApiPreferences | undefined;
     channelNumber: number;
@@ -186,37 +223,55 @@ export interface GetCanChannelBusSpeedsRequest {
     bitRateArbitrationPhase?: number | undefined;
     bitRateDataPhase?: number | undefined;
 }
-/** A response on GetCanChannelBusSpeeds request. */
+/**
+ * A response on GetCanChannelBusSpeeds request.
+ * @internal
+ */
 export interface GetCanChannelBusSpeedsResponse {
     /** Available bus speeds on classic CAN. */
     availableBusSpeeds: CanBusSpeedInfo[];
     /** Available bus speeds on CAN FD. */
     availableBusSpeedsFd: CanFDBusSpeedCombination[];
 }
-/** A request message to get a CAN channel's classic CAN bus speeds for the specified bit rates. */
+/**
+ * A request message to get a CAN channel's classic CAN bus speeds for the specified bit rates.
+ * @internal
+ */
 export interface GetClassicCanBusSpeedsRequest {
     preferences: ApiPreferences | undefined;
     channelNumber: number;
     bitRates: number[];
 }
-/** A response on GetClassicCanBusSpeeds request request. */
+/**
+ * A response on GetClassicCanBusSpeeds request request.
+ * @internal
+ */
 export interface GetClassicCanBusSpeedsResponse {
     /** Available bus speeds on classic CAN. */
     availableBusSpeeds: CanBusSpeedInfo[];
 }
-/** A request message to get a CAN channel's CAN FD bus speeds for a given bit rate. */
+/**
+ * A request message to get a CAN channel's CAN FD bus speeds for a given bit rate.
+ * @internal
+ */
 export interface GetCanFdBusSpeedsRequest {
     preferences: ApiPreferences | undefined;
     channelNumber: number;
     bitRatesArbitrationPhase: number[];
     bitRatesDataPhase: number[];
 }
-/** A response on GetCanFdBusSpeeds request request. */
+/**
+ * A response on GetCanFdBusSpeeds request request.
+ * @internal
+ */
 export interface GetCanFdBusSpeedsResponse {
     /** Available bus speeds on CAN FD. */
     availableBusSpeedsFd: CanFDBusSpeedCombination[];
 }
-/** Event arguments */
+/**
+ * Event arguments
+ * @internal
+ */
 export interface DeviceEventArgs {
     eventType: DeviceEvent;
     devices?: Devices | undefined;

package/dist/protos/frame_params.d.ts

@@ -3,44 +3,90 @@ import Long from "long";
 import { SignalDefinition } from "./signal_params";
 /** Possible CAN frame flags. The flag value must match the canlib flag value. */
 export declare enum CanFrameFlag {
+    /** CAN_FRAME_FLAG_UNSPECIFIED - No flag has been set. */
     CAN_FRAME_FLAG_UNSPECIFIED = 0,
+    /** CAN_FRAME_FLAG_RTR - Message is a remote request, only valid for classic CAN. */
     CAN_FRAME_FLAG_RTR = 1,
+    /** CAN_FRAME_FLAG_STD - Message has a standard (11-bit) identifier. */
     CAN_FRAME_FLAG_STD = 2,
+    /** CAN_FRAME_FLAG_EXT - Message has an extended (29-bit) identifier. */
     CAN_FRAME_FLAG_EXT = 4,
+    /** CAN_FRAME_FLAG_WAKEUP - Message is a WAKEUP message (SWC hardware.) */
     CAN_FRAME_FLAG_WAKEUP = 8,
+    /** CAN_FRAME_FLAG_NERR - NERR was active during the message (TJA1054 hardware). */
     CAN_FRAME_FLAG_NERR = 16,
+    /** CAN_FRAME_FLAG_ERROR_FRAME - Message represents an error frame. */
     CAN_FRAME_FLAG_ERROR_FRAME = 32,
+    /** CAN_FRAME_FLAG_TXACK - Message is a TX ACK (msg has really been sent). */
     CAN_FRAME_FLAG_TXACK = 64,
+    /** CAN_FRAME_FLAG_TXRQ - Message is a TX REQUEST (msg was transfered to the chip). */
     CAN_FRAME_FLAG_TXRQ = 128,
+    /**
+     * CAN_FRAME_FLAG_DELAY_MSG - Message is NOT sent on the bus. The transmission of messages are delayed.
+     * The dlc specifies the delay in milliseconds (1..1000).
+     */
     CAN_FRAME_FLAG_DELAY_MSG = 256,
+    /** CAN_FRAME_FLAG_LOCAL_TXACK - Message was sent from another handle on the same can channel. */
     CAN_FRAME_FLAG_LOCAL_TXACK = 268435456,
+    /**
+     * CAN_FRAME_FLAG_SINGLE_SHOT - Message is Single Shot, try to send once, no retransmission.
+     * This flag can only be used with transmitted messages.
+     */
     CAN_FRAME_FLAG_SINGLE_SHOT = 16777216,
+    /** CAN_FRAME_FLAG_TXNACK - Message is a failed Single Shot, message was not sent. This flag is only used with received messages. */
     CAN_FRAME_FLAG_TXNACK = 33554432,
+    /**
+     * CAN_FRAME_FLAG_ABL - Only together with TxNack, Single shot message was not sent because arbitration was lost.
+     * This flag is only used with received messages.
+     */
     CAN_FRAME_FLAG_ABL = 67108864,
+    /** CAN_FRAME_FLAG_FD_FDF - Message is an FD message (CAN FD). */
     CAN_FRAME_FLAG_FD_FDF = 65536,
+    /** CAN_FRAME_FLAG_FD_BRS - Message is sent/received with bit rate switch (CAN FD). */
     CAN_FRAME_FLAG_FD_BRS = 131072,
+    /** CAN_FRAME_FLAG_FD_ESI - Sender of the message is in error passive mode (CAN FD). */
     CAN_FRAME_FLAG_FD_ESI = 262144,
+    /** CAN_FRAME_FLAG_ERR_HW_OVERRUN - HW buffer overrun. */
     CAN_FRAME_FLAG_ERR_HW_OVERRUN = 512,
+    /** CAN_FRAME_FLAG_ERR_SW_OVERRUN - SW buffer overrun. */
     CAN_FRAME_FLAG_ERR_SW_OVERRUN = 1024,
+    /** CAN_FRAME_FLAG_ERR_STUFF - Stuff error. */
     CAN_FRAME_FLAG_ERR_STUFF = 2048,
+    /** CAN_FRAME_FLAG_ERR_FORM - Form error. */
     CAN_FRAME_FLAG_ERR_FORM = 4096,
+    /** CAN_FRAME_FLAG_ERR_CRC - CRC error. */
     CAN_FRAME_FLAG_ERR_CRC = 8192,
+    /** CAN_FRAME_FLAG_ERR_BIT0 - Sent dominant, read recessive. */
     CAN_FRAME_FLAG_ERR_BIT0 = 16384,
+    /** CAN_FRAME_FLAG_ERR_BIT1 - Sent recessive, read dominant. */
     CAN_FRAME_FLAG_ERR_BIT1 = 32768,
+    /** CAN_FRAME_FLAG_XL_XLF - CAN XL frame. (Not currently part of CanLib, the value can change in future releases.) */
+    CAN_FRAME_FLAG_XL_XLF = 1048576,
+    /** CAN_FRAME_FLAG_XL_VCID - CAN XL Virtual CAN network ID (VCID). (Not currently part of CanLib, the value can change in future releases.) */
+    CAN_FRAME_FLAG_XL_VCID = 2097152,
     UNRECOGNIZED = -1
 }
 export declare function canFrameFlagFromJSON(object: any): CanFrameFlag;
 export declare function canFrameFlagToJSON(object: CanFrameFlag): string;
 /** Possible LIN frame flags. The flag value must match the linlib flag value. */
 export declare enum LinFrameFlag {
+    /** LIN_FRAME_FLAG_UNSPECIFIED - No flag has been set. */
     LIN_FRAME_FLAG_UNSPECIFIED = 0,
+    /** LIN_FRAME_FLAG_TX - The message was something we transmitted to the bus. */
     LIN_FRAME_FLAG_TX = 1,
+    /** LIN_FRAME_FLAG_RX - The message was something we received from the bus. */
     LIN_FRAME_FLAG_RX = 2,
+    /** LIN_FRAME_FLAG_WAKEUP_FRAME - A wake up frame was received. Id/msg/dlc are undefined. */
     LIN_FRAME_FLAG_WAKEUP_FRAME = 4,
+    /** LIN_FRAME_FLAG_NODATA - No data, only a header. */
     LIN_FRAME_FLAG_NODATA = 8,
+    /** LIN_FRAME_FLAG_CSUM_ERROR - Checksum error. */
     LIN_FRAME_FLAG_CSUM_ERROR = 16,
+    /** LIN_FRAME_FLAG_PARITY_ERROR - ID parity error. */
     LIN_FRAME_FLAG_PARITY_ERROR = 32,
+    /** LIN_FRAME_FLAG_SYNCH_ERROR - A synch error. */
     LIN_FRAME_FLAG_SYNCH_ERROR = 64,
+    /** LIN_FRAME_FLAG_BIT_ERROR - Bit error when transmitting. */
     LIN_FRAME_FLAG_BIT_ERROR = 128,
     UNRECOGNIZED = -1
 }
@@ -51,6 +97,7 @@ export declare function linFrameFlagToJSON(object: LinFrameFlag): string;
  * This is a work-around since it's not possible to use repeated fields as oneof fields.
  */
 export interface CanFrameFlags {
+    /** A list of CAN frame flags. */
     flags: CanFrameFlag[];
 }
 /**
@@ -58,19 +105,27 @@ export interface CanFrameFlags {
  * This is a work-around since it's not possible to use repeated fields as oneof fields.
  */
 export interface LinFrameFlags {
+    /** A list of LIN frame flags. */
     flags: LinFrameFlag[];
 }
 /** A message that holds an extra frame property. */
 export interface FramePropertyValue {
+    /** String value. */
     stringValue?: string | undefined;
+    /** Double value. */
     doubleValue?: number | undefined;
 }
 /** A message that holds a signal's value. */
 export interface SignalValue {
+    /** Name of the signal. */
     name: string;
+    /** Qualified name of the signal. */
     qualifiedName: string;
+    /** Unit of the signal. */
     unit: string;
+    /** Text representation of the signal value if this is an enumeration signal. */
     stringValue?: string | undefined;
+    /** Numeric representation of the signal value. */
     doubleValue: number;
 }
 /** A message describing a frame. */
@@ -87,7 +142,10 @@ export interface Frame {
     messageName: string;
     /** Frame data */
     data: number[];
-    /** Timestamp in seconds when the frame was recieved or transmitted */
+    /**
+     * Timestamp in seconds when the frame was recieved or transmitted
+     * @deprecated Use time_us instead, which has microsecond precision. This field will be removed in future releases.
+     */
     time: number;
     /** Flag indicating if this message was transmitted or recieved */
     tx: boolean;
@@ -105,12 +163,24 @@ export interface Frame {
     canFrameFlags?: CanFrameFlags | undefined;
     /** Special LIN flags */
     linFrameFlags?: LinFrameFlags | undefined;
+    /** Timestamp in microseconds when the frame was recieved or transmitted */
+    timeUs: Long;
+    /** Delta time in microseconds since the previous frame with the same fixed pos identifier */
+    deltaTimeUs?: Long | undefined;
+    /** Fixed position frame identifier */
+    fixedPosIdentifier?: string | undefined;
+    /** Protocol used for this frame */
+    protocol?: string | undefined;
+    /** Multiplexing value of the frame, used in multiplexed CAN frames */
+    muxValue?: number | undefined;
 }
 export interface Frame_PropertiesEntry {
     key: string;
     value: FramePropertyValue | undefined;
 }
+/** A collection of frames. */
 export interface Frames {
+    /** A list of frames. */
     items: Frame[];
 }
 /** A message describing a frame that will be used for writing message to a bus. */
@@ -138,25 +208,38 @@ export interface FrameDefinition {
     signals: SignalDefinition[];
     /** Special CAN flags */
     canFrameFlags?: CanFrameFlags | undefined;
+    /** Identifiers of all possible source nodes */
+    sourceIdentifiers: string[];
 }
+/** A collection of frame definitions. */
 export interface FrameDefinitions {
+    /** A list of frame definitions. */
     items: FrameDefinition[];
 }
-/** A message describing database files for both database nodes and LIN channels. */
+/**
+ * A message describing database files for both database nodes and LIN channels.
+ * @internal
+ */
 export interface DatabaseFiles {
     /** Database files for CAN channels */
     dbcFiles: string[];
     /** Database files for LIN channels */
     ldfFiles: string[];
 }
-/** A message describing an entry in a schedule table. */
+/**
+ * A message describing an entry in a schedule table.
+ * @internal
+ */
 export interface ScheduleTableEntry {
     /** Message qualified name */
     messageQualifiedName: string;
     /** Delay in milliseconds */
     delay: number;
 }
-/** A message describing a schedule table. */
+/**
+ * A message describing a schedule table.
+ * @internal
+ */
 export interface ScheduleTable {
     /** Name of the schedule table */
     name: string;
@@ -169,12 +252,12 @@ export interface ScheduleTable {
 export interface FixedPosFrameIdentifier {
     /** Frame identifier */
     id: number;
-    /** True if the frame is transmitted, false if received */
-    tx: boolean;
-    /** Mux value for the frame, used in multiplexed CAN frames */
+    /** True if the frame is transmitted, false if received, undefined if both */
+    tx?: boolean | undefined;
+    /** Multiplexing value of the frame, used in multiplexed CAN frames */
     mux?: number | undefined;
-    /** Name of the source node, accept any source if not set */
-    sourceName?: string | undefined;
+    /** Identifier of the source node, accepts any source if not set */
+    sourceId?: string | undefined;
     /** Special CAN flags */
     canFrameFlags?: CanFrameFlags | undefined;
     /** Special LIN flags */