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
|
#!/usr/bin/env python
"""
"""
import ctypes
import time
import unittest
from unittest.mock import Mock
import pytest
import can
from can.interfaces.kvaser import canlib, constants
class KvaserTest(unittest.TestCase):
def setUp(self):
canlib.canGetNumberOfChannels = KvaserTest.canGetNumberOfChannels
canlib.canOpenChannel = Mock(return_value=0)
canlib.canIoCtl = Mock(return_value=0)
canlib.canIoCtlInit = Mock(return_value=0)
canlib.kvReadTimer = Mock()
canlib.canSetBusParamsC200 = Mock()
canlib.canSetBusParams = Mock()
canlib.canSetBusParamsFd = Mock()
canlib.canBusOn = Mock()
canlib.canBusOff = Mock()
canlib.canClose = Mock()
canlib.canSetBusOutputControl = Mock()
canlib.canGetChannelData = Mock()
canlib.canSetAcceptanceFilter = Mock()
canlib.canWriteSync = Mock()
canlib.canWrite = self.canWrite
canlib.canReadWait = self.canReadWait
canlib.canGetBusStatistics = Mock()
canlib.canRequestBusStatistics = Mock()
self.msg = {}
self.msg_in_cue = None
self.bus = can.Bus(channel=0, interface="kvaser")
def tearDown(self):
if self.bus:
self.bus.shutdown()
self.bus = None
def test_bus_creation(self):
self.assertIsInstance(self.bus, canlib.KvaserBus)
self.assertEqual(self.bus.protocol, can.CanProtocol.CAN_20)
self.assertTrue(canlib.canOpenChannel.called)
self.assertTrue(canlib.canBusOn.called)
def test_bus_creation_illegal_channel_name(self):
# Test if the bus constructor is able to deal with non-ASCII characters
def canGetChannelDataMock(
channel: ctypes.c_int,
param: ctypes.c_int,
buf: ctypes.c_void_p,
bufsize: ctypes.c_size_t,
):
if param == constants.canCHANNELDATA_DEVDESCR_ASCII:
buf_char_ptr = ctypes.cast(buf, ctypes.POINTER(ctypes.c_char))
for i, char in enumerate(b"hello\x7a\xcb"):
buf_char_ptr[i] = char
canlib.canGetChannelData = canGetChannelDataMock
bus = can.Bus(channel=0, interface="kvaser")
self.assertTrue(bus.channel_info.startswith("hello"))
bus.shutdown()
def test_bus_shutdown(self):
self.bus.shutdown()
self.assertTrue(canlib.canBusOff.called)
self.assertTrue(canlib.canClose.called)
def test_filter_setup(self):
# No filter in constructor
expected_args = [
((0, 0, 0, 0),), # Disable filtering STD on read handle
((0, 0, 0, 1),), # Disable filtering EXT on read handle
((0, 0, 0, 0),), # Disable filtering STD on write handle
((0, 0, 0, 1),), # Disable filtering EXT on write handle
]
self.assertEqual(canlib.canSetAcceptanceFilter.call_args_list, expected_args)
# One filter, will be handled by canlib
canlib.canSetAcceptanceFilter.reset_mock()
self.bus.set_filters([{"can_id": 0x8, "can_mask": 0xFF, "extended": True}])
expected_args = [
((0, 0x8, 0xFF, 1),), # Enable filtering EXT on read handle
((0, 0x8, 0xFF, 1),), # Enable filtering EXT on write handle
]
self.assertEqual(canlib.canSetAcceptanceFilter.call_args_list, expected_args)
# Multiple filters, will be handled in Python
canlib.canSetAcceptanceFilter.reset_mock()
multiple_filters = [
{"can_id": 0x8, "can_mask": 0xFF},
{"can_id": 0x9, "can_mask": 0xFF},
]
self.bus.set_filters(multiple_filters)
expected_args = [
((0, 0, 0, 0),), # Disable filtering STD on read handle
((0, 0, 0, 1),), # Disable filtering EXT on read handle
((0, 0, 0, 0),), # Disable filtering STD on write handle
((0, 0, 0, 1),), # Disable filtering EXT on write handle
]
self.assertEqual(canlib.canSetAcceptanceFilter.call_args_list, expected_args)
def test_send_extended(self):
msg = can.Message(
arbitration_id=0xC0FFEE, data=[0, 25, 0, 1, 3, 1, 4], is_extended_id=True
)
self.bus.send(msg)
self.assertEqual(self.msg["arb_id"], 0xC0FFEE)
self.assertEqual(self.msg["dlc"], 7)
self.assertEqual(self.msg["flags"], constants.canMSG_EXT)
self.assertSequenceEqual(self.msg["data"], [0, 25, 0, 1, 3, 1, 4])
def test_send_standard(self):
msg = can.Message(arbitration_id=0x321, data=[50, 51], is_extended_id=False)
self.bus.send(msg)
self.assertEqual(self.msg["arb_id"], 0x321)
self.assertEqual(self.msg["dlc"], 2)
self.assertEqual(self.msg["flags"], constants.canMSG_STD)
self.assertSequenceEqual(self.msg["data"], [50, 51])
@pytest.mark.timeout(3.0)
def test_recv_no_message(self):
self.assertEqual(self.bus.recv(timeout=0.5), None)
def test_recv_extended(self):
self.msg_in_cue = can.Message(
arbitration_id=0xC0FFEF, data=[1, 2, 3, 4, 5, 6, 7, 8], is_extended_id=True
)
now = time.time()
msg = self.bus.recv()
self.assertEqual(msg.arbitration_id, 0xC0FFEF)
self.assertEqual(msg.dlc, 8)
self.assertEqual(msg.is_extended_id, True)
self.assertSequenceEqual(msg.data, self.msg_in_cue.data)
self.assertTrue(now - 1 < msg.timestamp < now + 1)
def test_recv_standard(self):
self.msg_in_cue = can.Message(
arbitration_id=0x123, data=[100, 101], is_extended_id=False
)
msg = self.bus.recv()
self.assertEqual(msg.arbitration_id, 0x123)
self.assertEqual(msg.dlc, 2)
self.assertEqual(msg.is_extended_id, False)
self.assertSequenceEqual(msg.data, [100, 101])
def test_available_configs(self):
configs = canlib.KvaserBus._detect_available_configs()
expected = [
{
"interface": "kvaser",
"channel": 0,
"dongle_channel": 1,
"device_name": "",
"serial": 0,
},
{
"interface": "kvaser",
"channel": 1,
"dongle_channel": 1,
"device_name": "",
"serial": 0,
},
]
self.assertListEqual(configs, expected)
def test_canfd_default_data_bitrate(self):
canlib.canSetBusParams.reset_mock()
canlib.canSetBusParamsFd.reset_mock()
bus = can.Bus(channel=0, interface="kvaser", fd=True)
self.assertEqual(bus.protocol, can.CanProtocol.CAN_FD)
canlib.canSetBusParams.assert_called_once_with(
0, constants.canFD_BITRATE_500K_80P, 0, 0, 0, 0, 0
)
canlib.canSetBusParamsFd.assert_called_once_with(
0, constants.canFD_BITRATE_500K_80P, 0, 0, 0
)
def test_can_timing(self):
canlib.canSetBusParams.reset_mock()
canlib.canSetBusParamsFd.reset_mock()
timing = can.BitTiming.from_bitrate_and_segments(
f_clock=16_000_000,
bitrate=125_000,
tseg1=13,
tseg2=2,
sjw=1,
)
can.Bus(channel=0, interface="kvaser", timing=timing)
canlib.canSetBusParamsC200.assert_called_once_with(0, timing.btr0, timing.btr1)
def test_canfd_timing(self):
canlib.canSetBusParams.reset_mock()
canlib.canSetBusParamsFd.reset_mock()
canlib.canOpenChannel.reset_mock()
timing = can.BitTimingFd.from_bitrate_and_segments(
f_clock=80_000_000,
nom_bitrate=500_000,
nom_tseg1=68,
nom_tseg2=11,
nom_sjw=10,
data_bitrate=2_000_000,
data_tseg1=10,
data_tseg2=9,
data_sjw=8,
)
can.Bus(channel=0, interface="kvaser", timing=timing)
canlib.canSetBusParams.assert_called_once_with(0, 500_000, 68, 11, 10, 1, 0)
canlib.canSetBusParamsFd.assert_called_once_with(0, 2_000_000, 10, 9, 8)
canlib.canOpenChannel.assert_called_with(
0, constants.canOPEN_CAN_FD | constants.canOPEN_ACCEPT_VIRTUAL
)
def test_canfd_non_iso(self):
canlib.canSetBusParams.reset_mock()
canlib.canSetBusParamsFd.reset_mock()
canlib.canOpenChannel.reset_mock()
timing = can.BitTimingFd.from_bitrate_and_segments(
f_clock=80_000_000,
nom_bitrate=500_000,
nom_tseg1=68,
nom_tseg2=11,
nom_sjw=10,
data_bitrate=2_000_000,
data_tseg1=10,
data_tseg2=9,
data_sjw=8,
)
bus = can.Bus(channel=0, interface="kvaser", timing=timing, fd_non_iso=True)
self.assertEqual(bus.protocol, can.CanProtocol.CAN_FD_NON_ISO)
canlib.canSetBusParams.assert_called_once_with(0, 500_000, 68, 11, 10, 1, 0)
canlib.canSetBusParamsFd.assert_called_once_with(0, 2_000_000, 10, 9, 8)
canlib.canOpenChannel.assert_called_with(
0, constants.canOPEN_CAN_FD_NONISO | constants.canOPEN_ACCEPT_VIRTUAL
)
def test_canfd_nondefault_data_bitrate(self):
canlib.canSetBusParams.reset_mock()
canlib.canSetBusParamsFd.reset_mock()
data_bitrate = 2000000
bus = can.Bus(channel=0, interface="kvaser", fd=True, data_bitrate=data_bitrate)
self.assertEqual(bus.protocol, can.CanProtocol.CAN_FD)
bitrate_constant = canlib.BITRATE_FD[data_bitrate]
canlib.canSetBusParams.assert_called_once_with(
0, constants.canFD_BITRATE_500K_80P, 0, 0, 0, 0, 0
)
canlib.canSetBusParamsFd.assert_called_once_with(0, bitrate_constant, 0, 0, 0)
def test_canfd_custom_data_bitrate(self):
canlib.canSetBusParams.reset_mock()
canlib.canSetBusParamsFd.reset_mock()
data_bitrate = 123456
can.Bus(channel=0, interface="kvaser", fd=True, data_bitrate=data_bitrate)
canlib.canSetBusParams.assert_called_once_with(
0, constants.canFD_BITRATE_500K_80P, 0, 0, 0, 0, 0
)
canlib.canSetBusParamsFd.assert_called_once_with(0, data_bitrate, 0, 0, 0)
def test_bus_get_stats(self):
stats = self.bus.get_stats()
self.assertTrue(canlib.canRequestBusStatistics.called)
self.assertTrue(canlib.canGetBusStatistics.called)
self.assertIsInstance(stats, canlib.structures.BusStatistics)
@staticmethod
def canGetNumberOfChannels(count):
count._obj.value = 2
def canWrite(self, handle, arb_id, buf, dlc, flags):
self.msg["arb_id"] = arb_id
self.msg["dlc"] = dlc
self.msg["flags"] = flags
self.msg["data"] = bytearray(buf._obj)
def canReadWait(self, handle, arb_id, data, dlc, flags, timestamp, timeout):
if not self.msg_in_cue:
return constants.canERR_NOMSG
arb_id._obj.value = self.msg_in_cue.arbitration_id
dlc._obj.value = self.msg_in_cue.dlc
data._obj.raw = self.msg_in_cue.data
flags_temp = 0
if self.msg_in_cue.is_extended_id:
flags_temp |= constants.canMSG_EXT
else:
flags_temp |= constants.canMSG_STD
if self.msg_in_cue.is_remote_frame:
flags_temp |= constants.canMSG_RTR
if self.msg_in_cue.is_error_frame:
flags_temp |= constants.canMSG_ERROR_FRAME
flags._obj.value = flags_temp
timestamp._obj.value = 0
return constants.canOK
if __name__ == "__main__":
unittest.main()
|