RTL_433(1) rtl_433 Commands RTL_433(1)

rtl_433 - گیرنده و رمزگشای عمومی داده‌های RF برای دستگاه‌های باند ISM با استفاده از RTL-SDR و SoapySDR.

این صفحهٔ راهنما به‌طور خلاصه دستور rtl_433 را شرح می‌دهد.

دستور rtl_433 یک گیرندهٔ عمومی داده، عمدتاً برای باندهای ISM در فرکانس‌های 433.92 مگاهرتز، 868 مگاهرتز (SRD)، 315 مگاهرتز و 915 مگاهرتز است. این ابزار با RTL-SDR و/یا SoapySDR کار می‌کند. دستگاه‌هایی که به‌طور فعال آزمایش و پشتیبانی شده‌اند عبارتند از دانگل‌های DVB مبتنی بر Realtek RTL2832 (با استفاده از RTL-SDR)، LimeSDR (نمونه‌های مهندسی LimeSDR USB و LimeSDR mini که از سوی MyriadRf ارائه شده‌اند)، PlutoSDR، HackRF One (با استفاده از درایورهای SoapySDR) و همچنین SoapyRemote.

rtl_433 [گزینه]... فایل...

خلاصه‌ای از گزینه‌ها در زیر آمده است. اطلاعات دقیق‌تر دربارهٔ برخی گزینه‌ها در ادامه آورده شده است.


فایل "rtl_433.conf" در "./"، XDG_CONFIG_HOME برای نمونه "$HOME/.config/rtl_433/"،
و SYSCONFDIR برای نمونه "/usr/local/etc/rtl_433/" جستجو می‌شود، سپس آرگومان‌های خط فرمان به ترتیب بررسی خواهند شد.

[ -V ]
نمایش رشتهٔ نگارش و خروج
[ -v ]
افزایش پرگویی (می‌تواند چندین بار استفاده شود).
-v : اعلان پرگو (verbose notice)، -vv : اطلاعات پرگو (verbose info)، -vvv : اشکال‌زدایی (debug)، -vvvv : ردگیری (trace).
[ -c <path> ]
خواندن گزینه‌های پیکربندی از یک فایل

[ -d <RTL-SDR USB device index> | :<RTL-SDR USB device serial> | <SoapySDR device query> | rtl_tcp | help ]
[-g <gain> | help] (پیش‌فرض: auto)
[ -t <settings> ]
اعمال فهرستی از تنظیمات keyword=value به دستگاه SDR
برای نمونه برای SoapySDR: -t "antenna=A,bandwidth=4.5M,rfnotch_ctrl=false"
برای RTL-SDR از "direct_samp[=1]"، "offset_tune[=1]"، "digital_agc[=1]"، "biastee[=1]" استفاده کنید
[ -f <frequency> ]
فرکانس(های) دریافت (پیش‌فرض: 433920000 Hz)
[ -H <seconds> ]
بازهٔ جهش فرکانسی برای سرکشی چندین فرکانس (پیش‌فرض: 600 ثانیه)
[ -p <ppm_error> ]
تصحیح خطای آفست فرکانس تیونر rtl-sdr (پیش‌فرض: 0)
[ -s <sample rate> ]
تنظیم نرخ نمونه‌برداری (پیش‌فرض: 250000 Hz)
[ -D quit | restart | pause | manual ]
گزینه‌های حالت اجرای دستگاه ورودی (پیش‌فرض: quit).

[ -R <device> | help ]
تنها فعال کردن پروتکل رمزگشایی دستگاه مشخص‌شده (می‌تواند چندین بار استفاده شود)
برای غیرفعال کردن یک پروتکل رمزگشایی دستگاه، یک عدد منفی مشخص کنید (می‌تواند چندین بار استفاده شود)
[ -X <spec> | help ]
افزودن یک رمزگشای همه‌منظوره (افزودن -R 0 در ابتدا برای غیرفعال کردن همهٔ رمزگشاها)
[ -Y auto | classic | minmax ]
حالت آشکارساز پالس FSK.
[ -Y level=<dB level> ]
سطح آشکارسازی دستی برای تعیین پالس‌ها (-1.0 تا -30.0) (0=auto).
[ -Y minlevel=<dB level> ]
حداقل سطح آشکارسازی دستی برای تعیین پالس‌ها (-1.0 تا -99.0).
[ -Y minsnr=<dB level> ]
حداقل SNR برای تعیین پالس‌ها (1.0 تا 99.0).
[ -Y autolevel ]
تنظیم خودکار minlevel بر اساس میانگین نویز تخمینی.
[ -Y squelch ]
نادیده گرفتن فریم‌های زیر سطح نویز تخمینی جهت کاهش بار پردازنده (CPU).
[ -Y ampest | magest ]
انتخاب تخمین‌گر سطح دامنه (amplitude) یا بزرگی (magnitude)..SS "گزینه‌های تحلیل/اشکال‌زدایی (Analyze/Debug options)"
[ -A ]
تحلیل‌گر پالس. فعال‌سازی تحلیل پالس و تلاش برای رمزگشایی.
اگر فقط خروجی تحلیل‌گر را می‌خواهید، همه رمزگشاها را با -R 0 غیرفعال کنید.
[ -y <code> ]
تأیید رمزگشایی داده‌های آزمایشی مدولاسیون‌زدایی‌شده (مانند "{25}fb2dd58") با دستگاه‌های فعال

