Устройство

Данный контекст предоставляет Вам доступ к одному устройству и позволяет им управлять.

Уникальные действия

[?]

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

Редактировать свойства аккаунта устройства

Это действие позволяет получить подробную информацию о том, как AggreGate Server соединяется и взаимодействует с настраиваемым устройством, а также предоставляет доступ к нескольким группам свойств, специфичным для устройств в AggreGate:

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

Тип действия:

настроить

Имя действия:

setup

Иконка действия:

Права доступа:

Доступно на уровне с правами доступа для Менеджера.  

Управление устройством

(действие по умолчанию)

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

Имя действия:

manage

Иконка действия:

Не интерактивный режим:

не поддерживается

Права доступа:

Доступно на уровне с правами доступа для Наблюдателя.

Конфигурировать устройство

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

Тип действия:

настроить

Синхронизировать

Это действие сразу же запускает синхронизацию между AggreGate Server и устройством.

Тип действия:

вызвать функцию

Имя действия:

synchronize

Иконка действия:

Права доступа:

Доступно на уровне с правами доступа для Оператора.

Переинициализировать драйвер устройства

Это действие очищает кэш настроек устройства, удаляет всю другую информацию об устройстве, о которой помнит AggreGate Server. Затем запускает синхронизацию так, как если бы устройство было подключено к AggreGate Server в первый раз.

Тип действия:

вызвать функцию

Имя действия:

reset

Иконка действия:

Права доступа

Доступно на уровне с правами доступа для Менеджера.

Общие действия

[?]

Удалить, реплицировать, редактировать права доступа, просмотр событий, показать статус

Действия, связанные с переменной

[?]

Параметры синхронизации настроек устройства

Это действие позволяет редактировать опции синхронизации для определенной, предоставленной устройством настройки. Оно доступно лишь для входящих от устройства переменных.

Имя действия:

editVariableSyncOptions

Не интерактивный режим:

не поддерживается

Права доступа:

Доступно на уровне с правами доступа для Менеджера.

Состояния и иконки контекста

Информация о статусах устройства доступна здесь.

Иконка

Код

Состояние

20

режим Offline, синхронизировано

21

режим Online, синхронизировано

22

приостановлено, синхронизировано

23

статус подключения не известен, синхронизировано

30

режим Offline, ожидает синхронизации

31

режим Online, ожидает синхронизации

32

приостановлено, ожидает синхронизации

33

статус подключения не известен, ожидает синхронизации

40

режим Offline, ошибка синхронизации

41

режим Online, ошибка синхронизации

42

приостановлен, ошибка синхронизации

43

статус подключения не известен, ошибка синхронизации

50

режим Offline, не синхронизировано, или синхронизация выполняется.

51

режим Online, не синхронизировано, или синхронизация выполняется

52

приостановлено, не синхронизировано, или синхронизация выполняется

53

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

70

режим Offline, подключается (только статус с расширенными полномочиями (extended status))

71

режим Online, подключается (только статус c расширенными полномочиями, AggreGate Server запросил повторное подключение)

72

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

73

статус подключения не известен, подключается (только статус c расширенными полномочиями)

80

режим Offline, читает метаданные (только статус c расширенными полномочиями, означает, что соединение было разорвано во время чтения метаданных, а синхронизация прервана)

81

режим Online, читает метаданные (только статус c расширенными полномочиями)

82

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

83

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

90

режим Offline, выполняется синхронизации параметров (только статус c расширенными полномочиями, означает, что соединение было разорвано во время синхронизации параметров, а синхронизация прервана)

91

режим Online, выполняется синхронизации параметров (только статус c расширенными полномочиями)

92

приостановлено, выполняется синхронизации параметров (только статус c расширенными полномочиями, означает, что устройство было приостановлено во время синхронизации параметров)

93

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

Дополнительная информация

Информация о контексте

Тип контекста: device.DEVICE_TYPE

Имя контекста: предоставляется Драйвером устройства

Описание контекста: предоставляется Драйвером устройства

Путь контекста: users.USER_NAME.devices.NAME_OF_THIS_CONTEXT

Контекстная маска: users.*.devices.*

Права доступа к контексту

[?]

Уровень

Описание

Отсутствует

Нет доступа.

Наблюдатель

Просмотр настроек устройства.

Мониторинг основных событий.

Просмотр статуса.

Оператор

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

Редактирование настроек устройства.

Выполнение операций устройства.

Мониторинг событий устройства.

Запрос синхронизации устройства.

Менеджер

Конфигурация свойств учетной записи устройства.

Удаление устройства.

Переустановка драйвера устройства.

Просмотр статистических данных.

Инженер

Те же, что у Менеджера.

Администратор

Те же, что у Менеджера.

Общие переменные (свойства)

[?]

Некоторые общие переменные данного контекста зависят от типа представленного им устройства. AggreGate Server создает одну общую переменную в данном контексте для каждой настройки устройства. Переменные, относящиеся к параметрам устройства, доступны для чтения на уровне с правами доступа для Наблюдателя и доступны для записи для Оператора.

