Code and documentation for the unofficial electronic badge for the JoCo Cruise 2019.
This is based on the excellent work that the AND!XOR team produced for the DEFCON 25 Bender Badge. It's a software revision designed to work on the badge hardware that was built for the 2018 cruise.
All code and hardware design files are closed until March 16th, 2019 and then are licensed under the Apache license 2.0 unless superceded by notices in individual files or directories.
Some resources must be installed outside of this source tree. One of these is the Nordic SDK.
Choose a place to install these on your file system. For example, we'll use "/src/joco-support/".
Download the version 12.3 of the Nordic SDK from here and unzip it into the directory you chose.
It's known that later versions of the SDK are not compatible with the existing badge code. We may work on fixing that, which is why we don't install the SDK in the source tree for the project.
Now edit your shell init or rc file to set the following environment variable when you create a shell, substituting your chosen path:
export SDK_ROOT=/src/joco-support/nRF5_SDK_12.3.0_d7731ad
Download the GNU ARM Embedded Toolchain. Choose one of these methods:
-
Download the latest from https://developer.arm.com/open-source/gnu-toolchain/gnu-rm/downloads and unpack it into its own directory in
/usr/local. Or, -
Download the version that Nordic used to test their SDK, 4.9 2015q3, from https://launchpad.net/gcc-arm-embedded/+milestone/4.9-2015-q3-update and unpack it into its own directory in
/usr/local. Or, -
sudo apt-get install gcc-arm-none-eabiand take your chances on whatever version is current for your Linux. This may be your only option if you're running Linux on a non-x86 platform.
Then edit $SDK_ROOT/components/toolchain/gcc/Makefile.posix and change the value for GNU_INSTALL_ROOT to the directory where your toolchain was installed.
If you plan to hook up hardware for programming and debugging, you'll need the Segger JLink software. It's available from https://www.segger.com/downloads/jlink/ for a variety of host platforms. We used version V6.18b, but the latest version is probably fine. To install on Ubuntu on an Intel PC:
sudo dpkg -i <path-to-downloads>/JLink_Linux_V618b_x86_64.deb
You'll also need a couple of command line tools from Nordic. These are available from https://www.nordicsemi.com/Software-and-Tools/Development-Tools/nRF5-Command-Line-Tools/Download (change the platform on the left-hand side to Linux64). We used version 9.7.0, but the latest version is probably fine. Install them in a location outside this project, like the Nordic SDK. For example using the location "/src/joco-support", you can do the following:
mkdir -p /src/joco-support/bin
cd /src/joco-support/bin
tar xvf <path-to-downloads>/nRF5x-Command-Line-Tools_9_7_0_Linux-x86_64.tar
Now edit your shell init or rc file to set the following environment variable when you create a shell, substituting your chosen path:
export NRFJ_BIN=/src/joco-support/bin
If you want to develop on an ARM-based host, most of the components are available.
The Nordic SDK is the same.
You should be able to sudo apt-get install gcc-arm-none-eabi to get the toolchain.
You can get JLink software from Segger here
The command line tools nrfjprog and mergehex are not currently available for ARM hosts. You can use the JLink tools to program the device, so you can probably work around nrfjprog.
cd firmware/src
make
cd ..
./update.sh
To flash the code to the badge and use the Ozone debugger, you'll need a JTAG hardware interface. The one that was used by the development team is the Segger J-Link EDU Mini.
It's much easier to connect to the board if you use a short flat cable and a mating header on the board end. All these can be purchased from these retailers:
- J-Link EDU Mini from Adafruit (this comes with a 10-pin 2x5 cable)
- Header from Mouser
Pin 1 on the J-Link EDU Mini is labeled with a (1) icon. Plug in the red edge of the ribbon cable that comes with the J-Link to this pin.
On the badge, look for the row of 10 holes in a 2x5 arrangement to the right of the RIGADO bluetooth chip on the top right. Pin 1 is not labeled, but is the square pad on the top left. Plug the 2x5 header into these holes, then plug in the red edge of the cable so Pin 1 is the top left of the header (which is plugged in to the square pad).
Make sure the badge is powered on (ensure three AA batteries are inserted, then turn on the switch on the bottom left) before flashing the target.
After powering on the badge, there are two ways to flash. Either:
cd firmware
./provision.sh
or
cd firmware/src
make flash_softdevice
make flash
The make flash_softdevice can be omitted after the first time.
The directory SD Image contains files which should be on the Micro SD card plugged in next to the screen.
Unplug the SD card from the badge, attach to a Micro SD card adapter, insert into an SD card reader, connect to a computer, then sync over the contents. For example:
rsync -rav SD\\\ Image/ /path/to/mounts/NO\ NAME
This was correct for Ubuntu 14.04.5 64 bit
Install the Ozone package from here
The manual is useful (same link)
IMPORTANT NOTE:
Ozone version 2.56 would not work for me. It would halt execution in seemingly random places and not load source code.
Version 2.54b works fine
If you're using the Segger edu device, Select the device as Nordic nRF52832_xxAA
Choose SWD for the debugger device and NOT USB.
open the badge .out file to bring in source files