From 9b05bb5a5d3b5f5498b224e50fd4889b702031ef Mon Sep 17 00:00:00 2001 From: chrizog Date: Wed, 22 May 2024 20:21:46 +0200 Subject: [PATCH] Update readme --- README.md | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 3638442..04bd1ef 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,11 @@ -# someipy - A Python Library for the SOME/IP Protocol +# someipy - A Python Library for the SOME/IP Protocol :artificial_satellite: + +## Feature Requests, Bugs, Contact + +For feature requests or bug reports, send a message on GitHub or write an email to: +> :email: [someipy.package@gmail.com](mailto:someipy.package@gmail.com) + +## 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. @@ -12,6 +19,16 @@ someipy is based on the specification version of R22-11: The library is currently developed and tested under Ubuntu 22.04 and Python 3.12. +## 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](#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](#example-applications) *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](#example-applications) *receive_events_udp.py* illustrates this process. + ## Installation The package can be installed from [PyPi](https://pypi.org/project/someipy/).