RIGCTLTCP(1) Hamlib Utilities RIGCTLTCP(1)

rigctltcp - دیمن کنترل از راه دور رادیو ترنسیور بر بستر TCP

rigctltcp [-hlLuoVR] [-m id] [-r device] [-p device] [-d device] [-P type] [-D type] [-s baud] [-c id] [-S char] [-C parm=val] [-T ipaddr] [-t num] [-M addr] [-n port] [-W secs] [-w secs] [-x option] [-A password] [-v[-Z]]

دیمن شبکه‌ای که پخش‌های چندپخشی (multicast) مبتنی بر UDP شامل داده‌های لحظه‌ای (snapshot) رادیو را فعال می‌کند. از کنترل دوطرفه رادیو و دریافت وضعیت پشتیبانی می‌نماید. داده‌های پخش‌شده می‌توانند جفت‌توکن‌های rigctld(1) یا JSON باشند.

تمام بسته‌ها با یک رشته id منحصربه‌فرد برچسب‌گذاری می‌شوند تا چندین رادیو بتوانند روی یک پورت یکسان اقدام به ارسال یا دریافت (broadcast/rx) نمایند. در ابتدا امکان تنظیم فرکانس، حالت (mode)، پهنای باند عبوری (passband width)، وضعیت PTT، حالت ماهواره‌ای (satmode) و وضعیت split را فراهم خواهد کرد زیرا این موارد در بسیاری از برنامه‌ها مشترک هستند. قابلیت‌های بیشتری در آینده به مرور افزوده خواهند شد.

محتوای بسته‌های ارسالی بر پایه خروجی get_rig_info بوده و ممکن است شامل چندین خط VFO باشد. بخش مثال‌ها (EXAMPLES) در زیر را ببینید.

این برنامه از سینتکس معمول خط فرمان گنو پیروی می‌کند. در گزینه‌های کوتاه دارای آرگومان، مقدار می‌تواند بلافاصله پس از گزینه بیاید یا با یک فاصله جدا شود. گزینه‌های طولانی که با دو خط تیره (‘-’) آغاز می‌شوند به یک علامت مساوی (‘=’) میان گزینه و آرگومان نیاز دارند.

در اینجا خلاصه‌ای از گزینه‌های پشتیبانی‌شده آورده شده است:

