Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/blockchainsllc/nrf-in3-template
Boiler Plate for IN3 projects on the Nordic nRF52840 using Nordic SDK and Softdevice.
https://github.com/blockchainsllc/nrf-in3-template
Last synced: 25 days ago
JSON representation
Boiler Plate for IN3 projects on the Nordic nRF52840 using Nordic SDK and Softdevice.
- Host: GitHub
- URL: https://github.com/blockchainsllc/nrf-in3-template
- Owner: blockchainsllc
- License: other
- Created: 2020-03-03T12:37:19.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2022-12-08T07:24:44.000Z (about 2 years ago)
- Last Synced: 2024-11-08T02:15:35.447Z (3 months ago)
- Language: C
- Size: 1.81 MB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# IN3 on NRF52840 Template
Boiler Plate for IN3 projects on the Nordic nRF52840 using Nordic SDK and Softdevice.
#### Usage
1. Be sure to have all [dependencies](#dependencies) installed
2. Delete old builds with `make clean`
3. Compile sources with `make ./Makefile` or just `make`
4. Connect the device
5. Erase device memory to be sure only the desired firmware is in the device `make erase`
6. Write Nordic Softdevice with `make flash_softdevice`
7. Write in3 firmware with `make flash`
8. Connect the device to other capable device with internet connection accordingly to the loaded transport module
##### Compilation and Flashing
```
make clean
make
make erase
make flash_softdevice
make flash
```
##### All Make commands
- `make flash`: Runs `nrfjprog` to program the device with latest firmware
- `make erase`: Runs `nrfjprog` to erase the device
- `make flash_softdevice`: Runs `nrfjprog` to program the device with latest [softdevice](https://www.nordicsemi.com/Software-and-Tools/Software/S140) hex
- `make debug-server`: Runs Segger J-Link Debugger Server
- `make debug`: Uses `gcc` to compile the program and execute debugging commands
- `make sdk_config`: Uses `java` and [CMSIS Configuration Wizard](https://infocenter.nordicsemi.com/topic/com.nordic.infocenter.sdk5.v15.2.0/sdk_config.html) to allows users to easily configure ARM source files without using the Keil uVision IDE. Loads `config/sdk_config.h` from sources.
- `make check_env`: Check for NRF5 SDK folder
- `make update_in3`: Updates the version of in3 being used.
## Supported transport modules
Change `main.c`to activate he desired transport module, `UART` is de the default. Only **ONE** transport module can be activated on the current firmware version.
- UART - **_default_** - Universal Asynchronous Receiver/Transmitter
- BLE - Bluetooth Low-Energy
- USB - Universal Serial Bus
#### UART - Universal Asynchronous Receiver/Transmitter
Developer need an UART to USB adapter to be able to access this interface. We used `FTDI232`for testing.
- [Mouser.de FTDI 232](https://www.mouser.de/ProductDetail/Parallax/28024?qs=%2Fha2pyFaduj%2FYF1ey9away8PnRzDxED6kbp3OE70Ey4%3D)
- [Bus Pirate](http://dangerousprototypes.com/docs/Bus_Pirate)
##### Usage
1. Connect the UART to USB adapter to the nRF accordingly to the pinout
2. Create a python virtual environment `virtualenv -p python3 venv`
3. Activate it `source venv/bin/activate`
4. Install the dependencies `pip install -r scripts/requirements.txt`
5. Run the script `python scripts/in3_uart_adapter.py`
6. Turn on the dev board or press the reset button
7. Script must show the incubed payload and request the data from the in3 server
##### UART pinout on nRF5840:
| PIN NUMBER | PIN NAME | FTDI232 |
|:----------:|:--------:|:--------:|
| P0.29 | TXD | RXD |
| P0.31 | RXD | TXD |
| P1.13 | RTS | CTS |
| P1.15 | CTS | DTR |
#### BLE - Bluetooth Low-Energy
Missing pairing. Working with hardcoded parameters.
#### USB - Universal Serial Bus
*Future feature*
## Dependencies
- [Nordic nRF52 SDK](https://www.nordicsemi.com/Software-and-Tools/Software/nRF5-SDK)
- [Nordic Command Line Tools](https://www.nordicsemi.com/Software-and-Tools/Development-Tools/nRF-Command-Line-Tools/Download)
- [Micro-ecc library](https://github.com/kmackay/micro-ecc)
- [Installation steps](https://infocenter.nordicsemi.com/index.jsp?topic=%2Fcom.nordic.infocenter.sdk5.v12.2.0%2Flib_crypto.html&cp=4_0_1_3_9_2&anchor=lib_crypto_installing)
#### Tested on
- [Nordic nRF52840 PCA10056](https://www.nordicsemi.com/Software-and-Tools/Development-Kits/nRF52840-DK)
- [Nordic nRF52840 Dongle](https://www.nordicsemi.com/Software-and-Tools/Development-Kits/nRF52840-Dongle)