Skip to content

Commit

Permalink
PR feedback fixes:
Browse files Browse the repository at this point in the history
* Remove unneeded commented out line of code
* Include additional vsomeip pointers / links
* Update with intra-doc link for README.md
  • Loading branch information
PLeVasseur committed Aug 13, 2024
1 parent 1da18e4 commit 00326fb
Show file tree
Hide file tree
Showing 6 changed files with 18 additions and 24 deletions.
3 changes: 2 additions & 1 deletion up-linux-streamer-plugin/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,8 @@ keywords.workspace = true
license.workspace = true

[features]
default = ["dynamic_plugin", "zenoh/default", "zenoh/unstable", "zenoh/plugins"]
default = ["bundled-vsomeip", "dynamic_plugin", "zenoh/default", "zenoh/unstable", "zenoh/plugins"]
bundled-vsomeip = ["up-transport-vsomeip/bundled"]
dynamic_plugin = []

[lib]
Expand Down
16 changes: 13 additions & 3 deletions up-linux-streamer-plugin/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,9 +46,17 @@ LinuxStreamerZenohPlugin ..> ZenohRouter: loaded by
### Build the plugin

```bash
LD_LIBRARY_PATH=<your/path/to/vsomeip/lib> VSOMEIP_LIB_DIR=<your/path/to/vsomeip/lib> cargo build
LD_LIBRARY_PATH=<path/to/where/to/install/vsomeip/lib> VSOMEIP_INSTALL_PATH=<path/to/where/to/install/vsomeip/lib> cargo build
```

### Bundled vsomeip or bring your own

The default is to build a bundled version of [vsomeip](https://github.com/COVESA/vsomeip) for use by the `up-transport-vsomeip` crate.

The vsomeip library is used to communicate over [SOME/IP](https://some-ip.com/) to mechatronics devices.

If you wish to bring your own vsomeip install, you can use the flag `--no-default-features` flag when building with `cargo build`. For more details on required environment variables when building `up-transport-vsomeip-rust`, reference the README for [vsomeip-sys](https://github.com/eclipse-uprotocol/up-transport-vsomeip-rust/tree/main/vsomeip-sys).

### Copy plugin and configs to standalone folder

```bash
Expand All @@ -58,10 +66,12 @@ cp up-linux-streamer-plugin/DEFAULT_CONFIG.json5 my/new/standalone/zenohd/path/
cp -r up-linux-streamer-plugin/vsomeip-configs my/new/standalone/zenohd/path/
```

### Using the plugin
### A note on compatability

Because up-transport-zenoh-rust uses minimum supported Rust version (**MSRV**) of 1.74.0 and up-rust uses MSRV of 1.72.1, we need to build Zenoh from source in order to get a compatible zenohd (Zenoh Router). The following steps describe how to do so.

Note: We have an open issue [here](https://github.com/eclipse-uprotocol/up-streamer-rust/issues/43) which is for creating a compatible Zenoh Router (zenohd) which will avoid the next section.

### Getting Zenoh

https:
Expand Down Expand Up @@ -162,7 +172,7 @@ You may also run the other examples similarly.

### up-linux-streamer-plugin configuration

A configuration file is required to be supplied to `zenohd` as shown in the `Using the Plugin` section.
A configuration file is required to be supplied to `zenohd` as shown in the [Using the plugin](#using-the-plugin) section.

`DEFAULT_CONFIG.json5` is provided as a starting point, but can have certain parameters modified. Please reference it for guidance.

Expand Down
9 changes: 0 additions & 9 deletions up-linux-streamer-plugin/vsomeip-configs/mE_client.json

This file was deleted.

9 changes: 0 additions & 9 deletions up-linux-streamer-plugin/vsomeip-configs/mE_service.json

This file was deleted.

4 changes: 3 additions & 1 deletion up-linux-streamer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,9 @@ As well, the `ZENOH_CONFIG.json5` file is used to set Zenoh configurations. By d

### Bundled vsomeip or bring your own

The default is to build a bundled version of vsomeip for use by the `up-transport-vsomeip` crate.
The default is to build a bundled version of [vsomeip](https://github.com/COVESA/vsomeip) for use by the `up-transport-vsomeip` crate.

The vsomeip library is used to communicate over [SOME/IP](https://some-ip.com/) to mechatronics devices.

If you wish to bring your own vsomeip install, you can use the flag `--no-default-features` flag when building with `cargo build`. For more details on required environment variables when building `up-transport-vsomeip-rust`, reference the README for [vsomeip-sys](https://github.com/eclipse-uprotocol/up-transport-vsomeip-rust/tree/main/vsomeip-sys).

Expand Down
1 change: 0 additions & 1 deletion utils/hello-world-protos/build.rs
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ fn main() -> std::io::Result<()> {
// use vendored protoc instead of relying on user provided protobuf installation
env::set_var("PROTOC", protoc_bin_vendored::protoc_bin_path().unwrap());

// if let Err(err) = get_and_build_protos(
if let Err(err) = get_and_build_protos(
&[
"https://raw.githubusercontent.com/googleapis/googleapis/master/google/type/timeofday.proto",
Expand Down

0 comments on commit 00326fb

Please sign in to comment.