circuitpython/nrf
Daniel Tralamazza f730ea9602 Merge pull request #76 from glennrub/readme_update
nrf: Updating README.
2017-06-07 21:57:37 +02:00
..
boards implement #50 2017-06-07 18:57:47 +02:00
device implement #50 2017-06-07 18:57:47 +02:00
drivers nrf5/drivers/bluetooth: Make printf in 'ble_drv_service_add' function part of debug log. 2017-06-07 19:44:08 +02:00
examples rename temperature example 2017-06-07 19:44:09 +02:00
freeze implement #50 2017-06-07 18:57:47 +02:00
hal nrf5/hal/timer: Add support for fetching temperature if bluetooth stack is enabled. 2017-06-07 19:44:08 +02:00
modules nrf5/modules/ubluepy: Adding new event constant for gatts write (80) events from bluetooth stacks. 2017-06-07 19:44:08 +02:00
.gitignore implement #50 2017-06-07 18:57:47 +02:00
Makefile implement #50 2017-06-07 18:57:47 +02:00
README.md nrf: Updating README. 2017-06-07 21:33:47 +02:00
bluetooth_conf.h implement #50 2017-06-07 18:57:47 +02:00
builtin_open.c implement #50 2017-06-07 18:57:47 +02:00
fatfs_port.c implement #50 2017-06-07 18:57:47 +02:00
gccollect.c implement #50 2017-06-07 18:57:47 +02:00
gccollect.h implement #50 2017-06-07 18:57:47 +02:00
help.c implement #50 2017-06-07 18:57:47 +02:00
main.c implement #50 2017-06-07 18:57:47 +02:00
mpconfigport.h implement #50 2017-06-07 18:57:47 +02:00
mphalport.c implement #50 2017-06-07 18:57:47 +02:00
mphalport.h implement #50 2017-06-07 18:57:47 +02:00
nrf51_af.csv implement #50 2017-06-07 18:57:47 +02:00
nrf52_af.csv implement #50 2017-06-07 18:57:47 +02:00
pin_defs_nrf5.h implement #50 2017-06-07 18:57:47 +02:00
pin_named_pins.c implement #50 2017-06-07 18:57:47 +02:00
qstrdefsport.h implement #50 2017-06-07 18:57:47 +02:00

README.md

MicroPython Port To The Nordic Semiconductor nRF Series

This is a port of MicroPython to the Nordic Semiconductor nRF series of chips.

Supported Features

  • UART
  • SPI
  • LEDs
  • Pins
  • ADC
  • I2C
  • PWM (nRF52 only)
  • Temperature
  • RTC (Real Time Counter. Low-Power counter)
  • BLE support including:
    • Peripheral role on nrf51 targets
    • Central role and Peripheral role on nrf52 targets
    • REPL over Bluetooth LE (optionally using WebBluetooth)
    • ubluepy: Bluetooth LE module for micropython
    • 1 non-connectable advertiser while in connection

Tested Hardware

Compile and Flash

Prerequisite steps for building the nrf port:

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

By default, the PCA10040 (nrf52832) is used as compile target. To build and flash issue the following command inside the nrf/ folder:

make
make flash

Alternatively the target board could be defined:

 make BOARD=pca10040
 make 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
make sd

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.

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
microbit s110 Peripheral PyOCD
pca10000 s110 Peripheral Segger
pca10001 s110 Peripheral Segger
pca10028 s110 Peripheral Segger
pca10031 s110 Peripheral Segger
pca10040 s132 Peripheral and Central Segger
feather52 s132 Peripheral and Central UART DFU
pca10056 Segger

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

PyOCD/OpenOCD Targets

Install the necessary tools to flash and debug using OpenOCD:

sudo apt-get install openocd
sudo pip install pyOCD

DFU Targets

sudo apt-get install build-essential libffi-dev pkg-config gcc-arm-none-eabi git python python-pip
git clone https://github.com/adafruit/Adafruit_nRF52_Arduino.git
cd Adafruit_nRF52_Arduino/tools/nrfutil-0.5.2/
sudo pip install -r requirements.txt
sudo python setup.py install

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 feather52 target:

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