{"id":34091009,"url":"https://github.com/peads/sdrterm","last_synced_at":"2026-04-09T04:32:32.563Z","repository":{"id":240326740,"uuid":"801866610","full_name":"peads/sdrterm","owner":"peads","description":"Terminal-based tools for (mostly SDR-originated) signal analysis","archived":false,"fork":false,"pushed_at":"2024-08-04T09:20:22.000Z","size":210,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-12-16T17:52:51.907Z","etag":null,"topics":["communications","dsp","mathematics","radio","rtl","rtl-sdr","rtlsdr","sdr","sdrterm","sigint","signal-analysis","signal-processing","software-defined-radio"],"latest_commit_sha":null,"homepage":"https://github.com/peads/sdrterm","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/peads.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-05-17T04:23:53.000Z","updated_at":"2025-01-03T04:55:26.000Z","dependencies_parsed_at":"2024-05-22T23:36:33.734Z","dependency_job_id":null,"html_url":"https://github.com/peads/sdrterm","commit_stats":null,"previous_names":["peads/sdrterm"],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/peads/sdrterm","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/peads%2Fsdrterm","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/peads%2Fsdrterm/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/peads%2Fsdrterm/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/peads%2Fsdrterm/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/peads","download_url":"https://codeload.github.com/peads/sdrterm/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/peads%2Fsdrterm/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31586403,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-08T14:31:17.711Z","status":"online","status_checked_at":"2026-04-09T02:00:06.848Z","response_time":112,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["communications","dsp","mathematics","radio","rtl","rtl-sdr","rtlsdr","sdr","sdrterm","sigint","signal-analysis","signal-processing","software-defined-radio"],"created_at":"2025-12-14T14:30:48.348Z","updated_at":"2026-04-09T04:32:32.541Z","avatar_url":"https://github.com/peads.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"![image](https://github.com/user-attachments/assets/994dfc96-bf75-410d-ac77-dd83ee1a87c0)\n\n# Installation\n`pip install sdrterm`\n\n*NOTE: Unless you intend use code on the bleeding-edge, or to modify the source, skip ahead to [here](#notes).\n# Requirements\nAfter cloning this repo perform the following:\n```\ncd \u003cpath/to/clone\u003e\npython -m venv .venv\n\n(if using windows)\n.\\.venv\\Scripts\\activate\n\n(otherwise)\nsource .venv/bin/activate\n\n(either)\npip install .\n(or to include optional graphing dependencies)\npip install .[gui]\n\n...\u003cdo stuff here\u003e...\n\ndeactivate\n```\nAlternatively--if you do not wish to use a virtual environment--the dependencies may be installed via the system's \npackage manager; or, with caution, using `pip` directly.\n\n*Plotting support is optional, and dependencies can be installed by specifying by the \n`[gui]` option during install, or if they happen to already be installed in the environment.*\n## Notes\n### Input data\n* For raw files, input is system-default endianness, \n* For wave files, the endianness defined by the RIFF/X header\n* For tcp connections, data is expected to be big-endian\n* Endianness can be inverted using the `-X` flag\n* When necessary to specify the input datatype (`-e` flag), the selections map exactly to the \"integer\" and \"float\" types listed [here](https://docs.python.org/3/library/struct.html#format-characters)\n### Ouput data\n* Standard mode outputs doubles (float64) with system-default endianness and alignment\n* Multiple VFO mode (`--simo` flag) output is always big-endian doubles\n### Misc\n* Be aware that piping binary (i.e. non-text) data between processes in Powershell is only natively-supported \nin Powershell v7.4+ (https://stackoverflow.com/a/68696757/8372013), which you may have \nto install separately from the default version included with your copy of Windows. \n*N.B. this does not affect modes that use sockets for IO.*\n# Examples\n## sdrterm.py\n### Read input from wave file\n`python -m sdrterm -i file.wav --omega-out=5k --decimation=64 --center-frequency=\"15k\" --plot=spec --correct-iq -o out.bin`\n#### General explanation of options\n* Input source: wave file\n* Input data type: determined by RIFF/X header metadata\n* Sample rate: determined by RIFF/X header metadata ($fs$ $S \\over s$)\n* Output lp: 5 kHz\n* Decimation factor: $64 \\implies$ $fs \\over 64$ $S \\over s$\n* Offset from tuned frequency: +15 kHz\n* Plot(s): Spectrum Analyzer\n* IQ correction: enabled\n* Output destination: out.bin\n### Read input from socket, and pipe output to stdout \n`python -m sdrterm -i \u003chost\u003e:\u003cport\u003e -eh -r1024k -w5k -d64 -c\"-30k\" --plot=water | ...`\n#### General explanation of options\n*N.B. sampling rate and datatype must be specified for raw input*\n* Input source: TCP socket at \\\u003chost\u003e on \\\u003cport\u003e\n* Input data type: 16-bit, signed integer\n* Sample rate: $1024k$ $S \\over s$\n* Output lp: 5 kHz\n* Decimation factor: $64 \\implies$ $1024k \\over 64$ $= 16k$ $S \\over s$\n* Offset from tuned frequency: -30 kHz\n* Plot(s): Waterfall\n* Output destination: stdout\n### Select multiple frequencies to process from data input via a socket and output them via separate sockets\n#### See [exmaple_simo.sh](example_simo.sh) for a complete example\n\n*More examples can be found in the shell scripts  in the root of this repo.* \n```\n Usage: sdrterm.py [OPTIONS]\n\n╭─ Options ─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮\n│ --fs                     -r                          NUMBER                Sampling frequency in k/M/Samples per sec                                                                                                  │\n│ --center-frequency       -c                          NUMBER                Offset from tuned frequency in k/M/Hz [default: 0]                                                                                         │\n│ --input                  -i                          TEXT                  Input device [default: (stdin)]                                                                                                            │\n│ --output                 -o                          TEXT                  Output device [default: (stdout)]                                                                                                          │\n│ --plot                                               TEXT                  1D-Comma-separated value of plot type(s) [default: None]                                                                                   │\n│ --demodulation           -m                          [fm|am|re|im]         Demodulation type [default: fm]                                                                                                            │\n│ --tuned-frequency        -t                          NUMBER                Tuned frequency in k/M/Hz [default: 0]                                                                                                     │\n│ --vfos                                               TEXT                  1D-Comma-separated value of offsets from tuned frequency to process in addition to tuned frequency in k/M/Hz [default: None]               │\n│ --decimation             -d                          INTEGER RANGE [x\u003e=2]  Decimation factor [default: 2]                                                                                                             │\n│ --encoding               -e                          [b|B|h|H|i|I|f|d]     Binary encoding (ignored if wav file) [default: None]                                                                                      │\n│ --omega-out              -w                          NUMBER                Output cutoff frequency in k/M/Hz [default: 12500]                                                                                         │\n│ --correct-iq                 --no-correct-iq                               Toggle iq correction [default: no-correct-iq]                                                                                              │\n│ --simo                       --no-simo                                     Enable using sockets to output data processed from multiple channels specified by the vfos option. N.B. unlike normal mode, which uses the │\n│                                                                            system-default endianness for output, the sockets output network-default, big-endian doubles. [Implies: --vfos \u003ccsv\u003e]                      │\n│                                                                            [default: no-simo]                                                                                                                         │\n│ --verbose                -v                          INTEGER               Toggle verbose output. Repetition increases verbosity (e.g. -vv, or -v -v) [default: 0]                                                    │\n│ --smooth-output                                      INTEGER               Provide length of polynomial for smoothing output with Savitzky–Golay filter. A larger polynomial implies more aggressive filtering.       │\n│                                                                            [default: (0 =\u003e no filtering)]                                                                                                             │\n│ --vfo-host                                           TEXT                  Address on which to listen for vfo client connections [default: localhost]                                                                 │\n│ --swap-input-endianness  -X                                                Swap input endianness [default: (False =\u003e system-default, or as defined in RIFF header)]                                                   │\n│ --normalize-input            --no-normalize-input                          Normalize input data. [default: no-normalize-input]                                                                                        │\n│ --help                                                                     Show this message and exit.                                                                                                                │\n╰───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯\n```\n\n## rtltcp.py\n#### rtl_tcp running on server \u003cip | addr\u003e on \\\u003cport\u003e\n`python -m rtltcp \u003chost\u003e \u003cport\u003e`\n```\n Usage: rtltcp.py [OPTIONS] HOST PORT\n\n╭─ Arguments ───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮\n│ *    host      TEXT     Address of remote rtl_tcp server [default: None] [required]                                               │\n│ *    port      INTEGER  Port of remote rtl_tcp server [default: None] [required]                                                  │\n╰───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯\n╭─ Options ─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮\n│ --server-host          TEXT     Port of local distribution server [default: localhost]                                            │\n│ --verbose      -v      INTEGER  Toggle verbose output. Repetition increases verbosity (e.g. -vv, or -v -v) [default: 0]           │\n│ --help                          Show this message and exit.                                                                       │\n╰───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯\n```\n\u003cimg width=\"466\" alt=\"Screenshot 2024-06-18 at 20 45 48\" src=\"https://github.com/peads/sdrterm/assets/902685/29812f55-479f-4934-930b-56b2aaf743c4\"\u003e\n\n## sdrcontrol.py [EXPERIMENTAL]\n\n\u003cimg width=\"993\" alt=\"Screenshot 2024-06-18 at 20 43 23\" src=\"https://github.com/peads/sdrterm/assets/902685/7fd07d90-e79a-47e9-9cec-3ebc7cd446af\"\u003e\n\n*Due to the experimental nature of this interface, do not hesitate to report suspected bugs.*\n\n*N.B. if you'd like to be sure of your wave file's sampling rate beforehand, \nyou can use a tool like `mediainfo` available via most POSIX-like systems' package managers. \nAlso, basic information about the input file, and other settings are output in JSON format at beginning\nof sdrterm's operation. e.g.,*\n```\n{\n  \"bandwidth\": 12500,\n  \"centerFreq\": -25000,\n  \"tunedFreq\": 0,\n  \"omegaOut\": 5000,\n  \"smooth\": 0,\n  \"vfos\": \"15000,-15000\",\n  \"host\": \"localhost\",\n  \"encoding\": \"uint8\",\n  \"fs\": 1024000,\n  \"decimatedFs\": 16000\n}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpeads%2Fsdrterm","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpeads%2Fsdrterm","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpeads%2Fsdrterm/lists"}