MessageEthernet
Summary
Represents an ethernet message object.
See also
- Methods
- Properties
- Events
Structure
- class MessageEthernet
- capture(filter: Filter = None) MessageEthernet
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
- capture(timeout: int32, filter: Filter = None) MessageEthernet
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
- Returns
First message captured from the bus or
Nonein case no message is received.- Return type
- capture_list(timeout: int32, filter: Filter = None) IReadOnlyList[MessageEthernet]
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
- Returns
List of messages captured from the bus during a given period of time.
- Return type
- close_writer()
Closes the file previously created with
open_writer(file).
- get_arp_layer() MessageARP
Extracts the ARP layer from the message.
- Returns
ARP packet extracted. If no ARP layer found,
Noneis returned.- Return type
- get_can_layer() MessageCAN
Extracts the CAN layer from the message.
- Returns
CAN packet extracted. If no CAN layer found,
Noneis returned.- Return type
- get_dhcp_layer() MessageDHCP
Extracts the DHCP layer from the message.
- Returns
DHCP packet extracted. If no DHCP layer found,
Noneis returned.- Return type
- get_dlt_layer() MessageDlt
Extracts the DLT layer from the message, if present.
- Returns
Encapsulated DLT packet including both header and data. If no DLT layer found,
Noneis returned.- Return type
- get_ethernet_layer() MessageEthernet
Extracts the ethernet layer from the message, if present.
- Returns
Encapsulated Ethernet Packet if the parent message is an Ethernet Gateway. If no Ethernet Layer is found,
Noneis returned.- Return type
- get_flexray_layer() MessageFlexray
Extracts the FlexRay layer from the message.
- Returns
FlexRay packet extracted. If no FlexRay layer found,
Noneis returned.- Return type
- 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
- get_hsfz_layer() MessageHSFZ
Extracts the HSFZ layer from the message.
- Returns
HSFZ packet extracted. If no HSFZ layer found,
Noneis returned.- Return type
- get_icmp_layer() MessageICMPv4
Extracts the ICMP layer from the message.
- Returns
ICMP packet extracted. If no ICMP layer found,
Noneis returned.- Return type
- get_ieee1722_layer() MessageIEEE1722
Extracts the IEEE1722 layer from the message.
- Returns
IEEE1722 packet extracted. If no IEEE1722 layer found,
Noneis returned.- Return type
- get_ipv4_layer() MessageIpv4
Extracts the IPv4 layer from the message, if present.
- Returns
IPv4 packet, including both header and data. If no IPv4 layer found,
Noneis returned.- Return type
- get_ipv6_layer() MessageIPv6
Extracts the IPv6 layer from the message, if present.
- Returns
IPv6 packet, including both header and data. If no IPv6 layer found,
Noneis returned.- Return type
- get_layer(type: PROTOCOL_TYPE) IMessageBase
Extracts a layer from the message given its type.
- Parameters
type (
PROTOCOL_TYPE) – Desired layer.- Returns
Packet extracted, if the layer is not found,
Noneis returned.- Return type
- get_lin_layer() MessageLIN
Extracts the LIN layer from the message.
- Returns
LIN packet extracted. If no LIN layer found,
Noneis returned.- Return type
- get_nm_layer() MessageNM
Extracts the NM layer from the message, if present.
- Returns
NM packet extracted. If no NM layer found,
Noneis returned. NOTE: Due to its simplicity, it has no header or payload sections, so the whole message is treated as NM payload.- Return type
- get_pdu_layer() MessagePDU
Extracts the PDU layer from the message, if present.
- Returns
PDU packet, including both header and data. If no PDU layer found,
Noneis returned.- Return type
- get_ptp_layer() MessagePTP
Extracts the PTP layer from the message.
- Returns
PTP packet extracted. If no PTP layer found,
Noneis returned.- Return type
- get_someip_layer() MessageSomeIP
Extracts the SOME/IP layer from the message, if present.
- Returns
SOME/IP packet extracted. If no SOME/IP layer found,
Noneis returned.- Return type
- get_someip_sd_layer() MessageSomeIPSD
Extracts the SOME/IP-SD layer from the message, if present.
- Returns
Whole SOME/IP-SD packet extracted. If no SOME/IP-SD layer found,
Noneis returned.- Return type
- get_tcp_layer() MessageTCP
Extracts the TCP layer from the message.
- Returns
TCP packet extracted. If no TCP layer found,
Noneis returned.- Return type
- get_tls_layer() MessageTls
Extracts the TLS layer from the message.
- Returns
TLS packet extracted. If no TLS layer found,
Noneis returned.- Return type
- get_udp_layer() MessageUDP
Extracts the UDP layer from the message.
- Returns
UDP packet extracted. If no UDP layer found,
Noneis returned.- Return type
- has_layer(protocol: PROTOCOL_TYPE) bool
Checks if the message has a layer of the given protocol.
- Parameters
protocol (
PROTOCOL_TYPE) – Desired protocol layer. see Protocol type enum for a list of valid values.- Returns
Trueif the layer is present in the message. Otherwise,False.- Return type
- hex_view() str
Allows to visualize messages in hexadecimal format.
- Returns
Hexadecimal representation of the whole message.
- Return type
- 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 storedfileFormat (
FILEFORMATor None) – Obsolete, you don't need to specify this argument anymore
- receive() MessageEthernet
Matches a response for the used message.
- Returns
Listens to the bus until a message is received and returns this first message
- Return type
- receive(timeout: int32) MessageEthernet
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
Nonein case no message is received.- Return type
- receive_list(timeout: int32) IReadOnlyList[MessageEthernet]
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
- send() bool
Sends the message (the one used to call the method) through the Ethernet bus.
- Returns
Returns
Trueif the message is sent successfully. Otherwise, an exception will be thrown.- Return type
- 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.
- 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).
- stop_responding_machine()
Stops the responding machine activated with start_responding_machine.
- store(file: str)
Writes the message into the trace file.
- Parameters
file (
str) – Path of the file where the messages will be stored.
- store()
Writes the message into the trace file opened with
open_writer(file).
- tree_view() str
Gives the tree view of the message.
- Returns
Tree view representation of the message.
- Return type
- @on_capture_start
The event is triggered when the capture of Ethernet messages is started. See start_capture .
- @on_capture_stop
The event is triggered when the capture of Ethernet messages is stopped. See stop_capture .
- @on_message_received(message: MessageEthernet)
Event is triggered every time a message is read from the Ethernet bus or a trace file. See start_capture.
- Parameters
message (
MessageEthernet) – The message object being handled.
- capture_info
General information about the context in which the message was captured from.
Noneif the message was not captured- Type
- frame_number
Number of the frame received, in the context of all the ethernet traffic captured.
- Type
- vlan_tag
This field contains the vlan tag.
- Type