https://github.com/nes-lab/shepherd-targets
Collection of Target-Hardware and MCU-Firmwares
https://github.com/nes-lab/shepherd-targets
Last synced: 6 months ago
JSON representation
Collection of Target-Hardware and MCU-Firmwares
- Host: GitHub
- URL: https://github.com/nes-lab/shepherd-targets
- Owner: nes-lab
- License: mit
- Created: 2023-06-07T11:37:30.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2026-01-01T20:18:12.000Z (7 months ago)
- Last Synced: 2026-01-19T11:38:35.916Z (6 months ago)
- Language: C
- Homepage:
- Size: 27.4 MB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Target Boards & Firmware
[](https://github.com/nes-lab/shepherd-targets/actions/workflows/build_msp.yaml)
[](https://github.com/nes-lab/shepherd-targets/actions/workflows/build_nrf.yaml)
[](https://github.com/nes-lab/shepherd-targets/actions/workflows/qa_tests.yaml)
**Main Documentation**:
**Source Code**:
**Main Project**:
---
The repository contains a collection of target-hardware and mcu-firmwares used by the shepherd-testbed.
In the past shepherd had a nRF52-only target but can now leverage an additional FRAM, as demonstrated successfully by the
[Riotee-Platform](https://www.riotee.nessie-circuits.de).
**NOTE**: The shepherd testbed has a second target-port (unused) and is looking for ideas.
Just contact us if you got ideas.
## nRF52 with MSP430FR as FRAM
Hardware v1.3+ uses
- nRF52840
- MSP430FR5994 (TI)
- RTC AB1805
BOM, gerber-files and schematics are available in the [PCB-Directory](https://github.com/nes-lab/shepherd-targets/tree/main/hardware).
This folder also contains a guide for testing new target-PCBs.
### Features
- freedom to use both MCUs as needed (just as radio or FRAM) or disable when not needed (deep sleep)
- over-voltage protection for V_LV (max 3.9V)
- under-voltage protection with hysteresis for nRF
- one debug LEDs with separate supply for minimal impact on pwr-budget
- one self-powered LED to "burn" energy
- io pins not interfering with RF (nRF PS v1.6 page 578)
- LEDs / UART similar to [Riotee](https://www.riotee.nessie-circuits.de/)
- nRF uses low voltage mode (PSv1.1 page 61)
- 16x GPIO shared to host, current-limited with 240R star-configuration (every participant has that resistor on its port to also keep data rates >10 MHz)
- high & low power-good-signal (similar to riotee)
- SMA-port for external antenna
- 3rd possible way for reset (external), beside jtag and pwr-cycle
### nRF52-Firmwares
- [nrf52_demo_rf](https://github.com/nes-lab/shepherd-targets/tree/main/firmware/nrf52_demo_rf): demo implementation for a simple node that sends BLE packets when energy budget allows it
- [nrf52_testable](https://github.com/nes-lab/shepherd-targets/tree/main/firmware/nrf52_testable): watches all gpio and reports with UART messages (verification after assembly)
- ensures that pcb is assembled OK and both MCUs are programmable and show basic functions
- what is not tested: watchdog, FRAM, RF-Frontend (-> use rf-demo or rf-survey), sleep power consumption
- [nrf52_rf_test](https://github.com/nes-lab/shepherd-targets/tree/main/firmware/nrf52_rf_test): sends out 1 BLE-Packet per second (verify with an app like `RaMBLE`)
- [nrf52_rf_survey](https://github.com/nes-lab/shepherd-targets/tree/main/firmware/nrf52_rf_survey): Link Matrix Generator - TX-Unit - sends packet with every possible P_TX, loops until stopped
- [nrf52_deep_sleep](https://github.com/nes-lab/shepherd-targets/tree/main/firmware/nrf52_deep_sleep): practically turned off MCU with the lowest possible consumption
- TODO: nrf52_spi_radio - default implementation to use nRF as a radio frontend
### MSP430FR-Firmwares
- [msp430_deep_sleep](https://github.com/nes-lab/shepherd-targets/tree/main/firmware/msp430_deep_sleep): practically turned off MCU with the lowest possible consumption
- [msp430_spi_fram](https://github.com/nes-lab/shepherd-targets/tree/main/firmware/msp430_spi_fram): [riotee](https://github.com/NessieCircuits/Riotee_MSP430Fram) implementation to use MSP as a flash storage
- [msp430_testable](https://github.com/nes-lab/shepherd-targets/tree/main/firmware/msp430_testable): switches on all shared gpio one by one (verification after assembly)
## Getting started
Step by step description for installing all prerequisites to compile the firmware.
### nRF52
- Make sure you have the [GNU Arm Embedded Toolchain](https://developer.arm.com/tools-and-software/open-source-software/developer-tools/gnu-toolchain/gnu-rm/downloads) installed
- If `arm-none-eabi-gcc` is not in your path, set the environment variable `GNU_INSTALL_ROOT` accordingly, e.g.: `export GNU_INSTALL_ROOT=/opt/toolchain/` (note the trailing foreslash)
- Download the nRF5 SDK from [here.](https://www.nordicsemi.com/Software-and-tools/Software/nRF5-SDK/Download) (You don't need a SoftDevice) and extract it
- Set the environment variables `SDK_ROOT` to the corresponding absolute path, e.g.: `export SDK_ROOT=/home/user/nRF5_SDK_17.0.2_d674dde/`
- run `make`
Refer to [the GitHub workflow](https://github.com/nes-lab/shepherd-targets/tree/main/.github/workflows/build_nrf.yaml) for how to install the toolchain and build the project.
### MSP430
To build the code, you'll need the gcc toolchain for the MSP430 microcontroller series. Refer to [the GitHub workflow](https://github.com/nes-lab/shepherd-targets/tree/main/.github/workflows/build_msp.yaml) for how to install the toolchain and build the project.
### Controlling the Node-ID
When an `elf`-firmware contains a ``SHEPHERD_NODE_ID``, the variable will be patched with the actual target-ID before running the experiment. See the proposed [c-file](https://github.com/nes-lab/shepherd-targets/tree/main/firmware/nrf52_demo_rf/src/shepherd_node_id.c) for more information.