Technician tool v0.4

Imported from the Google Drive folder 004-technician_tool/v0.4.
This commit is contained in:
kkallas committed 2026-09-26 17:26:00 +02:00
1 parent e161941672
commit 72adfe1cec
19 files changed
+1818 -602

No files matched your search

+38 -19
View File
@@ -64,7 +64,7 @@ title = "Firmware is not running normally"
text = "The heartbeat LED should blink once per second whenever the firmware runs. A steady heartbeat LED means the firmware has frozen."
actions = [
"Switch the box off and on with the power switch.",
"If it happens again: save the session log and re-flash the official firmware (Flash tab, coming in v0.4).",
"If it happens again: save the session log and re-flash the official firmware (Flash firmware tab, App only).",
]
# =============================================================== network
@@ -597,7 +597,7 @@ title = "Box does not start"
text = "Neither LED is lit: no power or the firmware does not start."
actions = [
"Check the power supply and cable.",
"If the USB port shows up in this tool, re-flash the official firmware (Flash tab, coming in v0.4).",
"If the USB port shows up in this tool, re-flash the official firmware (Flash firmware tab, App only).",
]
# =================================================================== clock
@@ -651,29 +651,48 @@ default = "clap"
[[guide.step]]
id = "switch"
type = "question"
text = "The firmware reads the microphone as switched off. Does this box have a microphone ON/OFF switch or jumper (inside the case)?"
text = "The box reads its microphone switch as OFF. The switch is on the back of the case, just above the power switch (no need to open the box). Should this box measure noise?"
options = [
{ label = "Yes - I set it to ON", next = "switch_verify" },
{ label = "No such switch / not sure", next = "end:mic_enable_line" },
{ label = "It is meant to be off", next = "end:mic_off_ok" },
{ label = "Yes - I flipped the microphone switch", next = "switch_verify" },
{ label = "No - it is meant to be off", next = "end:mic_off_ok" },
]
[[guide.step]]
id = "switch_verify"
type = "wait"
text = "The tool restarts the box and waits for a microphone reading (up to 60 s)..."
tool_action = "reset"
# The firmware re-reads the switch before every reading (~10 s): no restart needed.
text = "Waiting for the next microphone reading (up to 30 s)..."
until = 'MICROPHONE: Read \d+ bytes'
fail_on = 'Microphone is in shutdown state'
timeout_s = 60
timeout_s = 30
on_ok = "end:mic_on"
on_fail = "end:mic_enable_line"
on_timeout = "end:mic_enable_line"
on_fail = "flip_back"
on_timeout = "flip_back"
[[guide.step]]
id = "flip_back"
type = "question"
text = "The box still reads the switch as OFF. Flip the microphone switch to the other position (it may have been ON already)."
options = [
{ label = "Done - I flipped it to the other position", next = "switch_verify2" },
{ label = "Leave it off", next = "end:mic_off_ok" },
]
[[guide.step]]
id = "switch_verify2"
type = "wait"
text = "Waiting for the next microphone reading (up to 30 s)..."
until = 'MICROPHONE: Read \d+ bytes'
fail_on = 'Microphone is in shutdown state'
timeout_s = 30
on_ok = "end:mic_on"
on_fail = "end:mic_switch_faulty"
on_timeout = "end:mic_switch_faulty"
[[guide.step]]
id = "clap"
type = "wait"
text = "Clap your hands or speak loudly right next to the box for about 20 seconds..."
text = "Check the microphone switch (back of the case, above the power switch) is ON. Then clap your hands or speak loudly right next to the box for about 20 seconds..."
until = 'dB peak: (?!-inf)'
timeout_s = 45
on_ok = "end:mic_ok"
@@ -683,8 +702,8 @@ on_timeout = "end:mic_faulty"
id = "mic_on"
severity = "ok"
title = "Microphone is on and recording"
text = "The firmware now reads audio samples."
actions = []
text = "The firmware reads audio samples again."
actions = ["Leave the microphone switch in this position."]
[[guide.end]]
id = "mic_off_ok"
@@ -694,11 +713,11 @@ text = "No noise data is recorded for this box; everything else works."
actions = []
[[guide.end]]
id = "mic_enable_line"
id = "mic_switch_faulty"
severity = "warning"
title = "Microphone enable line stays 'off'"
text = "The firmware keeps reading the microphone as switched off (GPIO3)."
actions = ["Check the microphone board and its cable/connector (inside the case); send the box MAC to the firmware team to confirm the hardware variant."]
title = "Microphone switch has no effect"
text = "The box reads the microphone as OFF in both switch positions (enable line GPIO3)."
actions = ["Check the switch and its cable to the main board (inside the case); replace the switch if needed."]
[[guide.end]]
id = "mic_ok"
@@ -711,5 +730,5 @@ actions = []
id = "mic_faulty"
severity = "error"
title = "Microphone records nothing"
text = "Even loud noise next to the box gives no signal."
text = "Even loud noise next to the box gives no signal, although the switch is on."
actions = ["Check the microphone board/cable (inside the case); replace the microphone if needed."]
+572 -572
View File
File diff suppressed because it is too large. Load diff