Ruuvi Firmware version 3. Built on top of Nordic SDK 15, uses both Ruuvi and external repositories as submodules. Under development, please follow Ruuvi Blog for details. The project is in beta stage, no breaking changes are intented but will be done if absolutely necessary for some reason.

Download Nordic SDK15.3 and install it at the project root. If you're working on multiple nRF projects, you can (and should) use softlinking instead.

Run git submodule update --init --recursive. This will search for and install the other git repositories referenced by this project. If any of the submodules has a changed remote, you'll need to run git submodule sync --recursive and again git submodule update --init --recursive to update the modules from new remotes.

ARMGCC is used for Jenkins builds, it's recommended to use SES for developing. You can make the project and all variants by runnning "make" at top level of this repository.

Segger Embedded Studio can be set up by installing nRF Connect for Desktop and following Getting Started plugin instructions.

Start SES and open ruuvi_ruuvi.firmware.c.emProject at root level, each of the target boards is in their own project.

Code is formatted with Artistic Style. Run astyle --project=.astylerc ./target_file. To format the entire project,

astyle --project=.astylerc "src/main.c"
astyle --project=.astylerc --recursive "src/application_config/*.h"
astyle --project=.astylerc --recursive "src/tasks/*.c"
astyle --project=.astylerc --recursive "src/tasks/*.h"
astyle --project=.astylerc --recursive "src/tests/*.c"
astyle --project=.astylerc --recursive "src/tests/*.h"

The code can be checked with PVS Studio and Sonarcloud for some common errors, style issues and potential problems. Here is a link to generated report which gets pushed to GitHub.

Obtain license and software from Viva64.

Make runs PVS Studio scan and outputs results under doxygen/html/fullhtml.

This results into hundreds of warnings, it is up to you to filter the data you're interested in. For example you probably want to filter out warnings related to 64-bit systems.

Travis pushes the results to SonarCloud.IO. SonarCloud uses access token which is private to Ruuvi, you'll need to fork the project and setup the SonarCloud under your own account if you wish to run Sonar Scan on your own code.

Unit tests are implemented with Ceedling. Run the tests with ceedling test:all

Ceedling can also generate Gcov reports with ceedling gcov:all utils:gcov. The report can be found under build/artifacts/gcov.

Travis will fail the build if unit test fails and Gcov results will get pushed to SonarCloud.

Compile and flash the project to your board using SES if you're developing. Note: You should erase your board entirely in case there is a bootloader from a previous firmware.

If you're building binaries for distribution, you can and should use the make script to generate binaries. This way you can be certain to have a repeatable build process. The makefile takes tag name of current git commit and names the binaries with the tag. The version information also gets compiled into binaries. If you have tagged the version as v3.99.1 the outputs will be named $BOARD_armgcc_ruuvifw_$VARIANT_v3.99.1_$TYPE.extension. For example ruuvitag_b_armgcc_ruuvifw_default_v3.29.3-rc1_full.hex.

Tags should be valid semantic versions, starting with v and posssibly having pre-release information such as -rc2. Do not add build information such as +TestFW.

Please let us know your thoughts on the direction and structure of the project. Does the project help you to understand how to build code on RuuviTag? Is the structure of the project sensible to you?

If you want to assist in the project maintenance by fixing some issues doxygen.error is a good place to look for code which needs better commenting. Project badges at the top of the readme point to issues which range from trivial clarifications to complex refactoring.

If you want to add new features, please discuss the feature first, and then create ceedling unit tests for the functionality. Once the functionality is agreed and testable in can be integrated into project.

Ruuvi code is BSD-3 licensed. Submodules and external dependencies have their own licenses, which are BSD-compatible.

Document is generated with Doxygen. Run make doxygen to generate the docs locally, or browse to Travis built docs