diff --git a/.gitignore b/.gitignore index c9c2222..bf8e857 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,4 @@ .idea _tmp cmake-build-* -_build \ No newline at end of file +_build diff --git a/README.md b/README.md index 0318e41..fd41a25 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,30 @@ -This is the implementation of Example module. Repo contains example_module libraries and a python client. +# Introduction -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. +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. -For more details on the module, see [module documentation](./docs/module_documentation_template.md). +## Identification and Purpose -# Requirements +Module number/ID: `1000` -- fleet protocol library - [v2.0.0](https://github.com/bringauto/fleet-protocol/releases/tag/v2.0.0) +### Device list -# Build +| **Device Name** | **Device Type** | **Device Roles** | Comment | +| --------------- | --------------- | ---------------- | ------------------------------------------- | +| button1 | 0 | test | Button driving a state of a dedicated LED | +| button1 | 10 | test | Button driving a state of a dedicated LED | +| button2 | 0 | test2 | Button driving a state of a dedicated LED | + +**For better understanding of the module functionality and how to implement your own modules, see [module documentation](./docs/example_module.md).** + +## Dependencies + +- [CMakeLib](https://github.com/cmakelib/cmakelib) + +## Build ```bash mkdir _build && cd _build -cmake .. -DCMLIB_DIR= +cmake .. -DCMLIB_DIR= make ``` @@ -21,5 +32,10 @@ make 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. -# Example module client +## Configuration + +This module does not require any configuration. + +## Example module client + See [client readme](./python_client/README.md)