Общие переменные: groupMembership (членство группы), activeAlerts (Active Alerts)

Общие свойства устройства

Содержит типовые свойства устройств.

Имя переменной:

genericProperties

Записи:

1

Права доступа:

Доступно для чтения уровне с правами доступа для Наблюдателя, доступно для записи для Менеджера.

Формат записи:

Имя поля

Тип поля

Примечания

name

Строка


description

Строка


type

Строка


syncPeriod

Длинное

Измеряется в миллисекундах

startSyncOnSettingChange

Булевое


interruptOnError

Булевое


suspend

Булевое


disableSynchronousSettingValueRW

Булевое


extendedStatus

Булевое


syncQueueLength

Целое


timeZone

Строка


metadata

Целое


activeEntities

Целое


cache

Целое


settingsDefaultQuality

Целое


eventStoragePeriod

Длинное


dependency

Строка


status

Строка


color

Строка


latitude

Строка


longitude

Строка


locationStoragePeriod

Длинное


offlineAlert

Булевое


virtualNetwork

Строка


Каналы статистики

Эта переменная позволяет управлять статистическими каналами устройства.

Имя переменной:

statisticsProperties

Записи:

0...не ограничено

Права доступа:

Доступно для чтения на уровне прав доступа Наблюдатель, доступно для записи для Менеджера.

Формат записи:

Имя поля

Тип поля

Примечания

name

Строка

Имя канала.

variable

Строка

Имя переменной, на которой базируется канал.

properties

Таблица данных

Свойства канала.

Параметры синхронизации настроек устройства

Содержит опции синхронизации для каждой из настроек устройства.

Имя переменной:

settingSyncOptions

Записи:

0...не ограничено

Права доступа:

Доступно для чтения на уровне прав доступа Наблюдатель, доступно для записи для Менеджера.

Формат записи:

Имя поля

Тип поля

Примечания

name

Строка


description

Строка


mode

Целое


updateHistoryStorageTime

Длинное

измеряется в миллисекундах

syncPeriod

Длинное

измеряется в миллисекундах

filter

Строка

поле может не иметь значения (определено как "nullable")

master

Строка


addPreviousValueToVariableUpdateEvent

Булевое


Активы

Эта переменная позволяет управлять активами устройства.

Имя переменной:

assets

Записи:

0...не ограничено

Права доступа:

Доступно для чтения на уровне прав доступа Наблюдатель, доступно для записи для Менеджера.

Формат записи:

Имя поля

Тип поля

Примечания

id

Строка

Уникальный ID актива.

description

Строка

Описание актива в удобной для пользователя форме.

enabled

Булевое

Флажок, указывающий, активирован ли актив, и доступны ли его члены (параметры, операции и события) в AggreGate.

children

Таблица данных

Список вложенных активов. Его формат аналогичен формату данной переменной.

Переменные

Эта таблица позволяет выбрать, какие настройки устройства будут использоваться в контексте Device. Активирован, если опция активные сущности установлена на выбранные сущности.

Имя переменной:

managedVariables

Записи:

0...не ограничено

Права доступа:

Доступно для чтения на уровне прав доступа Наблюдатель, доступно для записи для Менеджера.

Формат записи:

Имя поля

Тип поля

Примечания

name

Строка

Имя переменной.

description

Строка

Описание переменной.

group

Строка

Группа переменной.

active

Булевое

Флажок, определяющий, будет ли переменная использоваться контекстом устройства.

Функции

Эта таблица позволяет выбрать, какие операции устройства будут использоваться в контексте Device. Активирован, если опция активные сущности установлена на выбранные сущности.

Имя переменной:

managedFunctions

Записи:

0...не ограничено

Права доступа:

Доступно для чтения на уровне прав доступа Наблюдатель, доступно для записи для Менеджера.

Формат записи:

Имя поля

Тип поля

Примечания

name

Строка

Имя функции.

description

Строка

Описание функции.

group

Строка

Группа функции.

active

Булевое

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

События

Эта таблица позволяет выбрать, какие события устройства будут использоваться в контексте Device. Активирован, если опция активные сущности установлена на выбранные сущности.

Имя переменной:

managedEvents

Записи:

0...не ограничено

Права доступа:

Доступно для чтения на уровне прав доступа Наблюдатель, доступно для записи для Менеджера.

Record Format:

Имя поля

Тип поля

Примечания

name

Строка

Имя события.

description

Строка

Описание события.

group

Строка

Группа события.

active

Булевое

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

Статус

Возвращает статус устройства.

Имя переменной:

status

Записи:

1

Права доступа:

Доступно для чтения на уровне с правами доступа для Наблюдателя.

Формат записи:

Имя поля

Тип поля

Примечания

status

Строка

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

color

Цвет

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

driver

Строка

драйвер устройства

syncTime

Дата

Дата/время последней синхронизации между AggreGate Server и устройством.

