forked from hardbyte/python-can
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathcanlib.py
More file actions
1173 lines (1040 loc) · 42.8 KB
/
canlib.py
File metadata and controls
1173 lines (1040 loc) · 42.8 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
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
"""
Ctypes wrapper module for Vector CAN Interface on win32/win64 systems.
Authors: Julien Grave <[email protected]>, Christian Sandberg
"""
# Import Standard Python Modules
# ==============================
import ctypes
import logging
import time
import os
from types import ModuleType
from typing import (
List,
NamedTuple,
Optional,
Tuple,
Sequence,
Union,
Any,
Dict,
Callable,
cast,
)
WaitForSingleObject: Optional[Callable[[int, int], int]]
INFINITE: Optional[int]
try:
# Try builtin Python 3 Windows API
from _winapi import WaitForSingleObject, INFINITE # type: ignore
HAS_EVENTS = True
except ImportError:
WaitForSingleObject, INFINITE = None, None
HAS_EVENTS = False
# Import Modules
# ==============
from can import (
BusABC,
Message,
CanInterfaceNotImplementedError,
CanInitializationError,
BitTiming,
BitTimingFd,
)
from can.util import (
len2dlc,
dlc2len,
deprecated_args_alias,
time_perfcounter_correlation,
check_or_adjust_timing_clock,
)
from can.typechecking import AutoDetectedConfig, CanFilters
# Define Module Logger
# ====================
LOG = logging.getLogger(__name__)
# Import Vector API modules
# =========================
from .exceptions import VectorError, VectorInitializationError, VectorOperationError
from . import xldefine, xlclass
# Import safely Vector API module for Travis tests
xldriver: Optional[ModuleType] = None
try:
from . import xldriver
except Exception as exc:
LOG.warning("Could not import vxlapi: %s", exc)
class VectorBus(BusABC):
"""The CAN Bus implemented for the Vector interface."""
deprecated_args = dict(
sjwAbr="sjw_abr",
tseg1Abr="tseg1_abr",
tseg2Abr="tseg2_abr",
sjwDbr="sjw_dbr",
tseg1Dbr="tseg1_dbr",
tseg2Dbr="tseg2_dbr",
)
@deprecated_args_alias(
deprecation_start="4.0.0",
deprecation_end="5.0.0",
**deprecated_args,
)
def __init__(
self,
channel: Union[int, Sequence[int], str],
can_filters: Optional[CanFilters] = None,
poll_interval: float = 0.01,
receive_own_messages: bool = False,
timing: Optional[Union[BitTiming, BitTimingFd]] = None,
bitrate: Optional[int] = None,
rx_queue_size: int = 2**14,
app_name: Optional[str] = "CANalyzer",
serial: Optional[int] = None,
fd: bool = False,
data_bitrate: Optional[int] = None,
sjw_abr: int = 2,
tseg1_abr: int = 6,
tseg2_abr: int = 3,
sjw_dbr: int = 2,
tseg1_dbr: int = 6,
tseg2_dbr: int = 3,
**kwargs: Any,
) -> None:
"""
:param channel:
The channel indexes to create this bus with.
Can also be a single integer or a comma separated string.
:param can_filters:
See :class:`can.BusABC`.
:param receive_own_messages:
See :class:`can.BusABC`.
:param timing:
An instance of :class:`~can.BitTiming` or :class:`~can.BitTimingFd`
to specify the bit timing parameters for the VectorBus interface. The
`f_clock` value of the timing instance must be set to 8_000_000 (8MHz)
or 16_000_000 (16MHz) for CAN 2.0 or 80_000_000 (80MHz) for CAN FD.
If this parameter is provided, it takes precedence over all other
timing-related parameters.
Otherwise, the bit timing can be specified using the following parameters:
`bitrate` for standard CAN or `fd`, `data_bitrate`, `sjw_abr`, `tseg1_abr`,
`tseg2_abr`, `sjw_dbr`, `tseg1_dbr`, and `tseg2_dbr` for CAN FD.
:param poll_interval:
Poll interval in seconds.
:param bitrate:
Bitrate in bits/s.
:param rx_queue_size:
Number of messages in receive queue (power of 2).
CAN: range `16…32768`
CAN-FD: range `8192…524288`
:param app_name:
Name of application in *Vector Hardware Config*.
If set to `None`, the channel should be a global channel index.
:param serial:
Serial number of the hardware to be used.
If set, the channel parameter refers to the channels ONLY on the specified hardware.
If set, the `app_name` does not have to be previously defined in
*Vector Hardware Config*.
:param fd:
If CAN-FD frames should be supported.
:param data_bitrate:
Which bitrate to use for data phase in CAN FD.
Defaults to arbitration bitrate.
:param sjw_abr:
Bus timing value sample jump width (arbitration).
:param tseg1_abr:
Bus timing value tseg1 (arbitration)
:param tseg2_abr:
Bus timing value tseg2 (arbitration)
:param sjw_dbr:
Bus timing value sample jump width (data)
:param tseg1_dbr:
Bus timing value tseg1 (data)
:param tseg2_dbr:
Bus timing value tseg2 (data)
:raise ~can.exceptions.CanInterfaceNotImplementedError:
If the current operating system is not supported or the driver could not be loaded.
:raise ~can.exceptions.CanInitializationError:
If the bus could not be set up.
This may or may not be a :class:`~can.interfaces.vector.VectorInitializationError`.
"""
self.__testing = kwargs.get("_testing", False)
if os.name != "nt" and not self.__testing:
raise CanInterfaceNotImplementedError(
f"The Vector interface is only supported on Windows, "
f'but you are running "{os.name}"'
)
if xldriver is None:
raise CanInterfaceNotImplementedError("The Vector API has not been loaded")
self.xldriver = xldriver # keep reference so mypy knows it is not None
self.xldriver.xlOpenDriver()
self.poll_interval = poll_interval
self.channels: Sequence[int]
if isinstance(channel, int):
self.channels = [channel]
elif isinstance(channel, str): # must be checked before generic Sequence
# Assume comma separated string of channels
self.channels = [int(ch.strip()) for ch in channel.split(",")]
elif isinstance(channel, Sequence):
self.channels = [int(ch) for ch in channel]
else:
raise TypeError(
f"Invalid type for parameter 'channel': {type(channel).__name__}"
)
self._app_name = app_name.encode() if app_name is not None else b""
self.channel_info = "Application {}: {}".format(
app_name,
", ".join(f"CAN {ch + 1}" for ch in self.channels),
)
channel_configs = get_channel_configs()
self.mask = 0
self.fd = isinstance(timing, BitTimingFd) if timing else fd
self.channel_masks: Dict[int, int] = {}
self.index_to_channel: Dict[int, int] = {}
for channel in self.channels:
channel_index = self._find_global_channel_idx(
channel=channel,
serial=serial,
app_name=app_name,
channel_configs=channel_configs,
)
LOG.debug("Channel index %d found", channel)
channel_mask = 1 << channel_index
self.channel_masks[channel] = channel_mask
self.index_to_channel[channel_index] = channel
self.mask |= channel_mask
permission_mask = xlclass.XLaccess()
# Set mask to request channel init permission if needed
if bitrate or fd or timing:
permission_mask.value = self.mask
interface_version = (
xldefine.XL_InterfaceVersion.XL_INTERFACE_VERSION_V4
if self.fd
else xldefine.XL_InterfaceVersion.XL_INTERFACE_VERSION
)
self.port_handle = xlclass.XLportHandle(xldefine.XL_INVALID_PORTHANDLE)
self.xldriver.xlOpenPort(
self.port_handle,
self._app_name,
self.mask,
permission_mask,
rx_queue_size,
interface_version,
xldefine.XL_BusTypes.XL_BUS_TYPE_CAN,
)
self.permission_mask = permission_mask.value
LOG.debug(
"Open Port: PortHandle: %d, PermissionMask: 0x%X",
self.port_handle.value,
permission_mask.value,
)
# set CAN settings
for channel in self.channels:
if isinstance(timing, BitTiming):
timing = check_or_adjust_timing_clock(timing, [16_000_000, 8_000_000])
self._set_bit_timing(
channel=channel,
timing=timing,
)
elif isinstance(timing, BitTimingFd):
timing = check_or_adjust_timing_clock(timing, [80_000_000])
self._set_bit_timing_fd(
channel=channel,
timing=timing,
)
elif fd:
self._set_bit_timing_fd(
channel=channel,
timing=BitTimingFd.from_bitrate_and_segments(
f_clock=80_000_000,
nom_bitrate=bitrate or 500_000,
nom_tseg1=tseg1_abr,
nom_tseg2=tseg2_abr,
nom_sjw=sjw_abr,
data_bitrate=data_bitrate or bitrate or 500_000,
data_tseg1=tseg1_dbr,
data_tseg2=tseg2_dbr,
data_sjw=sjw_dbr,
),
)
elif bitrate:
self._set_bitrate(channel=channel, bitrate=bitrate)
# Enable/disable TX receipts
tx_receipts = 1 if receive_own_messages else 0
self.xldriver.xlCanSetChannelMode(self.port_handle, self.mask, tx_receipts, 0)
if HAS_EVENTS:
self.event_handle = xlclass.XLhandle()
self.xldriver.xlSetNotification(self.port_handle, self.event_handle, 1)
else:
LOG.info("Install pywin32 to avoid polling")
try:
self.xldriver.xlActivateChannel(
self.port_handle, self.mask, xldefine.XL_BusTypes.XL_BUS_TYPE_CAN, 0
)
except VectorOperationError as error:
self.shutdown()
raise VectorInitializationError.from_generic(error) from None
# Calculate time offset for absolute timestamps
offset = xlclass.XLuint64()
try:
if time.get_clock_info("time").resolution > 1e-5:
ts, perfcounter = time_perfcounter_correlation()
try:
self.xldriver.xlGetSyncTime(self.port_handle, offset)
except VectorInitializationError:
self.xldriver.xlGetChannelTime(self.port_handle, self.mask, offset)
current_perfcounter = time.perf_counter()
now = ts + (current_perfcounter - perfcounter)
self._time_offset = now - offset.value * 1e-9
else:
try:
self.xldriver.xlGetSyncTime(self.port_handle, offset)
except VectorInitializationError:
self.xldriver.xlGetChannelTime(self.port_handle, self.mask, offset)
self._time_offset = time.time() - offset.value * 1e-9
except VectorInitializationError:
self._time_offset = 0.0
self._is_filtered = False
super().__init__(channel=channel, can_filters=can_filters, **kwargs)
def _find_global_channel_idx(
self,
channel: int,
serial: Optional[int],
app_name: Optional[str],
channel_configs: List["VectorChannelConfig"],
) -> int:
if serial is not None:
serial_found = False
for channel_config in channel_configs:
if channel_config.serial_number != serial:
continue
serial_found = True
if channel_config.hw_channel == channel:
return channel_config.channel_index
if not serial_found:
err_msg = f"No interface with serial {serial} found."
else:
err_msg = (
f"Channel {channel} not found on interface with serial {serial}."
)
raise CanInitializationError(
err_msg, error_code=xldefine.XL_Status.XL_ERR_HW_NOT_PRESENT
)
if app_name:
hw_type, hw_index, hw_channel = self.get_application_config(
app_name, channel
)
idx = cast(
int, self.xldriver.xlGetChannelIndex(hw_type, hw_index, hw_channel)
)
if idx < 0:
# Undocumented behavior! See issue #353.
# If hardware is unavailable, this function returns -1.
# Raise an exception as if the driver
# would have signalled XL_ERR_HW_NOT_PRESENT.
raise VectorInitializationError(
xldefine.XL_Status.XL_ERR_HW_NOT_PRESENT,
xldefine.XL_Status.XL_ERR_HW_NOT_PRESENT.name,
"xlGetChannelIndex",
)
return idx
# check if channel is a valid global channel index
for channel_config in channel_configs:
if channel == channel_config.channel_index:
return channel
raise CanInitializationError(
f"Channel {channel} not found. The 'channel' parameter must be "
f"a valid global channel index if neither 'app_name' nor 'serial' were given.",
error_code=xldefine.XL_Status.XL_ERR_HW_NOT_PRESENT,
)
def _has_init_access(self, channel: int) -> bool:
return bool(self.permission_mask & self.channel_masks[channel])
def _read_bus_params(self, channel: int) -> "VectorBusParams":
channel_mask = self.channel_masks[channel]
vcc_list = get_channel_configs()
for vcc in vcc_list:
if vcc.channel_mask == channel_mask:
return vcc.bus_params
raise CanInitializationError(
f"Channel configuration for channel {channel} not found."
)
def _set_bitrate(self, channel: int, bitrate: int) -> None:
# set parameters if channel has init access
if self._has_init_access(channel):
self.xldriver.xlCanSetChannelBitrate(
self.port_handle,
self.channel_masks[channel],
bitrate,
)
LOG.info("xlCanSetChannelBitrate: baudr.=%u", bitrate)
if not self.__testing:
self._check_can_settings(
channel=channel,
bitrate=bitrate,
)
def _set_bit_timing(self, channel: int, timing: BitTiming) -> None:
# set parameters if channel has init access
if self._has_init_access(channel):
if timing.f_clock == 8_000_000:
self.xldriver.xlCanSetChannelParamsC200(
self.port_handle,
self.channel_masks[channel],
timing.btr0,
timing.btr1,
)
LOG.info(
"xlCanSetChannelParamsC200: BTR0=%#02x, BTR1=%#02x",
timing.btr0,
timing.btr1,
)
elif timing.f_clock == 16_000_000:
chip_params = xlclass.XLchipParams()
chip_params.bitRate = timing.bitrate
chip_params.sjw = timing.sjw
chip_params.tseg1 = timing.tseg1
chip_params.tseg2 = timing.tseg2
chip_params.sam = timing.nof_samples
self.xldriver.xlCanSetChannelParams(
self.port_handle,
self.channel_masks[channel],
chip_params,
)
LOG.info(
"xlCanSetChannelParams: baudr.=%u, sjwAbr=%u, tseg1Abr=%u, tseg2Abr=%u",
chip_params.bitRate,
chip_params.sjw,
chip_params.tseg1,
chip_params.tseg2,
)
else:
raise CanInitializationError(
f"timing.f_clock must be 8_000_000 or 16_000_000 (is {timing.f_clock})"
)
if not self.__testing:
self._check_can_settings(
channel=channel,
bitrate=timing.bitrate,
sample_point=timing.sample_point,
)
def _set_bit_timing_fd(
self,
channel: int,
timing: BitTimingFd,
) -> None:
# set parameters if channel has init access
if self._has_init_access(channel):
canfd_conf = xlclass.XLcanFdConf()
canfd_conf.arbitrationBitRate = timing.nom_bitrate
canfd_conf.sjwAbr = timing.nom_sjw
canfd_conf.tseg1Abr = timing.nom_tseg1
canfd_conf.tseg2Abr = timing.nom_tseg2
canfd_conf.dataBitRate = timing.data_bitrate
canfd_conf.sjwDbr = timing.data_sjw
canfd_conf.tseg1Dbr = timing.data_tseg1
canfd_conf.tseg2Dbr = timing.data_tseg2
self.xldriver.xlCanFdSetConfiguration(
self.port_handle, self.channel_masks[channel], canfd_conf
)
LOG.info(
"xlCanFdSetConfiguration.: ABaudr.=%u, DBaudr.=%u",
canfd_conf.arbitrationBitRate,
canfd_conf.dataBitRate,
)
LOG.info(
"xlCanFdSetConfiguration.: sjwAbr=%u, tseg1Abr=%u, tseg2Abr=%u",
canfd_conf.sjwAbr,
canfd_conf.tseg1Abr,
canfd_conf.tseg2Abr,
)
LOG.info(
"xlCanFdSetConfiguration.: sjwDbr=%u, tseg1Dbr=%u, tseg2Dbr=%u",
canfd_conf.sjwDbr,
canfd_conf.tseg1Dbr,
canfd_conf.tseg2Dbr,
)
if not self.__testing:
self._check_can_settings(
channel=channel,
bitrate=timing.nom_bitrate,
sample_point=timing.nom_sample_point,
fd=True,
data_bitrate=timing.data_bitrate,
data_sample_point=timing.data_sample_point,
)
def _check_can_settings(
self,
channel: int,
bitrate: int,
sample_point: Optional[float] = None,
fd: bool = False,
data_bitrate: Optional[int] = None,
data_sample_point: Optional[float] = None,
) -> None:
"""Compare requested CAN settings to active settings in driver."""
bus_params = self._read_bus_params(channel)
# use canfd even if fd==False, bus_params.can and bus_params.canfd are a C union
bus_params_data = bus_params.canfd
settings_acceptable = True
# check bus type
settings_acceptable &= (
bus_params.bus_type is xldefine.XL_BusTypes.XL_BUS_TYPE_CAN
)
# check CAN operation mode
if fd:
settings_acceptable &= bool(
bus_params_data.can_op_mode
& xldefine.XL_CANFD_BusParams_CanOpMode.XL_BUS_PARAMS_CANOPMODE_CANFD
)
elif bus_params_data.can_op_mode != 0: # can_op_mode is always 0 for cancaseXL
settings_acceptable &= bool(
bus_params_data.can_op_mode
& xldefine.XL_CANFD_BusParams_CanOpMode.XL_BUS_PARAMS_CANOPMODE_CAN20
)
# check bitrates
if bitrate:
settings_acceptable &= (
abs(bus_params_data.bitrate - bitrate) < bitrate / 256
)
if fd and data_bitrate:
settings_acceptable &= (
abs(bus_params_data.data_bitrate - data_bitrate) < data_bitrate / 256
)
# check sample points
if sample_point:
nom_sample_point_act = (
100
* (1 + bus_params_data.tseg1_abr)
/ (1 + bus_params_data.tseg1_abr + bus_params_data.tseg2_abr)
)
settings_acceptable &= (
abs(nom_sample_point_act - sample_point) < 2.0 # 2 percent tolerance
)
if fd and data_sample_point:
data_sample_point_act = (
100
* (1 + bus_params_data.tseg1_dbr)
/ (1 + bus_params_data.tseg1_dbr + bus_params_data.tseg2_dbr)
)
settings_acceptable &= (
abs(data_sample_point_act - data_sample_point)
< 2.0 # 2 percent tolerance
)
if not settings_acceptable:
# The error message depends on the currently active CAN settings.
# If the active operation mode is CAN FD, show the active CAN FD timings,
# otherwise show CAN 2.0 timings.
if bool(
bus_params_data.can_op_mode
& xldefine.XL_CANFD_BusParams_CanOpMode.XL_BUS_PARAMS_CANOPMODE_CANFD
):
active_settings = bus_params.canfd._asdict()
active_settings["can_op_mode"] = "CAN FD"
else:
active_settings = bus_params.can._asdict()
active_settings["can_op_mode"] = "CAN 2.0"
settings_string = ", ".join(
[f"{key}: {val}" for key, val in active_settings.items()]
)
raise CanInitializationError(
f"The requested settings could not be set for channel {channel}. "
f"Another application might have set incompatible settings. "
f"These are the currently active settings: {settings_string}."
)
def _apply_filters(self, filters: Optional[CanFilters]) -> None:
if filters:
# Only up to one filter per ID type allowed
if len(filters) == 1 or (
len(filters) == 2
and filters[0].get("extended") != filters[1].get("extended")
):
try:
for can_filter in filters:
self.xldriver.xlCanSetChannelAcceptance(
self.port_handle,
self.mask,
can_filter["can_id"],
can_filter["can_mask"],
xldefine.XL_AcceptanceFilter.XL_CAN_EXT
if can_filter.get("extended")
else xldefine.XL_AcceptanceFilter.XL_CAN_STD,
)
except VectorOperationError as exception:
LOG.warning("Could not set filters: %s", exception)
# go to fallback
else:
self._is_filtered = True
return
else:
LOG.warning("Only up to one filter per extended or standard ID allowed")
# go to fallback
# fallback: reset filters
self._is_filtered = False
try:
self.xldriver.xlCanSetChannelAcceptance(
self.port_handle,
self.mask,
0x0,
0x0,
xldefine.XL_AcceptanceFilter.XL_CAN_EXT,
)
self.xldriver.xlCanSetChannelAcceptance(
self.port_handle,
self.mask,
0x0,
0x0,
xldefine.XL_AcceptanceFilter.XL_CAN_STD,
)
except VectorOperationError as exc:
LOG.warning("Could not reset filters: %s", exc)
def _recv_internal(
self, timeout: Optional[float]
) -> Tuple[Optional[Message], bool]:
end_time = time.time() + timeout if timeout is not None else None
while True:
try:
if self.fd:
msg = self._recv_canfd()
else:
msg = self._recv_can()
except VectorOperationError as exception:
if exception.error_code != xldefine.XL_Status.XL_ERR_QUEUE_IS_EMPTY:
raise
else:
if msg:
return msg, self._is_filtered
# if no message was received, wait or return on timeout
if end_time is not None and time.time() > end_time:
return None, self._is_filtered
if HAS_EVENTS:
# Wait for receive event to occur
if end_time is None:
time_left_ms = INFINITE
else:
time_left = end_time - time.time()
time_left_ms = max(0, int(time_left * 1000))
WaitForSingleObject(self.event_handle.value, time_left_ms) # type: ignore
else:
# Wait a short time until we try again
time.sleep(self.poll_interval)
def _recv_canfd(self) -> Optional[Message]:
xl_can_rx_event = xlclass.XLcanRxEvent()
self.xldriver.xlCanReceive(self.port_handle, xl_can_rx_event)
if xl_can_rx_event.tag == xldefine.XL_CANFD_RX_EventTags.XL_CAN_EV_TAG_RX_OK:
is_rx = True
data_struct = xl_can_rx_event.tagData.canRxOkMsg
elif xl_can_rx_event.tag == xldefine.XL_CANFD_RX_EventTags.XL_CAN_EV_TAG_TX_OK:
is_rx = False
data_struct = xl_can_rx_event.tagData.canTxOkMsg
else:
self.handle_canfd_event(xl_can_rx_event)
return None
msg_id = data_struct.canId
dlc = dlc2len(data_struct.dlc)
flags = data_struct.msgFlags
timestamp = xl_can_rx_event.timeStamp * 1e-9
channel = self.index_to_channel.get(xl_can_rx_event.chanIndex)
return Message(
timestamp=timestamp + self._time_offset,
arbitration_id=msg_id & 0x1FFFFFFF,
is_extended_id=bool(
msg_id & xldefine.XL_MessageFlagsExtended.XL_CAN_EXT_MSG_ID
),
is_remote_frame=bool(
flags & xldefine.XL_CANFD_RX_MessageFlags.XL_CAN_RXMSG_FLAG_RTR
),
is_error_frame=bool(
flags & xldefine.XL_CANFD_RX_MessageFlags.XL_CAN_RXMSG_FLAG_EF
),
is_fd=bool(flags & xldefine.XL_CANFD_RX_MessageFlags.XL_CAN_RXMSG_FLAG_EDL),
bitrate_switch=bool(
flags & xldefine.XL_CANFD_RX_MessageFlags.XL_CAN_RXMSG_FLAG_BRS
),
error_state_indicator=bool(
flags & xldefine.XL_CANFD_RX_MessageFlags.XL_CAN_RXMSG_FLAG_ESI
),
is_rx=is_rx,
channel=channel,
dlc=dlc,
data=data_struct.data[:dlc],
)
def _recv_can(self) -> Optional[Message]:
xl_event = xlclass.XLevent()
event_count = ctypes.c_uint(1)
self.xldriver.xlReceive(self.port_handle, event_count, xl_event)
if xl_event.tag != xldefine.XL_EventTags.XL_RECEIVE_MSG:
self.handle_can_event(xl_event)
return None
msg_id = xl_event.tagData.msg.id
dlc = xl_event.tagData.msg.dlc
flags = xl_event.tagData.msg.flags
timestamp = xl_event.timeStamp * 1e-9
channel = self.index_to_channel.get(xl_event.chanIndex)
return Message(
timestamp=timestamp + self._time_offset,
arbitration_id=msg_id & 0x1FFFFFFF,
is_extended_id=bool(
msg_id & xldefine.XL_MessageFlagsExtended.XL_CAN_EXT_MSG_ID
),
is_remote_frame=bool(
flags & xldefine.XL_MessageFlags.XL_CAN_MSG_FLAG_REMOTE_FRAME
),
is_error_frame=bool(
flags & xldefine.XL_MessageFlags.XL_CAN_MSG_FLAG_ERROR_FRAME
),
is_rx=not bool(
flags & xldefine.XL_MessageFlags.XL_CAN_MSG_FLAG_TX_COMPLETED
),
is_fd=False,
dlc=dlc,
data=xl_event.tagData.msg.data[:dlc],
channel=channel,
)
def handle_can_event(self, event: xlclass.XLevent) -> None:
"""Handle non-message CAN events.
Method is called by :meth:`~can.interfaces.vector.VectorBus._recv_internal`
when `event.tag` is not `XL_RECEIVE_MSG`. Subclasses can implement this method.
:param event: XLevent that could have a `XL_CHIP_STATE`, `XL_TIMER` or `XL_SYNC_PULSE` tag.
"""
def handle_canfd_event(self, event: xlclass.XLcanRxEvent) -> None:
"""Handle non-message CAN FD events.
Method is called by :meth:`~can.interfaces.vector.VectorBus._recv_internal`
when `event.tag` is not `XL_CAN_EV_TAG_RX_OK` or `XL_CAN_EV_TAG_TX_OK`.
Subclasses can implement this method.
:param event: `XLcanRxEvent` that could have a `XL_CAN_EV_TAG_RX_ERROR`,
`XL_CAN_EV_TAG_TX_ERROR`, `XL_TIMER` or `XL_CAN_EV_TAG_CHIP_STATE` tag.
"""
def send(self, msg: Message, timeout: Optional[float] = None) -> None:
self._send_sequence([msg])
def _send_sequence(self, msgs: Sequence[Message]) -> int:
"""Send messages and return number of successful transmissions."""
if self.fd:
return self._send_can_fd_msg_sequence(msgs)
else:
return self._send_can_msg_sequence(msgs)
def _get_tx_channel_mask(self, msgs: Sequence[Message]) -> int:
if len(msgs) == 1:
return self.channel_masks.get(msgs[0].channel, self.mask) # type: ignore[arg-type]
else:
return self.mask
def _send_can_msg_sequence(self, msgs: Sequence[Message]) -> int:
"""Send CAN messages and return number of successful transmissions."""
mask = self._get_tx_channel_mask(msgs)
message_count = ctypes.c_uint(len(msgs))
xl_event_array = (xlclass.XLevent * message_count.value)(
*map(self._build_xl_event, msgs)
)
self.xldriver.xlCanTransmit(
self.port_handle, mask, message_count, xl_event_array
)
return message_count.value
@staticmethod
def _build_xl_event(msg: Message) -> xlclass.XLevent:
msg_id = msg.arbitration_id
if msg.is_extended_id:
msg_id |= xldefine.XL_MessageFlagsExtended.XL_CAN_EXT_MSG_ID
flags = 0
if msg.is_remote_frame:
flags |= xldefine.XL_MessageFlags.XL_CAN_MSG_FLAG_REMOTE_FRAME
xl_event = xlclass.XLevent()
xl_event.tag = xldefine.XL_EventTags.XL_TRANSMIT_MSG
xl_event.tagData.msg.id = msg_id
xl_event.tagData.msg.dlc = msg.dlc
xl_event.tagData.msg.flags = flags
xl_event.tagData.msg.data = tuple(msg.data)
return xl_event
def _send_can_fd_msg_sequence(self, msgs: Sequence[Message]) -> int:
"""Send CAN FD messages and return number of successful transmissions."""
mask = self._get_tx_channel_mask(msgs)
message_count = len(msgs)
xl_can_tx_event_array = (xlclass.XLcanTxEvent * message_count)(
*map(self._build_xl_can_tx_event, msgs)
)
msg_count_sent = ctypes.c_uint(0)
self.xldriver.xlCanTransmitEx(
self.port_handle, mask, message_count, msg_count_sent, xl_can_tx_event_array
)
return msg_count_sent.value
@staticmethod
def _build_xl_can_tx_event(msg: Message) -> xlclass.XLcanTxEvent:
msg_id = msg.arbitration_id
if msg.is_extended_id:
msg_id |= xldefine.XL_MessageFlagsExtended.XL_CAN_EXT_MSG_ID
flags = 0
if msg.is_fd:
flags |= xldefine.XL_CANFD_TX_MessageFlags.XL_CAN_TXMSG_FLAG_EDL
if msg.bitrate_switch:
flags |= xldefine.XL_CANFD_TX_MessageFlags.XL_CAN_TXMSG_FLAG_BRS
if msg.is_remote_frame:
flags |= xldefine.XL_CANFD_TX_MessageFlags.XL_CAN_TXMSG_FLAG_RTR
xl_can_tx_event = xlclass.XLcanTxEvent()
xl_can_tx_event.tag = xldefine.XL_CANFD_TX_EventTags.XL_CAN_EV_TAG_TX_MSG
xl_can_tx_event.transId = 0xFFFF
xl_can_tx_event.tagData.canMsg.canId = msg_id
xl_can_tx_event.tagData.canMsg.msgFlags = flags
xl_can_tx_event.tagData.canMsg.dlc = len2dlc(msg.dlc)
xl_can_tx_event.tagData.canMsg.data = tuple(msg.data)
return xl_can_tx_event
def flush_tx_buffer(self) -> None:
self.xldriver.xlCanFlushTransmitQueue(self.port_handle, self.mask)
def shutdown(self) -> None:
super().shutdown()
self.xldriver.xlDeactivateChannel(self.port_handle, self.mask)
self.xldriver.xlClosePort(self.port_handle)
self.xldriver.xlCloseDriver()
def reset(self) -> None:
self.xldriver.xlDeactivateChannel(self.port_handle, self.mask)
self.xldriver.xlActivateChannel(
self.port_handle, self.mask, xldefine.XL_BusTypes.XL_BUS_TYPE_CAN, 0
)
@staticmethod
def _detect_available_configs() -> List[AutoDetectedConfig]:
configs = []
channel_configs = get_channel_configs()
LOG.info("Found %d channels", len(channel_configs))
for channel_config in channel_configs:
if (
not channel_config.channel_bus_capabilities
& xldefine.XL_BusCapabilities.XL_BUS_ACTIVE_CAP_CAN
):
continue
LOG.info(
"Channel index %d: %s",
channel_config.channel_index,
channel_config.name,
)
configs.append(
{
# data for use in VectorBus.__init__():
"interface": "vector",
"channel": channel_config.hw_channel,
"serial": channel_config.serial_number,
# data for use in VectorBus.set_application_config():
"hw_type": channel_config.hw_type,
"hw_index": channel_config.hw_index,
"hw_channel": channel_config.hw_channel,
# additional information:
"supports_fd": bool(
channel_config.channel_capabilities
& xldefine.XL_ChannelCapabilities.XL_CHANNEL_FLAG_CANFD_ISO_SUPPORT
),
"vector_channel_config": channel_config,
}
)
return configs # type: ignore
@staticmethod
def popup_vector_hw_configuration(wait_for_finish: int = 0) -> None:
"""Open vector hardware configuration window.
:param wait_for_finish:
Time to wait for user input in milliseconds.
"""
if xldriver is None:
raise CanInterfaceNotImplementedError("The Vector API has not been loaded")
xldriver.xlPopupHwConfig(ctypes.c_char_p(), ctypes.c_uint(wait_for_finish))
@staticmethod
def get_application_config(
app_name: str, app_channel: int
) -> Tuple[Union[int, xldefine.XL_HardwareType], int, int]:
"""Retrieve information for an application in Vector Hardware Configuration.
:param app_name:
The name of the application.
:param app_channel:
The channel of the application.
:return:
Returns a tuple of the hardware type, the hardware index and the
hardware channel.
:raises can.interfaces.vector.VectorInitializationError:
If the application name does not exist in the Vector hardware configuration.
"""
if xldriver is None:
raise CanInterfaceNotImplementedError("The Vector API has not been loaded")
hw_type = ctypes.c_uint()
hw_index = ctypes.c_uint()
hw_channel = ctypes.c_uint()
_app_channel = ctypes.c_uint(app_channel)
try:
xldriver.xlGetApplConfig(
app_name.encode(),
_app_channel,
hw_type,
hw_index,
hw_channel,
xldefine.XL_BusTypes.XL_BUS_TYPE_CAN,
)
except VectorError as e:
raise VectorInitializationError(
error_code=e.error_code,
error_string=(
f"Vector HW Config: Channel '{app_channel}' of "
f"application '{app_name}' is not assigned to any interface"
),
function="xlGetApplConfig",
) from None
return _hw_type(hw_type.value), hw_index.value, hw_channel.value
@staticmethod
def set_application_config(
app_name: str,
app_channel: int,
hw_type: Union[int, xldefine.XL_HardwareType],
hw_index: int,
hw_channel: int,
**kwargs: Any,
) -> None:
"""Modify the application settings in Vector Hardware Configuration.
This method can also be used with a channel config dictionary::
import can
from can.interfaces.vector import VectorBus
configs = can.detect_available_configs(interfaces=['vector'])
cfg = configs[0]
VectorBus.set_application_config(app_name="MyApplication", app_channel=0, **cfg)
:param app_name:
The name of the application. Creates a new application if it does
not exist yet.
:param app_channel:
The channel of the application.
:param hw_type: