SberDevices: различия между версиями

Материал из Wiren Board
(не показано 45 промежуточных версий 1 участника)
Строка 1: Строка 1:
{{DISPLAYTITLE: Интеграция контроллера Wiren Board и умного дома Sber}}
{{DISPLAYTITLE: Интеграция контроллера Wiren Board в умный дом Sber}}
[[Image: Sber Mobile.jpg |300px|thumb|right| Диммер WB-MRGBW-D в приложении Салют ]]
{{Draft}}
== Описание ==
== Описание ==
Контроллеры [[Wiren Board]] можно интегрировать в систему умного дома от Sber и управлять вашей системой автоматизации через мобильное приложение, с помощью семейства виртуальных ассистентов «Салют» или через сценарии. Взаимодействие с контроллером и подключёнными устройствами происходит через [[MQTT]].
Контроллеры [[Wiren Board]] можно интегрировать в систему умного дома от Sber и упаравлять вашей системой автоматизации через мобильное приложение или с помощью голосового ассистента Салют.


Облачную платформу и агента для интеграции (SberDevices IoT Agent) разрабатывает компания Sber и у них есть активное коммунити разработчиков [https://t.me/smartmarket_community SmartMarket Community]. Подробные инструкции от производителя решения:
Облачную платформу и агента для интеграции разрабатывает компания Sber, вопросы можно задавать в [https://t.me/smartmarket_community Коммунити SberDevices].
* [https://developers.sber.ru/docs/ru/smarthome/mqtt-integrators/mqtt-to-integrators MQTT-to-Cloud для интегратора],
* [https://developers.sber.ru/docs/ru/smarthome/mqtt-diy/mqtt-to-diy MQTT-to-Cloud для DIY].
 
Мы опишем настройку со стороны частного разработчика (DIY), если вы интегратор — процесс создания кабинета и личного пространства у вас будет другой.


== Кабинет разработчика ==
== Кабинет разработчика ==
=== Создание ===
=== Создание ===
Создадим кабинет разработчика и получим данные для подключения, нам понадобится ''Сбер ID'':
Первым этапом надо создать кабинет разработчика и получить данные для подключения. Кабинеты бывают корпоративные для интеграторов и личные для частных разработчиков.
# Зарегистрируйтесь на сайте [https://developers.sber.ru/studio/ SmartMarket Studio] с помощью ''Сбер ID''. По умолчанию у вас будет создано ''Личное пространство'', его мы и будем использовать.
 
# Нажмите слева '''+ Создать проект'''.
Мы будем использовать личный кабинет разработчика, для этого нам понадобится ''Сбер ID'':
# Зарегистрируйтесь на сайте [https://developers.sber.ru/studio/ SmartMarket Studio] с помощью ''Сбер ID''.
# Нажмите '''Создать проект'''.
# Пролистайте вниз и выберите '''Smart Home'''.
# Пролистайте вниз и выберите '''Smart Home'''.
# Введите название проекта, выберите '''MQTT-to-Cloud для DIY''' и нажмите кнопку '''Создать проект'''.
# Введите название проекта, выберите '''MQTT-to-Cloud для DIY''' и нажмите кнопку '''Создать проект'''.
# Придумайте название контроллера и введите его в поле '''Доступ к облаку умного дома Sber'''.
# Придумайте название контроллера и введите его в поле '''Доступ к облаку умного дома Sber'''.
# Нажмите кнопку '''Получить данные для подключения''' и запишите их.
# Нажмите кнопку '''Получить данные для подключения''' и запишите их.
Если вы интегратор, используйте [https://developers.sber.ru/docs/ru/smarthome/mqtt-integrators/mqtt-to-integrators инструкцию от SverDevices].


<gallery mode="packed" heights="100px" caption="Настройка кабинета разработчика">
<gallery mode="packed" heights="100px" caption="Настройка кабинета разработчика">
Строка 32: Строка 32:


=== Добавление модели устройства ===
=== Добавление модели устройства ===
Этот шаг необязателен, но так удобнее: вы сразу задаёте набор функций устройства и потом просто прописываете MQTT-топики.
Чтобы нам было проще добавлять устройства в контроллере, создадим модель, например, типовой переключатель:
 
# Перейдите на вкладку '''Модели'''
Создадим модель, например, типовой переключатель:
# Нажмите '''Создать модель'''
# Перейдите на вкладку '''Модели'''.
# Нажмите '''Создать модель'''.
# Заполните поля:
# Заполните поля:
#* Идентификатор модели — switch
#* Идентификатор модели — switch
Строка 42: Строка 40:
#* Название модели — Switch
#* Название модели — Switch
#* Категория устройства — Реле
#* Категория устройства — Реле
#* Список функций — on_off, online. online выбирать обязательно.
#* Список функций — on_off, online
# Нажмите кнопку '''Создать модель'''.
# Нажмите кнопку '''Создать модель'''.


Переходим к установке и настройке агента на контроллере.
Переходим к установке и настройке агента на контроллер.


<gallery mode="packed" heights="100px" caption="Создание модели">
<gallery mode="packed" heights="100px" caption="Создание модели">
Строка 57: Строка 55:
{{Wbincludes:Installing Software In Console}}
{{Wbincludes:Installing Software In Console}}


Устанавливаем агента SberDevices IoT Agent:
Устанавливаем агента:
# Добавьте GPG ключ нового репозитория:
# Добавьте GPG ключ нового репозитория:
#:<syntaxhighlight lang="bash">
#:<syntaxhighlight lang="bash">
Строка 68: Строка 66:
# Обновите список пакетов и установите SberDevices IoT Agent:
# Обновите список пакетов и установите SberDevices IoT Agent:
#:<syntaxhighlight lang="bash">
#:<syntaxhighlight lang="bash">
apt update && apt install sberdevices-iot-agent
apt-get update && apt-get install sberdevices-iot-agent
</syntaxhighlight>
</syntaxhighlight>
# Закройте консоль контроллера.


Зайдите в веб-интерфейс агента, для этого откройте браузер и введите [[How to find IP address | IP-адрес своего контроллера]] в сети и порт 8083. Например: http://192.168.42.1:8083/
Интерфейс агента будет доступен по адресу http://192.168.42.1:8083/, где 192.168.42.1 — [[How to find IP address | IP-адрес вашего контроллера]], а 8083 — порт.


=== Настройка подключения ===
=== Настройка ===
Агент настраивается через свой веб-интерфейс:
Перейдите в веб-интерфес агента:
# Перейдите в веб-интерфейс SberDevices IoT Agent.
# В разделе '''Соединение''' нажмите кнопку '''Изменить'''.
# В разделе '''Соединение''' нажмите кнопку '''Изменить'''.
# Введите адрес MQTT-брокера, логин и пароль для подключения, которые вы получили в личном кабинете.
# Введите адрес, логин и пароль для подключения к облачному MQTT.
# Сохраните настройки подключения.
# Нажмите кнопку '''Обновить'''.
# Нажмите кнопку '''Обновить'''.
# Проверьте, что в разделе '''Статус''' написано '''В сети'''. Если это не так, проверьте подключение к интернету и правильнось введённых данных.
# Проверьте, что в разделе '''Статус''' написано '''В сети'''.
 
<gallery mode="packed" heights="100px" caption="Настройка соединения с облаком">
Image: Sber-Controller-1.png | Веб-интерфейс агента
Image: Sber-Controller-2.png | Настройка соединения с облаком
Image: Sber-Controller-3.png | Соединение настроено, статус ''Не в сети''
Image: Sber-Controller-4.png | После нажатия на кнопку ''Обновить''
</gallery>
 
=== Добавление устройств ===
Вам понадобятся адреса MQTT-топиков, которые можно посмотреть в [[Wiren Board Web Interface#mqtt-channels | стандартном веб-интерфейсе контроллера]].  


Добавьте новое устройство, например, Buzzer контроллера:
Добавьте новое устройство, например, Buzzer контроллера:
# Нажмите на кнопку '''Добавить устройство'''.
# Выберите модель, которую мы создали выше и впишите наименование.
# Если на этапе настройки личного кабинета вы создали модель, выберите её.
# Придумайте и впишите наименование устройства.
# На вкладке '''Функции''' укажите топики устройства в контроллере Wiren Board:
# На вкладке '''Функции''' укажите топики устройства в контроллере Wiren Board:
#* online → Объект статуса — <code>/devices/buzzer/controls/enabled: OK</code>
#* online → Объект статуса — <code>/devices/buzzer/controls/enabled: OK</code>
Строка 102: Строка 85:
#* on_off → Объект статуса — <code>/devices/buzzer/controls/enabled</code>
#* on_off → Объект статуса — <code>/devices/buzzer/controls/enabled</code>
# Нажмите кнопку '''Сохранить'''.
# Нажмите кнопку '''Сохранить'''.
# Повторите действия выше для каждого устройства.
# Нажмите кнопку Перезапустить, чтобы устройства были отправлены в облако.


После добавления устройств нажмите кнопку '''Перезапустить''' — данные о них будут отправлены в облако Sber. Перейдите в приложении «Салют» в раздел «Мой дом» и сдвиньте экран вниз, чтобы обновился список.
После этого они будут доступны в приложении Салют.
 
<gallery mode="packed" heights="150px" caption="Создание Buzzer (Реле)">
Image: Sber-Controller-Device-1.png | Buzzer: Описание
Image: Sber-Controller-Device-2.png | Buzzer: Функции
</gallery>
 
<gallery mode="packed" heights="100px" caption="Создание светодиодного диммера">
Image: Sber-Controller-Device-WB-MRGBW-D-1.png | WB-MRGBW-D: Описание
Image: Sber-Controller-Device-WB-MRGBW-D-2.png | WB-MRGBW-D: Функции
Image: Sber-Controller-Device-WB-MRGBW-D-3.png | WB-MRGBW-D: Функции
</gallery>


== Настройка мобильного приложения ==
== Настройка мобильного приложения ==
Установите мобильное приложение [https://sberdevices.ru/app/ Салют] и авторизуйтесь в нём.
Соданные выше устройства будут доступны в разделе '''Умный дом'''.
<gallery mode="packed" heights="350px" caption="Мобильное приложение Салют">
Image: Sber Mobile-1.jpg | Кнопка ''Умный дом''
Image: Sber Mobile-2.jpg | Список устройств
Image: Sber Mobile-3.jpg | Диммер WB-MRGBW-D
</gallery>
== Удаление агента ==
Если ''SberDevices IoT Agent'' больше не нужен, его можно удалить:
# Удалите пакет:
#:<syntaxhighlight lang="bash">
apt remove sberdevices-iot-agent
</syntaxhighlight>
# Удалите файл со ссылкой на репозиторий:
#:<syntaxhighlight lang="bash">
rm /etc/apt/sources.list.d/sberdevices-iot.list
</syntaxhighlight>
# Обновите список доступных системе пакетов:
#:<syntaxhighlight lang="bash">
apt update
</syntaxhighlight>


== Полезные ссылки ==
== Полезные ссылки ==
* [https://developers.sber.ru/docs/ru/smarthome/mqtt-integrators/mqtt-to-integrators Инструкция для интеграторов],
* [https://sberdevices.ru/help/smarthome/third-party-how-to-add-integrator/ Инструкция по настройке]
* [https://developers.sber.ru/docs/ru/smarthome/mqtt-diy/mqtt-to-diy Инструкция для частных разработчиков].
* [https://t.me/smartmarket_community Коммунити SberDevices]
* [https://t.me/smartmarket_community Коммунити SberDevices]
* [https://habr.com/ru/company/sberdevices/news/t/659555/ Статья про интеграцию на Хабре]
* [https://habr.com/ru/company/sberdevices/news/t/659555/ Статья на Хабре]
 
{{Wbincludes: Supported Devices}}

Версия 20:13, 25 мая 2022

Это черновик страницы. Последняя правка сделана 25.05.2022 пользователем A.Degtyarev.

Описание

Контроллеры Wiren Board можно интегрировать в систему умного дома от Sber и упаравлять вашей системой автоматизации через мобильное приложение или с помощью голосового ассистента Салют.

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

Кабинет разработчика

Создание

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

Мы будем использовать личный кабинет разработчика, для этого нам понадобится Сбер ID:

  1. Зарегистрируйтесь на сайте SmartMarket Studio с помощью Сбер ID.
  2. Нажмите Создать проект.
  3. Пролистайте вниз и выберите Smart Home.
  4. Введите название проекта, выберите MQTT-to-Cloud для DIY и нажмите кнопку Создать проект.
  5. Придумайте название контроллера и введите его в поле Доступ к облаку умного дома Sber.
  6. Нажмите кнопку Получить данные для подключения и запишите их.

Если вы интегратор, используйте инструкцию от SverDevices.

  • Настройка кабинета разработчика

  • Страница регистрации

  • Вход по Сбер ID

  • Вход по Сбер ID

  • Соглашение

  • Личный кабинет разработчика

  • Создание проекта

  • Выбор типа интеграции

  • Данные для входа

Добавление модели устройства

Чтобы нам было проще добавлять устройства в контроллере, создадим модель, например, типовой переключатель:

  1. Перейдите на вкладку Модели
  2. Нажмите Создать модель
  3. Заполните поля:
    • Идентификатор модели — switch
    • Производитель — Wiren Board
    • Название модели — Switch
    • Категория устройства — Реле
    • Список функций — on_off, online
  4. Нажмите кнопку Создать модель.

Переходим к установке и настройке агента на контроллер.

  • Создание модели

  • Кнопка Создать модель

  • Идентификатор, производитель и название

  • Категория устройства и список функций

Установка и настройка агента

Установка

Копируйте команды из инструкции, вставляйте их в консоль контроллера с помощью клавиш Shift+Insert и запускайте клавишей Enter. В случае ошибок, внимательно читайте вывод, там будут инструкции и подсказки.

Устанавливаем агента:

  1. Добавьте GPG ключ нового репозитория: 
    wget -q -O - https://nexus.iot.sberdevices.ru/repository/gpg-wirenboard/public.gpg.key | apt-key add -
  2. Добавьте ссылку на репозиторий в список apt: 
    echo "deb https://nexus.iot.sberdevices.ru/repository/wirenboard/ main main" | tee -a /etc/apt/sources.list.d/sberdevices-iot.list
  3. Обновите список пакетов и установите SberDevices IoT Agent: 
    apt-get update && apt-get install sberdevices-iot-agent

Интерфейс агента будет доступен по адресу http://192.168.42.1:8083/, где 192.168.42.1 — IP-адрес вашего контроллера, а 8083 — порт.

Настройка

Перейдите в веб-интерфес агента:

  1. В разделе Соединение нажмите кнопку Изменить.
  2. Введите адрес, логин и пароль для подключения к облачному MQTT.
  3. Нажмите кнопку Обновить.
  4. Проверьте, что в разделе Статус написано В сети.

Добавьте новое устройство, например, Buzzer контроллера:

  1. Выберите модель, которую мы создали выше и впишите наименование.
  2. На вкладке Функции укажите топики устройства в контроллере Wiren Board:
    • online → Объект статуса — /devices/buzzer/controls/enabled: OK
    • on_off → Объект команды — /devices/buzzer/controls/enabled
    • on_off → Объект статуса — /devices/buzzer/controls/enabled
  3. Нажмите кнопку Сохранить.
  4. Нажмите кнопку Перезапустить, чтобы устройства были отправлены в облако.

После этого они будут доступны в приложении Салют.

Настройка мобильного приложения

Полезные ссылки

Источник — https://wirenboard.com/wiki/index.php?title=SberDevices&oldid=62375