|
1 |
| -# Arduino Core for Nordic Semiconductor nRF5 based boards |
| 1 | +# Arduino Core for Adafruit nRF52 Feather Boards |
2 | 2 |
|
3 | 3 | ## BSP Installation
|
4 |
| - |
5 |
| -### Arduino nRF5x BSP via Board Manager |
6 | 4 |
|
7 |
| -**NOTE:** For now, you need to install this BSP to gain access to the compiler. In the |
8 |
| -future, only the Adafruit nRF52 BSP will be required. |
| 5 | +There are two methods that you can use to install this BSP. We highly recommend the first option unless you wish to participate in active development of this codebase via Github. |
| 6 | + |
| 7 | +### Recommended: Adafruit nRF52 BSP via the Arduino Board Manager |
9 | 8 |
|
10 | 9 | 1. [Download and install the Arduino IDE](https://www.arduino.cc/en/Main/Software) (At least v1.6.12)
|
11 | 10 | 2. Start the Arduino IDE
|
12 | 11 | 3. Go into Preferences
|
13 |
| - 4. Add ```https://sandeepmistry.github.io/arduino-nRF5/package_nRF5_boards_index.json``` as an "Additional Board Manager URL" |
14 |
| - 5. Open the Boards Manager from the Tools -> Board menu and install "Nordic Semiconductor nRF5 Boards" |
15 |
| - 6. Select your nRF5 board from the Tools -> Board menu |
| 12 | + 4. Add https://www.adafruit.com/package_adafruit_index.json as an 'Additional Board Manager URL' |
| 13 | + 5. Restart the Arduino IDE |
| 14 | + 6. Open the Boards Manager from the Tools -> Board menu and install 'Adafruit nRF52 by Adafruit' |
| 15 | + 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. |
16 | 16 |
|
17 |
| -### Adafruit nRF52 BSP via git (for core development) |
| 17 | +### Optional (Core Development): Adafruit nRF52 BSP via git |
18 | 18 |
|
19 |
| - 1. Follow steps from Board Manager section above |
20 |
| - 2. ```cd <SKETCHBOOK>```, where ```<SKETCHBOOK>``` is your Arduino Sketch folder: |
| 19 | + 1. ```cd <SKETCHBOOK>```, where ```<SKETCHBOOK>``` is your Arduino Sketch folder: |
21 | 20 | * OS X: ```~/Documents/Arduino```
|
22 | 21 | * Linux: ```~/Arduino```
|
23 | 22 | * Windows: ```~/Documents/Arduino```
|
24 | 23 | 3. Create a folder named ```hardware/Adafruit```, if it does not exist, and change directories to it
|
25 | 24 | 4. Clone this repo: `git clone [email protected]:adafruit/Adafruit_nRF52_Arduino.git`
|
26 | 25 | 5. Restart the Arduino IDE
|
| 26 | + 6. 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. |
27 | 27 |
|
28 | 28 | ### Third Party Tools
|
29 | 29 |
|
@@ -68,14 +68,6 @@ on your system and available in the system path:
|
68 | 68 | Download and install the [JLink Software and Documentation Pack](https://www.segger.com/downloads/jlink)
|
69 | 69 | from Segger, which will also install a set of command line tools.
|
70 | 70 |
|
71 |
| -#### pynrfjprog |
72 |
| - |
73 |
| -In order to burn the bootloader with a J-Link, you will need `pynrfjprog` from Nordic: |
74 |
| - |
75 |
| -``` |
76 |
| -$ sudo pip install pynrfjprog |
77 |
| -``` |
78 |
| - |
79 | 71 | ### Burning the Bootloader
|
80 | 72 |
|
81 | 73 | Once the tools above have been installed and added to your system path, from the Arduino IDE:
|
@@ -139,10 +131,9 @@ but enter the `MSDEnable` command.
|
139 | 131 |
|
140 | 132 | ## Credits
|
141 | 133 |
|
142 |
| -This core is based on the [Arduino SAMD Core](https://github.com/arduino/ArduinoCore-samd) |
143 |
| -and licensed under the same [GPL License](LICENSE) |
| 134 | +This core is based on [Arduino-nRF5](https://github.com/sandeepmistry/arduino-nRF5) by Sandeep Mistry, |
| 135 | +which in turn is based on the [Arduino SAMD Core](https://github.com/arduino/ArduinoCore-samd). |
144 | 136 |
|
145 | 137 | The following tools are used:
|
146 | 138 |
|
147 | 139 | * [GCC ARM Embedded](https://launchpad.net/gcc-arm-embedded) as the compiler
|
148 |
| - * A [forked](https://github.com/sandeepmistry/openocd-code-nrf5) version of [OpenOCD](http://openocd.org) to flash sketches |
0 commit comments