Developer guide

This guide is for someone building the app from source, forking it, or extending it with a screen or a demo of their own. The app is a React Native project in TypeScript, one codebase for Android and iOS, and its source is at github.com/Brainchip-Inc/BrainChip-Connect.

BrainChip Connect is licensed under the Apache License 2.0. NOTICE lists third-party components.

The chapters

1. Repository layout: where things live and which libraries do what.
2. Build and run a debug build: the toolchain, a first build on a phone or an emulator, and a debug APK that runs on its own.
3. How the app talks to the board: discovery, the command channel, detections, and the firmware and model transfers.
4. Add a screen or a demo: what a new screen needs, and what a new application on the board needs from the app.

Before you start

• CONTRIBUTING.md is the commit convention and the merge rules, enforced in CI.
• AGENTS.md in the repository root holds the project notes that travel with the code: setting up, the checks, how the app talks to a board and what adding a demo involves. Read it before touching the Bluetooth layer.
• Bugs go to GitHub issues and questions to the BrainChip Discord. A security problem is reported privately through the repository’s Security tab, under Report a vulnerability, never in a public issue.
• The user guide describes what every screen does from the user’s side.