ChannelCAN

Summary

Represents a CAN(FD) Channel Adapter object.

Methods

ChannelCAN.create_transmit()

ChannelCAN.start_record()

ChannelCAN.stop_record()

Properties

ChannelCAN.cluster_name

ChannelCAN.name

Structure

class ChannelCAN

create_transmit(messages: IList, repeat: uint32 or None) → Transmission

Starts the transmission of a burst of messages using a specific period of time between them. Useful to write load/stress tests.

Parameters

• messages (IList) – The messages to transmit.

• repeat (uint32 or None) – Number of times transmitting the packets, indefinitely if value is None

Returns

The object created for the transmission

Return type

Transmission

start_record(file: str, filter: Filter = None) → IRecordHandler

Starts recording the traffic on the adapter to an output file.

Parameters

• file (str) – The file to record into.

• filter (Filter) – Filter to use to narrow down packets to capture

Returns

The record handler responsible for recording.

Return type

IRecordHandler

stop_record()

stops capturing transmission

cluster_name

The name of the cluster that is mapped to the channel.

Type

str

name

The channel name. This Property is Read Only.

Type

str