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

Материал из Sprut.hub Wiki

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

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

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

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

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

  • Bluetooth
  • ZigBee
  • MQTT
  • ZWave
  • Test
  • Xiaomi
  • ModBus
  • Wirenboard

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

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

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

В качестве SFTP клиента можно использовать, например Filezilla где необходимо добавить новый хост с IP адресом вашей Raspberry Pi, на которой установлен Sprut.hub, выбрать протокол SFTP и ввести логин и пароль, который вы используете при подключение к "малине" по SSH. Стандартно это makesimple/123

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

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

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

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

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

Ранний доступ к шаблонам

В этом же разделе, можно включить ранний доступ к шаблонам. Он предоставляет возможность подключить устройства, которые были недавно добавлены и еще не попали в основную ветку поддерживаемых устройств. Ранний доступ действует вне зависимости от выхода обновлений Beta и Release ревизий хаба и шаблоны обновляются независимо от выхода обновлений Sprut.hub

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

После этого необходимо загрузить последнии версии шаблонов и перезагрузить шаблоны.