DoIP/UDS Guide

AutoPi

Intellectual Property of AutoPi.io - All rights reserved. No redistribution allowed without the consent of the
author. If you have any questions about this document, please contact: 1/11
[email protected]
Table of Contents
1 Revision History 3

2 DoIP/UDS Guide 4

3 DoIP Service Configuration 5

4 DoIP Command Usage 6

4.1 Interface Command 7
4.2 UDS Command 9

Intellectual Property of AutoPi.io - All rights reserved. No redistribution allowed without the consent of the
author. If you have any questions about this document, please contact: 2/11
[email protected]
1 Revision History

Revision Change Author Date

1.0 Initial revision HNI 11/12/2020

Intellectual Property of AutoPi.io - All rights reserved. No redistribution allowed without the consent of the
author. If you have any questions about this document, please contact: 3/11
[email protected]
2 DoIP/UDS Guide

Below extension board is pre-installed in the AutoPi device.

As default, the board is configured to use OBD-II connector pins 3 and 11 for ethernet RX (position
B​). By switching to position ​A​ the OBD-II connector pins 1 and 9 are used for ethernet RX.

The following software components have been installed on the DoIP device:
● udsoncan​ library backported to Python 2.7 (​https://github.com/autopi-io/py-udsoncan​).
● doip_manager​ AutoPi service managed through AutoPi Cloud (my.autopi.io). This service
uses the above library for UDS communication over ethernet.
● doip​ AutoPi command also managed through AutoPi Cloud (my.autopi.io). This command
enables communication with the above service.

Intellectual Property of AutoPi.io - All rights reserved. No redistribution allowed without the consent of the
author. If you have any questions about this document, please contact: 4/11
[email protected]
3 DoIP Service Configuration
The ​doip_manager​ AutoPi service needs to have specified below settings:
● host​ can be either IP address or hostname to connect to. Default is 127.0.0.1 if not specified.
● port​ is default 13400.

The settings are specified on the AutoPi Cloud (my.autopi.io) in JSON format. Example:

NOTE​: After changes have been saved they must be synchronized to the device in order to take
effect.

Intellectual Property of AutoPi.io - All rights reserved. No redistribution allowed without the consent of the
author. If you have any questions about this document, please contact: 5/11
[email protected]
4 DoIP Command Usage
With the ​doip​ AutoPi command it is possible to manage the DoIP connection and query UDS
services.

By running ​doip.help​ in the command terminal, documentation for all DoIP related commands are
displayed:

Intellectual Property of AutoPi.io - All rights reserved. No redistribution allowed without the consent of the
author. If you have any questions about this document, please contact: 6/11
[email protected]
4.1 Interface Command
The ​doip.interface​ command will display the current state of the interface and underlying
connection:

Intellectual Property of AutoPi.io - All rights reserved. No redistribution allowed without the consent of the
author. If you have any questions about this document, please contact: 7/11
[email protected]
It is also possible to list all available subcommands by running ​doip.interface help​:

● activate​ will ensure the OBD-II connector pin 8 is high.

● deactivate​ will ensure the OBD-II connector pin 8 is low.
● connect​ will open a TCP socket connection to the configured host.
● disconnect​ will close the TCP socket connection.
● reconnect​ will close then open the TCP socket connection.

Intellectual Property of AutoPi.io - All rights reserved. No redistribution allowed without the consent of the
author. If you have any questions about this document, please contact: 8/11
[email protected]
4.2 UDS Command
With the ​doip.uds​ command it is possible to query UDS requests and get back responses
synchronously.

To list all available UDS functions run the command ​doip.uds help​:

To see documentation for an individual UDS function run ​doip.uds help change_session​.

Example of running a specific UDS function and the received response:

Intellectual Property of AutoPi.io - All rights reserved. No redistribution allowed without the consent of the
author. If you have any questions about this document, please contact: 9/11
[email protected]
FYI: The above example is performed using a primitive UDS simulator running on a PC connected to
the AutoPi device with a custom OBD-II to ethernet cable:

Intellectual Property of AutoPi.io - All rights reserved. No redistribution allowed without the consent of the
author. If you have any questions about this document, please contact: 10/11
[email protected]
Intellectual Property of AutoPi.io - All rights reserved. No redistribution allowed without the consent of the
author. If you have any questions about this document, please contact: 11/11
[email protected]