Files
MeshTerm/meshterm/tools/dashboard.py
T
Jean-Pierre MartineauandClaude Fable 5 79410c4f16 Live feed: the dashboard's packet stream, promoted to the menu
The feed panel moves out of the dashboard into its own first-class Mesh
tool, right below it: a full-screen newest-first stream with the same
row lanes, highlight walking, and Enter-into-the-packet-viewer, wired
to the hub by its opener exactly as the dashboard is. The dashboard
becomes pure overview — activity, traffic, RF health — scrolling as
one body, and sheds the viewer-only plumbing (prefix bytes, channels,
self name, node types) it only carried for the feed.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
2026-07-19 00:52:45 -04:00

72 lines
2.4 KiB
Python

"""The ``dashboard`` tool: the live mesh overview, at the top of the Mesh section.
Opens the full-screen dashboard (see :mod:`meshterm.ui.dashboard_screen`): the two-hour
all-packet activity chart with its pulse line, the session's traffic tallies by packet
class, and the window's RF health beside the radio's own live numbers. (The per-packet
stream is the Live feed tool, right below.) It leads the Mesh section because it answers
the section's first question — *what's going on out there?* — before any specific tool
is reached for.
Menu-only: the dashboard is inherently live (it rides the event hub and repaints every
second), so there is no scripted one-shot to register — the ``monitor`` and ``nodes``
subcommands cover scripted inspection.
"""
from __future__ import annotations
from typing import Any, Optional
import typer
from ..context import AppContext
from .base import Tool, ToolResult, register
@register
class DashboardTool(Tool):
"""Watch everything going on on the mesh: activity, traffic, RF health."""
name = "dashboard"
title = "Dashboard"
icon = "📊"
help = "Watch the mesh live — activity, traffic, RF health"
category = "Mesh"
order = 5 # the section's overview, above the tools it summarizes
async def prompt_params(self, ctx: AppContext) -> Optional[dict[str, Any]]:
"""Run the live dashboard; there are never parameters to collect.
The screen presents everything itself and returns when dismissed, so
returning ``None`` tells the menu the invocation is complete (the same
pattern as the ``advert`` tool).
Args:
ctx: Shared application context.
Returns:
Always ``None``.
"""
from ..ui.dashboard_screen import open_dashboard
await open_dashboard(ctx)
return None
async def run(self, ctx: AppContext, params: dict[str, Any]) -> ToolResult:
"""Nothing runs here: the dashboard lives inside :meth:`prompt_params`.
Args:
ctx: Shared application context.
params: Unused.
Returns:
An empty :class:`ToolResult` (only reachable from a scripted call).
"""
return ToolResult(summary={})
def register_cli(self, app: typer.Typer) -> None:
"""Register no CLI command — the dashboard is a live, menu-only screen.
Args:
app: The Typer application (untouched).
"""