入門ガイド
Tip
この記事を読むタイミング:ロボットが 5 分鐘のクイックスタート で起動している場合、フレームワークのコアコンセプトと一般的な機能を体系的に理解したい場合に読んでください。まだ起動していない場合は、まずクイックスタートを完了してください。特定の問題を検索したい場合は、対応する個別記事に直接ジャンプしてください。
ロボットが起動した後、ここではフレームワークのコアコンセプトと一般的な機能を体系的に理解するためのガイドを提供します。
学習パス
以下はドキュメントのトップページで定義された L1 コアの5つの主要なドキュメントです。これらを順番に読むことで(約1–2時間)、90%の機能を独自に開発できます。
| ステップ | 主題 | 説明 |
|---|---|---|
| 1 | モジュール開発入門 | 独立したモジュールパッケージを作成し、モジュールの構造と登録メカニズムを理解する |
| 2 | 基本概念 | ErisPulse のコアアーキテクチャとモジュール設計を理解する |
| 3 | Event 包装クラス | イベントオブジェクトの返信、要求、およびフィールドへのアクセスを習得する |
| 4 | 設定ファイルの説明 | 設定を記入し、ホットアップデートと環境変数による上書きを理解する |
| 5 | 例外のキャッチ | フレームワークの例外階層を認識し、クラッシュしない処理チェーンを書く |
このディレクトリには、必要に応じて参照できる追加のドキュメントも含まれています。
| ドキュメント | いつ読むか |
|---|---|
| 最初のロボットを作成する | モジュール化開発を学ぶ前に、まず埋め込み型のプロセッサを書いてみたい場合 |
| イベント処理入門 | イベントの種類(メッセージ / コマンド / 通知 / 要求)に応じた処理方法を迅速に確認したい場合 |
| 一般的なタスクの例 | ストレージ、定期タスク、権限制御の既存の完全なコードをコピーしたい場合 |
| IDE補完ガイド | プラットフォーム固有のメソッドのIDE自動補完をしたい場合 |
開発方法の選択
ErisPulse は以下の2つの開発方法をサポートしています。
| 方法 | 適用シーン | 説明 |
|---|---|---|
| 埋め込み開発 | プロトタイプ作成、プロジェクト内の機能 | main.py にプロセッサを直接記述し、独立したモジュールを作成する必要はありません。 |
| モジュール開発(推奨) | 本番環境、機能の配布 | 独立した Python パッケージを作成し、epsdk install を使用してインストールして使用します。 |
両方の方法の詳細な比較と例については、最初のロボットを作成する および モジュール開発の入門 を参照してください。
アーキテクチャ概要
ErisPulse はイベント駆動アーキテクチャを採用しており、以下の主要なシステムで構成されています。
- アダプタシステム — 各プラットフォームとの通信を行い、プラットフォームのイベントを統一された OneBot12 標準形式に変換します。
- イベントシステム — メッセージ、コマンド、通知、リクエスト、メタイベントの5種類のイベントを処理します。
- モジュールシステム — 独立したモジュールにより機能を拡張でき、依存管理や遅延読み込みをサポートします。
- コアモジュール — Storage(ストレージ)、Config(設定)、Logger(ログ)、Router(ルーティング)などの基本的な機能を提供します。
詳細なアーキテクチャ図と初期化の流れについては、アーキテクチャ概要 をご参照ください。
次のステップ
上記の学習パス(L1 コアの5つの記事)の順序に従って読むことができます。目的に応じて直接ジャンプすることも可能です。
- まずは実践したい:最初のロボットを作成するから始めて、最初の
/helloコマンドハンドラを書き、次に モジュール開発の入門に進んでください。 - まずは原理を理解したい:基本概念を読んで、アダプター / モジュール / イベントがどのように連携するかを理解してください。
- 具体的な問題を解決したい:一般的なタスクの例を参照してください。ストレージ、定期的なタスク、権限制御など、そのままコピーできる完全なコード例が用意されています。
- L1の5つの記事を読了した後:必要に応じて 高度なトピック を参照してください。複雑なモジュールについては、まずその中のL2必読の4つの記事から始めてください。