RoKiX Sensor Node example firmware for nRF5 SDK

This repository contains an example source code for firmware and client application that can be used with RoKiX Sensor Nodes and Nordic Semiconductor's nRF52-series DK boards: nRF52832-DK and nRF52840-DK.

Description

This example includes:

example client application which can
- connect to a RoKiX Sensor Node or DK board via USB and Bluetooth LE
- receive data from a RoKiX Sensor Node or DK board
example firmware which can
- read sensor data using I2C digital bus
- read and write GPIO lines
- read ADC line
- send data through USB or Bluetooth LE

Client application

The Python client is a simple Python 2/3 application that allows you to read data sent by the firmware. The client code is in the client directory.

Set-up:

Open a shell (e.g. cmd.exe) and change directory to client
Run python -m pip install -r requirements.txt

2.1. If using a Bluetooth LE connection, run python -m pip install -r requirements-Linux-BLE.txt
By default, the example application connects to the firmware via USB and reads three 16-bit signed values in a loop. The following options are supported:

3.1 The connection can be changed to Bluetooth LE. Note that the mac variable must be updated to match with the MAC address of the used device in connect(). Use B2S.exe --list command for discovering the device MAC address.

3.2 Print sensor data in SI units instead of raw data.

Usage:

Connect the device to the computer. Note that
- the nRF52840-DK uses the nRF USB Micro-USB connector for data (the other Micro-USB connector is for debugging and flashing)
- with BLE, the device must be paired first (the device name is "RoKiX Sensor Node template")
Run python receive_data.py

Firmware

The RoKiX example firmware is based on the nRF5 SDK 15.2.0 and all needed SDK source files are include in the project. When adding a new SDK module for the project, the nRF5 SDK must be downloaded and the required files must be included in the firmware project.

The example firmware provides sensor drivers, GPIO, ADC and connection examples, such as USB virtual port and BLE UART. The sensor drivers are configured to use data ready interrupts. When an interrupt occurs, an event is put in to the application scheduler. The event is handled by an event handler attached to the scheduler, which is executed in application context. The defined scheduler events can be found in the platform_functions.h file. These events are free to modify.

Following connections are supported for sending sensor data, e.g. to a PC:

USB virtual port (CDC-ACM) (only on RoKiX Sensor Node and nRF52840-DK)
USB UART (using J-Link as a USB-UART bridge) (on nRF52832-DK)
BLE UART service

GPIOs defined for Nordic DK board:

Name	GPIO
I2C SCL	P0.27
I2C SDA	P0.26
Sensor INT (nRF52832)	P0.16
Sensor INT (nRF52840)	P1.06

Sensor-data usage

The following sensor drivers are implemented:

KX122 - Tri-axis accelerometer with orientation, tap/double tap, activity detecting, and Free fall algorithms.
KMX62 - Tri-axial magnetometer plus a tri-axial accelerometer.
KXG08 - The KXG08 is an advanced 6-axis accelerometer/gyroscope.
BM1383AGLV - BM1383AGLV is piezo-resistive pressure sensor.
BM1422GMV - Tri-axis magnetometer.

File \firmware\src\rokix\sensors\sensors.h contains enable flags for the supported sensors. On the RoKiX Sensor Node, all sensors can be enabled simultaneously. On the DK boards, only one sensor should be enabled at a time. By default, the KX122 sensor data is passed to the USB or BLE, depending on the connection. This can be changed to main.c file by adding/removing the sensor ID checks in the application_event_handler function.

if(event->type == EVENT_READ_TWI) {
    ret = event->app_events.sensor_evt.sensor_read(data, &size);
    if (ret == NRF_SUCCESS) {
        /* Add sensor ID check here for passing certain sensor data to USB or BLE*/
        if(event->app_events.sensor_evt.sensor_id == KX122_ID) {
            ble_uart_tx(data, size);
            usb_serial_tx(data, size);
        }
    }
}

Application scheduler

Existing application scheduler events can be modified and new events can be added to change the functionality of the firmware.

The application event structure is defined in the firmware as

/* Add own event to stucture here. */
typedef struct
{
    app_event_type_t type;
    union {
        app_sensor_evt_t sensor_evt;
        app_adc_evt_t adc_evt;
    } app_events;
} app_internal_evt_t;

New events (e.g. KX122 I2C read) are added to application scheduler queue in the following way

static app_internal_evt_t app_event =
{
    .type = EVENT_READ_TWI,
};

app_event.app_events.sensor_evt.sensor_read = KX122_get_raw_xyz;
app_event.app_events.sensor_evt.sensor_id = KX122_ID;

/* Send event to main thread, application_event_handler */
ret = app_sched_event_put(&app_event,
                          sizeof(app_internal_evt_t),
                          application_event_handler);

Events are processed in the main.c event handler as shown below.

/** @brief Handling application events from the scheduler. */
void application_event_handler(void * p_event_data, uint16_t event_size)
{
    /* ... */
}

Timers

Examples using application timers can be found in the ble_uart.c, usb_serial.c and battery_measurement.c files.

Define timer and callback function

APP_TIMER_DEF(m_blink_cdc);

static void usb_cdc_blink_handler(void * p_context)
{
    bsp_board_led_invert((uint32_t) p_context);
}

Create timer

app_timer_create(&m_blink_cdc, APP_TIMER_MODE_REPEATED, usb_cdc_blink_handler);

Start timer

app_timer_start(m_blink_cdc,
    APP_TIMER_TICKS(LED_BLINK_INTERVAL),
    (void *) LED_CDC_ACM_CONN);

Stop timer

app_timer_stop(m_blink_cdc);

Setup

Requirements

