diff --git a/documentation/doip.md b/documentation/doip.md index f9d089f..1ebe5ce 100644 --- a/documentation/doip.md +++ b/documentation/doip.md @@ -1,6 +1,8 @@ # DoIP - Diagnostic communication over Internet Protocol This module can be used to enumerate and perform security testing on DoIP upon the ISO 13400-2. It is mainly build targeting the UDSonIP (ISO 14229-5) protocol implementation in Caring Caribou, but it is supposed to be extended for further DoIP testing even outside of the UDS implementation. +*Note: This module requires the packages `doipclient` and `udsoncan`, which only support Python 3.6+. These can be installed through `$ pip install doipclient udsoncan`. If your system uses Python 2 as default python interpreter, you may have to use `$ pip3 install doipclient udsoncan` or `$ python3 -m pip install doipclient udsoncan` (and make sure to run Caring Caribou through `python3`) instead.* + The UDS protocol uses a server-client model, where the client (e.g. a diagnostics tool or Caring Caribou) sends requests on a specific arbitration ID, which a server (ECU) listens to. The server sends responses on another specific arbitration ID. Supported modes: