forked from hardbyte/python-can
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathnixnet.py
More file actions
340 lines (289 loc) · 12.4 KB
/
Copy pathnixnet.py
File metadata and controls
340 lines (289 loc) · 12.4 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
"""
NI-XNET interface module.
Implementation references:
NI-XNET Hardware and Software Manual: https://www.ni.com/pdf/manuals/372840h.pdf
NI-XNET Python implementation: https://github.com/ni/nixnet-python
Authors: Javier Rubio Giménez <jvrr20@gmail.com>, Jose A. Escobar <joseleescobar@hotmail.com>
"""
import logging
import os
import time
from queue import SimpleQueue
from types import ModuleType
from typing import Optional, List, Union, Tuple, Any
import can.typechecking
from can import BusABC, Message, BitTiming, BitTimingFd
from can.exceptions import (
CanInitializationError,
CanOperationError,
CanInterfaceNotImplementedError,
)
from can.util import check_or_adjust_timing_clock, deprecated_args_alias
logger = logging.getLogger(__name__)
nixnet: Optional[ModuleType] = None
try:
import nixnet # type: ignore
import nixnet.constants # type: ignore
import nixnet.system # type: ignore
import nixnet.types # type: ignore
except Exception as exc:
logger.warning("Could not import nixnet: %s", exc)
class NiXNETcanBus(BusABC):
"""
The CAN Bus implemented for the NI-XNET interface.
"""
@deprecated_args_alias(
deprecation_start="4.2.0",
deprecation_end="5.0.0",
brs=None,
log_errors=None,
)
def __init__(
self,
channel: str = "CAN1",
bitrate: int = 500_000,
timing: Optional[Union[BitTiming, BitTimingFd]] = None,
can_filters: Optional[can.typechecking.CanFilters] = None,
receive_own_messages: bool = False,
can_termination: bool = False,
fd: bool = False,
fd_bitrate: Optional[int] = None,
poll_interval: float = 0.001,
**kwargs: Any,
) -> None:
"""
:param str channel:
Name of the object to open (e.g. 'CAN0')
:param int bitrate:
Bitrate in bits/s
:param timing:
Optional :class:`~can.BitTiming` or :class:`~can.BitTimingFd` instance
to use for custom bit timing setting. The `f_clock` value of the timing
instance must be set to 40_000_000 (40MHz).
If this parameter is provided, it takes precedence over all other
timing-related parameters like `bitrate`, `fd_bitrate` and `fd`.
:param list can_filters:
See :meth:`can.BusABC.set_filters`.
:param receive_own_messages:
Enable self-reception of sent messages.
:param poll_interval:
Poll interval in seconds.
:raises ~can.exceptions.CanInitializationError:
If starting communication fails
"""
if os.name != "nt" and not kwargs.get("_testing", False):
raise CanInterfaceNotImplementedError(
f"The NI-XNET interface is only supported on Windows, "
f'but you are running "{os.name}"'
)
if nixnet is None:
raise CanInterfaceNotImplementedError("The NI-XNET API has not been loaded")
self.nixnet = nixnet
self._rx_queue = SimpleQueue() # type: ignore[var-annotated]
self.channel = channel
self.channel_info = "NI-XNET: " + channel
self.poll_interval = poll_interval
self.fd = isinstance(timing, BitTimingFd) if timing else fd
# Set database for the initialization
database_name = ":can_fd_brs:" if self.fd else ":memory:"
try:
# We need two sessions for this application,
# one to send frames and another to receive them
self._session_send = nixnet.session.FrameOutStreamSession(
channel, database_name=database_name
)
self._session_receive = nixnet.session.FrameInStreamSession(
channel, database_name=database_name
)
self._interface = self._session_send.intf
# set interface properties
self._interface.can_lstn_only = kwargs.get("listen_only", False)
self._interface.echo_tx = receive_own_messages
self._interface.bus_err_to_in_strm = True
if isinstance(timing, BitTimingFd):
timing = check_or_adjust_timing_clock(timing, [40_000_000])
custom_nom_baud_rate = ( # nxPropSession_IntfBaudRate64
0xA0000000
+ (timing.nom_tq << 32)
+ (timing.nom_sjw - 1 << 16)
+ (timing.nom_tseg1 - 1 << 8)
+ (timing.nom_tseg2 - 1)
)
custom_data_baud_rate = ( # nxPropSession_IntfCanFdBaudRate64
0xA0000000
+ (timing.data_tq << 13)
+ (timing.data_tseg1 - 1 << 8)
+ (timing.data_tseg2 - 1 << 4)
+ (timing.data_sjw - 1)
)
self._interface.baud_rate = custom_nom_baud_rate
self._interface.can_fd_baud_rate = custom_data_baud_rate
elif isinstance(timing, BitTiming):
timing = check_or_adjust_timing_clock(timing, [40_000_000])
custom_baud_rate = ( # nxPropSession_IntfBaudRate64
0xA0000000
+ (timing.tq << 32)
+ (timing.sjw - 1 << 16)
+ (timing.tseg1 - 1 << 8)
+ (timing.tseg2 - 1)
)
self._interface.baud_rate = custom_baud_rate
else:
# See page 1017 of NI-XNET Hardware and Software Manual
# to set custom can configuration
if bitrate:
self._interface.baud_rate = bitrate
if self.fd:
# See page 951 of NI-XNET Hardware and Software Manual
# to set custom can configuration
self._interface.can_fd_baud_rate = fd_bitrate or bitrate
_can_termination = (
nixnet.constants.CanTerm.ON
if can_termination
else nixnet.constants.CanTerm.OFF
)
self._interface.can_term = _can_termination
# self._session_receive.queue_size = 512
# Once that all the parameters have been set, we start the sessions
self._session_send.start()
self._session_receive.start()
except nixnet.errors.XnetError as error:
raise CanInitializationError(
f"{error.args[0]} ({error.error_type})", error.error_code
) from None
self._is_filtered = False
super().__init__(
channel=channel,
can_filters=can_filters,
bitrate=bitrate,
**kwargs,
)
def _recv_internal(
self, timeout: Optional[float]
) -> Tuple[Optional[Message], bool]:
end_time = time.perf_counter() + timeout if timeout is not None else None
while True:
# try to read all available frames
for frame in self._session_receive.frames.read(1024, timeout=0):
self._rx_queue.put_nowait(frame)
if self._rx_queue.qsize():
break
# check for timeout
if end_time is not None and time.perf_counter() > end_time:
return None, False
# Wait a short time until we try to read again
time.sleep(self.poll_interval)
can_frame = self._rx_queue.get_nowait()
# Timestamp should be converted from raw frame format(100ns increment
# from(12:00 a.m. January 1 1601 Coordinated Universal Time (UTC))
# to epoch time(number of seconds from January 1, 1970 (midnight UTC/GMT))
timestamp = can_frame.timestamp * 1e-7 - 11_644_473_600
if can_frame.type is self.nixnet.constants.FrameType.CAN_BUS_ERROR:
msg = Message(
timestamp=timestamp,
channel=self.channel,
is_error_frame=True,
)
else:
msg = Message(
timestamp=timestamp,
channel=self.channel,
is_remote_frame=can_frame.type
is self.nixnet.constants.FrameType.CAN_REMOTE,
is_error_frame=False,
is_fd=(
can_frame.type is self.nixnet.constants.FrameType.CANFD_DATA
or can_frame.type is self.nixnet.constants.FrameType.CANFDBRS_DATA
),
bitrate_switch=(
can_frame.type is self.nixnet.constants.FrameType.CANFDBRS_DATA
),
is_extended_id=can_frame.identifier.extended,
# Get identifier from CanIdentifier structure
arbitration_id=can_frame.identifier.identifier,
dlc=len(can_frame.payload),
data=can_frame.payload,
is_rx=not can_frame.echo,
)
return msg, False
def send(self, msg: Message, timeout: Optional[float] = None) -> None:
"""
Send a message using NI-XNET.
:param can.Message msg:
Message to send
:param float timeout:
Max time to wait for the device to be ready in seconds, None if time is infinite
:raises can.exceptions.CanOperationError:
If writing to transmit buffer fails.
It does not wait for message to be ACKed currently.
"""
if timeout is None:
timeout = self.nixnet.constants.TIMEOUT_INFINITE
if msg.is_remote_frame:
type_message = self.nixnet.constants.FrameType.CAN_REMOTE
elif msg.is_error_frame:
type_message = self.nixnet.constants.FrameType.CAN_BUS_ERROR
elif msg.is_fd:
if msg.bitrate_switch:
type_message = self.nixnet.constants.FrameType.CANFDBRS_DATA
else:
type_message = self.nixnet.constants.FrameType.CANFD_DATA
else:
type_message = self.nixnet.constants.FrameType.CAN_DATA
can_frame = self.nixnet.types.CanFrame(
self.nixnet.types.CanIdentifier(msg.arbitration_id, msg.is_extended_id),
type=type_message,
payload=msg.data,
)
try:
self._session_send.frames.write([can_frame], timeout)
except self.nixnet.errors.XnetError as error:
raise CanOperationError(
f"{error.args[0]} ({error.error_type})", error.error_code
) from None
def reset(self) -> None:
"""
Resets network interface. Stops network interface, then resets the CAN
chip to clear the CAN error counters (clear error passive state).
Resetting includes clearing all entries from read and write queues.
"""
self._session_send.flush()
self._session_receive.flush()
self._session_send.stop()
self._session_receive.stop()
self._session_send.start()
self._session_receive.start()
def shutdown(self) -> None:
"""Close object."""
super().shutdown()
if hasattr(self, "_session_send"):
self._session_send.flush()
self._session_send.stop()
self._session_send.close()
if hasattr(self, "_session_receive"):
self._session_receive.flush()
self._session_receive.stop()
self._session_receive.close()
@staticmethod
def _detect_available_configs() -> List[can.typechecking.AutoDetectedConfig]:
configs = []
try:
with nixnet.system.System() as nixnet_system: # type: ignore[union-attr]
for interface in nixnet_system.intf_refs_can:
channel = str(interface)
logger.debug(
"Found channel index %d: %s", interface.port_num, channel
)
configs.append(
{
"interface": "nixnet",
"channel": channel,
"can_term_available": interface.can_term_cap
is nixnet.constants.CanTermCap.YES, # type: ignore[union-attr]
"supports_fd": interface.can_tcvr_cap
is nixnet.constants.CanTcvrCap.HS, # type: ignore[union-attr]
}
)
except Exception as error:
logger.debug("An error occured while searching for configs: %s", str(error))
return configs # type: ignore