Skip to content

Commit 05e7d52

Browse files
committed
Minor doc updates
1 parent ebbfe7e commit 05e7d52

File tree

2 files changed

+38
-3
lines changed

2 files changed

+38
-3
lines changed

doc/source/udsoncan/questions_answers.rst

+28-2
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ What version of the standard has been used?
66

77
.. epigraph::
88

9-
The code was originally written based on ISO-14229:2006. Some addition from the 2013 and 2020 version has been added, but not exhaustively.
9+
The code was originally written based on ISO-14229:2006. Many additions from the 2013 and 2020 version have been added, but not exhaustively.
1010

1111

1212
How reliable is this code?
@@ -17,7 +17,7 @@ How reliable is this code?
1717
To the best of my knowledge, quite good. This project comes with a fair amount of unit tests, many based on examples proposed in the UDS standard document.
1818
Every service encoding/decoding is unit-tested.
1919

20-
The project is fully type-hinted and passes static type check using the `mypy` module
20+
The project is fully type-hinted and passes static type check using the ``mypy`` module
2121

2222
Only a few common services have been tested on a real ECU by the author, but many users are using the library successfully, including some major OEM.
2323

@@ -80,6 +80,7 @@ How can I contribute?
8080
.. epigraph::
8181

8282
Create a Github issue, fork the project, propose a pull request and I will review it; that's the best way.
83+
Unit tests and static analysis are required to pass for a change to be accepted
8384

8485
-----
8586

@@ -98,3 +99,28 @@ My IsoTPSocketConnection raises an error after updating udsoncan
9899
99100
# After 1.21
100101
IsoTPSocketConnection('vcan0', isotp.Address(isotp.AddressingMode.Normal_11bits, rxid=123, txid=456))
102+
103+
-----
104+
105+
Can this project be used on something else than a CAN bus?
106+
----------------------------------------------------------
107+
108+
.. epigraph::
109+
110+
Absolutely, the library completely abstract the transport protocol as detailed in the :ref:`Connection<Connection>` page.
111+
The name UDSonCAN can be misleading in that regard. I chosed that name many years ago and I am stuck with it now.
112+
113+
-----
114+
115+
Where can I find more information about UDS?
116+
--------------------------------------------
117+
118+
.. epigraph::
119+
120+
The best source of information is the standard itself `ISO-14229 <https://www.iso.org/standard/72439.html>`_ and
121+
`ISO-15765 <https://www.iso.org/standard/84211.html>`_ for the transport layer.
122+
123+
Other open source projects also provides a faire amount of information, see `py-uds knowledge base <https://uds.readthedocs.io/en/stable/pages/knowledge_base.html>`_
124+
125+
Finally, many commercial vendors such as Peak and Vector provide details about UDS in their documentation.
126+

udsoncan/services/Authentication.py

+10-1
Original file line numberDiff line numberDiff line change
@@ -47,37 +47,46 @@ class Authentication(BaseService):
4747
class ResponseData(BaseResponseData):
4848
"""
4949
.. data:: authentication_task_echo
50+
5051
Authentication Task echoed back by the server
5152
5253
.. data:: return_value
53-
:ref:`AuthenticationReturnParameter<AuthenticationReturnParameter>` authenticationReturnParameter as defined in
54+
55+
:class:`AuthenticationReturnParameter<AuthenticationReturnParameter>` as defined in
5456
B.5. (ISO 14229-1:2020)
5557
5658
.. data:: challenge_server
59+
5760
The challenge contains vehicle manufacturer specific formatted server data (eventually containing randomized
5861
information) or is a random number.
5962
6063
.. data:: ephemeral_public_key_server
64+
6165
Ephemeral public key generated by the server for Diffie-Hellman key agreement.
6266
6367
.. data:: certificate_server
68+
6469
The Certificate to verify.
6570
6671
.. data:: proof_of_ownership_server
72+
6773
Proof of Ownership to be verified by the client.
6874
6975
.. data:: session_key_info
76+
7077
If present, this value shall contain session key information, e.g. the encrypted session key(s) for securing
7178
further communication in the actual session and/or proof value(s) (e.g. a hash value) for the validation of the
7279
session key(s) on the client side.
7380
7481
.. data:: algorithm_indicator
82+
7583
Indicates the algorithm used in the generating and verifying Proof of Ownership (POWN), which further determines
7684
the parameters used in the algorithm and possibly the session key creation mode. This field is a 16 byte value
7785
containing the BER encoded OID value of the algorithm used. The value is left aligned and right padded with
7886
zero up to 16 bytes.
7987
8088
.. data:: needed_additional_parameter
89+
8190
Indicate what additional parameters, if needed, are expected by the server.
8291
"""
8392
authentication_task_echo: int

0 commit comments

Comments
 (0)