Открыть меню
Toggle preferences menu
Открыть персональное меню
Вы не представились системе
Your IP address will be publicly visible if you make any edits.

Добавление кастомных шаблонов для любых устройств: различия между версиями

Материал из Sprut.hub Wiki
Нет описания правки
Нет описания правки
Строка 8: Строка 8:
Это позволяет не дожидаться, пока разработчики добавят поддержку устройства и пользоваться им до появления официальной поддержки.
Это позволяет не дожидаться, пока разработчики добавят поддержку устройства и пользоваться им до появления официальной поддержки.


Добавить кастомный шаблон очень просто. Достаточно его записать в соответствующую протоколу папку на отдельную внешнюю флешку (или microSD карту памяти для владельцев Sprut.hub CE), которая используется для [[Резервное копирование и восстановление из резервной копии|резервного копирования]].
Добавить кастомный шаблон очень просто. Достаточно воспользоваться разделом Каталог в вашем хабе
 
[[Файл:Шаблоны 007 Добавление кастомного шаблона.png|центр|обрамить]]
Причем структура папок создается автоматически при настроенной резервной копии.
Вы можете выбрать контроллер, для которого вы загружаете шаблон
 
[[Файл:Шаблоны 009 выбор контроллера для шаблона.png|центр|обрамить]]
Шаблоны расположены в папке /Sprut.hub/Templates/ на флешке, которая используется для резервного копирования в хабе.
И вам доступны варианты: загрузка из файла или вставка в редакторе кода
 
[[Файл:Шаблоны 008 варианты загрузки шаблонов.png|центр|обрамить]]
* Bluetooth
Вы можете вставить код шаблона в редактор и нажать кнопку сохранить
* ZigBee
[[Файл:Шаблоны 010 редактор шаблона.png|центр|обрамить]]
* MQTT
После сохранения - шаблон сразу доступен для работы с хабом и при поиске устройства для этого шаблона - он автоматически применится к найденному устройству.
* ZWave
* Test
* Xiaomi
* ModBus
* Wirenboard
 
Шаблоны для каждого протокола располагаются в соответствующей протоколу папке. То есть ZigBee шаблоны, обитают в папке /Sprut.hub/Templates/ZigBee


{{QuoteYellow|Если папок на флешке нет, их можно создать в соответствии с путем и перечнем протоколов, или настроить резервное копирование и создать первую резервную копию, которая автоматически создается при перезагрузке хаба. После перезагрузки, папки для шаблонов на флешке создадутся автоматически}}
{{QuoteYellow|Если папок на флешке нет, их можно создать в соответствии с путем и перечнем протоколов, или настроить резервное копирование и создать первую резервную копию, которая автоматически создается при перезагрузке хаба. После перезагрузки, папки для шаблонов на флешке создадутся автоматически}}

Версия от 01:51, 29 июля 2025

Начиная с версии Sprut.hub release 14717 - WEB 1.5.48, кастомные шаблоны перестают храниться на флешке и меняется их структура. В старом формате - они работать не будут

Все ваши кастомные шаблоны после обновления, автоматически будут интегрированы в новую структуру и появятся в списке доступных шаблонов в Каталоге. Эта операция производится однократно при первом обновлении до новой версии. После обновления и переноса шаблонов во внутреннее хранилище - эти шаблоны не будут считываться с флешки и их редактирование на ней не будет приводить к обновлению шаблонов

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

Пользователь может самостоятельно разработать шаблон для своего устройства и загрузить его в Sprut.hub.

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

Добавить кастомный шаблон очень просто. Достаточно воспользоваться разделом Каталог в вашем хабе

Вы можете выбрать контроллер, для которого вы загружаете шаблон

И вам доступны варианты: загрузка из файла или вставка в редакторе кода

Вы можете вставить код шаблона в редактор и нажать кнопку сохранить

После сохранения - шаблон сразу доступен для работы с хабом и при поиске устройства для этого шаблона - он автоматически применится к найденному устройству.

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

Владельцам Raspberry Pi и WirenBoard

Для владельцев Raspberry Pi можно залить кастомный шаблон через SSH (SFTP) в папку /home/makesimple/.SprutHub/data/Templates

Для владельцев WirenBoard можно залить кастомный шаблон через SSH (SFTP) в папку /mnt/data/makesimple/.SprutHub/data/Templates

В качестве SFTP клиента можно использовать, например Filezilla где необходимо добавить новый хост с IP адресом вашей Raspberry Pi или WirenBoard, на которой установлен Sprut.hub, выбрать протокол SFTP и ввести логин и пароль, который вы используете при подключение к "малине" или "вайрену" по SSH. Для Raspberry Pi - стандартный логин/пароль SSH: pi/raspberry

Загрузка кастомного шаблона

Ваш кастомный шаблон необходимо скопировать в соответствующую протоколу папку, подключить флешку к хабу и в разделе Настройки - Расширенные - Перезагрузить шаблоны

Если шаблон некорректный - в логе вы увидите ошибку. Что именно в нем не так - вам придется выяснять самостоятельно.

Обновление шаблонов

Обновление шаблонов происходит так же как и при обновлении системы. Появится уведомление о наличии обновлений.

Если у вас есть кастомные шаблоны и вы обновляете версию шаблонов, стоит внимательно отслеживать события в логе, так как может возникнуть их конфликт. Для всех шаблонов кроме MQTT - приоритетными являются кастомные