mudhorn/meshtastic
1
0
Fork 0
mirror of https://github.com/meshtastic/meshtastic.git synced 2024-09-19 23:57:31 -07:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Add basic nrf52 guide

Browse source
This commit is contained in:
geeksville 2024-06-16 15:16:37 -07:00
parent 78de79b150
commit b2fcaa5530
1 changed files with 59 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

59
docs/development/firmware/nrf52-guide.mdx Normal file
View file

@ -0,0 +1,59 @@
---
id: nrf52-guide
title: Development Guide for nRF52
sidebar_label: NRF52 Guide
---
This document is a collection of tips and best practices for developing on the nRF52 platform.
It is intended to be a living document that will be updated as new information becomes available (please send in pull-requests on github).
## Using the NanoDAP USB debugging probe
This is a Mini HOWTO on installing the appropriate firmware and adapter software, it is loosely based on [this](https://docs.rakwireless.com/Product-Categories/Accessories/RAKDAP1-Flash-and-Debug-Tool/Quickstart/#rak4600-evaluation-board) tutorial by RAK.
### Required hardware
The [RAKDAP1/NanoDAP](https://store.rakwireless.com/products/daplink-tool) is a very reasonably priced (10$) USB based debugging probe.
It can be used on many ARM targets, but it is particularly suited for the nRF52 CPUs. It seems to be based on the
ARM [daplink](https://daplink.io/) [project](https://github.com/ARMmbed/DAPLink). Of this project seems to be [here](https://github.com/wuxx/nanoDAP). The fork is fairly
old wrt the latest daplink goodness, but it seems fine.
If you are looking to buy a probe, there are many other daplink based devices out there. I suspect they are mostly identical. If you find one that works well please
add a note to this document.
### Required software
You'll need to install the [pyocd](https://pyocd.io/) application to allow VSCode to talk to the NanoDAP. You first install the tool itself but then must add the
support files for the nrf52840:
Installing:
```bash
pip3 install pyocd
pyocd pack --i nrf52840
pyocd pack -s
```
If you are developing on a linux system, you will need to install the udev rules for the NanoDAP.
This is done by copying the rules file from the pyocd distribution to the udev rules directory per [these](https://github.com/pyocd/pyOCD/tree/main/udev) instructions.
### Connecting the NanoDAP to your nRF52 target
The NanoDAP has a 10 pin connector, but only 3 need to be connected:
* ground goes to ground on the target
* TMS-IO goes to SWDIO on the target
* TCK-CK goes to SWCLK on the target
Some web instructions recommend connecting the RESET and 3V3 pins, but this is usually not useful.
This image shows an example connection to a RAK4630 board:
![RAK4630 DAP connection](https://docs.rakwireless.com/assets/images/accessories/rakdap1-flash-and-debug-tool/RAKDAP1_New_1.png)
### Using the NanoDAP with VSCode
Our meshtastic project has a special build environment/target which has been configured to work with the NanoDAP. To use it select the "env:rak3631_dap" target in
the bottom left of your VSCode/PlatformIO window. Once that target is selected it changes two things:
* Device programming is no longer performed via the USB bootloader. Instead you you select "Upload" it will use the NanoDAP to program the device.
* The "Debug" button in vscode will be enabled. If you click that button it will launch the ICE assisted debugger and you can set breakpoints etc...