Пользовательский интерфейс менеджера

Версия: 1.26.0

Интерфейс Manager позволяет настраивать, контролировать и отслеживать IoT-платформу. Откройте адрес развернутого Manager для основной области или добавьте /manager/?realm=yourrealm для конкретной области. Ниже описаны доступные функции и необходимые права.

Чтобы получить доступ к диспетчеру, вам сначала необходимо войти в систему с правильными учетными данными (admin/секрет для вашей локальной установки). Обратите внимание, что наша служба управления учетными записями и идентификации включает в себя такие функции, как «забытый пароль». Дополнительные сведения см. в разделе Области, Пользователи и роли.

Если вы откроете приложение, вы увидите четыре основные страницы: Map, Assets, Rules и Insights. Кроме того, существует ряд Settings для соединения менеджеров, изменения языка, редактирования вашей учетной записи и создания пользователей, ролей или областей. Также здесь можно установить пользователей службы для Manager APIs.

Карта

На странице Map отобразится ваша карта. Вы можете панорамировать, масштабировать и наклонять карту. На карте отображаются все активы, у которых есть местоположение (отключите его, установив для элемента конфигурации show on dashboard значение false). Ресурсы могут иметь статические или динамические местоположения (например, автомобиль, лодка или самолет). Вы увидите направление, в котором объект смотрит или движется, если объект содержит атрибут под названием «направление». При выборе актива на панели отображаются его атрибуты и значения. Кнопка Asset details на этой панели приведет вас на соответствующую страницу актива.

В рамках настройки менеджера UI вы также можете настроить активы для изменения их цвета в зависимости от значения атрибута (числа, логического значения или строки) и отображения метки с единицами измерения или без них.

Рис. 1. Представление «Карта» с демонстрационным «Умным городом», показывающим карту с различными объектами по всему городу, а также дополнительный слой карты, показывающий основные и второстепенные автомагистрали (GeoJSON). Корабль также показывает свое направление

Дополнительную информацию см. на странице появления.

Активы

Страница Assets позволяет просматривать и изменять активы и их атрибуты. Вы увидите древовидную структуру активов слева и подробную информацию о выбранном активе справа. Страница ресурса содержит панель «Информация», панель «Атрибуты», панель «Местоположение» (если есть) и панель «История».

Панели «Информация» и «Атрибуты» дадут обзор всех атрибутов и их значений. Они могут содержать мета-, сенсорные или управляющие данные. Для атрибутов, значение которых можно изменить через пользовательский интерфейс и для которых у вас есть роль «запись» в качестве пользователя, вы можете ввести значение и нажать «ввод» или нажать стрелку send справа (например, в приведенном ниже примере атрибуты «Производитель», «Модель» и «Примечания» вводятся вручную). Другие значения атрибутов могут быть показаниями датчиков в реальном времени или автоматически обновляться правилами.

Рис. 2. Актив типа «среда»

Создайте актив

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

Рис. 3. Создание актива типа «среда» со зданием, выбранным в качестве родительского

Часто вам потребуется добавить или настроить атрибуты, чтобы определить, как они будут использоваться в системе, например. получить значения через ссылку агента, сделать атрибут доступным в правилах или отформатировать его значение. Далее мы объясним, как это работает.

Добавить атрибут

На странице «Активы» включите Edit asset (в верхней средней части страницы), что изменит представление на список всех атрибутов ресурсов. Нажмите + Add attribute внизу списка атрибутов. В модальном окне вы можете выбрать дополнительные атрибуты, уже связанные с типом актива, или создать custom attribute. Пользовательским атрибутам должно быть присвоено имя camelCase, которое будет автоматически переведено в регистр предложений с пробелами. Вы можете создавать атрибуты подготовленных типов значений, известных системе.

Рис. 4. Представление «Актив» в «режиме редактирования» при добавлении атрибута

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

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

Элементы конфигурации

Описание

Access public read

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

Access public write

Пользователи могут писать без аутентификации

Access restricted read

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

Access restricted write

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

Agent link

Определите агента, от которого извлекаются данные, включая анализ данных, см. ссылки агента

Apply predicted data points

Автоматически применять прогнозируемое значение как фактическое значение при совпадении метки времени

Attribute links

