someipy - A Python Library implementing the SOME/IP Protocol

Get in Contact :postbox:

If you want to connect, have a feature request, bug report or need support, send me an email or connect on LinkedIn:

:email: someipy.package@gmail.com
:electric_plug: LinkedIn

Documentation :pencil2:

:link: https://someipy.readthedocs.io/en/latest/

What is someipy?

someipy is a Python library implementing the SOME/IP protocol, including the SOME/IP SD (Service Discovery) in Python. It's perfectly suited for fast prototyping of applications that need to provide (server) or use (client) SOME/IP services from other ECUs.

someipy also supports serialization and deserialization of SOME/IP payloads, which is a unique feature compared to other libraries.

someipy is still under development; therefore, it does not yet support all features of the SOME/IP and SOME/IP Service Discovery protocol specification.

someipy is based on the specification version of R22-11:

• SOME/IP Protocol Specification
• SOME/IP Service Discovery Protocol Specification

The library is currently developed and tested under Ubuntu 22.04 and Python 3.8. Windows is supported as well.

Typical Use Cases

someipy excels in scenarios where a full-scale Autosar (Adaptive or Classic) integration would be excessive:

• :test_tube: Develop Test Applications: Easily create test applications to stimulate the SOME/IP interfaces of your system under test. Whether running on a PC in a SIL environment or on an ECU, someipy allows you to efficiently send and receive SOME/IP events or utilize/provide SOME/IP services. Test data can be seamlessly generated or imported in Python, from sources such as .csv files or ROS bag files. Explore the example applications for more details.

• :battery: Prototype Sensor Integration: Quickly integrate new sensors into your project using SOME/IP, ideal for evaluating the sensor's potential impact without significant effort. Define the message/parameter layout in Python and create a server service instance in minutes. Check out the example application send_events_udp.py for a practical demonstration.

• :microscope: Data Recording: Set up a SOME/IP recording application in just a few minutes and store data in your preferred format, such as ROS bags, .csv files, or databases. Simply dump the received data within your callback function. The example application receive_events_udp.py illustrates this process.

Installation

The package can be installed from PyPi.

pip3 install someipy

Example Applications

In the directory example_apps, examples including explanations, can be found for using the someipy library.