انتخاب شماره مدل رادیو. مقدار پیش‌فرض Dummy با شناسه ID 1 است.
مشاهده فهرست مدل‌ها (با دستور “rigctltcp -l”).
نکته: برنامه rigctltcp (یا نرم‌افزارهای شخص ثالث با استفاده از C API) از شناسه ID 2 برای NET rigctl (ارتباط با rigctld) استفاده خواهند کرد.
استفاده از DEVICE به‌عنوان نام فایل پورت متصل به رادیو.
معمولاً /dev/ttyS0، /dev/ttyS1، /dev/ttyUSB0 و غیره در لینوکس، و COM1، COM2 و غیره در ویندوز. توزیع‌های مختلف BSD و MacOS نام‌های دستگاهی مختص به خود را دارند. مستندات سیستم خود را بررسی کنید.
می‌تواند یک نشانی شبکه و پورت باشد، مانند 127.0.0.1:12345
می‌توان از رشته ویژه “uh-rig” برای فعال‌سازی پشتیبانی از دستگاه micro-ham استفاده کرد.
استفاده از DEVICE به‌عنوان نام فایل دستگاه Push To Talk با همان ساختار نام‌گذاری دستگاه که در گزینه -r در بالا شرح داده شد.
استفاده از DEVICE به‌عنوان نام فایل دستگاه Data Carrier Detect با همان ساختار نام‌گذاری دستگاه که در گزینه -r در بالا شرح داده شد.
استفاده از نوع TYPE برای دستگاه Push To Talk.
انواع پشتیبانی‌شده عبارتند از ‘RIG’ (دستور CAT)،‏ ‘DTR’،‏ ‘RTS’،‏ ‘PARALLEL’،‏ ‘CM108’،‏ ‘GPIO’،‏ ‘GPION’ و ‘NONE’، که نوع PTT تعریف‌شده در بک‌اند رادیو را بازنویسی (override) می‌کنند.
برخی اثرات جانبی این گزینه بدین صورت است که با تنظیم نوع روی DTR، وضعیت خوانده‌شده PTT از فرانت‌اند Hamlib می‌آید و مستقیماً از رادیو خوانده نمی‌شود. با تنظیم روی NONE، وضعیت PTT نه قابل خواندن و نه قابل تنظیم خواهد بود، حتی اگر بک‌اند رادیو از خواندن یا تنظیم وضعیت PTT پشتیبانی کند.
استفاده از نوع TYPE برای دستگاه Data Carrier Detect.
انواع پشتیبانی‌شده عبارتند از ‘RIG’ (دستور CAT)،‏ ‘DSR’،‏ ‘CTS’،‏ ‘CD’،‏ ‘PARALLEL’،‏ ‘CM108’،‏ ‘GPIO’،‏ ‘GPION’ و ‘NONE’.
تنظیم سرعت پورت سریال بر روی نرخ BAUD.
به‌طور پیش‌فرض از حداکثر سرعت سریال پشتیبانی‌شده در قابلیت‌های بک‌اند رادیو (تعیین‌شده توسط -m در بالا) استفاده می‌کند.
استفاده از ID به‌عنوان آدرس CI–V جهت برقراری ارتباط با رادیو.
فقط برای رادیوهای Icom و برخی از رادیوهای Ten–Tec کاربرد دارد.
نکته: شناسه id در قالب ده‌دهی (decimal) است، مگر اینکه با 0x شروع شده باشد که در این صورت هگزادسیمال در نظر گرفته می‌شود.
استفاده از CHAR به‌عنوان جداکننده به جای نویسه خط جدید (line feed).
مقدار پیش‌فرض \n است. استفاده از $ یا @ توصیه می‌شود زیرا در هر دو محیط POSIX و ویندوز کار می‌کنند.
فهرست کردن تمامی پارامترهای پیکربندی رادیوی مشخص‌شده با -m در بالا. در صورت عدم تعیین -r، برنامه خارج می‌شود. توجه کنید که دستگاه dummy پارامترهای سریال ندارد.
تنظیم پارامتر(های) پیکربندی. برخی از موارد پرکاربرد عبارتند از:
async: مقدار True انتقال ناهمگام داده‌ها را برای بک‌اندهایی که از آن پشتیبانی می‌کنند فعال می‌سازد. این امر امکان استفاده از داده‌های transceive و طیف (spectrum) را فراهم می‌کند.
auto_power_on: مقدار True روشن شدن خودکار رادیوهای سازگار را در زمان باز شدن پورت فعال می‌کند.
auto_power_off: مقدار True خاموش شدن خودکار رادیوهای سازگار را در زمان بسته شدن پورت فعال می‌کند.
auto_disable_screensaver: مقدار True غیرفعال‌سازی خودکار محافظ صفحه (screensaver) رادیوهای سازگار را هنگام باز شدن اتصال ممکن می‌سازد.
dcd_type: بازنویسی نوع رابط Data Carrier Detect (یا squelch).
dcd_pathname: مسیر فایل دستگاه رابط Data Carrier Detect (یا squelch).
disable_yaesu_bandselect: مقدار True انتخاب خودکار باند هنگام تغییر باند را در رادیوهای Yaesu غیرفعال می‌کند.
dtr_state: مقدار ON سیگنال DTR را روشن و OFF آن را خاموش می‌کند؛ در صورت عدم تنظیم غیرفعال است.
freq_skip: مقدار !=0 تنظیم فرکانس روی TX_VFO را هنگام دریافت (RX) و روی RX_VFO را هنگام ارسال (TX) نادیده می‌گیرد؛ کاربرد در gpredict و رادیوهایی که فاقد TARGETABLE_VFO هستند.
lo_freq: فرکانسی که برای استفاده با ترانسورتر به فرکانس VFO افزوده می‌شود.
post_write_delay: تأخیر بر حسب میلی‌ثانیه میان ارسال هر دستور.
ptt_share: مقدار True امکان اشتراک‌گذاری پورت PTT با سایر برنامه‌ها را فعال می‌کند.
ptt_type: بازنویسی نوع رابط Push–To–Talk.
ptt_pathname: مسیر فایل دستگاه رابط Push–To–Talk.
ptt_bitnum: شماره بیت GPIO برای Push–To–Talk.
retry: حداکثر تعداد تلاش‌های مجدد.
rts_state: مقدار ON سیگنال RTS را روشن و OFF آن را خاموش می‌کند؛ در صورت عدم تنظیم غیرفعال است.
twiddle_timeout: برای عملیات‌های ماهواره‌ای، با دستکاری VFOB ارسال دستورات به آن تا زمان انقضای مهلت متوقف می‌شود.
twiddle_rit: جلوگیری از اجرای get_freq روی VFOB به منظور تنظیم RIT در ماهواره‌ها.
timeout: مهلت زمانی بر حسب میلی‌ثانیه.
write_delay: تأخیر بر حسب میلی‌ثانیه میان ارسال هر بایت.
tuner_control_pathname: مسیر فایل اسکریپت یا برنامه‌ای جهت کنترل تیونر با یک آرگومان 0/1 برای خاموش/روشن کردن تیونر.
برای دریافت فهرست پارامترهای پیکربندی برای یک شماره مدل خاص از گزینه -L در بالا استفاده کنید.
فهرست کردن تمامی شماره مدل‌های تعریف‌شده در Hamlib و خروج.
فهرست بر اساس شماره مدل مرتب شده است.
نکته: می‌توان فهرست را با استفاده از کلیدهای Shift-PageUp/Shift-PageDown یا با استفاده از نوار اسکرول شبیه‌ساز ترمینال در X/Wayland یا پنجره cmd در ویندوز به بالا و پایین پیمایش کرد. می‌توان خروجی را به more(1) یا less(1) هدایت (pipe) کرد، مانند “rigctltcp -l | more”.
تخلیه و نمایش قابلیت‌های رادیوی مشخص‌شده با -m در بالا و خروج.
فعال‌سازی حالت VFO.
یک آرگومان اضافی VFO در ابتدای هر دستور مرتبط (به‌جز set_vfo) مورد نیاز خواهد بود. در غیر این صورت، با فعال نبودن این گزینه مقدار ‘currVFO’ به کار می‌رود و آرگومان اضافی VFO استفاده نمی‌شود.
دستور chk_vfo در زیر را ببینید.
تنظیم حالت پرگویی (verbose)، به صورت افزایشی (بخش عیب‌یابی در زیر را ببینید).
استفاده از IPADDR به‌عنوان نشانی IP شنود.
مقدار پیش‌فرض ANY (0.0.0.0) است.
استفاده از NUM به‌عنوان پورت شنود TCP.
مقدار پیش‌فرض 4531 است.
استفاده از ADDR به‌عنوان نشانی IP چندپخشی (multicast).
مقدار پیش‌فرض OFF (0.0.0.0) است.
مقدار پیشنهادی برای IPv4 برابر با 224.0.1.1 است.
استفاده از PORT به‌عنوان پورت شنود چندپخشی.
مقدار پیش‌فرض 4532 است.
فعال‌سازی مهلت زمانی هنگام تشخیص تغییر وضعیت VFO. برخی عملکردها نادیده گرفته خواهند شد.
تنها زمانی نیاز است که نرم‌افزار کنترل‌کننده باید موقتاً متوقف (pause) شود تا بتوانید VFO را جابه‌جا کنید. حرکت مداوم این مهلت زمانی را تمدید می‌کند.
جلوگیری از اجرای get_freq روی VFOB تا امکان تغییر RIT فراهم شود.
1=Sub, 2=Main.
در GPredict از این گزینه برای نادیده گرفتن get_freq در VFO آپ‌لینک Sub یا Main استفاده کنید.
امکان تغییر VFO در داون‌لینک را بدون تداخل در عملکرد GPredict یا آپ‌لینک فراهم می‌سازد.
فعال‌سازی برچسب‌های زمانی برای پیام‌های اشکال‌زدایی.
فقط همراه با گزینه -v استفاده شود، زیرا به‌تنهایی خروجی تولید نمی‌کند.
تنظیم گذرواژه برای rigctltcp که نیازمند استفاده از rig_set_password در Hamlib و استفاده کلاینت‌ها از PASSWORD جهت دسترسی به rigctltcp است. یک کلید مخفی مشترک ۳۲ کاراکتری جهت استفاده در سمت کلاینت نمایش داده خواهد شد.
(پیاده‌سازی نشده است)
موجب می‌شود در زمانی که هیچ کلاینتی متصل نیست، rigctltcp اتصال به رادیو را ببندد. در حالت عادی جهت تسریع اتصالات بعدی، ارتباط همچنان برقرار می‌ماند.
نمایش خلاصه‌ای از این گزینه‌ها و خروج.
نمایش نسخه rigctltcp و خروج.

