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

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

Материал из Sprut.hub Wiki
Нет описания правки
Нет описания правки
 
(не показано 26 промежуточных версий 2 участников)
Строка 1: Строка 1:
{{QuoteRed|Начиная с версии Sprut.hub release 14717 - WEB 1.5.48, кастомные шаблоны перестают храниться на флешке и меняется их структура. В старом формате - они работать не будут}}
{{QuoteYellow|Все ваши кастомные шаблоны после обновления, автоматически будут интегрированы в новую структуру и появятся в списке доступных шаблонов в Каталоге. Эта операция производится однократно при первом обновлении до новой версии. После обновления и переноса шаблонов во внутреннее хранилище - эти шаблоны не будут считываться с флешки и их редактирование на ней не будет приводить к обновлению шаблонов}}
{{QuoteGreen|Для приведения старых версий кастомных шаблонов к новому формату, вы можете воспользоваться [https://kirillashikhmin.github.io/Sprut.Hub_Tools/ валидатором с функцией автоматического исправления шаблона под новую структуру] За валидатор, выражаем огромную благодарность Kirill Ashikhmin!!!}}
Пользователь может самостоятельно разработать шаблон для своего устройства и загрузить его в Sprut.hub.
Пользователь может самостоятельно разработать шаблон для своего устройства и загрузить его в Sprut.hub.


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


Добавить кастомный шаблон очень просто. Достаточно его загрузить в соответствующую протоколу папку на отдельную внешнюю флешку (или microSD карту памяти для владельцев Sprut.hub CE), которая используется для [[Резервное копирование и восстановление из резервной копии|резервного копирования]].
== Добавление кастомного шаблона ==
 
Добавить кастомный шаблон очень просто. Достаточно воспользоваться разделом Каталог в вашем хабе
Причем структура папок создается автоматически при настроенной резервной копии.
[[Файл:Шаблоны 007 Добавление кастомного шаблона.png|центр|обрамить]]
 
Вы можете выбрать контроллер, для которого вы загружаете шаблон  
Шаблоны расположены в папке /Sprut.hub/Templates/ на флешке, которая используется для резервного копирования в хабе.
[[Файл:Шаблоны 009 выбор контроллера для шаблона.png|центр|обрамить]]
 
И вам доступны варианты: загрузка из файла или вставка в редакторе кода
* Bluetooth
[[Файл:Шаблоны 008 варианты загрузки шаблонов.png|центр|обрамить]]
* ZigBee
Вы можете вставить код шаблона в редактор и нажать кнопку сохранить
* MQTT
[[Файл:Шаблоны 010 редактор шаблона.png|центр|обрамить]]
* ZWave
После сохранения - шаблон сразу доступен для работы с хабом и при поиске устройства для этого шаблона - он автоматически применится к найденному устройству.
* Test
* Xiaomi
* ModBus
* Wirenboard
{{QuoteYellow|Если папок на флешке нет, их можно создать в соответствии с путем и перечнем протоколов, или настроить резервное копирование и создать первую резервную копию, которая автоматически создается при перезагрузке хаба}}
 
== Владельцам Raspberry Pi ==
Для владельцев Raspberry Pi можно залить кастомный шаблон через SSH (SFTP) в папку /home/makesimple/.SprutHub/data/Templates
 
В качестве SFTP клиента можно использовать, например [https://filezilla.ru Filezilla] где необходимо добавить новый хост с IP адресом вашей Raspberry Pi, на которой установлен Sprut.hub, выбрать протокол SFTP и ввести логин и пароль, который вы используете при подключение к "малине" по SSH. Стандартно это makesimple/123
[[Файл:Шаблоны 003 Filezilla.png|центр|обрамить]]
 
== Загрузка кастомного шаблона ==
Ваш кастомный шаблон необходимо скопировать в соответствующую протоколу папку, подключить флешку к хабу и в разделе '''Настройки - Расширенные - Перезагрузить шаблоны'''
[[Файл:Шаблоны 001 Перезагрузить шаблоны.png|центр|обрамить]]
{{QuoteRed|Если вы создаете собственный шаблон и производите постоянное изменение настроек в нем, то каждая версия шаблона должна иметь отличное от предыдущей версии название файла. Иначе он не загрузится. Аксессуар, созданный предыдущей версией шаблона, перед обновлением шаблонов необходимо удалить.}}


== Обновление шаблонов ==
== Редактирование шаблонов ==
Обновление шаблонов, позволяет получить обновления основных шаблонов для устройств (ветка main), а также обновляются ранние шаблоны, если доступ к ним включен.
Для редактирования доступны только те шаблоны, которые не входят в базовый набор шаблонов Sprut.hub. То есть вы сможете редактировать только те шаблоны, которые вы сами добавили.


== Ранний доступ к шаблонам ==
Для редактирования, вам нужно выбрать хранилище, контроллер и другие необходимые параметры для фильтра шаблонов. После этого вам необходимо зайти в свойства шаблона (просто нажав на шаблон в списке), и после этого перейти в редактор шаблона
В этом же разделе, можно включить ранний доступ к шаблонам
[[Файл:Шаблоны 011 редактирование кастомного шаблона.png|центр|обрамить]]
[[Файл:Шаблоны 012 открыть редактор.png|центр|обрамить]]
[[Файл:Шаблоны 013 шаблон в режиме редактирования.png|центр|обрамить]]


{{QuoteRed|Вы действуете на свой страх и риск, так как ранний доступ к шаблонам подразумевает возможность некорректной работы устройств и предполагает обязательную отправку обратной связи разработчикам обо всех неполадках в соответствующих разделах поддержки}}
[[Файл:Шаблоны 002 Ранний доступ.png|центр|обрамить]]
__ОБЯЗАТЕЛЬНОЕ_ОГЛАВЛЕНИЕ__
__ОБЯЗАТЕЛЬНОЕ_ОГЛАВЛЕНИЕ__

Текущая версия от 02:00, 29 июля 2025

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

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

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

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

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

Добавление кастомного шаблона

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

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

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

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

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

Редактирование шаблонов

Для редактирования доступны только те шаблоны, которые не входят в базовый набор шаблонов Sprut.hub. То есть вы сможете редактировать только те шаблоны, которые вы сами добавили.

Для редактирования, вам нужно выбрать хранилище, контроллер и другие необходимые параметры для фильтра шаблонов. После этого вам необходимо зайти в свойства шаблона (просто нажав на шаблон в списке), и после этого перейти в редактор шаблона