Files
MeshTerm/meshterm/tools/advert.py
T
Jean-Pierre MartineauandClaude Fable 5 920b3f8b83 Promote Send advert to the main menu as its own tool
Announcing the node is the everyday operation in the Device actions
bucket, but it sat two screens deep and out of reach of the main menu's
type-to-filter. Give it a top-level entry (order 10, right after Device
actions; Device info shifts to 11) via a new menu-only tool that reuses
the existing advert flow through a standalone send_advert() entry point.
Only SELF_INFO is read on open — the advert op and contact card never
need the full snapshot — so it stays snappy over Bluetooth. The row
inside Device actions stays, and scripting remains under `config
advert` / `config share`, so no new CLI subcommand.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
2026-07-10 01:27:41 -04:00

71 lines
2.5 KiB
Python

"""The ``advert`` tool: announce this node to the mesh, straight from the main menu.
Opens the Send advert flow (see :func:`meshterm.ui.config_editor.send_advert`) — a
zero-hop or flood advertisement, or this node's shareable contact card as a QR code.
The same flow also lives inside the Device actions screen; it gets its own menu entry
because sending an advert is the everyday operation in that bucket, promoted to the top
level so it sits one keystroke (and one type-to-filter match) away instead of two
screens deep.
Menu-only: the scripted equivalents are ``config advert`` and ``config share``, so no
duplicate subcommand is registered here (the same pattern as ``device-actions``).
"""
from __future__ import annotations
from typing import Any, Optional
import typer
from ..context import AppContext
from .base import Tool, ToolResult, register
@register
class SendAdvertTool(Tool):
"""Send a zero-hop or flood advert, or share this node's contact card."""
name = "advert"
title = "Send advert"
help = "Announce this node to the mesh — zero-hop, flood, or share as QR"
category = "Device"
order = 10 # right after Device actions, before Device info
async def prompt_params(self, ctx: AppContext) -> Optional[dict[str, Any]]:
"""Run the interactive advert flow; there are never parameters to collect.
The flow presents its own result (the sent-advert note or the contact-card
view) before returning, so by the time the user backs out there is nothing
left for :meth:`run` to do — returning ``None`` tells the menu the invocation
is complete (the same pattern as the Device actions screen).
Args:
ctx: Shared application context.
Returns:
Always ``None``.
"""
from ..ui.config_editor import send_advert
await send_advert(ctx)
return None
async def run(self, ctx: AppContext, params: dict[str, Any]) -> ToolResult:
"""Nothing runs here: the advert is sent 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 — ``config advert`` / ``config share`` cover scripting.
Args:
app: The Typer application (untouched).
"""