update mkdocs

Author: Yanujz

mkdocs/docs/index.md

@@ -70,3 +70,80 @@ def main():
 if __name__ == '__main__':
     main()
 ```
+
+
+## Roadmap
+### Phase 1: Initial Setup
+
+#### Step 1: Project Structure
+- [x] Create the initial project structure.
+    ```
+    pycan/
+    ├── pycan/
+    │   ├── __init__.py
+    │   ├── pyisotp.py
+    │   ├── pyuds.py
+    │   └── utility.py
+    ├── setup.py
+    └── README.md
+    ```
+
+#### Step 2: Implement CAN Interface
+- [x] Write `can_interface.py` to handle basic CAN communication.
+
+#### Step 3: Implement ISO-TP Layer
+- [x] Write `pyisotp.py` to manage ISO-TP message fragmentation and reassembly.
+
+#### Step 4: Implement UDS Protocol
+- [x] Write `pyuds.py` to implement UDS over ISO-TP.
+
+#### Step 5: Create Setup Script
+- [x] Write `setup.py` for module packaging and installation.
+
+#### Step 6: Write README
+- [ ] Create a comprehensive `README.md` with installation and usage instructions.
+
+### Phase 2: Development and Testing
+
+#### Step 7: Develop Core Features
+- [x] (0x10) Diagnostic Session Control.
+- [x] (0x11) ECU Reset.
+    - [x] (0x0) Hard Reset
+    - [x] (0x1) Key OffOn
+    - [x] (0x2) Soft Reset
+    - [x] (0x3) Enable Rapid Power Shutdown
+- [ ] (0x14) Clear Diagnostic Information.
+- [ ] (0x19) Read DTCI nformation.
+- [x] (0x22) Read Data By Identifier.
+- [ ] (0x23) Read Memory By Address.
+- [ ] (0x24) Read Scaling Data By Identifier.
+- [x] (0x27) Security Access.
+- [ ] (0x28) Communication Control.
+- [ ] (0x29) Authentication.
+- [ ] (0x2A) Read Data By Periodic Identifier.
+- [ ] (0x2C) Dynamically Define Data Identifier.
+- [x] (0x2E) Write Data By Identifier.
+- [ ] (0x2F) Input Output Control By Identifier.
+- [x] (0x31) RoutineControl.
+    - [x]  (0x01) Start Routine
+    - [x]  (0x02) Stop Routine
+    - [x]  (0x03) Result Routine
+- [x]  (0x34) Request Download
+- [ ]  (0x35) Request Upload
+- [x]  (0x36) Transfer Data
+- [x]  (0x37) Request Transfer Exit
+- [ ]  (0x38) Request File Transfer
+- [ ]  (0x3D) Write Memory By Address
+- [x]  (0x3E) Tester Present
+- [ ]  (0x84) SecuredDataTransmission
+- [x]  (0x85) Control DTC Setting
+- [ ]  (0x86) ResponseOnEvent
+- [ ]  (0x87) LinkControl
+
+#### Step 8: Unit Testing
+- [ ] Write unit tests for `pyisotp.py`.
+- [ ] Write unit tests for `pyuds.py`.
+
+#### Step 9: Integration Testing
+- [ ] Perform integration tests to ensure all components work together.
+

mkdocs/mkdocs.yml

@@ -43,4 +43,7 @@ markdown_extensions:
   - tables
   - pymdownx.snippets:
       auto_append:
-        - includes/abbreviations.md
+        - includes/abbreviations.md
+  - def_list
+  - pymdownx.tasklist:
+      custom_checkbox: true