Skip to content

User Guide

Overview

This repository provides Postman local-mode artifacts and visualizer examples for PyPNM API workflows.

Required Postman version: Postman Desktop v12+ (local YAML collection support).

Main artifacts:

  • postman/collections/PyPNM/**.request.yaml
  • postman/collections/PyPNM-CMTS/**.request.yaml
  • postman/environments/PyPNM Remote Server.environment.yaml
  • postman/globals/workspace.globals.yaml

Install Postman

  1. Follow docs/postman-install.md for Ubuntu/Windows install steps
  2. Install and open Postman

Clone Repository

git clone https://github.com/PyPNMApps/Postman-PyPNMApps-API.git
cd Postman-PyPNMApps-API

Load Postman Assets

Follow docs/postman-import-and-navigation.md for:

  • opening local-mode YAML collections/environment/globals
  • configuring pypnm_url
  • navigating the PyPNM collection and first request

Configure URL and Variables

Minimum variables commonly needed:

  • pypnm_url
  • cm_ip_address
  • cm_mac_address
  • cm_snmp_community_rw or snmp_v2_community_rw

Additional workflow variables often needed:

  • tftp_server_ipv4
  • tftp_server_ipv6
  • channel_ids
  • measurement_duration
  • multi_measurement_duration
  • op_id
  • transaction_id
  • filename
  • operation_id
  • mac_address
  • analysis_min_avg_max

First Request

Health check:

  1. Open PyPNM -> Health -> Health
  2. Set pypnm_url
  3. Click Send

Then try a single-capture request such as Ofdm-RxMER-GetCapture.

Visualizer Notes

The visual HTML templates in visual/ are example visualizers for Postman Visualizer usage.

  • Example MAC and system_description values are sanitized to generic placeholders.
  • See docs/tools.md for the sanitize tool that enforces this.

MultiCapture RxMER Echo Detection 1

For visual/PyPNM/MultiCapture/RxMER/Ofdm-RxMER-Analysis-Echo-Detection-1.html:

  • Top chart shows all channels aligned by frequency using rxmer.avg.
  • Each channel card shows one RxMER Avg graph.
  • Echo details are shown in an echo table directly under each channel graph.
  • Echo status may show Echo Detected, Standing Wave Likely, or No Echo Detected.