py-uds-demo 25.0.0__py3-none-any.whl

py_uds_demo/interface/web.py

@@ -0,0 +1,108 @@
+import socket
+import gradio as gr
+
+from py_uds_demo.core.client import UdsClient
+
+
+class Web:
+    """
+    WebUi provides a Gradio-based web interface for interacting with the UDS (Unified Diagnostic Services) simulator.
+
+    This class manages the UI components, handles user input, processes diagnostic requests, and logs interactions.
+    """
+
+    def __init__(self):
+        """
+        Initialize the WebUi instance.
+
+        Sets up the UdsClient and default log file path.
+        """
+        self.uds_client = UdsClient()
+        self.logger = self.uds_client.server.logger
+
+    def run(self):
+        """
+        Launch the Gradio app for the UDS simulator UI.
+
+        Initializes the logger and starts the Gradio Blocks interface.
+        """
+        uds_sim = gr.Blocks(title="UDS Simulator")
+        with uds_sim:
+            self.uds_simulator_ui()
+        uds_sim.launch(server_name=socket.getfqdn(), server_port=7865, share=False, debug=False)
+
+    def uds_simulator_ui(self):
+        """
+        Build the Gradio UI for the UDS simulator.
+
+        Sets up the tester present checkbox, chatbot, and diagnostic request textbox.
+        """
+        self.tester_present_checkbox = gr.Checkbox(label="tester_present", value=False)
+        self.uds_sim_chatbot = gr.Chatbot(type="messages", label="UDS Simulator(Chat Box)", show_label=True, show_copy_all_button=True, layout="bubble", value=[])
+        self.diag_req_textbox = gr.Textbox(label="Diagnostic Request", placeholder="Enter diagnostic request in hex format (e.g., 22 F1 87). No need to mention size.", show_label=True)
+        self.diag_req_textbox.submit(self.chat_bot_process, [self.diag_req_textbox, self.uds_sim_chatbot], [self.diag_req_textbox, self.uds_sim_chatbot])
+        self.tester_present_checkbox.change(self._update_tester_present, [self.tester_present_checkbox])
+
+        with gr.Row():
+            self.help_sid_textbox = gr.Textbox(label="Help with SID", placeholder="Enter SID (e.g., 10)", show_label=True)
+            self.help_button = gr.Button(value="Get Help")
+        self.help_button.click(self._show_help_callback, [self.help_sid_textbox, self.uds_sim_chatbot], [self.help_sid_textbox, self.uds_sim_chatbot])
+
+    def _show_help_callback(self, sid_str, chat_history):
+        try:
+            sid = int(sid_str, 16)
+            service = self.uds_client.server.service_map.get(sid)
+            if service:
+                chat_history.append({"role": "user", "content": f"Help for SID 0x{sid:02X}"})
+                chat_history.append({"role": "assistant", "content": service.__doc__})
+            else:
+                chat_history.append({"role": "user", "content": f"Help for SID 0x{sid:02X}"})
+                chat_history.append({"role": "assistant", "content": f"No help found for SID 0x{sid:02X}."})
+        except (ValueError, IndexError):
+            chat_history.append({"role": "user", "content": f"Help for SID {sid_str}"})
+            chat_history.append({"role": "assistant", "content": "Invalid SID. Please enter a valid hex value."})
+        return "", chat_history
+
+    def chat_bot_process(self, diagnostic_request, chat_history):
+        """
+        Process user diagnostic request and update chat history.
+
+        Args:
+            diagnostic_request (str): The diagnostic request input by the user in hex string format.
+            chat_history (list): The current chat history between user and assistant.
+
+        Returns:
+            tuple: A tuple of (empty string, updated chat_history).
+        """
+        diagnostic_request_clean = diagnostic_request.replace(" ", "")
+        try:
+            diagnostic_request_stream = [int(diagnostic_request_clean[i:i+2], 16) for i in range(0, len(diagnostic_request_clean), 2)]
+            user_sent_request = self.uds_client.format_request(diagnostic_request_stream)
+            chat_history.append({"role": "user", "content": user_sent_request})
+            diagnostic_response = self.uds_client.send_request(diagnostic_request_stream, True)
+            chat_history.append({"role": "assistant", "content": diagnostic_response})
+        except ValueError:
+            chat_history.append({"role": "user", "content": diagnostic_request})
+            chat_history.append({"role": "assistant", "content": "Invalid hex input. Please enter a valid hex string."})
+            self.logger.warning(f"Invalid Diagnostic Request 💉 {diagnostic_request}")
+        except Exception as e:
+            chat_history.append({"role": "user", "content": diagnostic_request})
+            chat_history.append({"role": "assistant", "content": f"An error occurred while processing the request. {e}"})
+            self.logger.error(f"Error occurred while processing request 💉 {diagnostic_request}: {e}")
+        finally:
+            return "", chat_history
+
+    def _update_tester_present(self, value: bool):
+        """
+        Update the tester present flag in the UDS server and log the action.
+
+        Args:
+            value (bool): True to activate tester present, False to deactivate.
+        """
+        self.uds_client.server.diagnostic_session_control.tester_present_active = value
+        self.logger.info('tester present [✔️] activated' if value else 'tester present [✖️] deactivated')
+
+
+if __name__ == "__main__":
+    web_ui = Web()
+    web_ui.run()

py_uds_demo-25.0.0.dist-info/METADATA

