Skip to main content
Version: 4.00

Python CAN Monitor Program

Setting Up the Execution Environment​

This section describes one way to prepare the sample program environment: create a virtual environment with venv, then build and install the sample in that environment.

Perform the following steps while the virtual environment is active.

  1. Change the current directory to the directory containing the source code.
  2. Run python setup.py build to build the Python wrapper sample.
  3. Run python -m pip install . to install the Python wrapper sample built in step 2.
  4. Run python mpx_canfd_monsample.py to start the sample program.

Operation Specification​

ItemDescription
CH1Operates in monitor mode.
Calls MPXGetLog every 10 ms to acquire logs and display them in the console.
CH2Not used

Log Display Details​

ItemDescription
TIMEDisplays the timestamp.
PROTOCOLDisplays the CAN protocol (CAN or CAN FD).
DIRDisplays the log direction.
Rx: received log; Tx: transmitted log.
IDDisplays the ID format (see below) and CAN ID in hexadecimal.
Std: standard ID; Ext: extended ID.
DLDisplays the data length (0 to 64).
DLDisplays data (D1 to D64) in hexadecimal.

Sample Source Code​

Source: MPXCtrl_CANFD_MonSample/mpx_canfd_monsample.py

import os
import sys
from pathlib import Path

if sys.platform == 'win32':
_dll_dir = os.add_dll_directory(
str(Path(__file__).resolve().parent)
)

import MPX_ADL_WR

import threading
import time

stop_event = threading.Event()

#read thread
def read_exec():
while not stop_event.is_set():
ret = MPX_ADL_WR.DispMonitor(serial, 1)
if not ret is None:
for i in range(ret[0]):
data = ret[1 + i][7]
data_text = '\\'.join(hex(b) for b in data)
print('TIME:' + str(ret[1 + i][0]) +'[ms] ' + str(ret[1 + i][1]) +'[us]' +
' PROTOCOL:' + ret[1 + i][2] +
' DIR:' + ret[1 + i][3] +
' ID:' + ret[1 + i][4] + '/' + hex(ret[1 + i][5]) +
' DL:' + str(ret[1 + i][6]) +
' DATA:' + data_text)
time.sleep(0.01)

ret = MPX_ADL_WR.MPXOpen()
if ret[0] != 0:
print('MPXOpen Error:' + str(ret[0]))

print('Serial No.')
for i in range(ret[1]):
print(' ' + str(ret[2][i]))

serial = ret[2][0]

print('MPX CAN INIT.')
ret = MPX_ADL_WR.MPXSampleCANInit(serial, 1)
if ret != 0:
print('CAN INIT error:' + str(ret))

print('MPX MonitorStart.')
ret = MPX_ADL_WR.MPXMonitorStart(serial)

print('Start ReadThread...')
read_thread = threading.Thread(target = read_exec)
read_thread.start()

print('Monitoring...')
time.sleep(20.0) # メインスレッドだけ20秒待つ。read_threadは動き続ける

stop_event.set()
read_thread.join(timeout = 2.0)

ret = MPX_ADL_WR.MPXMonitorStop(serial)
if ret[0] != 0:
print('MonitorStop :Error' + str(ret[0]))
else:
print('MonitorStop :Time' + str(ret[1]) + '[ms]' + str(ret[2]) + '[us]')

ret = MPX_ADL_WR.MPXClose()

The processing flow of this source code is as follows.

  1. Open the Device
  • MPXOpen() searches for MicroPeckerX devices and obtains their serial numbers.
  1. Initialize the Device
  • MPXSampleCANInit() initializes the MicroPeckerX device identified by the obtained serial number.
  1. Start Monitoring
  • MPXMonitorStart() starts monitoring.
  1. Start the Monitoring Thread
  • DispMonintor() starts a thread that runs read_exec() to acquire logs periodically.
  1. Stop the Monitoring Thread
  • stop_eventis set to terminate the thread that runs read_exec().
  1. Stop Monitoring
  • MPXMonitorStop() stops monitoring.
  1. Close the Device
  • MPXClose() closes the MicroPeckerX device identified by the obtained serial number.