summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorglennrub <glennbakke@gmail.com>2017-06-09 22:33:51 +0200
committerGitHub <noreply@github.com>2017-06-09 22:33:51 +0200
commit3193bcc7ee52ce80cd6fe7507239387bd2d47914 (patch)
tree50ad705499d2e675f778e4254c697f480a9a579b
parenta6b138c9ef6c6b7e9000cf86047f4ac6bf87f4f9 (diff)
nrf5: Updating readme with BLE REPL
-rw-r--r--nrf/README.md17
1 files changed, 16 insertions, 1 deletions
diff --git a/nrf/README.md b/nrf/README.md
index ebfedbb94..b6d750550 100644
--- a/nrf/README.md
+++ b/nrf/README.md
@@ -68,7 +68,7 @@ If the Bluetooth stacks has been downloaded, compile the target with the followi
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.
+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
@@ -122,3 +122,18 @@ 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
+
+## 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.