Newer
Older
RobotCar / docs / 04_ENV / ENV_04_ディレクトリ構成.txt
========================================================================
ディレクトリ構成 (Directory Structure)
========================================================================


1. 概要 (Overview)
------------------------------------------------------------------------

    1-0. 目的

    自律走行システムのソースコードのディレクトリ構成を定義する.
    ディレクトリ構成を変更した場合は本ドキュメントも更新すること.

    1-1. 状態の表記

    ・(実装済み): ファイルが存在し,動作する状態.
    ・(未実装): 今後作成予定のファイル.
    ・表記なし: ディレクトリのみ作成済み.


2. ディレクトリ構成 (Directory Structure)
------------------------------------------------------------------------

    2-1. 全体構成

        RobotCar/
        ├── CLAUDE.md                      (実装済み)
        ├── requirements_pc.txt            (実装済み)
        ├── requirements_pi.txt            (実装済み)
        ├── docs/                          ドキュメント
        ├── src/                           自律走行用ソースコード
        │   ├── common/                    共通設定(PC・Pi 両方で使用)
        │   ├── pc/                        PC 側
        │   └── pi/                        Pi 側
        └── src_old/                       旧コード(参照用)

    2-2. src/common/

        common/
        └── config.py                      (未実装)

    ・PC・Pi 間で共有する設定値を定義する.
    ・内容: ネットワーク設定,画像フォーマット,通信設定等.

    2-3. src/pc/

        pc/
        ├── main.py                        (未実装) エントリーポイント
        ├── gui/                           GUI 関連
        │   └── main_window.py             (未実装) メインウィンドウ
        ├── comm/                          通信関連
        │   └── zmq_client.py              (未実装) ZMQ 送受信
        ├── steering/                      操舵量計算(独立モジュール)
        │   ├── base.py                    (未実装) 共通インターフェース
        │   └── pd_control.py              (未実装) PD 制御の実装
        └── vision/                        画像処理
            └── line_detector.py           (未実装) 線検出

    2-4. src/pi/

        pi/
        ├── main.py                        (未実装) エントリーポイント
        ├── comm/                          通信関連
        │   └── zmq_client.py              (未実装) ZMQ 送受信
        ├── camera/                        カメラ関連
        │   └── capture.py                 (未実装) フレーム取得
        └── motor/                         モーター関連
            └── driver.py                  (未実装) TB6612FNG 制御