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
|
#!/usr/bin/env python
"""
This module tests multiple message cyclic send tasks.
"""
import time
import unittest
import can
from .config import TEST_INTERFACE_SOCKETCAN
@unittest.skipUnless(TEST_INTERFACE_SOCKETCAN, "skip testing of socketcan")
class CyclicSocketCan(unittest.TestCase):
BITRATE = 500000
TIMEOUT = 0.1
INTERFACE_1 = "socketcan"
CHANNEL_1 = "vcan0"
INTERFACE_2 = "socketcan"
CHANNEL_2 = "vcan0"
PERIOD = 1.0
DELTA = 0.01
def _find_start_index(self, tx_messages, message):
"""
:param tx_messages:
The list of messages that were passed to the periodic backend
:param message:
The message whose data we wish to match and align to
:returns: start index in the tx_messages
"""
start_index = -1
for index, tx_message in enumerate(tx_messages):
if tx_message.data == message.data:
start_index = index
break
return start_index
def setUp(self):
self._send_bus = can.Bus(
interface=self.INTERFACE_1, channel=self.CHANNEL_1, bitrate=self.BITRATE
)
self._recv_bus = can.Bus(
interface=self.INTERFACE_2, channel=self.CHANNEL_2, bitrate=self.BITRATE
)
def tearDown(self):
self._send_bus.shutdown()
self._recv_bus.shutdown()
def test_cyclic_initializer_list(self):
messages = []
messages.append(
can.Message(
arbitration_id=0x401,
data=[0x11, 0x11, 0x11, 0x11, 0x11, 0x11],
is_extended_id=False,
)
)
messages.append(
can.Message(
arbitration_id=0x401,
data=[0x22, 0x22, 0x22, 0x22, 0x22, 0x22],
is_extended_id=False,
)
)
messages.append(
can.Message(
arbitration_id=0x401,
data=[0x33, 0x33, 0x33, 0x33, 0x33, 0x33],
is_extended_id=False,
)
)
messages.append(
can.Message(
arbitration_id=0x401,
data=[0x44, 0x44, 0x44, 0x44, 0x44, 0x44],
is_extended_id=False,
)
)
messages.append(
can.Message(
arbitration_id=0x401,
data=[0x55, 0x55, 0x55, 0x55, 0x55, 0x55],
is_extended_id=False,
)
)
task = self._send_bus.send_periodic(messages, self.PERIOD)
self.assertIsInstance(task, can.broadcastmanager.CyclicSendTaskABC)
results = []
for _ in range(len(messages) * 2):
result = self._recv_bus.recv(self.PERIOD * 2)
if result:
results.append(result)
task.stop()
# Find starting index for each
start_index = self._find_start_index(messages, results[0])
self.assertTrue(start_index != -1)
# Now go through the partitioned results and assert that they're equal
for rx_index, rx_message in enumerate(results):
tx_message = messages[start_index]
self.assertIsNotNone(rx_message)
self.assertEqual(tx_message.arbitration_id, rx_message.arbitration_id)
self.assertEqual(tx_message.dlc, rx_message.dlc)
self.assertEqual(tx_message.data, rx_message.data)
self.assertEqual(tx_message.is_extended_id, rx_message.is_extended_id)
self.assertEqual(tx_message.is_remote_frame, rx_message.is_remote_frame)
self.assertEqual(tx_message.is_error_frame, rx_message.is_error_frame)
self.assertEqual(tx_message.is_fd, rx_message.is_fd)
start_index = (start_index + 1) % len(messages)
def test_cyclic_initializer_tuple(self):
messages = []
messages.append(
can.Message(
arbitration_id=0x401,
data=[0x11, 0x11, 0x11, 0x11, 0x11, 0x11],
is_extended_id=False,
)
)
messages.append(
can.Message(
arbitration_id=0x401,
data=[0x22, 0x22, 0x22, 0x22, 0x22, 0x22],
is_extended_id=False,
)
)
messages.append(
can.Message(
arbitration_id=0x401,
data=[0x33, 0x33, 0x33, 0x33, 0x33, 0x33],
is_extended_id=False,
)
)
messages.append(
can.Message(
arbitration_id=0x401,
data=[0x44, 0x44, 0x44, 0x44, 0x44, 0x44],
is_extended_id=False,
)
)
messages.append(
can.Message(
arbitration_id=0x401,
data=[0x55, 0x55, 0x55, 0x55, 0x55, 0x55],
is_extended_id=False,
)
)
messages = tuple(messages)
self.assertIsInstance(messages, tuple)
task = self._send_bus.send_periodic(messages, self.PERIOD)
self.assertIsInstance(task, can.broadcastmanager.CyclicSendTaskABC)
results = []
for _ in range(len(messages) * 2):
result = self._recv_bus.recv(self.PERIOD * 2)
if result:
results.append(result)
task.stop()
# Find starting index for each
start_index = self._find_start_index(messages, results[0])
self.assertTrue(start_index != -1)
# Now go through the partitioned results and assert that they're equal
for rx_index, rx_message in enumerate(results):
tx_message = messages[start_index]
self.assertIsNotNone(rx_message)
self.assertEqual(tx_message.arbitration_id, rx_message.arbitration_id)
self.assertEqual(tx_message.dlc, rx_message.dlc)
self.assertEqual(tx_message.data, rx_message.data)
self.assertEqual(tx_message.is_extended_id, rx_message.is_extended_id)
self.assertEqual(tx_message.is_remote_frame, rx_message.is_remote_frame)
self.assertEqual(tx_message.is_error_frame, rx_message.is_error_frame)
self.assertEqual(tx_message.is_fd, rx_message.is_fd)
start_index = (start_index + 1) % len(messages)
def test_cyclic_initializer_message(self):
message = can.Message(
arbitration_id=0x401,
data=[0x11, 0x11, 0x11, 0x11, 0x11, 0x11],
is_extended_id=False,
)
task = self._send_bus.send_periodic(message, self.PERIOD)
self.assertIsInstance(task, can.broadcastmanager.CyclicSendTaskABC)
# Take advantage of kernel's queueing mechanisms
time.sleep(4 * self.PERIOD)
task.stop()
for _ in range(4):
tx_message = message
rx_message = self._recv_bus.recv(self.TIMEOUT)
self.assertIsNotNone(rx_message)
self.assertEqual(tx_message.arbitration_id, rx_message.arbitration_id)
self.assertEqual(tx_message.dlc, rx_message.dlc)
self.assertEqual(tx_message.data, rx_message.data)
self.assertEqual(tx_message.is_extended_id, rx_message.is_extended_id)
self.assertEqual(tx_message.is_remote_frame, rx_message.is_remote_frame)
self.assertEqual(tx_message.is_error_frame, rx_message.is_error_frame)
self.assertEqual(tx_message.is_fd, rx_message.is_fd)
def test_cyclic_initializer_invalid_none(self):
with self.assertRaises(ValueError):
task = self._send_bus.send_periodic(None, self.PERIOD)
def test_cyclic_initializer_invalid_empty_list(self):
with self.assertRaises(ValueError):
task = self._send_bus.send_periodic([], self.PERIOD)
def test_cyclic_initializer_different_arbitration_ids(self):
messages = []
messages.append(
can.Message(
arbitration_id=0x401,
data=[0x11, 0x11, 0x11, 0x11, 0x11, 0x11],
is_extended_id=False,
)
)
messages.append(
can.Message(
arbitration_id=0x3E1,
data=[0xEE, 0xEE, 0xEE, 0xEE, 0xEE, 0xEE],
is_extended_id=False,
)
)
with self.assertRaises(ValueError):
task = self._send_bus.send_periodic(messages, self.PERIOD)
def test_start_already_started_task(self):
messages_a = can.Message(
arbitration_id=0x401,
data=[0x11, 0x11, 0x11, 0x11, 0x11, 0x11],
is_extended_id=False,
)
task_a = self._send_bus.send_periodic(messages_a, self.PERIOD)
time.sleep(0.1)
# Task restarting is permitted as of #1440
task_a.start()
task_a.stop()
def test_create_same_id(self):
messages_a = can.Message(
arbitration_id=0x401,
data=[0x11, 0x11, 0x11, 0x11, 0x11, 0x11],
is_extended_id=False,
)
messages_b = can.Message(
arbitration_id=0x401,
data=[0x22, 0x22, 0x22, 0x22, 0x22, 0x22],
is_extended_id=False,
)
task_a = self._send_bus.send_periodic(messages_a, self.PERIOD)
self.assertIsInstance(task_a, can.broadcastmanager.CyclicSendTaskABC)
task_b = self._send_bus.send_periodic(messages_b, self.PERIOD)
self.assertIsInstance(task_b, can.broadcastmanager.CyclicSendTaskABC)
time.sleep(self.PERIOD * 4)
task_a.stop()
task_b.stop()
msgs = []
for _ in range(4):
msg = self._recv_bus.recv(self.PERIOD * 2)
self.assertIsNotNone(msg)
msgs.append(msg)
self.assertTrue(len(msgs) >= 4)
# Both messages should be recevied on the bus,
# even with the same arbitration id
msg_a_data_present = msg_b_data_present = False
for rx_message in msgs:
self.assertTrue(
rx_message.arbitration_id
== messages_a.arbitration_id
== messages_b.arbitration_id
)
if rx_message.data == messages_a.data:
msg_a_data_present = True
if rx_message.data == messages_b.data:
msg_b_data_present = True
self.assertTrue(msg_a_data_present)
self.assertTrue(msg_b_data_present)
def test_modify_data_list(self):
messages_odd = []
messages_odd.append(
can.Message(
arbitration_id=0x401,
data=[0x11, 0x11, 0x11, 0x11, 0x11, 0x11],
is_extended_id=False,
)
)
messages_odd.append(
can.Message(
arbitration_id=0x401,
data=[0x33, 0x33, 0x33, 0x33, 0x33, 0x33],
is_extended_id=False,
)
)
messages_odd.append(
can.Message(
arbitration_id=0x401,
data=[0x55, 0x55, 0x55, 0x55, 0x55, 0x55],
is_extended_id=False,
)
)
messages_even = []
messages_even.append(
can.Message(
arbitration_id=0x401,
data=[0x22, 0x22, 0x22, 0x22, 0x22, 0x22],
is_extended_id=False,
)
)
messages_even.append(
can.Message(
arbitration_id=0x401,
data=[0x44, 0x44, 0x44, 0x44, 0x44, 0x44],
is_extended_id=False,
)
)
messages_even.append(
can.Message(
arbitration_id=0x401,
data=[0x66, 0x66, 0x66, 0x66, 0x66, 0x66],
is_extended_id=False,
)
)
task = self._send_bus.send_periodic(messages_odd, self.PERIOD)
self.assertIsInstance(task, can.broadcastmanager.ModifiableCyclicTaskABC)
results_odd = []
results_even = []
for _ in range(len(messages_odd) * 2):
result = self._recv_bus.recv(self.PERIOD * 2)
if result:
results_odd.append(result)
task.modify_data(messages_even)
for _ in range(len(messages_even) * 2):
result = self._recv_bus.recv(self.PERIOD * 2)
if result:
results_even.append(result)
task.stop()
# Make sure we received some messages
self.assertTrue(len(results_even) != 0)
self.assertTrue(len(results_odd) != 0)
# Find starting index for each
start_index_even = self._find_start_index(messages_even, results_even[0])
self.assertTrue(start_index_even != -1)
start_index_odd = self._find_start_index(messages_odd, results_odd[0])
self.assertTrue(start_index_odd != -1)
# Now go through the partitioned results and assert that they're equal
for rx_index, rx_message in enumerate(results_even):
tx_message = messages_even[start_index_even]
self.assertEqual(tx_message.arbitration_id, rx_message.arbitration_id)
self.assertEqual(tx_message.dlc, rx_message.dlc)
self.assertEqual(tx_message.data, rx_message.data)
self.assertEqual(tx_message.is_extended_id, rx_message.is_extended_id)
self.assertEqual(tx_message.is_remote_frame, rx_message.is_remote_frame)
self.assertEqual(tx_message.is_error_frame, rx_message.is_error_frame)
self.assertEqual(tx_message.is_fd, rx_message.is_fd)
start_index_even = (start_index_even + 1) % len(messages_even)
if rx_index != 0:
prev_rx_message = results_even[rx_index - 1]
# Assert timestamps are within the expected period
self.assertTrue(
abs(
(rx_message.timestamp - prev_rx_message.timestamp) - self.PERIOD
)
<= self.DELTA
)
for rx_index, rx_message in enumerate(results_odd):
tx_message = messages_odd[start_index_odd]
self.assertEqual(tx_message.arbitration_id, rx_message.arbitration_id)
self.assertEqual(tx_message.dlc, rx_message.dlc)
self.assertEqual(tx_message.data, rx_message.data)
self.assertEqual(tx_message.is_extended_id, rx_message.is_extended_id)
self.assertEqual(tx_message.is_remote_frame, rx_message.is_remote_frame)
self.assertEqual(tx_message.is_error_frame, rx_message.is_error_frame)
self.assertEqual(tx_message.is_fd, rx_message.is_fd)
start_index_odd = (start_index_odd + 1) % len(messages_odd)
if rx_index != 0:
prev_rx_message = results_odd[rx_index - 1]
# Assert timestamps are within the expected period
self.assertTrue(
abs(
(rx_message.timestamp - prev_rx_message.timestamp) - self.PERIOD
)
<= self.DELTA
)
def test_modify_data_message(self):
message_odd = can.Message(
arbitration_id=0x401,
data=[0x11, 0x11, 0x11, 0x11, 0x11, 0x11],
is_extended_id=False,
)
message_even = can.Message(
arbitration_id=0x401,
data=[0x22, 0x22, 0x22, 0x22, 0x22, 0x22],
is_extended_id=False,
)
task = self._send_bus.send_periodic(message_odd, self.PERIOD)
self.assertIsInstance(task, can.broadcastmanager.ModifiableCyclicTaskABC)
results_odd = []
results_even = []
for _ in range(1 * 4):
result = self._recv_bus.recv(self.PERIOD * 2)
if result:
results_odd.append(result)
task.modify_data(message_even)
for _ in range(1 * 4):
result = self._recv_bus.recv(self.PERIOD * 2)
if result:
results_even.append(result)
task.stop()
# Now go through the partitioned results and assert that they're equal
for rx_index, rx_message in enumerate(results_even):
tx_message = message_even
self.assertEqual(tx_message.arbitration_id, rx_message.arbitration_id)
self.assertEqual(tx_message.dlc, rx_message.dlc)
self.assertEqual(tx_message.data, rx_message.data)
self.assertEqual(tx_message.is_extended_id, rx_message.is_extended_id)
self.assertEqual(tx_message.is_remote_frame, rx_message.is_remote_frame)
self.assertEqual(tx_message.is_error_frame, rx_message.is_error_frame)
self.assertEqual(tx_message.is_fd, rx_message.is_fd)
if rx_index != 0:
prev_rx_message = results_even[rx_index - 1]
# Assert timestamps are within the expected period
self.assertTrue(
abs(
(rx_message.timestamp - prev_rx_message.timestamp) - self.PERIOD
)
<= self.DELTA
)
for rx_index, rx_message in enumerate(results_odd):
tx_message = message_odd
self.assertEqual(tx_message.arbitration_id, rx_message.arbitration_id)
self.assertEqual(tx_message.dlc, rx_message.dlc)
self.assertEqual(tx_message.data, rx_message.data)
self.assertEqual(tx_message.is_extended_id, rx_message.is_extended_id)
self.assertEqual(tx_message.is_remote_frame, rx_message.is_remote_frame)
self.assertEqual(tx_message.is_error_frame, rx_message.is_error_frame)
self.assertEqual(tx_message.is_fd, rx_message.is_fd)
if rx_index != 0:
prev_rx_message = results_odd[rx_index - 1]
# Assert timestamps are within the expected period
self.assertTrue(
abs(
(rx_message.timestamp - prev_rx_message.timestamp) - self.PERIOD
)
<= self.DELTA
)
def test_modify_data_invalid(self):
message = can.Message(
arbitration_id=0x401,
data=[0x11, 0x11, 0x11, 0x11, 0x11, 0x11],
is_extended_id=False,
)
task = self._send_bus.send_periodic(message, self.PERIOD)
self.assertIsInstance(task, can.broadcastmanager.ModifiableCyclicTaskABC)
time.sleep(2 * self.PERIOD)
with self.assertRaises(ValueError):
task.modify_data(None)
def test_modify_data_unequal_lengths(self):
message = can.Message(
arbitration_id=0x401,
data=[0x11, 0x11, 0x11, 0x11, 0x11, 0x11],
is_extended_id=False,
)
new_messages = []
new_messages.append(
can.Message(
arbitration_id=0x401,
data=[0x11, 0x11, 0x11, 0x11, 0x11, 0x11],
is_extended_id=False,
)
)
new_messages.append(
can.Message(
arbitration_id=0x401,
data=[0x22, 0x22, 0x22, 0x22, 0x22, 0x22],
is_extended_id=False,
)
)
task = self._send_bus.send_periodic(message, self.PERIOD)
self.assertIsInstance(task, can.broadcastmanager.ModifiableCyclicTaskABC)
time.sleep(2 * self.PERIOD)
with self.assertRaises(ValueError):
task.modify_data(new_messages)
def test_modify_data_different_arbitration_id_than_original(self):
old_message = can.Message(
arbitration_id=0x401,
data=[0x11, 0x11, 0x11, 0x11, 0x11, 0x11],
is_extended_id=False,
)
new_message = can.Message(
arbitration_id=0x3E1,
data=[0xEE, 0xEE, 0xEE, 0xEE, 0xEE, 0xEE],
is_extended_id=False,
)
task = self._send_bus.send_periodic(old_message, self.PERIOD)
self.assertIsInstance(task, can.broadcastmanager.ModifiableCyclicTaskABC)
time.sleep(2 * self.PERIOD)
with self.assertRaises(ValueError):
task.modify_data(new_message)
def test_stop_all_periodic_tasks_and_remove_task(self):
message_a = can.Message(
arbitration_id=0x401,
data=[0x11, 0x11, 0x11, 0x11, 0x11, 0x11],
is_extended_id=False,
)
message_b = can.Message(
arbitration_id=0x402,
data=[0x22, 0x22, 0x22, 0x22, 0x22, 0x22],
is_extended_id=False,
)
message_c = can.Message(
arbitration_id=0x403,
data=[0x33, 0x33, 0x33, 0x33, 0x33, 0x33],
is_extended_id=False,
)
# Start Tasks
task_a = self._send_bus.send_periodic(message_a, self.PERIOD)
task_b = self._send_bus.send_periodic(message_b, self.PERIOD)
task_c = self._send_bus.send_periodic(message_c, self.PERIOD)
self.assertIsInstance(task_a, can.broadcastmanager.ModifiableCyclicTaskABC)
self.assertIsInstance(task_b, can.broadcastmanager.ModifiableCyclicTaskABC)
self.assertIsInstance(task_c, can.broadcastmanager.ModifiableCyclicTaskABC)
for _ in range(6):
_ = self._recv_bus.recv(self.PERIOD)
# Stop all tasks and delete
self._send_bus.stop_all_periodic_tasks(remove_tasks=True)
# Now wait for a few periods, after which we should definitely not
# receive any CAN messages
time.sleep(4 * self.PERIOD)
# If we successfully deleted everything, then we will eventually read
# 0 messages.
successfully_stopped = False
for _ in range(6):
rx_message = self._recv_bus.recv(self.PERIOD)
if rx_message is None:
successfully_stopped = True
break
self.assertTrue(successfully_stopped, "Still received messages after stopping")
# None of the tasks should still be associated with the bus
self.assertEqual(0, len(self._send_bus._periodic_tasks))
if __name__ == "__main__":
unittest.main()
|
