Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

In-Vehicle SDK Package

pypi downloads downloads_monthly Tests

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. 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
  2. DoipUtils: A utility library for performing Diagnostic over IP (DoIP) operations, such as vehicle identity requests, routing activation, and more.

  3. 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
  4. IDeviceShell: Allows for the execution of shell commands. The following implementations are available:

    • AdbDeviceShell
    • SerialDeviceShell
    • SshDeviceShell
  5. SomeipUtils: A utility library for SOME/IP operations, allowing the receive and parse services, and in these services invoke methods and subscribe to eventgroups

  6. 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
  7. 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.16a42768

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.16a42768
File Size Uploaded
cyclarity_in_vehicle_sdk-1.1.16a42768.tar.gz 113.3 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for cyclarity-in-vehicle-sdk 1.1.16a42768
File Interpreter ABI Platform
cyclarity_in_vehicle_sdk-1.1.16a42768-py3-none-any.whl Python 3 none any Details

Total release size: 272.3 kB

Release files / cyclarity_in_vehicle_sdk-1.1.16a42768.tar.gz

Download URL cyclarity_in_vehicle_sdk-1.1.16a42768.tar.gz
Size 113.3 kB
Tags Source
SHA-256 checksum
How to use checksums
cf9b22f1c3c449681d5975d934fefc869e4c0ef24a57f271d18286ad6649aa5d
BLAKE2b-256 checksum
How to use checksums
7181d71ca2029565f447dc6be447ea454c40f7fd620acf7a9659bc0f8a009342
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/2.0.1 CPython/3.10.13 Linux/6.17.0-1022-azure

Release files / cyclarity_in_vehicle_sdk-1.1.16a42768-py3-none-any.whl

Download URL cyclarity_in_vehicle_sdk-1.1.16a42768-py3-none-any.whl
Size 159.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
64d5b1fba242d4d24766e2b7fbc539ab23a1a26d27f512fc157e3541cbab9a64
BLAKE2b-256 checksum
How to use checksums
ba93969da12e81b5483febe8b7bc82271f8f0b529a87a01197016a4418cc8bad
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/2.0.1 CPython/3.10.13 Linux/6.17.0-1022-azure

Release history Release notifications | RSS feed

This release

1.1.16a42768 This release

2 release files

1.1.15

2 release files

1.1.13

2 release files

1.1.9

2 release files

1.1.8

2 release files

1.1.7

2 release files

1.1.6

2 release files

1.1.5

2 release files

1.1.4

2 release files

1.1.3

2 release files

1.1.2

2 release files

1.1.1

2 release files

1.1.0

2 release files

1.0.10

2 release files

1.0.9

2 release files

1.0.8

2 release files

1.0.7

2 release files

1.0.6

2 release files

1.0.5

2 release files

1.0.4

2 release files

1.0.3

2 release files

1.0.2

2 release files

1.0.1

2 release files

1.0.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page