scottbez1/smartknob

Firmware Documentation

Open

#85 opened on Jul 13, 2022

View on GitHub
 (0 comments) (3 reactions) (0 assignees)C++ (21,794 stars) (1,262 forks)batch import
documentationgood first issuetype: firmware

Description

I'm a hardware guy through and through, so the flashing portion of this project has been a complete mystery to me. I have PlatformIO setup (I think?), but I'm still lost on why attempts fail. Is there a chance the flashing process can be documented soon, at least on a basic level?

Contributor guide

Tech stack
cpp
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
smartknob hardwarePlatformIO setupbasic C++ knowledge
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Examine the repository's firmware directory and any existing documentation. Look at the PlatformIO configuration file (platformio.ini) to understand the build and flash process. Test the flashing procedure with a smartknob device and create a step by step guide. Reference any linked PRs or comments if available, though none exist.