Skip to content

docs(onboard): add Linux and Windows setup notes - #11

Merged
reubenmiller merged 1 commit into
mainfrom
docs/onboard-linux-windows
Nov 11, 2026
Merged

reubenmiller merged 1 commit into
mainfrom
docs/onboard-linux-windows

Conversation

@reubenmiller

Copy link
Copy Markdown
Contributor

Adds platform notes to the tedge-onboard README:

  • Linux: USB serial ports need the dialout group (uucp on Arch Linux), with the commands to check and add it. The Wi-Fi network is read through NetworkManager; without it, the tool asks for the network and password.
  • Windows: boards with a built-in USB port (ESP32-C6, ESP32-S3) need no driver on Windows 10 and later. Boards with a separate USB chip may need the CP210x or CH340 driver.
  • The "No device was found" troubleshooting row now points at both, since a denied port or a missing driver shows up as "No board was found".

Docs only. The Linux and Windows paths have unit tests but haven't been tried with a real board yet.

🤖 Generated with Claude Code

Linux users need serial port access (dialout or uucp group), and the
tool reads Wi-Fi through NetworkManager. Windows boards with a separate
USB chip may need the CP210x or CH340 driver. The "No device was found"
row now points at both.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
@reubenmiller
reubenmiller merged commit df2b85c into main Nov 11, 2026
15 checks passed
@reubenmiller
reubenmiller deleted the docs/onboard-linux-windows branch November 11, 2026 01:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant