ChannelMediaGatewayCAN

Summary

Represents a Media Gateway CAN Channel Adapter object.

Methods

ChannelMediaGatewayCAN.encode()

ChannelMediaGatewayCAN.start_record()

ChannelMediaGatewayCAN.stop_record()

Properties

ChannelMediaGatewayCAN.cluster_name

ChannelMediaGatewayCAN.name

Structure

class ChannelMediaGatewayCAN

encode(message: MessageCAN, request_counter: int64 = 0) → Array[uint8]

Returns the encoded CAN message as a byte array.

Parameters

• message (MessageCAN) – the encoded CAN message

• request_counter (int64) – request counter

Returns

the encoded CAN message as a byte array

Return type

Array[uint8]

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