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)

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cyclarity_in_vehicle_sdk-1.1.2a51240.tar.gz (73.2 kB view details)

Uploaded Jul 2, 2025 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

cyclarity_in_vehicle_sdk-1.1.2a51240-py3-none-any.whl (106.4 kB view details)

Uploaded Jul 2, 2025 Python 3

File details

Details for the file cyclarity_in_vehicle_sdk-1.1.2a51240.tar.gz.

File metadata

Download URL: cyclarity_in_vehicle_sdk-1.1.2a51240.tar.gz
Upload date: Jul 2, 2025
Size: 73.2 kB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: poetry/2.0.1 CPython/3.10.13 Linux/6.11.0-1015-azure

File hashes

Hashes for cyclarity_in_vehicle_sdk-1.1.2a51240.tar.gz
Algorithm	Hash digest
SHA256	`f11499a6096fa76c6b47d100d202e76116c7920f7f84141358476371c2685706`
MD5	`779b5e3921915b8130eb7ded33931f32`
BLAKE2b-256	`3156e3636320309d4fff11de6be1880ff53b826c075fe12f815e4262650768dc`

See more details on using hashes here.

File details

Details for the file cyclarity_in_vehicle_sdk-1.1.2a51240-py3-none-any.whl.

File metadata

Download URL: cyclarity_in_vehicle_sdk-1.1.2a51240-py3-none-any.whl
Upload date: Jul 2, 2025
Size: 106.4 kB
Tags: Python 3
Uploaded using Trusted Publishing? No
Uploaded via: poetry/2.0.1 CPython/3.10.13 Linux/6.11.0-1015-azure

File hashes

Hashes for cyclarity_in_vehicle_sdk-1.1.2a51240-py3-none-any.whl
Algorithm	Hash digest
SHA256	`7a2d2780cba4565e52bc03cb477fbe55d850ad79b6de987c8ebbac0a8c2a032b`
MD5	`69e034bf6f1ad3ff5aca3e1e4b184720`
BLAKE2b-256	`69b5a16ec4ee52fbd7d582c83c540b2a33b4745432cbeefe1a4303e65e39e1f8`