DoIpSettings

class DoIpSettings
Clone()

Call this method if you want to use API-objects in multiple contexts, e.g. if you want to insert a specific test step in multiple blocks.

Returns:

A copy of this object

Return type:

DoIpSettings

GetActivateRouting()

Returns the ActivateRouting.

Specifies whether the DoIP entity should forward diagnostic messages to an internal device.

Returns:

ActivateRouting

Return type:

bool

GetActivationType()

Returns the ActivationType.

Here: Only the byte sequence in format “AA:BB:01”.

The type of routing activation if routing is to be activated. - ByteStream (e.g. 00 -> default, 01 -> WWH-OBD, E0 -> Central Security, further values can be taken from the standard)

Returns:

ActivationType

Return type:

str

GetDiagTimeoutDoIp()

Returns the DiagTimeoutDoIp.

Timeout in milliseconds when waiting for responses on diagnostic requests via the DoIP protocol - Integer

Returns:

DiagTimeoutDoIp

Return type:

int

GetDoIpVersion()

Returns the DoIpVersion.

The version of the DoIP protocol used - Integer

Returns:

DoIpVersion

Return type:

int

GetEID()

Returns the EID.

Here: Only the byte sequence in format “AA:BB:01”.

ID of the DoIP entity to which a connection is to be established. If specified, a vehicle identification request is sent to this ID to establish the connection. If not, a general vehicle identification request is sent and a connection is established to the first responding ECU. - ByteStream

Returns:

EID

Return type:

str

GetListenPort()

Returns the ListenPort.

The port on which to wait for responses from the DoIp entity. (Only relevant for UDP messages during connection setup, 0 -> the port is selected automatically) - Integer

Returns:

ListenPort

Return type:

int

GetRemotePort()

Returns the RemotePort.

The port on which the DoIp Entity shall receive diagnostic messages - Integer

Returns:

RemotePort

Return type:

int

GetSourceAddress()

Returns the SourceAddress.

Here: Only the byte sequence in format “AA:BB:01”.

The diagnostic address from which diagnostic messages are sent - ByteStream

Returns:

SourceAddress

Return type:

str

GetTargetAddress()

Returns the TargetAddress.

Here: Only the byte sequence in format “AA:BB:01”.

The diagnostic address of the DoIP entity. If specified, no vehicle identification request is sent and UDS requests are sent directly to this address. - ByteStream

Returns:

TargetAddress

Return type:

str

GetTargetIp()

Returns the TargetIp.

IP address of the DoIP entity - String

Returns:

TargetIp

Return type:

str

SetActivateRouting(value)

Sets the ActivateRouting.

Specifies whether the DoIP entity should forward diagnostic messages to an internal device.

Parameters:
value : bool

ActivateRouting

SetActivationType(value)

Sets the ActivationType.

Here: Only the byte sequence in format “AA:BB:01”.

The type of routing activation if routing is to be activated. - ByteStream (e.g. 00 -> default, 01 -> WWH-OBD, E0 -> Central Security, further values can be taken from the standard)

Parameters:
value : str

ActivationType

SetDiagTimeoutDoIp(value)

Sets the DiagTimeoutDoIp.

Timeout in milliseconds when waiting for responses on diagnostic requests via the DoIP protocol - Integer

Parameters:
value : int

DiagTimeoutDoIp

SetDoIpVersion(value)

Sets the DoIpVersion.

The version of the DoIP protocol used - Integer

Parameters:
value : int

DoIpVersion

SetEID(value)

Sets the EID.

Here: Only the byte sequence in format “AA:BB:01”.

ID of the DoIP entity to which a connection is to be established. If specified, a vehicle identification request is sent to this ID to establish the connection. If not, a general vehicle identification request is sent and a connection is established to the first responding ECU. - ByteStream

Parameters:
value : str

EID

SetListenPort(value)

Sets the ListenPort.

The port on which to wait for responses from the DoIp entity. (Only relevant for UDP messages during connection setup, 0 -> the port is selected automatically) - Integer

Parameters:
value : int

ListenPort

SetRemotePort(value)

Sets the RemotePort.

The port on which the DoIp Entity shall receive diagnostic messages - Integer

Parameters:
value : int

RemotePort

SetSourceAddress(value)

Sets the SourceAddress.

Here: Only the byte sequence in format “AA:BB:01”.

The diagnostic address from which diagnostic messages are sent - ByteStream

Parameters:
value : str

SourceAddress

SetTargetAddress(value)

Sets the TargetAddress.

Here: Only the byte sequence in format “AA:BB:01”.

The diagnostic address of the DoIP entity. If specified, no vehicle identification request is sent and UDS requests are sent directly to this address. - ByteStream

Parameters:
value : str

TargetAddress

SetTargetIp(value)

Sets the TargetIp.

IP address of the DoIP entity - String

Parameters:
value : str

TargetIp