This release is a pre-release and may not be stable for production use.
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:
-
Communication
-
CommunicatorBase: Provides the capability to send and receive byte data over various protocols. The following implementations are available:
TcpCommunicatorUdpCommunicatorMulticastCommunicatorIsoTpCommunicatorDoipCommunicator
-
RawSocketCommunicatorBase: Offers send, receive, and srp (send and receive answer) operations for
py_pcapplusplus.Packettypes. The following implementations are available:Layer2RawSocketLayer3RawSocketWiFiRawSocket
-
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
-
-
DoipUtils: A utility library for performing Diagnostic over IP (DoIP) operations, such as vehicle identity requests, routing activation, and more.
-
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
-
IDeviceShell: Allows for the execution of shell commands. The following implementations are available:
AdbDeviceShellSerialDeviceShellSshDeviceShell
-
SomeipUtils: A utility library for SOME/IP operations, allowing the receive and parse services, and in these services invoke methods and subscribe to eventgroups
-
Plugins:
SessionChangeCrashDetector: a plugin that detects ECU crash based on UDS session changeUnrespondedTesterPresentCrashDetector: a plugin that detects ECU crash based on UDS TP that is not being respondedUdsEcuRecoverPlugin: a plugin responsible of recovering the ECU back to predefined UDS state - session and elevationRelayResetPlugin: a plugin that resets a device via relayUdsBasedEcuResetPlugin: a plugin that resets a device via UDS ECU Reset
-
ConfigurationManager: An API allowing to perform configuration of the IOT Device.
- configure_actions(action/s) - can perform the following configuration actions on the device:
IpAddAction- add an IP to an Ethernet interface, and optionally configure a route for this IP.IpRemoveAction- remove an existing IP from an Ethernet interface.CanConfigurationAction- configure CAN interface parameters. e.g. bitrate, sample-point, cc-len8-dlc flag and state.EthInterfaceConfigurationAction- configure the Ethernet interface: mtu, state and flags.WifiConnectAction- connect to a WiFi access point
- get_device_configuration() - retrieves the current device configurations:
- Ethernet interface configuration: state, IPs, flags and MTU.
- CAN interface configurations: state, bitrate, sample-point and cc-len8-dlc flag.
- The available WiFi access points.
- configure_actions(action/s) - can perform the following configuration actions on the device:
Installation
You can install the In-Vehicle SDK package using pip:
pip install cyclarity-in-vehicle-sdk
Metadata
Release files for cyclarity-in-vehicle-sdk 1.0.9a15253
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| cyclarity_in_vehicle_sdk-1.0.9a15253.tar.gz | 63.8 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| cyclarity_in_vehicle_sdk-1.0.9a15253-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 158.3 kB
Release files / cyclarity_in_vehicle_sdk-1.0.9a15253.tar.gz
| Download URL | cyclarity_in_vehicle_sdk-1.0.9a15253.tar.gz |
|---|---|
| Size | 63.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
3501e94c724d8b545ac4fbb602599688c2c8751748d17ae3caf8dbee6e7a030f
|
|
BLAKE2b-256 checksum How to use checksums |
07f1af2df6ebcf816042211d8f2d2b5ce54dee6c2e044230141c31c8b094bf28
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.0.1 CPython/3.10.13 Linux/6.1.79
|
Release files / cyclarity_in_vehicle_sdk-1.0.9a15253-py3-none-any.whl
| Download URL | cyclarity_in_vehicle_sdk-1.0.9a15253-py3-none-any.whl |
|---|---|
| Size | 94.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
9b6bc75c0efa330584365faed58ecc832e9f4f6fe402ed5bbd6a9ce5f9654abe
|
|
BLAKE2b-256 checksum How to use checksums |
c0e555ef56600cbfbf843fcf156311c808b3abcbef98081bb175923eedf15c8b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.0.1 CPython/3.10.13 Linux/6.1.79
|