weaklink-modem 0.7.2__tar.gz → 0.7.4__tar.gz

{weaklink_modem-0.7.2 → weaklink_modem-0.7.4}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.1
 Name: weaklink-modem
-Version: 0.7.2
-Summary: N-FSK streaming modem for HF SSB and wider channels: Reed-Solomon framing, soft Viterbi, round-robin block repetition, byte-pipe semantics.
+Version: 0.7.4
+Summary: MFSK streaming modem for HF SSB and wider channels: Reed-Solomon framing, soft Viterbi, round-robin block repetition, byte-pipe semantics.
 License: MIT
 Author: ivica3730k
 Requires-Python: >=3.10,<4.0
@@ -27,7 +27,7 @@ Project-URL: Homepage, https://github.com/ivica3730k/weaklink-9a3ice
 Project-URL: Repository, https://github.com/ivica3730k/weaklink-9a3ice
 Description-Content-Type: text/markdown
 
-<!-- generated from README.md at tag v0.7.2 by scripts/build_pypi_readme.py; do not hand-edit -->
+<!-- generated from README.md at tag v0.7.4 by scripts/build_pypi_readme.py; do not hand-edit -->
 
 # weaklink
 
@@ -37,7 +37,7 @@ with `tail -f`; no memory buffering, no wait-for-EOF. RS + convolutional
 soft-LLR combining. Modes: **OOK (1-tone)** through **16-FSK**, at
 **45 / 300 / 1200 baud**.
 