نکته: برخی از گزینه‌ها ممکن است در یک بک‌اند خاص پیاده‌سازی نشده باشند و با خطا مواجه شوند. این مسئله معمولاً در گزینه‌های --set-conf و --show-conf رخ می‌دهد.

لطفاً توجه داشته باشید که بک‌اند رادیوی تحت کنترل یا خود رادیو ممکن است از برخی دستورات پشتیبانی نکنند. در این حالت، عملیات با یک کد خطای Hamlib شکست خواهد خورد.

گزینه -v, --verbose امکان ارسال سطوح مختلف پیام‌های تشخیصی به stderr را فراهم می‌سازد که به ترتیب شامل -v برای BUG، -vv برای ERR، -vvv برای WARN، -vvvv برای VERBOSE یا -vvvvv برای TRACE است.

هر یک از این سطوح برای ارائه اطلاعات لازم اشکال‌زدایی سودمند هستند. برای مثال، خروجی TRACE تمام مقادیر ارسال‌شده به رادیو و دریافت‌شده از آن را نشان می‌دهد که برای توسعه کتابخانه بک‌اند رادیو بسیار مفید بوده و ممکن است توسط توسعه‌دهندگان درخواست شود.

rigctltcp با این مقادیر خارج می‌شود:

0
اگر تمام عملیات‌ها با موفقیت و به طور عادی انجام شوند؛
1
اگر گزینه یا آرگومان نامعتبری در خط فرمان وارد شده باشد؛
2
اگر خطایی از سوی Hamlib بازگردانده شود.

