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.9a93462
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.9a93462.tar.gz | 64.1 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| cyclarity_in_vehicle_sdk-1.0.9a93462-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 158.9 kB
Release files / cyclarity_in_vehicle_sdk-1.0.9a93462.tar.gz
| Download URL | cyclarity_in_vehicle_sdk-1.0.9a93462.tar.gz |
|---|---|
| Size | 64.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
b3a1d7b81484a239890f426c838645bc794cc783ba9048038bbe0e64b969585f
|
|
BLAKE2b-256 checksum How to use checksums |
809ed3b01b4f307a66ed180d7aab83334dc6f6b3827d502aebd101e944d6f0d1
|
| 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.9a93462-py3-none-any.whl
| Download URL | cyclarity_in_vehicle_sdk-1.0.9a93462-py3-none-any.whl |
|---|---|
| Size | 94.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
ae9a2345a72c3e5414d7b810064a7c9e3fcdab0a2a5cb056ef561c4d50d8b75d
|
|
BLAKE2b-256 checksum How to use checksums |
8c8fb22676d656d07d391259fbfadb650c41061f27a6dbec096f47a566739479
|
| 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
|