Shell: the console's commands on the device's own screen and keyboard (#67)
CI / build (pull_request) Successful in 1m48s
Site / build (pull_request) Successful in 9s

An App in the Launcher that runs the same commands as USB serial and the
Debug Console, trusted like the first. It shows what the console prints
while it is open, through a second ring of the console's that exists only
meanwhile; Ctrl+b keeps only what follows your own commands. Tab completes
a command's name from the firmware's help text, Fn with up and down recalls
earlier lines, Alt with up and down scrolls back. `rm` asks first in the
Shell, `rm -f` doesn't. Nothing is kept once the App is left.

`screenshot [seconds]` saves the screen as a PNG in /screenshots on the
card, now or after a pause: written a row at a time, indexed colour with
RGB332 as the palette, in one stored deflate block.

487 host tests (11 new: the PNG writer, the Shell's log filter, Tab).
Checked on the device over the Debug Console: commands, Tab, history, a
screenshot fetched and decoded on the PC, rm with and without the question,
a delayed screenshot of another screen. 12 KB of flash; 7 KB of heap while
open. Decisions Q204 to Q212 in docs/milestones/S1.md. Safe Mode: #77.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01EhqxQ49eCju4CzKYNjZzwT
This commit is contained in:
2026-10-07 10:53:31 +02:00
co-authored by Claude Opus 5.5
parent c278a06ca1
commit 3863d28593
29 changed files with 1112 additions and 50 deletions
+53 -31
View File
@@ -35,38 +35,71 @@ void Console::captureEspLogs() {
if (!espLogNext) espLogNext = esp_log_set_vprintf(teeEspLog); // once: it stays, and costs nothing with the ring closed
}
bool Console::openRing() {
if (ring_) return true;
auto* fresh = static_cast<uint8_t*>(malloc(kRingBytes));
namespace {
// One ring: the last kRingBytes written, and how many were written in all. Under ringLock.
bool openOne(uint8_t*& ring, uint32_t& head) {
if (ring) return true;
auto* fresh = static_cast<uint8_t*>(malloc(Console::kRingBytes));
if (!fresh) return false;
portENTER_CRITICAL(&ringLock);
head_ = 0;
ring_ = fresh;
head = 0;
ring = fresh;
portEXIT_CRITICAL(&ringLock);
return true;
}
void Console::closeRing() {
void closeOne(uint8_t*& ring) {
portENTER_CRITICAL(&ringLock);
uint8_t* old = ring_;
ring_ = nullptr;
uint8_t* old = ring;
ring = nullptr;
portEXIT_CRITICAL(&ringLock);
free(old);
}
void writeOne(uint8_t* ring, uint32_t& head, const uint8_t* data, size_t len) { // inside the lock
if (!ring) return;
size_t at = head % Console::kRingBytes;
size_t first = std::min(len, Console::kRingBytes - at);
memcpy(ring + at, data, first);
memcpy(ring, data + first, len - first);
head += len;
}
size_t readOne(const uint8_t* ring, uint32_t head, uint32_t& pos, uint8_t* out, size_t max, uint32_t& skipped) {
portENTER_CRITICAL(&ringLock);
size_t n = 0;
skipped = 0;
if (ring) {
uint32_t from = head > Console::kRingBytes ? head - Console::kRingBytes : 0;
skipped = pos < from ? from - pos : 0;
if (pos < from) pos = from;
n = std::min<size_t>(max, head - pos);
size_t at = pos % Console::kRingBytes;
size_t first = std::min(n, Console::kRingBytes - at);
memcpy(out, ring + at, first);
memcpy(out + first, ring, n - first);
pos += n;
}
portEXIT_CRITICAL(&ringLock);
return n;
}
} // namespace
bool Console::openRing() { return openOne(ring_, head_); }
void Console::closeRing() { closeOne(ring_); }
bool Console::openShellRing() { return openOne(shellRing_, shellHead_); }
void Console::closeShellRing() { closeOne(shellRing_); }
void Console::toRing(const uint8_t* data, size_t len) {
if (len > kRingBytes) {
data += len - kRingBytes; // only the tail can fit
len = kRingBytes;
}
portENTER_CRITICAL(&ringLock);
if (ring_) {
size_t at = head_ % kRingBytes;
size_t first = std::min(len, kRingBytes - at);
memcpy(ring_ + at, data, first);
memcpy(ring_, data + first, len - first);
head_ += len;
}
writeOne(ring_, head_, data, len);
writeOne(shellRing_, shellHead_, data, len);
portEXIT_CRITICAL(&ringLock);
}
@@ -78,22 +111,11 @@ uint32_t Console::oldest() const {
}
size_t Console::readSince(uint32_t& pos, uint8_t* out, size_t max, uint32_t& skipped) {
portENTER_CRITICAL(&ringLock);
size_t n = 0;
skipped = 0;
if (ring_) {
uint32_t from = head_ > kRingBytes ? head_ - kRingBytes : 0;
skipped = pos < from ? from - pos : 0;
if (pos < from) pos = from;
n = std::min<size_t>(max, head_ - pos);
size_t at = pos % kRingBytes;
size_t first = std::min(n, kRingBytes - at);
memcpy(out, ring_ + at, first);
memcpy(out + first, ring_, n - first);
pos += n;
}
portEXIT_CRITICAL(&ringLock);
return n;
return readOne(ring_, head_, pos, out, max, skipped);
}
size_t Console::readShellSince(uint32_t& pos, uint8_t* out, size_t max, uint32_t& skipped) {
return readOne(shellRing_, shellHead_, pos, out, max, skipped);
}
size_t Console::write(const uint8_t* data, size_t len) {