Перейти к содержанию

Getting-started-for-integrators: различия между версиями

Материал из XIOT Wiki
← Предыдущая правкаСледующая правка →

Admin (обсуждение | вклад)

3 группы участника
3500 правок
ВизуальныйВики-текст
COR-06: единый словарь действий и адресов управления/состояния
NAV-05: линейный быстрый старт интегратора и прямые редиректы старых маршрутов
Строка 1: Строка 1:
''Краткая пошаговая инструкция для Интегратора''
Этот чек-лист ведёт интегратора от регистрации до проверки готового проекта и его передачи владельцу. Выполняйте шаги по порядку: каждый шаг заканчивается проверяемым результатом.


== '''📝''' 1. Регистрация и создание проекта ==
== 1. Зарегистрируйтесь в XIOT-EDITOR ==


* Перейдите на сайт [https://xiot.pro https://xiot.pro] и зарегистрируйтесь, указав email интегратора и пароль.
# Откройте [https://xiot.pro xiot.pro] в актуальной версии Google Chrome или Safari на компьютере или ноутбуке.
* Рассчитайте состав в [https://xiot.ru/xiot_calc_license.html калькуляторе лицензии ПО XIOT] и приобретите лицензию для проекта.
# Зарегистрируйте учётную запись по email и паролю.
* После покупки получите лицензионный ключ на email интегратора.
* Войдите в XIOT-EDITOR под этой учётной записью и активируйте ключ. При активации будет создан новый проект.
* Учётная запись интегратора получит в проекте роли '''Владелец''' и '''Интегратор'''.


Для каждого следующего проекта требуется отдельная лицензия и новый лицензионный ключ.
'''Результат:''' вы входите в XIOT-EDITOR под учётной записью интегратора. 
'''Подробнее:''' [[Регистрация в редакторе]], [[Доступ к XIOT-EDITOR]]. 
'''Далее:''' получите лицензионный ключ и создайте проект.


[[Регистрация_в_редакторе|Подробно про регистрацию в редакторе]]
== 2. Получите лицензию и создайте проект ==
[[Получение лицензионного ключа|Получение и активация лицензионного ключа]]


== '''🛠️'''2. Работа в редакторе XIOT ==
# Рассчитайте состав в [https://xiot.ru/xiot_calc_license.html калькуляторе лицензии XIOT] и приобретите лицензию.
# Получите ключ на email, войдите в XIOT-EDITOR и активируйте ключ. Для каждого следующего проекта нужны отдельная лицензия и новый ключ.


* Редактор работает в браузере и не требует установки. Откройте [https://xiot.pro https://xiot.pro] на компьютере или ноутбуке; актуальный список поддерживаемых браузеров приведён в статье [[Доступ к XIOT-EDITOR]].
'''Результат:''' в XIOT-EDITOR создан новый проект; интегратор получил в нём роли '''Владелец''' и '''Интегратор'''.
* '''Клавиша F2 переключает просмотр и редактирование, а не режимы Lite и Pro'''. На некоторых ноутбуках используйте '''Fn + F2'''.
'''Подробнее:''' [[Получение лицензионного ключа]], [[Лицензирование XIOT]].
* '''Lite и Pro — два режима одного XIOT-EDITOR''' и одного проекта. Переключение выполняется кнопкой '''LITE / PRO''' и не создаёт второй проект.
'''Далее:''' установите XIOT-PLC.


Подробнее о режимах: [[Lite и Pro версии редактора]].
== 3. Установите XIOT-PLC ==
Основные действия и точные термины: [[Основные термины и сокращения]].


=== '''⚡''' Lite (основной режим) ===
# Выберите поддерживаемое устройство-хост с Debian-совместимой Linux-системой и архитектурой <code>armhf</code>, <code>arm64</code> или <code>amd64</code>.
* Интерфейс создаётся автоматически по структуре: этажи, комнаты, устройства.
# Скачайте актуальный DEB-пакет XIOT-PLC по официальной ссылке и установите его с правами администратора. Не отключайте проверку TLS-сертификата.
* Используется как стандартный пользовательский интерфейс проекта.


=== '''⚙️''' Pro (дополнительный режим) ===
'''Результат:''' служба XIOT-PLC установлена и запущена на устройстве-хосте. 
* Позволяет вручную создавать дополнительные страницы, окна и элементы интерфейса.
'''Подробнее:''' [[Установка XIOT-PLC на контроллер]].
* Используется вместе с Lite для технических и специализированных страниц.
'''Далее:''' привяжите XIOT-PLC к проекту.


== 3. Установка XIOT-PLC на устройство-хост и привязка к проекту ==
== 4. Привяжите XIOT-PLC к проекту ==


'''📦 Установка XIOT-PLC на поддерживаемое устройство-хост или контроллер'''
# Из доверенной локальной сети откройте <code>http://&lt;IP_устройства&gt;:5551</code>; не публикуйте этот порт в интернете.
# Введите те же email и пароль, что и в XIOT-EDITOR, выберите проект и выполните привязку.


Поддерживаются Wiren Board 6/7/8/9, JetHome, Raspberry Pi, Orange Pi, NanoPi, x86-ПК/Intel NUC и VDS/VPS на архитектурах <code>armhf</code>, <code>arm64</code> и <code>amd64</code>. Требуется Debian-совместимая Linux-система.
'''Результат:''' в слоте <code>plc1</code> проекта отображается привязанный XIOT-PLC. Сейчас к одному проекту привязывается один XIOT-PLC.
'''Подробнее:''' [[Связываем XIOT-PLC с редактором XIOT|Привязка XIOT-PLC к проекту]]. 
'''Далее:''' создайте структуру объекта.


1. Подключитесь по SSH к устройству-хосту (например, через программу PuTTY).
== 5. Создайте структуру и виртуальные устройства ==


# Нажмите '''F2''' или '''Fn + F2''', чтобы включить редактирование. F2 не переключает Lite и Pro.
# Создайте этажи, комнаты и виртуальные устройства. Lite автоматически формирует стандартный интерфейс, Pro позволяет добавлять свои страницы и элементы. Это два режима одного проекта.


2. Установите пакет XIOT-PLC командой:
'''Результат:''' структура объекта и нужные виртуальные устройства видны в редакторе.
<pre>
'''Подробнее:''' [[Создание виртуальных устройств]], [[Lite и Pro версии редактора]], [[Назначение и возможности Pro версии редактора]]. 
wget https://xiot.pro/system/public/xiot.deb -O xiot.deb && dpkg -i xiot.deb
'''Далее:''' настройте связь с физическим оборудованием.
</pre>


Не отключайте проверку TLS-сертификата при скачивании.
== 6. Настройте драйверы и адреса ==


3. Из доверенной локальной сети откройте в браузере <code>http://&lt;IP_устройства&gt;:5551</code>. Не публикуйте этот порт в интернет.
# Добавьте нужные драйверы XIOT, например Wiren Board или KNX. Драйвер XIOT — интеграционный модуль XIOT-PLC, а не системная служба производителя.
# Назначьте характеристикам виртуальных устройств '''адрес управления''' для исходящей команды и '''адрес состояния''' для фактического состояния или обратной связи.


4. Введите те же email и пароль, с которыми вы входите в текущий XIOT-EDITOR.
'''Результат:''' физические сигналы связаны с характеристиками виртуальных устройств.
'''Подробнее:''' [[Настройка драйверов]], [[Привязка реальных устройств к виртуальным]], [[Основные термины и сокращения]]. 
'''Далее:''' создайте и проверьте сценарии.


5. Выберите проект из списка и привяжите установленный XIOT-PLC к этому проекту.
== 7. Добавьте и проверьте сценарии ==


В текущей версии к одному проекту привязывается один XIOT-PLC. Он может использовать до шести MQTT-подключений Wiren Board. Несколько XIOT-PLC в одном проекте, в том числе для гостиничных объектов, находятся в планах и пока не описываются как доступная функция.
# Добавьте готовые или пользовательские сценарии.
# Проверьте условия запуска, действия и переходы между состояниями.


'''Результат:''' поведение устройств и сценариев соответствует проектной логике в редакторе. 
'''Подробнее:''' [[Сценарии]], [[Обзор инструментов и меню PRO версии редактора]]. 
'''Далее:''' проверьте ручное сохранение.


[[Установка_XIOT-PLC_на_контроллер|Установка XIOT-PLC на устройство-хост или контроллер]]
== 8. Создайте самостоятельную контрольную точку ==
[[Связываем_XIOT-PLC_с_редактором_XIOT|Привязка XIOT-PLC к проекту]]


== 4. Настройка структуры проекта ==
# Во время настройки, например после отдельного этапа вёрстки в Pro, нажмите '''Сохранить проект'''.
# Убедитесь, что появилась новая версия. Если нужна облачная копия, дождитесь статуса '''В облаке'''.


'''🏗️ Настройка проекта'''
'''Результат:''' создана отдельная версия-контрольная точка. Это действие не изменяет XIOT-PLC и не является техническим условием загрузки. 
'''Подробнее:''' [[Сохранение резервной копии проекта]]. 
'''Далее:''' завершите настройку, а затем загрузите готовую конфигурацию.


1. Создайте этажи, комнаты и виртуальные устройства (освещение, розетки, датчики и т.д.).
== 9. Загрузите конфигурацию на XIOT-PLC ==


2. В разделе '''Драйверы''' настройте драйвер XIOT для связи с оборудованием, например Wiren Board или KNX. Драйвер XIOT — интеграционный модуль XIOT-PLC, а не системная служба производителя оборудования.
# Нажмите '''Загрузить конфигурацию на контроллер''' и дождитесь завершения без ошибок.


3. Назначьте характеристикам виртуальных устройств адреса управления и состояния, которые предоставляет драйвер XIOT.
Команда сама сохраняет проект, создаёт одну новую версию и передаёт на привязанный XIOT-PLC точный снимок этой версии. Не сохраняйте проект ещё раз непосредственно перед загрузкой без специальной причины.


4. Вся настройка осуществляется через визуальный интерфейс, без необходимости знания системных переменных.
'''Результат:''' XIOT-PLC работает с точным снимком версии, созданной командой загрузки. 
'''Подробнее:''' [[Основные термины и сокращения]], [[Настройка драйверов]].
'''Далее:''' проверьте проект через XIOT-APP.


== 5. Добавление сценариев ==
== 10. Проверьте проект в XIOT-APP ==


'''⏱️'''
# Установите XIOT-APP на телефон или планшет, войдите по email и паролю и откройте нужный проект.
# Измените состояние одного безопасного тестового устройства. Убедитесь, что команда выполнена, а адрес состояния показал фактическую обратную связь.
# Проверьте основные экраны, сценарии и критичные состояния.


* Используйте готовые сценарии из библиотеки:
'''Результат:''' проект открывается в XIOT-APP, команды доходят до оборудования, а обратная связь показывает фактическое состояние.
** биодинамическое освещение;
'''Подробнее:''' [[Приложение для телефона и планшета XIOT-APP]].
** имитация рассвета и заката;
'''Далее:''' подготовьте проект к передаче владельцу.
** рабочий ритм;
** отключение света;
** управление поливом и др.
* Либо создайте '''кастомный сценарий''' визуально, без программирования.
* Сценарии можно запускать:
** по времени;
** по изменению статусов;
** по действиям пользователя;
** по логическим условиям.


Чтобы применить проверенную конфигурацию, нажмите '''Загрузить конфигурацию на контроллер'''. Команда сама сохранит проект, создаст одну новую версию и передаст на привязанный XIOT-PLC точный снимок этой версии. Отдельное сохранение полезно как самостоятельная контрольная точка, особенно во время вёрстки в Pro, но не выполняйте его непосредственно перед загрузкой без специальной причины.
== 11. Передайте проект владельцу ==


== '''🔁'''6. Передача проекта владельцу ==
# Убедитесь, что проект проверен на объекте и через XIOT-APP.
# Нажмите '''Сохранить проект''' и дождитесь статуса '''В облаке'''. Эта контрольная точка нужна для административной передачи и не заменяет загрузку на XIOT-PLC.
# Подготовьте данные нового владельца и выполните передачу после подтверждения сторон.


При создании проекта интегратор получает роли '''Владелец''' и '''Интегратор'''. После завершения работ:
'''Результат:''' владелец получил проект, а интегратор и владелец проверили доступ и роли.
 
'''Подробнее:''' [[Передача проекта новому владельцу]], [[Как сменить интегратора в XIOT]], [[Роли пользователей в XIOT]]. 
# сохраните актуальную версию проекта и дождитесь статуса '''В облаке''';
'''Далее:''' передайте владельцу ссылку на [[Связь с поддержкой]] и зафиксируйте итоговую документацию по объекту.
# подготовьте данные нового владельца;
# выполните передачу по административной процедуре после подтверждения сторон.
 
Подробный порядок: [[Передача проекта новому владельцу]]. Если требуется назначить другого интегратора, см. [[Как сменить интегратора в XIOT]].
 
== '''👥'''Роли в системе XIOT (кратко) ==
 
 
* '''Интегратор''' — настраивает проект и интерфейс, устанавливает XIOT-PLC на поддерживаемое устройство-хост, привязывает его к проекту и передаёт проект владельцу.
* '''Владелец''' — управляет пользователями, может отключить Интегратора или передать проект.
* '''Пользователь''' — работает только с интерфейсом, не имеет доступа к настройкам.
* '''Разработчик''' — сотрудник XIOT, развивает платформу, не участвует в пользовательских проектах.
[[Роли_пользователей_в_XIOT | Подробно про роли пользователей в XIOT]]

Версия от 09:41, 24 августа 2026

Этот чек-лист ведёт интегратора от регистрации до проверки готового проекта и его передачи владельцу. Выполняйте шаги по порядку: каждый шаг заканчивается проверяемым результатом.

1. Зарегистрируйтесь в XIOT-EDITOR

  1. Откройте xiot.pro в актуальной версии Google Chrome или Safari на компьютере или ноутбуке.
  2. Зарегистрируйте учётную запись по email и паролю.

Результат: вы входите в XIOT-EDITOR под учётной записью интегратора. Подробнее: Регистрация в редакторе, Доступ к XIOT-EDITOR. Далее: получите лицензионный ключ и создайте проект.

2. Получите лицензию и создайте проект

  1. Рассчитайте состав в калькуляторе лицензии XIOT и приобретите лицензию.
  2. Получите ключ на email, войдите в XIOT-EDITOR и активируйте ключ. Для каждого следующего проекта нужны отдельная лицензия и новый ключ.

Результат: в XIOT-EDITOR создан новый проект; интегратор получил в нём роли Владелец и Интегратор. Подробнее: Получение лицензионного ключа, Лицензирование XIOT. Далее: установите XIOT-PLC.

3. Установите XIOT-PLC

  1. Выберите поддерживаемое устройство-хост с Debian-совместимой Linux-системой и архитектурой armhf, arm64 или amd64.
  2. Скачайте актуальный DEB-пакет XIOT-PLC по официальной ссылке и установите его с правами администратора. Не отключайте проверку TLS-сертификата.

Результат: служба XIOT-PLC установлена и запущена на устройстве-хосте. Подробнее: Установка XIOT-PLC на контроллер. Далее: привяжите XIOT-PLC к проекту.

4. Привяжите XIOT-PLC к проекту

  1. Из доверенной локальной сети откройте http://<IP_устройства>:5551; не публикуйте этот порт в интернете.
  2. Введите те же email и пароль, что и в XIOT-EDITOR, выберите проект и выполните привязку.

Результат: в слоте plc1 проекта отображается привязанный XIOT-PLC. Сейчас к одному проекту привязывается один XIOT-PLC. Подробнее: Привязка XIOT-PLC к проекту. Далее: создайте структуру объекта.

5. Создайте структуру и виртуальные устройства

  1. Нажмите F2 или Fn + F2, чтобы включить редактирование. F2 не переключает Lite и Pro.
  2. Создайте этажи, комнаты и виртуальные устройства. Lite автоматически формирует стандартный интерфейс, Pro позволяет добавлять свои страницы и элементы. Это два режима одного проекта.

Результат: структура объекта и нужные виртуальные устройства видны в редакторе. Подробнее: Создание виртуальных устройств, Lite и Pro версии редактора, Назначение и возможности Pro версии редактора. Далее: настройте связь с физическим оборудованием.

6. Настройте драйверы и адреса

  1. Добавьте нужные драйверы XIOT, например Wiren Board или KNX. Драйвер XIOT — интеграционный модуль XIOT-PLC, а не системная служба производителя.
  2. Назначьте характеристикам виртуальных устройств адрес управления для исходящей команды и адрес состояния для фактического состояния или обратной связи.

Результат: физические сигналы связаны с характеристиками виртуальных устройств. Подробнее: Настройка драйверов, Привязка реальных устройств к виртуальным, Основные термины и сокращения. Далее: создайте и проверьте сценарии.

7. Добавьте и проверьте сценарии

  1. Добавьте готовые или пользовательские сценарии.
  2. Проверьте условия запуска, действия и переходы между состояниями.

Результат: поведение устройств и сценариев соответствует проектной логике в редакторе. Подробнее: Сценарии, Обзор инструментов и меню PRO версии редактора. Далее: проверьте ручное сохранение.

8. Создайте самостоятельную контрольную точку

  1. Во время настройки, например после отдельного этапа вёрстки в Pro, нажмите Сохранить проект.
  2. Убедитесь, что появилась новая версия. Если нужна облачная копия, дождитесь статуса В облаке.

Результат: создана отдельная версия-контрольная точка. Это действие не изменяет XIOT-PLC и не является техническим условием загрузки. Подробнее: Сохранение резервной копии проекта. Далее: завершите настройку, а затем загрузите готовую конфигурацию.

9. Загрузите конфигурацию на XIOT-PLC

  1. Нажмите Загрузить конфигурацию на контроллер и дождитесь завершения без ошибок.

Команда сама сохраняет проект, создаёт одну новую версию и передаёт на привязанный XIOT-PLC точный снимок этой версии. Не сохраняйте проект ещё раз непосредственно перед загрузкой без специальной причины.

Результат: XIOT-PLC работает с точным снимком версии, созданной командой загрузки. Подробнее: Основные термины и сокращения, Настройка драйверов. Далее: проверьте проект через XIOT-APP.

10. Проверьте проект в XIOT-APP

  1. Установите XIOT-APP на телефон или планшет, войдите по email и паролю и откройте нужный проект.
  2. Измените состояние одного безопасного тестового устройства. Убедитесь, что команда выполнена, а адрес состояния показал фактическую обратную связь.
  3. Проверьте основные экраны, сценарии и критичные состояния.

Результат: проект открывается в XIOT-APP, команды доходят до оборудования, а обратная связь показывает фактическое состояние. Подробнее: Приложение для телефона и планшета XIOT-APP. Далее: подготовьте проект к передаче владельцу.

11. Передайте проект владельцу

  1. Убедитесь, что проект проверен на объекте и через XIOT-APP.
  2. Нажмите Сохранить проект и дождитесь статуса В облаке. Эта контрольная точка нужна для административной передачи и не заменяет загрузку на XIOT-PLC.
  3. Подготовьте данные нового владельца и выполните передачу после подтверждения сторон.

Результат: владелец получил проект, а интегратор и владелец проверили доступ и роли. Подробнее: Передача проекта новому владельцу, Как сменить интегратора в XIOT, Роли пользователей в XIOT. Далее: передайте владельцу ссылку на Связь с поддержкой и зафиксируйте итоговую документацию по объекту.

Источник — https://wiki.xiot.ru/index.php?title=Getting-started-for-integrators&oldid=3809