Skip to content

Align readme with bringauto guidelines #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.idea
_tmp
cmake-build-*
_build
_build
34 changes: 25 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,41 @@
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=<path-to-cmakelib-dir>
cmake .. -DCMLIB_DIR=<CMAKELIB_DIR>
make
```

> cmakelib directory is absolute path to [this](https://github.com/cmakelib/cmakelib) repo root directory.

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)