ErisPulse ErisPulse
Открыть интерактивную версию →
Разделы страницы
name: erispulse-ecosystem description: "适用于:了解生态组件(Dashboard/Cron/AI 模块等)与各平台适配器的接入差异。覆盖场景:Сама платформа ErisPulse предоставляет только основные возможности (система событий, система модулей, конфигурация, маршрутизация, логирование и т.д.), не включая в себя такие "тяжелые" функции, как GUI, рендеринг изображений, визуализация и т.д. Эти возможности предоставляются третьими сторонами и поддерживаются сообществом, и устанавливаются по мере необходимости.。Когда это нужно читать: Когда вы хотите использовать веб-интерфейс для визуального управления роботом (включение/выключение модулей, редактирование конфигурации, просмотр логов, мониторинг потоков событий), или хотите зарегистрировать страницу управления для своего модуля. Если не нужно — пропустите.。Когда стоит читать этот документ: когда вашему модулю требуется логика запуска по расписанию или с задержкой (напоминания по расписанию, периодический мониторинг, планирование по Cron-выражениям), и вы хотите, чтобы задачи не терялись после перезапуска фреймворка. Если это не ваш сл..." 内容大纲 生态总览 Рекомендуемые модули ErisPulse-Dashboard: панель управления в браузере ErisPulse-Cron: задачи по расписанию ErisPulse-QvQChat: универсальный агент ErisPulse-ApiMCP: позвольте ИИ-клиентам управлять ботом ErisPulse-Takumi: рендеринг изображений Официальный клиент (независимое приложение) ErisPulse-App: запуск бота прямо на телефоне Я тоже хочу добавить свой модуль сюда? Dashboard Принцип работы API регистрации Описание параметров Два режима встраивания Режим 1: HTML/JS встраивание (рекомендуется) Режим 2: Встраивание с помощью iframe Группировка в боковой панели Распространённые CSS-классы Аутентификация и вызов API Полный пример модуля Удаление визуального окна Примечания Дальнейшие шаги 定时任务 Краткий обзор возможностей Быстрый старт Обзор API Создание задач Колбэки Управление задачами Политика пропущенных запусков (missed_policy) Поведение при выгрузке модуля Полезные ссылки Следующие шаги AI 对话模块 Основные возможности Расширение через модули Глубокая интеграция (опционально) Моменты обновления Подписка на события Вызов в качестве службы Сопутствующие плагины Интерфейс Следующие шаги MCP 桥 Принцип работы Подключение Claude Desktop Обзор 14 инструментов Ключевые моменты безопасности Далее 平台指南索引 Платформенные функции Общие интерфейсы Цепочка вызовов Send Слушатели событий Стандартные форматы Стандартный формат событий Стандартный формат ответа Ссылки Участие в разработке
Статическое зеркало — интерактивная версия является основной Открыть интерактивную версию →

name: erispulse-ecosystem description: "适用于:了解生态组件(Dashboard/Cron/AI 模块等)与各平台适配器的接入差异。覆盖场景:Сама платформа ErisPulse предоставляет только основные возможности (система событий, система модулей, конфигурация, маршрутизация, логирование и т.д.), не включая в себя такие "тяжелые" функции, как GUI, рендеринг изображений, визуализация и т.д. Эти возможности предоставляются третьими сторонами и поддерживаются сообществом, и устанавливаются по мере необходимости.。Когда это нужно читать: Когда вы хотите использовать веб-интерфейс для визуального управления роботом (включение/выключение модулей, редактирование конфигурации, просмотр логов, мониторинг потоков событий), или хотите зарегистрировать страницу управления для своего модуля. Если не нужно — пропустите.。Когда стоит читать этот документ: когда вашему модулю требуется логика запуска по расписанию или с задержкой (напоминания по расписанию, периодический мониторинг, планирование по Cron-выражениям), и вы хотите, чтобы задачи не терялись после перезапуска фреймворка. Если это не ваш сл..."

ErisPulse 生态与多平台

This skill is auto-built from the ErisPulse documentation. Repository: https://github.com/ErisPulse/ErisPulse Source paths are annotated per section; see docs/ in the repository for the latest content.

内容大纲

AI 按需读取:只读需要的章节即可,不必全文加载。

  • 生态总览: 59-78 行
  • Рекомендуемые модули: 80-130 行
  • Официальный клиент (независимое приложение): 132-140 行
  • Я тоже хочу добавить свой модуль сюда?: 142-150 行
  • Dashboard: 152-179 行
  • Принцип работы: 181-192 行
  • API регистрации: 194-232 行
  • Два режима встраивания: 234-267 行
  • Группировка в боковой панели: 269-295 行
  • Распространённые CSS-классы: 297-332 行
  • Аутентификация и вызов API: 334-356 行
  • Полный пример модуля: 358-468 行
  • Удаление визуального окна: 470-482 行
  • Примечания: 484-494 行
  • Дальнейшие шаги: 496-500 行
  • 定时任务: 502-522 行
  • Краткий обзор возможностей: 524-533 行
  • Быстрый старт: 535-553 行
  • Обзор API: 555-610 行
  • Поведение при выгрузке модуля: 612-619 行
  • Полезные ссылки: 621-626 行
  • Следующие шаги: 628-632 行
  • AI 对话模块: 634-652 行
  • Основные возможности: 654-673 行
  • Расширение через модули: 675-745 行
  • Подписка на события: 747-759 行
  • Вызов в качестве службы: 761-767 行
  • Сопутствующие плагины: 769-779 行
  • Интерфейс: 781-789 行
  • Следующие шаги: 791-796 行
  • MCP 桥: 798-816 行
  • Принцип работы: 818-829 行
  • Подключение Claude Desktop: 831-849 行
  • Обзор 14 инструментов: 851-861 行
  • Ключевые моменты безопасности: 863-870 行
  • Далее: 872-876 行
  • 平台指南索引: 878-895 行
  • Платформенные функции: 897-923 行
  • Общие интерфейсы: 925-1105 行
  • Стандартные форматы: 1107-1163 行
  • Ссылки: 1165-1176 行
  • Участие в разработке: 1178-1187 行

生态总览

