An open API service indexing awesome lists of open source software.

https://github.com/bringauto/example-module

Implementation of Example module for Fleet protocol v2
https://github.com/bringauto/example-module

example fleet-protocol fleet-protocol-module

Last synced: about 2 months ago
JSON representation

Implementation of Example module for Fleet protocol v2

Awesome Lists containing this project

README

          

This is the implementation of Example module. Repo contains example_module libraries and a python client.

This module serves as an example for module maintainers to implement their own modules outside reserved range of modules. It is not intended to be used in production.
Module number of this module is 1000.

For more details on the module, see [module documentation](./docs/module_documentation_template.md).

# Requirements

- fleet protocol library - [v2.0.0](https://github.com/bringauto/fleet-protocol/releases/tag/v2.0.0)
- [CMakeLib](https://github.com/cmakelib/cmakelib)

# Build

```bash
mkdir _build && cd _build
cmake ..
make
```

The shared libraries `example_module_module_manager.so` and `example_module_external_server.so` should be compiled in current directory. Use `example_module_module_manager.so` with module gateway and `example_module_external_server.so` with external server.

# Example module client

See [client readme](./python_client/README.md)