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 alpha stage, build maybe broken in obvious ways and not build at all or in non-obvious ways and fail on some Ruuvi boards.
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.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. Instructions on how to use a bootloader will be added later on. The project is not yet in a useful state for any practical purpose other than learning.
Note: You should erase your board entirely in case there is a bootloader from a previous firmware.
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.
- Add Travis CI and SonarCloud support
- Convert project to use Ceedling for unit tests.
- Bugfixes
- Add longlife-logging
- Fix storing and loading sensor configurations
- Store fatal error sources to flash before reboot.
- Use busyloop in log flush to avoid getting stuck if logs are flushed in interrupt context
- Initialize variables in environmental logging to zero. Explicit U64->U32 timestamp typecast.
- Fix errors in data format 5 encoding
- Known issue: timestamps are occasionally wrong in log data
- Rework task structure
- Add "hearbeat" transmissions to GATT
- Add SD+BL+APP DFU builds
- Do not block if RTT logs are not read in debug mode
- Fix build script in case of out-of-master submodule commits
- Fix Keijo build
- Improve logging sent elements.
- Send 0xFFFFFFFF payload at the end of log data
- Block until RTT logs are sent in debug mode
- Add Humidity, pressure logging PoC
- Add Temperature logging PoC
- Switch Keijo to S140 for Coded PHY
- Discard Keijo GATT, bootlaoder
- Fit Keijo application in nRF52811
- Initial support for "Keijo"-project
- Port to SDK15.3
- Initial support for "Kaarle"-project
- Use acceleration interrupts for movement counter
- Add low-power delay to drivers
- Try to initialize a separate pressure sensor if using SHTC as environmental sensor
- Add pressure sensor tasks
- Various reworks and refactoring.
- Use refactored drivers.
- Add NFC writes to tag
- Disable GATT
- Use activity interrupts, advertise data format 5
- Trigger watchdog if data is not sent via NFC, GATT or advertisement for 120 seconds.
- 27 uA current consumption at 3V
- Add GATT profile
- Stream accelerometer data over GATT / NUS
- Tigger watchdog if data is not sent over NUS for 120 seconds
- Disable data advertising
- Disable activity interrupts from LIS2DH12
- Add watchdog, reset if button is not pressed.
- Add interrupts to accelerometer
- Add data format 5 support
- Synchronize battery measurements to radio
- Bootloader in a separate repository
- Add scheduler and timer, update transmitted data once per second.
- Environmental sensor is now in continuous mode and has IIR filtering at 16x (was oversampling)
- ADC is now read once per minute
Adds NFC tag functionality - read only
Adds BLE broadcasts
Adds RTC
Adds battery measurement
Adds Accelerometer polling
Adds environmental sensing
Adds button control to blink leds
Adds Led blinking example
Adds logging and error code handling
Put external sensors to sleep and then put MCU to sleep.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent