EcuNodeEthernet

Summary

Represents an RBS Ethernet ECU node.

Methods: EcuNodeEthernet.call()

EcuNodeEthernet.disable()

EcuNodeEthernet.enable()

EcuNodeEthernet.get_config()

EcuNodeEthernet.get_mac()

EcuNodeEthernet.get_value()

EcuNodeEthernet.reset()

EcuNodeEthernet.reset_value()

EcuNodeEthernet.set_config()

EcuNodeEthernet.set_mac()

EcuNodeEthernet.set_value()

EcuNodeEthernet.start()

EcuNodeEthernet.stop()

EcuNodeEthernet.trigger()
Properties: EcuNodeEthernet.auto_fire

EcuNodeEthernet.auto_fire_delay

EcuNodeEthernet.auto_toggle_bit_length

EcuNodeEthernet.auto_toggle_bit_position

EcuNodeEthernet.auto_toggle_payload

EcuNodeEthernet.data_base

EcuNodeEthernet.enable_arp_manager

EcuNodeEthernet.enable_icmp_manager

EcuNodeEthernet.enable_nm_manager

EcuNodeEthernet.enable_sd_manager

EcuNodeEthernet.ip_address_source

EcuNodeEthernet.ip_multicast_address

EcuNodeEthernet.is_started

EcuNodeEthernet.message_manager

EcuNodeEthernet.nm_manager

EcuNodeEthernet.override_auto_fire_delays

EcuNodeEthernet.override_auto_toggle_bit

EcuNodeEthernet.port_connection

EcuNodeEthernet.sd_manager

EcuNodeEthernet.someip_manager
Events: EcuNodeEthernet.on_method_called()

EcuNodeEthernet.on_receiving()

EcuNodeEthernet.on_reset_ecu()

EcuNodeEthernet.on_sending_sd()

EcuNodeEthernet.on_sending_someip()

EcuNodeEthernet.on_start()

EcuNodeEthernet.on_stop()

EcuNodeEthernet.on_value_changed()

Structure

class EcuNodeEthernet

call(selector: str, input_parameters: IDictionary, transport_protocol: str = None, timeout: float = 1) → IDictionary

Calls a consumed method to send SOME/IP message and return the output parameters. Follows an example RBS Scripting in documentation for more info.

Parameters

selector (str) – selector can be service_id_or_name.method_id_or_name
input_parameters (IDictionary) – dictionary contains the input parameters of a method and its default values
transport_protocol (str) – the protocol of the service. It can be UDP or TCP
timeout (float) – timout of response message in seconds

Returns

A dictionary contains the output parameters of a method and its values

Return type

IDictionary

disable(selector: str)

Disables a service, a method, an event or a field of the ecu.

Parameters: selector (str) – selector can be service_id_or_name and it can be service_id_or_name.member_id_or_name

enable(selector: str)

Enables a service, a method, an event or a field of the ecu.

Parameters: selector (str) – selector can be service_id_or_name and it can be service_id_or_name.member_id_or_name

get_config(config_path: str, config_property: str) → decimal

Gets the value of a specified config.

Parameters

config_path (str) – The config_path is service_name_or_id @ instance_id
config_property (str) – The config_property is port

Returns

The value of a specified config.

Return type

decimal

get_mac(ip: str) → str

Finds the specific device with the specific IP address provided from the map and returns its MAC address.

Parameters: ip (str) – Desired IP address.
Returns: MAC address found.
Return type: str

get_value(path: str, member: str = None) → object

Gets the value of a specific child of the ecu.

Parameters

path (str) – The path to the child. follows a specific path format see RBS Notations in documentation for more info
member (str) – [optional] The name of the member in the child, empty or None means the entire child value will be returned.

Returns

The value of the child (member if member is not None)

Return type

object

reset() → bool

Resets the ECU.

Returns: True if the operation was successful, False otherwise.
Return type: bool

reset(service_id: uint16, instance_id: uint16) → bool

Attempts to reset the ECU node.

Parameters

service_id (uint16) – Service identifier.
instance_id (uint16) – Instance identifier.

Returns

True if reset was successful, False if not.

Return type

bool

reset_value(path: str = None, member: str = None)

Resets the value of a specific child of the ecu to the default value.

Parameters

path (str) – The path to the child. follows a specific path format see RBS Notations in documentation for more info.empty or None means the entire elements of the node will be reset.
member (str) – [optional] The name of the member in the child, empty or None means the entire child value will be reset.

set_config(config_path: str, config_property: str, value: decimal)

Sets the value of a specified config.

Parameters

config_path (str) – The config_path is service_name_or_id @ instance_id
config_property (str) – The config_property is port
value (decimal) – The config value

set_mac(mac: str, p: str)

Sets the mac address (if empty) of the desired device by IP from the MAC/IP map.

Parameters

mac (str) – Desired MAC address.
p (str) – Desired IP addresses

set_value(path: str, value: object)

Sets the value of a specific child of the ecu to a specific value.

Parameters

path (str) – The path to the child. follows a specific path format see RBS Notations in documentation for more info.
value (object) – The value of the child/member to be set, None means default value.

set_value(path: str, member: str, value: object)

Sets the value of a specific child of the ecu to a specific value.

Parameters

path (str) – The path to the child. follows a specific path format see RBS Notations in documentation for more info.
member (str) – The name of the member in the child, None means the entire child value will be set (use set_values(path, value) instead).
value (object) – The value of the child/member to be set, None means default value.

start(): Starts the ECU

stop(): Stops the ECU.

trigger(selector: str, transport_protocol: str = None)

Triggers an enabled provided field or event of the ecu to send SOME/IP message. Follows an example RBS Scripting in documentation for more info.

Parameters

selector (str) – selector is service_id_or_name.instance_id.member_id_or_name
transport_protocol (str) – the protocol of the service. It can be UDP or TCP

@on_method_called(sender: object, e: MethodCalledArgs)