@@ -0,0 +1,70 @@
+Metadata-Version: 2.3
+Name: py-uds-demo
+Version: 25.0.0
+Summary: Learn and Practice UDS Protocol
+Keywords: python,template
+Author: chaitu-ycr
+Author-email: chaitu-ycr <chaitu.ycr@gmail.com>
+License: MIT License
+         
+         Copyright (c) 2025 chaitu-ycr
+         
+         Permission is hereby granted, free of charge, to any person obtaining a copy
+         of this software and associated documentation files (the "Software"), to deal
+         in the Software without restriction, including without limitation the rights
+         to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+         copies of the Software, and to permit persons to whom the Software is
+         furnished to do so, subject to the following conditions:
+         
+         The above copyright notice and this permission notice shall be included in all
+         copies or substantial portions of the Software.
+         
+         THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+         IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+         FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+         AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+         LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+         OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+         SOFTWARE.
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: Microsoft :: Windows
+Requires-Dist: dearpygui
+Requires-Dist: gradio
+Requires-Dist: fastapi
+Requires-Dist: uvicorn
+Requires-Python: >=3.10, <=3.14
+Project-URL: documentation, https://chaitu-ycr.github.io/automotive-test-kit/packages/py_uds_demo
+Project-URL: homepage, https://github.com/chaitu-ycr/automotive-test-kit
+Project-URL: repository, https://github.com/chaitu-ycr/automotive-test-kit
+Description-Content-Type: text/markdown
+
+# py_uds_demo
+
+## Overview
+
+`py_uds_demo` is a Python package for learning and practicing the Unified Diagnostic Services (UDS) protocol. It provides a simulator with CLI, GUI, and Web interfaces, allowing users to send diagnostic requests and view responses as per ISO 14229.
+
+### Features
+
+- UDS protocol simulation (ISO 14229)
+- CLI, GUI (CustomTkinter), and Web (Gradio) interfaces
+- Diagnostic session management, data transmission, input/output control, and more
+- Extensible and modular codebase
+
+---
+
+## source manual
+
+::: py_uds_demo.core.client
+::: py_uds_demo.core.server
+::: py_uds_demo.core.utils.helpers
+::: py_uds_demo.core.utils.responses
+::: py_uds_demo.core.utils.services.diagnostic_and_commmunication_management
+::: py_uds_demo.core.utils.services.data_transmission
+::: py_uds_demo.core.utils.services.stored_data_transmission
+::: py_uds_demo.core.utils.services.input_output_contol
+::: py_uds_demo.core.utils.services.remote_activation_of_routine
+::: py_uds_demo.core.utils.services.upload_download
+
+---

py_uds_demo-25.0.0.dist-info/RECORD

@@ -0,0 +1,24 @@
+py_uds_demo/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+py_uds_demo/__main__.py,sha256=jXTwCde6XSvrUodd8FGorlItlhav3EnuqHQtlYjorDY,1873
+py_uds_demo/core/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+py_uds_demo/core/client.py,sha256=r9p-m68qsgyNLAji0znute0nAY_8VPvavvtbWCYTri4,3104
+py_uds_demo/core/server.py,sha256=6DYcHajC7p4sEp-LP2UHYBEoCK2gZxNBauuQP_IUChM,12812
+py_uds_demo/core/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+py_uds_demo/core/utils/helpers.py,sha256=mhrvOs1PCcgTNZFJPiVocp_3jOjgKC1sPnfCaUVwgmE,14162
+py_uds_demo/core/utils/responses.py,sha256=Oqz36f79dF0pdawA04eXxfvjuvvgqdmxue45A0hk738,1749
+py_uds_demo/core/utils/services/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+py_uds_demo/core/utils/services/data_transmission.py,sha256=JeTtcNKi3keLfDgdHh_4RdNm9ieCGl4twDvqa0oTyFA,16895
+py_uds_demo/core/utils/services/diagnostic_and_commmunication_management.py,sha256=wX2qVEW29LGT4_XCM-iVhFXuGJukFVaY6lYcQQnids8,31161
+py_uds_demo/core/utils/services/input_output_contol.py,sha256=DJ5z_JAYjphF7JSiSAkx1_Tj5511g4005duoLiFdDiQ,2495
+py_uds_demo/core/utils/services/negative_response.py,sha256=frcCV1k9oG9oKj3dpUqdJg1PxRT2RSN_XKdLCPjaYaY,2
+py_uds_demo/core/utils/services/remote_activation_of_routine.py,sha256=id_vFBmANOTul5E-PU7ltRuMSE9poF4bTotbEKSkHFo,3311
+py_uds_demo/core/utils/services/stored_data_transmission.py,sha256=IFeiFqZZtRvTm7MgZII1haU1FlATfjKsevC5kxG6D_4,5490
+py_uds_demo/core/utils/services/upload_download.py,sha256=nLhGBANAYCuCTxv9D78FuEE2YR5FEsjCznK_aEkep40,6055
+py_uds_demo/interface/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+py_uds_demo/interface/api.py,sha256=CIqQJx_WsTc5rb4D9gFXnScVjtlBV5WJnA0_xfNfVeY,813
+py_uds_demo/interface/cli.py,sha256=aDkAGkJlTnSd45NzpObpf6rY8Jndty1vMWqaQ85LPEk,2138
+py_uds_demo/interface/gui.py,sha256=IpRa--_UKhx2xF-hlWrdFOsQsTxlmnOnMNMwkSoPyTw,4259
+py_uds_demo/interface/web.py,sha256=fM7xVnGcpa6Mb0HPxZCt8911puT8po86GPFLhLfyXIM,5429
+py_uds_demo-25.0.0.dist-info/WHEEL,sha256=5h_Q-_6zWQhhADpsAD_Xpw7gFbCRK5WjOOEq0nB806Q,79
+py_uds_demo-25.0.0.dist-info/METADATA,sha256=YBl-lWSUtaRhbKYBbe3lKPDBVUDzQzZO_RIGECZkMKk,3062
+py_uds_demo-25.0.0.dist-info/RECORD,,

py_uds_demo-25.0.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: uv 0.8.18
+Root-Is-Purelib: true
+Tag: py3-none-any