Capability 004: Event Log Size and Clear¶
Status: Accepted
Context¶
The Event Log of capability 003 grows with every entry and pushes everything below it down the page. While debugging, the Robot Operator also wants to see only what happens from now on, e.g. the outcome of the next Stop Command, without telling it apart from older entries by their time.
References¶
- Event Log: capability 003
- Status Pane: capability 002
- Target picture:
target_picture.md - Responsive web and user experience: directives in
responsive_web.mdanduser_experience.md
Details¶
| Element | Behavior |
|---|---|
| Event Log | 12 rem high, whatever the number of entries; scrolls vertically once its entries need more room; never scrolls horizontally |
| Entry | Time and severity stand in columns of their own; a message too long for its line wraps and continues flush under its own start, so that each entry stands out from the next |
Button Clear |
Follows the heading Event Log; a click removes every entry |
Functional Requirements¶
- The Event Log keeps the height given under Details and scrolls as given there.
- Its entries wrap as given under Details.
- A click on
Clearremoves every entry from the Event Log; outcomes that arrive afterwards are recorded as before.
Non-Functional Requirements¶
None.
Technical Requirements¶
None.
Error Handling¶
None.
Out of Scope¶
- Asking for confirmation before clearing; the entries are a debugging aid, not a record
- Holding the scroll position while new entries arrive, filtering, or saving the Event Log
- Clearing anything in the Superordinate Controller
Acceptance Criteria¶
All criteria run against a mocked Remote Control API.
Stopclicked once, and 30 times: the Event Log has the same height both times; with 30 entries, it scrolls vertically, and the page does not scroll horizontally.Stopclicked, the API answers 503, on a page 320 px wide: the message of the entry wraps, and each of its lines starts at the same distance from the left edge, right of time and severity.Stopclicked 3 times, thenClearclicked: the Event Log shows no entry.Clearclicked, thenStopclicked, the API answers 202: the Event Log shows one entry,INFOwithStop Command accepted.Clearclicked on an empty Event Log: it stays empty.
Decisions¶
- The Event Log has a fixed height and scrolls. The Status Pane will hold telemetry and later a camera stream; a growing Event Log would push them out of sight. Consequence: older entries are reached by scrolling the Event Log, not the page.
Clearacts at once, without confirmation. Losing entries costs nothing that the Robot Operator cannot provoke again; a confirmation would slow down every debugging round. Consequence: a click by mistake loses the entries shown.