Руководство по веб-интерфейсу Shelly BLU Assistant

Обзор

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

Обратите внимание, что для использования локального веб-интерфейса вам не требуется подключение к интернету или Shelly Cloud — единственное требование заключается в том, что ваш браузер должен находиться в той же сети Wi-Fi, что и ваше устройство Shelly.

Доступ к веб-интерфейсу

Для доступа к веб-интерфейсу:

Подключите ваше устройство к сети Wi-Fi с именем (SSID), соответствующим следующему формату: ""DeviceName-XXXXXXXXXX", где "DeviceName" — это имя устройства, к которому вы хотите подключиться, а "XXXXXXXXXX" представляет собой уникальную комбинацию букв и цифр, составляющую идентификатор устройства.
После установления соединения с точкой доступа/AP устройства (Указанная в шаге 1 сеть Wi-Fi) Доступ к веб-интерфейсу осуществляется путем ввода в браузере универсального IP-адреса для всех устройств Shelly: 192.168.33.1.

Теперь вы находитесь в веб-интерфейсе вашего устройства.

Подключение устройства к сети Wi-Fi

Некоторые настройки, которые вы увидите в веб-интерфейсе, доступны только при подключении устройства к интернету. Для этого выполните следующие действия:

В веб-интерфейсе перейдите в «Настройки» > «Wi-Fi».

Введите или выберите предпочитаемую сеть Wi-Fi и введите ее пароль. Также можно подключиться к открытой сети, для чего необходимо установить флажок для подключения к открытым сетям Wi-Fi. Кроме того, рекомендуется установить статический IP-адрес.

Подождите несколько секунд, пока устройство попытается подключиться к указанной вами сети Wi-Fi. Если введенный вами пароль неверен или сеть Wi-Fi недостаточно мощная или стабильная, в веб-интерфейсе отобразится сообщение о том, что соединение не удалось установить. После успешного подключения к Wi-Fi над настройками Wi-Fi появится ссылка с новым IP-адресом. Просто скопируйте и вставьте эту ссылку в свой браузер.

Теперь вы находитесь в веб-интерфейсе вашего устройства, подключенного к интернету. В следующий раз, когда вам понадобится получить доступ к веб-интерфейсу, просто подключитесь к той же сети Wi-Fi, что и ваше устройство, и введите новый IP-адрес, полученный на шаге 3. Рекомендуется установить статический IP-адрес, поскольку это гарантирует постоянную доступность по этому конкретному адресу.

Понимание структуры

Веб-интерфейс можно разделить на четыре основных раздела: заголовок, нижний колонтитул, главное меню и основное содержимое.

Заголовок

Заголовок состоит из двух компонентов: названия вашего устройства слева и нескольких значков, отображающих основные сетевые и коммуникационные функции вашего устройства справа. Эти значки могут включать в себя такие функции, как Wi-Fi, Bluetooth, MQTT и многое другое, а также значок, показывающий наличие новых обновлений прошивки для вашего устройства. Наведение курсора мыши на значок предоставит вам дополнительную информацию. Вы найдете легенду со значением каждого значка в руководстве по веб-интерфейсу каждого устройства. Обратите внимание, что в отдельных руководствах описаны только функции подключения, доступные для конкретного устройства.

Нижний колонтитул

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

Главное меню

В настольной версии веб-интерфейса главное меню находится слева, тогда как на мобильных устройствах оно выглядит как меню-гамбургер с иконкой из трех горизонтальных линий, расположенных друг над другом. Меню содержит разные элементы в зависимости от устройства, но нажатие на пункт меню переводит вас на другую страницу. Вы также можете использовать его, чтобы вернуться на главную страницу, нажав «Главная».

Основное содержимое

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

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

Главное меню

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

Главная страница

Тип	Значение
Значок точки доступа	Серый: режим точки доступа отключен. Синий: режим точки доступа включен.
Значок Wi‑Fi	Серый: подключение Wi‑Fi отключено. Белый: подключение Wi‑Fi включено, но не установлено. Синий: устройство подключено к Wi‑Fi.
Значок Bluetooth	Серый: подключение отключено. Синий: подключение включено.
Значок облака	Серый: подключение к облаку Shelly отключено. Белый: подключение к облаку Shelly включено, но не установлено. Синий: устройство подключено к облаку Shelly.
Значок MQTT	Серый: MQTT отключен. Синий: MQTT включен.
Значок обновления прошивки	Синий: для вашего устройства доступна новая стабильная версия прошивки. Не отображается: прошивка устройства обновлена.
Значок подключения Websocket	Синий: Websocket подключен. Серый: Websocket не подключен. Главная страница веб‑интерфейса разделена на четыре сворачиваемые панели.

