orion-sdr 0.0.62

Composable SDR/DSP block library targeting HF-to-EHF: analog and single-carrier digital modes, FT8/FT4, PSK31, OFDM/COFDM, and DVB-T/NB-DVB-T, with Python bindings.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239

"""Tests for FT8/FT4 Python bindings (Phase 5).

All tests are noiseless / synthetic — no hardware or RF noise required.
"""

import numpy as np
import pytest

import orion_sdr as sdr

FS = 12_000.0
BASE_HZ = 1_000.0
MAX_HZ  = 1_100.0

# A known-good 10-byte payload (all zeros with slack bits zeroed).
PAYLOAD = bytes(10)


# ---------------------------------------------------------------------------
# Waveform: Ft8Mod / Ft8Demod
# ---------------------------------------------------------------------------

class TestFt8Waveform:
    def test_mod_shape(self):
        mod = sdr.Ft8Mod(FS, BASE_HZ, 0.0, 1.0)
        tones = np.zeros(58, dtype=np.uint8)
        iq = mod.modulate(tones)
        assert iq.shape == (151_680,)
        assert iq.dtype == np.complex64

    def test_demod_roundtrip(self):
        tones_in = np.array([i % 8 for i in range(58)], dtype=np.uint8)
        mod = sdr.Ft8Mod(FS, BASE_HZ, 0.0, 1.0)
        iq = mod.modulate(tones_in)
        demod = sdr.Ft8Demod(FS, BASE_HZ)
        tones_out = demod.demodulate(iq)
        assert tones_out.shape == (58,)
        assert tones_out.dtype == np.uint8
        np.testing.assert_array_equal(tones_out, tones_in)

    def test_mod_wrong_length(self):
        mod = sdr.Ft8Mod(FS, BASE_HZ, 0.0, 1.0)
        with pytest.raises((ValueError, Exception)):
            mod.modulate(np.zeros(57, dtype=np.uint8))

    def test_demod_too_short(self):
        demod = sdr.Ft8Demod(FS, BASE_HZ)
        with pytest.raises((ValueError, Exception)):
            demod.demodulate(np.zeros(1000, dtype=np.complex64))


# ---------------------------------------------------------------------------
# Waveform: Ft4Mod / Ft4Demod
# ---------------------------------------------------------------------------

class TestFt4Waveform:
    def test_mod_shape(self):
        mod = sdr.Ft4Mod(FS, BASE_HZ, 0.0, 1.0)
        tones = np.zeros(87, dtype=np.uint8)
        iq = mod.modulate(tones)
        assert iq.shape == (60_480,)
        assert iq.dtype == np.complex64

    def test_demod_roundtrip(self):
        tones_in = np.array([i % 4 for i in range(87)], dtype=np.uint8)
        mod = sdr.Ft4Mod(FS, BASE_HZ, 0.0, 1.0)
        iq = mod.modulate(tones_in)
        demod = sdr.Ft4Demod(FS, BASE_HZ)
        tones_out = demod.demodulate(iq)
        assert tones_out.shape == (87,)
        assert tones_out.dtype == np.uint8
        np.testing.assert_array_equal(tones_out, tones_in)


# ---------------------------------------------------------------------------
# Codec: Ft8Codec
# ---------------------------------------------------------------------------

class TestFt8Codec:
    def test_encode_shape(self):
        tones = sdr.Ft8Codec.encode(PAYLOAD)
        assert tones.shape == (58,)
        assert tones.dtype == np.uint8
        assert all(0 <= int(t) <= 7 for t in tones)

    def test_roundtrip_hard(self):
        tones = sdr.Ft8Codec.encode(PAYLOAD)
        result = sdr.Ft8Codec.decode_hard(tones)
        assert result is not None
        assert result == PAYLOAD

    def test_decode_hard_bad_tones(self):
        bad_tones = np.zeros(58, dtype=np.uint8)
        # All-zero tones won't pass CRC unless the payload happens to match;
        # result may be None or valid — just check it doesn't crash.
        result = sdr.Ft8Codec.decode_hard(bad_tones)
        assert result is None or isinstance(result, bytes)

    def test_decode_soft_shape_check(self):
        with pytest.raises((ValueError, Exception)):
            sdr.Ft8Codec.decode_soft(np.zeros(10, dtype=np.float32))


# ---------------------------------------------------------------------------
# Codec: Ft4Codec
# ---------------------------------------------------------------------------

class TestFt4Codec:
    def test_encode_shape(self):
        tones = sdr.Ft4Codec.encode(PAYLOAD)
        assert tones.shape == (87,)
        assert tones.dtype == np.uint8
        assert all(0 <= int(t) <= 3 for t in tones)

    def test_roundtrip_hard(self):
        tones = sdr.Ft4Codec.encode(PAYLOAD)
        result = sdr.Ft4Codec.decode_hard(tones)
        assert result is not None
        assert result == PAYLOAD


