https://github.com/thoughtworks/smip
A framework for SOME/IP development in Rust
https://github.com/thoughtworks/smip
rust sdv someip
Last synced: about 1 month ago
JSON representation
A framework for SOME/IP development in Rust
- Host: GitHub
- URL: https://github.com/thoughtworks/smip
- Owner: thoughtworks
- License: apache-2.0
- Created: 2024-04-30T07:47:15.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-08-07T14:10:11.000Z (10 months ago)
- Last Synced: 2024-08-07T22:50:24.443Z (10 months ago)
- Topics: rust, sdv, someip
- Language: Rust
- Homepage:
- Size: 124 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# smip - A framework for SOME/IP development in Rust
**smip** aims to make SOME/IP development in Rust feel as natural as building regular web services.
It offers a higher-level abstraction over the underlying protocol, making it easier to use and understand by providing a cleaner more structured way to define services by leveraging Rust's powerful macro system, something similar to [rocket.rs](https://rocket.rs/) but for SOME/IP.
## Example
Let's look at a simple "Hello World" example using smip.
```rust
use smip::{Runtime, RuntimeConfig, Service};
#[smip::service(id = 0x1234, major_version = 1, minor_version = 0)]
struct MyService {
x: u32,
}
#[smip::methods_impl]
impl MyService {
#[smip_method(id = 1)]
fn add(&mut self, value: u32) -> u32 {
self.x += value;
self.x
}
#[smip_method(id = 2)]
fn hello(&self) -> String {
"Hello World!".to_string()
}
}
fn main() {
let config = smip::RuntimeConfig::new("Simple", 0xABCD, 0x1);
let application = Runtime::new(config).service(
MyService {
x: 0
}, 30509);
let _ = application.run();
}
```
A service is represented by a struct, `MyService` in this case, with a `service` attribute for providing its `id` and other metadata like the `major_version` (optional) and `minor_version` (optional). This struct will also hold all of the service's state.
SOME/IP methods are just rust methods with a special `smip_method` attribute to indicate its id. Whatever you pass as an argument to your method is parsed automatically from the payload, and whatever you return from it serialized into a response and sent back.
All of these need to be in a special impl block marked with a `methods_impl` attribute for the framework to recognize them.
There are two methods
A `Runtime` needs to be created using a `RuntimeConfig` which which take care of creating and running all of your services.
After adding all your services to the `Runtime`, call `runtime.run()` to start all the services.
## Goal
**smip** aims to be a SOME/IP framework and not an implementation of SOME/IP, so its not competing with [vSomeIP](https://github.com/COVESA/vsomeip) or [SommR](https://projects.eclipse.org/projects/automotive.sommr). Currently vSomeIP is used as the underlying implementation but this can be swapped with any compliant implementation in the future.
## Key Benefits
* **Macro-Based Definition**: The smip macro simplifies the definition of services and methods, reducing the amount of code needed.
* **Automatic Serialization/Deserialization**: smip handles the serialization and deserialization of your service's data types, so you don't have to write it yourself.
* **Rust-Idiomatic API**: The framework's API is designed to be Rust-friendly, with a focus on clarity and simplicity.
* **Improved Developer Experience**: smip streamlines the development process, making it easier to create and manage SOME/IP services in Rust.
⚠️ **This is a highly experimental framework and doesn't support all of the features in SOME/IP**
## Build
**smip** requires a working installation of vsomeip, for more info refer to the **Install vsomeip** section of the [vsomeip-rs README](crates/vsomeip-rs/README.md).
## Run
For a working demo see `examples/simple.rs` and `examples/simple_client.rs`:
To run locally,
```bash
cargo run --example simple
```
In another terminal,
```bash
cargo run --example simple_client
```
- You may need to set the `LD_LIBRARY_PATH` environment to a path that contains the vSomeIP library as this is dynamically loaded `LD_LIBRARY_PATH=/usr/local/lib`
## License
- smip is licensed under [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0), check [LICENSE.md](./LICENSE.md) for more information.
- This project uses the vSomeIP library which is licensed under [MPL 2.0](https://www.mozilla.org/en-US/MPL/2.0/).