Metadata-Version: 2.1
Name: cyclarity-in-vehicle-sdk
Version: 1.0.8a69918
Summary: 
Author: Cymotive
Author-email: clarity@cymotive.com
Requires-Python: >=3.10,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Dist: adb-shell (>=0.4.4,<0.5.0)
Requires-Dist: can-isotp (>=2.0.6,<3.0.0)
Requires-Dist: cmake (>=3.30.2,<4.0.0)
Requires-Dist: construct (>=2.10.70,<3.0.0)
Requires-Dist: cyclarity-sdk (>=1.0.49,<2.0.0)
Requires-Dist: doipclient (>=1.1.1,<2.0.0)
Requires-Dist: gpiod (>=2.2.3,<3.0.0)
Requires-Dist: jsonargparse (>=4.34.0,<4.35.0)
Requires-Dist: paramiko (>=3.4.1,<4.0.0)
Requires-Dist: py-pcapplusplus (>=1.0.1,<2.0.0)
Requires-Dist: pycryptodome (>=3.21.0,<4.0.0)
Requires-Dist: pyserial (>=3.5,<4.0)
Requires-Dist: python-can (>=4.5.0,<5.0.0)
Requires-Dist: udsoncan (>=1.23.1,<2.0.0)
Description-Content-Type: text/markdown

# In-Vehicle SDK Package  
  
This package provides the In-Vehicle SDK, offering a range of functionalities to support communication and operations with in-vehicle systems.  
  
## Features  
  
The In-Vehicle SDK package includes the following interfaces and implementations:  
  
1. **CommunicatorBase**: Provides the capability to send and receive byte data over various protocols. The following implementations are available:  
    * `TcpCommunicator`  
    * `MulticastCommunicator`  
    * `IsoTpCommunicator`  
    * `DoipCommunicator`  
  
2. **RawSocketCommunicatorBase**: Offers send, receive, and srp (send and receive answer) operations for `py_pcapplusplus.Packet` types. The following implementations are available:  
    * `Layer2RawSocket`  
    * `Layer3RawSocket`  
  
3. **CanCommunicatorBase**: Exposes the python-can functionality, offering operations like send, receive, sniff, and more. The following implementation is available:  
    * `CanCommunicatorSocketCan` - A specific implementation for the socketcan driver  
  
4. **DoipUtils**: A utility library for performing Diagnostic over IP (DoIP) operations, such as vehicle identity requests, routing activation, and more.  
  
5. **UdsUtilsBase**: Used for performing Unified Diagnostic Services (UDS) operations, such as ECU reset, read DIDs, session change, and more. The following implementation is available:  
    * `UdsUtils` - Can be initialized to work over DoIP/ISO-TP  
  
6. **IDeviceShell**: Allows for the execution of shell commands. The following implementations are available:  
    * `AdbDeviceShell`  
    * `SerialDeviceShell`  
    * `SshDeviceShell`  
  
## Installation  
  
You can install the In-Vehicle SDK package using pip:  
`pip install cyclarity-in-vehicle-sdk`

