Awesome

Arduino Core for Nordic Semiconductor nRF5 based boards

Program your Nordic Semiconductor nRF51 or nRF52 board using the Arduino IDE.

Does not require a custom bootloader on the device.

Backers

Support us with a monthly donation and help us continue our activities. [Become a backer]

Sponsors

Become a sponsor and get your logo on our README on Github with a link to your site. [Become a sponsor]

Supported boards

nRF52833

nRF52

Plain nRF52 MCU
Nordic Semiconductor nRF52 DK
- For boards prior to 2016.9 (see sticker), the lastest JLink bootloader is required to upload sketches. To upgrade, press the boot/reset button while powering on the board and copy over the latest bootloader.
- To see how the silkscreened MCU pin names map to Arduino-compatible pin names, see PCA10040_Schematic_And_PCB.pdf -> GPIO pin mapping from the PCA10040_Schematic.
Shenzhen Taida Century Technology nRF52 low cost development board
RedBear Blend 2
RedBear Nano 2
Bluey
hackaBLE
hackaBLE_v2
DWM1001-DEV

nRF51

Plain nRF51 MCU
BBC micro:bit
Calliope mini
Bluz DK
Nordic Semiconductor nRF51822 Development Kit + nRF51422 Development Kit
Nordic SemiconductornRF51x22 Development Kits (PCA1000x)
Nordic Semiconductor NRF51 Smart Beacon Kit
Nordic Semiconductor NRF51 Dongle
OSHChip
RedBearLab BLE Nano
RedBearLab nRF51822
Waveshare BLE400
ng-beacon
TinyBLE
Sino:bit
SeeedArchLink

Installing

Board Manager

Download and install the Arduino IDE (At least v1.6.12)
Start the Arduino IDE
Go into Preferences
Add https://sandeepmistry.github.io/arduino-nRF5/package_nRF5_boards_index.json as an "Additional Board Manager URL"
Open the Boards Manager from the Tools -> Board menu and install "Nordic Semiconductor nRF5 Boards"
Select your nRF5 board from the Tools -> Board menu

NOTE: During installation it takes the Arduino IDE a few minutes to extract the tools after they have been downloaded, please be patient.

OS Specific Setup

OS X

No additional setup required.

Linux

For 64-bit Linux users, libc6:i386, libstdc++6:i386, libncurses5:i386 and libudev1:i386 need to be installed :

sudo dpkg --add-architecture i386
sudo apt-get update
sudo apt-get -y install libc6:i386 libstdc++6:i386 libncurses5:i386 libudev1:i386

Windows

Driver Setup for mbed devices

Download mbed Windows Serial driver

Driver Setup for Segger J-Link

Download Zadig
Plugin Segger J-Link or DK board
Start Zadig
Select Options -> List All Devices
Plug and unplug your device to find what changes, and select the Interface 2 from the device dropdown
Click Replace Driver

NOTE: To roll back to the original driver go to: Device Manager -> Right click on device -> Check box for "Delete the driver software for this device" and click Uninstall

Driver Setup for Black Magic Probe

Download .inf file drivers from blacksphere github
Plugin Black Magic Probe
Point the installer to the folder containing blackmagic.inf

NOTE: If using Windows 10 or Linux then two UART COM ports will be visible without requiring additional drivers

Selecting a SoftDevice

SoftDevices contain the BLE stack and housekeeping, and must be downloaded once before a sketch using BLE can be loaded. The SD consumes ~5k of Ram + some extra based on actual BLE configuration.

SoftDevice S110 v8.0.0 supports Revision 2 and 3 of nRF51 in peripheral role. It is 96k in size.
SoftDevice S130 v2.0.1 supports Revision 3 of nRF51 in peripheral and central role. It is 108k in size.
SoftDevice S132 v2.0.1 supports nRF52 in peripheral and central role. It is 112k in size.

Flashing a SoftDevice (IDE 1.8.x only)

cd <SKETCHBOOK>, where <SKETCHBOOK> is your Arduino Sketch folder:

OS X: ~/Documents/Arduino
Linux: ~/Arduino
Windows: ~/Documents/Arduino

Create the following directories: tools/nRF5FlashSoftDevice/tool/
Download nRF5FlashSoftDevice.jar to <SKETCHBOOK>/tools/nRF5FlashSoftDevice/tool/
Restart the Arduino IDE
Select your nRF board from the Tools -> Board menu
Select a SoftDevice from the Tools -> "SoftDevice: " menu
Select a Programmer (J-Link, ST-Link V2, or CMSIS-DAP) from the Tools -> "Programmer: " menu
Select Tools -> nRF5 Flash SoftDevice
Read license agreement
Click "Accept" to accept license and continue, or "Decline" to decline and abort
If accepted, SoftDevice binary will be flashed to the board

From git (for core development)

Follow steps from Board Manager section above
cd <SKETCHBOOK>, where <SKETCHBOOK> is your Arduino Sketch folder:

OS X: ~/Documents/Arduino
Linux: ~/Arduino
Windows: ~/Documents/Arduino

Create a folder named hardware, if it does not exist, and change directories to it
Clone this repo: git clone https://github.com/sandeepmistry/arduino-nRF5.git sandeepmistry-github/nRF5
Restart the Arduino IDE

BLE

This Arduino Core does not contain any Arduino style API's for BLE functionality. All the relevant Nordic SoftDevice (S110, S130, S132) header files are included build path when a SoftDevice is selected via the Tools menu.

Recommend BLE Libraries

BLEPeripheral
- v0.3.0 and greater, available via the Arduino IDE's library manager.
- Supports peripheral mode only.

Low Frequency Clock Source (LFCLKSRC)

If the selected board has an external 32 kHz crystal connected, it will be used as the source for the low frequency clock. Otherwise the internal 32 kHz RC oscillator will be used. The low frequency clock is used by the delay(ms) and millis() Arduino API's.

The Generic nRF51 and nRF52 board options have an additional menu item under Tools -> Low Frequency Clock that allows you to select the low frequency clock source. However, Nordic does not recommend the Synthesized clock, which also has a significant power impact.

Credits

This core is based on the Arduino SAMD Core and licensed under the same LGPL License

The following tools are used:

GCC ARM Embedded as the compiler
A forked version of OpenOCD to flash sketches