MessageNM

Summary

Represents an NM (network management protocol) Message object.

See also

Message

IMessageInternetApplication

Methods: MessageNM.capture()

MessageNM.capture_list()

MessageNM.close_writer()

MessageNM.get_all_bytes()

MessageNM.get_bytes()

MessageNM.get_hex_bytes()

MessageNM.hex_view()

MessageNM.is_segmented()

MessageNM.is_sending_cyclic()

MessageNM.open_writer()

MessageNM.receive()

MessageNM.receive_list()

MessageNM.send()

MessageNM.send_receive()

MessageNM.send_receive_list()

MessageNM.set_all_bytes()

MessageNM.set_bytes()

MessageNM.start_capture()

MessageNM.start_cyclic_send()

MessageNM.start_responding_machine()

MessageNM.stop_capture()

MessageNM.stop_cyclic_send()

MessageNM.stop_responding_machine()

MessageNM.store()

MessageNM.tree_view()
Properties: MessageNM.active_wakeup_bit

MessageNM.capture_info

MessageNM.cbv

MessageNM.coordinator_sleep_ready

MessageNM.ctr_bs_prtnt_nm

MessageNM.ctr_fktn_prtnt_nm

MessageNM.data_base

MessageNM.ethernet_header

MessageNM.frame_number

MessageNM.ip_header

MessageNM.ipv4_header

MessageNM.ipv6_header

MessageNM.length

MessageNM.network_protocol

MessageNM.payload

MessageNM.pni_bit

MessageNM.rpt_msg_request

MessageNM.source_node

MessageNM.timestamp

MessageNM.transport_header

MessageNM.transport_protocol

MessageNM.udp_header

MessageNM.vlan_tag
Events: MessageNM.on_capture_start()

MessageNM.on_capture_stop()

MessageNM.on_message_received()

Structure

class MessageNM

capture(filter: Filter = None) → MessageNM

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: MessageNM

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

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

MessageNM

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

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[MessageNM]

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

is_segmented() → bool

Checks if the message is segmented.

Returns: True if the message is segmented. False if not
Return type: bool

is_sending_cyclic() → bool

Checks if the message is sending cyclically.

Returns: True if the message is sending cyclically. Otherwise, False.
Return type: bool

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() → MessageNM

Matches a response for the used message.

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

receive(timeout: int32) → MessageNM

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: MessageNM

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

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[MessageNM]

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

send_receive(timeout: int32 = 1000) → MessageNM

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. Default 1 second
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: MessageNM

send_receive_list(timeout: int32) → IReadOnlyList[MessageNM]

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: IReadOnlyList[MessageNM]

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_cyclic_send(cycle_time_milliseconds: uint16)

Starts sending NM message cyclically for a possible cycle_time.

Parameters: cycle_time_milliseconds (uint16) – Max time in milliseconds to send the message cyclically.

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_cyclic_send(): Stops the sending cyclically activated with start_cyclic_send

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: str

@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: MessageNM)

Event is triggered every time a message is read from the Ethernet bus or a trace file. See start_capture.

Parameters: message (MessageNM) – The message object being handled.

active_wakeup_bit

“Active Wakeup” bit.

Type: bool

capture_info

General information about the context in which the message was captured from. None if the message was not captured

Type: CaptureInfo

cbv

8bit Control Bit Vector that contains the data about Repeat Message Request, the NM Coordinator Sleep Ready Bit, the Active Wakeup Bit and the Partial Network Information Bit.

Type: int8

coordinator_sleep_ready

“NM Coordinator Sleep” bit.

Type: bool

ctr_bs_prtnt_nm

16bit control field that contains data about KOM_Parken_BN_ni0, KOM_Parken_BN_i0, KOM_Standfunktionen_Kunde_nicht_im_FZG, KOM_Wohnen, KOM_Pruefen_Analyse_Diagnose, KOM_Fahrbereitschaft_herstellen, KOM_Fahren, KOM_Fahrbereitschaft_beenden.