https://github.com/eclipse-uprotocol/up-transport-vsomeip-rust
Rust uPClient for vsomeip (SOME/IP)
https://github.com/eclipse-uprotocol/up-transport-vsomeip-rust
rust up-transport uprotocol vsomeip
Last synced: 6 months ago
JSON representation
Rust uPClient for vsomeip (SOME/IP)
- Host: GitHub
- URL: https://github.com/eclipse-uprotocol/up-transport-vsomeip-rust
- Owner: eclipse-uprotocol
- License: apache-2.0
- Created: 2024-02-28T07:44:24.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-08-09T11:52:11.000Z (about 1 year ago)
- Last Synced: 2024-08-09T21:21:54.028Z (about 1 year ago)
- Topics: rust, up-transport, uprotocol, vsomeip
- Language: Rust
- Size: 67.4 KB
- Stars: 0
- Watchers: 7
- Forks: 4
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Eclipse uProtocol Rust vsomeip Client
## Overview
This library implements a uTransport client for vsomeip in Rust following the uProtocol [uTransport Specifications](https://github.com/eclipse-uprotocol/uprotocol-spec/blob/main/up-l1/README.adoc).
## Getting Started
### Building the Library
To build the library, run:
```bash
VSOMEIP_INSTALL_PATH= GENERIC_CPP_STDLIB_PATH= ARCH_SPECIFIC_CPP_STDLIB_PATH= cargo build
```
in the project root directory.
See `vsomeip-sys/README.md` for more details on options.
This library leverages the [up-rust](https://github.com/eclipse-uprotocol/up-rust) library for data types and models specified by uProtocol.
### Running the Tests
To run the tests, run
```bash
VSOMEIP_INSTALL_PATH= LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/lib GENERIC_CPP_STDLIB_PATH= ARCH_SPECIFIC_CPP_STDLIB_PATH= cargo test -- --test-threads 1
```
Breaking this down:
* Details about the environment variables can be found in `vsomeip-sys/README.md`. Please reference there for further detail.
* We need to pass in `-- --test-threads 1` because the tests refer to the same configurations and will fall over if they are run simultaneously. So we instruct to use a single thread, i.e. run the tests in serial.
### Using the Library
The library contains the following modules:
Package | [uProtocol spec](https://github.com/eclipse-uprotocol/uprotocol-spec) | Purpose
---|---|---
transport | [uP-L1 Specifications](https://github.com/eclipse-uprotocol/uprotocol-spec/blob/main/up-l1/README.adoc) | Implementation of vsomeip uTransport client used for bidirectional point-2-point communication between uEs.