RoKiX Sensor Node, nRF52832-DK, or nRF52840-DK
If using a DK board, a RoKiX Adapter Board and compatible sensor boards are required. Adapter Board documentation can be found in the RoKiX IoT Platform User's Guide, which is distributed as part of the RoKiX IoT Platform.
USB-certified Micro-USB cable
PC (tested with Windows OS)
- Segger Embedded Studio
- Pc-nrfutil
Android phone
nRF Toolbox from Google Play
RoKiX Sensor Node USB CDC-ACM drivers (only needed for Windows 7 and 8). See RoKix user guide section 4.2.
Python 2.7

Update bootloader (RoKiX Sensor Node only)

RoKiX Sensor Nodes include a default bootloader which does not allow DFU (Device Firmware Update) with unsigned firmware files. The default bootloader offers DFU only over BLE. Before using this example, the default BLE bootloader needs to be changed to the open bootloader. After that, unsigned firmware files can be loaded with DFU.

Steps for updating bootloader:

Install nRF Toolbox application to Android phone (Google play store)
Copy open bootloader zip from the dfu_pkg folder to phone (\firmware\dfu_pkg\RoKiXUSBOpenBootloader.zip)
Power on the RoKiX Sensor Node
Open "nRF Toolbox"
press "DFU" button
Select "file" and browse to bootloader zip file and device to be updated (path)
Select "distribution" packet and "scope all"
Press "upload" button

To test if the DFU update succeeded, press device button of the device for longer than 3 seconds and then release the button. The red LED should start blinking and the device should be visible in the device manager ports (COM & LPT) as a serial device.

Development environment setup for Segger Embedded Studio (SES)

To get started with developing the firmware with SES, follow the following steps to set up the necessary tools.

Install SEGGER Embedded Studio.
Install Python 2.7.
Add the Python executable to your user's PATH.
Tip: on Windows, the default path is C:\Python27
Run python -m pip install nrfutil in a shell (e.g. cmd.exe).
Add nrfutil to your user's PATH.
Tip: on Windows, the default path is C:\Python27\Scripts
Launch SEGGER Embedded Studio.
Try to build the project.
A license prompt will pop up. Select the option activate the free license with Nordic Semiconductor devices. (Nordic Semiconductor has signed an agreement with SEGGER to license Embedded Studio to developers for developing Nordic nRF51 & nRF52 applications.)
Go through the licensing procedure.

Build, flash and debug

Build

Open SEGGER Embedded Studio.
Use the File->Open solution menu to open the rokixsensornode_ex.emProject project file.
Select the build configuration for your platform with the Build->Set Active Build Configuration menu.
Select build from the menu or press F7.
The built application zip and hex files can be found in Output\Debug\Exe

Flash

RoKiX Sensor Node

Connect the RoKiX Sensor Node to the computer with a Micro-USB cable. Set the device to bootloader mode by pressing the button for longer than 3 seconds. A blinking red LED incdicates that the node is in bootloader mode. Use the following command to flash the device.

nrfutil.exe dfu serial -pkg Output\Debug\Exe\xx.zip -p COMXX

Nordic DK boards

The Nordic DK boards can be flashed over USB directly from SEGGER Embedded Studio with Target->Download rokixsensornode_ex. The IDE will flash both the application and the SoftDevice to the board. Note that the nRF52840-DK has two Micro-USB connectors; flashing is done over the connector (J2) that is close to the coin cell holder.

Trace and debug

RoKiX Sensor Node

Option 1:

By default the application traces are routed to the UART TX pin (20) so a serial adapter (e.g. FTDI FT232RL USB to TTL Serial Adapter - 3.3V Operation) is needed for tracing. TX and GND pins can be found in the Rohm 5+ connector (see RoKiX IoT Platform User's guide section 2.2). The UART baudrate setting is 115200 baud. This can be changed by modifying the sdk_config.h configuration file.

Option 2:

The second option is to use a debug probe, e.g. J-Link BASE with a Tag Connect TC2030-IDC-NL. Debugging and RTT tracing can only be done with a debug probe.

Nordic DK boards

The firmware uses RTT for diagnostic messages by default on the DK boards. Note that using the debug, flashing, and tracing features on the nRF52840-DK requires that a Micro-USB cable is connected to the connector (J2) that resides close to the coin cell holder.

The RTT messages can be viewed with SEGGER Embedded Studio by running the application in a debugger (menu item Debug->Go) or by installing and using SEGGER's RTT Viewer. (The RTT Viewer is a part of the J-Link Software and Documentation Pack.)

Licenses

i. nRF5 SDK license: The majority of the source code included in the nRF5 SDK in src/nrf5 (nRF5_Nordic_license.txt)

ii. SoftDevice license: The SoftDevice and its headers (src\nrf5\components\softdevice\s140\doc\license_file)

iii. ARM 3-clause BSD license: CMSIS and system files (src\nrf5\components\toolchain)

iv. Third-party licenses: All third-party code contained in src\nrf5\external (respective licenses included in each of the imported projects)

v. The MIT License Header and source files in src\rokix

vi. The MIT License Python code under client\ folder

RohmSemiconductor/RoKiX-firmware-for-nRF5-SDK

RoKiX Sensor Node example firmware for nRF5 SDK

Description

Client application

Firmware

Sensor-data usage

Application scheduler

Timers

Setup

Requirements

Update bootloader (RoKiX Sensor Node only)

Development environment setup for Segger Embedded Studio (SES)

Build, flash and debug

Build

Flash

RoKiX Sensor Node

Nordic DK boards

Trace and debug

RoKiX Sensor Node

Nordic DK boards

Licenses