UNPKG

@kvaser/canking-api

Version:

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

165 lines (86 loc) • 3.31 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
161
162
163
164
165
[**Kvaser CanKing GUI Extensions SDK v7.5.1**](../../README.md) *** [Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / CanChannelConfiguration # Interface: CanChannelConfiguration A message for defining a CAN channel's configuration. ## Remarks When using CAN FD or CAN XL, both arbitration and data phase bus parameters must be specified. For CAN XL, both CAN FD and CAN XL data phase parameters must be specified. Specify either only the bit rate or both the bit rate and the sample point or only the bus parameters for each phase. If the bus parameters are specified, the bit rate and sample point values are ignored (will be calculated automatically). If only the bit rate is specified, the sample point will be set to a default value of 75% for classic CAN and 80% for CAN FD and CAN XL ## Properties ### accessMode > **accessMode**: [`AccessMode`](../enumerations/AccessMode.md) The access mode to use. *** ### busParams > **busParams**: [`CanBusParams`](CanBusParams.md) \| `undefined` The selected bus params for classic CAN or the selected bus params for the arbitration phase in CAN FD/CAN XL. *** ### busParamsBitRate > **busParamsBitRate**: `number` Bit rate of the selected bus params for classic CAN or the selected bus params for the arbitration phase in CAN FD/CAN XL. *** ### busParamsBitRateFd? > `optional` **busParamsBitRateFd**: `number` Bit rate of the selected bus params for the data phase in CAN FD. *** ### busParamsBitRateXl? > `optional` **busParamsBitRateXl**: `number` Bit rate of the selected bus params for the data phase in CAN XL. *** ### busParamsFd? > `optional` **busParamsFd**: [`CanBusParams`](CanBusParams.md) The selected bus params for the data phase in CAN FD. *** ### busParamsSamplePoint? > `optional` **busParamsSamplePoint**: `number` Sample point in percentage of the selected bus params for classic CAN or the selected bus params for the arbitration phase in CAN FD/CAN XL. *** ### busParamsSamplePointFd? > `optional` **busParamsSamplePointFd**: `number` Sample point in percentage of the selected bus params for the data phase in CAN FD. *** ### busParamsSamplePointXl? > `optional` **busParamsSamplePointXl**: `number` Sample point in percentage of the selected bus params for the data phase in CAN XL. *** ### busParamsXl? > `optional` **busParamsXl**: [`CanBusParams`](CanBusParams.md) The selected bus params for the data phase in CAN XL. *** ### canConfigModes > **canConfigModes**: [`CanConfigMode`](../enumerations/CanConfigMode.md)[] The CAN configuration mode to use. *** ### canMode > **canMode**: [`CanMode`](../enumerations/CanMode.md) The CAN mode to use. *** ### fdTdc? > `optional` **fdTdc**: [`TdcConfiguration`](TdcConfiguration.md) CAN FD Transmitter-Delay Compensation (TDC). *** ### pwml? > `optional` **pwml**: `number` PWM long phase (mtq). *** ### pwmo? > `optional` **pwmo**: `number` PWM time offset (mtq). *** ### pwms? > `optional` **pwms**: `number` PWM short phase (mtq). *** ### silentMode > **silentMode**: `boolean` Set to true to enable silent mode, otherwise the channel will be setup as normal. *** ### xlTdc? > `optional` **xlTdc**: [`TdcConfiguration`](TdcConfiguration.md) CAN XL Transmitter-Delay Compensation (TDC).