Single capture operations¶
Endpoints that perform one-shot capture or query against a single device. All routes live under the FastAPI service (default localhost API). Use the request and response conventions when constructing payloads.
Choose a telemetry path¶
Downstream SNMP telemetry¶
Poll DOCSIS 3.0/3.1 downstream metrics directly from the cable modem via SNMP-backed endpoints.
| Reference | Purpose |
|---|---|
| OFDM channel statistics | Snapshot OFDM physical channel KPIs. |
| OFDM profile statistics | Codeword stats per OFDM profile. |
| SC-QAM channel statistics | SC-QAM downstream power/SNR stats. |
| SC-QAM CW error rate | Codeword error counters. |
Upstream SNMP telemetry¶
| Reference | Purpose |
|---|---|
| OFDMA channel statistics | OFDMA upstream channel KPIs. |
| ATDMA pre-equalization | Tap coefficients and equalizer status. |
| ATDMA channel statistics | ATDMA upstream power/SNR stats. |
FDD / FDX diplexer info¶
| Reference | Purpose |
|---|---|
| Diplexer band-edge capability | Supported diplexer range. |
| Diplexer configuration (system) | System-level diplexer settings. |
Cable modem utilities¶
| Reference | Purpose |
|---|---|
| Diplexer configuration | Device-level diplexer settings. |
| DOCSIS base configuration | Full DOCSIS configuration snapshot. |
| Event log | Retrieve the CM event log. |
| Reset cable modem | Invoke a remote reset. |
| System description | SNMP sysDescr. |
| System uptime | SNMP sysUpTime. |
| Interface statistics | Interface-level counters. |
Proactive network maintenance (PNM)¶
Downstream captures¶
| Reference | Purpose |
|---|---|
| OFDM RxMER | Raw RxMER, summaries, plots. |
| OFDM MER margin | MER margin helpers. |
| OFDM channel estimation | Echo/distortion analysis. |
| OFDM constellation display | Symbol visualization. |
| OFDM FEC summary | Forward error correction stats. |
| OFDM modulation profile | Bit loading and usage. |
| Histogram | Power-level histogram. |
Upstream captures¶
| Reference | Purpose |
|---|---|
| OFDMA pre-equalization | Upstream tap coefficients. |
Spectrum analysis¶
| Reference | Purpose |
|---|---|
| Spectrum analyzer endpoints | Capture downstream spectrum snapshots (SC-QAM and OFDM options within). |
| Spectrum analyzer RBW permutations | Reference RBW auto-scale outcomes for common and edge-case spans. |