https://github.com/eclipse-uprotocol/up-transport-zenoh-cpp
C++ client library to connect to the zenoh implementation of uProtocol
https://github.com/eclipse-uprotocol/up-transport-zenoh-cpp
cpp up-transport uprotocol zenoh
Last synced: about 1 year ago
JSON representation
C++ client library to connect to the zenoh implementation of uProtocol
- Host: GitHub
- URL: https://github.com/eclipse-uprotocol/up-transport-zenoh-cpp
- Owner: eclipse-uprotocol
- License: apache-2.0
- Created: 2023-09-26T14:58:24.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-04-07T19:23:58.000Z (about 1 year ago)
- Last Synced: 2025-04-07T19:30:21.369Z (about 1 year ago)
- Topics: cpp, up-transport, uprotocol, zenoh
- Language: C++
- Size: 149 KB
- Stars: 6
- Watchers: 5
- Forks: 20
- Open Issues: 37
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.adoc
- License: LICENSE
Awesome Lists containing this project
- awesome-zenoh - `up-transport-zenoh-cpp` - C++ implementation. (Eclipse SDV)
README
# uProtocol C++ Zenoh Transport (up-transport-zenoh-cpp)
## Welcome!
This library provides a Zenoh-based uProtocol transport for C++ uEntities.
*_IMPORTANT NOTE:_ This project is under active development*
This module contains the Zenoh implementation of the Layer 1 `UTransport` API
from [up-cpp][cpp-api-repo].
## Getting Started
### Requirements:
- Compiler: GCC/G++ 11 or Clang 13
- Conan : 1.59 or latest 2.X
#### Conan packages
Using the recipes found in [up-conan-recipes][conan-recipe-repo], build these
Conan packages:
1. [up-core-api][spec-repo] - `conan create --version 1.6.0 --build=missing up-core-api/release`
1. [up-cpp][cpp-api-repo] - `conan create --version 1.0.1-rc1 --build=missing up-cpp/release`
2. [zenoh-c][zenoh-repo] - `conan create --version 0.11.0 zenoh-tmp/from-source`
**NOTE:** all `conan` commands in this document use Conan 2.x syntax. Please
adjust accordingly when using Conan 1.x.
## How to Use the Library
To add up-transport-zenoh-cpp to your conan build dependencies, place following
in your conanfile.txt:
```
[requires]
up-transport-zenoh-cpp/[>=1.0.0 <2.0.0]
[generators]
CMakeDeps
CMakeToolchain
[layout]
cmake_layout
```
**NOTE:** If using conan version 1.59 Ensure that the conan profile is
configured to use ABI 11 (libstdc++11: New ABI) standards according to
[the Conan documentation for managing gcc ABIs][conan-abi-docs].
## Building locally
The following steps are only required for developers to locally build and test
up-transport-zenoh-cpp, If you are making a project that uses
up-transport-zenoh-cpp, follow the steps in the
[How to Use the Library](#how-to-use-the-library) section above.
### With Conan for dependencies
```
cd up-client-zenoh-cpp
conan install . --build=missing
cmake --preset conan-release
cd build/Release
cmake --build . -- -j
```
Once the build completes, tests can be run with `ctest`.
### With dependencies installed as system libraries
**TODO** Verify steps for pure cmake build without Conan.
### Creating the Conan package
See: [up-conan-recipes][conan-recipe-repo]
## Show your support
Give a ⭐️ if this project helped you!
[conan-recipe-repo]: https://github.com/eclipse-uprotocol/up-conan-recipes
[spec-repo]: https://github.com/eclipse-uprotocol/up-spec
[cpp-api-repo]: https://github.com/eclipse-uprotocol/up-cpp
[zenoh-repo]: https://github.com/eclipse-zenoh/zenoh-cpp
[conan-abi-docs]: https://docs.conan.io/en/1.60/howtos/manage_gcc_abi.html