Requirements
Hardware and OS for CHESTER SDK development: CHESTER DevKit, SEGGER J-Link Compact Plus, Power Profiler Kit 2 and Ubuntu, macOS or Windows.
J-Link Installation
Install nRF Command Line Tools with the SEGGER J-Link software pack, then connect J-Link to CHESTER through the Cortex-M adapter and the 10-pin SWD cable.
Installation on Ubuntu
Install the CHESTER SDK on Ubuntu 22.04 LTS: udev rules, APT packages, a Python virtual environment and West workspace, then build and flash blinky.
Installation on macOS
Install the CHESTER SDK on macOS 12 or 13 with Homebrew, a Python virtual environment and West, then build and flash the blinky sample.
Installation on Windows
Install the CHESTER SDK on Windows 10 or 11: Python, Chocolatey packages, a West workspace in a path without spaces, then build and flash blinky.
Build and Deploy
Build CHESTER firmware with west build, stamp it with FW_NAME and FW_VERSION, and upload it to HARDWARIO Cloud with the HARDWARIO CLI to share by QR code.
Debug
Debug CHESTER firmware with nRF Connect for VS Code: debug build, single stepping, shell over RTT, threads, and keeping the UICR region intact.
Applications
Source code structure of the CHESTER catalog applications: project files, application flow, and how to add a sensor or a shell config option.
Samples
Overview of the CHESTER SDK samples for extension modules, sensors, BLE, LTE, LoRaWAN and GNSS; each one is a separate project to build and flash.
Application Customization
Customize a CHESTER catalog application in your own Git fork of the CHESTER SDK and keep it current by rebasing onto the upstream main branch.
How to: I²C Bus
Read and write registers of I²C target devices from CHESTER firmware with the Zephyr I²C API, and scan the bus with the i2c scan shell command.
How to: Kconfig
Define a custom Kconfig option in a CHESTER application, enable or disable it in prj.conf, and inspect the generated macros in autoconf.h.
How to: CBOR
Encode CHESTER data for HARDWARIO Cloud with CBOR: describe the message in a YAML codec file and use the keys generated in app_codec.h in your C code.
How to: LTE v2
Upgrade CHESTER firmware to LTE v2 and HARDWARIO Cloud: LTE modem v1.7.0, ctr_cloud instead of ctr_lte, hierarchical CBOR codecs, APN, IP address and port.
How to: Project Generator
Use the CHESTER SDK Project Generator to define catalog application variants and features in project.yaml and generate the files with west chester-update.
Git Repository
API Reference
Licenses
CHESTER SDK license terms (LicenseRef-HARDWARIO-5-Clause, use with HARDWARIO hardware only), SPDX identifiers and license reports made with ncs-sbom.