Pre-release documentation update (#67)

Update UDS knowledge base:
- add UDS OSI Model
- describe segmentation process

docs/source/_static/page_width.css

@@ -0,0 +1,3 @@
+.wy-nav-content {
+    max-width: 100% !important;
+}

docs/source/conf.py

@@ -46,9 +46,13 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'sphinx_rtd_theme'
+html_theme = "sphinx_rtd_theme"
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = []
+html_static_path = ["_static"]
+
+
+def setup(app):
+    app.add_css_file("page_width.css")

docs/source/index.rst

@@ -16,7 +16,7 @@ Welcome to UDS documentation!
 
 .. figure:: images/UDS_logo.PNG
     :alt: UDS
-    :width: 200px
+    :width: 25%
     :figclass: align-center
 
 

docs/source/tables/UDS_OSI_Model.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":"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":"","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":"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":"","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":"","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":"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":""}},{"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":"OSI Layer","cspan":1,"rspan":1,"markup":[1,9]},{"value":"ISO Standards","cspan":1,"rspan":1,"markup":[1,13]},{"value":"Functionalities","cspan":1,"rspan":1,"markup":[1,15]},{"value":"Implementation","cspan":1,"rspan":1,"markup":[1,14]}],[{"value":"Layer 7\nApplication","cspan":1,"rspan":1,"markup":[1,19]},{"value":"Common:\n\n- ISO 14229-1\n\n- ISO 27145-3\n\n\nCAN specific:\n\n- ISO 14229-3\n\n\nFlexRay specific:\n\n- ISO 14229-4\n\n\nEthernet specific:\n\n- ISO 14229-5\n\n\nK-Line specific:\n\n- ISO 14229-6\n\n\nLIN specific:\n\n- ISO 14229-7","cspan":1,"rspan":1,"markup":[1,204]},{"value":"Diagnostic message:\n\n- creating\n\n- storing historic data\n\n- various SIDs support\n\n- bus specific services\n","cspan":1,"rspan":1,"markup":[1,106]},{"value":"- UdsMessage\n\n- UdsMessageRecord\n\n- RequestSID\n\n- ResponseSID\n\n- NRC\n\n- AddressingType\n\n\nTo be extended in milestones:\n\n- `Database support <https://github.com/mdabrowski1990/uds/milestone/2>`_\n","cspan":1,"rspan":1,"markup":[1,194]}],[{"value":"Layer 6\nPresentation","cspan":1,"rspan":1,"markup":[1,20]},{"value":"Common:\n\n- ISO 27145-2\n\n\nUnique per system:\n\n- system manufacturer specific","cspan":1,"rspan":1,"markup":[1,75]},{"value":"- diagnostic messages data interpretation\n\n- messaging database import from a file\n\n- messaging database export to a file\n\n","cspan":1,"rspan":1,"markup":[1,123]},{"value":"To be implemented in milestones:\n\n- `Database support <https://github.com/mdabrowski1990/uds/milestone/2>`_\n","cspan":1,"rspan":1,"markup":[1,108]}],[{"value":"Layer 5\nSession","cspan":1,"rspan":1,"markup":[1,15]},{"value":"Common:\n\n- ISO 14229-2","cspan":1,"rspan":1,"markup":[1,22]},{"value":"- Client simulation\n\n- Server simulation","cspan":1,"rspan":1,"markup":[1,40]},{"value":"To be implemented in milestones:\n\n- `Client simulation <https://github.com/mdabrowski1990/uds/milestone/8>`_ \n\n- `Server simulation <https://github.com/mdabrowski1990/uds/milestone/7>`_","cspan":1,"rspan":1,"markup":[1,185]}],[{"value":"Layer 4\nTransport","cspan":1,"rspan":1,"markup":[1,17]},{"value":"CAN specific:\n\n- ISO 15765-2\n\n\nFlexRay specific:\n\n- 10681-2\n\n\nEthernet specific:\n\n- 13400-2\n\n\nLIN specific:\n\n- 17987-2","cspan":1,"rspan":2,"markup":[1,118]},{"value":"UDS packets:\n\n- creating\n- storing historic data\n\n- support for bus specific packets\n\n\n\nUDS communication:\n\n\n- diagnostic messages segmentation\n\n- receiving packets\n\n- transmitting packets\n\n- errors handling\n\n- errors simulation\n","cspan":1,"rspan":2,"markup":[1,229]},{"value":"- AbstractUdsPacket\n\n- AbstractUdsPacketRecord\n\n- AbstractPacketType\n","cspan":1,"rspan":2,"markup":[1,69]}],[{"value":"Layer 3\nNetwork","cspan":1,"rspan":1,"markup":[1,15]},{"value":"","cspan":1,"rspan":-1,"markup":[]},{"value":"","cspan":1,"rspan":-1,"markup":[]},{"value":"","cspan":1,"rspan":-1,"markup":[]}],[{"value":"Layer 2\nData","cspan":1,"rspan":1,"markup":[1,12]},{"value":"CAN specific:\n\n- ISO 11898-1\n\n- ISO 11898-2\n\n- ISO 11898-3\n\n\nFlexRay specific:\n\n- ISO 17458-2\n\n- ISO 17458-4\n\n\nEthernet specific:\n\n- 13400-3\n\n\nK-Line specific:\n\n- ISO 14230-2\n\n- ISO 14230-1\n\n\nLIN specific:\n\n- ISO 17987-3\n\n- ISO 17987-4","cspan":1,"rspan":2,"markup":[1,235]},{"value":"Bus handling:\n\n- creating frames\n\n- storing historic frames data\n\n- frames receiving\n\n- frames transmitting\n\n","cspan":1,"rspan":2,"markup":[1,109]},{"value":"External python packages for bus handling:\n\n- `CAN <https://python-can.readthedocs.io>`_","cspan":1,"rspan":2,"markup":[1,88]}],[{"value":"Layer 1\nPhysical","cspan":1,"rspan":1,"markup":[1,16]},{"value":"","cspan":1,"rspan":-1,"markup":[]},{"value":"","cspan":1,"rspan":-1,"markup":[]},{"value":"","cspan":1,"rspan":-1,"markup":[]}]]},"theme":null,"fixed_layout":false,"markup":{"instances":[{},{"style":{"fontWeight":"","fontStyle":"","textDecoration":"","color":"","backgroundColor":""}},null]},"options":{}}