/ruuvi.endpoints.c

Data endpoints for abstracting source (i.e. bme280) from data (i.e. temperature). Under development, not recommended for any use yet.

Primary LanguageCBSD 3-Clause "New" or "Revised" LicenseBSD-3-Clause

ruuvi.endpoints.c

Data endpoints for abstracting source (e.g. bme280) from data (e.g. temperature).

GH-Pages Ceedling Quality Gate Status Coverage Bugs Code Smells

Embedding to your application

Include a tagged release to your application as a git submodule. If you define APPLICATION_ENDPOINTS_CONFIGURED in preprocessor, you can select which endpoints to compile by adding definitions #define RE_3_ENABLED 1 , #define RE_5_ENABLED 1 etc in "app_config.h" inside your application.

Developing

Unit testing

Unit tests are run by Ceedling.

Static code analysis

Test coverage and code analysis are reported by Sonarcloud. Additionally the project is analyzed with PVS Studio and report is published to GH Pages

Styling

Styling is done via Artisitic Style, following configuration at .astylerc.

Documentation

Documentation is autogenerated to GH-Pages. On pull requests, the documentation is generated to gh-pages-check branch.

Customization for private projects

Use 0xF0 ... 0xFF space for custom header and type bytes. With the exception of 0xFA-header adveertisement, Ruuvi does not have official uses which start with these headers. This way future Ruuvi development won't conflict with your development.

Changelog

See CHANGELOG.md