summaryrefslogtreecommitdiff
path: root/docs/getting_started.rst
AgeCommit message (Collapse)Author
2026-07-18docs, udev: address Copilot review nits on PR #3775hathach
- getting_started.rst: the reST inline-link markup rendered literally inside the code-block (not a runnable command) and lacked sudo — use a plain `sudo cp examples/device/99-tinyusb-examples.rules ...`. - tools/88-tinyusb.rules: normalize the six MODE="666" entries to the 4-digit octal MODE="0666" used everywhere else in the file.
2026-07-17skill: add usb-sniffer — wire-level capture with the ataradov hardware taphathach
Fourth view in the USB debugging toolset (usbmon = host URBs, usb-debug = host reasoning, usb-target-debug = device firmware, usb-sniffer = what actually crossed D+/D-). Covers the ataradov/usb-sniffer analyzer: headless pcapng capture (--speed ls/fs/hs, --fold, --limit self-exit), Wireshark/tshark analysis recipes, and the wire realities that bite: downstream broadcast, sniffer self-capture noise, xHCI devnum != wire address, tap-point-dependent reset visibility (hub choreography anchors), FS-behind-HS-hub splits. Every recipe hardware-validated on the rig, including the capture-window floor (a 3 s window provably misses the enumeration ladder; 3M packets minimum). Two udev files with distinct audiences, not one: - examples/device/99-tinyusb-examples.rules (renamed from 99-tinyusb.rules): the user-facing rules the examples need — cafe VID access, hidraw, the ModemManager blacklist, a couple of board probes. getting_started.rst, the webusb_serial README and its source comment point here. - tools/88-tinyusb.rules: the HIL rig's private probe/analyzer allowlist, now with the sniffer (6666:6620 + blank FX2LP 04b4:8613). Installed on the rig only; the usb-sniffer skill references it.
2026-03-31Removed readme and modified the getting started docValentyn Korniienko
2026-02-10update getting_started.rst and get_deps.py for clarity and improved ↵hathach
dependency handling
2026-02-07remove sdk setup instruction for rp2040 and espressifhathach
2025-12-28Fix trailing whitespace in getting_started.rstcopilot-swe-agent[bot]
- Removed trailing whitespace from line 37 as detected by pre-commit check - Documentation builds successfully Co-authored-by: HiFiPhile <[email protected]>
2025-12-28Use appropriate syntax highlighting for Windows commandscopilot-swe-agent[bot]
- Changed Windows Command Prompt blocks from bash to bat for proper highlighting - Changed PowerShell blocks from bash to powershell for proper highlighting - Improves documentation readability and accuracy Co-authored-by: HiFiPhile <[email protected]>
2025-12-28Add detailed build instructions for rp2040 and esp32 to getting_started.rstcopilot-swe-agent[bot]
- Added dedicated "Building for RP2040" section with pico-sdk installation steps - Added dedicated "Building for ESP32" section with esp-idf installation steps - Included platform-specific instructions for Linux/macOS and Windows - Added PICO_SDK_PATH export steps before cmake for rp2040 - Added esp-idf source/export steps before cmake for esp32 - Updated note section to reference new detailed sections - Documentation builds successfully without errors Co-authored-by: HiFiPhile <[email protected]>
2025-11-11update dochathach
2025-10-21use CMake in getting_started examplesc1570
2025-10-20add note about CMakec1570
2025-10-20streamlined getting_startedc1570
2025-10-20getting_started structurec1570
2025-10-20more consolidationc1570