開発者ガイド
このガイドは、ErisPulse の機能を拡張するためのカスタムモジュールやアダプターを開発する方法を説明します。
内容リスト
モジュール開発
- モジュール開発入門 - 最初のモジュールを作成する
- モジュールのコアコンセプト - モジュールのコアコンセプトとアーキテクチャ
- Event 包装クラスの詳細 - Event オブジェクトの完全な説明
- モジュールのベストプラクティス - 高品質なモジュールを開発するための提案
データモデル
- データモデル層(ORM) - 宣言的モデル、自動テーブル作成、追加・削除・更新・検索
アダプタ開発
- アダプタ開発入門 - 最初のアダプタを作成する
- アダプタのコアコンセプト - アダプタのコアコンセプト
- SendDSL 詳解 - Send メッセージ送信 DSL の完全な説明
- イベントコンバーター - イベントコンバーターの実装
- アダプタのベストプラクティス - 高品質なアダプタを開発するための提案
テストとトラブルシューティング
- モジュールテスト(ErisPulse-Testing) - TestBot、イベントファクトリー、アサーション面
- モジュールトラブルシューティングガイド - モジュールがロードされない / イベントが反応しない / コマンドがトリガーされない問題の解決方法
パブリッシングガイド
- パブリッシュとモジュールストアガイド - あなたの作品を PyPI および ErisPulse モジュールストアに公開する方法
開発の準備
開発を始める前に、以下の点を確認してください:
開発タイプの選択
ニーズに応じて、適切な開発タイプを選択してください。
| 開発タイプ | 適用シーン | 入門ガイド |
|---|---|---|
| モジュール開発 | ロボット機能の拡張、ビジネスロジックの実装、コマンドやメッセージ処理の提供 | モジュール開発入門 |
| アダプタ開発 | 新しいメッセージプラットフォームへの接続、クロスプラットフォーム通信の実現、プラットフォーム固有機能の提供 | アダプタ開発入門 |
ロボットの機能を拡張したい場合(コマンドの追加やメッセージ処理など)、モジュール開発を選択してください。ロボットを新しいプラットフォームに接続したい場合は、アダプタ開発を選択してください。
開発ツール
プロジェクトテンプレート
ErisPulse には、参考用のサンプルプロジェクトが用意されています:
開発モード
ホットリロードモードを使用して開発を行い、コードの変更後は自動的に再読み込みされます:
epsdk run main.py --reload
デバッグのコツ
config/config.toml で DEBUG または TRACE レベルのログを有効にします:
[ErisPulse.logger]
# DEBUG: モジュールのロード、ルートの登録などの開発デバッグ情報を出力
# TRACE: 最低レベルで、イベントの配信、ストレージへの書き込み、遅延ロードなどのフレームワーク内部の詳細なフローを出力
level = "DEBUG"
モジュールの公開
完全な公開フローについては、公開とモジュールストアのガイドを参照してください。PyPI での公開手順や ErisPulse モジュールストアへの提出プロセスなども含まれています。
関連ドキュメント
- 標準規格 - 兼容性を確保するための技術基準
- プラットフォーム特性ガイド - 各プラットフォームアダプタの特性について学ぶ