Skip to content

API_USAGE.md

Latest commit

 

History

History
187 lines (135 loc) · 4.06 KB

API_USAGE.md

File metadata and controls

187 lines (135 loc) · 4.06 KB
Raw

FastAPI サーバー使用ガイド

セットアップ

1. 必要なパッケージのインストール

pip install fastapi uvicorn python-multipart

2. サーバーの起動

python api.py

サーバーは http://localhost:8000 で起動します。

ダッシュボード表示（推奨）

データを送信すると、自動的にサーバー側でHTMLダッシュボードに結果が表示されます。

ブラウザで開く：

http://localhost:8000/dashboard

ダッシュボードには以下が表示されます：

  • 左右モーターの最新スコア
  • 推奨ゲイン（Kp、Ki、Kd）
  • アドバイス
  • 左右バランス分析
  • スコア推移グラフ（複数の解析結果がある場合）

API エンドポイント

/analyze - POST

CSVファイルをアップロードして解析を実行します。

パラメータ

  • file (必須): CSVファイル
  • target_val (オプション): ターゲット値（デフォルト: 500.0）
  • kp_l, ki_l, kd_l (オプション): 左モーターのPIDゲイン
  • kp_r, ki_r, kd_r (オプション): 右モーターのPIDゲイン

手動でAPI呼び出しする場合

PowerShell:

# 実行ポリシーを一時的に許可
Set-ExecutionPolicy -ExecutionPolicy Bypass -Scope Process -Force

# 基本的な使い方
$form = @{ file = Get-Item "runlog.csv" }
$response = Invoke-WebRequest -Uri "http://localhost:8000/analyze" -Method Post -Form $form
$response.Content | ConvertFrom-Json | ConvertTo-Json -Depth 10

ターゲット値を指定:

$form = @{
    file = Get-Item "runlog.csv"
    target_val = "600"
}
$response = Invoke-WebRequest -Uri "http://localhost:8000/analyze" -Method Post -Form $form
$response.Content | ConvertFrom-Json | ConvertTo-Json -Depth 10

結果をファイルに保存:

$form = @{ file = Get-Item "runlog.csv" }
$response = Invoke-WebRequest -Uri "http://localhost:8000/analyze" -Method Post -Form $form
$response.Content | Out-File "result.json" -Encoding UTF8

Linux/Mac（curl使用）:

curl -X POST -F "file=@runlog.csv" http://localhost:8000/analyze | python -m json.tool

/dashboard - GET

ダッシュボードをブラウザで表示します。

http://localhost:8000/dashboard

機能：

  • 最新の解析結果を表示
  • 過去10件の結果を履歴として保存
  • スコア推移をグラフで表示
  • 見やすいUIで推奨ゲインとアドバイスを表示

レスポンス形式

{
  "timestamp": "2026-06-04T12:34:56.789012",
  "target_val": 500.0,
  "left_motor": {
    "score": 85.5,
    "max_speed": 520.3,
    "overshoot": 4.06,
    "steady_error": -2.5,
    "stable_std": 5.2,
    "rise_time": 0.123,
    "saturation_ratio": 15.3,
    "hunting_cycles": 2,
    "suggested_kp": 0.95,
    "suggested_ki": 0.05,
    "suggested_kd": 0.15,
    "advice": [
      "追従性は良好です"
    ]
  },
  "right_motor": {
    "score": 82.1,
    ...
  },
  "balance": {
    "left_avg_speed": 498.5,
    "right_avg_speed": 502.1,
    "diff_ratio": 0.72,
    "regression_a": 0.015,
    "regression_b": -1.5
  }
}

CSVファイル形式

必須列:

  • time: 時間（秒）
  • leftSpeed: 左モーター速度
  • rightSpeed: 右モーター速度
  • leftPower: 左モーター出力
  • rightPower: 右モーター出力

例:

time,leftSpeed,rightSpeed,leftPower,rightPower
0.0,0.0,0.0,0.0,0.0
0.1,50.2,49.8,25.5,24.8
0.2,100.5,101.2,51.0,50.5
...

トラブルシューティング

ポート 8000 が既に使用されている場合

別のポートで起動:

python -c "import uvicorn; from api import app; uvicorn.run(app, host='0.0.0.0', port=8001)"

その場合はcurlのURLを http://localhost:8001/analyze に変更してください。

ファイルが見つからない

CSVファイルがカレントディレクトリにあることを確認してください。 相対パスまたは絶対パスでファイルを指定してください。