-![alt text](https://github.com/ivica3730k/weaklink-9a3ice/raw/v0.7.2/image.png)
+![alt text](https://github.com/ivica3730k/weaklink-9a3ice/raw/v0.7.4/image.png)
 
 Distribution: `weaklink-modem` (PyPI + release binaries).
 
@@ -121,7 +121,7 @@ cross-baud comparison convention, not a physical channel filter.
 
 Doubling `--modem-block-repeats` buys ~2–3 dB via soft-LLR combining
 at proportional air time. Full sweep of every combo we test is in
-[`results.md`](https://github.com/ivica3730k/weaklink-9a3ice/blob/v0.7.2/results.md).
+[`results.md`](https://github.com/ivica3730k/weaklink-9a3ice/blob/v0.7.4/results.md).
 
 ### OOK / 1-tone mode
 
@@ -131,52 +131,21 @@ bandwidth of any mode (no tone stack — just the carrier and its
 modulation sidelobes). Same 1 bit/symbol as 2-FSK but a few dB worse
 in AWGN — the trade you make for the narrow spectrum. Cliff at
 45 baud with `block_repeats=4`: ≈ −14 dB, matching 4-FSK at the same
-settings. See [`results.md`](https://github.com/ivica3730k/weaklink-9a3ice/blob/v0.7.2/results.md) for the per-baud numbers.
+settings. See [`results.md`](https://github.com/ivica3730k/weaklink-9a3ice/blob/v0.7.4/results.md) for the per-baud numbers.
 
-### One tone at a time (constant envelope, any N)
+### One tone at a time (constant envelope, any M)
 
 Every mode in this modem is **single-tone-at-a-time CPFSK**.
 `--modem-num-tones 16` means "16 possible frequencies to pick from
 per symbol", **not** "16 frequencies playing simultaneously". The
 transmitter emits exactly one sinusoid at any instant, hopping between
 frequencies at the symbol clock. Constant envelope (PAPR = 3 dB, the
-peak-to-RMS of a pure sine) regardless of N.
-
-Time-frequency view of a 4-FSK burst — each column is one symbol,
-each row is one of the 4 available frequencies:
-
-```
-freq
- ↑
- F₃ │  .  ▓  .  .  .  ▓  .  .
- F₂ │  .  .  .  ▓  .  .  .  .
- F₁ │  ▓  .  .  .  .  .  ▓  .
- F₀ │  .  .  ▓  .  ▓  .  .  ▓
-    └────────────────────────→ time
-      s₀ s₁ s₂ s₃ s₄ s₅ s₆ s₇
-
-Exactly one ▓ per column: at any instant, one tone at full amplitude.
-Over 8 symbols the modem has visited all 4 slots (that's what you see
-on an SDR waterfall over time), but never more than one at once.
-```
-
-vs. what parallel multi-tone (OFDM-style; **not** this modem) would do:
-
-```
-freq
- ↑
- F₃ │  ▓  .  ▓  ▓  .  ▓  .  ▓
- F₂ │  .  ▓  ▓  .  ▓  .  ▓  ▓   Multiple ▓ per column: N tones
- F₁ │  ▓  ▓  .  ▓  .  ▓  ▓  .   summed at each instant. PAPR grows
- F₀ │  ▓  .  ▓  .  ▓  ▓  .  ▓   with N (~10·log₁₀(N)).
-    └────────────────────────→ time
-      s₀ s₁ s₂ s₃ s₄ s₅ s₆ s₇
-```
+peak-to-RMS of a pure sine) regardless of M.
 
 Why single-tone:
 
 - **All transmit power in one tone at a time** — maximum per-symbol SNR, no `1/N` power split across a stack.
-- **Higher N buys log₂(N) bits/symbol** (more throughput) without any PAPR cost. 16-FSK carries 4× the bits of 2-FSK at the same baud, same peak power.
+- **Higher M buys log₂(M) bits/symbol** (more throughput) without any PAPR cost. 16-FSK carries 4× the bits of 2-FSK at the same baud, same peak power.
 
 On an SDR waterfall you'll see all N frequency slots "lit up" during a long transmission — that's the display integrating over time, showing every slot the modem visited. Zoom the FFT window below one symbol duration (~3.3 ms at 300 baud) and you'll see the transmitter chasing one tone across the slots instead.
 
@@ -197,7 +166,7 @@ On an SDR waterfall you'll see all N frequency slots "lit up" during a long tran
 ## Full SNR sweep
 
 Every baud × num_tones × RS × repeats combo is measured in
-[`results.md`](https://github.com/ivica3730k/weaklink-9a3ice/blob/v0.7.2/results.md). Re-run `poetry run weaklink-modem-benchmark` to
+[`results.md`](https://github.com/ivica3730k/weaklink-9a3ice/blob/v0.7.4/results.md). Re-run `poetry run weaklink-modem-benchmark` to
 refresh.
 
 ---
@@ -219,7 +188,7 @@ refresh.
 | Flag | Default | Description |
 |------|---------|-------------|
 | `--modem-baud N` | `300` | Symbol rate. Only `45`, `300`, `1200` supported. |
-| `--modem-num-tones N` | `4` | N-FSK order: 2 / 4 / 8 / 16. Higher packs more bits per symbol at wider bandwidth and worse cliff. 2 halves throughput but fits narrow audio paths (e.g. FM voice via SignaLink). TX and RX must match. |
+| `--modem-num-tones N` | `4` | MFSK order: 2 / 4 / 8 / 16. Higher packs more bits per symbol at wider bandwidth and worse cliff. 2 halves throughput but fits narrow audio paths (e.g. FM voice via SignaLink). TX and RX must match. |
 | `--modem-rs-data-bytes N` | preset | Reed-Solomon data bytes per block. |
 | `--modem-rs-parity-bytes N` | preset | RS parity bytes. Corrects up to N/2 byte errors per block. |
 | `--modem-no-rs-crc` | CRC on | Skip the CRC-32 inside each RS block. |
@@ -283,7 +252,7 @@ One tx session (live audio):
   │ pilot  │ pre │ slot 0 │ pre │ slot 1 │ pre │ ... │slot N-1│ pre │ pilot  │
   └────────┴─────┴────────┴─────┴────────┴─────┴─────┴────────┴─────┴────────┘
 
-One RS block, data area (before conv + interleave + FSK):
+One RS block, data area (before conv + interleave + MFSK):
 
   ┌── 1B ──┬── 2B ────┬──── rs_data − 3 B ────┬── 4B CRC ──┬── rs_parity B ──┐
   │ length │block_idx │ payload (zero-padded) │  CRC-32    │  RS parity      │
@@ -307,10 +276,11 @@ through the same `_StreamingRxPump` the CLI uses.
 
 ## Glossary
 
-- **N-FSK / CPFSK** — Continuous-phase FSK with an **N-value alphabet**: N possible tone frequencies, exactly one on the air at any instant (never a stack). Each symbol picks one → log₂(N) bits/symbol. Default N=4.
+- **MFSK** — M-ary Frequency Shift Keying. M possible tone frequencies; each symbol picks one and emits it → log₂(M) bits/symbol. Exactly one tone on the air at any instant (never a stack). Default M=4.
+- **CPFSK** — Continuous-Phase FSK. Frequency changes between symbols with no phase discontinuity, so the envelope stays clean at symbol boundaries. This modem's MFSK is CPFSK.
 - **Single-tone-at-a-time** — The whole family from OOK through 16-FSK emits at most one sinusoid at any instant. Envelope stays constant (PAPR = 3 dB, same as a pure sine) regardless of `--modem-num-tones`.
 - **OOK** — On-off keying. `num_tones=1` mode: single carrier, symbol 0 = silence, symbol 1 = tone. 1 bit/symbol like 2-FSK but at the narrowest possible bandwidth (only the carrier + modulation sidelobes). Pays a few dB vs 2-FSK in AWGN.
-- **PAPR** — Peak-to-average power ratio. 0 dB = pure DC; 3 dB = pure sine; ~10·log₁₀(N) dB = N tones summed with random phases. This modem stays at 3 dB.
+- **PAPR** — Peak-to-average power ratio. 0 dB = pure DC; 3 dB = pure sine; ~10·log₁₀(M) dB = M tones summed with random phases. This modem stays at 3 dB.
 - **Preamble** — Fixed 32-symbol PN sequence bracketing every slot; RX locks timing / frequency / amplitude from it.
 - **Slot** — Preamble + one RS-encoded block.
 - **Block** — RS-encoded chunk carrying header + payload.
@@ -321,12 +291,12 @@ through the same `_StreamingRxPump` the CLI uses.
 - **Interleaver** — Bit shuffle so bursts become isolated errors. Ours changes every block (32-permutation cycle).
 - **Non-coherent demod** — Tone detection by energy; ~3 dB behind coherent.
 - **LO offset** — Radio frequency error; we correct up to ±500 Hz.
-- **Pilot** — Short random N-FSK burst before / after every live TX.
+- **Pilot** — Short random MFSK burst before / after every live TX.
 - **SNR (dB)** — Signal-to-noise ratio. Negative = noise louder than signal.
 - **AWGN** — Additive white Gaussian noise; the standard clean-channel noise model used by the benchmark.
 - **Shannon limit** — Theoretical lowest SNR at which a given data rate can be decoded error-free. Every FEC decoder sits some dB above it — that gap is what "Gap" columns report.
 - **Best SNR / cliff** — Lowest SNR at which decode still works for a given config. Below it, everything breaks.
-- **Nyquist theorem** — A signal is only recoverable if sampled above twice its highest frequency. In practice: tones must sit below sample_rate/2, and N-FSK tone spacing must be at least `1/T_symbol` for non-coherent orthogonality.
+- **Nyquist theorem** — A signal is only recoverable if sampled above twice its highest frequency. In practice: tones must sit below sample_rate/2, and MFSK tone spacing must be at least `1/T_symbol` for non-coherent orthogonality.
 
 ---
 

{weaklink_modem-0.7.2 → weaklink_modem-0.7.4}/pyproject.toml

@@ -1,7 +1,7 @@
 [tool.poetry]
 name = "weaklink-modem"
-version = "0.7.2"
-description = "N-FSK streaming modem for HF SSB and wider channels: Reed-Solomon framing, soft Viterbi, round-robin block repetition, byte-pipe semantics."
+version = "0.7.4"
+description = "MFSK streaming modem for HF SSB and wider channels: Reed-Solomon framing, soft Viterbi, round-robin block repetition, byte-pipe semantics."
 authors = ["ivica3730k"]
 license = "MIT"
 readme = "readme-pypi.md"

{weaklink_modem-0.7.2 → weaklink_modem-0.7.4}/readme-pypi.md

@@ -1,4 +1,4 @@
-<!-- generated from README.md at tag v0.7.2 by scripts/build_pypi_readme.py; do not hand-edit -->
+<!-- generated from README.md at tag v0.7.4 by scripts/build_pypi_readme.py; do not hand-edit -->
 
 # weaklink
 
@@ -8,7 +8,7 @@ with `tail -f`; no memory buffering, no wait-for-EOF. RS + convolutional
 soft-LLR combining. Modes: **OOK (1-tone)** through **16-FSK**, at
 **45 / 300 / 1200 baud**.
 
-![alt text](https://github.com/ivica3730k/weaklink-9a3ice/raw/v0.7.2/image.png)
+![alt text](https://github.com/ivica3730k/weaklink-9a3ice/raw/v0.7.4/image.png)
 
 Distribution: `weaklink-modem` (PyPI + release binaries).
 
@@ -92,7 +92,7 @@ cross-baud comparison convention, not a physical channel filter.
 
 Doubling `--modem-block-repeats` buys ~2–3 dB via soft-LLR combining
 at proportional air time. Full sweep of every combo we test is in
-[`results.md`](https://github.com/ivica3730k/weaklink-9a3ice/blob/v0.7.2/results.md).
+[`results.md`](https://github.com/ivica3730k/weaklink-9a3ice/blob/v0.7.4/results.md).
 
 ### OOK / 1-tone mode
 
@@ -102,52 +102,21 @@ bandwidth of any mode (no tone stack — just the carrier and its
 modulation sidelobes). Same 1 bit/symbol as 2-FSK but a few dB worse
 in AWGN — the trade you make for the narrow spectrum. Cliff at
 45 baud with `block_repeats=4`: ≈ −14 dB, matching 4-FSK at the same
-settings. See [`results.md`](https://github.com/ivica3730k/weaklink-9a3ice/blob/v0.7.2/results.md) for the per-baud numbers.
+settings. See [`results.md`](https://github.com/ivica3730k/weaklink-9a3ice/blob/v0.7.4/results.md) for the per-baud numbers.
 
-### One tone at a time (constant envelope, any N)
+### One tone at a time (constant envelope, any M)
 
 Every mode in this modem is **single-tone-at-a-time CPFSK**.
 `--modem-num-tones 16` means "16 possible frequencies to pick from
 per symbol", **not** "16 frequencies playing simultaneously". The
 transmitter emits exactly one sinusoid at any instant, hopping between
 frequencies at the symbol clock. Constant envelope (PAPR = 3 dB, the
-peak-to-RMS of a pure sine) regardless of N.
-
-Time-frequency view of a 4-FSK burst — each column is one symbol,
-each row is one of the 4 available frequencies:
-
-```
-freq
- ↑
- F₃ │  .  ▓  .  .  .  ▓  .  .
- F₂ │  .  .  .  ▓  .  .  .  .
- F₁ │  ▓  .  .  .  .  .  ▓  .
- F₀ │  .  .  ▓  .  ▓  .  .  ▓
-    └────────────────────────→ time
-      s₀ s₁ s₂ s₃ s₄ s₅ s₆ s₇
-
-Exactly one ▓ per column: at any instant, one tone at full amplitude.
-Over 8 symbols the modem has visited all 4 slots (that's what you see
-on an SDR waterfall over time), but never more than one at once.
-```
-
-vs. what parallel multi-tone (OFDM-style; **not** this modem) would do:
-
-```
-freq
- ↑
- F₃ │  ▓  .  ▓  ▓  .  ▓  .  ▓
- F₂ │  .  ▓  ▓  .  ▓  .  ▓  ▓   Multiple ▓ per column: N tones
- F₁ │  ▓  ▓  .  ▓  .  ▓  ▓  .   summed at each instant. PAPR grows
- F₀ │  ▓  .  ▓  .  ▓  ▓  .  ▓   with N (~10·log₁₀(N)).
-    └────────────────────────→ time
-      s₀ s₁ s₂ s₃ s₄ s₅ s₆ s₇
-```
+peak-to-RMS of a pure sine) regardless of M.
 
 Why single-tone:
 
 - **All transmit power in one tone at a time** — maximum per-symbol SNR, no `1/N` power split across a stack.
-- **Higher N buys log₂(N) bits/symbol** (more throughput) without any PAPR cost. 16-FSK carries 4× the bits of 2-FSK at the same baud, same peak power.
+- **Higher M buys log₂(M) bits/symbol** (more throughput) without any PAPR cost. 16-FSK carries 4× the bits of 2-FSK at the same baud, same peak power.
 
 On an SDR waterfall you'll see all N frequency slots "lit up" during a long transmission — that's the display integrating over time, showing every slot the modem visited. Zoom the FFT window below one symbol duration (~3.3 ms at 300 baud) and you'll see the transmitter chasing one tone across the slots instead.
 
@@ -168,7 +137,7 @@ On an SDR waterfall you'll see all N frequency slots "lit up" during a long tran
 ## Full SNR sweep
 
 Every baud × num_tones × RS × repeats combo is measured in
-[`results.md`](https://github.com/ivica3730k/weaklink-9a3ice/blob/v0.7.2/results.md). Re-run `poetry run weaklink-modem-benchmark` to
+[`results.md`](https://github.com/ivica3730k/weaklink-9a3ice/blob/v0.7.4/results.md). Re-run `poetry run weaklink-modem-benchmark` to
 refresh.
 
 ---
@@ -190,7 +159,7 @@ refresh.
 | Flag | Default | Description |
 |------|---------|-------------|
 | `--modem-baud N` | `300` | Symbol rate. Only `45`, `300`, `1200` supported. |
-| `--modem-num-tones N` | `4` | N-FSK order: 2 / 4 / 8 / 16. Higher packs more bits per symbol at wider bandwidth and worse cliff. 2 halves throughput but fits narrow audio paths (e.g. FM voice via SignaLink). TX and RX must match. |
+| `--modem-num-tones N` | `4` | MFSK order: 2 / 4 / 8 / 16. Higher packs more bits per symbol at wider bandwidth and worse cliff. 2 halves throughput but fits narrow audio paths (e.g. FM voice via SignaLink). TX and RX must match. |
 | `--modem-rs-data-bytes N` | preset | Reed-Solomon data bytes per block. |
 | `--modem-rs-parity-bytes N` | preset | RS parity bytes. Corrects up to N/2 byte errors per block. |
 | `--modem-no-rs-crc` | CRC on | Skip the CRC-32 inside each RS block. |
@@ -254,7 +223,7 @@ One tx session (live audio):
   │ pilot  │ pre │ slot 0 │ pre │ slot 1 │ pre │ ... │slot N-1│ pre │ pilot  │
   └────────┴─────┴────────┴─────┴────────┴─────┴─────┴────────┴─────┴────────┘
 
-One RS block, data area (before conv + interleave + FSK):
+One RS block, data area (before conv + interleave + MFSK):
 
   ┌── 1B ──┬── 2B ────┬──── rs_data − 3 B ────┬── 4B CRC ──┬── rs_parity B ──┐
   │ length │block_idx │ payload (zero-padded) │  CRC-32    │  RS parity      │
@@ -278,10 +247,11 @@ through the same `_StreamingRxPump` the CLI uses.
 
 ## Glossary
 
-- **N-FSK / CPFSK** — Continuous-phase FSK with an **N-value alphabet**: N possible tone frequencies, exactly one on the air at any instant (never a stack). Each symbol picks one → log₂(N) bits/symbol. Default N=4.
+- **MFSK** — M-ary Frequency Shift Keying. M possible tone frequencies; each symbol picks one and emits it → log₂(M) bits/symbol. Exactly one tone on the air at any instant (never a stack). Default M=4.
+- **CPFSK** — Continuous-Phase FSK. Frequency changes between symbols with no phase discontinuity, so the envelope stays clean at symbol boundaries. This modem's MFSK is CPFSK.
 - **Single-tone-at-a-time** — The whole family from OOK through 16-FSK emits at most one sinusoid at any instant. Envelope stays constant (PAPR = 3 dB, same as a pure sine) regardless of `--modem-num-tones`.
 - **OOK** — On-off keying. `num_tones=1` mode: single carrier, symbol 0 = silence, symbol 1 = tone. 1 bit/symbol like 2-FSK but at the narrowest possible bandwidth (only the carrier + modulation sidelobes). Pays a few dB vs 2-FSK in AWGN.
-- **PAPR** — Peak-to-average power ratio. 0 dB = pure DC; 3 dB = pure sine; ~10·log₁₀(N) dB = N tones summed with random phases. This modem stays at 3 dB.
+- **PAPR** — Peak-to-average power ratio. 0 dB = pure DC; 3 dB = pure sine; ~10·log₁₀(M) dB = M tones summed with random phases. This modem stays at 3 dB.
 - **Preamble** — Fixed 32-symbol PN sequence bracketing every slot; RX locks timing / frequency / amplitude from it.
 - **Slot** — Preamble + one RS-encoded block.
 - **Block** — RS-encoded chunk carrying header + payload.
@@ -292,12 +262,12 @@ through the same `_StreamingRxPump` the CLI uses.
 - **Interleaver** — Bit shuffle so bursts become isolated errors. Ours changes every block (32-permutation cycle).
 - **Non-coherent demod** — Tone detection by energy; ~3 dB behind coherent.
 - **LO offset** — Radio frequency error; we correct up to ±500 Hz.
-- **Pilot** — Short random N-FSK burst before / after every live TX.
+- **Pilot** — Short random MFSK burst before / after every live TX.
 - **SNR (dB)** — Signal-to-noise ratio. Negative = noise louder than signal.
 - **AWGN** — Additive white Gaussian noise; the standard clean-channel noise model used by the benchmark.
 - **Shannon limit** — Theoretical lowest SNR at which a given data rate can be decoded error-free. Every FEC decoder sits some dB above it — that gap is what "Gap" columns report.
 - **Best SNR / cliff** — Lowest SNR at which decode still works for a given config. Below it, everything breaks.
-- **Nyquist theorem** — A signal is only recoverable if sampled above twice its highest frequency. In practice: tones must sit below sample_rate/2, and N-FSK tone spacing must be at least `1/T_symbol` for non-coherent orthogonality.
+- **Nyquist theorem** — A signal is only recoverable if sampled above twice its highest frequency. In practice: tones must sit below sample_rate/2, and MFSK tone spacing must be at least `1/T_symbol` for non-coherent orthogonality.
 
 ---
 

{weaklink_modem-0.7.2 → weaklink_modem-0.7.4}/src/weaklink/modem/__init__.py

@@ -1,4 +1,4 @@
-"""Weaklink modem: N-FSK + convolutional FEC + soft Viterbi, audio I/O."""
+"""Weaklink modem: MFSK + convolutional FEC + soft Viterbi, audio I/O."""
 
 from weaklink.modem.api import ModemOptions, build_config, rx, tx
 from weaklink.modem.codec import ModemConfig

{weaklink_modem-0.7.2 → weaklink_modem-0.7.4}/src/weaklink/modem/benchmark.py

@@ -119,7 +119,7 @@ def _find_cliff(config: Config, *, trials: int, payload: bytes) -> Result:
     shannon = shannon_snr_db(info_rate)
 
     cliff: float | None = None
-    # OOK's cliff sits ~10 dB higher than N-FSK, so the sweep needs a
+    # OOK's cliff sits ~10 dB higher than MFSK, so the sweep needs a
     # higher starting SNR to see it. Everything else still starts at
     # +10 dB, matching the previous behaviour.
     snr_db = 25.0 if config.num_tones == 1 else 10.0

{weaklink_modem-0.7.2 → weaklink_modem-0.7.4}/src/weaklink/modem/cli.py

@@ -64,7 +64,7 @@ def _add_modem_args(sub: argparse.ArgumentParser) -> None:
         default=None,
         dest="modem_num_tones",
         choices=(1, 2, 4, 8, 16),
-        help="Number of FSK tones. 4 (default) is standard; 8/16 pack "
+        help="Number of MFSK tones. 4 (default) is standard; 8/16 pack "
         "more bits per symbol at wider bandwidth and worse cliff. 2 "
         "halves throughput but fits narrow audio paths. 1 selects OOK "
         "(single carrier, on/off keying) -- narrowest bandwidth of any "
@@ -128,7 +128,7 @@ def _build_parser() -> argparse.ArgumentParser:
     except PackageNotFoundError:
         version = "unknown"
 
-    parser = argparse.ArgumentParser(prog="weaklink-modem", description="Streaming N-FSK modem.")
+    parser = argparse.ArgumentParser(prog="weaklink-modem", description="Streaming MFSK modem.")
     parser.add_argument("--version", action="version", version=f"weaklink-modem {version}")
     subparsers = parser.add_subparsers(dest="direction", required=True)
     tx_parser = subparsers.add_parser("tx", help="Encode stdin bytes and transmit (or write to WAV).")

{weaklink_modem-0.7.2 → weaklink_modem-0.7.4}/src/weaklink/modem/codec.py

@@ -111,7 +111,7 @@ def _preamble_deterministic_sidelobe(num_tones: int) -> float:
                 max_score = max(max_score, abs(numerator / denominator))
         return max_score
 
-    # N-FSK correlator: score = (M * wanted - total) / ((M-1) * total).
+    # MFSK correlator: score = (M * wanted - total) / ((M-1) * total).
     for shift in range(1, length):
         magnitudes = np.zeros((length, num_tones), dtype=np.float64)
         # Positions inside the overlap carry the shifted preamble's tone.
@@ -820,7 +820,7 @@ def _find_preamble_peaks(
         mag_col = magnitudes[:, 0]
         raw = np.correlate(mag_col, tone_mask, mode="valid") - np.correlate(mag_col, silence_mask, mode="valid")
     else:
-        # N-FSK: for each tone k, mask marks where the preamble expects
+        # MFSK: for each tone k, mask marks where the preamble expects
         # that tone; sum the wanted energy across all N tones.
         wanted = np.zeros(max_offset + 1, dtype=np.float64)
         for tone in range(num_tones):
@@ -846,7 +846,7 @@ def _find_preamble_peaks(
         cutoff = float(np.quantile(abs_scores, 0.75))
         noise_pool = scores[abs_scores <= cutoff]
     else:
-        # N-FSK noise floor: bottom (2/M) of scores (adaptive quantile).
+        # MFSK noise floor: bottom (2/M) of scores (adaptive quantile).
         # At M=2 sidelobes fill the lower half, so we go lower (Q0.25).
         # At higher M sidelobes are tighter and the lower half is fine.
         q = max(0.25, 1.0 - 2.0 / num_tones)

{weaklink_modem-0.7.2 → weaklink_modem-0.7.4}/src/weaklink/modem/constants.py

@@ -24,7 +24,7 @@ BAUD_PRESETS: dict[float, dict[str, float]] = {
 
 #: Pilot padding on each side of live-tx: brings the audio sink out
 #: of its IDLE state (~50 ms of wake-up latency) and gives the
-#: coarse-offset FFT real N-FSK tone energy to lock onto.
+#: coarse-offset FFT real MFSK tone energy to lock onto.
 LIVE_TX_PILOT_MIN_SECONDS: float = 0.2
 
 #: Pilot must also exceed the preamble in symbol space so back-to-back

{weaklink_modem-0.7.2 → weaklink_modem-0.7.4}/src/weaklink/modem/exceptions.py

@@ -18,7 +18,7 @@ class ConfigError(WeaklinkError):
 
 
 class NyquistError(ConfigError):
-    """N-FSK tone stack won't fit under sample_rate/2, or spacing is
+    """MFSK tone stack won't fit under sample_rate/2, or spacing is
     below the non-coherent orthogonality floor."""
 
 

{weaklink_modem-0.7.2 → weaklink_modem-0.7.4}/src/weaklink/modem/streaming.py

@@ -29,7 +29,7 @@ _log = logging.getLogger("weaklink.streaming")
 
 
 def pilot_signal(config: ModemConfig, duration_seconds: float) -> np.ndarray:
-    """Random N-FSK symbols for ``duration_seconds``. All tones exercised
+    """Random MFSK symbols for ``duration_seconds``. All tones exercised
     uniformly so the coarse-offset FFT locks cleanly."""
     symbols_needed = max(1, int(round(duration_seconds * config.waveform.baud)))
     rng = np.random.default_rng(0xC0DE)

{weaklink_modem-0.7.2 → weaklink_modem-0.7.4}/src/weaklink/modem/waveform.py

@@ -1,4 +1,4 @@
-"""N-FSK CPFSK modulator + non-coherent soft demodulator.
+"""MFSK CPFSK modulator + non-coherent soft demodulator.
 
 Continuous-phase for narrow spectrum, non-coherent I/Q magnitudes (~3 dB
 worse than coherent but no carrier recovery). Gray-coded symbols so
@@ -25,7 +25,7 @@ NUM_TONES = 4
 def _num_symbols(num_tones: int) -> int:
     """Size of the symbol alphabet. For ``num_tones=1`` we run OOK
     (1 frequency, 2 symbols: silence + tone); otherwise symbols and
-    tones are 1:1 as in standard N-FSK."""
+    tones are 1:1 as in standard MFSK."""
     return 2 if num_tones == 1 else num_tones
 
 
@@ -70,7 +70,7 @@ class WaveformConfig:
     amplitude: float = 0.25
     """Peak amplitude, well under 1.0 to leave headroom in WAV / audio devices."""
     num_tones: int = 4
-    """Number of tone frequencies. Standard N-FSK for values in
+    """Number of tone frequencies. Standard MFSK for values in
     {2, 4, 8, 16}: each tone is one symbol. ``num_tones=1`` selects
     OOK -- one carrier, symbol 0 = silence, symbol 1 = tone --
     which trades throughput for the narrowest bandwidth possible."""
@@ -83,7 +83,7 @@ class WaveformConfig:
     def __post_init__(self) -> None:
         if self.num_tones != 1 and (self.num_tones < 2 or (self.num_tones & (self.num_tones - 1)) != 0):
             raise ConfigError(f"num_tones must be 1 or a power of 2 >= 2, got {self.num_tones}")
-        # OOK sits on a single carrier at ``center_hz``; N-FSK spreads
+        # OOK sits on a single carrier at ``center_hz``; MFSK spreads
         # symmetrically around ``center_hz`` at ``tone_spacing_hz``.
         if self.num_tones == 1:
             relative_offsets: tuple[float, ...] = (0.0,)
@@ -114,7 +114,7 @@ class WaveformConfig:
 
     @property
     def num_symbols(self) -> int:
-        """Symbol-alphabet size. Equals ``num_tones`` for standard N-FSK;
+        """Symbol-alphabet size. Equals ``num_tones`` for standard MFSK;
         equals 2 for OOK (``num_tones=1``)."""
         return _num_symbols(self.num_tones)
 
@@ -142,7 +142,7 @@ def symbols_to_bits(symbols: np.ndarray, num_tones: int = NUM_TONES) -> bytes:
 
 
 def modulate(symbols: np.ndarray, config: WaveformConfig) -> np.ndarray:
-    """Vectorised modulator: continuous-phase N-FSK for ``num_tones >= 2``;
+    """Vectorised modulator: continuous-phase MFSK for ``num_tones >= 2``;
     on-off keying for ``num_tones == 1`` (symbol 0 = silence, symbol 1 =
     continuous-phase sine at the carrier)."""
     samples_per_symbol = config.samples_per_symbol
@@ -164,7 +164,7 @@ def modulate(symbols: np.ndarray, config: WaveformConfig) -> np.ndarray:
         gate = symbols_int.astype(np.float64)[:, None]
         return (config.amplitude * gate * carrier).ravel().astype(np.float32)
 
-    # Standard N-FSK: per-symbol frequency + continuous phase.
+    # Standard MFSK: per-symbol frequency + continuous phase.
     omega_per_symbol = 2.0 * np.pi * np.asarray(config.tones_hz, dtype=np.float64)[symbols_int] * dt
     # Phase at the START of each symbol = 0 for i=0, cumsum(omega*sps) shifted for i>=1.
     end_phases = np.cumsum(omega_per_symbol * samples_per_symbol)