https://github.com/CharlesDias/BLE-Watch
Project using the Zephyr RTOS and Nordic nRF52840 DK board.
https://github.com/CharlesDias/BLE-Watch
ble docker-image github-actions nordic nrf52840 zephyr-rtos
Last synced: about 1 year ago
JSON representation
Project using the Zephyr RTOS and Nordic nRF52840 DK board.
- Host: GitHub
- URL: https://github.com/CharlesDias/BLE-Watch
- Owner: CharlesDias
- License: mit
- Created: 2023-01-21T14:13:43.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-12-08T17:59:35.000Z (over 2 years ago)
- Last Synced: 2024-10-24T16:49:44.702Z (over 1 year ago)
- Topics: ble, docker-image, github-actions, nordic, nrf52840, zephyr-rtos
- Language: C
- Homepage:
- Size: 55.2 MB
- Stars: 42
- Watchers: 3
- Forks: 8
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Bluetooth LE Watch
[](https://shields.io/)
[](https://github.com/CharlesDias/BLE-Watch/actions/workflows/build.yml)
[](https://sonarcloud.io/dashboard?id=CharlesDias_BLE-Watch)
This is a sample project using the Zephyr RTOS and Nordic nRF Connect to create a BLE watch. This device is composed with:
* [nRF52840 DK](https://www.nordicsemi.com/Products/Development-hardware/nRF5340-DK) Nordic board.
* OLED monochrome displays SSD1306 128x64 pixels.
* and the DS3231 real-time clock (RTC).
Both display and RTC communicates with the nRF52840 MCU via I2C bus.
Some topics covered:
* Tested on [nRF52840 DK](https://www.nordicsemi.com/Products/Development-hardware/nRF5340-DK) board.
* Embedded system with [Zephyr RTOS](https://zephyrproject.org/) and [nRF Connect SDK](https://www.nordicsemi.com/Products/Development-software/nrf-connect-sdk).
* Bluetooth Low Energy (LE) technology.
* The device works as GAP Peripheral and GATT server.
* Implemented BLE services officially adopted by Bluetooth SIG and custom services too.
* Continuous integration (CI) with GitHub Actions, as SonarCloud integration.
* Use of Docker container.
## Bluetooth Services
### Device information service (dis)
Exposes the device information.
* Device Information Service:
* Characteristic: Model number string
* Data format: < string >
* Properties: Read.
* Characteristic: Manufacturer name string
* Data format: < string >
* Properties: Read.
* Characteristic: Serial number string
* Data format: < string >
* Properties: Read.
* Characteristic: Firmware revision string
* Data format: < string >
* Properties: Read.
* Characteristic: Hardware revision string
* Data format: < string >
* Properties: Read.
* Characteristic: Software revision string
* Data format: < string >
* Properties: Read.
### Battery service (bas)
Simulates the battery level voltage.
* Battery Service:
* Characteristic: Battery level
* Data format: < UINT8[1 byte]> percentage battery level
* Properties: Notify, Read.
### Custom service
Receives messages to be shown on the display screen.
* Unknown Service:
* Characteristic: Unknown
* Data format: < TEXT (UTF-8) > limit up to 31 characters
* Properties: Read, Write.
## Project Structure
```text
.
├── CMakeLists.txt
├── docs
│ ├── Assigned Numbers.pdf
│ ├── DS3231.pdf
│ ├── DTS_v1.0.pdf
│ └── images
├── Kconfig
├── Makefile
├── nrf52840dk_nrf52840.overlay
├── prj.conf
├── README.md
├── sample.yaml
├── sonar-project.properties
├── src
│ ├── app
│ │ ├── inc
│ │ │ ├── device_information_service.h
│ │ │ ├── display_ssd1306.h
│ │ │ ├── gatt_central.h
│ │ │ └── rtc_ds3231.h
│ │ └── src
│ │ ├── device_information_service.c
│ │ ├── display_ssd1306.c
│ │ ├── gatt_central.c
│ │ └── rtc_ds3231.c
│ └── main.c
```
## Building and Running
### Building with Docker image in interactive mode
Navigate to the project folder.
```console
$ cd BLE-Watch
```
Then, run the Docker image. Replace the `--device=/dev/bus/usb/001/xxx` with the correct value.
```console
$ docker run --rm -it --device=/dev/bus/usb/001/xxx --device=/dev/ttyACM0 --device=/dev/ttyACM1 -v ${PWD}:/workdir/project -w /workdir/project charlesdias/nrfconnect-sdk /bin/bash
```
Afterwards, execute the command below to build the firmware.
```console
$ make build
```
You should expect an output similar to the following:
```console
.
.
.
[390/400] Linking C executable zephyr/zephyr_pre0.elf
[394/400] Linking C executable zephyr/zephyr_pre1.elf
[400/400] Linking C executable zephyr/zephyr.elf
Memory region Used Size Region Size %age Used
FLASH: 353588 B 1 MB 33.72%
RAM: 55624 B 256 KB 21.22%
IDT_LIST: 0 GB 2 KB 0.00%
```
### Flashing the firmware
After the build is complete, run the following command to flash the firmware:
```console
$ make flash
```
The expected output should be similar to:
```console
.
.
.
[ ###### ] 0.000s | Verifying image - block 1 of 2
[ #################### ] 0.000s | Verifying image - Verify successful
[ #################### ] 2.377s | Verify file - Done verifying
Applying system reset.
Run.
-- runners.nrfjprog: Board with serial number flashed successfully.
```
### Running
Test the BLE Watch application with the nRF Connect app, which is available for iOS (App Store) and Android (Google Play).
## Unit Testing with Ztest
Ztest is a simple testing framework for Zephyr applications. It provides basic structures for writing test cases and test suites.
To run the unit tests for this project, follow these steps:
1. Navigate to the project's directory.
```console
$ cd BLE-Watch
```
2. Open the `/dev/ttyACM0` using your preferable serial communication program.
3. Build the tests with the following command:
```console
$ make tests
```
4. After building, flash the tests firmware into the board with:
```console
$ make flash
```
The output will show the results of the tests on `/dev/ttyACM0`, indicating which tests passed and which failed.
## Next improvements
* Create dedicate task to update the display.
* Implement Bluetooth service to set the date and time.
* Flash the application project running west on Docker container.
* Add Doxygen configuration.