Skip to content

Commit c96a8c8

Browse files
MattWoodheadzariiii9003
authored andcommitted
Update ixxat docs
1 parent 0af7543 commit c96a8c8

File tree

1 file changed

+21
-3
lines changed

1 file changed

+21
-3
lines changed

doc/interfaces/ixxat.rst

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -56,17 +56,35 @@ VCI documentation, section "Message filters" for more info.
5656

5757
List available devices
5858
----------------------
59-
In case you have connected multiple IXXAT devices, you have to select them by using their unique hardware id.
60-
To get a list of all connected IXXAT you can use the function ``get_ixxat_hwids()`` as demonstrated below:
59+
60+
In case you have connected multiple IXXAT devices, you have to select them by using their unique hardware id.
61+
The function :meth:`~can.detect_available_configs` can be used to generate a list of :class:`~can.BusABC` constructors
62+
(including the channel number and unique hardware ID number for the connected devices).
6163

6264
.. testsetup:: ixxat
6365

66+
from unittest.mock import Mock
67+
can.detect_available_configs = Mock(side_effect=lambda: [{'interface': 'ixxat', 'channel': 0, 'unique_hardware_id': 'HW441489'}, {'interface': 'ixxat', 'channel': 0, 'unique_hardware_id': 'HW107422'}, {'interface': 'ixxat', 'channel': 1, 'unique_hardware_id': 'HW107422'}])
68+
69+
.. doctest:: ixxat
70+
71+
>>> import can
72+
>>> print(can.detect_available_configs("ixxat"))
73+
[{'interface': 'ixxat', 'channel': 0, 'unique_hardware_id': 'HW509182'},
74+
{'interface': 'ixxat', 'channel': 0, 'unique_hardware_id': 'HW107422'},
75+
{'interface': 'ixxat', 'channel': 1, 'unique_hardware_id': 'HW107422'}]
76+
77+
78+
You may also get a list of all connected IXXAT devices using the function ``get_ixxat_hwids()`` as demonstrated below:
79+
80+
.. testsetup:: ixxat2
81+
6482
from unittest.mock import Mock
6583
import can.interfaces.ixxat
6684
assert hasattr(can.interfaces.ixxat, "get_ixxat_hwids")
6785
can.interfaces.ixxat.get_ixxat_hwids = Mock(side_effect=lambda: ['HW441489', 'HW107422'])
6886

69-
.. doctest:: ixxat
87+
.. doctest:: ixxat2
7088

7189
>>> from can.interfaces.ixxat import get_ixxat_hwids
7290
>>> for hwid in get_ixxat_hwids():

0 commit comments

Comments
 (0)