circuitpython/ports/nrf
arturo182 7390dc7dab bleio: Move ScanEntry to shared module and add a new AdvertisementData class 2018-10-21 15:43:24 +02:00
..
boards fix feather nrf52840 build error 2018-09-25 17:09:54 +07:00
common-hal bleio: Add a new Address class 2018-10-21 15:43:21 +02:00
device/nrf52 nrf: Rewrite the SPI common-hal using nrfx 2018-06-25 23:46:34 +02:00
drivers/bluetooth bleio: Move ScanEntry to shared module and add a new AdvertisementData class 2018-10-21 15:43:24 +02:00
examples Fix 'advertisement' typo 2018-10-03 09:56:30 +02:00
freeze ports/nrf: Moving nrf51/52 port to new ports directory 2017-10-04 21:46:48 +02:00
modules/ubluepy bleio: Move ScanEntry to shared module and add a new AdvertisementData class 2018-10-21 15:43:24 +02:00
nrfx@d4ebe15f58 fix tinyusb cdc issue 2018-10-05 21:37:16 +07:00
peripherals/nrf PulseOut working 2018-10-16 11:05:02 -04:00
supervisor PulseOut working 2018-10-16 11:05:02 -04:00
usb add autoreload 2018-09-22 02:08:00 +07:00
.gitignore ports/nrf: Moving nrf51/52 port to new ports directory 2017-10-04 21:46:48 +02:00
Makefile bleio: Move ScanEntry to shared module and add a new AdvertisementData class 2018-10-21 15:43:24 +02:00
README.md update readme board name feather_nrf52832 2018-08-28 16:15:20 +07:00
background.c should fix #1021 2018-07-17 21:24:49 +07:00
board_busses.c pin files rework; implement pin claiming; add more boards 2018-08-31 18:05:55 -04:00
board_busses.h pin files rework; implement pin claiming; add more boards 2018-08-31 18:05:55 -04:00
fatfs_port.c ports/nrf: Moving nrf51/52 port to new ports directory 2017-10-04 21:46:48 +02:00
gccollect.c ports/nrf: Moving nrf51/52 port to new ports directory 2017-10-04 21:46:48 +02:00
internal_flash.c merge review 2018-07-12 01:37:23 +07:00
internal_flash.h make SD default to s140 and s132 for nrf52840 and nrf52832 2018-07-06 14:39:49 +07:00
mpconfigport.h adding neopixel write 2018-09-04 15:51:49 +07:00
mpconfigport.mk merge from 2.2.0 + fix up board defs 2018-01-02 21:25:41 -05:00
mphalport.c migrate serial from uart to uarte 2018-09-25 16:14:44 +07:00
mphalport.h migrate serial from uart to uarte 2018-09-25 16:14:44 +07:00
nrfx_config.h PulseOut working 2018-10-16 11:05:02 -04:00
nrfx_glue.h add ARRAY_SIZE 2018-07-10 01:06:57 +07:00
nrfx_log.h nrf: Rewrite the SPI common-hal using nrfx 2018-06-25 23:46:34 +02:00
qstrdefsport.h nrf: Remove old qstr defines 2018-06-27 20:52:13 +02:00
tick.c add usb msc support for nrf52840 2018-07-04 16:40:53 +07:00
tick.h nrf: Implement ticks, add gamepad module and example 2018-02-05 20:48:25 +01:00

README.md

CircuitPython Port To The Nordic Semiconductor nRF52 Series

This is a port of CircuitPython to the Nordic Semiconductor nRF52 series of chips.

Supported Features

  • UART
  • SPI
  • LEDs
  • Pins
  • ADC
  • I2C
  • PWM
  • Temperature
  • RTC (Real Time Counter. Low-Power counter)
  • BLE support including:
    • Peripheral role
    • Scanner role
    • REPL over Bluetooth LE (optionally using WebBluetooth)
    • ubluepy: Bluetooth LE module for CircuitPython
    • 1 non-connectable advertiser while in connection

Tested Hardware

Board Specific Instructions

For board-specific instructions on building and flashing CircuitPython, see the following links:

NOTE: These board specific readmes may be more up to date than the generic board-neutral documentation further down.

For all other board targets, see the generic notes below.

Compile and Flash

Prerequisite steps for building the nrf port:

git clone <URL>.git circuitpython
cd circuitpython
git submodule update --init
make -C mpy-cross

To build and flash issue the following command inside the ports/nrf/ folder:

make BOARD=pca10056
make BOARD=pca10056 flash

Compile and Flash with Bluetooth Stack

First prepare the bluetooth folder by downloading Bluetooth LE stacks and headers:

 ./drivers/bluetooth/download_ble_stack.sh

If the Bluetooth stacks has been downloaded, compile the target with the following command:

make BOARD=pca10040 SD=s132

The make sd will trigger a flash of the bluetooth stack before that application is flashed. Note that make sd will perform a full erase of the chip, which could cause 3rd party bootloaders to also be wiped.

make BOARD=pca10040 SD=s132 sd

Note: further tuning of features to include in bluetooth or even setting up the device to use REPL over Bluetooth can be configured in the bluetooth_conf.h.

Target Boards and Make Flags

Target Board (BOARD) Bluetooth Stack (SD) Bluetooth Support Flash Util
pca10040 s132 Peripheral and Scanner Segger
pca10056 s140 Peripheral and Scanner Segger
feather_nrf52832 s132 Peripheral and Scanner UART DFU
feather_nrf52840_express s140 Peripheral and Scanner UF2 bootloader

Segger Targets

Install the necessary tools to flash and debug using Segger:

JLink Download

nrfjprog linux-32bit Download

nrfjprog linux-64bit Download

nrfjprog osx Download

nrfjprog win32 Download

note: On Linux it might be required to link SEGGER's libjlinkarm.so inside nrfjprog's folder.

DFU Targets

run follow command to install adafruit-nrfutil from PyPi

$ pip3 install --user adafruit-nrfutil

make flash and make sd will not work with DFU targets. Hence, dfu-gen and dfu-flash must be used instead.

  • dfu-gen: Generates a Firmware zip to be used by the DFU flash application.
  • dfu-flash: Triggers the DFU flash application to upload the firmware from the generated Firmware zip file.

Example on how to generate and flash feather_nrf52832 target:

make BOARD=feather_nrf52832 SD=s132
make BOARD=feather_nrf52832 SD=s132 dfu-gen dfu-flash

Bluetooth LE REPL

The port also implements a BLE REPL driver. This feature is disabled by default, as it will deactivate the UART REPL when activated. As some of the nRF devices only have one UART, using the BLE REPL free's the UART instance such that it can be used as a general UART peripheral not bound to REPL.

The configuration can be enabled by editing the bluetooth_conf.h and set MICROPY_PY_BLE_NUS to 1.

When enabled you have different options to test it:

Other:

  • nRF UART application for IPhone/Android

WebBluetooth mode can also be configured by editing bluetooth_conf.h and set BLUETOOTH_WEBBLUETOOTH_REPL to 1. This will alternate advertisement between Eddystone URL and regular connectable advertisement. The Eddystone URL will point the phone or PC to download WebBluetooth REPL (experimental), which subsequently can be used to connect to the Bluetooth REPL from the PC or Phone browser.