Skip to content

getting-started.md

Latest commit

 

History

History
68 lines (47 loc) · 1.8 KB

getting-started.md

File metadata and controls

68 lines (47 loc) · 1.8 KB

Getting Started

1. Install and bootstrap

From the repo root:

./install.sh

Details:

2. Configure API endpoint

Edit .env if your PyPNM API is not local default:

VITE_PYPNM_API_BASE_URL=http://127.0.0.1:8080
VITE_REQUEST_TIMEOUT_MS=30000

Runtime instance selection details:

To edit agent entries and per-agent request defaults interactively:

pypnm-webui config-menu

That writes the active local override file:

  • public/config/pypnm-instances.local.yaml

3. Start the UI

pypnm-webui serve

Open:

  • http://127.0.0.1:4173

4. First checks

  • Use the top-bar PyPNM Agent dropdown to confirm the active instance from the runtime YAML config.
  • Open Health page and verify backend connectivity.
  • Open Single Capture and confirm the PNM capture pages are using the selected instance defaults.
  • Confirm the Capture Inputs chip turns green when the current MAC, IP, and SNMP community can be verified through /system/sysDescr.
  • Confirm the execution button stays grayed out until that chip reports Online.
  • Open About and confirm the loaded WebUI version.

5. Common first workflows

  • Single Capture for one-shot PNM capture flows such as RxMER, histogram, FEC summary, modulation profile, and OFDMA pre-equalization
  • Advanced -> RxMER, Channel Estimation, or OFDMA PreEq for stateful multi-capture, polling, stop, results ZIP, and reusable analysis
  • PNM -> Spectrum Analyzer for friendly, full-band, OFDM, and SCQAM capture flows
  • Files for stored capture search, hexdump, JSON inspection, and file analysis

Request forms validate common network fields before submit:

  • MAC Address
  • IP Address
  • TFTP IPv4
  • TFTP IPv6