Purpose

Returns a table of all DoIP entities (vehicles) on the local subnet, possibly restricted to EID or VIN. Format

Input

Broadcast Address is the subnet address to send the request to. It defaults to 255.255.255.255 (broadcast on the default Network Interface Controller), but can be overridden to specify a specific broadcast address, e.g. on a specific Network Interface Controller).
Diag reference in specifies the diagnostic session handle, obtained from Open Diagnostic on IP.vi and wired through subsequent diagnostic VIs. Normally, it is not necessary to manually manipulate the elements of this cluster.
DoIP Open Type is a U16 ring. It defines which DoIP entities this command queries and lists. Allowed values are VIN, EID, and All.
VIN or EID depends on the DoIP Open Type:
DoIP Open TypeVIN or EID Value
VINVIN or EID is a 17-character Vehicle Identification Number. Only DoIP entities for this VIN are listed.
EIDVIN or EID is an Entity ID (usually a MAC address). Only the DoIP entity with this ID is listed. Specify the EID as xx-xx-xx-xx-xx-xx, where each x is a hexadecimal digit.
AllVIN or EID is ignored.
error in is a cluster that describes error conditions occurring before the VI executes. If an error has already occurred, the VI returns the value of the error in cluster to error out.
status is TRUE if an error occurred. This VI is not executed when status is TRUE.
code is the error code number identifying an error. A value of 0 means success. A negative value means error: the VI did not execute the intended operation. A positive value means warning: the VI executed intended operation, but an informational warning is returned. For a description of the code, wire the error cluster to a LabVIEW error-handling VI, such as the Simple Error Handler.
source identifies the VI where the error occurred.
All Versions specifies whether the request is sent with 0xFF as the protocol version in the Generic DoIP header. The default is TRUE.

If the protocol version in Open Diagnostic on IP.vi is set to 2010, this flag is ignored and the request is always sent with the protocol version byte of the header set to 1.

Output

Diag reference out is a copy of Diag reference in. You can wire it to subsequent diagnostic VIs.
DoIP Entities is an array of clusters, each of which contains the description of one DoIP entity that responded to the command:
VIN is the 17-character Vehicle Identification Number of the DoIP entity. It can be blank if the DoIP entity does not yet belong to a vehicle.
Source Address is the 16-bit DoIP address of this entity. This address can distinguish multiple DoIP entities within a vehicle.
EID is a 6-byte array of the Entity ID, which is usually the DoIP device MAC address.
GID is a unique 6-byte group identification of DoIP entities that belong to the same vehicle. It is used as long as a VIN is not yet defined.
IP Address is the IP Address of this DoIP entity in a.b.c.d notation. Use this IP address to connect to the DoIP entity using DoIP Connect.vi.
error out describes error conditions. If the error in cluster indicated an error, the error out cluster contains the same information. Otherwise, error out describes the error status of this VI.
status is TRUE if an error occurred.
code is the error code number identifying an error. A value of 0 means success. A negative value means error: the VI did not execute the intended operation. A positive value means warning: the VI executed intended operation, but an informational warning is returned. For a description of the code, wire the error cluster to a LabVIEW error-handling VI, such as the Simple Error Handler.
source identifies the VI where the error occurred.

Description

DoIP Get Entities.vi uses a UDP broadcast to identify all DoIP entities in the local subnet matching a certain condition. The entities responding are returned in the DoIP Entities cluster array.

The conditions are either a common VIN or EID or simply all entities connected. Refer to the DoIP Open Type and VIN or EID descriptions.