Фильтрация и анализ нескольких значений, полученных с помощью ссылки агента, см. example]

Constraints

Ограничения значений, применяемые к значению (размер/длина, регулярное выражение, не пустое и т. д.)

Data points max age days

Период времени, в течение которого хранятся данные

Forecast

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

Format

Используется для анализа данных. Доступные варианты соответствуют значениям ValueFormat платформы.

Has predicted data points

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

Label

Добавьте понятное имя, заменив имя по умолчанию.

UMECLOCK51ТОКЕН

Ввод кнопки для отправки значения «истина/включено/нажато/закрыто» при нажатии; и ложное значение при выпуске

Multiline

Указывает, что любой ввод должен поддерживать многострочный ввод текста.

Read only

Данные не могут быть заполнены через пользовательский интерфейс, только агентами или правилами.

Rule event

События сохраняются в правиле, что позволяет оценить историю изменений атрибута.

Rule event expires

Установите время жизни триггеров событий и фактов

Rule stateДобавьте этот атрибут в качестве опции для выбора в правилах слева.

Rule reset immediate

Позволяет правилу немедленно перезапуститься. Может быть полезно для данных на основе событий

Secret

Помечает значение как секретное, указывая клиентам, что оно должно отображаться скрыто.

Show on dashboard

При использовании в сочетании с «местоположением» объект будет отображаться на карте.

Store data points

Сохраняет точки данных в базе данных, по умолчанию в течение одного месяца.

Units

Добавляет единицу измерения к значению атрибута, см. composition and options.

User connected

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

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

Создать агента

Агенты — это особый тип ресурсов, используемый для подключения к внешним датчикам, исполнительным механизмам, шлюзам или службам с использованием протоколов. Они добавляются так же, как и активы, путем щелчка по + в заголовке дерева активов. Откроется модальное окно, которое покажет доступные типы агентов вверху списка. Вы увидите общие: HTTP, WebSocket, MQTT, TCP, UDP и SNMP; а также более конкретные, такие как Z-Wave, KNX или Velbus. После создания агента на странице агента будут отображаться соответствующие атрибуты, необходимые для установления фактического соединения с внешним миром.

Некоторые агенты имеют автоматическое обнаружение (например, Z-Wave) или используют файлы конфигурации (например, KNX и Velbus). На странице агента появится кнопка обнаружения или средство выбора файлов. При правильной настройке агент также создаст дополнительную структуру активов/атрибутов для всех обнаруженных или настроенных активов.

Рис. 5. Создание агента с использованием HTTP-агента (вверху) создает страницу ресурсов агента (внизу)

Обратите внимание, что вы также можете подключиться к OpenRemote через API-интерфейсы Manager без использования пользовательского интерфейса, см. параграф: Manager APIs.

Связывайте агенты и активы

Если агент не поддерживает файлы обнаружения или конфигурации, вам придется вручную связать данные, поступающие через ваши агенты, с атрибутами ваших активов. Для этого мы используем элементы конфигурации для таких атрибутов, как Agent link и Attribute link. См. руководство по подключению к OpenWeatherMap через HTTP-агент к погодному активу.

Фильтрация активов и агентов

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

Рис. 6. Фильтрация активов путем ввода имени актива (слева) или с помощью расширенного фильтра, выбора типа актива, ввода имени атрибута (без пробелов) и фильтрации по значению атрибута

Группировка активов и групповой контроль

В дереве ресурсов вы можете выбирать несколько ресурсов и коллективно добавлять их в качестве дочерних элементов в группу, просто перетаскивая их на другой актив. Вы можете использовать его, например, чтобы добавить серию источников света в качестве детей в комнату или здание. Кроме того, добавив это правило Control Groovy для каждого актива группы, вы можете управлять всеми этими дочерними активами одновременно, просто создав соответствующие атрибуты (с тем же именем и типом) в родительском активе. Итак, в случае с примером освещения: создав атрибут «onOff» (логический) в комнате или объекте здания, вы можете управлять всеми источниками света одновременно. Обратите внимание, что вы создаете правило Control Groovy для каждого родительского актива и настраиваете родительский актив в соответствии с идентификатором родительского актива. Идентификатор можно найти в URL-адресе страницы ресурса. Кроме того, не забудьте добавить элемент конфигурации «Состояние правила» к атрибуту родительского и дочернего активов.

