Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/chrberger/cluon-livefeed
A tiny tool for libcluon-based OD4Sessions to display which Envelopes are currently exchanged.
https://github.com/chrberger/cluon-livefeed
aarch64 armhf docker docker-image libcluon microservice opendavinci opendlv x86-64
Last synced: 27 days ago
JSON representation
A tiny tool for libcluon-based OD4Sessions to display which Envelopes are currently exchanged.
- Host: GitHub
- URL: https://github.com/chrberger/cluon-livefeed
- Owner: chrberger
- License: gpl-3.0
- Created: 2018-03-31T20:07:20.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2021-12-04T08:44:47.000Z (about 3 years ago)
- Last Synced: 2024-11-09T10:06:35.117Z (2 months ago)
- Topics: aarch64, armhf, docker, docker-image, libcluon, microservice, opendavinci, opendlv, x86-64
- Language: C++
- Homepage:
- Size: 272 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# cluon-livefeed
`cluon-livefeed` is a microservice for [libcluon](https://github.com/chrberger/libcluon)-based [OD4Sessions](https://github.com/chalmers-revere/opendlv) to display the currently exchanged messages in [`Envelope`](https://github.com/chrberger/libcluon/blob/master/libcluon/resources/cluonDataStructures.odvd#L23-L30) data format.
[](https://raw.githubusercontent.com/chrberger/libcluon/master/LICENSE)
## Table of Contents
* [Features](#features)
* [Dependencies](#dependencies)
* [Usage](#usage)
* [License](#license)
## Features
* Written in highly portable and high quality C++14
* Data-driven display of any messages exchanged in [`Envelope`](https://github.com/chrberger/libcluon/blob/master/libcluon/resources/cluonDataStructures.odvd#L23-L30) data format from a running [OD4Sessions](https://github.com/chalmers-revere/opendlv) session
* Available as Docker images for [x86_64](https://hub.docker.com/r/chrberger/cluon-livefeed-amd64/tags/), [armhf](https://hub.docker.com/r/chrberger/cluon-livefeed-armhf/tags/), and [aarch64](https://hub.docker.com/r/chrberger/cluon-livefeed-aarch64/tags/)
* To simplify the usage for your platfrom, we also provide a [multi](https://hub.docker.com/r/chrberger/cluon-livefeed-multi/tags/)-platform Docker image
## Dependencies
No dependencies! You just need a C++14-compliant compiler to compile this
project as it ships its dependencies as part of the source distribution:
* [libcluon](https://github.com/chrberger/libcluon) - [](https://www.gnu.org/licenses/gpl-3.0.txt)
## Usage
This microservice is supposed to be used in parallel with a running [OD4Sessions](https://github.com/chalmers-revere/opendlv) with other microservices that exchange messages in [`Envelope`](https://github.com/chrberger/libcluon/blob/master/libcluon/resources/cluonDataStructures.odvd#L23-L30) data format. The purpose of this microservice to display the type and timestamps of the currently exchanged messages on console. It can be used as shown in the following:
```
docker run --rm -ti --init --net=host ghcr.io/chrberger/cluon-livefeed:latest --cid=111
```
Additionally, you can supply a message specification in `.odvd`-file like, for example, the [OpenDLV Standard Message Set](https://github.com/chalmers-revere/opendlv.standard-message-set/blob/master/opendlv.odvd) to dynamically resolve the data types of the exchanged messages. In the following, it is assumed that you have the `.odvd`-file named `example.odvd` residing in the current working directory:
```
docker run --rm -ti --init --net=host -v $PWD:/opt ghcr.io/chrberger/cluon-livefeed:latest --cid=111 --odvd=/opt/example.odvd
```
## License
* This project is released under the terms of the GNU GPLv3 License