kkallasandClaude Opus 5.5
0d21c5c205
Some files had been saved with CRLF on Windows, so a one-line change showed as a whole-file diff. .gitattributes now stores text as LF (.bat stays CRLF for cmd, .command/.sh LF for macOS). Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
88 lines
4.8 KiB
Python
88 lines
4.8 KiB
Python
"""Quick-start cheat sheet shown on launch.
|
|
|
|
LED table for firmware 1.0.16+ (firmware-diagnostics-what-changed.md,
|
|
status.cpp Status::pattern_for): colour AND pattern name the fault. Older
|
|
boxes (v1.0, built Jun 29 2026) show the same colours, always solid.
|
|
"""
|
|
|
|
# (swatch colour, LED name, pattern -> meaning, first action)
|
|
LED_TABLE = [
|
|
("#2e9e44", "Green", "solid: everything OK.", "Nothing to do."),
|
|
("#1fc8d8", "Cyan",
|
|
"breathing: not paired in Matter yet<br>fast blink: a phone is connected for pairing.",
|
|
"Pair the box in the Matter app (QR sticker or the QR code in the tool)."),
|
|
("#f4f4f4", "White",
|
|
"fast blink: SD card or ENV.TXT error<br>solid: factory reset (Matter button held 5 s)<br>"
|
|
"breathing: Wi-Fi setup portal.",
|
|
"SD card is inside the case: re-seat or re-provision it. Setup portal: short-press the button to leave."),
|
|
("#d64541", "Red",
|
|
"1-6 pulses: 1 BME688, 2 SEN66, 3 AS7341, 4 microphone, 5 flicker, 6 self-check failed<br>"
|
|
"solid: other internal error / out of memory.",
|
|
"Count the pulses, then check that sensor's cable. The box restarts itself after 150 s."),
|
|
("#2f6fd6", "Blue",
|
|
"1 pulse: clock (RTC) not responding<br>2 pulses: I2C bus stuck (shorted / broken sensor cable).",
|
|
"Check the I2C cable between the boards first, then the RTC module."),
|
|
("#8e44ad", "Purple",
|
|
"solid: no network<br>blinking: server rejected the box (wrong ENV.TXT credentials).",
|
|
"Solid: check Wi-Fi / Internet. Blinking: re-provision the SD card with the current ENV.TXT."),
|
|
("#e6c229", "Yellow", "blinking, faster over time: downloading an update.", "Do not switch off. Wait."),
|
|
("#f08c1a", "Orange", "solid: self-check after an update (~2.5 min).",
|
|
"Wait; should turn green (or red on failure)."),
|
|
("#444444", "Off", "Firmware did not start (or crashed very early).",
|
|
"Check power switch & USB cable. If the small LED is also dark: re-flash."),
|
|
]
|
|
|
|
HINTS = [
|
|
"<b>Before a self-restart</b> the LED flashes the error colour 3 times; <b>after the restart</b> it "
|
|
"shows the previous error for 3 s. So a reboot loop shows its cause. Connect serial and press "
|
|
"<i>Reset & capture</i>: the tool reads the restart reason from the box.",
|
|
"<b>Small LED next to the RGB LED</b> (heartbeat): blinks once per second while online, "
|
|
"double-blinks while offline. Dark or steady = firmware hung or not running.",
|
|
"<b>Serial monitor</b>: lines starting with <b>KOTA:</b> are the box's own diagnosis (boot, I2C, SD, "
|
|
"clock, Matter, microphone, status, LED, and a health line every 60 s). The Diagnosis panel reads them "
|
|
"directly; filter the view with <i>KOTA diagnostics + errors</i>. Error lines carry a code like "
|
|
"<b>[E-SD-03]</b> - the tool shows the recommended action for it.",
|
|
"<b>Outside the case</b> (back): power switch, the <b>microphone switch</b> just above it "
|
|
"(off = no noise measurements), and the Matter button. Holding the "
|
|
"Matter button <b>5 s</b> factory-resets the box (it forgets its Matter "
|
|
"network and must be commissioned again with the sticker QR code).",
|
|
"<b>Inside the case</b> (unscrew): RESET and BOOT buttons and the SD card. "
|
|
"Normally not needed - the tool resets the board over USB.",
|
|
"<b>Flashing</b> uses only the firmware files in the tool's <b>firmware</b> folder; choose the build "
|
|
"by its compile date.",
|
|
]
|
|
|
|
STEPS = [
|
|
"Switch the sensorbox <b>power switch ON</b>.",
|
|
"Connect the laptop to the box's <b>native USB</b> port with a data-capable cable.",
|
|
"Open the <b>Serial monitor</b> tab, choose the sensorbox port, press "
|
|
"<b>Connect</b>.",
|
|
"Press <b>Reset & capture</b> to record a full boot log from the first line.",
|
|
"Read the <b>Diagnosis</b> panel on the right, then open <b>Guided troubleshooting</b> "
|
|
"and start <b>Quick check</b>: the tool asks what you see and checks the log live.",
|
|
]
|
|
|
|
|
|
def cheatsheet_html() -> str:
|
|
rows = "".join(
|
|
f"<tr><td style='padding:6px'><span style='background:{c};"
|
|
f"border:1px solid #888'> </span> <b>{name}</b></td>"
|
|
f"<td style='padding:6px'>{meaning}</td><td style='padding:6px'>{action}</td></tr>"
|
|
for c, name, meaning, action in LED_TABLE
|
|
)
|
|
steps = "".join(f"<li>{s}</li>" for s in STEPS)
|
|
hints = "".join(f"<li>{h}</li>" for h in HINTS)
|
|
return f"""
|
|
<h2>Sensorbox quick start</h2>
|
|
<ol>{steps}</ol>
|
|
<h3>RGB status LED - colour and pattern</h3>
|
|
<table border='1' cellspacing='0' cellpadding='0' width='100%'>
|
|
<tr><th align='left' style='padding:6px'>LED</th>
|
|
<th align='left' style='padding:6px'>Pattern: meaning</th>
|
|
<th align='left' style='padding:6px'>First action</th></tr>
|
|
{rows}
|
|
</table>
|
|
<h3>Good to know</h3>
|
|
<ul>{hints}</ul>
|
|
"""
|