Правила

Страница «Правила» (доступна только на экранах настольных компьютеров) позволяет создавать три типа правил:

• Правила WHEN-THEN: при выполнении определенных условий, созданных с помощью атрибутов актива, активируется действие для другого атрибута.
• FLOW: обработка атрибутов и преобразование их в новые атрибуты с помощью простого интерфейса перетаскивания.
• GROOVY: программирование любой расширенной логики с использованием атрибутов в системе. Все правила можно настроить так, чтобы они были активны только во время (повторяющегося) события, заданного планировщиком.

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

Правила When–Then

Правила «Когда-То» используют условия, заданные для атрибутов, чтобы инициировать действие для другого атрибута. Действия включают не только управление активами, но также могут использоваться для отправки электронных писем или push-уведомлений в мобильные приложения (с использованием консолей OpenRemote) или использования веб-перехватчиков.

Рис. 7. Пример «Когда-Тогда», который показывает, как на стороне «Когда» можно выбрать тип актива, а на стороне «Тогда» определяется действие, в данном случае push-уведомление.

Можно установить частоту срабатывания правил, а также расписание таймера. Частота правила (раскрывающийся список в правом верхнем углу каждой панели «Тогда») определяет, как часто может срабатывать правило. Например, «Всегда» означает каждый раз, когда условие срабатывает, но только после того, как условие стало ложным (то есть не всегда, когда оно истинно). Планировщик (рядом с полем имени правила) позволяет вам установить период повторения, а также повторять это повторение.

Рис. 8. Частота срабатывания правил (справа), а также планировщик времени (слева) определяют, когда правила срабатывают и становятся активными. В запланированном примере правило устанавливается активным до 20 июня 2022 года, только в будние дни.

Дополнительную информацию см. в документации When-Then Rules.

Flow Rules

Flow Rules можно использовать для заполнения (новых) атрибутов обработанными другими атрибутами. В визуальном редакторе вы можете использовать узлы Input (синий), Processor (зеленый) и Output (фиолетовый) и соединить их. Дополнительные сведения см. в документации Flow Rules.

Рис. 9. Flow Rules для обработки данных

Правила Groovy

Правила Groovy предназначены для более сложной обработки и автоматизации (см. пример на рис. 10). Для получения дополнительной информации см. Groovy Rules.

Рис. 10. Groovy-правила для более сложной обработки, логики или автоматизации

Глобальные правила и правила области

Как пользователь-администратор системы, имеющий доступ ко всем областям, вы можете выбрать правила «Глобальные» или «Области». Глобальные правила позволяют использовать правила When-Then и Groovy, которые могут получать доступ к ресурсам в разных областях. Пользователи области могут использовать только правила своей области и получать доступ только к её атрибутам.

Сервисы

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

Сервис прогнозирования ML с использованием нескольких регрессоров

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

Аналитика

Страница Insights (см. рис. 11) позволяет создавать несколько информационных панелей в пользовательском интерфейсе менеджера. Вы можете:

• Определите поведение информационной панели для экранов разных размеров и оптимизируйте дизайн для конкретного экрана.
• Делитесь информационными панелями с другими пользователями даже в виде отдельного приложения или сохраняйте конфиденциальность своей информационной панели.
• Сделайте информационные панели общедоступными. Обратите внимание, что для этого необходимо, чтобы активы были установлены как «общедоступные», а атрибуты — как «публично доступные для чтения».
• Делитесь информацией через консоль iOS или Android и получайте преимущества push-уведомлений (см. рис. 12).
• Используйте девять типов виджетов (или расширьте их собственным ]): линейная диаграмма, гистограмма, KPI, датчик, изображение, карта, таблица, атрибут (с контролем) и шлюз.
• Виджет шлюза позволяет открывать пользовательский интерфейс менеджера экземпляров OpenRemote, подключенных в качестве шлюзов к этому экземпляру. Техническую конфигурацию см. в разделе «Настройка туннелирования шлюза](local platform documentation)».

Рис. 11. Пример информационной панели Insights, на которой показана информационная панель с восемью различными типами виджетов.