# ---------------------------------------------------------------------------
# Sync: ft8_sync
# ---------------------------------------------------------------------------

class TestFt8Sync:
    def _make_frame_iq(self, payload=PAYLOAD):
        """Build a noiseless IQ buffer containing one FT8 frame at offset 0."""
        tones = sdr.Ft8Codec.encode(payload)
        mod = sdr.Ft8Mod(FS, BASE_HZ, 0.0, 1.0)
        return mod.modulate(tones)

    def test_finds_frame(self):
        iq = self._make_frame_iq()
        results = sdr.ft8_sync(iq, FS, BASE_HZ - 50.0, BASE_HZ + 100.0, 0, 0, 5)
        assert len(results) > 0
        r = results[0]
        assert "time_sym" in r
        assert "freq_bin" in r
        assert "score" in r
        assert "llr" in r
        assert r["llr"].shape == (174,)
        assert r["llr"].dtype == np.float32

    def test_decode_soft(self):
        iq = self._make_frame_iq()
        results = sdr.ft8_sync(iq, FS, BASE_HZ - 50.0, BASE_HZ + 100.0, 0, 0, 5)
        assert len(results) > 0
        payload_out = sdr.Ft8Codec.decode_soft(results[0]["llr"])
        assert payload_out is not None
        assert payload_out == PAYLOAD

    def test_empty_on_silence(self):
        iq = np.zeros(151_680, dtype=np.complex64)
        results = sdr.ft8_sync(iq, FS, BASE_HZ, BASE_HZ + 100.0, 0, 0, 5)
        # Silence may produce candidates with low scores; just check no crash.
        assert isinstance(results, list)


# ---------------------------------------------------------------------------
# Message packing / unpacking
# ---------------------------------------------------------------------------

class TestFt8Message:
    def test_pack_unpack_standard(self):
        payload = sdr.ft8_pack_standard("KD9ABC", "W9XYZ", "FN31")
        assert isinstance(payload, bytes)
        assert len(payload) == 10
        msg = sdr.ft8_unpack(payload)
        assert msg["type"] == "standard"
        assert msg["call_to"] == "KD9ABC"
        assert msg["call_de"] == "W9XYZ"
        assert msg["extra"] == "FN31"

    def test_pack_unpack_free_text(self):
        payload = sdr.ft8_pack_free_text("CQ DX")
        assert isinstance(payload, bytes)
        assert len(payload) == 10
        msg = sdr.ft8_unpack(payload)
        assert msg["type"] == "free_text"
        assert msg["text"] == "CQ DX"

    def test_pack_unpack_telemetry(self):
        data = bytes([0x12, 0x34, 0x56, 0x78, 0x9A, 0xBC, 0xDE, 0xF0, 0x11])
        payload = sdr.ft8_pack_telemetry(data)
        assert isinstance(payload, bytes)
        assert len(payload) == 10
        msg = sdr.ft8_unpack(payload)
        assert msg["type"] == "telemetry"
        assert msg["data"] == data

    def test_pack_standard_cq(self):
        payload = sdr.ft8_pack_standard("CQ", "W9XYZ", "+07")
        assert isinstance(payload, bytes)
        assert len(payload) == 10

    def test_unpack_wrong_length(self):
        with pytest.raises((ValueError, Exception)):
            sdr.ft8_unpack(bytes(5))

    def test_pack_telemetry_wrong_length(self):
        with pytest.raises((ValueError, Exception)):
            sdr.ft8_pack_telemetry(bytes(8))


# ---------------------------------------------------------------------------
# Full stack: pack → encode → mod → sync → decode_soft → unpack
# ---------------------------------------------------------------------------

class TestFt8FullStack:
    def test_full_stack(self):
        # Pack a standard message
        payload = sdr.ft8_pack_standard("KD9ABC", "W9XYZ", "FN31")
        assert len(payload) == 10

        # Encode to tones
        tones = sdr.Ft8Codec.encode(payload)
        assert tones.shape == (58,)

        # Modulate to IQ
        mod = sdr.Ft8Mod(FS, BASE_HZ, 0.0, 1.0)
        iq = mod.modulate(tones)
        assert iq.shape == (151_680,)

        # Sync (wide search window)
        results = sdr.ft8_sync(iq, FS, BASE_HZ - 50.0, BASE_HZ + 100.0, 0, 0, 5)
        assert len(results) > 0

        # Soft decode
        payload_out = sdr.Ft8Codec.decode_soft(results[0]["llr"])
        assert payload_out is not None
        assert payload_out == payload

        # Unpack and verify
        msg = sdr.ft8_unpack(payload_out)
        assert msg["type"] == "standard"
        assert msg["call_to"] == "KD9ABC"
        assert msg["call_de"] == "W9XYZ"
        assert msg["extra"] == "FN31"