@kvaser/canking-api 7.3.0 → 7.4.0

package/dist/protos/status_params.d.ts

@@ -3,8 +3,11 @@ import Long from "long";
 /** Possible CAN frame flags. The flag value must match the canlib flag value. */
 export declare enum StatusLevel {
     STATUS_LEVEL_NONE = 0,
+    /** STATUS_LEVEL_OK - Status is OK. */
     STATUS_LEVEL_OK = 1,
+    /** STATUS_LEVEL_WARNING - Status is warning. */
     STATUS_LEVEL_WARNING = 2,
+    /** STATUS_LEVEL_ERROR - Status is error. */
     STATUS_LEVEL_ERROR = 3,
     UNRECOGNIZED = -1
 }
@@ -13,7 +16,9 @@ export declare function statusLevelToJSON(object: StatusLevel): string;
 /** Possible log replay states. */
 export declare enum LogReplayState {
     LOG_REPLAY_STATE_UNSPECIFIED = 0,
+    /** LOG_REPLAY_STATE_STARTED - The log replay is in started state. */
     LOG_REPLAY_STATE_STARTED = 1,
+    /** LOG_REPLAY_STATE_STOPPED - The log replay is in stopped state. */
     LOG_REPLAY_STATE_STOPPED = 2,
     UNRECOGNIZED = -1
 }
@@ -22,8 +27,11 @@ export declare function logReplayStateToJSON(object: LogReplayState): string;
 /** Possible message or signal logger states. */
 export declare enum LoggerState {
     MESSAGE_LOGGER_STATE_UNSPECIFIED = 0,
+    /** MESSAGE_LOGGER_STATE_PRESTART - The logger is in the pre-start state. */
     MESSAGE_LOGGER_STATE_PRESTART = 1,
+    /** MESSAGE_LOGGER_STATE_STARTED - The logger is currently started. */
     MESSAGE_LOGGER_STATE_STARTED = 2,
+    /** MESSAGE_LOGGER_STATE_STOPPED - The logger is currently stopped. */
     MESSAGE_LOGGER_STATE_STOPPED = 3,
     UNRECOGNIZED = -1
 }
@@ -31,35 +39,56 @@ export declare function loggerStateFromJSON(object: any): LoggerState;
 export declare function loggerStateToJSON(object: LoggerState): string;
 /** A message holding bus status information. */
 export interface BusStatus {
+    /** The number of received messages. */
     rxMessageCounter: number;
+    /** The number of received messages per second. */
     rxMessagesPerSecond: number;
+    /** The number of transmitted messages. */
     txMessageCounter: number;
+    /** The number of transmitted messages per second. */
     txMessagesPerSecond: number;
+    /** The number of error frames. */
     errorFrameCounter: number;
+    /** The number of error frames per second. */
     errorFramesPerSecond: number;
+    /** The number of overruns. */
     overrunCounter: number;
+    /** The number of overruns per second. */
     overrunsPerSecond: number;
+    /** The number of received errors. */
     rxErrorCounter: number;
+    /** The number of transmitted errors. */
     txErrorCounter: number;
+    /** The number of overrun errors. */
     overrunErrorCounter: number;
+    /** The bus on status level. */
     busOnStatus: StatusLevel;
+    /** The error status level. */
     errorStatus: StatusLevel;
+    /** The overrun status level. */
     overrunStatus: StatusLevel;
+    /** The bus load. */
     busLoad: number;
 }
 /** A message holding special data processing status information. */
 export interface DataProcessingStatus {
+    /** Number of errors encountered during data processing. */
     errorCounter: number;
+    /** The last execution time of the data processing. */
     lastExecutionTime: Long;
+    /** The minimum execution time of the data processing. */
     minExecutionTime: Long;
+    /** The maximum execution time of the data processing. */
     maxExecutionTime: Long;
 }
 /** A message holding special log replay status information. */
 export interface LogReplayStatus {
+    /** The current state of the log replay. */
     state: LogReplayState;
 }
 /** A message holding special message or signal logger status information. */
 export interface LoggerStatus {
+    /** The current state of the logger. */
     state: LoggerState;
 }
 /** A message holding any errors associated with a node. */
@@ -88,6 +117,7 @@ export interface NodeStatus {
 }
 /** A collection of node status items. */
 export interface NodeStatuses {
+    /** A list of node status items. */
     items: NodeStatus[];
 }
 export declare const BusStatus: MessageFns<BusStatus>;