ISomeIPMessageManager

Summary

Represents a SOME/IP message manager.

See also

MessageSomeIP

Methods
Properties

Structure

class ISomeIPMessageManager
fire_event(service_id: uint16, instance_id: uint16, event_id: uint16, transport_protocol: str = None) bool

Attempts to fire an event.

Parameters
  • service_id (uint16) – The provided service id.

  • instance_id (uint16) – The provided service instance id.

  • event_id (uint16) – The event id to fire.

  • transport_protocol (str) – the protocol of the event. It can be UDP or TCP

Returns

True if the operation was successful, False otherwise.

Return type

bool

fire_field(service_id: uint16, instance_id: uint16, notifier_id: uint16, param: Array[object]) bool

Attempts to fire a field.

Parameters
  • service_id (uint16) – The provided service id.

  • instance_id (uint16) – The provided service instance id.

  • notifier_id (uint16) – The notifier id to fire.

  • param (Array[object]) – A list of the parameters of the node.

Returns

True if the operation was successful, False otherwise.

Return type

bool

fire_field(service_id: uint16, instance_id: uint16, notifier_id: uint16, transport_protocol: str = None) bool

Attempts to fire a field.

Parameters
  • service_id (uint16) – The provided service id.

  • instance_id (uint16) – The provided service instance id.

  • notifier_id (uint16) – The notifier id to fire.

  • transport_protocol (str) – the protocol of the field. It can be UDP or TCP

Returns

True if the operation was successful, False otherwise.

Return type

bool

request_event(service_id: uint16, instance_id: uint16, event_id: uint16) bool

Attempt to send an event request on a specific subscribed service.

Parameters
  • service_id (uint16) – The subscribed service id.

  • instance_id (uint16) – The subscribed service instance id.

  • event_id (uint16) – The event id.

Returns

True if the operation was successful, False otherwise.

Return type

bool

send_getter(service_id: uint16, instance_id: uint16, getter_id: uint16) bool

Attempt to send a setter on a specific subscribed service.

Parameters
  • service_id (uint16) – The subscribed service id.

  • instance_id (uint16) – The subscribed service instance id.

  • getter_id (uint16) – The getter id.

Returns

True if the operation was successful, False otherwise.

Return type

bool

send_setter(service_id: uint16, instance_id: uint16, setter_id: uint16) bool

Attempt to send a setter on a specific subscribed service.

Parameters
  • service_id (uint16) – The subscribed service id.

  • instance_id (uint16) – The subscribed service instance id.

  • setter_id (uint16) – The setter id.

Returns

True if the operation was successful, False otherwise.

Return type

bool

start()

Starts the ECU

stop()

Stops the ECU.

ecu_node

The ECU node of the manager.

Type

EcuNodeEthernet

is_started

Checks whether the Ethernet ECU RBS is running.

Type

bool