Избранное

Эта панель изначально пуста. Щелкните по устройству, найденному на панели «Результаты», чтобы добавить его в избранное и отобразить здесь. На этой панели можно закрепить до 6 устройств. Каждое устройство имеет:

пользовательский псевдоним (сохраненный в KVS, но не отправляемый на само устройство командой переименования).
до 4 кнопок для произвольных вызовов RPC с пользовательскими метками.

Найти устройства Shelly

Тип	Значение
Поиск и фильтр устройств	На данной панели можно найти и отсортировать определённые устройства Shelly; найденные устройства отображаются на панели «Результаты».
Фильтр по идентификатору модели	Можно выбрать из выпадающего списка все модели Shelly или начать вводить текст, чтобы найти нужную модель.
Фильтр по имени устройства	Введите заявленное имя устройства Shelly, которое вы хотите найти.
Порог RSSI (дБм)	Установите пороговое значение для сигнала, чтобы скрыть все устройства с более слабым RSSI.
Сортировка	Можно сортировать по RSSI (от самого сильного к самому слабому) или по имени устройства (от A до Z).
Сканирование	Запустите сканирование BLE для поиска целевых устройств; найденные устройства отображаются на панели «Результаты».
Сбросить запрос	Очистите все поля фильтра одним действием.

Отправить RPC

Отправить RPC одновременно до 5 устройств:

Выберите одно или несколько устройств на панели «Результаты» (установите флажок справа от имени устройства).
Начните вводить RPC-запрос. Автозаполнение отображает команды, действительные только для выбранной вами модели устройства.
Необязательно: Добавьте параметры в формате JSON.
Нажмите Отправить для одновременного выполнения команды на 5 устройствах.

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

Результаты

Посмотрите все найденные устройства, соответствующие критериям, выбранным вами в панели Найти устройства Shelly.

В верхней части панели отображается обзор, показывающий:

Количество отсканированных устройств
Количество отфильтрованных устройств
Количество выбранных устройств (это делается путем установки флажка или нажатия кнопки Выбрать все для быстрой проверки всех устройств)
Количество избранных устройств

На каждой карточке устройства отображается модель, имя, MAC и RSSI. Во время работы отображается индикатор выполнения.

Подробная информация об успехе/неудаче отображается под карточкой устройства.

Настройки

Сетевые настройки

Точка доступа — Настройте точку доступа (AP) устройства, установив флажок «Включить точку доступа» и задав пароль для защиты вашей сети от несанкционированного доступа. Точка доступа устройства по умолчанию является открытой сетью. SSID уникален и не может быть изменен.
Wi-Fi — Зарегистрируйте устройство Shelly для подключения к двум различным сетям Wi-Fi. Введите (написав в текстовом поле) или выберите сеть Wi-Fi, щелкнув значок стрелы (шеврон), чтобы просмотреть все доступные сети. Можно выбрать открытую сеть, а также установить статический IP-адрес. Можно включить Wi-Fi 1, Wi-Fi 2 или оба одновременно (используя переключатель рядом с каждым из них). Если включены оба Wi-Fi 1 и Wi-Fi 2, и устройство Shelly отключается от одной из сетей, оно подключится к другой. Включить Wi-Fi можно только после установки имени сети (SSID). Если у устройства нет других доступных подключений (точка доступа, Bluetooth, Ethernet (если применимо) или вторая сеть Wi-Fi), попытка отключить Wi-Fi вызовет всплывающее окно с вопросом, хотите ли вы продолжить.
Bluetooth - Отключение/включение Bluetooth путем переключения переключателя. В настройках устройства по умолчанию включен Bluetooth.

Подключение

Примечание по связи RPC: Если вызов RPC не удается выполнить, появляется сообщение-баннер, уведомляющее о том, что устройство не отвечает вовремя и потеряло соединение. После восстановления соединения запрос будет отправлен снова.

