> ## Documentation Index
> Fetch the complete documentation index at: https://docs.warmcore-tech.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Python API リファレンス

> X3 プレビューの Python インターフェースと制約

> **開発者向けプレビュー／ハードウェア未検証：** X3 ハードウェアおよび実機に展開されたロボットの実行環境は未検証です。ローカルテストだけでは、機器の互換性、物理的な動作、安全な運用を確認できません。

## `XiaolingClient`

ROS クライアントは、状態とテキスト結果に対するコールバックを提供します。コールバックを動作させるにはノードを Spin する必要があります。次の読み取り専用サンプルはデータをローカルに表示します。対話内容には個人情報が含まれる可能性があるため、適切な方針なしに共有ログへ記録しないでください。

```python theme={null}
import rclpy
from warmcore_xiaoling import XiaolingClient

rclpy.init()
node = XiaolingClient(on_status=print, on_text_result=print)
try:
    rclpy.spin(node)
finally:
    node.destroy_node()
    rclpy.shutdown()
```

`namespace` はクライアントの名前空間を指定します。デプロイ先の名前およびリマップと一致させてください。`send_text(text)` は空ではない文字列を送信して直ちに戻り、到達確認は行いません。`text_subscriber_count()` は探索結果であり、配信完了を示しません。`start_session(timeout_sec=5.0)` と `stop_session(timeout_sec=5.0)` はサービスを待機して非同期 Future を返します。ノードを Spin し、別途応答タイムアウトを設定して結果を確認してください。セッションやテキスト操作はロボットに影響するため担当者の承認が必要です。

## 読み取り専用 WebSocket クライアント

`warmcore_xiaoling.rosbridge.XiaolingRosbridgeClient` は、接続、対話状態とテキスト結果のサブスクライブ、受信、終了に対応します。クライアントの許可リストはサーバーを保護しません。実環境の通信とイベントは未検証です。診断手順は[サンプル](https://docs.warmcore-tech.com/jp/xiaoling-x3/v1/examples.md)を参照してください。


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.