MessagePTP

Summary

Represents a PTP (Precision Time Protocol) message object, follows PTPv2 specifications.

Methods: MessagePTP.capture()

MessagePTP.capture_list()

MessagePTP.close_writer()

MessagePTP.get_all_bytes()

MessagePTP.get_bytes()

MessagePTP.get_hex_bytes()

MessagePTP.hex_view()

MessagePTP.open_writer()

MessagePTP.receive()

MessagePTP.receive_list()

MessagePTP.send()

MessagePTP.set_all_bytes()

MessagePTP.set_bytes()

MessagePTP.start_capture()

MessagePTP.start_responding_machine()

MessagePTP.stop_capture()

MessagePTP.stop_responding_machine()

MessagePTP.store()

MessagePTP.tree_view()
Properties: MessagePTP.capture_info

MessagePTP.clock_identity

MessagePTP.control

MessagePTP.correction

MessagePTP.data_base

MessagePTP.ethernet_header

MessagePTP.flags

MessagePTP.followup_tlv

MessagePTP.frame_number

MessagePTP.log_message_period

MessagePTP.message_id

MessagePTP.message_length

MessagePTP.message_type

MessagePTP.message_type_specific

MessagePTP.minor_sdo_id

MessagePTP.minor_version_ptp

MessagePTP.origin_timestamp

MessagePTP.payload

MessagePTP.requesting_port_id

MessagePTP.requesting_port_identity

MessagePTP.sequence_id

MessagePTP.source_port_id

MessagePTP.subdomain_number

MessagePTP.timestamp

MessagePTP.transport_specific

MessagePTP.version

MessagePTP.vlan_tag
Events: MessagePTP.on_capture_start()

MessagePTP.on_capture_stop()

MessagePTP.on_message_received()

Structure

class MessagePTP

capture(filter: Filter = None) → MessagePTP

Matches any message with the same protocol.

Parameters: filter (Filter) – Filter to use to narrow down packets to capture
Returns: Listens to the bus until a message is received and returns this first message
Return type: MessagePTP

capture(timeout: int32, filter: Filter = None) → MessagePTP

Waits for the first message having the same protocol that the sent message without verify the IP address and the port between send and respond message and return it. A timeout is specified to guarantee that the script can continue if no message is captured in a certain time interval.

Parameters

timeout (int32) – Max time in milliseconds to wait for the response.
filter (Filter) – Filter to use to narrow down packets to capture

Returns

First message captured from the bus or None in case no message is received.

Return type

MessagePTP

capture_list(timeout: int32, filter: Filter = None) → IReadOnlyList[MessagePTP]

Waits for any response having the same protocol that the sent message without verify the IP address and the port between send and respond message and return them all as a list. A timeout is specified to guarantee that the script can continue if no message is received in a certain time interval.

Parameters

timeout (int32) – Max time in milliseconds to wait for the response.
filter (Filter) – Filter to use to narrow down packets to capture

Returns

List of messages captured from the bus during a given period of time.

Return type

IReadOnlyList[MessagePTP]

close_writer(): Closes the file previously created with open_writer(file).

get_all_bytes() → Array[uint8]

Gets the content of the whole message from Ethernet layer.

Returns: Array of bytes representing the message from Ethernet layer.
Return type: Array[uint8]

get_bytes() → Array[uint8]

Gets the content of the payload.

Returns: Array of bytes representing the payload of the message.
Return type: Array[uint8]

get_hex_bytes() → str

Converts the payload of the message from decimal to hex and outputs it to a string of bytes.

Returns: Payload of message in hex bytes.
Return type: str

hex_view() → str

Allows to visualize messages in hexadecimal format.

Returns: Hexadecimal representation of the whole message.
Return type: str

hex_view(nb_bytes_per_line: int32) → str

Allows to visualize messages in hexadecimal format.

Parameters: nb_bytes_per_line (int32) – (optional) number of bytes per line.
Returns: Hexadecimal representation of the whole message.
Return type: str

open_writer(file: str, fileFormat: FILEFORMAT or None = None)

Creates a PCAP or PCAPNG file for writing the received messages. If the file already exists, it will be overwritten (old file data will be lost). Use the store() method to record received messages into the file.

Parameters

file (str) – Absolute path of the file where the messages will be stored
fileFormat (FILEFORMAT or None) – Obsolete, you don't need to specify this argument anymore

receive() → MessagePTP

Matches a response for the used message.

Returns: Listens to the bus until a message is received and returns this first message
Return type: MessagePTP

receive(timeout: int32) → MessagePTP

Waits for the first response having the IP address destination equals to the IP address source of the sent message and return it. A timeout is specified to guarantee that the script can continue if no message is received in a certain time interval.

Parameters: timeout (int32) – Max time in milliseconds to wait for the response.
Returns: First message received from the bus or None in case no message is received.
Return type: MessagePTP

receive_list(timeout: int32) → IReadOnlyList[MessagePTP]

Waits for any response having the IP address destination equals to the IP address source of sent message and return them all as a list. A timeout is specified to guarantee that the script can continue if no message is received in a certain time interval.

Parameters: timeout (int32) – Max time in milliseconds to wait for the response.
Returns: List of messages received from the bus during a given period of time.
Return type: IReadOnlyList[MessagePTP]

send() → bool

Sends the message (the one used to call the method) through the Ethernet bus.

Returns: Returns True if the message is sent successfully. Otherwise, an exception will be thrown.
Return type: bool

set_all_bytes(all_packet: Array[uint8]) → bool

Sets the content of the whole message from Ethernet layer, byte per byte.

Parameters: all_packet (Array[uint8]) – All packet to set.
Returns: True if the operation was successful, False otherwise.
Return type: bool

set_bytes(payload: Array[uint8])

Sets the content of the payload, byte per byte.

Parameters: payload (Array[uint8]) – Array of bytes to set.

start_capture(filter: Filter = None)

Used for online capture(capturing network traffic from an adapter). Used with callback function(on_message_received()) and stop_capture() method.

Parameters: filter (Filter) – Filter to use to narrow down packets to capture

start_capture(file: str, wait_eof: bool, filter: Filter = None)

Used for offline capture(reading packets from pcap or asc file). Used with callback function(on_message_received()) and stop_capture() method.

Parameters

file (str) – The trace file from where the messages will be read.
wait_eof (bool) – If True the function would block until all frames in the file are read. If False the function would read the frames in the background.
filter (Filter) – Filter to use to narrow down packets to capture

start_responding_machine(): With this function, it is possible to simulate an ECU. It captures packets and, for every received message, it calls is_request callback. If it returns True, then it calls the make_reply callback

stop_capture(): Stops capturing Ethernet messages, either directly from the bus or from a trace file (depending on the version used to start the capture).