diff --git a/README.md b/README.md index 1872026..7a4b37e 100644 --- a/README.md +++ b/README.md @@ -2,15 +2,49 @@ [![Build Status](https://travis-ci.com/wirepas/backend-apis.svg?branch=master)](https://travis-ci.com/wirepas/backend-apis) -This repository contains the linux gateway protocol buffer definitions and -language specific wrappers. +This repository contains the message definition files for the Wirepas' +service APIs, specifically: -Language wrappers: +- [Wirepas Gateway][here_gateway] +- [Wirepas Network Tool][here_wnt] +- [Wirepas Positioning Engine][here_wpe] -- [Python: wirepas_messaging][here_python] +In addition to the the message specification files, the repository contains language specific wrappers (classes, function, ...) that simplify the translation of the API data into a target language object (see Figure 1). + +![runtime operation of wm-config][here_docs_operation] + +**Figure 1 -** Illustration of messaging wrapper's function within applications. + +## Language wrappers + +- **Python**: wirepas_messaging \[[source][here_python]\] \[[PyPi][pypi_messaging]\] + +## Contributing + +We welcome your contributions! + +Please read the [instructions on how to do it][here_contribution] +and please review our [code of conduct][here_code_of_conduct]. ## License -Licensed under the Apache License, Version 2.0. See LICENSE for the full license text. +Licensed under the Apache License, Version 2.0. +See [LICENSE][here_license] for the full license text. [here_python]: https://github.com/wirepas/backend-apis/tree/master/wrappers/python + +[here_docs_operation]: ./docs/img/overview.png + +[here_gateway]: ./gateway_to_backend + +[here_wpe]: ./wpe + +[here_wnt]: ./wnt + +[pypi_messaging]: https://pypi.org/project/wirepas-messaging/ + +[here_code_of_conduct]: https://github.com/wirepas/backend-apis/blob/master/CODE_OF_CONDUCT.md + +[here_contribution]: https://github.com/wirepas/backend-apis/blob/master/CONTRIBUTING.md + +[here_license]: https://github.com/wirepas/backend-apis/blob/master/LICENSE diff --git a/docs/img/overview.png b/docs/img/overview.png new file mode 100644 index 0000000..96dfeea Binary files /dev/null and b/docs/img/overview.png differ diff --git a/docs/img/overview.svg b/docs/img/overview.svg new file mode 100644 index 0000000..86d7478 --- /dev/null +++ b/docs/img/overview.svg @@ -0,0 +1,848 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + image/svg+xml + + + + + + + + + + + Sheet.742 + + + Wirepas Gateway to Backend API Protocol buffer messages + + + import wirepas_messaging + + + + Sheet.742 + + + Wirepas Network Tool Client APIProtocol buffer messages + + Sheet.742 + + + Wirepas Positioning Engine APIProtocol buffer messages + Protocol buffer to language object translationWirepas' public API function wrappers + + + + Application code + + + +