Рис. 12. Представление Insights демонстрационной версии производителя, доступ к которой осуществляется через консоли, показывает, как ваши информационные панели легко превращаются в приложение для конечных пользователей.

Тревоги

Функционал сигналов тревоги (вверху справа) позволяет автоматически генерировать сигналы тревоги, назначать их пользователям и отслеживать их статус. Вы также можете просмотреть обзор назначенных вам сигналов тревоги, а сигналы тревоги с высоким приоритетом автоматически отправляются назначенным лицам. Поддерживаются следующие функции:

• Генерация сигналов тревоги с помощью правил: сигналы тревоги могут создаваться с помощью правил «Когда-То».
• Серьезность: сигналы тревоги высокой серьезности автоматически отправляются по электронной почте назначенному лицу.
• Назначение сигналов тревоги пользователям: исполнители всегда имеют обзор назначенных им сигналов тревоги.
• Статус: Статус указывает этапы типичного рабочего процесса: Открыто - Подтверждено - В процессе - Решено - Закрыто.
• Связанные активы: активы, вызвавшие срабатывание правила тревоги, будут отображаться, чтобы облегчить решение проблем.
• Упорядочение и фильтрация тревог.

Рис. 13. Страница аварийных сигналов с обзором всех аварийных сигналов.

Настройки и доступ

Пользователи-администраторы области «Мастер» видят переключатель областей в правом верхнем углу для переключения между областями. Кроме того, точки дают вам доступ к ряду общих настроек, а также к настройкам, связанным с доступом к учетной записи. Мы объясним это здесь:

Соединение менеджера

Вы можете связать несколько экземпляров OpenRemote (как шлюзы) с одним центральным экземпляром OpenRemote, создав актив шлюза в центральном экземпляре и связав экземпляр шлюза OpenRemote с помощью функции «Соединение менеджера». Шлюз в центральных экземплярах будет отображать активы связанного экземпляра шлюза OpenRemote как дочерние элементы актива Шлюза и обеспечит двустороннюю связь с его атрибутами. Более того, чтобы ограничить трафик, вы можете выбрать и ограничить отображаемые атрибуты, а также скорость их синхронизации с центральным экземпляром. Дополнительную информацию см. в документации по пограничному шлюзу.

Рис. 14. Несколько экземпляров OpenRemote могут быть связаны между собой, например подключение нескольких экземпляров на пограничных шлюзах к одному экземпляру, размещенному в центральном облаке. Страница Соединение менеджера, используемая в пограничных экземплярах (слева), использует ключи, созданные в центральном экземпляре путем добавления активов пограничного шлюза (справа).

Рис. 15. Рядом с соединением вы можете выбрать, какие атрибуты актива фактически связаны, а также скорость обмена данными.

Шлюзовые туннели

Помимо функции «Соединение менеджера», вы можете удалённо открыть интерфейс менеджера экземпляра OpenRemote через туннель шлюза. Дополнительную информацию см. в документации по пограничному шлюзу.

Рис. 16. Создание туннеля шлюза и открытие пользовательского интерфейса менеджера удаленного экземпляра, который подключен в качестве шлюза.

Языки

OpenRemote в настоящее время поддерживает 9 языков: английский, немецкий, французский, испанский, португальский, итальянский, китайский, украинский и голландский.

Журналы

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

Рис. 17. Страница журналов для оценки поведения системы.

Аккаунт

На странице учетной записи вы можете (пере)установить свою личную информацию или пароль. Вы также можете отслеживать свои прошлые сеансы или включить 2FA через аутентификатор (по умолчанию отключен).

Рис. 18. Страница учетной записи с контактными данными (слева) и сбросом паролей (справа).

Пользователи и конфигурация доступа

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

Свяжите ресурсы с пользователями

Связывая активы с пользователями, система поймет, какие пользователи подключены к конкретному активу. Следовательно, вы можете создать такое правило, как «Когда любой датчик температуры показывает более 100 градусов, отправьте электронное письмо связанному пользователю».

Пользователь с ограниченными правами

