From 78d6e5931c1e6412190e1f3ec271c7a7e6cd4d4f Mon Sep 17 00:00:00 2001 From: Jake Kenneally Date: Tue, 3 Feb 2026 16:33:20 -0500 Subject: [PATCH] fix: Correct `debugging_monitor.py` script instructions (#676) ## Summary **What is the goal of this PR?** - Minor correction to the `debugging_monitor.py` script instructions **What changes are included?** - `pyserial` should be installed, NOT `serial`, which is a [different lib](https://pypi.org/project/serial/) - Added macOS serial port ## Additional Context - Just a minor docs update. I can confirm the debugging script is working great on macOS --- ### AI Usage While CrossPoint doesn't have restrictions on AI tools in contributing, please be transparent about their usage as it helps set the right context for reviewers. Did you use AI tools to help write this code? _**< NO >**_ --- README.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 9efa6801..151c6293 100644 --- a/README.md +++ b/README.md @@ -102,13 +102,18 @@ After flashing the new features, it’s recommended to capture detailed logs fro First, make sure all required Python packages are installed: ```python -python3 -m pip install serial colorama matplotlib +python3 -m pip install pyserial colorama matplotlib ``` after that run the script: ```sh +# For Linux +# This was tested on Debian and should work on most Linux systems. python3 scripts/debugging_monitor.py + +# For macOS +python3 scripts/debugging_monitor.py /dev/cu.usbmodem2101 ``` -This was tested on Debian and should work on most Linux systems. Minor adjustments may be required for Windows or macOS. +Minor adjustments may be required for Windows. ## Internals