miri_sdr(1)

💖 miri_sdr(1) — the I/Q recorder that eats frequencies for breakfast 💖

okay bestie, pull up a chair, because we're about to talk about miri_sdr, straight out of the User Commands section of the manual. yes, the (1) is part of the name, it's giving very "I live in section one and I'm proud of it." 💅

---

✨ NAME ✨

miri_sdr — an I/Q recorder for Mirics SDR devices 🎀

like. that's the whole name section. short, sweet, iconic.

---

🌸 DESCRIPTION 🌸

It's software for the Mirics MSi2500 + MSi001 SDR platform. no cap.

So here's the vibe: In-Phase and Quadrature Phase data can faithfully represent all of the information in a band of frequencies centered on a carrier signal frequency. that's the whole point of I/Q, bestie, it's literally carrying the entire band's soul on its back. 👑

---

🦋 USAGE 🦋

This program captures information from a band of frequencies and outputs the data in a form useful to other software radio programs. 🫶

it's giving "middle friend who introduces everyone to everyone." it grabs the radio waves, it hands them off, everybody eats.

---

🌈 SYNOPSIS 🌈

mirisdr [-f freq] [OPTIONS] [output file]

that's it. that's the shape of it. brackets mean optional, which means the vibes are flexible. ✨

---

💅 OPTIONS 💅

okay here's the part you actually came for. every single one, no skips, no "you get the idea." we do not summarise in this house. 🎀

• -f frequency_to_tune_to [Hz] — tell it which frequency to tune to, in Hz. this is your "hey bestie go stand over there" flag. 📻
• -m sample format (default: auto) — pick how the samples come out. if you don't pick, it picks for you (auto, main character energy).
  • 504: S8 (fastest) 🔥 — zoom zoom, least detail.
  • 384: S10 +2bits — the middle child.
  • 252: S14 — the most bits of the three.
• -e USB transfer mode (default: 1) — how the data travels over USB.
  • 1: Isochronous (maximum 196.608 Mbit/s)
  • 2: Bulk (maximum 333Mbit/s, depends on controller type)

⚠️ note the little truth bomb attached to 2: that max depends on your controller type. it's not a promise, it's a maybe. 💀

• -i IF mode (default: ZERO) — intermediate frequency mode, aka where the band sits.
  • 0: ZERO
  • 450000: 450 kHz
  • 1620000: 1620kHz
  • 2048000: 2048kHz
• -w BW mode (default: 8MHz) — bandwidth mode, aka how wide you're opening the window.
  • 200000: 200kHz
  • 300000: 300kHz
  • 600000: 600kHz
  • 1536000: 1536kHz
  • 5000000: 5MHz
  • 6000000: 6MHz
  • 7000000: 7MHz
  • 8000000: 8MHz
• -s samplerate (default: 2048000 Hz) — how many samples per second. default is 2048000 Hz, she has a favourite. ⭐
• -d device_index (default: 0) — which device, if you've got more than one. default 0, i.e. the first one, i.e. the chosen one.
• -T device_type device variant (default: 0) — device type / device variant. yes it takes a type and a variant, she's thorough.
  • 0: Default
  • 1: SDRPlay
• -g gain (default: 0 for auto) — set the gain. default 0 means auto, so leaving it alone is a valid lifestyle choice. 🍓
• -b output_block_size (default: 16 * 16384) — how big the output blocks are. default is 16 * 16384, and yes we're leaving that expression exactly as-is, it's not my job to do arithmetic at you. 🙈
• -S force sync output (default: async) — force synchronous output. by default it's async, so this flag is you saying "actually, no, sync." assertive. we love that. 👑
• filename — the file you're dumping into. and listen: (a '-' dumps samples to stdout) — so a single dash means "just yeet it at standard output," which is exactly what you want when you're piping into something else. 🌊

---

🧚 EXAMPLES 🧚

Example: To tune to 392.0 MHz, and set the sample-rate to 1.8 MS/s, use:

./mirisdr /tmp/capture.bin -s 1.8e6 -f 392e6

to record samples to a file or to forward the data to a fifo. 🎀

and now the part that saves lives:

If the device can't be opened, make sure you have the appropriate rights to access the device (install udev-rules from the repository, or run it as root).

like, if it's giving "permission denied," it's not broken, you just haven't been introduced yet. install the udev-rules from the repository, or run it as root. periodt. 💅

---

🔥 SEE ALSO 🔥

miri_fm(1), gnuradio(1) — your other besties, go say hi. 🫶

---

💜 AUTHOR 💜

This manual page was written by Maitland Bottoms for the Debian project (but may be used by others). sharing is caring, and she said so herself. 🎀

---

👑 COPYRIGHT 👑

Copyright (c) 2013.2023 A. Maitland Bottoms <bottoms@debian.org>

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

⚠️ bestie, that all-caps warranty disclaimer is not a joke and not a vibe — it literally means no warranty, so read the GNU General Public License for the full deets before you come for anyone. 😭

---

and that's the whole page, diva. this was MiriSDR, version 2.0.0, living in the miri_sdr(1) manual page — slay, bye, go record some I/Q data. 💖✨🦋