Skip to main content

MSXシリアルターミナル

Project description

MSX Serial Terminal

MSXとのシリアル通信を行うターミナルプログラムです。

機能

  • MSXとのシリアル通信
  • 日本語文字の送受信(MSX文字コード対応)
  • ファイル送信機能
  • コマンド補完機能
  • カラー表示

必要条件

  • Python 3.9以上
  • 必要なパッケージ(pyproject.tomlに記載)

インストール方法

# パッケージのインストール
pip install msx-serial

開発環境のセットアップ

# リポジトリのクローン
git clone https://github.com/yamamo-to/msx-serial
cd msx-serial

# 仮想環境の作成と有効化
python -m venv venv
.\venv\Scripts\activate  # Windowsの場合
source venv/bin/activate  # Linuxの場合

# 開発モードでインストール
pip install -e . --use-pep517

使用方法

# 基本的な使用方法(--portは必須)
msx-serial --port COM3  # Windowsの場合
python -m msx_serial --port COM3  # 開発モードの場合

msx-serial --port /dev/tty.usbserial  # Linuxの場合
python -m msx_serial --port /dev/tty.usbserial  # 開発モードの場合

# ボーレートを指定
msx-serial --port COM3 --baudrate 115200  # Windowsの場合
python -m msx_serial --port COM3 --baudrate 115200  # 開発モードの場合

msx-serial --port /dev/tty.usbserial --baudrate 115200  # Linuxの場合
python -m msx_serial --port /dev/tty.usbserial --baudrate 115200  # 開発モードの場合

コマンドラインオプション

  • --port: シリアルポート(必須)
    • Windowsの場合: COM3など
    • Linuxの場合: /dev/tty.usbserialなど
  • --baudrate: ボーレート(デフォルト: 115200)
  • --encoding: エンコーディング(デフォルト: msx-jp)

開発モードでの実行

開発モードで実行する場合は、以下の手順に従ってください:

  1. リポジトリをクローン
git clone https://github.com/yamamo-to/msx-serial
cd msx-serial
  1. 仮想環境を作成して有効化
python -m venv venv
.\venv\Scripts\activate  # Windowsの場合
source venv/bin/activate  # Linuxの場合
  1. 依存関係をインストール
pip install -r requirements.txt
  1. 開発モードでインストール
pip install -e . --use-pep517
  1. プログラムを実行
python -m msx_serial

シリアルポートの確認方法

Windows

  1. デバイスマネージャーを開く
  2. 「ポート(COMとLPT)」を展開
  3. 「USB Serial Port (COM3)」などのポート名を確認

Linux

  1. ターミナルで以下のコマンドを実行
ls /dev/tty.*

コマンド一覧

  • @file: ファイルを選択して送信
  • @bytes: 16進数のバイト列を送信
  • @upload: ファイルをBase64エンコードしてアップロード
  • @exit: プログラムを終了

特殊キー

  • ^C: Ctrl+Cを送信
  • ^[: ESCキーを送信

文字コード対応

  • UTF-8からMSX文字コードへの変換
  • MSX文字コードからUTF-8への変換
  • グラフィックキャラクタ対応
  • 濁点・半濁点対応

依存関係

  • Python 3.9以上
  • colorama: ターミナルのカラー表示
  • prompt-toolkit: 対話型コマンドラインインターフェース
  • pyserial: シリアル通信
  • PyYAML: YAMLファイルの読み込み
  • chardet: 文字エンコーディングの検出
  • msx-charset: MSX文字コードの変換

謝辞

BASE64によるアップロードは下記の記事を参考にさせていただきました。 https://qiita.com/enu7/items/23cab122141fb8d07c6d

ライセンス

MIT License

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

msx_serial-0.1.4.dev0.tar.gz (12.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

msx_serial-0.1.4.dev0-py3-none-any.whl (12.3 kB view details)

Uploaded Python 3

File details

Details for the file msx_serial-0.1.4.dev0.tar.gz.

File metadata

  • Download URL: msx_serial-0.1.4.dev0.tar.gz
  • Upload date:
  • Size: 12.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.3

File hashes

Hashes for msx_serial-0.1.4.dev0.tar.gz
Algorithm Hash digest
SHA256 6203605951117df000eb38866818a45202727b0a730034632a13dda9a801ad0c
MD5 719f95079eaf02ab09357a375510aaa4
BLAKE2b-256 fb9d2892b404eecacd5965464e43ee9c379c7702eafdc19a28fb04991b47de4d

See more details on using hashes here.

File details

Details for the file msx_serial-0.1.4.dev0-py3-none-any.whl.

File metadata

File hashes

Hashes for msx_serial-0.1.4.dev0-py3-none-any.whl
Algorithm Hash digest
SHA256 77e27aa55034a85d98e520ebd62f17db6ea26d4900019876f205e5efcd721a49
MD5 036796f3b9a15b0ac495b84c78330fcb
BLAKE2b-256 289942accba2a99a23aed290bade8c3616bb7fb315245483aea0acfc6d4ab5f2

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page