circuitpython/ports/nrf/README.md

128 lines
5.3 KiB
Markdown
Raw Normal View History

# CircuitPython Port To The Nordic Semiconductor nRF52 Series
2017-05-28 23:20:46 -04:00
This is a port of CircuitPython to the Nordic Semiconductor nRF52 series of chips.
2017-05-28 23:20:46 -04:00
2017-06-07 15:33:47 -04:00
## Supported Features
2017-05-28 23:20:46 -04:00
* UART
* SPI
* LEDs
* Pins
* ADC
* I2C
* PWM
2017-05-28 23:20:46 -04:00
* Temperature
2017-06-02 18:16:31 -04:00
* RTC (Real Time Counter. Low-Power counter)
* BLE support including:
* Peripheral role
* Scanner role
2017-06-07 15:33:47 -04:00
* _REPL over Bluetooth LE_ (optionally using WebBluetooth)
* ubluepy: Bluetooth LE module for CircuitPython
2017-06-07 15:33:47 -04:00
* 1 non-connectable advertiser while in connection
2017-05-28 23:20:46 -04:00
2017-06-07 15:33:47 -04:00
## Tested Hardware
2017-06-02 18:16:31 -04:00
* nRF52840
* [PCA10056](http://www.nordicsemi.com/eng/Products/nRF52840-Preview-DK)
2018-05-15 16:42:27 -04:00
## 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.
* Adafruit Feather nRF52840: `boards/feather_nrf52840_express/README.md`: 1MB Flash, 256KB SRAM
* Nordic PCA10056 (uses nRF52840): `boards/pca10056/README.md`
2019-01-16 00:24:36 -05:00
* MakerDiary nRF52840 MDK: `boards/makerdiary_nrf52840_mdk/README.md`
* MakerDiary nRF52840 MDK USB Dongle: `boards/makerdiary_nrf52840_mdk_usb_dongle/README.md`
2018-05-15 16:42:27 -04:00
For all other board targets, see the generic notes below.
2017-06-02 18:16:31 -04:00
## Compile and Flash
2017-06-07 12:56:20 -04:00
Prerequisite steps for building the nrf port:
2017-06-02 18:16:31 -04:00
git clone <URL>.git circuitpython
cd circuitpython
2017-06-02 18:16:31 -04:00
git submodule update --init
make -C mpy-cross
To build and flash issue the following command inside the ports/nrf/ folder:
2017-06-02 18:16:31 -04:00
make BOARD=pca10056
make BOARD=pca10056 flash
2017-06-02 18:16:31 -04:00
## Compile and Flash with Bluetooth Stack
First prepare the bluetooth folder by downloading Bluetooth LE stacks and headers:
./bluetooth/download_ble_stack.sh
2017-06-02 18:16:31 -04:00
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
2017-06-09 16:33:51 -04:00
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`.
2017-06-02 18:16:31 -04:00
2017-06-07 15:33:47 -04:00
## Target Boards and Make Flags
Target Board (BOARD) | Bluetooth Stack (SD) | Bluetooth Support | Flash Util
-------------------------|-------------------------|------------------------|-------------------------------
pca10056 | s140 | Peripheral and Scanner | [Segger](#segger-targets)
feather_nrf52840_express | s140 | Peripheral and Scanner | UF2 bootloader
2018-10-20 05:39:09 -04:00
makerdiary_nrf52840_mdk | s140 | Peripheral and Scanner | pyocd or ARM mbed DAPLink
2019-01-16 00:24:36 -05:00
makerdiary_nrf52840_mdk_usb_dongle | s140 | Peripheral and Scanner | DFU bootloader & nrfutil
electronut_labs_papyr | s140 | Peripheral and Scanner | UF2 bootloader
2017-06-02 18:16:31 -04:00
2017-06-07 15:33:47 -04:00
## Segger Targets
2017-06-02 18:16:31 -04:00
Install the necessary tools to flash and debug using Segger:
2017-06-07 15:33:47 -04:00
[JLink Download](https://www.segger.com/downloads/jlink#)
[nrfjprog linux-32bit Download](https://www.nordicsemi.com/eng/nordic/download_resource/52615/16/95882111/97746)
[nrfjprog linux-64bit Download](https://www.nordicsemi.com/eng/nordic/download_resource/51386/21/77886419/94917)
2017-06-02 18:16:31 -04:00
2017-06-07 15:33:47 -04:00
[nrfjprog osx Download](https://www.nordicsemi.com/eng/nordic/download_resource/53402/12/97293750/99977)
2017-06-02 18:16:31 -04:00
2017-06-07 15:33:47 -04:00
[nrfjprog win32 Download](https://www.nordicsemi.com/eng/nordic/download_resource/33444/40/22191727/53210)
2017-06-02 18:16:31 -04:00
note: On Linux it might be required to link SEGGER's `libjlinkarm.so` inside nrfjprog's folder.
2017-06-07 15:33:47 -04:00
## DFU Targets
2017-06-02 18:16:31 -04:00
run follow command to install [adafruit-nrfutil](https://github.com/adafruit/Adafruit_nRF52_nrfutil) from PyPi
2018-08-22 08:42:41 -04:00
$ pip3 install --user adafruit-nrfutil
2017-06-02 18:16:31 -04:00
**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.
2017-06-02 18:16:31 -04:00
Example on how to generate and flash feather_nrf52840 target:
2017-06-02 18:16:31 -04:00
2018-12-30 22:49:20 -05:00
make BOARD=feather_nrf52840 SD=s140
make BOARD=feather_nrf52840 SD=s140 dfu-gen dfu-flash
2017-06-09 16:33:51 -04:00
## 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:
* [NUS Console for Linux](https://github.com/tralamazza/nus_console) (recommended)
* [WebBluetooth REPL](https://glennrub.github.io/webbluetooth/micropython/repl/) (experimental)
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](https://glennrub.github.io/webbluetooth/micropython/repl/) (experimental), which subsequently can be used to connect to the Bluetooth REPL from the PC or Phone browser.