cli.md

CLI利用ガイド

K5RX CLIのprimary commandはk5rxです。

開発repository内では:

uv run k5rx --help

PyPI公開後は:

uvx k5rx-tools --help

CLIのhelp/error/output自体はterminal encoding互換性を優先して英語で表示します。このdocumentでは典型的な操作を日本語で説明します。

Serial portを確認

k5rx radio ports

macOS例:

/dev/cu.usbserial-10

RadioはFirmware flashing modeではなく通常起動してください。

RAW backupを取得

k5rx radio read backup.raw --port /dev/cu.usbserial-10

このRAWは単なる一時fileではなく、その編集作業のbaselineです。

CSV importとRadio writeで同じfileを--baseとして指定します。

CSVをRadioから作る

k5rx csv export backup.raw channels.csv

Bank nameを含めない場合:

k5rx csv export backup.raw channels.csv --no-banks

CSVを空のtemplateから作る

k5rx csv template channels.csv

生成内容:

B1 ... B8
M001 ... M400

Bank rowを不要にする場合:

k5rx csv template channels.csv --no-banks

CSV validation

k5rx csv validate channels.csv

CSVはM001〜M400を全件必要とします。行不足errorが出た場合は、既存CSVへ手作業で不足行を追加するよりcsv templateから作り直すことを推奨します。

CSVをRAWへ反映

k5rx csv import channels.csv \
  --base backup.raw \
  --output updated.raw

--baseはhidden fieldを保持するために必要です。

backup.rawがない場合は、先に:

k5rx radio read backup.raw --port <PORT>

を実行してください。

Bank rowがCSVに存在していても現在のBank nameを保持したい場合:

k5rx csv import channels.csv \
  --base backup.raw \
  --output updated.raw \
  --no-banks

差分確認

k5rx eeprom diff backup.raw updated.raw

Radioへ書く前に必ず意図したMemory/Bankのみが変更されていることを確認することを推奨します。

RadioへWrite

k5rx radio write updated.raw \
  --base backup.raw \
  --port /dev/cu.usbserial-10

通常は次の確認が出ます。

Type WRITE to continue with EEPROM write:

WRITE以外を入力すると中止します。

--yesはCIや明示的なautomation向けです。通常の手操作では使用しないことを推奨します。

radio no longer matches --base image が出た場合

これは安全機能です。

backup.rawを取得した後にRadio EEPROMが変化しています。別ツールで変更した、Radio側の操作でEEPROMが更新された、古いbaselineを使用した、などが考えられます。

そのまま強制上書きせず、次の順でやり直してください。

k5rx radio read backup-new.raw --port <PORT>
k5rx csv import channels.csv --base backup-new.raw --output updated-new.raw
k5rx eeprom diff backup-new.raw updated-new.raw
k5rx radio write updated-new.raw --base backup-new.raw --port <PORT>

CSV must contain all 400 physical Memory slots が出た場合

k5rx csv template new-channels.csv

でcanonical templateを生成し、必要な内容を移してください。

RAW検証

k5rx eeprom validate backup.raw
k5rx eeprom inspect backup.raw
k5rx eeprom inspect backup.raw --memories

Schema mismatchの場合は、そのRAWを現在のSchema v2用writerへ使用しないでください。