UNPKG

@kvaser/canking-api

Version:

CanKing API to communicate with the CanKing service using Node.js.

160 lines (81 loc) • 2.15 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
[**Kvaser CanKing GUI Extensions SDK v7.5.1**](../../README.md) *** [Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / Frame # Interface: Frame A message describing a frame. ## Properties ### canFrameFlags? > `optional` **canFrameFlags**: [`CanFrameFlags`](CanFrameFlags.md) Special CAN flags *** ### data > **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? > `optional` **deltaTimeUs**: `Long` Delta time in microseconds since the previous frame with the same fixed pos identifier *** ### dlc > **dlc**: `number` Frame DLC *** ### fixedPosIdentifier? > `optional` **fixedPosIdentifier**: `string` Fixed position frame identifier *** ### hashCode > **hashCode**: `number` Frame hash code, a unique key that identifies the frame *** ### id > **id**: `number` Frame identifier *** ### linFrameFlags? > `optional` **linFrameFlags**: [`LinFrameFlags`](LinFrameFlags.md) Special LIN flags *** ### messageName > **messageName**: `string` Frame identifier *** ### muxValue? > `optional` **muxValue**: `number` Multiplexing value of the frame, used in multiplexed CAN frames *** ### properties > **properties**: `object` Extra properties #### Index Signature \[`key`: `string`\]: [`FramePropertyValue`](FramePropertyValue.md) *** ### protocol? > `optional` **protocol**: `string` Protocol used for this frame *** ### signalValues > **signalValues**: [`SignalValue`](SignalValue.md)[] Signal values *** ### sourceId > **sourceId**: `string` Identifier of the source node *** ### sourceName > **sourceName**: `string` Name of the source node *** ### streamId > **streamId**: `string` Identifier of the stream node *** ### timeUs > **timeUs**: `Long` Timestamp in microseconds when the frame was received or transmitted *** ### tx > **tx**: `boolean` Flag indicating if this message was transmitted or received