miata-bot / conergb-companion

React Native companion app for can-link project.

RGB Controller Companion Mobile Application

A React Native application to control an RGB Controller over BLE. The RGB Controller is an open source hardware project designed, among many other things, to control auxiliary RGB lighting.

---

Tech Stack

This app is written in TypeScript and utilizes React Native, a few core libraries, and various other supporting libraries.

Core dependencies include:

• React Native
  • Allows for the creation of native mobile applications written with Javascript
• Native Base
  • Component and theming library that provides the foundation for this application's user interface
• react-native-ble-manager
  • Bridges native Bluetooth Low Energy APIs
• react-native-permissions
  • Bridges native app permissions APIs
• React Navigation
  • Routing and navigation library that provides a true native experience for transitioning between app screens

---

Local Development

TL;DR: run npm i and npm run start.

The instructions for setting up the development environment closely follows the instructions in React Native's documentation for setting up a development environment. Ensure that you are reading the instructions under "React Native CLI Quickstart".

This project requires Node.js 18; I highly recommend installing it with asdf and its associated node plugin.

conergb-companion's Issues

Onboarding flow

The app should have on onboarding flow that:

• explains the need for and then asks for permissions
• scans for and pairs to the controller
• remembers that the user has already gone through onboarding
• reappears if pairing is lost

Bluetooth functionality can be mocked.

Bluetooth functionality

The app should be able to:

• scan for the controller
• pair with the controller
• send/receive data

Add helper text if android and bt perms are unavailable