|
1 | | -This is the implementation of Example module. Repo contains example_module libraries and a python client. |
| 1 | +# Introduction |
2 | 2 |
|
3 | | -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. |
4 | | -Module number of this module is 1000. |
| 3 | +The Example Module is an illustrative module for BringAuto's [Fleet Protocol](https://github.com/bringauto/fleet-protocol). It serves as a template for module maintainers to implement their own modules outside the reserved range. **Note**: This module is not intended for production use. |
5 | 4 |
|
6 | | -For more details on the module, see [module documentation](./docs/module_documentation_template.md). |
| 5 | +## Identification and Purpose |
7 | 6 |
|
8 | | -# Requirements |
| 7 | +Module number/ID: `1000` |
9 | 8 |
|
10 | | -- fleet protocol library - [v2.0.0](https://github.com/bringauto/fleet-protocol/releases/tag/v2.0.0) |
| 9 | +### Device list |
11 | 10 |
|
12 | | -# Build |
| 11 | +| **Device Name** | **Device Type** | **Device Roles** | Comment | |
| 12 | +| --------------- | --------------- | ---------------- | ------------------------------------------- | |
| 13 | +| button1 | 0 | test | Button driving a state of a dedicated LED | |
| 14 | +| button1 | 10 | test | Button driving a state of a dedicated LED | |
| 15 | +| button2 | 0 | test2 | Button driving a state of a dedicated LED | |
| 16 | + |
| 17 | +**For better understanding of the module functionality and how to implement your own modules, see [module documentation](./docs/example_module.md).** |
| 18 | + |
| 19 | +## Dependencies |
| 20 | + |
| 21 | +- [CMakeLib](https://github.com/cmakelib/cmakelib) |
| 22 | + |
| 23 | +## Build |
13 | 24 |
|
14 | 25 | ```bash |
15 | 26 | mkdir _build && cd _build |
16 | | -cmake .. -DCMLIB_DIR=<path-to-cmakelib-dir> |
| 27 | +cmake .. -DCMLIB_DIR=<CMAKELIB_DIR> |
17 | 28 | make |
18 | 29 | ``` |
19 | 30 |
|
20 | 31 | > cmakelib directory is absolute path to [this](https://github.com/cmakelib/cmakelib) repo root directory. |
21 | 32 |
|
22 | 33 | Now 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. |
23 | 34 |
|
24 | | -# Example module client |
| 35 | +## Configuration |
| 36 | + |
| 37 | +This module does not require any configuration. |
| 38 | + |
| 39 | +## Example module client |
| 40 | + |
25 | 41 | See [client readme](./python_client/README.md) |
0 commit comments