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
|
import os
from ctypes import POINTER, Structure, sizeof
from ctypes import (
c_long as BOOL,
)
from ctypes import (
c_ubyte as BYTE,
)
from ctypes import (
c_ulong as DWORD,
)
from ctypes import (
c_ushort as WORD,
)
from ctypes import (
c_void_p as LPVOID,
)
# Workaround for Unix based platforms to be able to load structures for testing, etc...
if os.name == "nt":
from ctypes import WINFUNCTYPE as FUNCTYPE
else:
from ctypes import CFUNCTYPE as FUNCTYPE
from .constants import MsgFrameFormat
class CanMsg(Structure):
"""
Structure of a CAN message.
.. seealso::
:meth:`UcanServer.read_can_msg`
:meth:`UcanServer.write_can_msg`
:meth:`UcanServer.define_cyclic_can_msg`
:meth:`UcanServer.read_cyclic_can_msg`
"""
_pack_ = 1
_fields_ = [
("m_dwID", DWORD), # CAN Identifier
("m_bFF", BYTE), # CAN Frame Format (see enum :class:`MsgFrameFormat`)
("m_bDLC", BYTE), # CAN Data Length Code
("m_bData", BYTE * 8), # CAN Data (array of 8 bytes)
(
"m_dwTime",
DWORD,
), # Receive time stamp in ms (for transmit messages no meaning)
]
def __init__(
self, id_=0, frame_format=MsgFrameFormat.MSG_FF_STD, data=None, dlc=None
):
data = [] if data is None else data
dlc = len(data) if dlc is None else dlc
super().__init__(id_, frame_format, dlc, (BYTE * 8)(*data), 0)
def __eq__(self, other):
if not isinstance(other, CanMsg):
return False
return (
self.id == other.id
and self.frame_format == other.frame_format
and self.data == other.data
)
@property
def id(self):
return self.m_dwID
@id.setter
def id(self, value):
self.m_dwID = value
@property
def frame_format(self):
return self.m_bFF
@frame_format.setter
def frame_format(self, frame_format):
self.m_bFF = frame_format
@property
def data(self):
return self.m_bData[: self.m_bDLC]
@data.setter
def data(self, data):
self.m_bDLC = len(data)
self.m_bData((BYTE * 8)(*data))
@property
def time(self):
return self.m_dwTime
class Status(Structure):
"""
Structure with the error status of CAN and USB.
Use this structure with the method :meth:`UcanServer.get_status`
.. seealso::
:meth:`UcanServer.get_status`
:meth:`UcanServer.get_can_status_message`
"""
_pack_ = 1
_fields_ = [
("m_wCanStatus", WORD), # CAN error status (see enum :class:`CanStatus`)
("m_wUsbStatus", WORD), # USB error status (see enum :class:`UsbStatus`)
]
def __eq__(self, other):
if not isinstance(other, Status):
return False
return (
self.can_status == other.can_status and self.usb_status == other.usb_status
)
@property
def can_status(self):
return self.m_wCanStatus
@property
def usb_status(self):
return self.m_wUsbStatus
class InitCanParam(Structure):
"""
Structure including initialisation parameters used internally in :meth:`UcanServer.init_can`.
.. note:: This structure is only used internally.
"""
_pack_ = 1
_fields_ = [
("m_dwSize", DWORD), # size of this structure (only used internally)
(
"m_bMode",
BYTE,
), # selects the mode of CAN controller (see enum :class:`Mode`)
# Baudrate Registers for GW-001 or GW-002
("m_bBTR0", BYTE), # Bus Timing Register 0 (see enum :class:`Baudrate`)
("m_bBTR1", BYTE), # Bus Timing Register 1 (see enum :class:`Baudrate`)
("m_bOCR", BYTE), # Output Control Register (see enum :class:`OutputControl`)
(
"m_dwAMR",
DWORD,
), # Acceptance Mask Register (see method :meth:`UcanServer.set_acceptance`)
(
"m_dwACR",
DWORD,
), # Acceptance Code Register (see method :meth:`UcanServer.set_acceptance`)
("m_dwBaudrate", DWORD), # Baudrate Register for all systec USB-CANmoduls
# (see enum :class:`BaudrateEx`)
(
"m_wNrOfRxBufferEntries",
WORD,
), # number of receive buffer entries (default is 4096)
(
"m_wNrOfTxBufferEntries",
WORD,
), # number of transmit buffer entries (default is 4096)
]
def __init__(
self, mode, BTR, OCR, AMR, ACR, baudrate, rx_buffer_entries, tx_buffer_entries
):
super().__init__(
sizeof(InitCanParam),
mode,
BTR >> 8,
BTR,
OCR,
AMR,
ACR,
baudrate,
rx_buffer_entries,
tx_buffer_entries,
)
def __eq__(self, other):
if not isinstance(other, InitCanParam):
return False
return (
self.mode == other.mode
and self.BTR == other.BTR
and self.OCR == other.OCR
and self.baudrate == other.baudrate
and self.rx_buffer_entries == other.rx_buffer_entries
and self.tx_buffer_entries == other.tx_buffer_entries
)
@property
def mode(self):
return self.m_bMode
@mode.setter
def mode(self, mode):
self.m_bMode = mode
@property
def BTR(self):
return self.m_bBTR0 << 8 | self.m_bBTR1
@BTR.setter
def BTR(self, BTR):
self.m_bBTR0, self.m_bBTR1 = BTR >> 8, BTR
@property
def OCR(self):
return self.m_bOCR
@OCR.setter
def OCR(self, OCR):
self.m_bOCR = OCR
@property
def baudrate(self):
return self.m_dwBaudrate
@baudrate.setter
def baudrate(self, baudrate):
self.m_dwBaudrate = baudrate
@property
def rx_buffer_entries(self):
return self.m_wNrOfRxBufferEntries
@rx_buffer_entries.setter
def rx_buffer_entries(self, rx_buffer_entries):
self.m_wNrOfRxBufferEntries = rx_buffer_entries
@property
def tx_buffer_entries(self):
return self.m_wNrOfTxBufferEntries
@tx_buffer_entries.setter
def tx_buffer_entries(self, tx_buffer_entries):
self.m_wNrOfTxBufferEntries = tx_buffer_entries
class Handle(BYTE):
pass
class HardwareInfoEx(Structure):
"""
Structure including hardware information about the USB-CANmodul.
This structure is used with the method :meth:`UcanServer.get_hardware_info`.
.. seealso:: :meth:`UcanServer.get_hardware_info`
"""
_pack_ = 1
_fields_ = [
("m_dwSize", DWORD), # size of this structure (only used internally)
("m_UcanHandle", Handle), # USB-CAN-Handle assigned by the DLL
("m_bDeviceNr", BYTE), # device number of the USB-CANmodul
("m_dwSerialNr", DWORD), # serial number from USB-CANmodul
("m_dwFwVersionEx", DWORD), # version of firmware
("m_dwProductCode", DWORD), # product code (see enum :class:`ProductCode`)
# unique ID (available since V5.01) !!! m_dwSize must be >= HWINFO_SIZE_V2
("m_dwUniqueId0", DWORD),
("m_dwUniqueId1", DWORD),
("m_dwUniqueId2", DWORD),
("m_dwUniqueId3", DWORD),
("m_dwFlags", DWORD), # additional flags
]
def __init__(self):
super().__init__(sizeof(HardwareInfoEx))
def __eq__(self, other):
if not isinstance(other, HardwareInfoEx):
return False
return (
self.device_number == other.device_number
and self.serial == other.serial
and self.fw_version == other.fw_version
and self.product_code == other.product_code
and self.unique_id == other.unique_id
and self.flags == other.flags
)
@property
def device_number(self):
return self.m_bDeviceNr
@property
def serial(self):
return self.m_dwSerialNr
@property
def fw_version(self):
return self.m_dwFwVersionEx
@property
def product_code(self):
return self.m_dwProductCode
@property
def unique_id(self):
return (
self.m_dwUniqueId0,
self.m_dwUniqueId1,
self.m_dwUniqueId2,
self.m_dwUniqueId3,
)
@property
def flags(self):
return self.m_dwFlags
# void PUBLIC UcanCallbackFktEx (Handle UcanHandle_p, DWORD dwEvent_p,
# BYTE bChannel_p, void* pArg_p);
CallbackFktEx = FUNCTYPE(None, Handle, DWORD, BYTE, LPVOID)
class HardwareInitInfo(Structure):
"""
Structure including information about the enumeration of USB-CANmoduls.
.. seealso:: :meth:`UcanServer.enumerate_hardware`
.. note:: This structure is only used internally.
"""
_pack_ = 1
_fields_ = [
("m_dwSize", DWORD), # size of this structure
(
"m_fDoInitialize",
BOOL,
), # specifies if the found module should be initialized by the DLL
("m_pUcanHandle", Handle), # pointer to variable receiving the USB-CAN-Handle
("m_fpCallbackFktEx", CallbackFktEx), # pointer to callback function
(
"m_pCallbackArg",
LPVOID,
), # pointer to user defined parameter for callback function
("m_fTryNext", BOOL), # specifies if a further module should be found
]
class ChannelInfo(Structure):
"""
Structure including CAN channel information.
This structure is used with the method :meth:`UcanServer.get_hardware_info`.
.. seealso:: :meth:`UcanServer.get_hardware_info`
"""
_pack_ = 1
_fields_ = [
("m_dwSize", DWORD), # size of this structure
("m_bMode", BYTE), # operation mode of CAN controller (see enum :class:`Mode`)
("m_bBTR0", BYTE), # Bus Timing Register 0 (see enum :class:`Baudrate`)
("m_bBTR1", BYTE), # Bus Timing Register 1 (see enum :class:`Baudrate`)
("m_bOCR", BYTE), # Output Control Register (see enum :class:`OutputControl`)
(
"m_dwAMR",
DWORD,
), # Acceptance Mask Register (see method :meth:`UcanServer.set_acceptance`)
(
"m_dwACR",
DWORD,
), # Acceptance Code Register (see method :meth:`UcanServer.set_acceptance`)
("m_dwBaudrate", DWORD), # Baudrate Register for all systec USB-CANmoduls
# (see enum :class:`BaudrateEx`)
(
"m_fCanIsInit",
BOOL,
), # True if the CAN interface is initialized, otherwise false
(
"m_wCanStatus",
WORD,
), # CAN status (same as received by method :meth:`UcanServer.get_status`)
]
def __init__(self):
super().__init__(sizeof(ChannelInfo))
def __eq__(self, other):
if not isinstance(other, ChannelInfo):
return False
return (
self.mode == other.mode
and self.BTR == other.BTR
and self.OCR == other.OCR
and self.AMR == other.AMR
and self.ACR == other.ACR
and self.baudrate == other.baudrate
and self.can_is_init == other.can_is_init
and self.can_status == other.can_status
)
@property
def mode(self):
return self.m_bMode
@property
def BTR(self):
return self.m_bBTR0 << 8 | self.m_bBTR1
@property
def OCR(self):
return self.m_bOCR
@property
def AMR(self):
return self.m_dwAMR
@property
def ACR(self):
return self.m_dwACR
@property
def baudrate(self):
return self.m_dwBaudrate
@property
def can_is_init(self):
return self.m_fCanIsInit
@property
def can_status(self):
return self.m_wCanStatus
class MsgCountInfo(Structure):
"""
Structure including the number of sent and received CAN messages.
This structure is used with the method :meth:`UcanServer.get_msg_count_info`.
.. seealso:: :meth:`UcanServer.get_msg_count_info`
.. note:: This structure is only used internally.
"""
_fields_ = [
("m_wSentMsgCount", WORD), # number of sent CAN messages
("m_wRecvdMsgCount", WORD), # number of received CAN messages
]
@property
def sent_msg_count(self):
return self.m_wSentMsgCount
@property
def recv_msg_count(self):
return self.m_wRecvdMsgCount
# void (PUBLIC *ConnectControlFktEx) (DWORD dwEvent_p, DWORD dwParam_p, void* pArg_p);
ConnectControlFktEx = FUNCTYPE(None, DWORD, DWORD, LPVOID)
# typedef void (PUBLIC *EnumCallback) (DWORD dwIndex_p, BOOL fIsUsed_p,
# HardwareInfoEx* pHwInfoEx_p, HardwareInitInfo* pInitInfo_p, void* pArg_p);
EnumCallback = FUNCTYPE(
None, DWORD, BOOL, POINTER(HardwareInfoEx), POINTER(HardwareInitInfo), LPVOID
)
|