[ -S none | all | unknown | known ]
ذخیره خودکار سیگنال. برای هر سیگنال یک فایل ایجاد می‌کند.
نکته: نمونه‌های خام I/Q را ذخیره می‌کند (uint8 pcm، دو کاناله). حالت ترجیحی برای ایجاد فایل‌های آزمایشی.
[ -r <filename> | help ]
خواندن داده از فایل ورودی به جای گیرنده
[ -w <filename> | help ]
ذخیره جریان داده در فایل خروجی (یک '-' نمونه‌ها را در stdout می‌ریزد)
[ -W <filename> | help ]
ذخیره جریان داده در فایل خروجی، رونویسی روی فایل موجود

[ -F log | kv | json | csv | mqtt | influx | syslog | trigger | rtl_tcp | http | null | help ]
تولید خروجی رمزگشایی‌شده در قالب ارائه‌شده.
الحاق خروجی به فایل با :<filename> (مانند -F csv:log.csv)، پیش‌فرض stdout است.
مشخص کردن میزبان/درگاه برای syslog با نمونه‌ای مانند -F syslog:127.0.0.1:1514
[ -M time[:<options>] | protocol | level | noise[:<secs>] | stats | bits | help ]
افزودن فراداده‌های گوناگون به هر خروجی.
[ -K FILE | PATH | <tag> | <key>=<tag> ]
افزودن یک توکن بسط‌یافته یا برچسب ثابت به هر خط از خروجی.
[ -C native | si | customary ]
تبدیل یکاها در خروجی رمزگشایی‌شده.
[ -n <value> ]
مشخص کردن تعداد نمونه‌ها برای دریافت (هر نمونه یک جفت I/Q است)
[ -T <seconds> ]
مشخص کردن مدت‌زمان اجرا بر حسب ثانیه، همچنین به صورت 12:34 یا 1h23m45s
[ -E hop | quit ]
پرش فرکانسی/خروج پس از ارسال رویداد(های) موفق به خروجی
[ -h ]
نمایش این راهنمای استفاده و خروج
برای راهنمایی بیشتر، گزینه‌های -d، -g، -R، -X، -F، -M، -r، -w یا -W را بدون آرگومان استفاده کنید

