@kvaser/canking-api 7.2.1 → 7.4.0

package/dist/protos/app_params.d.ts

@@ -1,16 +1,6 @@
 import { BinaryReader, BinaryWriter } from "@bufbuild/protobuf/wire";
 import Long from "long";
 import { ApiPreferences } from "./common_params";
-/** Possible file types when browsing files. */
-export declare enum FileType {
-    PROJECT_FILE = 0,
-    LOG_FILE = 1,
-    CAN_DATABASES = 2,
-    LIN_DATABASES = 3,
-    UNRECOGNIZED = -1
-}
-export declare function fileTypeFromJSON(object: any): FileType;
-export declare function fileTypeToJSON(object: FileType): string;
 /** Possible log levels. */
 export declare enum LogLevel {
     /**
@@ -46,23 +36,34 @@ export declare enum LogLevel {
 }
 export declare function logLevelFromJSON(object: any): LogLevel;
 export declare function logLevelToJSON(object: LogLevel): string;
-/** Possible application events. */
+/**
+ * Possible application events.
+ * @internal
+ */
 export declare enum AppEvent {
     APP_EVENT_UNSPECIFIED = 0,
     /** APP_EVENT_LICENSE_INFO_CHANGED - Raised when the license information has changed. */
     APP_EVENT_LICENSE_INFO_CHANGED = 1,
+    /** APP_EVENT_EXTENSION_CHANGED - Raised when an extension has been installed, updated, or uninstalled. */
+    APP_EVENT_EXTENSION_CHANGED = 2,
     UNRECOGNIZED = -1
 }
 export declare function appEventFromJSON(object: any): AppEvent;
 export declare function appEventToJSON(object: AppEvent): string;
-/** A request message for setting log level. */
+/**
+ * A request message for setting log level.
+ * @internal
+ */
 export interface SetLogLevelRequest {
     /** API preferences. */
     preferences: ApiPreferences | undefined;
     /** The new log level. */
     logLevel: LogLevel;
 }
-/** A response message for receiving the current log level. */
+/**
+ * A response message for receiving the current log level.
+ * @internal
+ */
 export interface GetLogLevelResponse {
     /** The current log level. */
     logLevel: LogLevel;
@@ -85,7 +86,10 @@ export interface LogMessages {
     /** The log message items. */
     items: LogMessage[];
 }
-/** License information. */
+/**
+ * License information.
+ * @internal
+ */
 export interface LicenseInformation {
     /** The license key. */
     licenseKey: string;
@@ -104,68 +108,120 @@ export interface LicenseInformation {
     /** A flag indicating if the license is valid. */
     isValid: boolean;
 }
-/** A collection of licenses. */
+/**
+ * A collection of licenses.
+ * @internal
+ */
 export interface Licenses {
     /** The license information items. */
     items: LicenseInformation[];
 }
-/** Event arguments. */
+/**
+ * Event arguments.
+ * @internal
+ */
 export interface AppEventArgs {
     /** The application event type. */
     eventType: AppEvent;
     /** A collection of registered licenses. */
     licenses?: Licenses | undefined;
+    /** A collection of extension information. */
+    extensions?: ExtensionInfos | undefined;
 }
-/** Request message for installing a service extension. */
-export interface InstallServiceExtensionRequest {
+/**
+ * Message holding extension information.
+ * @internal
+ */
+export interface ExtensionInfo {
+    /** Timestamp of when the extension was packed */
+    createdDate: string;
+    /** Extension name. */
+    name: string;
+    /** Extension display name. */
+    displayName: string;
+    /** Extension description. */
+    description: string;
+    /** Extension version. */
+    version: string;
+    /** Extension author. */
+    author: string;
+    /** Extension data, i.e., default configuration for a service extension. */
+    data: string;
+    /** Extension type. */
+    extensionType?: string | undefined;
+    /** Product identifier of the extension, used for license validation. */
+    productId?: string | undefined;
+    /** European Article Number (EAN) of the extension. */
+    ean?: string | undefined;
+    /** License type of the extension. */
+    licenseType?: string | undefined;
+    /** Publisher of the extension, extracted from signing certificate. */
+    publisher?: string | undefined;
+    /** Indicates if the extension requires activation. */
+    requiresActivation?: boolean | undefined;
+    /** Copyright notice of the extension. */
+    copyrightNotice?: string | undefined;
+    /** End User License Agreement (EULA) of the extension. */
+    eula?: string | undefined;
+    /** Signed date of the extension, ISO 8601 timestamp. */
+    signedDate?: string | undefined;
+}
+/**
+ * A collection of extension information.
+ * @internal
+ */
+export interface ExtensionInfos {
+    /** A collection of extension information items. */
+    items: ExtensionInfo[];
+}
+/**
+ * Request message for installing a GUI or service extension.
+ * @internal
+ */
+export interface InstallExtensionRequest {
     /** API preferences. */
     preferences: ApiPreferences | undefined;
-    /** Full path to the extension WebAssembly file (.wasm file). */
+    /** Full path to the service extension WebAssembly file (.wasm file), or the GUI extension Node.js package file (.tgz file). */
     filePath: string;
-    /** An optional flag that can be used if an extension should be replace/updated with a new WebAssembly file. */
+    /** An optional flag that can be used if an extension should be replace/updated with a new version. */
     replaceExisting?: boolean | undefined;
 }
-/** Request message for uninstalling a service extension. */
-export interface UninstallServiceExtensionRequest {
+/**
+ * Request message for uninstalling a GUI or service extension.
+ * @internal
+ */
+export interface UninstallExtensionRequest {
     /** API preferences. */
     preferences: ApiPreferences | undefined;
     /** Name of the extension. */
     name: string;
 }
 /**
- * Request message for getting information about a service extension, either from a
- * WebAssembly file or from an installed extension.
+ * Request message for getting information about an extension, either from a service extension WebAssembly file (.wasm file),
+ * a GUI extension Node.js package file (.tgz file), or from an installed extension.
+ * @internal
  */
-export interface GetServiceExtensionInfoRequest {
+export interface GetExtensionInfoRequest {
     /** API preferences. */
     preferences: ApiPreferences | undefined;
     /**
-     * Full path to the extension WebAssembly file (.wasm file), or the extension name if it is
-     * already installed.
+     * Full path to the service extension WebAssembly file (.wasm file), the GUI extension Node.js package file (.tgz file),
+     * or the extension name if it is already installed.
      */
     filePathOrName: string;
 }
-/** Response message for getting service extension information. */
-export interface GetServiceExtensionInfoResponse {
-    /** Extension name. */
-    name: string;
-    /** Extension display name. */
-    displayName: string;
-    /** Extension description. */
-    description: string;
-    /** Extension version. */
-    version: string;
-    /** Extension author. */
-    author: string;
-    /** Extension default configuration. */
-    defaultConfig: string;
-}
-/** Response message for getting licenses. */
+/**
+ * Response message for getting licenses.
+ * @internal
+ */
 export interface GetLicensesResponse {
     /** A collection of registered licenses. */
     licenses: LicenseInformation[];
 }
-/** Request message for activating a license. */
+/**
+ * Request message for activating a license.
+ * @internal
+ */
 export interface ActivateLicenseRequest {
     /** API preferences. */
     preferences: ApiPreferences | undefined;
@@ -174,7 +230,10 @@ export interface ActivateLicenseRequest {
     /** Optional product_id, used if activating anything but the base CanKing product. */
     productId: string;
 }
-/** Message for getting about information. */
+/**
+ * Message for getting about information.
+ * @internal
+ */
 export interface AboutInformation {
     /** The API version used by the service. */
     apiVersion: string;
@@ -190,10 +249,11 @@ export declare const LogMessages: MessageFns<LogMessages>;
 export declare const LicenseInformation: MessageFns<LicenseInformation>;
 export declare const Licenses: MessageFns<Licenses>;
 export declare const AppEventArgs: MessageFns<AppEventArgs>;
-export declare const InstallServiceExtensionRequest: MessageFns<InstallServiceExtensionRequest>;
-export declare const UninstallServiceExtensionRequest: MessageFns<UninstallServiceExtensionRequest>;
-export declare const GetServiceExtensionInfoRequest: MessageFns<GetServiceExtensionInfoRequest>;
-export declare const GetServiceExtensionInfoResponse: MessageFns<GetServiceExtensionInfoResponse>;
+export declare const ExtensionInfo: MessageFns<ExtensionInfo>;
+export declare const ExtensionInfos: MessageFns<ExtensionInfos>;
+export declare const InstallExtensionRequest: MessageFns<InstallExtensionRequest>;
+export declare const UninstallExtensionRequest: MessageFns<UninstallExtensionRequest>;
+export declare const GetExtensionInfoRequest: MessageFns<GetExtensionInfoRequest>;
 export declare const GetLicensesResponse: MessageFns<GetLicensesResponse>;
 export declare const ActivateLicenseRequest: MessageFns<ActivateLicenseRequest>;
 export declare const AboutInformation: MessageFns<AboutInformation>;

package/dist/protos/app_service.d.ts

@@ -1,5 +1,5 @@
 import { type CallOptions, ChannelCredentials, Client, type ClientOptions, type ClientReadableStream, type ClientUnaryCall, type handleServerStreamingCall, type handleUnaryCall, Metadata, type ServiceError, type UntypedServiceImplementation } from "@grpc/grpc-js";
-import { AboutInformation, ActivateLicenseRequest, AppEventArgs, GetLicensesResponse, GetLogLevelResponse, GetServiceExtensionInfoRequest, GetServiceExtensionInfoResponse, InstallServiceExtensionRequest, LicenseInformation, LogMessages, SetLogLevelRequest, UninstallServiceExtensionRequest } from "./app_params";
+import { AboutInformation, ActivateLicenseRequest, AppEventArgs, ExtensionInfo, ExtensionInfos, GetExtensionInfoRequest, GetLicensesResponse, GetLogLevelResponse, InstallExtensionRequest, LicenseInformation, LogMessages, SetLogLevelRequest, UninstallExtensionRequest } from "./app_params";
 import { ApiPreferences } from "./common_params";
 import { Empty } from "./google/protobuf/empty";
 /**
@@ -79,46 +79,61 @@ export declare const AppServiceService: {
         readonly responseDeserialize: (value: Buffer) => Empty;
     };
     /**
-     * Asks the service to install a service extension.
-     * @param request A request message with a service extension .wasm-file.
-     * @returns An empty response message.
+     * Asks the service to install a GUI or service extension.
+     * @param request A request message with a service extension .wasm-file, or a GUI extension Node.js package file (.tgz file).
+     * @returns A response message with the installed extension information.
      */
-    readonly installServiceExtension: {
-        readonly path: "/appservice.AppService/InstallServiceExtension";
+    readonly installExtension: {
+        readonly path: "/appservice.AppService/InstallExtension";
         readonly requestStream: false;
         readonly responseStream: false;
-        readonly requestSerialize: (value: InstallServiceExtensionRequest) => Buffer;
-        readonly requestDeserialize: (value: Buffer) => InstallServiceExtensionRequest;
-        readonly responseSerialize: (value: Empty) => Buffer;
-        readonly responseDeserialize: (value: Buffer) => Empty;
+        readonly requestSerialize: (value: InstallExtensionRequest) => Buffer;
+        readonly requestDeserialize: (value: Buffer) => InstallExtensionRequest;
+        readonly responseSerialize: (value: ExtensionInfo) => Buffer;
+        readonly responseDeserialize: (value: Buffer) => ExtensionInfo;
     };
     /**
-     * Asks the service to uninstall a service extension.
-     * @param request A request message with a service extension name.
+     * Asks the service to uninstall a GUI or service extension.
+     * @param request A request message with a GUI or service extension name.
      * @returns An empty response message.
      */
-    readonly uninstallServiceExtension: {
-        readonly path: "/appservice.AppService/UninstallServiceExtension";
+    readonly uninstallExtension: {
+        readonly path: "/appservice.AppService/UninstallExtension";
         readonly requestStream: false;
         readonly responseStream: false;
-        readonly requestSerialize: (value: UninstallServiceExtensionRequest) => Buffer;
-        readonly requestDeserialize: (value: Buffer) => UninstallServiceExtensionRequest;
+        readonly requestSerialize: (value: UninstallExtensionRequest) => Buffer;
+        readonly requestDeserialize: (value: Buffer) => UninstallExtensionRequest;
         readonly responseSerialize: (value: Empty) => Buffer;
         readonly responseDeserialize: (value: Buffer) => Empty;
     };
     /**
-     * Gets a service extension's information.
-     * @param request A request message with a service extension .wasm-file or an installed extension's name.
+     * Gets information about all installed extensions.
+     * @param request A request message with API preferences.
+     * @returns A response message with all installed extensions information.
+     */
+    readonly getInstalledExtensions: {
+        readonly path: "/appservice.AppService/GetInstalledExtensions";
+        readonly requestStream: false;
+        readonly responseStream: false;
+        readonly requestSerialize: (value: ApiPreferences) => Buffer;
+        readonly requestDeserialize: (value: Buffer) => ApiPreferences;
+        readonly responseSerialize: (value: ExtensionInfos) => Buffer;
+        readonly responseDeserialize: (value: Buffer) => ExtensionInfos;
+    };
+    /**
+     * Gets an extension's information.
+     * @param request A request message with a service extension .wasm-file, a GUI extension Node.js package file (.tgz file),
+     *                or an installed extension's name.
      * @returns A response message with the extension information.
      */
-    readonly getServiceExtensionInfo: {
-        readonly path: "/appservice.AppService/GetServiceExtensionInfo";
+    readonly getExtensionInfo: {
+        readonly path: "/appservice.AppService/GetExtensionInfo";
         readonly requestStream: false;
         readonly responseStream: false;
-        readonly requestSerialize: (value: GetServiceExtensionInfoRequest) => Buffer;
-        readonly requestDeserialize: (value: Buffer) => GetServiceExtensionInfoRequest;
-        readonly responseSerialize: (value: GetServiceExtensionInfoResponse) => Buffer;
-        readonly responseDeserialize: (value: Buffer) => GetServiceExtensionInfoResponse;
+        readonly requestSerialize: (value: GetExtensionInfoRequest) => Buffer;
+        readonly requestDeserialize: (value: Buffer) => GetExtensionInfoRequest;
+        readonly responseSerialize: (value: ExtensionInfo) => Buffer;
+        readonly responseDeserialize: (value: Buffer) => ExtensionInfo;
     };
     /**
      * Gets all registered licenses.
@@ -209,23 +224,30 @@ export interface AppServiceServer extends UntypedServiceImplementation {
      */
     shutdown: handleUnaryCall<ApiPreferences, Empty>;
     /**
-     * Asks the service to install a service extension.
-     * @param request A request message with a service extension .wasm-file.
-     * @returns An empty response message.
+     * Asks the service to install a GUI or service extension.
+     * @param request A request message with a service extension .wasm-file, or a GUI extension Node.js package file (.tgz file).
+     * @returns A response message with the installed extension information.
      */
-    installServiceExtension: handleUnaryCall<InstallServiceExtensionRequest, Empty>;
+    installExtension: handleUnaryCall<InstallExtensionRequest, ExtensionInfo>;
     /**
-     * Asks the service to uninstall a service extension.
-     * @param request A request message with a service extension name.
+     * Asks the service to uninstall a GUI or service extension.
+     * @param request A request message with a GUI or service extension name.
      * @returns An empty response message.
      */
-    uninstallServiceExtension: handleUnaryCall<UninstallServiceExtensionRequest, Empty>;
+    uninstallExtension: handleUnaryCall<UninstallExtensionRequest, Empty>;
+    /**
+     * Gets information about all installed extensions.
+     * @param request A request message with API preferences.
+     * @returns A response message with all installed extensions information.
+     */
+    getInstalledExtensions: handleUnaryCall<ApiPreferences, ExtensionInfos>;
     /**
-     * Gets a service extension's information.
-     * @param request A request message with a service extension .wasm-file or an installed extension's name.
+     * Gets an extension's information.
+     * @param request A request message with a service extension .wasm-file, a GUI extension Node.js package file (.tgz file),
+     *                or an installed extension's name.
      * @returns A response message with the extension information.
      */
-    getServiceExtensionInfo: handleUnaryCall<GetServiceExtensionInfoRequest, GetServiceExtensionInfoResponse>;
+    getExtensionInfo: handleUnaryCall<GetExtensionInfoRequest, ExtensionInfo>;
     /**
      * Gets all registered licenses.
      * @param request A request message with API preferences.
@@ -291,29 +313,38 @@ export interface AppServiceClient extends Client {
     shutdown(request: ApiPreferences, metadata: Metadata, callback: (error: ServiceError | null, response: Empty) => void): ClientUnaryCall;
     shutdown(request: ApiPreferences, metadata: Metadata, options: Partial<CallOptions>, callback: (error: ServiceError | null, response: Empty) => void): ClientUnaryCall;
     /**
-     * Asks the service to install a service extension.
-     * @param request A request message with a service extension .wasm-file.
-     * @returns An empty response message.
+     * Asks the service to install a GUI or service extension.
+     * @param request A request message with a service extension .wasm-file, or a GUI extension Node.js package file (.tgz file).
+     * @returns A response message with the installed extension information.
      */
-    installServiceExtension(request: InstallServiceExtensionRequest, callback: (error: ServiceError | null, response: Empty) => void): ClientUnaryCall;
-    installServiceExtension(request: InstallServiceExtensionRequest, metadata: Metadata, callback: (error: ServiceError | null, response: Empty) => void): ClientUnaryCall;
-    installServiceExtension(request: InstallServiceExtensionRequest, metadata: Metadata, options: Partial<CallOptions>, callback: (error: ServiceError | null, response: Empty) => void): ClientUnaryCall;
+    installExtension(request: InstallExtensionRequest, callback: (error: ServiceError | null, response: ExtensionInfo) => void): ClientUnaryCall;
+    installExtension(request: InstallExtensionRequest, metadata: Metadata, callback: (error: ServiceError | null, response: ExtensionInfo) => void): ClientUnaryCall;
+    installExtension(request: InstallExtensionRequest, metadata: Metadata, options: Partial<CallOptions>, callback: (error: ServiceError | null, response: ExtensionInfo) => void): ClientUnaryCall;
     /**
-     * Asks the service to uninstall a service extension.
-     * @param request A request message with a service extension name.
+     * Asks the service to uninstall a GUI or service extension.
+     * @param request A request message with a GUI or service extension name.
      * @returns An empty response message.
      */
-    uninstallServiceExtension(request: UninstallServiceExtensionRequest, callback: (error: ServiceError | null, response: Empty) => void): ClientUnaryCall;
-    uninstallServiceExtension(request: UninstallServiceExtensionRequest, metadata: Metadata, callback: (error: ServiceError | null, response: Empty) => void): ClientUnaryCall;
-    uninstallServiceExtension(request: UninstallServiceExtensionRequest, metadata: Metadata, options: Partial<CallOptions>, callback: (error: ServiceError | null, response: Empty) => void): ClientUnaryCall;
+    uninstallExtension(request: UninstallExtensionRequest, callback: (error: ServiceError | null, response: Empty) => void): ClientUnaryCall;
+    uninstallExtension(request: UninstallExtensionRequest, metadata: Metadata, callback: (error: ServiceError | null, response: Empty) => void): ClientUnaryCall;
+    uninstallExtension(request: UninstallExtensionRequest, metadata: Metadata, options: Partial<CallOptions>, callback: (error: ServiceError | null, response: Empty) => void): ClientUnaryCall;
+    /**
+     * Gets information about all installed extensions.
+     * @param request A request message with API preferences.
+     * @returns A response message with all installed extensions information.
+     */
+    getInstalledExtensions(request: ApiPreferences, callback: (error: ServiceError | null, response: ExtensionInfos) => void): ClientUnaryCall;
+    getInstalledExtensions(request: ApiPreferences, metadata: Metadata, callback: (error: ServiceError | null, response: ExtensionInfos) => void): ClientUnaryCall;
+    getInstalledExtensions(request: ApiPreferences, metadata: Metadata, options: Partial<CallOptions>, callback: (error: ServiceError | null, response: ExtensionInfos) => void): ClientUnaryCall;
     /**
-     * Gets a service extension's information.
-     * @param request A request message with a service extension .wasm-file or an installed extension's name.
+     * Gets an extension's information.
+     * @param request A request message with a service extension .wasm-file, a GUI extension Node.js package file (.tgz file),
+     *                or an installed extension's name.
      * @returns A response message with the extension information.
      */
-    getServiceExtensionInfo(request: GetServiceExtensionInfoRequest, callback: (error: ServiceError | null, response: GetServiceExtensionInfoResponse) => void): ClientUnaryCall;
-    getServiceExtensionInfo(request: GetServiceExtensionInfoRequest, metadata: Metadata, callback: (error: ServiceError | null, response: GetServiceExtensionInfoResponse) => void): ClientUnaryCall;
-    getServiceExtensionInfo(request: GetServiceExtensionInfoRequest, metadata: Metadata, options: Partial<CallOptions>, callback: (error: ServiceError | null, response: GetServiceExtensionInfoResponse) => void): ClientUnaryCall;
+    getExtensionInfo(request: GetExtensionInfoRequest, callback: (error: ServiceError | null, response: ExtensionInfo) => void): ClientUnaryCall;
+    getExtensionInfo(request: GetExtensionInfoRequest, metadata: Metadata, callback: (error: ServiceError | null, response: ExtensionInfo) => void): ClientUnaryCall;
+    getExtensionInfo(request: GetExtensionInfoRequest, metadata: Metadata, options: Partial<CallOptions>, callback: (error: ServiceError | null, response: ExtensionInfo) => void): ClientUnaryCall;
     /**
      * Gets all registered licenses.
      * @param request A request message with API preferences.

package/dist/protos/common_params.d.ts

@@ -1,6 +1,9 @@
 import { BinaryReader, BinaryWriter } from "@bufbuild/protobuf/wire";
 import Long from "long";
-/** A message to be included in all request messages to control the responses. */
+/**
+ * A message to be included in all request messages to control the responses.
+ * @internal
+ */
 export interface ApiPreferences {
     /** The API version used by the client. */
     version: string;

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;