MessageSomeIP
Summary
Represents a SOME/IP (Scalable service-Oriented MiddlewarE over IP) message.
See also
- Methods
- Properties
- Events
Structure
- class MessageSomeIP
- append_message(message: IMessageInternetApplication)
Lets the user packs several messages into one packet, each appended message will have its own header.
- Parameters
message (
IMessageInternetApplication) – The message to append
- capture(filter: Filter = None) MessageSomeIP
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) MessageSomeIP
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[MessageSomeIP]
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).
- disconnect(timeout: float = 0)
Closes the TCP connection opened with connect.
- Parameters
timeout (
float) – Number of seconds to wait for connection to close before aborting. If timeout is0(default) the connection would be closed with a TCP RST instead of normal TCP FIN, this prevents the connection from remaining stuck in the TIME_WAIT state for two minutes.
- get_all_input_params() IDictionary
Retrieves all the encoded or decoded input parameters. Where, parameters and complex members are following the information from the database attached to the SOME/IP message (if the database is not set, an exception will be | | invoked) . If the deserialization is not possible (message ID does not exist in the database), an empty dictionary will be returned. When the parameters’ specification does not match the payload of the SOME/IP message (wrong | SOME/IP message following a database), an exception will be invoked: in this case the dictionary will be filled with deserialized valid parameters and completed with default value of no valid one.
- Returns
Dictionary: “key” short name of the param. “value” DecodedParameter type.
- Return type
IDictionary
- get_all_output_params() IDictionary
Gets all the encoded or decoded output parameters.
- Returns
Array of bytes representing the payload of the message
- Return type
IDictionary
- 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_input_parameters(service_id: uint16, method_id: uint16) Array[Parameter]
Returns a list of input parameter object.
- get_output_parameters(service_id: uint16, method_id: uint16) Array[Parameter]
Gets a list of the output parameters object
- get_service_version() uint32
Gets the service version of the message.
- Returns
Service version of the message.
- Return type
- has_dynamic_parameters() bool
Checks if the message has dynamic parameters.
- Returns
Trueif the message has dynamic parameters. Otherwise,False.- Return type
- hex_view() str
Allows to visualize messages in hexadecimal format.
- Returns
Hexadecimal representation of the whole message.
- Return type
- is_segmented() bool
Checks if the message is segmented.
- Returns
Trueif the message is segmented.Falseif not- 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() MessageSomeIP
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) MessageSomeIP
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[MessageSomeIP]
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
- send_receive(timeout: int32 = 1000) MessageSomeIP
Sends the message (the one used to call the method) through the Ethernet bus and waits for a possible response, i.e. a message from the target address to our own address. It is possible to specify a timeout to guarantee that the script can continue if no response is detected in a certain time interval.
- Parameters
timeout (
int32) – (optional) Max time in milliseconds to wait for the response. Default1second- Returns
First message detected from the destination address to our address. This can be the response to the message sent but it is not
100%guaranteed; additional traffic can be captured before this expected response and thus returned.- Return type
- send_receive_list(timeout: int32) IReadOnlyList[MessageSomeIP]
Sends the message through the Ethernet bus, listens for a while and returns a list with all the messages captured in that period. It is possible to specify a timeout to guarantee that the script can continue if no response is detected in a certain time interval.
- Parameters
timeout (
int32) – Max time in milliseconds to wait for the response.- Returns
List of messages detected from the destination address to our address. This can be the response to the message sent but it is not
100%guaranteed; additional traffic can be captured before this expected response and thus returned.- Return type
- set_all_bytes(all_packet: Array[uint8]) bool
Sets the content of the whole message from Ethernet layer, byte per byte.
- set_crc_value() uint32
Calculates and retrieves the CRC identifier of SOME/IP message.
- Returns
Returns the CRC identifier of the SOME/IP message. Otherwise, it returns to
0.- Return type
- set_field_param(param: str, value: object)
Sets the field or members of it (if it is complex) with values specified by the user.
- set_input_param(param: str, value: object)
Sets the parameter and members of it (if it is complex) with values specified by user.
- set_output_param(param: str, value: object)
Sets the parameter and members of it (if it is complex) with values specified by user.
- 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_listener()
Starts listening for TCP clients through the receiver network adapter.
- 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_listener(timeout: float = 0)
Stops listening for TCP clients through the receiver network adapter.
- Parameters
timeout (
float) – Number of seconds to wait for connection to close before aborting. If timeout is0(default) the connection would be closed with a TCP RST instead of normal TCP FIN, this prevents the connection from remaining stuck in the TIME_WAIT state for two minutes.
- 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: MessageSomeIP)
Event is triggered every time a message is read from the Ethernet bus or a trace file. See start_capture.
- Parameters
message (
MessageSomeIP) – The message object being handled.
- auto_calculate
Determines which parameters are auto calculated.
- Type
- capture_info
General information about the context in which the message was captured from.
Noneif the message was not captured- Type
- ethernet_header
Object containing all the information from the Ethernet header like the source and destination MAC addresses of the message.
- Type
- frame_number
Number of the frame received, in the context of all the ethernet traffic captured.
- Type
- ip_header
Object containing all the information from the IP header like the source and destination IP addresses of the message.
- Type
- ipv4_header
Object containing all the information from the IPV4 header.
- Type
- ipv6_header
Object containing all the information from the IPV6 header.
- Type
- messages
Messages list.
- network_protocol
Network Protocol of the message.
- Type
- someip_header
Object containing all the information from the SOME/IP header.
- Type
- tp_header
Object containing all the information from the SOME/IP-TP header.
- Type
- transport_header
Object containing all the information from the transport header (usually TCP or UDP) like the source and destination ports.
- Type
- transport_protocol
Object containing all the information from the transport protocol (usually TCP or UDP) like the source and destination ports.
- Type
- vlan_tag
Object containing all VLAN info.
- Type