connectionStatus

Целое

статус подключения устройства

syncStatus

Целое

статус синхронизации устройства

syncDetails

Строка

прогресс текущей синхронизации

Статус синхронизации настроек

Возвращает информацию о статусе синхронизации для параметров устройства.

Имя переменной:

settingsStatus

Записи:

0...не ограничено

Права доступа:

Доступно для чтения на уровне с правами доступа для Наблюдателя.

Формат записи:

Имя поля

Тип поля

Примечания

name

Строка

Имя переменной параметра. Это поле скрыто.

setting

Строка

Описание параметра, т.е. описание переменной параметра.

serverTime

Дата

Дата/время последней синхронизации.

duration

Длинное

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

updated

Булевое

Флажок "Обновленный на сервере" является верным (true), если значение параметра было обновлено в кэше сервера, и новое значение еще не записано в аппаратное оборудование.

syncStatus

Строка

Текстовое описание текущего статуса синхронизации параметров.

Статистика

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

Имя переменной:

statistics

Записи:

0...не ограничено

Права доступа:

Доступно для чтения на уровне с правами доступа для Наблюдателя.

Формат записи:

Имя поля

Тип поля

Примечания

name

Строка

Имя канала.

variable

Строка

Имя переменной, на которой базируется канал.

statistics

Таблица данных

Краткие статистические данные.

Местоположение

Возвращает текущее местоположение устройства. См. Отслеживание местоположения устройства для получения более подробной информации.

Имя переменной:

location

Записи:

1

Права доступа:

Читаются на уровне с правами доступа для Наблюдателя

Формат записи:

Имя поля

Тип поля

Примечания

latitude

Плавающее

Текущая широта устройства в формате числа с плавающей точкой.

longitude

Плавающее

Текущая долгота устройства в формате числа с плавающей точкой.

Статусы переменной

Возвращает дополнительную информацию о статусе параметров устройства.

Имя переменной:

variableStatuses

Записи:

0...не ограничено

Права доступа:

Доступно для чтения уровне с правами доступа для Наблюдателя.

Формат записи:

Имя поля

Тип поля

Примечания

name

Строка

Имя переменной

status

Строка

Уникальный ID строки статуса

comment

Строка

Описание статуса в форме, удобной пользователю для чтения

Общие функции

[?]

Некоторые общие функции данного контекста зависят от типа представляющего его устройства. AggreGate Server создает в данном контексте одну общую функцию для каждой операции устройства. Функции, относящиеся к операциям устройства, доступны на уровне с правами доступа для Оператора.

Синхронизировать

Запускает синхронизацию между Device  и AggreGate Server. Можно также синхронизировать только одну переменную, а не целое Device. Передайте имя вашей переменной в параметры функции синхронизации. См. действие Синхронизировать.

Имя функции:

synchronize

Права доступа:

Доступно на уровне с правами доступа для Оператора.  

Записи ввода:

1

Формат ввода:

Имя

Тип

Описание

variable

String

Синхронизирует с AggreGate Server

Записи вывода:

0

Формат вывода:

нет

Переинициализировать драйвер устройства

Заставляет AggreGate Server очистить всю информацию об устройстве и запустить синхронизацию. См. действие Перезапустить драйвер устройства.

Имя функции:

reset

Права доступа:

Доступно на уровне с правами доступа для Менеджера.

Записи ввода:

0

Формат ввода:

нет

Записи вывода:

0

Формат вывода:

нет

Общие события

[?]

Общие события данного контекста зависят от типа представляющего его устройства. AggreGate Server создает в данном контексте одно общее событие для каждого типа события, которое может сгенерировать устройство.

Общие события: info (информация), contextStatusChanged (статус изменен)

Синхронизировано

Это событие появляется в конце каждого цикла синхронизации. Оно не принадлежит к какой-либо группе событий и поэтому не появляется в журнале событий во время действия Отследить связанные события.

Имя события:

synchronized

Права доступа:

Доступно на уровене прав доступа Наблюдатель

Период действия:

Непостоянный

Записи:

0

Функция вызвана

Это событие появляется при выполнении операции устройства. События генерируются только когда включена настройка устройства Включить расширенную статусную информацию.

Имя события:

functionCalled

Права доступа:

Доступно на уровене с правами доступа для Наблюдателя

Период действия:

Непостоянный

Записи:

1

Формат записи:

Имя поля

Тип поля

Примечания

function

Строка

Имя вызванной функции.

input

Таблица данных

Таблица входных данных функции.

output

Таблица данных

Таблица выходных данных функции.

user

Строка

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

Хронологическое событие изменения

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

Имя события:

backdatedChange

Права доступа:

Доступно на уровене прав доступа Наблюдатель

Период действия:

Непостоянный (см. событие изменений для постоянного обновления переменных)

Записи:

1

Формат записи:

Имя поля

Тип поля

Примечания

variable

Строка

Имя измененной переменной.

value

Таблица данных

Хронологическое значение переменной.