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

Текущая версия от 18:28, 2 декабря 2023

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

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

Добавить кастомный шаблон очень просто. Достаточно его записать в соответствующую протоколу папку на отдельную внешнюю флешку (или microSD карту памяти для владельцев Sprut.hub CE), которая используется для резервного копирования.

Причем структура папок создается автоматически при настроенной резервной копии.

Шаблоны расположены в папке /Sprut.hub/Templates/ на флешке, которая используется для резервного копирования в хабе.

Bluetooth
ZigBee
MQTT
ZWave
Test
Xiaomi
ModBus
Wirenboard

Шаблоны для каждого протокола располагаются в соответствующей протоколу папке. То есть ZigBee шаблоны, обитают в папке /Sprut.hub/Templates/ ZigBee

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

Владельцам 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 - приоритетными являются кастомные

@@ Строка 3: / Строка 3: @@
 Это позволяет не дожидаться, пока разработчики добавят поддержку устройства и пользоваться им до появления официальной поддержки.
-Добавить кастомный шаблон очень просто. Достаточно его загрузить в соответствующую протоколу папку на отдельную внешнюю флешку (или microSD карту памяти для владельцев Sprut.hub CE), которая используется для [[Резервное копирование и восстановление из резервной копии|резервного копирования]].
+Добавить кастомный шаблон очень просто. Достаточно его записать в соответствующую протоколу папку на отдельную внешнюю флешку (или microSD карту памяти для владельцев Sprut.hub CE), которая используется для [[Резервное копирование и восстановление из резервной копии|резервного копирования]].
 Причем структура папок создается автоматически при настроенной резервной копии.
@@ Строка 17: / Строка 17: @@
 * ModBus
 * Wirenboard
-{{QuoteYellow|Если папок на флешке нет, их можно создать в соответствии с путем и перечнем протоколов, или настроить резервное копирование и создать первую резервную копию, которая автоматически создается при перезагрузке хаба}}
-== Владельцам Raspberry Pi ==
+Шаблоны для каждого протокола располагаются в соответствующей протоколу папке. То есть ZigBee шаблоны, обитают в папке /Sprut.hub/Templates/ ZigBee
+{{QuoteYellow|Если папок на флешке нет, их можно создать в соответствии с путем и перечнем протоколов, или настроить резервное копирование и создать первую резервную копию, которая автоматически создается при перезагрузке хаба. После перезагрузки, папки для шаблонов на флешке создадутся автоматически}}
+== Владельцам Raspberry Pi и WirenBoard ==
 Для владельцев Raspberry Pi можно залить кастомный шаблон через SSH (SFTP) в папку /home/makesimple/.SprutHub/data/Templates
-В качестве SFTP клиента можно использовать, например [https://filezilla.ru Filezilla] где необходимо добавить новый хост с IP адресом вашей Raspberry Pi, на которой установлен Sprut.hub, выбрать протокол SFTP и ввести логин и пароль, который вы используете при подключение к "малине" по SSH. {{color|red|Стандартно это makesimple/123}}
+Для владельцев WirenBoard можно залить кастомный шаблон через SSH (SFTP) в папку /mnt/data/makesimple/.SprutHub/data/Templates
+В качестве SFTP клиента можно использовать, например [https://filezilla.ru Filezilla] где необходимо добавить новый хост с IP адресом вашей Raspberry Pi или WirenBoard, на которой установлен Sprut.hub, выбрать протокол SFTP и ввести логин и пароль, который вы используете при подключение к "малине" или "вайрену" по SSH. {{color|red|Для Raspberry Pi - стандартный логин/пароль SSH: pi/raspberry}}
 [[Файл:Шаблоны 003 Filezilla.png|центр|обрамить]]
 == Загрузка кастомного шаблона ==
 Ваш кастомный шаблон необходимо скопировать в соответствующую протоколу папку, подключить флешку к хабу и в разделе '''Настройки - Расширенные - Перезагрузить шаблоны'''
-[[Файл:Шаблоны 001 Перезагрузить шаблоны.png|центр|обрамить]]
+[[Файл:Шаблоны 001 Перезагрузить шаблоны.png|центр|обрамить]]Если шаблон некорректный - в логе вы увидите ошибку. Что именно в нем не так - вам придется выяснять самостоятельно.{{QuoteRed|Если вы создаете собственный шаблон и производите постоянное изменение настроек в нем, то каждая версия шаблона должна иметь отличное от предыдущей версии название файла. Иначе он не загрузится. Аксессуар, созданный предыдущей версией шаблона, перед обновлением шаблонов необходимо удалить.}}
-{{QuoteRed|Если вы создаете собственный шаблон и производите постоянное изменение настроек в нем, то каждая версия шаблона должна иметь отличное от предыдущей версии название файла. Иначе он не загрузится. Аксессуар, созданный предыдущей версией шаблона, перед обновлением шаблонов необходимо удалить.}}
 == Обновление шаблонов ==
-Обновление шаблонов, позволяет получить обновления основных шаблонов для устройств (ветка main), а также обновляются ранние шаблоны, если доступ к ним включен.
+Обновление шаблонов происходит так же как и при обновлении системы. Появится уведомление о наличии обновлений.
+{{QuoteYellow|Если у вас есть кастомные шаблоны и вы обновляете версию шаблонов, стоит внимательно отслеживать события в логе, так как может возникнуть их конфликт. Для всех шаблонов кроме MQTT - приоритетными являются кастомные}}
-== Ранний доступ к шаблонам ==
-В этом же разделе, можно включить ранний доступ к шаблонам. Он предоставляет возможность подключить устройства, которые были недавно добавлены и еще не попали в основную ветку поддерживаемых устройств. Ранний доступ действует вне зависимости от выхода обновлений Beta и Release ревизий хаба и шаблоны обновляются независимо от выхода обновлений Sprut.hub
-{{QuoteRed|Вы действуете на свой страх и риск, так как ранний доступ к шаблонам подразумевает возможность некорректной работы устройств и предполагает обязательную отправку обратной связи разработчикам обо всех неполадках в соответствующих разделах поддержки}}
-[[Файл:Шаблоны 002 Ранний доступ.png|центр|обрамить]]
-После этого необходимо загрузить последнии версии шаблонов и перезагрузить шаблоны.
-[[Файл:Шаблоны 004 Ранний доступ загрузка.png|центр|обрамить]]
 __ОБЯЗАТЕЛЬНОЕ_ОГЛАВЛЕНИЕ__