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
|
"""
Reader and writer for can logging files in peak trc format
See https://www.peak-system.com/produktcd/Pdf/English/PEAK_CAN_TRC_File_Format.pdf
for file format description
Version 1.1 will be implemented as it is most commonly used
"""
import logging
import os
from datetime import datetime, timedelta, timezone
from enum import Enum
from typing import Any, Callable, Dict, Generator, Optional, TextIO, Tuple, Union
from ..message import Message
from ..typechecking import StringPathLike
from ..util import channel2int, len2dlc
from .generic import TextIOMessageReader, TextIOMessageWriter
logger = logging.getLogger("can.io.trc")
class TRCFileVersion(Enum):
UNKNOWN = 0
V1_0 = 100
V1_1 = 101
V1_2 = 102
V1_3 = 103
V2_0 = 200
V2_1 = 201
def __ge__(self, other):
if self.__class__ is other.__class__:
return self.value >= other.value
return NotImplemented
class TRCReader(TextIOMessageReader):
"""
Iterator of CAN messages from a TRC logging file.
"""
file: TextIO
def __init__(
self,
file: Union[StringPathLike, TextIO],
**kwargs: Any,
) -> None:
"""
:param file: a path-like object or as file-like object to read from
If this is a file-like object, is has to opened in text
read mode, not binary read mode.
"""
super().__init__(file, mode="r")
self.file_version = TRCFileVersion.UNKNOWN
self._start_time: float = 0
self.columns: Dict[str, int] = {}
self._num_columns = -1
if not self.file:
raise ValueError("The given file cannot be None")
self._parse_cols: Callable[[Tuple[str, ...]], Optional[Message]] = (
lambda x: None
)
@property
def start_time(self) -> Optional[datetime]:
if self._start_time:
return datetime.fromtimestamp(self._start_time, timezone.utc)
return None
def _extract_header(self):
line = ""
for _line in self.file:
line = _line.strip()
if line.startswith(";$FILEVERSION"):
logger.debug("TRCReader: Found file version '%s'", line)
try:
file_version = line.split("=")[1]
if file_version == "1.1":
self.file_version = TRCFileVersion.V1_1
elif file_version == "1.3":
self.file_version = TRCFileVersion.V1_3
elif file_version == "2.0":
self.file_version = TRCFileVersion.V2_0
elif file_version == "2.1":
self.file_version = TRCFileVersion.V2_1
else:
self.file_version = TRCFileVersion.UNKNOWN
except IndexError:
logger.debug("TRCReader: Failed to parse version")
elif line.startswith(";$STARTTIME"):
logger.debug("TRCReader: Found start time '%s'", line)
try:
self._start_time = (
datetime(1899, 12, 30, tzinfo=timezone.utc)
+ timedelta(days=float(line.split("=")[1]))
).timestamp()
except IndexError:
logger.debug("TRCReader: Failed to parse start time")
elif line.startswith(";$COLUMNS"):
logger.debug("TRCReader: Found columns '%s'", line)
try:
columns = line.split("=")[1].split(",")
self.columns = {column: columns.index(column) for column in columns}
self._num_columns = len(columns) - 1
except IndexError:
logger.debug("TRCReader: Failed to parse columns")
elif line.startswith(";"):
continue
else:
break
if self.file_version >= TRCFileVersion.V1_1:
if self._start_time is None:
raise ValueError("File has no start time information")
if self.file_version >= TRCFileVersion.V2_0:
if not self.columns:
raise ValueError("File has no column information")
if self.file_version == TRCFileVersion.UNKNOWN:
logger.info(
"TRCReader: No file version was found, so version 1.0 is assumed"
)
self._parse_cols = self._parse_msg_v1_0
elif self.file_version == TRCFileVersion.V1_0:
self._parse_cols = self._parse_msg_v1_0
elif self.file_version == TRCFileVersion.V1_1:
self._parse_cols = self._parse_cols_v1_1
elif self.file_version == TRCFileVersion.V1_3:
self._parse_cols = self._parse_cols_v1_3
elif self.file_version in [TRCFileVersion.V2_0, TRCFileVersion.V2_1]:
self._parse_cols = self._parse_cols_v2_x
else:
raise NotImplementedError("File version not fully implemented for reading")
return line
def _parse_msg_v1_0(self, cols: Tuple[str, ...]) -> Optional[Message]:
arbit_id = cols[2]
if arbit_id == "FFFFFFFF":
logger.info("TRCReader: Dropping bus info line")
return None
msg = Message()
msg.timestamp = float(cols[1]) / 1000
msg.arbitration_id = int(arbit_id, 16)
msg.is_extended_id = len(arbit_id) > 4
msg.channel = 1
msg.dlc = int(cols[3])
msg.data = bytearray([int(cols[i + 4], 16) for i in range(msg.dlc)])
return msg
def _parse_msg_v1_1(self, cols: Tuple[str, ...]) -> Optional[Message]:
arbit_id = cols[3]
msg = Message()
msg.timestamp = float(cols[1]) / 1000 + self._start_time
msg.arbitration_id = int(arbit_id, 16)
msg.is_extended_id = len(arbit_id) > 4
msg.channel = 1
msg.dlc = int(cols[4])
msg.data = bytearray([int(cols[i + 5], 16) for i in range(msg.dlc)])
msg.is_rx = cols[2] == "Rx"
return msg
def _parse_msg_v1_3(self, cols: Tuple[str, ...]) -> Optional[Message]:
arbit_id = cols[4]
msg = Message()
msg.timestamp = float(cols[1]) / 1000 + self._start_time
msg.arbitration_id = int(arbit_id, 16)
msg.is_extended_id = len(arbit_id) > 4
msg.channel = int(cols[2])
msg.dlc = int(cols[6])
msg.data = bytearray([int(cols[i + 7], 16) for i in range(msg.dlc)])
msg.is_rx = cols[3] == "Rx"
return msg
def _parse_msg_v2_x(self, cols: Tuple[str, ...]) -> Optional[Message]:
type_ = cols[self.columns["T"]]
bus = self.columns.get("B", None)
if "l" in self.columns:
length = int(cols[self.columns["l"]])
dlc = len2dlc(length)
elif "L" in self.columns:
dlc = int(cols[self.columns["L"]])
else:
raise ValueError("No length/dlc columns present.")
msg = Message()
msg.timestamp = float(cols[self.columns["O"]]) / 1000 + self._start_time
msg.arbitration_id = int(cols[self.columns["I"]], 16)
msg.is_extended_id = len(cols[self.columns["I"]]) > 4
msg.channel = int(cols[bus]) if bus is not None else 1
msg.dlc = dlc
if dlc:
msg.data = bytearray.fromhex(cols[self.columns["D"]])
msg.is_rx = cols[self.columns["d"]] == "Rx"
msg.is_fd = type_ in {"FD", "FB", "FE", "BI"}
msg.bitrate_switch = type_ in {"FB", "FE"}
msg.error_state_indicator = type_ in {"FE", "BI"}
return msg
def _parse_cols_v1_1(self, cols: Tuple[str, ...]) -> Optional[Message]:
dtype = cols[2]
if dtype in ("Tx", "Rx"):
return self._parse_msg_v1_1(cols)
else:
logger.info("TRCReader: Unsupported type '%s'", dtype)
return None
def _parse_cols_v1_3(self, cols: Tuple[str, ...]) -> Optional[Message]:
dtype = cols[3]
if dtype in ("Tx", "Rx"):
return self._parse_msg_v1_3(cols)
else:
logger.info("TRCReader: Unsupported type '%s'", dtype)
return None
def _parse_cols_v2_x(self, cols: Tuple[str, ...]) -> Optional[Message]:
dtype = cols[self.columns["T"]]
if dtype in {"DT", "FD", "FB", "FE", "BI"}:
return self._parse_msg_v2_x(cols)
else:
logger.info("TRCReader: Unsupported type '%s'", dtype)
return None
def _parse_line(self, line: str) -> Optional[Message]:
logger.debug("TRCReader: Parse '%s'", line)
try:
cols = tuple(line.split(maxsplit=self._num_columns))
return self._parse_cols(cols)
except IndexError:
logger.warning("TRCReader: Failed to parse message '%s'", line)
return None
def __iter__(self) -> Generator[Message, None, None]:
first_line = self._extract_header()
if first_line is not None:
msg = self._parse_line(first_line)
if msg is not None:
yield msg
for line in self.file:
temp = line.strip()
if temp.startswith(";"):
# Comment line
continue
if len(temp) == 0:
# Empty line
continue
msg = self._parse_line(temp)
if msg is not None:
yield msg
self.stop()
class TRCWriter(TextIOMessageWriter):
"""Logs CAN data to text file (.trc).
The measurement starts with the timestamp of the first registered message.
If a message has a timestamp smaller than the previous one or None,
it gets assigned the timestamp that was written for the last message.
If the first message does not have a timestamp, it is set to zero.
"""
file: TextIO
first_timestamp: Optional[float]
FORMAT_MESSAGE = (
"{msgnr:>7} {time:13.3f} DT {channel:>2} {id:>8} {dir:>2} - {dlc:<4} {data}"
)
FORMAT_MESSAGE_V1_0 = "{msgnr:>6}) {time:7.0f} {id:>8} {dlc:<1} {data}"
def __init__(
self,
file: Union[StringPathLike, TextIO],
channel: int = 1,
**kwargs: Any,
) -> None:
"""
:param file: a path-like object or as file-like object to write to
If this is a file-like object, is has to opened in text
write mode, not binary write mode.
:param channel: a default channel to use when the message does not
have a channel set
"""
super().__init__(file, mode="w")
self.channel = channel
if hasattr(self.file, "reconfigure"):
self.file.reconfigure(newline="\r\n")
else:
raise TypeError("File must be opened in text mode.")
self.filepath = os.path.abspath(self.file.name)
self.header_written = False
self.msgnr = 0
self.first_timestamp = None
self.file_version = TRCFileVersion.V2_1
self._msg_fmt_string = self.FORMAT_MESSAGE_V1_0
self._format_message = self._format_message_init
def _write_header_v1_0(self, start_time: datetime) -> None:
lines = [
";##########################################################################",
f"; {self.filepath}",
";",
"; Generated by python-can TRCWriter",
f"; Start time: {start_time}",
"; PCAN-Net: N/A",
";",
"; Columns description:",
"; ~~~~~~~~~~~~~~~~~~~~~",
"; +-current number in actual sample",
"; | +time offset of message (ms",
"; | | +ID of message (hex",
"; | | | +data length code",
"; | | | | +data bytes (hex ...",
"; | | | | |",
";----+- ---+--- ----+--- + -+ -- -- ...",
]
self.file.writelines(line + "\n" for line in lines)
def _write_header_v2_1(self, start_time: datetime) -> None:
header_time = start_time - datetime(
year=1899, month=12, day=30, tzinfo=timezone.utc
)
lines = [
";$FILEVERSION=2.1",
f";$STARTTIME={header_time/timedelta(days=1)}",
";$COLUMNS=N,O,T,B,I,d,R,L,D",
";",
f"; {self.filepath}",
";",
f"; Start time: {start_time}",
"; Generated by python-can TRCWriter",
";-------------------------------------------------------------------------------",
"; Bus Name Connection Protocol",
"; N/A N/A N/A N/A",
";-------------------------------------------------------------------------------",
"; Message Time Type ID Rx/Tx",
"; Number Offset | Bus [hex] | Reserved",
"; | [ms] | | | | | Data Length Code",
"; | | | | | | | | Data [hex] ...",
"; | | | | | | | | |",
";---+-- ------+------ +- +- --+----- +- +- +--- +- -- -- -- -- -- -- --",
]
self.file.writelines(line + "\n" for line in lines)
def _format_message_by_format(self, msg, channel):
if msg.is_extended_id:
arb_id = f"{msg.arbitration_id:07X}"
else:
arb_id = f"{msg.arbitration_id:04X}"
data = [f"{byte:02X}" for byte in msg.data]
serialized = self._msg_fmt_string.format(
msgnr=self.msgnr,
time=(msg.timestamp - self.first_timestamp) * 1000,
channel=channel,
id=arb_id,
dir="Rx" if msg.is_rx else "Tx",
dlc=msg.dlc,
data=" ".join(data),
)
return serialized
def _format_message_init(self, msg, channel):
if self.file_version == TRCFileVersion.V1_0:
self._format_message = self._format_message_by_format
self._msg_fmt_string = self.FORMAT_MESSAGE_V1_0
elif self.file_version == TRCFileVersion.V2_1:
self._format_message = self._format_message_by_format
self._msg_fmt_string = self.FORMAT_MESSAGE
else:
raise NotImplementedError("File format is not supported")
return self._format_message_by_format(msg, channel)
def write_header(self, timestamp: float) -> None:
# write start of file header
start_time = datetime.fromtimestamp(timestamp, timezone.utc)
if self.file_version == TRCFileVersion.V1_0:
self._write_header_v1_0(start_time)
elif self.file_version == TRCFileVersion.V2_1:
self._write_header_v2_1(start_time)
else:
raise NotImplementedError("File format is not supported")
self.header_written = True
def log_event(self, message: str, timestamp: float) -> None:
if not self.header_written:
self.write_header(timestamp)
self.file.write(message + "\n")
def on_message_received(self, msg: Message) -> None:
if self.first_timestamp is None:
self.first_timestamp = msg.timestamp
if msg.is_error_frame:
logger.warning("TRCWriter: Logging error frames is not implemented")
return
if msg.is_remote_frame:
logger.warning("TRCWriter: Logging remote frames is not implemented")
return
channel = channel2int(msg.channel)
if channel is None:
channel = self.channel
else:
# Many interfaces start channel numbering at 0 which is invalid
channel += 1
if msg.is_fd:
logger.warning("TRCWriter: Logging CAN FD is not implemented")
return
serialized = self._format_message(msg, channel)
self.msgnr += 1
self.log_event(serialized, msg.timestamp)
|