Плагины в zMod¶
Любой пользователь может создать и подключить свой плагин к zmod.
Плагины включенные в поставку zMod:
- Recommend - Настройки, которые рекомендуется использовать сразу после установки мода
- G28_tenz - Парковка оси Z по тензодатчикам
- Nopoop - Максимальное уменьшение количества отходов от ninjamida.
- TimeLapse - Moonraker TimeLapse
- Notify - Получение уведомлений в телеграм и еще более 100 различных сервисов
Внешние плагины, не разрабатываемых автором zMod.
- Bambufy - Совместим с Bambu Studio, улучшает управление башней подачи, обеспечивает точную оценку времени и расхода материала, снижает отходы, поддерживает Mainsail, быструю смену цвета и расширенные функции печати. НЕЛЬЗЯ ИСПОЛЬЗОВАТЬ С РОДНЫМ ЭКРАНОМ.
- lessWaste - форк BamBufy
Чтобы включить репозиторий внешних плагинов, не разрабатываемых автором zMod, выполните команду ENABLE_EXTRA_PLUGINS.
Управление плагином¶
Включить плагин:
ENABLE_PLUGIN name=g28_tenz
Выключить плагин:
DISABLE_PLUGIN name=g28_tenz
Установка классических плагинов Klipper с Python модулями¶
Для классических плагинов Klipper, которые работают с использованием Python модулей (например, klipper-led_effect), требуется специальный процесс установки с созданием символической ссылки на модуль Klipper.
Пример: Установка led_effect¶
led_effect — это плагин для управления WS2812 RGB LED полосками через Klipper.
Шаг 1: Клонируем репозиторий
Выполните эти команды в chroot окружении:
# Для FF5M:
chroot /data/.mod/.zmod/
# Для FF5X:
chroot /usr/data/.mod/.zmod/
# Одинаково для всех моделей:
cd /opt/config/mod_data/plugins/
git clone https://github.com/julianschill/klipper-led_effect.git
Шаг 2: Добавляем запись в Moonraker config
В файле mod_data/user.moonraker.conf добавьте следующую секцию:
[update_manager led_effect]
type: git_repo
channel: stable
path: /opt/config/mod_data/plugins/klipper-led_effect
origin: https://github.com/julianschill/klipper-led_effect.git
is_system_service: False
primary_branch: master
Шаг 3: Создаём символическую ссылку на модуль Klipper
Создайте символическую ссылку для подключения модуля к Klipper:
ln -s /opt/config/mod_data/plugins/klipper-led_effect/src/led_effect.py /usr/prog/klipper/klippy/extras/led_effect.py
Замените:
klipper-led_effectна папку вашего плагинаled_effect.pyна имя модуля (может быть другой в зависимости от плагина)
Шаг 4: Перезагружаем Klipper
После создания символической ссылки необходимо перезагрузить Klipper через веб-интерфейс Fluidd/Mainsail, нажав кнопку перезагрузки.
Важные замечания¶
Модуль должен быть совместим с версией Klipper Убедитесь, что версия плагина совместима с установленной версией Klipper.
Создание собственного плагина¶
Пример плагина: https://github.com/ghzserg/g28_tenz
(Во всех примерах ниже используется имя g28_tenz — замените его на имя вашего плагина.)
Добавление плагина¶
В файле
mod_data/user.moonraker.conf
добавьте секцию:
[update_manager g28_tenz]
type: git_repo
channel: dev
path: /root/printer_data/config/mod_data/plugins/g28_tenz
origin: https://github.com/ghzserg/g28_tenz.git
is_system_service: False
primary_branch: main
- Путь к плагину:
/root/printer_data/config/mod_data/plugins/g28_tenz - Источник:
https://github.com/ghzserg/g28_tenz.git
Стабильные плагины могут быть включены в поставку zmod, но обновляются и управляются их авторами.
Скрипт установки¶
После вызова ENABLE_PLUGIN, будет автоматически вызыван файл install.sh
После вызова DISABLE_PLUGIN, будет автоматически вызыван файл uninstall.sh
Одноязычный плагин¶
Должен содержать файл:
g28_tenz.cfg
Многоязычный плагин¶
Файлы размещаются в подкаталогах по языкам:
en/g28_tenz.cfg
ru/g28_tenz.cfg
de/g28_tenz.cfg
...
Все строки вывода должны быть экранированы, например:
RESPOND PREFIX="info" MSG="===Cutting the filament==="
Перевод¶
Переводы хранятся в каталоге translate/ в файлах вида de.csv:
Cutting the filament;Filament schneiden
Формат:
Английская фраза;Перевод на нужный язык
Чтобы сгенерировать языковые файлы, выполните:
./Make.sh
.cfg-файлы.