diff --git a/README.md b/README.md index c384d8a..e87f70b 100644 --- a/README.md +++ b/README.md @@ -8,19 +8,20 @@ VSS-Lib is considered a middleware Python library and D-Bus service designed to 1. [VSS-Lib: Vehicle Signal Specification Library](#vss-lib-vehicle-signal-specification-library) 2. [Features](#features) -3. [Requirements](#requirements) -4. [Installation](#installation) +3. [Benefits of VSS-Lib](#benefits-of-vss-lib) +4. [Requirements](#requirements) +5. [Installation](#installation) - [Step 1: Clone the Repository](#step-1-clone-the-repository) - [Step 2: Install Python Dependencies](#step-2-install-python-dependencies) - [Step 3: Install the Library](#step-3-install-the-library) - [Step 4: Install the Systemd Service](#step-4-install-the-systemd-service) - [Step 5: Configure the VSS Paths](#step-5-configure-the-vss-paths) -5. [Monitoring Signals on the D-Bus Interface](#monitoring-signals-on-the-d-bus-interface) -6. [Sending Hardware Signals](#sending-hardware-signals) -7. [Uninstalling](#uninstalling) -8. [Makefile](#makefile) -9. [Contributing](#contributing) -10. [License](#license) +6. [Monitoring Signals on the D-Bus Interface](#monitoring-signals-on-the-d-bus-interface) +7. [Sending Hardware Signals](#sending-hardware-signals) +8. [Uninstalling](#uninstalling) +9. [Makefile](#makefile) +10. [Contributing](#contributing) +11. [License](#license) ## Features @@ -29,6 +30,39 @@ VSS-Lib is considered a middleware Python library and D-Bus service designed to - Attach electronics vendors to vehicle models for simulation. - Monitor D-Bus for vehicle signal data. +## Benefits of VSS-Lib + +### 1. **Standardization and Interoperability** + - **VSS-Lib** provides a standardized framework for defining and managing vehicle signals across different vendors, making it easier to share, interpret, and exchange data across the ecosystem. + - A standardized approach reduces fragmentation, ensuring vendors can work with other systems more seamlessly. + +### 2. **Time and Cost Efficiency** + - Developing proprietary software to handle vehicle signals can be expensive and time-consuming. By using **VSS-Lib**, vendors leverage an existing solution, allowing them to focus on other core aspects of their products. + - **VSS-Lib** already comes with pre-built functionality for signal management, reducing the need for vendors to reinvent the wheel. + +### 3. **Compliance with Industry Trends** + - **VSS-Lib** is aligned with industry initiatives like **W3C Automotive** and **COVESA VSS**, ensuring that vendors stay in line with industry standards. + - Vendors can rely on **VSS-Lib** to maintain compliance with increasing regulatory requirements for data sharing and signal management. + +### 4. **Modular and Extensible** + - **VSS-Lib** is designed to be modular, allowing vendors to customize and extend it based on their specific needs without building a new system. + - Vendors can easily attach their specific signals, protocols, and data structures while benefiting from the standardized structure. + +### 5. **Easier Collaboration Across Vendors** + - When different electronics and car vendors work together, using **VSS-Lib** makes collaboration smoother, especially when integrating electronics from multiple suppliers. + +### 6. **Future-Proofing** + - **VSS-Lib** is built to accommodate future changes in technology and regulation. Vendors can rely on the **VSS-Lib** community to handle changes in signal standards and requirements. + +### 7. **Open Source Community and Support** + - **VSS-Lib** benefits from constant development, improvements, and community support, leading to faster bug fixes and enhancements. + +### 8. **Compatibility Across Industries** + - **VSS-Lib** provides a unified structure that can be adapted for various industries, including automotive, aerospace, medical devices, and drones. + +### 9. **Focus on Hardware Innovation** + - Vendors can focus on hardware development and improving product capabilities without developing custom software, leveraging **VSS-Lib** as a common communication layer. + ## Requirements - Python 3.10+ @@ -58,7 +92,7 @@ source venv/bin/activate ### Step 3: Install the Library -Install the library and the vss dbus demo service: +Install the library and the VSS D-Bus demo service: ```bash sudo pip install . @@ -69,7 +103,7 @@ sudo journalctl -u vss-dbus.service -f # Monitor the deploy sudo dbus-monitor --system "interface=com.vss_lib.VehicleSignals" # See all signals being sent ``` -Start monitoring the Car Manufactors vendors and partners "speaking" the Vehicle Signal Specification (VSS) protocol on top of Fedora, CentOS. +Start monitoring the Car Manufacturers' vendors and partners "speaking" the Vehicle Signal Specification (VSS) protocol on top of Fedora, CentOS. ```bash sudo dbus-monitor --system "interface=com.vss_lib.VehicleSignals" @@ -108,7 +142,9 @@ e62bf9a0e121 localhost/bmw_vss_image:latest sh -c /usr/lib/py... About a 161f79e61eb7 localhost/volvo_vss_image:latest sh -c /usr/lib/py... About a minute ago Up About a minute volvo_vss_container ``` -### Step 4: Install the Systemd Service (setup.py should do for you but in case you want to execute manual steps) +### Step 4 + +: Install the Systemd Service To enable and start the D-Bus service, follow these steps: @@ -230,3 +266,4 @@ Feel free to open an issue or submit a pull request if you'd like to contribute ## License This project is licensed under the Apache License 2.0. See the [LICENSE](LICENSE) file for more details. +```