Features status (#118)

Provide information with features status on main page of the user documentation.

docs/source/index.rst

@@ -27,6 +27,57 @@ The most likely use cases of this package are:
  - performing tests against OBD Tester (client)
 
 
+Implementation Status
+---------------------
+The package is currently in the early development phase, therefore only a few features are currently available.
+If you want to speed up the development, please visit :ref:`contribution section <contribution>` to find out
+what are your options.
+
+
+Features
+````````
+Current implementation status of package features:
+
++----------------------------------------------+------------------------------+
+|                    Feature                   |     Implementation Status    |
++==============================================+==============================+
+| UDS Messages and Packets                     | Implemented in version 0.0.2 |
++----------------------------------------------+------------------------------+
+| UDS Packets Reception                        | Ongoing                      |
++----------------------------------------------+------------------------------+
+| UDS Packets Transmission                     | Planned                      |
++----------------------------------------------+------------------------------+
+| Segmentation                                 | Ongoing                      |
++----------------------------------------------+------------------------------+
+| Support for Services with multiple responses | Planned                      |
++----------------------------------------------+------------------------------+
+| Client Simulation                            | Ongoing                      |
++----------------------------------------------+------------------------------+
+| Server Simulation                            | Planned                      |
++----------------------------------------------+------------------------------+
+| Support for Messages Databases               | Planned                      |
++----------------------------------------------+------------------------------+
+
+
+Buses supported
+```````````````
+Current implementation status of support for communication buses:
+
++----------+-----------------------+
+|    Bus   | Implementation Status |
++==========+=======================+
+| CAN      | Ongoing               |
++----------+-----------------------+
+| FlexRay  | Planned               |
++----------+-----------------------+
+| Ethernet | Planned               |
++----------+-----------------------+
+| K-Line   | Planned               |
++----------+-----------------------+
+| LIN      | Planned               |
++----------+-----------------------+
+
+
 License
 -------
 The project is licensed under the MIT license - https://github.com/mdabrowski1990/uds/blob/main/LICENSE

docs/source/pages/contribution.rst

@@ -1,3 +1,5 @@
+.. _contribution:
+
 Contribution
 ============
 

docs/source/tables/bus_implementation_status.tgn

@@ -0,0 +1 @@
+{"rows_views":[[{"style":{"borders":"","font_style":{},"text_color":"","bg_color":"","halign":"center","valign":"top","padding":{"top":10,"right":5,"bottom":10,"left":5},"border_color":""}},{"style":{"borders":"","font_style":{},"text_color":"","bg_color":"","halign":"center","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":"","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":"","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":"","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":"","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":"","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":"Ongoing","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":{}}

docs/source/tables/features_implementation_status.tgn

@@ -0,0 +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":""}}],[{"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":"Implemented in version 0.0.2","cspan":1,"rspan":1,"markup":[1,28]}],[{"value":"UDS Packets Reception","cspan":1,"rspan":1,"markup":[1,21]},{"value":"Ongoing","cspan":1,"rspan":1,"markup":[1,7]}],[{"value":"UDS Packets Transmission","cspan":1,"rspan":1,"markup":[1,24]},{"value":"Planned","cspan":1,"rspan":1,"markup":[1,7]}],[{"value":"Segmentation","cspan":1,"rspan":1,"markup":[1,12]},{"value":"Ongoing","cspan":1,"rspan":1,"markup":[1,7]}],[{"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":"Ongoing","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":{}}