ihidchaos/ncs-playground

nRF Connect SDK Playground

nRF Connect SDK Playground

nRF Connect SDK Playground contains a range of applications, samples, and libraries for Makerdiary's development hardware.

This repository is versioned together with the nRF Connect SDK main tree. This means that every time that nRF Connect SDK is tagged, this repository is tagged as well with the same version number, and the manifest entry for zephyr will point to the corresponding nRF Connect SDK tag. For example, the ncs-playground v2.4.0 will point to nRF Connect SDK v2.4.0. Note that the main branch always points to the development branch of nRF Connect SDK, also main.

Supported Hardware

Hardware platform	Build target
nRF52840 Connect Kit	connectkit_nrf52840
nRF52840 MDK USB Dongle	dongle_nrf52840

Getting Started

Before getting started, make sure you have a proper nRF Connect SDK development environment. Follow the official Getting started guide.

Initialization

The first step is to initialize the workspace folder (my-workspace) where the ncs-playground and all nRF Connect SDK modules will be cloned. Run the following command:

# initialize my-workspace for the ncs-playground (main branch)
west init -m https://github.com/makerdiary/ncs-playground --mr main my-workspace
# update nRF Connect SDK modules
cd my-workspace
west update

Building and running

After completing the environment setup, run the following command to build the sample (for example, Blinky):

west build -p always -b $BOARD samples/blinky

where $BOARD is the target board and -p always option forces a pristine build.

After running the west build command, the build files can be found in build/zephyr. If the board supports UF2 Bootloader, you will find the firmware with the name zephyr.uf2.

Community Support

Community support is provided via GitHub Discussions. You can also reach us on Makerdiary Community.

We would love to have more developers contribute to this project! If you're passionate about making this project better, see our Contributing Guidelines for more information.

License

Copyright (c) 2016-2023 Makerdiary. See LICENSE for further details.