نمونه‌ای از یک بسته ارسالی چندپخشی (multicast) به تاریخ 2023-10-20:

{
  "app": "Hamlib",
  "version": "4.6~git 2023-10-20T16:52:59Z SHA=d87671",
  "seq": 183,
  "time": "2023-10-20T20:13:53.139869-0000",
  "crc": 0,
  "rig": {
    "id": "FLRig:127.0.0.1:12345:30508",
    "status": "OK",
    "errorMsg": "",
    "name": "FLRig",
    "split": false,
    "splitVfo": "VFOA",
    "satMode": false,
    "modelist": "AM CW USB LSB FM CWR PKTLSB PKTUSB "
  },
  "vfos": [
    {
      "name": "VFOA",
      "freq": 14074270,
      "mode": "PKTUSB",
      "width": 3,
      "ptt": false,
      "rx": true,
      "tx": true
    },
    {
      "name": "VFOB",
      "freq": 14074500,
      "mode": "",
      "width": 0,
      "ptt": false,
      "rx": false,
      "tx": false
    }
  ],
  "spectra": [
    {
      "id": 0,
      "name": "?",
      "type": "FIXED",
      "minLevel": 0,
      "maxLevel": 0,
      "minStrength": 0,
      "maxStrength": 0,
      "centerFreq": 0,
      "span": 0,
      "lowFreq": 0,
      "highFreq": 0,
      "length": 0,
      "data": ""
    }
  ]
}

این مستند به شکلی ناقص رها شده است.

این فایل بخشی از Hamlib است؛ پروژه‌ای برای توسعه کتابخانه‌ای که عملکردهای کنترل رادیو، روتاتور و تقویت‌کننده را برای توسعه‌دهندگان نرم‌افزارهای مرتبط با رادیوآماتوری و علاقه‌مندان به ارتباطات رادیویی تسهیل می‌کند.

کپی‌رایت © 2000-2011 Stephane Fillod
کپی‌رایت © 2000-2026 the Hamlib Group (مشارکت‌کنندگان مختلف)
کپی‌رایت © 2010-2026 Nate Bargmann

این یک نرم‌افزار آزاد است؛ برای شرایط تکثیر و کپی‌رایت فایل COPYING را ببینید. هیچ‌گونه ضمانتی وجود ندارد؛ حتی برای قابلیت فروش یا تناسب با یک هدف خاص.

rigctl(1), hamlib(7)

پیوندها به ویکی Hamlib، مخزن گیت، آرشیوهای انتشار و آرشیوهای اسنپ‌شات روزانه از طریق hamlib.org در دسترس است.

2026-02-14 Hamlib