MQTT - Настройте устройство Shelly для выполнения действий через MQTT. По умолчанию MQTT отключен, но вы можете включить его, установив пустой флажок. Изменение этих настроек приведет к перезагрузке устройства. Есть и другие настройки, такие как «Уведомления о состоянии RPC через MQTT» (позволяет обмениваться данными с устройством через уведомления RPC) и «Общее обновление состояния через MQTT» (для получения общего обновления состояния), которые вы можете включить или отключить. Вы также можете включить SSL и ввести свой сервер, имя пользователя и пароль, но имейте в виду, что включение SSL сократит время работы батареи, скорее всего, вдвое.
Исходящий Websocket — указывает, создает ли HTTP-канал исключение ввода-вывода при закрытии входящего соединения, которое все еще используется сервлетом. По умолчанию этот параметр отключен. Чтобы включить его, щелкните переключатель рядом с «Включить». Введите адрес вашей службы в текстовое поле и из раскрывающегося меню в разделе «SSL-подключение» выберите «
», «ca.pem» или «user_ca.pem».

RPC через UDP — взаимодействует с вашим устройством и отправляет запросы через удаленный вызов процедур (RPC) через сервер протокола пользовательских дейтаграмм (UDP). Это может быть полезно для удаленного управления и мониторинга вашего устройства без необходимости использования выделенного сервера или подключения. Для использования этой настройки вам потребуется ввести порт прослушивания и адрес назначения для UDP-сервера. Порт прослушивания — это номер порта, на котором устройство будет принимать входящие запросы, а адрес назначения — это IP-адрес сервера, на который будут отправляться запросы. После ввода необходимой информации вы можете использовать протокол RPC по UDP для отправки запросов на ваше устройство и получения ответов.

Настройки устройства

Имя устройства (информация) — Отображает идентификатор вашего устройства, сеть Wi-Fi, к которой оно подключено, и значение RSSI Wi-Fi.
Перезагрузка — После нажатия кнопки «Перезагрузка» вам будет предложено подтвердить, что вы хотите перезагрузить устройство. Нажмите «ОК» для перезагрузки устройства и «Отмена», если вы не хотите перезагрузки устройства.
«Сброс к заводским настройкам» — Нажав кнопку «Сброс», вы сбросите все настройки устройства до значений по умолчанию. Все внесенные вами изменения будут отменены. Вы можете подтвердить сброс устройства к заводским настройкам, нажав «ОК» во всплывающем окне, или «Отмена», чтобы отменить сброс.
«Местоположение и часовой пояс» — Ваш часовой пояс и местоположение будут определены автоматически, но вы можете изменить их вручную в этой настройке, выбрав часовой пояс из выпадающего меню и введя широту и долготу. Также есть кнопка «Автоматическое определение местоположения», которая позволит устройству автоматически определить местоположение еще раз, если в прошлый раз это не удалось.

«Если время устройства не синхронизировано с текущим временем, расписания и действия могут работать некорректно. Если время не синхронизировано, появится сообщение.»

«Аутентификация» — если вы включите аутентификацию, вам будет предложено ввести пароль, который вы будете использовать для доступа к веб-интерфейсу устройства. После включения, чтобы отключить ее, нажмите переключатель и введите свой пароль аутентификации, когда появится соответствующий запрос.
«Прошивка» — в этом разделе вы можете увидеть идентификатор вашего устройства, версию прошивки, идентификатор сборки и идентификатор веб-сборки. Используйте кнопку «Копировать» над идентификатором прошивки или идентификатором веб-сборки, чтобы скопировать содержимое в буфер обмена. Вы также можете увидеть доступные новые версии, проверить наличие обновлений и легко обновить ваше устройство. Также есть возможность загрузить собственную прошивку, однако прошивка устройства пользовательской прошивкой необратимо аннулирует гарантию устройства.
Сертификат пользователя (конфигурация TLS) — Загрузите пользовательский центр сертификации, клиентский сертификат и клиентский ключ, перетащив файл(ы) или выбрав нужные файлы, нажав соответствующую кнопку. Нажмите «Загрузить», чтобы загрузить файлы, и «Очистить», чтобы удалить файлы, которые вы не хотите загружать.
Отладка — Этот параметр включает отладку MQTT, Websocket и UDP. Чтобы включить любой из них, нажмите переключатель рядом с соответствующим параметром. Для отладки UDP вам также будет предложено ввести «адрес UDP».

Скрипты

Это устройство поддерживает скриптовые функции. Вы можете использовать их для настройки и расширения функциональности устройства в соответствии с конкретными потребностями пользователя. Эти скрипты могут учитывать состояние устройства, взаимодействовать с другими устройствами или получать данные из внешних сервисов, таких как прогнозы погоды. Скрипт — это программа, написанная на подмножестве JavaScript.

В веб-интерфейсе, перейдя в меню «Скрипты», вы увидите существующие скрипты, или, если у вас их нет, вы можете создать новый или открыть библиотеку, чтобы изучить уже доступные скрипты. Рядом с каждым скриптом вы сможете увидеть его статус (работает он или остановлен), а также переключатель, позволяющий запускать скрипт при запуске системы. Если в вашем скрипте есть ошибки, последняя сохраненная ошибка будет отображена под именем скрипта.

В режиме редактирования скрипта вы увидите консоль под ним, а также любые возникающие ошибки. Над полем кода расположены кнопки «Сохранить», «Запустить/Остановить» или «Удалить» ваш скрипт. Вы также можете получить доступ к «Фрагментам» и «Документации», щелкнув соответствующие метки.

Компоненты

Создание компонента

Настройка «Компоненты» позволяет пользователю создавать «динамические компоненты», которые изначально не существуют на устройстве. Виртуальные компоненты, тип динамических компонентов, используются для хранения или передачи данных между скриптами или запусками и отображения функциональности скрипта на главной странице. Компоненты можно группировать только в группы, и компоненты внутри них будут отображаться на главной странице. Компоненты, не принадлежащие к группе, там отображаться не будут. Количество компонентов и групп компонентов на одном устройстве ограничено.

Чтобы создать компонент:

Нажмите кнопку «Создать новый» рядом с «Пользовательские компоненты».
Выберите тип компонента, который вы хотите создать — логический, числовой, текстовый, перечисление или кнопка. После создания каждый тип компонента будет иметь поля «Имя», «Вид» и «URL-адрес пользовательской иконки», которые необходимо заполнить. Поле «URL-адрес пользовательской иконки» не является обязательным, но его можно использовать для настройки внешнего вида компонентов на главной странице. Вы можете переименовать или удалить компонент, а также создать для него действия, используя кнопки, расположенные рядом с каждым компонентом.

Различные типы компонентов могут иметь дополнительные поля, специфичные для этого типа. Ниже приведено их описание.

Тип компонента «Boolean» хранит значение true/false и имеет два разных заголовка, которые пользователь может ввести в зависимости от того, истинно или ложно значение, а также два отдельных значка. Выпадающее меню для значения по умолчанию будет включать различные состояния вашего устройства. Варианты отображения: «Скрытый», «Переключатель» и «Метка». В режиме «Переключатель» отображается кнопка переключения, поэтому значение компонента изменяется при каждом нажатии. В режиме «Метка» отображается заголовок значения компонента.

Тип компонента «Number» хранит значения от -999999999999999 до 9999999999999999. Значение по умолчанию должно быть числом в этом диапазоне. Вы также можете изменить единицу измерения и шаг. Доступны следующие варианты отображения: «Скрытое», «Поле», «Ползунок», «Панель прогресса» и «Метка». Вариант «Поле» отображает поле ввода, вариант «Метка» — значение, вариант «Панель прогресса» — визуальное отображение прогресса, а вариант «Ползунок» — интерфейс ползунка для взаимодействия. Компонент типа «Текст» хранит строку длиной до 255 символов. Доступны следующие варианты отображения: «Скрытое», «Поле», «Метка» и «Изображение». Вариант «Поле» отображает поле ввода, вариант «Метка» — заголовок, а вариант «Изображение» требует указания URL-адреса для отображения изображения. Компонент типа «Перечисление» хранит группу именованных констант. Доступны следующие варианты отображения: «Скрытый», «Выпадающий список» и «Метка». Если вы выберете вариант «Метка», компонент по умолчанию будет отображать заголовок, но если указано изображение, оно будет иметь приоритет и отображаться вместо заголовка.

Компонент типа «Кнопка» предоставляет имитированный виртуальный ввод, позволяющий пользователям взаимодействовать с пользовательским интерфейсом, регистрируя и сообщая о кликах. Затем он отправляет уведомления через подключенные каналы и может использоваться для запуска автоматизации и активации веб-хуков. Он имеет два варианта отображения: «Кнопка», которая отображает компонент кнопки на главной странице, и «Скрытый».

Если компоненту установлен режим «Скрытый», он не будет отображаться на главной странице. В противном случае ваши группы компонентов будут отображаться под входами и/или выходами вашего устройства и будут отображать компоненты, входящие в эти группы.

Создание группы компонентов

Чтобы создать группу:

Щелкните значок «+» рядом с «Пользовательские группы», и вы перейдете в меню создания группы.
Введите имя группы.
Выберите необходимые компоненты, которые вы хотите включить в эту группу.

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

Действия с компонентами

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

Скриптинг

Компоненты могут быть включены в скрипты и запрограммированы на изменение значений в зависимости от условия. Чтобы указать компонент в скрипте, вам потребуется использовать его идентификатор (ID). Идентификаторы компонентов начинаются с 200 и ограничены 299. Вы сможете увидеть идентификатор вашего компонента в меню «Компоненты».

Для этого устройства вы можете иметь до 20 виртуальных компонентов.

Компоненты BTHome

Компоненты BTHome позволяют создавать виртуальные/динамические компоненты, сопряженные с реальными устройствами, излучающими пакеты BTHome, такими как устройства Shelly BLU. Для использования компонентов BTHome необходимо сначала установить успешное соединение Bluetooth. Если наблюдатель Bluetooth отключен, появится сообщение с информацией о том, что он отключен, а также кнопка для его включения и перезагрузки устройства.

После установления соединения, чтобы добавить устройство BTHome (Bluetooth), нажмите на знак «+» рядом с «Компонентами BTHome». Устройство выполнит поиск доступных устройств Bluetooth, но вы можете нажать кнопку «Сканировать», чтобы выполнить сканирование еще раз. Все найденные устройства отобразятся под этой кнопкой. Для того чтобы устройство было обнаружено во время сканирования, оно должно находиться в режиме сопряжения, что достигается удерживанием кнопки устройства. Другой вариант добавления устройства — использование MAC-адреса. Для этого нажмите «Добавить устройство по MAC-адресу» и введите MAC-адрес устройства, которое вы хотите добавить.

Чтобы добавить датчики, нажмите «Настроить» рядом с выбранным вами устройством Bluetooth. На этом экране вы можете присвоить имя своему устройству BTHome (Bluetooth), добавить ключ шифрования, а также ввести «URL-адрес пользовательского значка», чтобы настроить внешний вид компонента BTHome на главной странице. Ключ шифрования используется для расшифровки пакетов и может быть получен с помощью приложения «Shelly BLU Debug».

Ниже поля ключа шифрования указаны поддерживаемые датчики, которые вы можете добавить, нажав на знак «+» рядом с теми, которые хотите добавить. После добавления рядом с датчиком появится значок карандаша, и, нажав на него, вы можете изменить его имя, добавить URL-адрес пользовательского значка или использовать значок корзины для полного удаления датчика.

Чтобы сохранить компонент BTHome, нажмите «Сохранить настройки». Чтобы удалить компонент, нажмите на значок корзины над текстовыми полями.

Чтобы отредактировать компонент BTHome, нажмите на значок шестеренки. Вы перейдете к настройкам, это тот же экран, что и при добавлении компонента.

== Расширенные настройки == После нажатия на стрелку рядом с этой настройкой отобразятся расширенные настройки. Они описаны ниже.

== KVS == KVS расшифровывается как Key-Value Storage и представляет собой тип нереляционной базы данных, которая использует простой метод ключ-значение для хранения данных. В одном устройстве можно хранить до 50 пар ключ-значение. После нажатия на кнопку «Добавить значение» вы перейдете к экрану создания значения, где вам будет предложено ввести ключ (до 42 символов) и значение (до 253 символов). Под текстовым полем для значения вы увидите текущий тип значения. По умолчанию тип значения — «Число», но при вводе текста тип изменится на «Строка». Чтобы сохранить ключ, просто нажмите кнопку «Сохранить». Чтобы отредактировать существующее значение, просто щелкните по нему. Чтобы удалить пару ключ-значение, нажмите кнопку «Удалить», которая появится под ним при редактировании ключа. Щелчок по вопросительному знаку рядом с названием параметра переведет вас к документации API, где вы найдете дополнительную информацию о том, как работает «KVS» для устройств Shelly.

Диагностика

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

HTTP-пинг

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

Клиенты устройства

Просмотрите устройства, подключенные к вашему устройству, отсортированные по категориям. Для большинства устройств есть два варианта:

Клиенты Bluetooth - устройства, подключенные к вашему устройству через Bluetooth.
Клиенты AP - устройства, подключенные к точке доступа вашего устройства.

В этом меню вы сможете увидеть информацию о клиентах.