来源: docs/ru/ecosystem/README.md(https://github.com/ErisPulse/ErisPulse/blob/main/docs/ru/ecosystem/README.md)

Экологические модули

Сама платформа ErisPulse предоставляет только основные возможности (система событий, система модулей, конфигурация, маршрутизация, логирование и т.д.), не включая в себя такие "тяжелые" функции, как GUI, рендеринг изображений, визуализация и т.д. Эти возможности предоставляются третьими сторонами и поддерживаются сообществом, и устанавливаются по мере необходимости.

Important

Документация в этом разделе делится на два типа, способ установки которых различается:

  • Модули (например, Dashboard / Takumi) устанавливаются с помощью epsdk install:

    epsdk install <имя_модуля>
    
  • Отдельные программы (например, клиент ErisPulse-App) устанавливаются напрямую из GitHub Releases, без использования epsdk.


Рекомендуемые модули

ErisPulse-Dashboard: панель управления в браузере

Бот висит на сервере, а для запуска/остановки модулей, изменения конфигурации и просмотра логов по-прежнему нужно заходить в терминал? Dashboard переносит всё это в браузер: запуск и остановка модулей, редактирование конфигурации, просмотр логов, мониторинг событий; другие модули также могут регистрировать собственные окна в боковой панели — все страницы управления собраны в одном месте.

epsdk install Dashboard

Документация: Использование Dashboard и регистрация окон | Домашняя страница проекта: PyPI

ErisPulse-Cron: задачи по расписанию

Хотите ежедневно в определённое время отправлять напоминания о чек-ине, запускать периодические задачи по Cron-выражению или опрашивать данные каждые несколько минут? Cron предоставляет три типа задач: однократные / интервальные / по Cron-выражению, с передачей аргументов в колбэки и сохранением в SQLite (задачи не теряются после перезапуска).

epsdk install Cron

Документация: Задачи по расписанию Cron | Домашняя страница проекта: GitHub

ErisPulse-QvQChat: универсальный агент

Хотите, чтобы в группе был ИИ-ассистент, который действительно работает, а не просто отвечает по ключевым словам? QvQChat — это универсальный агент: цикл инструментов охватывает отправку/получение сообщений / выполнение кода / управление компьютером / генерацию изображений / голос / MCP / суб-агентов, поддерживает потоковый диалог и последовательное воспроизведение инструментов, имеет встроенное окно Dashboard. Также есть три сопутствующих плагина: QvQStalker (подслушивает и вставляет реплики), QvQMemes (мемы), QvQCompanion (очеловеченное общение).

epsdk install ErisPulse-QvQChat

Документация: Агент QvQChat | Домашняя страница проекта: GitHub

ErisPulse-ApiMCP: позвольте ИИ-клиентам управлять ботом

Пользуетесь ИИ-клиентами с поддержкой MCP, такими как Claude Desktop или Claude Code? ApiMCP наоборот открывает рантайм бота в виде 14 инструментов MCP: ИИ может напрямую отправлять и получать сообщения за вас, вызывать установленные модули, просматривать статус платформ, подписываться на события групповых чатов — бот становится «руками и глазами» ИИ.

epsdk install ErisPulse-ApiMCP

Документация: Руководство по использованию ApiMCP | Домашняя страница проекта: GitHub

ErisPulse-Takumi: рендеринг изображений

Для сценариев, где нужно «отправлять картинки» — таблицы лидеров, отчёты о сражениях, карточки расписаний — достаточно написать шаблон, отрендерить его в изображение и отправить в группу: поддерживает HTML / дерево узлов / Jinja / SVG / анимацию (на основе takumi-py), со встроенными китайскими и английскими шрифтами, работает сразу из коробки.

epsdk install Takumi

Документация: Рендеринг изображений Takumi | Домашняя страница проекта: GitHub (автор @ccd2s)

Официальный клиент (независимое приложение)

ErisPulse-App: запуск бота прямо на телефоне

Нет постоянного сервера, но вы хотите создавать экземпляры, устанавливать модули и просматривать поток событий в любое время? ErisPulse-App — это официальный клиент для всех платформ (Android / Windows / Linux / macOS): создание / запуск / управление несколькими экземплярами ботов с помощью родного интерфейса, встроенный магазин модулей и конструктор событий, запуск прямо с телефона, постоянное присутствие в системном трее на рабочем столе.

Скачайте установочные пакеты для всех платформ с GitHub Releases, для этого не требуется epsdk.

Документация: Установка и использование ErisPulse-App

Я тоже хочу добавить свой модуль сюда?

Добро пожаловать, чтобы рекомендовать качественные, повторно используемые модули экосистемы ErisPulse. Требования:

  1. Опубликован на PyPI, и имя пакета начинается с ErisPulse-
  2. Предоставляет базовый README и примеры использования
  3. Активно поддерживается, с ответами на Issue

Авторы модулей, соответствующих вышеуказанным условиям, могут добавить документ <имя_модуля>.md в этом каталоге через PR и дополнить соответствующий раздел в рекомендованном списке вверху.

Dashboard

来源: docs/ru/ecosystem/dashboard.md(https://github.com/ErisPulse/ErisPulse/blob/main/docs/ru/ecosystem/dashboard.md)

ErisPulse-Dashboard

Tip

Когда это нужно читать: Когда вы хотите использовать веб-интерфейс для визуального управления роботом (включение/выключение модулей, редактирование конфигурации, просмотр логов, мониторинг потоков событий), или хотите зарегистрировать страницу управления для своего модуля. Если не нужно — пропустите.

ErisPulse-Dashboard — это веб-панель управления, поддерживаемая ErisDev, которая предоставляет визуальный интерфейс для управления ErisPulse в режиме выполнения: включение/выключение модулей, редактирование конфигурации, просмотр логов, мониторинг потоков событий и т.д.

Important

Dashboard не является встроенной функцией фреймворка ErisPulse, его нужно устанавливать отдельно:

epsdk install Dashboard

Dashboard также поддерживает регистрацию пользовательских страниц управления другими модулями ErisPulse в боковой панели. После регистрации пользователь может напрямую переключиться на специальную визуальную страницу модуля в Dashboard, без необходимости дополнительного разработки отдельного пользовательского интерфейса.

Note

Регистрация визуальных окон — это необязательная функция.

  • Если модуль Dashboard не установлен или не загружен, вызов sdk.Dashboard.register_view() вызовет исключение
  • Обязательно используйте try/except для обертывания кода регистрации, чтобы убедиться, что другие функции модуля не будут затронуты
  • Рекомендуется проверять доступность Dashboard перед регистрацией: hasattr(sdk, 'Dashboard') and sdk.Dashboard

Принцип работы

Модуль on_load()
  → вызов sdk.Dashboard.register_view(...)
  → Dashboard сохраняет информацию о визуальном окне
  → WebSocket уведомляет клиент
  → Клиент динамически создает элемент навигации в боковой панели + контейнер страницы
  → Пользователь может переключиться на страницу модуля

API регистрации

sdk.Dashboard.register_view(
    id="MyModule",                    # Обязательный, уникальный идентификатор
    title="Мой модуль",                  # Название на китайском
    title_en="My Module",             # Название на английском
    icon_svg='<svg>...</svg>',        # SVG-иконка для боковой панели
    html_content='<div>...</div>',     # HTML-контент страницы
    js_content='function xxx() {}',    # JavaScript-логика страницы
    css_content='.my-style {}',        # Необязательный пользовательский CSS
    iframe_url='',                     # URL для режима iframe (один из двух: html_content или iframe_url)
    loader="loadMyModuleView",         # Имя функции JavaScript, вызываемой при переключении на страницу
    group="group_extensions",          # Группа в боковой панели
    group_title="",                    # Название группы на китайском
    group_title_en="",                 # Название группы на английском
)

Описание параметров

Параметр Тип Обязательно Описание
id str Да Уникальный идентификатор визуального окна, рекомендуется использовать название модуля
title str Нет Название для отображения на китайском, по умолчанию используется id
title_en str Нет Название для отображения на английском, по умолчанию используется title
icon_svg str Нет Полная строка SVG-иконки для боковой панели
html_content str Нет* HTML-контент страницы в режиме встраивания
js_content str Нет JavaScript-код страницы
css_content str Нет Пользовательский CSS-стиль страницы
iframe_url str Нет* URL для режима iframe, при указании игнорируется html_content
loader str Нет Имя функции JavaScript, вызываемой при активации страницы
group str Нет Идентификатор группы в боковой панели, по умолчанию group_extensions
group_title str Нет Название группы на китайском
group_title_en str Нет Название группы на английском

*Обязательно указывать либо html_content, либо iframe_url, иначе страница будет пустой.


Два режима встраивания

Режим 1: HTML/JS встраивание (рекомендуется)

Предоставляйте HTML, JS и CSS напрямую, Dashboard вставит содержимое на страницу. Этот режим полностью соответствует стилям Dashboard, рекомендуется использовать CSS-классы, предоставляемые Dashboard.

sdk.Dashboard.register_view(
    id="HelloPage",
    title="Привет страница", title_en="Hello",
    icon_svg='<svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2"><circle cx="12" cy="12" r="10"/></svg>',
    html_content='<h1 class="page-title">Hello World</h1><div class="card"><div class="card-body">Это пример страницы</div></div>',
    group="group_tools",
)

Полный пример модуля погоды (с API-маршрутами, JS-взаимодействием и т.д.) см. ниже Полный пример модуля.

Режим 2: Встраивание с помощью iframe

Модуль предоставляет URL своей HTML-страницы (необходимо зарегистрировать маршрут), Dashboard встраивает её в iframe. Подходит для сценариев с полностью независимым UI или сложным взаимодействием.

sdk.Dashboard.register_view(
    id="MyVisualizer",
    title="Визуализация данных", title_en="Data Visualizer",
    iframe_url="/MyVisualizer/view",
    group="group_tools",
)

В режиме iframe автоматически добавляется параметр token в URL для аутентификации.


Группировка в боковой панели

Модуль может указать группу, в которой будет отображаться визуальное окно. Dashboard предоставляет следующие встроенные группы:

Идентификатор группы Название на китайском Позиция
group_overview Обзор 1-я группа
group_events События 2-я группа
group_extensions Расширения 3-я группа (по умолчанию)
group_system Система 4-я группа
group_tools Инструменты 5-я группа

Указав идентификатор встроенной группы, визуальное окно будет добавлено в конец этой группы:

group="group_tools"  # Добавление в группу "Инструменты"

Также можно использовать пользовательские идентификаторы групп (не начинающиеся с group_), Dashboard автоматически создаст новую группу:

group="my_group",
group_title="Моя группа",
group_title_en="My Group",

Распространённые CSS-классы

При использовании режима встраивания HTML, можно напрямую использовать CSS-классы, предоставленные Dashboard, для обеспечения визуальной согласованности:

Класс Назначение
page-title Заголовок страницы, например <h1 class="page-title">Заголовок</h1>
card Контейнер карточки
card-header Заголовок карточки
card-body Тело карточки
grid-2 Двухколоночный макет сетки
grid-3 Трёхколоночный макет сетки
btn Базовая кнопка
btn-primary Основная кнопка (синяя)
btn-secondary Второстепенная кнопка
btn-icon Кнопка с иконкой
btn-danger Кнопка опасного действия

Dashboard использует CSS-переменные для управления темой, которые можно использовать в модуле:

CSS-переменная Назначение
var(--bg-p) Основной фон
var(--bg-s) Вторичный фон
var(--bg-t) Третичный фон (карточки и т.д.)
var(--tx-p) Основной цвет текста
var(--tx-s) Вторичный цвет текста
var(--tx-t) Вспомогательный цвет текста
var(--bd) Цвет границы
var(--accent) Акцентный цвет
var(--ok-c) Цвет успеха
var(--er-c) Цвет ошибки

Эти переменные автоматически переключаются между светлой и тёмной темами Dashboard, модулю не нужно дополнительно обрабатывать.


Аутентификация и вызов API

При вызове API модуля из JavaScript визуального окна необходимо передавать токен Dashboard для аутентификации:

var token = localStorage.getItem('__ep_tk__');
var resp = await fetch('/YourModule/api/data', {
    headers: { 'Authorization': 'Bearer ' + token }
});
var data = await resp.json();

API-точки модуля могут самостоятельно решать, нужно ли проверять токен. Если нужно проверить, можно извлечь его из заголовка:

async def _api_data(self, request):
    token = request.headers.get("Authorization", "").replace("Bearer ", "")
    if not token:
        return {"error": "Unauthorized"}, 401
    return {"data": "hello"}

Полный пример модуля

Ниже приведён полный пример модуля погоды, демонстрирующий регистрацию визуального окна, предоставление данных API и очистку ресурсов при выгрузке:

from ErisPulse import sdk
from ErisPulse.Core.Bases import BaseModule
from ErisPulse.Core.Event import command


class Main(BaseModule):
    def __init__(self):
        self.sdk = sdk
        self.logger = sdk.logger.get_child("Weather")
        self.config = self._load_config()

    @staticmethod
    def get_load_strategy():
        from ErisPulse.loaders import ModuleLoadStrategy
        return ModuleLoadStrategy(lazy_load=False, priority=50)

    async def on_load(self, event):
        self._register_routes()
        self._register_dashboard_view()
        self.logger.info("Модуль погоды загружен")

    async def on_unload(self, event):
        self._unregister_routes()
        if hasattr(self.sdk, 'Dashboard') and self.sdk.Dashboard:
            self.sdk.Dashboard.unregister_view("Weather")
        self.logger.info("Модуль погоды выгружен")

    def _load_config(self):
        config = self.sdk.config.getConfig("Weather")
        if not config:
            default = {"city": "Пекин", "api_key": ""}
            self.sdk.config.setConfig("Weather", default)
            return default
        return config

    def _register_routes(self):
        r = self.sdk.router
        r.register_http_route("Weather", "/api/current",
                              handler=self._api_current, methods=["GET"])

    def _unregister_routes(self):
        r = self.sdk.router
        try:
            r.unregister_http_route("Weather", "/api/current")
        except Exception:
            pass

    async def _api_current(self, request):
        return {
            "city": self.config.get("city", "Пекин"),
            "temp": 25,
            "humidity": 60,
        }

    def _register_dashboard_view(self):
        try:
            dashboard = self.sdk.Dashboard
            dashboard.register_view(
                id="Weather",
                title="Погода", title_en="Weather",
                icon_svg='<svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2"><circle cx="12" cy="12" r="5"/><line x1="12" y1="1" x2="12" y2="3"/><line x1="12" y1="21" x2="12" y2="23"/><line x1="4.22" y1="4.22" x2="5.64" y2="5.64"/><line x1="18.36" y1="18.36" x2="19.78" y2="19.78"/><line x1="1" y1="12" x2="3" y2="12"/><line x1="21" y1="12" x2="23" y2="12"/><line x1="4.22" y1="19.78" x2="5.64" y2="18.36"/><line x1="18.36" y1="5.64" x2="19.78" y2="4.22"/></svg>',
                html_content='''
                    <h1 class="page-title">Погодный запрос</h1>
                    <p style="color:var(--tx-s);margin-bottom:16px">Просмотр текущей погоды</p>
                    <div class="grid-2">
                        <div class="card">
                            <div class="card-header">Текущая погода</div>
                            <div class="card-body">
                                <div id="weather-info" style="font-size:14px;color:var(--tx-s)">Нажмите, чтобы обновить</div>
                            </div>
                        </div>
                        <div class="card">
                            <div class="card-header">Действия</div>
                            <div class="card-body">
                                <button class="btn btn-primary" onclick="refreshWeather()">Обновить</button>
                            </div>
                        </div>
                    </div>
                ''',
                js_content='''
                    async function loadWeatherView() { await refreshWeather(); }
                    async function refreshWeather() {
                        var el = document.getElementById('weather-info');
                        if (!el) return;
                        el.textContent = 'Загрузка...';
                        try {
                            var resp = await fetch('/Weather/api/current', {
                                headers: { 'Authorization': 'Bearer ' + localStorage.getItem('__ep_tk__') }
                            });
                            var data = await resp.json();
                            el.innerHTML = '<p>Город: ' + (data.city || '--') + '</p>' +
                                           '<p>Температура: ' + (data.temp || '--') + '°C</p>' +
                                           '<p>Влажность: ' + (data.humidity || '--') + '%</p>';
                        } catch (e) {
                            el.textContent = 'Загрузка не удалась: ' + e.message;
                        }
                    }
                ''',
                loader="loadWeatherView",
                group="group_tools",
            )
        except Exception as e:
            self.logger.warning(f"Регистрация визуального окна Dashboard не удалась: {e}")

Удаление визуального окна

При выгрузке модуля следует вызвать unregister_view() для удаления зарегистрированного визуального окна:

async def on_unload(self, event):
    if hasattr(self.sdk, 'Dashboard') and self.sdk.Dashboard:
        self.sdk.Dashboard.unregister_view("Weather")

После удаления Dashboard будет удалять элементы навигации и контент в реальном времени через WebSocket, без необходимости обновления страницы.


Примечания

  1. Порядок загрузки — Dashboard загружается с приоритетом 99999 (очень высокий приоритет), приоритет вашего модуля должен быть ниже, например 50, чтобы убедиться, что Dashboard загружен первым
  2. Защитное программирование — оберните код регистрации визуального окна в try/except, потому что модуль Dashboard может не быть установлен или загружен
  3. Очистка ресурсов — в on_unload вызовите unregister_view(), чтобы удалить зарегистрированное визуальное окно
  4. Уникальность ID — параметр id должен быть уникальным во всём Dashboard, рекомендуется использовать имя модуля
  5. SVG-иконки — icon_svg должен быть полной строкой <svg>, рекомендуется использовать viewBox="0 0 24 24", и использовать stroke="currentColor" для наследования темы Dashboard
  6. Имена функций JS — имена функций в js_content должны быть уникальными (например, loadWeatherView), чтобы избежать конфликтов с другими модулями
  7. Динамическое обновление — после регистрации/удаления визуального окна Dashboard будет обновлять боковую панель в реальном времени через WebSocket, без необходимости обновления страницы

Дальнейшие шаги

定时任务

来源: docs/ru/ecosystem/cron.md(https://github.com/ErisPulse/ErisPulse/blob/main/docs/ru/ecosystem/cron.md)

ErisPulse-Cron

Tip

Когда стоит читать этот документ: когда вашему модулю требуется логика запуска по расписанию или с задержкой (напоминания по расписанию, периодический мониторинг, планирование по Cron-выражениям), и вы хотите, чтобы задачи не терялись после перезапуска фреймворка. Если это не ваш случай — пропустите.

ErisPulse-Cron — это модуль планирования задач по расписанию в экосистеме ErisPulse, предоставляющий другим модулям единый API для работы с отложенными задачами: поддерживает три типа задач — однократный запуск по времени, циклический запуск с интервалом и Cron-выражения, передачу параметров в колбэки, а также персистентность в SQLite (задачи не теряются после перезапуска).

Important

Cron не является встроенной функциональностью фреймворка ErisPulse и требует отдельной установки:

epsdk install Cron

После установки весь API доступен через sdk.Cron.


Краткий обзор возможностей

  • Три типа расписания: однократный запуск (once), циклический запуск с интервалом (interval), Cron-выражения (cron)
  • Передача параметров в колбэки: при создании передаётся callback_data, которая при срабатывании возвращается без изменений — это удобно для определения источника задачи
  • Персистентность: задачи хранятся в SQLite (через sdk.storage) и автоматически восстанавливаются после перезапуска фреймворка
  • Политика пропущенных запусков: немедленный запуск / пропуск / перепланирование — выбирается отдельно для каждой задачи
  • Управление задачами: пауза, возобновление, отмена, ручной запуск, очистка устаревших задач
  • Интеграция с Dashboard: при установленном ErisPulse-Dashboard панель управления регистрируется автоматически

Быстрый старт

from ErisPulse import sdk

# 1. Регистрация обработчика колбэка
@sdk.Cron.on_trigger
async def handle_trigger(info):
    data = info["callback_data"]
    print(f"Задача сработала: {info['task_id']}, данные: {data}")

# 2. Создание задачи по расписанию
task_id = sdk.Cron.once(
    delay=60,
    callback_data={"type": "reminder", "msg": "Пора попить воды"},
)

Обзор API

Создание задач

# Однократная задача: срабатывает с задержкой 600 секунд
sdk.Cron.once(delay=600, callback_data={"order_id": "123"}, label="Напоминание о таймауте заказа")

# Циклическая задача: срабатывает каждые 300 секунд, максимум 100 раз
sdk.Cron.interval(interval_seconds=300, callback_data={"monitor": "server-1"}, max_runs=100)

# Cron-выражение: по будням каждый день в 9:30
sdk.Cron.cron(expression="30 9 * * 1-5", callback_data={"type": "daily_report"})

# Общие необязательные параметры: trigger_at (абсолютная временная метка), delay (задержка первого запуска), timezone,
# max_runs (0=бесконечно), label, source (имя модуля-создателя), missed_policy (политика пропущенных запусков)

Распространённые Cron-выражения: */5 * * * * (каждые 5 минут), 0 8 * * * (каждый день в 8 утра), 30 9 * * 1-5 (по будням в 9:30), 0 0 1 * * (1-го числа каждого месяца).

Колбэки

@sdk.Cron.on_trigger
async def my_handler(info):
    # info содержит task_id / task_type / callback_data / label / source /
    # run_count / max_runs / created_at / last_run / trigger_time
    ...

Поддерживается регистрация нескольких обработчиков (handler); все они вызываются по очереди, и исключение в одном из них не влияет на работу остальных.

Управление задачами

sdk.Cron.cancel(task_id)                  # Отмена
sdk.Cron.pause(task_id)                   # Пауза
sdk.Cron.resume(task_id)                  # Возобновление (reschedule=True пересчитывает время следующего запуска)
await sdk.Cron.trigger_now(task_id)       # Ручной немедленный запуск (не влияет на исходное расписание)
sdk.Cron.get_task(task_id)                # Просмотр отдельной задачи
sdk.Cron.list_tasks(source="MyModule")    # Список задач (поддерживается фильтрация по source/status/task_type)
sdk.Cron.delete_task(task_id)             # Удаление записи задачи
sdk.Cron.cleanup()                        # Очистка выполненных/отменённых задач старше 7 дней

Политика пропущенных запусков (missed_policy)

После перезапуска фреймворка для задач, у которых было пропущено время срабатывания:

Политика Поведение
fire_immediately Немедленный запуск (по умолчанию)
skip Пропустить текущий запуск и ждать следующего
reschedule Пересчитать время следующего запуска от текущего момента

Поведение при выгрузке модуля

Данные задач Cron являются персистентным активом: выгрузка или отключение модуля-создателя задачи не приводит к удалению уже созданных задач. Однако зарегистрированные этим модулем обработчики колбэков будут очищены — благодаря хукам внешней очистки на основе системы владения, Cron при хранении колбэков от имени других модулей автоматически фиксирует их владельца, и при выгрузке/отключении модуля-владельца его обработчики колбэков автоматически отбрасываются, что гарантирует корректную утилизацию экземпляров этого модуля.

  • После перезагрузки модуля-создателя достаточно заново зарегистрировать on_trigger, чтобы восстановить приём срабатываний
  • Ненужные задачи можно очистить с помощью sdk.Cron.cancel(task_id) / delete_task(task_id)

Полезные ссылки


Следующие шаги

  • Отправка сообщений пользователю после срабатывания задачи: в колбэке используйте Send DSL или event.reply() (см. API системы событий) для доставки напоминания
  • Визуальное управление задачами по расписанию: после установки ErisPulse-Dashboard Cron автоматически регистрирует панель управления
  • Детали очистки колбэков при выгрузке модуля: система владения (owner)

AI 对话模块

来源: docs/ru/ecosystem/qvqchat.md(https://github.com/ErisPulse/ErisPulse/blob/main/docs/ru/ecosystem/qvqchat.md)

ErisPulse-QvQChat — универсальный агент

Tip

Когда стоит читать этот документ: когда вы хотите добавить боту возможности ИИ-агента (цикл инструментов, потоковый диалог, MCP, долговременная память) или открыть службы своего модуля для вызова агентом. Если это не нужно — пропустите.

ErisPulse-QvQChat — это модуль универсального агента, построенный вокруг цикла инструментов: приём и отправка сообщений, вызов служб модулей экосистемы, написание и выполнение кода, управление компьютером, генерация изображений и речи, управление задачами по расписанию и долговременной памятью — всё выполняется через единый протокол инструментов.

Important

QvQChat требует отдельной установки:

epsdk install ErisPulse-QvQChat

Также необходимо добавить в «Пул моделей» хотя бы одну совместимую с OpenAI модель (Base URL, API Key, имя модели).

Основные возможности

Возможность Описание
Цикл инструментов Модель выдаёт вызовы инструментов → параллельное выполнение → подстановка результатов → продолжение рассуждений, пока не будет дан финальный ответ
Потоковый диалог Посимвольный вывод через SSE, шаги инструментов видны в реальном времени; после обновления страницы или ухода и возвращения прогресс не теряется
Сжатие контекста При превышении порога token старый диалог автоматически сжимается в резюме (по умолчанию оценка 128000, настраивается)
Мост служб экосистемы Автоматическое обнаружение служб, объявленных модулями, и их преобразование в инструменты; установка или удаление модулей добавляет и убирает возможности
MCP-клиент stdio и Streamable HTTP, инструменты MCP объединяются в единый набор инструментов
Подагенты spawn_agent направляет подагента с независимой сессией на исследование задачи, возвращаются только итоговые выводы
Выполнение внутри процесса run_python_sdk запускает Python в основном процессе с прямым доступом к объектам среды выполнения
Управление компьютером Трёхуровневая безопасная песочница (strict / standard / permissive), подтверждение опасных операций, полный аудит
Визуальное понимание Изображения автоматически передаются модели (при отсутствии поддержки автоматически удаляются с повторной попыткой)
Вложения Любые файлы сохраняются на диск с дедупликацией по hash, путь передаётся ИИ для самостоятельной обработки; вставка скриншотов через Ctrl+V
Общий доступ к сессиям Временные ссылки только для чтения (срок действия + лимит token), экспорт в Markdown
Задачи по расписанию cron / однократные / с интервалом, с сохранением состояния, права наследуются от создателя
Захват сессии Администратор может передать агенту сессию в монопольное управление
Система персон Системный промпт + вступительный диалог + белый список инструментов, возможна привязка к сессиям
Долговременная память Записи памяти для каждой сессии, извлекаются по схожести и внедряются в контекст
Автоименование ИИ После первого ответа в сессии автоматически генерируется краткий заголовок

Расширение через модули

Любой модуль ErisPulse, объявляющий services, автоматически становится инструментом QvQChat — специальный интерфейс не требуется:

from ErisPulse.Core.Bases import BaseModule, ModuleMeta

class Main(BaseModule):
    @staticmethod
    def get_meta() -> ModuleMeta:
        return ModuleMeta(name="Draw", services=[
            {"name": "draw", "description": "Генерирует изображение по описанию, возвращает URL изображения"},
        ])

    async def draw(self, prompt: str, size: str = "1024x1024"):
        return {"image_url": "https://..."}

Сигнатуры методов служб автоматически отображаются в определения параметров JSON Schema инструмента, первая строка docstring используется как описание параметра.

Глубокая интеграция (опционально)

Модуль может дополнительно реализовать любые из следующих служб, каждая из которых независима и опциональна — модуль может заниматься только расширением персон или только внедрением промптов:

qvq_prompts() → внедрение системных промптов

Возвращает list[str] или list[{"text": str, "priority": int}], элементы объединяются в порядке возрастания priority.

async def qvq_prompts(self):
    return [
        {"text": "После создания изображения отправьте его пользователю через send_message.", "priority": 10},
        {"text": "Поддерживаемые стили: аниме, реализм, акварель, пиксель-арт.", "priority": 20},
    ]

qvq_personas() → регистрация предустановок персон

Возвращает список персон, к id автоматически добавляется префикс ext.<имя модуля>., при удалении модуля выполняется автоматическая очистка. Подходит для модулей, специализирующихся на расширении персон (эмоциональный компаньон, переводчик, рецензент кода и т.д.).

async def qvq_personas(self):
    return [
        {"id": "companion", "name": "Тёплый собеседник", "system": "Ты — тёплый и заботливый собеседник..."},
        {"id": "coder", "name": "Наставник по коду", "system": "...", "tools": ["read_file", "run_python"]},
    ]

tools опционально ограничивает подмножество инструментов, доступных данной персоне.

qvq_schemas() → явные схемы параметров

Возвращает dict[имя службы, JSON Schema], переопределяя вывод из сигнатуры метода. Используется, когда параметры сложны или требуется строгая валидация.

async def qvq_schemas(self):
    return {
        "draw": {
            "type": "object",
            "properties": {
                "prompt": {"type": "string", "description": "Описание изображения"},
                "size": {"type": "string", "enum": ["512x512", "1024x1024"]},
            },
            "required": ["prompt"],
        },
    }

Моменты обновления

Моменты обновления служб глубокой интеграции: запуск, установка и удаление модулей, ручное обновление на странице «Инструменты» в Dashboard.

Подписка на события

QvQChat рассылает два события жизненного цикла:

Событие Момент Полезная нагрузка
qvq.message Получено сообщение пользователя chat_key platform sender_id sender_name text is_group
qvq.replied После отправки ответа chat_key reply tools
async def setup(self):
    sdk.lifecycle.on("qvq.message", self.on_message)

Вызов в качестве службы

Служба Сигнатура Описание
chat (session_id, prompt, persona="") Диалог с агентом, возвращает текст
run_prompt (chat_key, prompt, ...) Запускает промпт, результат может быть отправлен в целевую сессию
get_status () Сводка состояния выполнения

Сопутствующие плагины

Три независимых модуля расширяют QvQChat и заодно демонстрируют, на что способны точки расширения — после установки QvQChat добавляйте их по мере необходимости:

Плагин Что делает
ErisPulse-QvQStalker Подслушивает групповые чаты и автоматически вмешивается в разговор: отслеживание активности, пятиуровневая оценка и уровень импульсивности совместно определяют, когда агенту вступить; 15 параметров поведения настраиваются прямо на странице настроек
ErisPulse-QvQMemes Прививает агенту привычку к мемам и стикерам: инструмент send_sticker позволяет модели самой выбирать, какой стикер отправить, изображения из групповых чатов автоматически собираются и размечаются визуальной моделью
ErisPulse-QvQCompanion Антропоморфное сопровождение: внедрение персоны и тона общения, инициативные реплики по уровню импульсивности, периоды тишины и дневной лимит

Все три плагина подключаются через соглашения о службах, описанные выше в разделе «Расширение через модули», и сами являются эталонной реализацией написания расширений.

Интерфейс

Доступен отдельно по адресу /QvQChat/view или встроен в боковую панель Dashboard.

Обзор

Диалог


Следующие шаги

MCP 桥

来源: docs/ru/ecosystem/apimcp.md(https://github.com/ErisPulse/ErisPulse/blob/main/docs/ru/ecosystem/apimcp.md)

ErisPulse-ApiMCP 控制机器人的人工智能客户端

Tip

何时阅读本文:当你希望使用 Claude Desktop 等支持 MCP 的人工智能客户端直接控制你的机器人时阅读本文——发送消息、查看消息、调用模块、管理适配器、观察事件流——无需则可跳过。

ErisPulse-ApiMCP 通过 MCP(Model Context Protocol) 将机器人运行时功能开放给人工智能客户端:安装后,Claude Desktop 中将新增 14 个工具,人工智能可以代替你收发消息、排查模块问题、订阅群聊事件——机器人从“你管理的程序”转变为“人工智能的手和眼”。

Important

ApiMCP 需要单独安装,并且必须显式配置 token 后桥接功能才能启用:

epsdk install ErisPulse-ApiMCP

在 config.toml 的 [ApiMCP] 节设置 token = "长随机串"(或环境变量 ERISPULSE_APIMCP_TOKEN)。未配置时除探活外所有端点返回 503,以避免令牌静默泄露。

Принцип работы

Двухуровневая структура, без каких-либо зависимостей от ИИ в самом роботе:

  • Внутри процесса робота: модуль ApiMCP подключает REST-мост (/apimcp/*, с аутентификацией по токену, по умолчанию ограничение 30 запросов/минуту) к встроенного HTTP-сервера фреймворка.
  • В отдельном процессе: команда erispulse-apimcp запускает stdio-сервер с помощью официального mcp SDK и перенаправляет вызовы инструментов MCP на REST-мост робота.
Claude Desktop ──MCP(stdio)──► erispulse-apimcp ──HTTP──► REST-мост в процессе робота ──► sdk.*

Если робот не работает или мост не настроен, инструмент возвращает понятную ошибку и указания по устранению неполадок, не выбрасывая стек вызовов.

Подключение Claude Desktop

Отредактируйте файл claude_desktop_config.json (Windows: %APPDATA%\Claude\; macOS: ~/Library/Application Support/Claude/):

{
  "mcpServers": {
    "erispulse": {
      "command": "erispulse-apimcp",
      "env": {
        "ERISPULSE_APIMCP_URL": "http://127.0.0.1:8000",
        "ERISPULSE_APIMCP_TOKEN": "ваш токен"
      }
    }
  }
}

После сохранения файла перезапустите Claude Desktop полностью. Если в списке инструментов появится сервер erispulse, значит подключение успешно. Любой клиент, поддерживающий MCP stdio server (Claude Code, Cursor и т. д.), может подключиться таким же образом.

Обзор 14 инструментов

Категория Инструмент Описание
Модуль list_modules / get_module_info / call_module / reload_module Просмотр и вызов открытых сервисов загруженных модулей, запуск горячей перезагрузки
Адаптер list_adapters / get_adapter_status / reload_adapter Статус онлайн-платформы; перезагрузка адаптера по умолчанию отключена
Сообщения send_message / recent_messages Отправка текста/изображений/аудио/видео/файлов на любую платформу; просмотр последних сообщений через transcript
События subscribe_events / unsubscribe / poll_events Подписка на события сообщений/уведомлений и т.д., кольцевой буфер (по умолчанию 1000 сообщений), инкрементальный опрос
Рантайм get_topology / sdk_health Топология рантайма (обезличенная) и сводка здоровья

Типичное применение: AI сначала вызывает subscribe_events(["message"]), затем периодически использует poll_events для наблюдения за разговором в группе, чтобы решить, нужно ли вставить сообщение через send_message или вызвать функциональность модуля через call_module.

Ключевые моменты безопасности

  • Токен — это полный контроль: токен позволяет читать сообщения, отправлять сообщения и вызывать методы модулей из белого списка. Никогда не добавляйте токен в репозиторий или не публикуйте в общедоступных каналах; в сценариях с несколькими арендаторами создавайте несколько экземпляров бота.
  • Минимальные права доступа: module_call_whitelist ограничивает список вызываемых модулей (поддерживается точный доступ по формату модуль.метод), send_target_whitelist ограничивает целевые адреса отправки (например, только определённая группа), allow_adapter_reload оставьте по умолчанию отключённым.
  • Только для локального использования: при использовании только на локальной машине установите фреймворк HTTP-сервера как server.host = "127.0.0.1"; при использовании на нескольких машинах необходимо использовать внутреннюю сеть + обратный прокси + TLS.
  • Вывод данных проходит очистку по ключам (ключи, относящиеся к ключам/пути, полностью удаляются); глубокая очистка — это обязанность самого модуля, не открывайте подписки на чувствительные сессии.

Полный список конфигурационных параметров (емкость буфера, окно восстановления, белый список типов событий и т.д.) и подробности REST-эндпоинтов см. в README проекта.

Далее

  • Хотите, чтобы ИИ активно участвовал в чате, а не просто подчинялся командам? QvQChat — это позитивное направление — интеллектуальные агенты активно общаются и выполняют задачи, см. Общий интеллектуальный агент QvQChat; ApiMCP — это обратное направление — внешний ИИ управляет ботом, оба модуля можно устанавливать одновременно.
  • Хотите понять, откуда берутся данные последних сообщений? Приемник транскриптов сессий
  • Хотите узнать о HTTP-сервере бота? Система маршрутизации

平台指南索引

来源: docs/ru/platform-guide/README.md(https://github.com/ErisPulse/ErisPulse/blob/main/docs/ru/platform-guide/README.md)

Документация по функциям платформы ErisPulse

Базовый протокол: OneBot12

Данная документация является руководством по платформенным функциям и содержит:

  • Примеры цепочки вызовов метода Send для различных адаптеров
  • Описание специфических событий и форматов сообщений платформы

Общие методы использования см. в следующих документах:


Платформенные функции

Эта часть документации поддерживается разработчиками адаптеров и предназначена для описания отличий и расширений данной платформы от стандарта OneBot12. Пожалуйста, ознакомьтесь с подробной документацией по каждой платформе:

Также существует адаптер sandbox, но для него не требуется отдельная документация по платформенным функциям


Общие интерфейсы

Цепочка вызовов Send

Все адаптеры поддерживают следующие стандартные вызовы:

Важно: {AdapterName} в документации необходимо заменить на фактическое имя адаптера (например, yunhu, telegram, onebot11, email и т.д.).

  1. Указание типа и ID: To(type,id).Func()
    # Получение экземпляра адаптера
    my_adapter = adapter.get("{AdapterName}")
    
    # Отправка сообщения
    await my_adapter.Send.To("user", "U1001").Text("Hello")
    
    # Например:
    yunhu = adapter.get("yunhu")
    await yunhu.Send.To("user", "U1001").Text("Hello")
    
  2. Указание только ID: To(id).Func()
    my_adapter = adapter.get("{AdapterName}")
    await my_adapter.Send.To("U1001").Text("Hello")
    
    # Например:
    telegram = adapter.get("telegram")
    await telegram.Send.To("U1001").Text("Hello")
    
  3. Указание учетной записи отправки: Using(account_id)
    my_adapter = adapter.get("{AdapterName}")
    await my_adapter.Send.Using("bot1").To("U1001").Text("Hello")
    
    # Например:
    onebot11 = adapter.get("onebot11")
    await onebot11.Send.Using("bot1").To("U1001").Text("Hello")
    
  4. Прямой вызов: Func()
    my_adapter = adapter.get("{AdapterName}")
    await my_adapter.Send.Text("Broadcast message")
    
    # Например:
    email = adapter.get("email")
    await email.Send.Text("Broadcast message")
    

Асинхронная отправка и обработка результатов

Методы Send DSL возвращают объект asyncio.Task, что позволяет выбирать, нужно ли немедленно ожидать результат:

# Получение экземпляра адаптера
my_adapter = adapter.get("{AdapterName}")

# Отправка сообщения без ожидания результата, сообщение отправляется в фоне
task = my_adapter.Send.To("user", "123").Text("Hello")

# Если нужно получить результат отправки, можно позже ожидать завершения задачи
result = await task

Декораторы правил отправки

В реальном разработке часто требуется: выполнять последующие действия только после успешной отправки, автоматически повторять отправку при ошибке, отменять отправку по таймауту, отслеживать прогресс отправки и т.д. DSL Send содержит встроенный набор декораторов правил отправки, которые можно добавлять цепочкой:

Метод Описание
.Hook(callback) Выполняется после успешной отправки (можно вызывать несколько раз)
.Retry(times=1) Автоматически повторяет отправку N раз (включая первую попытку, всего N+1)
.Timeout(seconds) Устанавливает таймаут для одной отправки, при превышении отменяет отправку (можно комбинировать с Retry)
.Defer(seconds) Откладывает отправку (внутрипроцессное таймерное ожидание, не сохраняется)
.OnProgress(callback) Вызывает обратный вызов при каждом этапе отправки, передавая SendContext
.OnError(callback) Вызывается при окончательной ошибке отправки (вызывается только один раз)
yunhu = adapter.get("yunhu")

# Выполняется только после успешной отправки (например, списание баллов)
await (yunhu.Send.To("user", "123")
       .Hook(lambda r: deduct_points("123"))
       .Text("消费成功"))

# Повтор отправки + таймаут + отслеживание прогресса
def on_progress(ctx):
    print(f"Этап: {ctx.stage}, Попытка: {ctx.attempt + 1}/{ctx.max_attempts}")

task = (yunhu.Send.To("user", "123")
        .Retry(3)              # Повторит отправку до 3 раз
        .Timeout(10)           # Таймаут на одну отправку 10 секунд
        .OnProgress(on_progress)
        .OnError(lambda ctx: notify_admin(ctx.error))
        .Text("重要通知"))

Методы правил возвращают self, поэтому они должны вызываться до отправки сообщения (Text/Image и т.д.). SendContext содержит поля stage (pending/sending/retrying/success/failed/timeout), attempt, elapsed, error, result, что удобно для отслеживания.

Режим построения пакетов (Build)

Позволяет построить несколько отправок в одной цепочке и выполнить их одновременно. Подходит для сценариев "отправить сразу несколько сообщений":

yunhu = adapter.get("yunhu")

# Строим несколько сообщений и отправляем их одновременно
results = await (yunhu.Send.To("user", "123")
                .Build()                     # Переходим в режим построения
                .Text("通知一")
                .Image("pic.jpg")
                .Text("通知二")
                .send_all())                 # Выполняем отправку
# results = [результат текста, результат изображения, результат текста]

.send_all() по умолчанию выполняет отправку параллельно (высокая эффективность). Если нужно сохранить порядок доставки, используйте .Sequential() для последовательной отправки:

# Последовательная отправка (сохраняет порядок) + повтор при ошибке
await (yunhu.Send.To("group", "456")
       .Build()
       .Sequential()                # Отправка по порядку
       .Retry(2)                     # Каждая неудачная отправка повторяется
       .Text("第一条").Text("第二条")
       .send_all())

Пакетная отправка использует стратегию "продолжать при ошибке": одна неудачная отправка не прерывает другие, неудачные отправки автоматически повторяются. Пакетная отправка также поддерживает общие Hook (вызывается после всех успешных отправок), OnError (вызывается при наличии ошибок), OnProgress (обратный вызов по прогрессу).

Более подробную информацию о правилах и построении пакетов см. в SendDSL подробно.

Слушатели событий

Существует три способа прослушивания событий:

  1. Слушатель событий платформы:

    from ErisPulse.Core import adapter, logger
    
    @adapter.on("event_type", raw=True, platform="{AdapterName}")
    async def handler(data):
        logger.info(f"Получено событие {AdapterName}: {data}")
    
  2. Слушатель стандартных событий OneBot12:

    from ErisPulse.Core import adapter, logger
    
    # Слушатель стандартных событий OneBot12
    @adapter.on("event_type")
    async def handler(data):
        logger.info(f"Получено стандартное событие: {data}")
    
    # Слушатель стандартных событий для конкретной платформы
    @adapter.on("event_type", platform="{AdapterName}")
    async def handler(data):
        logger.info(f"Получено событие {AdapterName}: {data}")
    
  3. Слушатель событий модуля Event: События модуля Event основаны на функции adapter.on(), поэтому формат событий в Event соответствует стандартному событию OneBot12

    from ErisPulse.Core.Event import message, notice, request, command
    
    message.on_message()(message_handler)
    notice.on_notice()(notice_handler)
    request.on_request()(request_handler)
    command("hello", help="Отправить приветственное сообщение", usage="hello")(command_handler)
    
    async def message_handler(event):
        logger.info(f"Получено сообщение: {event}")
    async def notice_handler(event):
        logger.info(f"Получено уведомление: {event}")
    async def request_handler(event):
        logger.info(f"Получен запрос: {event}")
    async def command_handler(event):
        logger.info(f"Получена команда: {event}")
    

Наиболее рекомендуемый способ обработки событий — использование модуля Event, поскольку он предоставляет богатые типы событий и методы обработки событий.


Стандартные форматы

Для удобства приведены простые форматы событий. Подробную информацию см. по ссылкам выше.

Важно: Ниже представлены базовые форматы стандарта OneBot12, каждый адаптер может добавлять расширения. Подробнее см. в описании платформенных функций каждого адаптера.

Стандартный формат событий

Все адаптеры должны реализовать формат преобразования событий:

{
  "id": "event_123",
  "time": 1752241220,
  "type": "message",
  "detail_type": "group",
  "platform": "example_platform",
  "self": {"platform": "example_platform", "user_id": "bot_123"},
  "message_id": "msg_abc",
  "message": [
    {"type": "text", "data": {"text": "Привет"}}
  ],
  "alt_message": "Привет",
  "user_id": "user_456",
  "user_nickname": "ExampleUser",
  "group_id": "group_789"
}

Стандартный формат ответа

Успешная отправка сообщения

{
  "status": "ok",
  "retcode": 0,
  "data": {
    "message_id": "1234",
    "time": 1632847927.599013
  },
  "message_id": "1234",
  "message": "",
  "echo": "1234",
  "{platform}_raw": {...}
}

Неудачная отправка сообщения

{
  "status": "failed",
  "retcode": 10003,
  "data": null,
  "message_id": "",
  "message": "Отсутствуют необходимые параметры",
  "echo": "1234",
  "{platform}_raw": {...}
}

Ссылки

Проект ErisPulse:

Связанные официальные документации:

Участие в разработке

Мы приветствуем больше разработчиков для написания и поддержки документации адаптеров! Пожалуйста, следуйте следующим шагам для внесения вклада:

  1. Сделайте fork репозитория ErisPulse.
  2. Создайте Markdown-файл в каталоге docs/platform-features/ с именем <название платформы>.md.
  3. Добавьте ссылку на ваш адаптер и соответствующую официальную документацию в этот файл README.md.
  4. Отправьте Pull Request.

Спасибо за вашу поддержку!