ADTF ASAM CMP Toolbox
Loading...
Searching...
No Matches
ASAM CMP Message Extractor

Plugin Information

Plugin Filenamecmp_components.adtfplugin
Plugin Descriptioncmp_components.plugindescription
Plugin NameASAM CMP Components Plugin
LicenseADTF Subscription
Support Mailsupport@digitalwerk.net
Homepage URLhttps://adtf.dev/

Plugin Versions

Plugin Version1.99.99
Plugin File Version1.0
adtf::dw_asam_cmp_toolbox1.99.99
adtf3.21.0
adtf::ucom3.1.0

Component Information

NameASAM CMP Message Extractor
CIDasam_cmp_message_extractor.filter.dw.cid
DescriptionUse this filter to receive ADTF ethernet samples and to check whether they are CMP frames with data, status or vendor messages. The payload is being extracted into individual ADTF samples in CMP type specific substreams. Therefore the received data is only being copied but not changed (original byte order is being kept; CMP defines big endian byte order). This filter complies with the CMP 1.0 specification (see documentation). Segmentation and aggregation is supported.
TypeFilter

Properties

NameValueTypeDescriptionSubproperties
hex_displayfalsetBoolCheck this if you want all numbers of the substream name displayed in hexadecimal, otherwise displayed in decimal.Value Range:
minimum =
maximum = Filename Extension Filter:
log_channels/default/fatal_action2tUInt32The default action when a fatal error is reported.Value List:
Stop session = 2
Shutdown ADTF = 3
Abort to crash handler = 4Value Range:
minimum =
maximum = Filename Extension Filter:
log_channels/default/log_level35tUInt32The log level for this channel.Value List:
None = 0
Error = 10
Warning = 20
Info = 30
Detail = 35
Dump = 40
All = 255Value Range:
minimum =
maximum = Filename Extension Filter:
log_channels/default/recoverable_action0tUInt8The action to perform when a recoverable error is reported.Value List:
Log only = 0
Treat as fatal = 1Value Range:
minimum =
maximum = Filename Extension Filter:
request_substreams_on_first_receivetruetBoolIf checked everytime a new substream is created it is requested too. The creation of a substream always takes place exactly when a certain cmp message with a certain type arrives for the first time. If unchecked the new created substream is not automatically requested.Value Range:
minimum =
maximum = Filename Extension Filter:
timestamp_type1tUInt8Choose between using the ADTF timestamps which come with the input samples or the CMP timestamp which comes within the CMP message for the output input_sample. Furthermore you can choose between POSIX UTC and TAI timebase or if there is no correlation to a timeserver.Value List:
ADTF_INPUT_SAMPLE = 0
CMP_TAI = 1
CMP_UTC = 2
CMP_NO_TIMESYNC = 3Value Range:
minimum =
maximum = Filename Extension Filter:
verbosetruetBoolCheck this if warnings should be logged. If unchecked warnings are not logged.Value Range:
minimum =
maximum = Filename Extension Filter:

Input Pins

NameStream TypeDescription
cmp_input adtf/anonymous Samples of type adtf/devicetb/ethernet (or adtf/anonymous if CMP frames captured by UDP Receiver) are expected. Ethernet/CMP, Ethernet/IPv4/UDP/CMP and Ethernet/IPv6/UDP/CMP frames are supported. Make sure that the input only contains the desired cmp messages by previously filtering the Ethernet frames by eg. source/destination address/port using the PCap BPF Ethernet Reducer of the ADTF PCAP Toolbox.

Output Pins

NameStream TypeDescription
cmp_output adtf/substreams

This output pins sends substreams dependend on CMP message type and the corresponding payload types. The following substream naming conventions are used:

  • Data messages:
    • [device_id].data.can.[interface_id]
    • [device_id].data.can_fd.[interface_id]
    • [device_id].data.flexray.[interface_id]
    • [device_id].data.ethernet.[interface_id]
    • [device_id].data.vendor.[interface_id].[vendor_id].[vendor_payload_type]
    • [device_id].data.other.[interface_id]
  • Status messages:
    • [device_id].status.capture_module
    • [device_id].status.config
    • [device_id].status.data_lost_event
    • [device_id].status.interface
    • [device_id].status.invalid
    • [device_id].status.time_sync_lost_event
    • [device_id].status.vendor
  • Vendor messages:
    • [device_id].vendor.[vendor_id].[vendor_payload_type]

The vendor-specific data message payload format consists of each 16 bit vendor id and vendor payload type, followed by the payload. For comfortable use the header is cut away and only the payload is part of the output sample.

Runner Pins

NameActivation TypeData TriggeredData InputThread TriggeredThread CyclicTimer TriggeredTimer IntervalDescription
process_cmp_input91cmp_input0000Default runner port for the input pin 'cmp_input'

Dynamic Pins

Dynamic Input Pinsfalse
Dynamic Output Pinsfalse
Dynamic Input Binding Pinsfalse
Dynamic Output Binding Pinsfalse

Required Interfaces

IID
reference_clock.vision.streaming.adtf.iid

Input Pin Stream Types

Pin Namecmp_input
Meta Type Nameadtf/anonymous
Stream Type Properties

Output Pin Stream Types

Pin Namecmp_output
Meta Type Nameadtf/substreams
Stream Type Properties
NameValueTypeDescriptionSubproperties
substreamstruetBoolValue Range:
minimum =
maximum = Filename Extension Filter: