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
1. CommunicatorBase: Provides the capability to send and receive byte data over various protocols. The following implementations are available:
  - TcpCommunicator
  - UdpCommunicator
  - 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
  - WiFiRawSocket
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
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:
- AdbDeviceShell
- SerialDeviceShell
- SshDeviceShell
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 change
- UnrespondedTesterPresentCrashDetector: a plugin that detects ECU crash based on UDS TP that is not being responded
- UdsEcuRecoverPlugin: a plugin responsible of recovering the ECU back to predefined UDS state - session and elevation
- RelayResetPlugin: a plugin that resets a device via relay
- UdsBasedEcuResetPlugin: 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:
  1. IpAddAction - add an IP to an Ethernet interface, and optionally configure a route for this IP.
  2. IpRemoveAction - remove an existing IP from an Ethernet interface.
  3. CanConfigurationAction - configure CAN interface parameters. e.g. bitrate, sample-point, cc-len8-dlc flag and state.
  4. EthInterfaceConfigurationAction - configure the Ethernet interface: mtu, state and flags.
  5. WifiConnectAction - connect to a WiFi access point
  6. CreateVlanAction - creating a VLAN interface
- get_device_configuration() - retrieves the current device configurations:
  1. Ethernet interface configuration: state, IPs, flags and MTU.
  2. CAN interface configurations: state, bitrate, sample-point and cc-len8-dlc flag.
  3. The available WiFi access points.

The complete user manual can be found in here

Installation

You can install the In-Vehicle SDK package using pip:
pip install cyclarity-in-vehicle-sdk

Usage

Example for importing and using CanCommunicatorSocketCan for sending a Message

from cyclarity_in_vehicle_sdk.communication.can.base.can_communicator_base import CanMessage
from cyclarity_in_vehicle_sdk.communication.can.impl.can_communicator_socketcan import CanCommunicatorSocketCan

canmsg = CanMessage(
            arbitration_id=0x123,
            is_extended_id = False,
            is_rx=False,
            data=b"\x00" * 8,
            is_fd=False,
            bitrate_switch=False,
        )

socket = CanCommunicatorSocketCan(channel="vcan0", support_fd=True)
with socket:
    socket.send(can_msg=canmsg)

Metadata

Release files for cyclarity-in-vehicle-sdk 1.1.0a73098

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for cyclarity-in-vehicle-sdk 1.1.0a73098
File	Size	Uploaded
cyclarity_in_vehicle_sdk-1.1.0a73098.tar.gz	77.7 kB	May 28, 2025	Details

Built distribution (wheel)

Table of built distributions (wheels) for cyclarity-in-vehicle-sdk 1.1.0a73098
File	Interpreter	ABI	Platform	Reset
cyclarity_in_vehicle_sdk-1.1.0a73098-py3-none-any.whl 117.7 kB May 28, 2025	Python 3	none	any	Details

Total release size: 195.3 kB

Release files / cyclarity_in_vehicle_sdk-1.1.0a73098.tar.gz

Download URL	cyclarity_in_vehicle_sdk-1.1.0a73098.tar.gz
Size	77.7 kB
Tags	Source
SHA-256 checksum How to use checksums	`e354635042c5f322a80627641b889671fece7113510762e35441b055af66df2e`
BLAKE2b-256 checksum How to use checksums	`e46fb4c55c73be1c0fbcd8d14454c818b4b3e6ded694be624758774b5a41e0ca`
Upload date	May 28, 2025
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`poetry/2.0.1 CPython/3.10.13 Linux/6.11.0-1014-azure`

Release files / cyclarity_in_vehicle_sdk-1.1.0a73098-py3-none-any.whl

Download URL	cyclarity_in_vehicle_sdk-1.1.0a73098-py3-none-any.whl
Size	117.7 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`52d3c9f91bb54b3759269df2f5d312fc1489d208395ea9fef626bb3c588c6667`
BLAKE2b-256 checksum How to use checksums	`1854551fa6b259f9c0410523c6d4e20992ad9792ae28bdbf7c1d3d6141753c49`
Upload date	May 28, 2025
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`poetry/2.0.1 CPython/3.10.13 Linux/6.11.0-1014-azure`