درایور دستگاه RTL-SDR در دسترس است.
[ -d <RTL-SDR USB device index> ]
(پیش‌فرض: 0)
[ -d :<RTL-SDR USB device serial (can be set with rtl_eeprom -s)> ]
برای تنظیم بهره (gain) برای RTL-SDR، از -g <gain> جهت تنظیم بهره کلی بر حسب dB استفاده کنید.
درایور دستگاه SoapySDR در دسترس است.
[ -d "" ]
باز کردن دستگاه پیش‌فرض SoapySDR
[ -d driver=rtlsdr ]
باز کردن دستگاهی خاص از SoapySDR، برای نمونه
برای تنظیم بهره SoapySDR از -g ELEM=val,ELEM=val,... استفاده کنید؛ برای نمونه: -g LNA=20,TIA=8,PGA=2 (برای LimeSDR).
[ -d rtl_tcp[:[//]host[:port] ]
(پیش‌فرض: localhost:1234)
مشخص کردن میزبان/درگاه جهت اتصال، برای نمونه: -d rtl_tcp:127.0.0.1:1234
[ -g <gain> ]
(پیش‌فرض: auto)
برای RTL-SDR: بهره بر حسب dB (مقدار "0" به معنی auto است).
برای SoapySDR: بهره بر حسب dB برای توزیع خودکار ("" به معنی auto است)، یا رشته‌ای از عناصر بهره.
برای مثال "LNA=20,TIA=8,PGA=2" برای LimeSDR.

برای افزودن یک رمزگشای همه‌منظوره و منعطف، از -X <spec> استفاده کنید.

‏<spec> به‌صورت "key=value[,key=value...]" است. کلیدهای متداول عبارتند از:

name=<name> (یا: n=<name>)
modulation=<modulation> (یا: m=<modulation>)
short=<short> (یا: s=<short>)
long=<long> (یا: l=<long>)
sync=<sync> (یا: y=<sync>)
reset=<reset> (یا: r=<reset>)
gap=<gap> (یا: g=<gap>)
tolerance=<tolerance> (یا: t=<tolerance>)
priority=<n> : اجرای رمزگشا تنها به عنوان جایگزین نهایی (fallback)
که در آن: <name> می‌تواند هر برچسب نام توصیفی باشد که در خروجی به آن نیاز دارید <modulation> یکی از موارد زیر است:
OOK_MC_ZEROBIT : کد منچستر با بیت صفر آغازین ثابت
OOK_PCM : کدگذاری بدون بازگشت به صفر (کد پالس)
OOK_RZ : کدگذاری بازگشت به صفر (کد پالس)
OOK_PPM : مدولاسیون موقعیت پالس (Pulse Position Modulation)
OOK_PWM : مدولاسیون پهنای پالس (Pulse Width Modulation)
OOK_DMC : کد منچستر تفاضلی (Differential Manchester Code)
OOK_PIWM_RAW : مدولاسیون خام بازه و پهنای پالس
OOK_PIWM_DC : مدولاسیون تفاضلی بازه و پهنای پالس
OOK_MC_OSV1 : کد منچستر برای دستگاه‌های OSv1
FSK_PCM : مدولاسیون کد پالس FSK
FSK_PWM : مدولاسیون پهنای پالس FSK
FSK_MC_ZEROBIT : کد منچستر با بیت صفر آغازین ثابت
‏<short>، <long> و <sync> زمان‌بندی‌های اسمی مدولاسیون بر حسب میکروثانیه (us) هستند، ‏<reset>، <gap> و <tolerance> حداکثر زمان‌بندی‌های مدولاسیون بر حسب میکروثانیه (us) هستند: PCM/RZ short: پهنای اسمی پالس [us]
long: پهنای اسمی دوره بیت [us] PPM short: پهنای اسمی فاصله '0' [us]
long: پهنای اسمی فاصله '1' [us] PWM short: پهنای اسمی پالس '1' [us]
long: پهنای اسمی پالس '0' [us]
sync: پهنای اسمی پالس همگام‌سازی [us] (اختیاری) common gap: حداکثر اندازه فاصله قبل از سطر جدید بیت‌ها [us]
reset: حداکثر اندازه فاصله قبل از پایان پیام [us]
tolerance: حداکثر انحراف پالس [us] (اختیاری). گزینه‌های موجود عبارتند از:
bits=<n> : تنها در صورتی تطبیق داده شود که حداقل یک سطر دارای <n> بیت باشد
rows=<n> : تنها در صورتی تطبیق داده شود که <n> سطر وجود داشته باشد
repeats=<n> : تنها در صورتی تطبیق داده شود که سطری <n> بار تکرار شده باشد
از opt>=n برای تطبیق با حداقل <n> و از opt<=n برای تطبیق با حداکثر <n> استفاده کنید
invert : معکوس کردن تمام بیت‌ها
reflect : بازتاب هر بایت (بیت باارزش‌تر از ابتدا به انتها)
decode_uart : رمزگشایی UART 8n1 (10-to-8)
decode_dm : رمزگشایی منچستر تفاضلی
decode_mc : رمزگشایی منچستر
match=<bits> : تنها در صورتی تطبیق داده شود که <bits> پیدا شود
preamble=<bits> : تطبیق و تراز کردن در پیش‌درآمد (preamble) <bits>
‏<bits> مشخصه سطری به‌صورت {<bit count>}<bits as hex number> است
unique : جلوگیری از خروجی سطرهای تکراری
countonly : جلوگیری از خروجی جزئیات سطرها

برای مثال: -X "n=doorbell,m=OOK_PWM,s=400,l=800,r=7000,g=1000,match={24}0xa9878c,repeats>=3".SS "گزینه قالب خروجی (Output format option)"

[ -F log|kv|json|csv|mqtt|influx|syslog|trigger|rtl_tcp|http|null ]
تولید خروجی رمزگشایی‌شده در قالب مشخص‌شده.
بدون این گزینه، پیش‌فرض خروجی LOG و KV است. برای حذف پیش‌فرض از «-F null» استفاده کنید.
الحاق خروجی به فایل با :<filename> (مانند -F csv:log.csv)، پیش‌فرض خروجی استاندارد (stdout) است.
[ -F mqtt[s][:[//]host[:port][,<options>] ]
(پیش‌فرض: localhost:1883)
مشخص کردن کارساز MQTT به عنوان مثال با -F mqtt://localhost:1883
نام کاربری و گذرواژه پیش‌فرض از متغیرهای محیطی MQTT_USERNAME و MQTT_PASSWORD خوانده می‌شوند.
افزودن گزینه‌های MQTT به عنوان مثال با -F "mqtt://host:1883,opt=arg"
گزینه‌های MQTT عبارتند از: user=foo, pass=bar, retain[=0|1], <format>[=topic]
قالب‌های پشتیبانی‌شده MQTT: (پیش‌فرض همه موارد است)

availability: ارسال وضعیت دسترسی (online/offline)

events: ارسال داده‌های رویداد JSON، پیش‌فرض «<base>/events»

states: ارسال داده‌های وضعیت JSON، پیش‌فرض «<base>/states»

devices: ارسال اطلاعات دستگاه و حسگر در تاپیک‌های تو در تو،

پیش‌فرض «<base>/devices[/type][/model][/subtype][/channel][/id]»
یک تاپیک پایه را می‌توان با base=<topic> تنظیم کرد، پیش‌فرض «rtl_433/HOSTNAME» است.
هر رشته تاپیک جایگزین تاپیک پایه می‌شود و کلیدهایی مانند [/model] را گسترش می‌دهد
مانند: -F "mqtt://localhost:1883,user=USERNAME,pass=PASSWORD,retain=0,devices=rtl_433[/id]"
برای TLS به عنوان مثال از -F "mqtts://host,tls_cert=<path>,tls_key=<path>,tls_ca_cert=<path>" استفاده کنید
در MQTT، هر نمونه rtl_433 به انتخاب درایور متفاوتی نیاز دارد. شناسه کلاینت MQTT (Client-ID) از رشته درایور محاسبه می‌شود.
اگر از چندین RTL-SDR استفاده می‌کنید، بهتر است یک شماره سریال تنظیم کرده و بر اساس آن انتخاب کنید (کمک می‌کند آنتن اشتباهی انتخاب نشود).
[ -F influx[:[//]host[:port][/<path and options>] ]
مشخص کردن کارساز InfluxDB 2.0 به عنوان مثال با -F "influx://localhost:9999/api/v2/write?org=<org>&bucket=<bucket>,token=<authtoken>"
مشخص کردن کارساز InfluxDB 1.x به عنوان مثال با -F "influx://localhost:8086/write?db=<db>&p=<password>&u=<user>"

پارامتر اضافی -M time:unix:usec:utc برای برچسب‌های زمانی صحیح در InfluxDB توصیه می‌شود
[ -F syslog[:[//]host[:port ]
(پیش‌فرض: localhost:514)
میزبان/درگاه برای syslog را مشخص کنید، به عنوان مثال با -F syslog:127.0.0.1:1514
[ -F trigger:/path/to/file ]
افزودن خروجی‌ای که به ازای هر رویداد یک مقدار «1» در مسیر می‌نویسد، مناسب برای استفاده با مواردی مانند GPIO
[ -F rtl_tcp[:[//]bind[:port] ]
(پیش‌فرض: localhost:1234)
افزودن یک کارساز میان‌گذر (pass-through) rtl_tcp
[ -F http[:[//]bind[:port] ]
(پیش‌فرض: 0.0.0.0:8433)
افزودن یک کارساز HTTP API، رابط کاربری به عنوان مثال در http://localhost:8433 در دسترس است
[ -M time[:<options>]|protocol|level|noise[:<secs>]|stats|bits ]
افزودن فراداده‌های گوناگون به هر خط خروجی.
از "time" برای افزودن فراداده تاریخ و زمان جاری استفاده کنید (پیش‌تنظیم برای ورودی‌های زنده).
از "time:rel" برای افزودن فراداده موقعیت نمونه استفاده کنید (پیش‌تنظیم برای read-file و stdin).
از "time:unix" برای نمایش ثانیه‌ها از مبدأ یونیکس (unix epoch) به عنوان فراداده زمان استفاده کنید. این مقدار همیشه UTC است.
از "time:iso" برای نمایش زمان در قالب ISO-8601 (YYYY-MM-DD"T"hh:mm:ss) استفاده کنید.
از "time:off" برای حذف فراداده زمان استفاده کنید.
از "time:usec" برای افزودن میکروثانیه به فراداده تاریخ و زمان استفاده کنید.
از "time:tz" برای خروجی دادن زمان همراه با اختلاف منطقه زمانی استفاده کنید.
از "time:utc" برای خروجی دادن زمان در UTC استفاده کنید.
(این کار می‌تواند با فراخوانی همراه با تنظیم متغیر محیطی TZ نیز انجام شود).
"usec" و "utc" را می‌توان با گزینه‌های دیگر ترکیب کرد، مثلاً "time:iso:utc" یا "time:unix:usec".
از "replay[:N]" برای پخش مجدد ورودی‌های فایل با سرعت (N برابر) زمان واقعی استفاده کنید.
از "protocol" / "noprotocol" برای خروجی دادن فراداده شماره پروتکل رمزگشا استفاده کنید.
از "level" برای افزودن فراداده‌های Modulation، Frequency، RSSI، SNR و Noise استفاده کنید.
از "noise[:<secs>]" برای گزارش سطح تخمینی نویز در فواصل زمانی مشخص استفاده کنید (پیش‌فرض: ۱۰ ثانیه).
از "stats[:[<level>][:<interval>]]" برای گزارش آمارها استفاده کنید (پیش‌فرض: ۶۰۰ ثانیه).

سطح ۰: بدون گزارش، ۱: گزارش دستگاه‌های موفق، ۲: گزارش دستگاه‌های فعال، ۳: گزارش همه
از "bits" برای افزودن نمایش بیتی به خروجی‌های کد استفاده کنید (جهت اشکال‌زدایی).

[ -r <filename> ]
خواندن داده‌ها از فایل ورودی به جای یک گیرنده
پارامترها از مسیر کامل، نام فایل و پسوند آن شناسایی می‌شوند.
فرکانس مرکزی به صورت یک عدد (کسری) دارای پسوند 'M'،

'Hz'، 'kHz'، 'MHz' یا 'GHz' شناسایی می‌شود.
نرخ نمونه‌برداری به صورت یک عدد (کسری) دارای پسوند 'k'،

'sps'، 'ksps'، 'Msps' یا 'Gsps' شناسایی می‌شود.
محتوا و قالب فایل به عنوان پارامتر شناسایی می‌شوند، گزینه‌های ممکن عبارتند از:

'cu8'، 'cs16'، 'cf32' (به طور ضمنی 'IQ') و 'am.s16'.
پارامترها باید با نویسه‌های غیرحرفی-عددی جدا شوند و به حروف بزرگ و کوچک حساس نیستند.
بازنویسی‌ها می‌توانند به صورت پیشوند و جداشده با دونقطه (':') اعمال شوند
مثلاً شناسایی پیش‌فرض از روی پسوند: path/filename.am.s16
بازنویسی‌های اجباری: am:s16:path/filename.ext
خواندن از لوله‌ها (pipes) نیز از گزینه‌های قالب پشتیبانی می‌کند.
مثلاً خواندن ممیز شناور ۳۲-بیتی مختلط: CU32:-
[ -w <filename> ]
ذخیرهٔ جریان داده در فایل خروجی (یک '-' نمونه‌ها را در stdout می‌ریزد)
[ -W <filename> ]
ذخیرهٔ جریان داده در فایل خروجی، رونویسی فایل در صورت وجود
پارامترها از مسیر کامل، نام فایل و پسوند آن تشخیص داده می‌شوند.
محتوا و قالب فایل به‌عنوان پارامتر تشخیص داده می‌شوند؛ گزینه‌های ممکن عبارتند از:

'cu8'، 'cs8'، 'cs16'، 'cf32' (به‌طور ضمنی 'IQ')،

'am.s16'، 'am.f32'، 'fm.s16'، 'fm.f32'،

'i.f32'، 'q.f32'، 'logic.u8'، 'ook' و 'vcd'.
پارامترها باید با نویسه‌های غیرحرفی-عددی از هم جدا شوند و به حروف کوچک و بزرگ حساس نیستند.
بازنویسی‌ها می‌توانند به‌صورت پیشوند قرار گیرند و با دونقطه (':') جدا شوند.
به‌عنوان مثال، تشخیص پیش‌فرض بر اساس پسوند: path/filename.am.s16
بازنویسی‌های اجباری: am:s16:path/filename.ext

وب‌گاه پروژه: https://github.com/merbanan/rtl_433

حق نشر © 2012-2019 متعلق به Benjamin Larsson، Christian W. Zuckschwerdt و مشارکت‌کنندگان پرشمار.
استفادهٔ آزاد از این نرم‌افزار تحت شرایط اجازه‌نامهٔ GPL-2+ مجاز است.

2019-08-21 rtl_433