CANLIN_use_case.py

# This script is licensed under BSD License, see file LICENSE.txt.
# 
# This Python example demonstrates different use cases for CAN/LIN Add-on
# module, as described in winIDEA Help: Network traffic sniffing,
# Timing Analysis, System delay, and Message injection.
#
# (c) TASKING Germany GmbH, 2023
 
"""
This script demonstrates different use cases for CAN/LIN Add-on module.
More information can be found in the winIDEA Help.
"""
 
import time
import isystem.connect as ic
 
# Connect to the last used winIDEA instance
conn_mgr = ic.ConnectionMgr()
conn_mgr.connect(ic.CConnectionConfig())
 
# CAN1 bus configuration:
#   Add the description file
#   Set mode to CAN
#   Allow message injection
#   Set the arbitration phase:
#       Baudrate - 500 kbps
#       Bit sampling point - 70 %
FNet_ctrl = ic.CFNetCtrl(conn_mgr)
CAN1_ctrl = FNet_ctrl.CAN("CAN2LIN2.CAN1")
CAN1_cfg = CAN1_ctrl.cfg()
CAN1_cfg.set("Databases[0].Path", "../../common/AOM/CAN.dbc")
CAN1_cfg.set_mode(ic.ECAN_CAN)
CAN1_cfg.set_allow_injection(True)
CAN1_cfg.set_arbitration(nBaudrate_kbps=500, nBitSamplingPoint=70)
 
# End and begin new debug session so the configuration takes effect
session_ctrl = ic.CSessionCtrl(conn_mgr)
session_ctrl.end()
session_ctrl.begin_reset()
 
# CAN1 FNet operation configuration:
#   Enable recording of all messages
#   Enable recording of injected messages
CAN1_op = CAN1_ctrl.op()
CAN1_op.set_record_all_received(True)
CAN1_op.set_record_all_injected(True)
 
# Use comparator 0 to trigger TC4 on the reception of a message with ID=0x555
CAN1_op.set_comparator(nComparator=0, bRecord=True, nFTrig=4, eLength=ic.ECAN_Standard,
                       nID=0x555, nMask=0xFFFFFFFF, eType=ic.ECAN_Both)
 
# Use action trigger slot 0 to inject message with ID=0x123 when TC4 is triggered
CAN1_op.set_action(nAction=0, nFTrig=4, eLength=ic.ECAN_Standard, nID=0x123,
                   bFD=False, bBRS=False, bESI=False, bRequest=False, rstrData="00000000")
 
# Begin New Session - start trace recording
profiler = ic.CProfilerController2(conn_mgr, fileName='CANLIN_use_case.trd', mode='w')
profiler.start()
 
# Run the target
exec_ctrl = ic.CExecutionController(conn_mgr)
exec_ctrl.run()
 
# Wait for a while (target is running) before injecting a message
time.sleep(3)
 
# Manually inject a message with ID=0x45 and data=0x0
CAN1_ctrl.ctrl_inject(eLength=ic.ECAN_Standard, nID=0x45, bFD=False,
                      bBRS=False, bESI=False, bRequest=False, rstrData="00000000")
 
# Wait for a while before a new manual message is injected
time.sleep(3)
 
# Set a breakpoint at a function, run the target until BP is hit and inject a CAN message with ID=0xBB after it
bc_ctrl = ic.CBreakpointController(conn_mgr)
bc_ctrl.setBP("Runnable_Core0_1000ms")
exec_ctrl.run(ic.CExecutionController.TOUT_INF)
CAN1_ctrl.ctrl_inject(eLength=ic.ECAN_Standard, nID=0xBB, bFD=False,
                      bBRS=False, bESI=False, bRequest=False, rstrData="00000000")
 
 
# Export the collected data
export_cfg = ic.CProfilerExportConfig()
export_cfg.setFileName('CANLIN_use_case.xml') \
          .setSaveTimeline(True)
profiler.exportData(export_cfg)
 
# Load profiler results
profiler_export_file = export_cfg.getFileName()
profiler_data = ic.CProfilerData2.createInstance(export_cfg.getFileName(), False)
 
# Always check for parser warnings
warnings = profiler_data.getParserWarnings()
if warnings:
    print(f"WARNING(S): {warnings}")
 
# Print events for the 'Signal_Rx8bit_Cyclic'
if profiler_data.hasArea(ic.CProfilerArea2.EAUX, 'Signal_Rx8bit_Cyclic'):
    signal_area = profiler_data.getArea(ic.CProfilerArea2.EAUX, 'Signal_Rx8bit_Cyclic')
    timelineIterator = profiler_data.getTimelineIterator(ic.CProfilerTimeEvent.EEvAny,
                                                         signal_area.getHandle())
 
    while timelineIterator.hasNext():
        timeEvent = timelineIterator.next()
        print(timeEvent.toString())
 
# --------------------------------------------------------------------------------------
# Output example for one of the timeEvents
# CProfilerTimeEvent:
#   handle: 1073741836
#   eventType: 1
#   value: 37
#   valueUnit:
#   floatValue: 37
#   time: 3667651152
#   eventSource: -1