From cfd9715023c598aa744f403f957005616c1b0af3 Mon Sep 17 00:00:00 2001 From: true Date: Tue, 31 Oct 2023 08:22:07 -0700 Subject: [PATCH] Update README.md --- README.md | 36 ++++++++++++++++++------------------ 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 52e47b4..d0d9fd3 100644 --- a/README.md +++ b/README.md @@ -7,11 +7,11 @@ This is a PlatformIO-compatible project.   **BE AWARE:** -On REV1 boards, the right potentiometer only works for the first half of its rotation. Turning the right pot beyond half way will not cause damage, but will consume extra current (up to ~3-5mA) and will flash the eyes red an error indicator while in RGB fun mode. +On REV1 boards, the right potentiometer only works for the first half of its rotation. Turning the right pot beyond half way _will not cause damage_, but the addon will consume extra current (up to ~3-5mA). If the knob is within the affected second half of rotation, the eye LEDs will flash red as an indicator while in RGB fun mode. -To work around this, use the right pot within the first half of its rotation. +To work around this, use the right pot only within the first half of its rotation. -  +  ## What can you do with it? @@ -42,6 +42,13 @@ The TEST-O Robot is: - There is an empty RGB LED program slot available for hackers to add one +## Hacking + +Use a DAPLink probe to debug. If you don't have one, there are many projects to convert existing devboards to DAPLink. + +If you want to hack on this without a debug probe, an XMODEM bootloader is available. Use a TTL UART to connect to the UART pins on the addon header. To activate the bootloader, ensure the left knob is between halfway to full clockwise. Press and hold the button while powering on. The bootloader will now indicate it is working with flashing LEDs, and will communicate at 115200-8-N-1. Send your firmware.bin file using XMODEM using a terminal emulator. + + ## Specifications - PUYA PY32F003W16S6 MCU @@ -56,23 +63,16 @@ The TEST-O Robot is: ## Misc Notes: -- This device is using PUYA PY32F003 MCU. This is a CM0+ MCU - that is intended for the China domestic market. This MCU, - as well as other PY32F002A/003/030 cores with at least 32K - flash, internally uses the same core as PY32F030F6P6. +- This device is using PUYA PY32F003 MCU, an MCU intended for + the China domestic market. This MCU, as well as other + PY32F002A/003/030 cores with at least 32K flash, internally + uses the same core (and has the same features) as PY32F030F6P6. -- To activate the bootloader, press and hold the button while - powering on while the left knob is turned between halfway to - full clockwise. The bootloader will now communicate on the UART pins - of the addon header at 115200-8-N-1 and wait for XMODEM data. +- The normal firwmare does not use UART and leaves the pins configured + as SWD for the user. -- To use a debugger, connect using the UART pins on the addon header. - The normal firwmare does not use UART and leaves the pins configured - as SWD for the user. Use a DAPLink compatible debugger. If you don't - have one, there are many projects to convert existing devboards to DAPLink. - -- There is no official OpenOCD support for this MCU. Adding the PUYA MCU - to pyOCD is trivial, so this project uses pyOCD. Using OpenOCD, J-Link, +- There is no official OpenOCD support for this MCU. This project uses + pyOCD as adding PUYA MCU to pyOCD is trivial. Using OpenOCD, J-Link, or anything other than the DAPLink compatible debugger with pyOCD is untested and left as an exercise to the programmer.