Если помимо привязки актива к пользователю вы также установите для роли области значение «Пользователь с ограниченными правами», пользователи будут иметь доступ только к тем активам, с которыми они связаны. Обратите внимание, что вам дополнительно необходимо указать на активах, к каким атрибутам актива они имеют доступ. Для этого установите для атрибута элемент конфигурации «Доступ ограничен для чтения/записи пользователей» (см. «Настройка атрибутов» ](/docs/user-guide/manager-ui#configure-attributes)).

Рис. 19. Создание пользователей для выбранной области, назначение ролей. В этом примере пользователь становится «пользователем с ограниченными правами», связанным только с 6 активами.

Роли

Имея правильные разрешения, вы можете создавать и редактировать роли. Эти роли определяют, какие части системы пользователю разрешено читать или записывать, например. системные настройки, активы, атрибуты, карта или правила. Также см. руководство пользователя: Реалмы, пользователи и роли.

Рис. 20. Роли состоят из набора разрешений

Области

Только администратор главной области может создавать другие области через https://your-address.example/manager. Каждая область представляет отдельный проект для своей группы пользователей или клиента платформы. Доступ к области выполняется по адресу https://your-address.example/manager/?realm=realmname. Перед первым входом администратор главной области должен создать в ней пользователя.

Вы можете создать область, добавив имя realmname (одно слово, строчные буквы) и Friendly name. Вы можете (временно) отключить области, что блокирует доступ для любого пользователя.

Рис. 21. Области можно создавать для управления несколькими независимыми проектами в одном экземпляре OpenRemote

Также см. руководство пользователя: Реалмы, пользователи и роли.

Автоматическая инициализация устройств

Если вы являетесь OEM-производителем и разрабатываете и производите собственное оборудование, вы можете подготовить свои устройства и OpenRemote для автоматического подключения ваших устройств, как только они подключатся к сети. Используя сертификаты (в настоящее время мы поддерживаем X.509), ваши устройства будут регистрироваться, автоматически генерировать и подключаться к активу определенного типа в OpenRemote Manager (см. рисунок 22). Подробную информацию см. в документации по 'Автоматической подготовке'.

Рис. 22. Автоматическая инициализация устройств

Внешний вид

Вы можете изменить стиль любой области в OpenRemote, а также настроить вид карты (перейдите в настройки/внешний вид).

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

Для добавления слоев карты вы можете добавить файлы GeoJSON (созданные, например, с помощью https://geojson.io/). Более расширенные настройки, такие как видимые типы активов и агентов на странице активов и правил, можно настроить непосредственно в файле JSON. Параметры, доступные в файле JSON, и их пример можно найти в статье Настройка диспетчера UI. Для карт вы можете установить центральную точку, уровни масштабирования и границы.

Рис. 23. Настройки внешнего вида позволяют помечать ваш менеджер OpenRemote белой маркировкой

API менеджера

API-интерфейсы Manager позволяют взаимодействовать с OpenRemote без использования пользовательского интерфейса. Это можно использовать, например. синхронизировать данные атрибутов с внешними клиентами, получать доступ к конфигурациям или создавать новые активы. Для аутентификации вам необходимо сначала создать пользователя службы на странице «Пользователи». У нас есть три типа API на выбор: HTTP, MQTT и WebSocket.

Пользователи сервиса

Пользователей службы можно создать на странице Users и выбрать Add user на панели Service user (см. рисунок 24). Username (ClientID) можно задать с помощью букв, тире и цифр, а Secret будет сгенерирован автоматически после сохранения. Обратите внимание, что вам также необходимо выбрать роль(и).

Рис. 24. Создание пользователей службы с именем пользователя, секретным ключом и ролями для выбранной области

HTTP, MQTT и WebSocket

API Manager включает HTTP, MQTT и WebSocket.

• HTTP API использует модель «запрос-ответ» и описан в локальном справочнике API.
• MQTT предоставляет обмен сообщениями по модели «издатель-подписчик».
• WebSocket предоставляет событийный обмен данными по модели «издатель-подписчик».
• MQTT — это API публикации и подписки, который позволяет подключаться к нашему MQTT-брокеру. — WebSocket API — это API публикации и подписки, основанный на событиях.

Дополнительную информацию об этих API, касающихся форматов и аутентификации, можно найти в документации к Manager APIs.

См. также

• Настройка IDE
• Работа над UI

---

Уведомление о лицензии: атрибуция документации OpenRemote