Skip to content

Commit

Permalink
Prepare for new release (#283)
Browse files Browse the repository at this point in the history 
New release
  • Loading branch information
@mdabrowski1990
mdabrowski1990 authored Oct 3, 2024
1 parent 5be8710 commit c65a445
Show file tree
Hide file tree
Showing 5 changed files with 28 additions and 17 deletions.
15 changes: 10 additions & 5 deletions docs/source/index.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,16 @@ Welcome to UDS documentation!

Overview
--------
The purpose of this project is to provide python tools for simulation (on both sides - client and server) and
monitoring of diagnostic communication defined by ISO-14229. It can be used with any bus type (e.g. CAN, Ethernet, LIN).
The purpose of this project is to provide python tool to handle
`Unified Diagnostic Services (UDS) <https://en.wikipedia.org/wiki/Unified_Diagnostic_Services>`_ protocol defined
by ISO-14229. The created package helps to simulate either communication side (client or server), monitoring
and decode diagnostic communication.

The architecture enables to use it with various communication buses (e.g. CAN, LIN).

The most likely use cases of this package are:
- communication with your vehicle (e.g. reading Diagnostic Trouble Codes)
- monitoring and decoding ongoing UDS communication
- monitoring and decoding UDS communication
- performing tests against on-board ECU (server)
- performing tests against OBD Tester (client)

Expand All @@ -44,7 +48,8 @@ Current implementation status of package features:
| UDS Packets Reception and Transmission | Available since version `0.3.0 |
| | <https://pypi.org/project/py-uds/0.3.0/>`_ |
+----------------------------------------------+--------------------------------------------+
| UDS Messages Reception and Transmission | Planned |
| UDS Messages Reception and Transmission | Available since version `1.0.0 |
| | <https://pypi.org/project/py-uds/1.0.0/>`_ |
+----------------------------------------------+--------------------------------------------+
| Messages Segmentation | Available since version `0.2.0 |
| | <https://pypi.org/project/py-uds/0.2.0/>`_ |
Expand All @@ -69,7 +74,7 @@ Current implementation status of support for communication buses:
+----------+-----------------------+
| Bus | Implementation Status |
+==========+=======================+
| CAN | Partial |
| CAN | Full |
+----------+-----------------------+
| FlexRay | Planned |
+----------+-----------------------+
Expand Down
2 changes: 1 addition & 1 deletion docs/source/tables/bus_implementation_status.tgn
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"rows_views":[[{"style":{"borders":"lrtb","font_style":{},"text_color":"","bg_color":"","halign":"center","valign":"top","padding":{"top":10,"right":5,"bottom":10,"left":5},"border_color":""}},{"style":{"borders":"lrtb","font_style":{},"text_color":"","bg_color":"","halign":"center","valign":"top","padding":{"top":10,"right":5,"bottom":10,"left":5},"border_color":""}}],[{"style":{"borders":"lrtb","font_style":{},"text_color":"","bg_color":"","halign":"left","valign":"top","padding":{"top":10,"right":5,"bottom":10,"left":5},"border_color":""}},{"style":{"borders":"lrtb","font_style":{},"text_color":"","bg_color":"","halign":"left","valign":"top","padding":{"top":10,"right":5,"bottom":10,"left":5},"border_color":""}}],[{"style":{"borders":"lrtb","font_style":{},"text_color":"","bg_color":"","halign":"left","valign":"top","padding":{"top":10,"right":5,"bottom":10,"left":5},"border_color":""}},{"style":{"borders":"lrtb","font_style":{},"text_color":"","bg_color":"","halign":"left","valign":"top","padding":{"top":10,"right":5,"bottom":10,"left":5},"border_color":""}}],[{"style":{"borders":"lrtb","font_style":{},"text_color":"","bg_color":"","halign":"left","valign":"top","padding":{"top":10,"right":5,"bottom":10,"left":5},"border_color":""}},{"style":{"borders":"lrtb","font_style":{},"text_color":"","bg_color":"","halign":"left","valign":"top","padding":{"top":10,"right":5,"bottom":10,"left":5},"border_color":""}}],[{"style":{"borders":"lrtb","font_style":{},"text_color":"","bg_color":"","halign":"left","valign":"top","padding":{"top":10,"right":5,"bottom":10,"left":5},"border_color":""}},{"style":{"borders":"lrtb","font_style":{},"text_color":"","bg_color":"","halign":"left","valign":"top","padding":{"top":10,"right":5,"bottom":10,"left":5},"border_color":""}}],[{"style":{"borders":"lrtb","font_style":{},"text_color":"","bg_color":"","halign":"left","valign":"top","padding":{"top":10,"right":5,"bottom":10,"left":5},"border_color":""}},{"style":{"borders":"lrtb","font_style":{},"text_color":"","bg_color":"","halign":"left","valign":"top","padding":{"top":10,"right":5,"bottom":10,"left":5},"border_color":""}}]],"model":{"rows":[[{"value":"Bus","cspan":1,"rspan":1,"markup":[1,3]},{"value":"Implementation Status","cspan":1,"rspan":1,"markup":[1,21]}],[{"value":"CAN","cspan":1,"rspan":1,"markup":[1,3]},{"value":"Partial","cspan":1,"rspan":1,"markup":[1,7]}],[{"value":"FlexRay","cspan":1,"rspan":1,"markup":[1,7]},{"value":"Planned","cspan":1,"rspan":1,"markup":[1,7]}],[{"value":"Ethernet","cspan":1,"rspan":1,"markup":[1,8]},{"value":"Planned","cspan":1,"rspan":1,"markup":[1,7]}],[{"value":"K-Line","cspan":1,"rspan":1,"markup":[1,6]},{"value":"Planned","cspan":1,"rspan":1,"markup":[1,7]}],[{"value":"LIN","cspan":1,"rspan":1,"markup":[1,3]},{"value":"Planned","cspan":1,"rspan":1,"markup":[1,7]}]]},"theme":null,"fixed_layout":false,"markup":{"instances":[{},{"style":{"fontWeight":"","fontStyle":"","textDecoration":"","color":"","backgroundColor":""}}]},"options":{}}
{"rows_views":[[{"style":{"borders":"lrtb","font_style":{},"text_color":"","bg_color":"","halign":"center","valign":"top","padding":{"top":10,"right":5,"bottom":10,"left":5},"border_color":""}},{"style":{"borders":"lrtb","font_style":{},"text_color":"","bg_color":"","halign":"center","valign":"top","padding":{"top":10,"right":5,"bottom":10,"left":5},"border_color":""}}],[{"style":{"borders":"lrtb","font_style":{},"text_color":"","bg_color":"","halign":"left","valign":"top","padding":{"top":10,"right":5,"bottom":10,"left":5},"border_color":""}},{"style":{"borders":"lrtb","font_style":{},"text_color":"","bg_color":"","halign":"left","valign":"top","padding":{"top":10,"right":5,"bottom":10,"left":5},"border_color":""}}],[{"style":{"borders":"lrtb","font_style":{},"text_color":"","bg_color":"","halign":"left","valign":"top","padding":{"top":10,"right":5,"bottom":10,"left":5},"border_color":""}},{"style":{"borders":"lrtb","font_style":{},"text_color":"","bg_color":"","halign":"left","valign":"top","padding":{"top":10,"right":5,"bottom":10,"left":5},"border_color":""}}],[{"style":{"borders":"lrtb","font_style":{},"text_color":"","bg_color":"","halign":"left","valign":"top","padding":{"top":10,"right":5,"bottom":10,"left":5},"border_color":""}},{"style":{"borders":"lrtb","font_style":{},"text_color":"","bg_color":"","halign":"left","valign":"top","padding":{"top":10,"right":5,"bottom":10,"left":5},"border_color":""}}],[{"style":{"borders":"lrtb","font_style":{},"text_color":"","bg_color":"","halign":"left","valign":"top","padding":{"top":10,"right":5,"bottom":10,"left":5},"border_color":""}},{"style":{"borders":"lrtb","font_style":{},"text_color":"","bg_color":"","halign":"left","valign":"top","padding":{"top":10,"right":5,"bottom":10,"left":5},"border_color":""}}],[{"style":{"borders":"lrtb","font_style":{},"text_color":"","bg_color":"","halign":"left","valign":"top","padding":{"top":10,"right":5,"bottom":10,"left":5},"border_color":""}},{"style":{"borders":"lrtb","font_style":{},"text_color":"","bg_color":"","halign":"left","valign":"top","padding":{"top":10,"right":5,"bottom":10,"left":5},"border_color":""}}]],"model":{"rows":[[{"value":"Bus","cspan":1,"rspan":1,"markup":[1,3]},{"value":"Implementation Status","cspan":1,"rspan":1,"markup":[1,21]}],[{"value":"CAN","cspan":1,"rspan":1,"markup":[1,3]},{"value":"Full","cspan":1,"rspan":1,"markup":[1,4]}],[{"value":"FlexRay","cspan":1,"rspan":1,"markup":[1,7]},{"value":"Planned","cspan":1,"rspan":1,"markup":[1,7]}],[{"value":"Ethernet","cspan":1,"rspan":1,"markup":[1,8]},{"value":"Planned","cspan":1,"rspan":1,"markup":[1,7]}],[{"value":"K-Line","cspan":1,"rspan":1,"markup":[1,6]},{"value":"Planned","cspan":1,"rspan":1,"markup":[1,7]}],[{"value":"LIN","cspan":1,"rspan":1,"markup":[1,3]},{"value":"Planned","cspan":1,"rspan":1,"markup":[1,7]}]]},"theme":null,"fixed_layout":false,"markup":{"instances":[{},{"style":{"fontWeight":"","fontStyle":"","textDecoration":"","color":"","backgroundColor":""}}]},"options":{}}
2 changes: 1 addition & 1 deletion docs/source/tables/features_implementation_status.tgn
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"rows_views":[[{"style":{"borders":"lrtb","font_style":{},"text_color":"","bg_color":"","halign":"center","valign":"top","padding":{"top":10,"right":5,"bottom":10,"left":5},"border_color":""}},{"style":{"borders":"lrtb","font_style":{},"text_color":"","bg_color":"","halign":"center","valign":"top","padding":{"top":10,"right":5,"bottom":10,"left":5},"border_color":""}}],[{"style":{"borders":"lrtb","font_style":{},"text_color":"","bg_color":"","halign":"left","valign":"top","padding":{"top":10,"right":5,"bottom":10,"left":5},"border_color":""}},{"style":{"borders":"lrtb","font_style":{},"text_color":"","bg_color":"","halign":"left","valign":"top","padding":{"top":10,"right":5,"bottom":10,"left":5},"border_color":""}}],[{"style":{"borders":"lrtb","font_style":{},"text_color":"","bg_color":"","halign":"left","valign":"top","padding":{"top":10,"right":5,"bottom":10,"left":5},"border_color":""}},{"style":{"borders":"","font_style":{},"text_color":"","bg_color":"","halign":"left","valign":"top","padding":{"top":10,"right":5,"bottom":10,"left":5},"border_color":""}}],[{"style":{"borders":"lrtb","font_style":{},"text_color":"","bg_color":"","halign":"left","valign":"top","padding":{"top":10,"right":5,"bottom":10,"left":5},"border_color":""}},{"style":{"borders":"lrtb","font_style":{},"text_color":"","bg_color":"","halign":"left","valign":"top","padding":{"top":10,"right":5,"bottom":10,"left":5},"border_color":""}}],[{"style":{"borders":"lrtb","font_style":{},"text_color":"","bg_color":"","halign":"left","valign":"top","padding":{"top":10,"right":5,"bottom":10,"left":5},"border_color":""}},{"style":{"borders":"lrtb","font_style":{},"text_color":"","bg_color":"","halign":"left","valign":"top","padding":{"top":10,"right":5,"bottom":10,"left":5},"border_color":""}}],[{"style":{"borders":"lrtb","font_style":{},"text_color":"","bg_color":"","halign":"left","valign":"top","padding":{"top":10,"right":5,"bottom":10,"left":5},"border_color":""}},{"style":{"borders":"","font_style":{},"text_color":"","bg_color":"","halign":"left","valign":"top","padding":{"top":10,"right":5,"bottom":10,"left":5},"border_color":""}}],[{"style":{"borders":"lrtb","font_style":{},"text_color":"","bg_color":"","halign":"left","valign":"top","padding":{"top":10,"right":5,"bottom":10,"left":5},"border_color":""}},{"style":{"borders":"lrtb","font_style":{},"text_color":"","bg_color":"","halign":"left","valign":"top","padding":{"top":10,"right":5,"bottom":10,"left":5},"border_color":""}}],[{"style":{"borders":"lrtb","font_style":{},"text_color":"","bg_color":"","halign":"left","valign":"top","padding":{"top":10,"right":5,"bottom":10,"left":5},"border_color":""}},{"style":{"borders":"","font_style":{},"text_color":"","bg_color":"","halign":"left","valign":"top","padding":{"top":10,"right":5,"bottom":10,"left":5},"border_color":""}}],[{"style":{"borders":"lrtb","font_style":{},"text_color":"","bg_color":"","halign":"left","valign":"top","padding":{"top":10,"right":5,"bottom":10,"left":5},"border_color":""}},{"style":{"borders":"lrtb","font_style":{},"text_color":"","bg_color":"","halign":"left","valign":"top","padding":{"top":10,"right":5,"bottom":10,"left":5},"border_color":""}}],[{"style":{"borders":"lrtb","font_style":{},"text_color":"","bg_color":"","halign":"left","valign":"top","padding":{"top":10,"right":5,"bottom":10,"left":5},"border_color":""}},{"style":{"borders":"lrtb","font_style":{},"text_color":"","bg_color":"","halign":"left","valign":"top","padding":{"top":10,"right":5,"bottom":10,"left":5},"border_color":""}}]],"model":{"rows":[[{"value":"Feature","cspan":1,"rspan":1,"markup":[1,7]},{"value":"Implementation Status","cspan":1,"rspan":1,"markup":[1,21]}],[{"value":"UDS Messages and Packets","cspan":1,"rspan":1,"markup":[1,24]},{"value":"Available since version `0.0.2\n<https://pypi.org/project/py-uds/0.0.2/>`_","cspan":1,"rspan":1,"markup":[1,73]}],[{"value":"UDS Packets Reception and Transmission","cspan":1,"rspan":1,"markup":[1,38]},{"value":"Available since version `0.3.0\n<https://pypi.org/project/py-uds/0.3.0/>`_","cspan":1,"rspan":1,"markup":[1,73]}],[{"value":"UDS Messages Reception and Transmission","cspan":1,"rspan":1,"markup":[1,39]},{"value":"Planned","cspan":1,"rspan":1,"markup":[1,7]}],[{"value":"Messages Segmentation","cspan":1,"rspan":1,"markup":[1,21]},{"value":"Available since version `0.2.0\n<https://pypi.org/project/py-uds/0.2.0/>`_","cspan":1,"rspan":1,"markup":[1,73]}],[{"value":"UDS Packets Desegmentation","cspan":1,"rspan":1,"markup":[1,26]},{"value":"Available since version `0.2.0\n<https://pypi.org/project/py-uds/0.2.0/>`_","cspan":1,"rspan":1,"markup":[1,73]}],[{"value":"Support for Services with multiple responses","cspan":1,"rspan":1,"markup":[1,44]},{"value":"Planned","cspan":1,"rspan":1,"markup":[1,7]}],[{"value":"Client Simulation","cspan":1,"rspan":1,"markup":[1,17]},{"value":"Planned","cspan":1,"rspan":1,"markup":[1,7]}],[{"value":"Server Simulation","cspan":1,"rspan":1,"markup":[1,17]},{"value":"Planned","cspan":1,"rspan":1,"markup":[1,7]}],[{"value":"Support for Messages Databases","cspan":1,"rspan":1,"markup":[1,30]},{"value":"Planned","cspan":1,"rspan":1,"markup":[1,7]}]]},"theme":null,"fixed_layout":false,"markup":{"instances":[{},{"style":{"fontWeight":"","fontStyle":"","textDecoration":"","color":"","backgroundColor":""}},null]},"options":{}}
{"rows_views":[[{"style":{"borders":"lrtb","font_style":{},"text_color":"","bg_color":"","halign":"center","valign":"top","padding":{"top":10,"right":5,"bottom":10,"left":5},"border_color":""}},{"style":{"borders":"lrtb","font_style":{},"text_color":"","bg_color":"","halign":"center","valign":"top","padding":{"top":10,"right":5,"bottom":10,"left":5},"border_color":""}}],[{"style":{"borders":"lrtb","font_style":{},"text_color":"","bg_color":"","halign":"left","valign":"top","padding":{"top":10,"right":5,"bottom":10,"left":5},"border_color":""}},{"style":{"borders":"lrtb","font_style":{},"text_color":"","bg_color":"","halign":"left","valign":"top","padding":{"top":10,"right":5,"bottom":10,"left":5},"border_color":""}}],[{"style":{"borders":"lrtb","font_style":{},"text_color":"","bg_color":"","halign":"left","valign":"top","padding":{"top":10,"right":5,"bottom":10,"left":5},"border_color":""}},{"style":{"borders":"lrtb","font_style":{},"text_color":"","bg_color":"","halign":"left","valign":"top","padding":{"top":10,"right":5,"bottom":10,"left":5},"border_color":""}}],[{"style":{"borders":"","font_style":{},"text_color":"","bg_color":"","halign":"left","valign":"top","padding":{"top":10,"right":5,"bottom":10,"left":5},"border_color":""}},{"style":{"borders":"lrtb","font_style":{},"text_color":"","bg_color":"","halign":"left","valign":"top","padding":{"top":10,"right":5,"bottom":10,"left":5},"border_color":""}}],[{"style":{"borders":"lrtb","font_style":{},"text_color":"","bg_color":"","halign":"left","valign":"top","padding":{"top":10,"right":5,"bottom":10,"left":5},"border_color":""}},{"style":{"borders":"lrtb","font_style":{},"text_color":"","bg_color":"","halign":"left","valign":"top","padding":{"top":10,"right":5,"bottom":10,"left":5},"border_color":""}}],[{"style":{"borders":"lrtb","font_style":{},"text_color":"","bg_color":"","halign":"left","valign":"top","padding":{"top":10,"right":5,"bottom":10,"left":5},"border_color":""}},{"style":{"borders":"lrtb","font_style":{},"text_color":"","bg_color":"","halign":"left","valign":"top","padding":{"top":10,"right":5,"bottom":10,"left":5},"border_color":""}}],[{"style":{"borders":"lrtb","font_style":{},"text_color":"","bg_color":"","halign":"left","valign":"top","padding":{"top":10,"right":5,"bottom":10,"left":5},"border_color":""}},{"style":{"borders":"lrtb","font_style":{},"text_color":"","bg_color":"","halign":"left","valign":"top","padding":{"top":10,"right":5,"bottom":10,"left":5},"border_color":""}}],[{"style":{"borders":"lrtb","font_style":{},"text_color":"","bg_color":"","halign":"left","valign":"top","padding":{"top":10,"right":5,"bottom":10,"left":5},"border_color":""}},{"style":{"borders":"lrtb","font_style":{},"text_color":"","bg_color":"","halign":"left","valign":"top","padding":{"top":10,"right":5,"bottom":10,"left":5},"border_color":""}}],[{"style":{"borders":"lrtb","font_style":{},"text_color":"","bg_color":"","halign":"left","valign":"top","padding":{"top":10,"right":5,"bottom":10,"left":5},"border_color":""}},{"style":{"borders":"lrtb","font_style":{},"text_color":"","bg_color":"","halign":"left","valign":"top","padding":{"top":10,"right":5,"bottom":10,"left":5},"border_color":""}}],[{"style":{"borders":"lrtb","font_style":{},"text_color":"","bg_color":"","halign":"left","valign":"top","padding":{"top":10,"right":5,"bottom":10,"left":5},"border_color":""}},{"style":{"borders":"lrtb","font_style":{},"text_color":"","bg_color":"","halign":"left","valign":"top","padding":{"top":10,"right":5,"bottom":10,"left":5},"border_color":""}}]],"model":{"rows":[[{"value":"Feature","cspan":1,"rspan":1,"markup":[1,7]},{"value":"Implementation Status","cspan":1,"rspan":1,"markup":[1,21]}],[{"value":"UDS Messages and Packets","cspan":1,"rspan":1,"markup":[1,24]},{"value":"Available since version `0.0.2\n<https://pypi.org/project/py-uds/0.0.2/>`_","cspan":1,"rspan":1,"markup":[1,73]}],[{"value":"UDS Packets Reception and Transmission","cspan":1,"rspan":1,"markup":[1,38]},{"value":"Available since version `0.3.0\n<https://pypi.org/project/py-uds/0.3.0/>`_","cspan":1,"rspan":1,"markup":[1,73]}],[{"value":"UDS Messages Reception and Transmission","cspan":1,"rspan":1,"markup":[1,39]},{"value":"Available since version `1.0.0\n<https://pypi.org/project/py-uds/1.0.0/>`_","cspan":1,"rspan":1,"markup":[1,73]}],[{"value":"Messages Segmentation","cspan":1,"rspan":1,"markup":[1,21]},{"value":"Available since version `0.2.0\n<https://pypi.org/project/py-uds/0.2.0/>`_","cspan":1,"rspan":1,"markup":[1,73]}],[{"value":"UDS Packets Desegmentation","cspan":1,"rspan":1,"markup":[1,26]},{"value":"Available since version `0.2.0\n<https://pypi.org/project/py-uds/0.2.0/>`_","cspan":1,"rspan":1,"markup":[1,73]}],[{"value":"Support for Services with multiple responses","cspan":1,"rspan":1,"markup":[1,44]},{"value":"Planned","cspan":1,"rspan":1,"markup":[1,7]}],[{"value":"Client Simulation","cspan":1,"rspan":1,"markup":[1,17]},{"value":"Planned","cspan":1,"rspan":1,"markup":[1,7]}],[{"value":"Server Simulation","cspan":1,"rspan":1,"markup":[1,17]},{"value":"Planned","cspan":1,"rspan":1,"markup":[1,7]}],[{"value":"Support for Messages Databases","cspan":1,"rspan":1,"markup":[1,30]},{"value":"Planned","cspan":1,"rspan":1,"markup":[1,7]}]]},"theme":null,"fixed_layout":false,"markup":{"instances":[{},{"style":{"fontWeight":"","fontStyle":"","textDecoration":"","color":"","backgroundColor":""}},null]},"options":{}}
Loading

0 comments on commit c65a445

Please sign in to comment.