Skip to main content

Руководство по плагинам каналов

Создайте собственный канал для Велеса за три шага: создание подкласса, упаковка, установка.

Как это работает

Велес обнаруживает плагины каналов через точки входа Python. При запуске veles gateway сканируются:
  1. Встроенные каналы в veles/channels/
  2. Внешние пакеты, зарегистрированные в группе entry point veles.channels
Если соответствующий раздел конфигурации имеет значение "enabled": true, канал инициализируется и запускается.

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

Мы создадим минимальный канал веб-хука, который получает сообщения через HTTP POST и отправляет ответы обратно.

Структура проекта

1. Создание канала

2. Регистрация Entry Point

Ключ (webhook) становится именем раздела конфигурации. Значение указывает на ваш подкласс BaseChannel.

3. Установка и настройка

Отредактируйте ~/.veles/config.json:

4. Запуск и тестирование

В другом терминале:
Агент получит сообщение и обработает его. Ответы придут в ваш метод send().

API BaseChannel

Обязательные методы (абстрактные)

Базовые возможности

Типы сообщений

Конфигурация

Ваш канал получает конфиг как обычный dict. Доступ к полям через .get():
allowFrom обрабатывается автоматически в _handle_message(). Переопределите default_config(), чтобы Veles onboard автоматически заполнил config.json:

Соглашение об именовании

Локальная разработка

Проверка