Skip to content

Commit 10dbb17

Browse files
committed
update readme
1 parent 1491b13 commit 10dbb17

File tree

1 file changed

+41
-40
lines changed

1 file changed

+41
-40
lines changed

README.md

Lines changed: 41 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
1-
# Arduino Core for Adafruit nRF52 Feather Boards
1+
# Arduino Core for Adafruit Bluefruit nRF52 Boards
2+
3+
This repository contains the Arduino BSP for Adafruit nRF52 series:
4+
5+
- [Bluefruit Feather nRF52832](https://www.adafruit.com/product/3406)
26

37
## BSP Installation
48

@@ -21,33 +25,27 @@ There are two methods that you can use to install this BSP. We highly recommend
2125
* OS X : `~/Library/Arduino15/packages/adafruit/hardware/nrf52`
2226
* Linux : `~/.arduino15/packages/adafruit/hardware/nrf52`
2327
* Windows: `%APPDATA%\Local\Arduino15\packages\adafruit\hardware\nrf52`
24-
3. ```cd <SKETCHBOOK>```, where ```<SKETCHBOOK>``` is your Arduino Sketch folder:
25-
* OS X : ```~/Documents/Arduino```
26-
* Linux : ```~/Arduino```
27-
* Windows: ```~/Documents/Arduino```
28-
4. Create a folder named ```hardware/Adafruit```, if it does not exist, and change directories to it
29-
5. Clone this repo: `git clone git@github.com:adafruit/Adafruit_nRF52_Arduino.git`
28+
3. `cd <SKETCHBOOK>`, where `<SKETCHBOOK>` is your Arduino Sketch folder:
29+
* OS X : `~/Documents/Arduino`
30+
* Linux : `~/Arduino`
31+
* Windows: `~/Documents/Arduino`
32+
4. Create a folder named `hardware/Adafruit`, if it does not exist, and change directories to it
33+
5. Clone this repo: `git clone https://github.com/adafruit/Adafruit_nRF52_Arduino.git`
3034
6. Restart the Arduino IDE
3135
7. Once the BSP is installed, select 'Adafruit Bluefruit nRF52 Feather' from the Tools -> Board menu, which will update your system config to use the right compiler and settings for the nRF52.
3236

3337
### Third Party Tools
3438

35-
#### nrfutil
39+
#### adafruit-nrfutil
3640

37-
The Adafruit nRF52 BSP includes a [python wrapper](https://github.com/NordicSemiconductor/pc-nrfutil)
38-
for Nordic's `nrfutil`, which is used to flash boards. Go into the BSP folder
39-
(`hardware/Adafruit/Adafruit_nRF52_Arduino/tools/nrfutil-0.5.2`), and run the following to make
40-
this available to the Arduino IDE:
41+
[adafruit-nrfutil](https://github.com/adafruit/Adafruit_nRF52_nrfutil) is needed to upload sketch via serial port.
4142

42-
```
43-
$ cd tools/nrfutil-0.5.2
44-
$ sudo pip install -r requirements.txt
45-
$ sudo python setup.py install
46-
```
43+
- For Windows and macOS, pre-built executable binaries are included in the BSP at `tools/adafruit-nrfutil/`.
44+
- While Linux user can install it easily via PyPi
4745

48-
**Notes** : Don't install nrfutil from the pip package (ex. `sudo pip install nrfutil`). The
49-
latest nrfutil does not support DFU via Serial, and you should install the local copy of 0.5.2
50-
included with the BSP via the `python setup.py install` command above.
46+
```
47+
$ pip3 install adafruit-nrfutil --user
48+
```
5149
5250
## Arduino BLE Application Support
5351
@@ -63,31 +61,26 @@ examples sketched for the selected board.
6361
6462
## Bootloader Support
6563
66-
### Third Party Tools
64+
### Upgrade existiting Bootloader
6765
68-
To burn the bootloader from within the Arduino IDE, you will need the following tools installed
69-
on your system and available in the system path:
66+
Bluefruit's Bootloader is self-upgradable, you could upgrade to the latest Bootloader + Softdevice using the serial port within Arduino IDE.
7067
71-
#### Jlink Driver and Tools
72-
73-
Download and install the [JLink Software and Documentation Pack](https://www.segger.com/downloads/jlink)
74-
from Segger, which will also install a set of command line tools.
68+
- Select `Tools > Board > Adafruit Bluefruit Feather52`
69+
- Select `Tools > Programmer > Bootloader DFU for Bluefruit nRF52`
70+
- Select `Tools > Burn Bootloader`
71+
- **WAIT** until the process complete ~30 seconds
7572
76-
### Burning the Bootloader
73+
Note: close the Serial Monitor before you click "Burn Bootloader". Afterwards, you shouldn't close the Arduino IDE, unplug the Feather, launch Serial Monitor etc ... to abort the process. There is a high chance it will brick your device! Do this with care and caution.
7774
78-
Once the tools above have been installed and added to your system path, from the Arduino IDE:
75+
### Burnning new Bootloader
7976
80-
- Select `Tools > Board > Adafruit Bluefruit Feather52`
81-
- Select `Tools > Programmer > J-Link for Feather52`
82-
- Select `Tools > Burn Bootloader` with the board and J-Link connected
83-
84-
#### Manually Burning the Bootloader via nrfjprog
77+
To burn the bootloader from within the Arduino IDE, you will need the following tools installed
78+
on your system and available in the system path:
8579
86-
You can also manually burn the bootloader from the command line, you will need `nrfjprog` from Nordic:
80+
- Segger [JLink Software and Documentation Pack](https://www.segger.com/downloads/jlink)
81+
- Nordic [nRF5x Command Line Tools](http://infocenter.nordicsemi.com/index.jsp?topic=%2Fcom.nordic.infocenter.tools%2Fdita%2Ftools%2Fnrf5x_command_line_tools%2Fnrf5x_installation.html)
8782
88-
- Download [nRF5x-Command-Line-Tools](https://www.nordicsemi.com/eng/Products/Bluetooth-low-energy/nRF52832#Downloads) for OSX/Linux/Win32
89-
- Extract the downloaded file and add the extracted path to your environment `PATH` variable
90-
- Check to make sure you can run `nrfjprog` from your terminal/command prompt
83+
Check to make sure you can run `nrfjprog` from your terminal/command prompt
9184
9285
**OS X Note** At present, you will need to create a symlink in `/usr/local/bin` to the
9386
`nrfjprog` tool wherever you have added it. You can run the following command, for example:
@@ -96,11 +89,19 @@ You can also manually burn the bootloader from the command line, you will need `
9689
$ ln -s $HOME/prog/nordic/nrfjprog/nrfjprog /usr/local/bin/nrfjprog
9790
```
9891
99-
Then run the command as follows:
92+
Once the tools above have been installed and added to your system path, from the Arduino IDE:
93+
94+
- Select `Tools > Board > Adafruit Bluefruit Feather52`
95+
- Select `Tools > Programmer > J-Link for Feather52`
96+
- Select `Tools > Burn Bootloader` with the board and J-Link connected
97+
98+
#### Manually Burning the Bootloader via nrfjprog
99+
100+
The bootloader hex file can be found at `bin/bootloader` run the command as follows:
100101
101102
```
102103
$ nrfjprog -e -f nrf52
103-
$ nrfjprog --program bootloader_with_s132.hex -f nrf52
104+
$ nrfjprog --program feather_nrf52832_bootloader.hex -f nrf52
104105
$ nrfjprog --reset -f nrf52
105106
```
106107

0 commit comments

Comments
 (0)