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

Класс устройства − класс, описывающий Устройство, его свойства и функции в системе.

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

Свойства устройства характеризуются параметрами атрибут или телеметрия.

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

Для создания класса устройства используйте метод POST /front-api-srv/api/v1.0/class, при этом:

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

Параметр	Тип	Тип данных	Обяз.	Описание	Пример
thingType	body	string	+	Тип вещи, на которую создается модель. Enum: [“DEVICE”, “ASSET”]	DEVICE
protocol	body	string	+	Протокол класса устройства. Указывается только для классов устройств. Enum: [“MQTT”, “COAP”, “HTTP”, “NIDD”, “MQTT_GATEWAY”]. В зависимости от выбранного протокола создаваемый класс отнаследуется от одноимённого абстрактного системного протокольного класса	MQTT
name	body	string	+	Наименование класса	УСПД
supportsUnspecifiedProperties	body	bool	+	Определяет, является ли класс абстрактным*	true
properties	body	array of objects	-	Свойства вещи	-
functionalities	body	array of objects	-	Функциональность	-

* - Устройства абстрактных классов не проверяются относительно атрибутивной схемы: то есть, могут быть добавлены параметры, отсутствующие в модели — Платформа автоматически определит и запишет тип данных. При этом отсутствует возможность использования данных классов в настройках модулей платформы (Rule Engine, Script Executor и так далее).

object “properties”

Параметр	Тип	Тип данных	Обяз.	Описание	Пример
name	body	string	+	Наименование свойства	token
propertyType	body	string	+	Тип свойства. Enum: [“TELEMETRY”, “ATTRIBUTE”]	ATTRIBUTE
namespace	body	string	-	Пространство имен свойства. Обязателен к заполнению для классов, у которых thingType = “DEVICE” и propertyType = “ATTRIBUTE”. Возможные значения: “CLIENT” (доступен для изменения устройствам клиента) “SERVER” (доступен для изменения клиенту платформы через интерфейс платформы) “SHARED” (нет ограничений на то, кто изменяет)	SERVER
required	body	bool	+	Признак обязательности заполнения свойства у вещи	true
dataType	body	string	+	Тип данных свойства. Возможные значения: “LONG_VARIABLE” “BOOLEAN_VARIABLE” “DOUBLE_VARIABLE” “STRING_VARIABLE” “DATETIME_VARIABLE” “TUPLE_VARIABLE” “ARRAY_VARIABLE” “LONG_CONST” “BOOLEAN_CONST” “DOUBLE_CONST” “STRING_CONST” “DATETIME_CONST” “TUPLE_CONST”	STRING_VARIABLE
meta	body	array of objects	-	Метаданные свойства	-

object “meta”

Параметр	Тип	Тип данных	Обяз.	Описание	Пример
name	body	string	+	Название метаданных	-
metaType	body	string	+	Тип метаданных. Возможные значения: “SYSTEM_TAG” − системные теги, определяющие логику работы с устройством. Для данного “metaType” значения “value” выбираются только из списка “USER_TAG” − пользовательские теги. Значения “value” заполняются на усмотрение пользователя “DICTIONARY_TAG” − тип метаданных, позволяющий заполнять свойство только значениями согласно заранее созданному словарю “DICTIONARY_VALUE_TAG” − тип метаданных, позволяющий заполнить свойство выбранным значением из словаря	-
value	body	string	+	Комментарий к метаданным. Заполняется только для metaType == SYSTEM_TAG или USER_TAG. При metaType ==SYSTEM_TAG можно заполнять только следующими значениями: TOKEN	-
value	body	object	+	Описание словаря на основании которых заполняются метаданные. Передается объектом только для metaType = DICTIONARY_VALUE_TAG или DICTIONARY_TAG	-

object “meta.value”

Параметр	Тип	Тип данных	Обяз.	Описание	Пример
dictionaryId	body	string	+	Наименование справочника	-
valueId	body	string	-	Идентификатор значения справочника	-

object “functionalities”

Параметр	Тип	Тип данных	Обяз.	Описание	Пример
name	body	string	+	Наименование функциональности	-
funcType	body	string	+	Тип функциональности ENUM: [“CONTROLLING”, “MEASURING”]	-
commands	body	array of objects	-	Команды	-

object “commands”

Параметр	Тип	Тип данных	Обяз.	Описание	Пример
name	body	string	+	Наименование команды	-
commandType	body	string	+	Тип команды. ENUM: [“INPUT”, “OUTPUT”]	-
params**	body	array of objects	-	Параметры команды	-

** − object "params" в описании object "properties".

Пример тела запроса:

1
{
2
    "thingType": "DEVICE",
3
    "protocol": "MQTT",
4
    "name": "УСПД",
5
    "supportsUnspecifiedProperties": true,
6
    "properties": [
7
        {
8
            "name": "token",
9
            "propertyType": "ATTRIBUTE",
10
            "required": true,
11
            "dataType": "STRING_VARIABLE",
12
            "namespace": "SERVER",
13
            "meta": []
14
        }
15
    ],
16
    "functionalities": []
17
}

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

В случае ошибки обработки запроса в ответе будет получен код ошибки, по которому можно определить ее характер и устранить возможную проблему.

Пример ответа:

1
{
2
    "id": "00d00000-0ed0-0a0f-beb0-df0b000a0000",
3
    "thingType": "DEVICE",
4
    "name": "УСПД",
5
    "system": false,
6
    "properties": [
7
        {
8
            "id": "00000000-f0cf-00e0-0fdc-c00ba0fcae00",
9
            "name": "token",
10
            "propertyType": "ATTRIBUTE",
11
            "namespace": "SERVER",
12
            "required": true,
13
            "dataType": "STRING_VARIABLE",
14
            "meta": []
15
        }
16
    ],
17
    "refs": [
18
        {
19
            "id": "00f00a00-e00f-0a00-af0a-c0af00e0ff00",
20
            "refType": "TENANT",
21
            "extId": "00000fec-000b-0000-a000-ec0b00f0f0e0"
22
        }
23
    ],
24
    "functionalities": [],
25
    "assetIds": [],
26
    "propagateUpdateOfProperties": [],
27
    "protocol": "MQTT",
28
    "abstract": false,
29
    "extends": "33333333-3333-3333-3333-333333333333",
30
    "supportsUnspecifiedProperties": true
31
}