メインコンテンツまでスキップ

REST/HTTP API

Limelight OSには(ipaddress):5807で実行されるREST/HTTPサーバーが搭載されています

LimelightLib PythonはLimelight HTTP/REST APIを利用するオープンソースライブラリです。

注意: 例 http://(limelight-ip-address):5807/results

一般​

メソッドルート説明
GET/results現在のターゲティング結果の完全なJSONダンプを取得
GET/status温度、fps、デバイス名、パイプラインインデックス、CPU使用率、RAM使用率を含むJSONステータスオブジェクトを取得
GET/hwreportハードウェアレポートの完全なJSON配列を返します。ハードウェアレポートにはFOV、プリンシパルオフセットなどの人間が読める情報が含まれています

パイプライン管理​

メソッドルート説明
GET/pipeline-defaultデフォルトパイプラインを取得（JSON）
GET/pipeline-atindexカメラからパイプライン[n]を取得（JSON）。ディスクからパイプラインをロードします。リクエストに「index」URLパラメータを含めてください。
POST/pipeline-switch別のパイプラインに切り替えます。リクエストに「index」URLパラメータを含めてください。
POST/reload-pipelineカメラに現在のパイプラインとすべてのパイプラインリソースを強制的に再読み込みさせます
POST/update-pipeline1つ以上の設定更新を含むJSONを受け入れます。これらの設定をディスクに保存するには、URLパラメータ「flush」を1に設定します。
POST/upload-pipelineパイプラインをアップロードします。リクエストボディにJSONデータを送信します。オプションで「index」パラメータを含めることができます。ディスク上のパイプラインを上書きします

カメラ管理​

メソッドルート説明
POST/set-imumodeIMUモードを設定（JSON）
POST/set-throttle熱管理のために処理されるフレーム間でスキップするフレーム数を設定
POST/set-imuassistalphaIMUアシストモードの相補フィルタアルファを設定（デフォルト0.001）

リソース管理​

メソッドルート説明
POST/upload-fieldmapフィールドマップをアップロードします。リクエストボディにJSONデータを送信します。オプションで「index」パラメータを含めることができます。
POST/upload-pythonPythonコードをアップロードします。リクエストボディにプレーンテキストとしてコードを送信します。オプションで「index」パラメータを含めることができます。
POST/upload-nnニューラルネットワークをアップロードします。「type」パラメータ（「detector」または「classifier」）を含め、リクエストボディにファイルの内容を含め、オプションで「index」パラメータを含めることができます。
POST/upload-nnlabelsニューラルネットワークラベルをアップロードします。「type」パラメータ（「detector」または「classifier」）を含め、リクエストボディにファイルを含め、オプションで「index」パラメータを含めることができます。
GET/getsnapscriptnamesSnapScriptPro名のリスト

Pythonとロボットのオリエンテーション​

メソッドルート説明
POST/update-pythoninputsSnapScriptパイプライン用のPython入力を更新します。リクエストボディにJSONデータ（配列）を送信します。
POST/update-robotorientationロボットのオリエンテーションを更新します。リクエストボディにJSONデータ（配列）を送信します。例：「[45,0,0,0,0,0]」。このメソッドを使用すると、再起動/リブートまでNetworkTablesベースのオリエンテーション更新が無効になります

キャリブレーション​

メソッドルート説明
GET/cal-defaultデフォルトのキャリブレーション結果を返します
GET/cal-fileカスタムキャリブレーション結果を返します（ファイルシステム）
GET/cal-eepromカスタムキャリブレーション結果を返します（EEPROM）
GET/cal-latest最新のカスタムキャリブレーション結果を返します。この結果はファイルシステムまたはEEPROMに保存されない限り使用されません
POST/cal-eepromEEPROMキャリブレーション結果を更新します。リクエストボディにキャリブレーションデータを送信します。
POST/cal-fileファイルシステムキャリブレーション結果を更新します。リクエストボディにキャリブレーションデータを送信します。
DELETE/cal-latest最新のキャリブレーション結果を削除します
DELETE/cal-eepromEEPROMキャリブレーション結果を削除します
DELETE/cal-fileファイルシステムキャリブレーション結果を削除します

スナップショット​

メソッドルート説明
POST/capture-snapshotスナップショットを撮影します。スナップショットに名前を付けるには「snapname」URLパラメータを含めてください。
POST/upload-snapshot名前付きスナップショットをアップロードします。「snapname」URLパラメータとリクエストボディに画像ファイルを含めてください。
GET/snapshotmanifestスナップショットファイル名のリストを返します
DELETE/delete-snapshotsすべてのスナップショットを削除します
DELETE/delete-snapshot特定のスナップショットを削除します。リクエストに「snapname」パラメータを含めてください。