Особенности моделей для разных протоколов

MQTT

Параметры

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

2. Топик известен заранее, данные приходят в формате JSON.

1. Создайте параметр с типом данных Объект, в источнике укажите тот топик, по которому ожидаете данные – в данном случае base/state/pos. Задайте некоторый идентификатор – например, pos.
   
2. Создайте еще два параметра – под каждое поле из JSON. В данном случае это узлы для широты и долготы. У каждого из этих параметров укажите тип данных, соответствующий типу этих значений в JSON. В нашем пакете координаты передаются как числа, поэтому укажите тип данных Число.
3. Источник у каждого из параметров сформируйте в виде <идентификатор_узла_с_типом_объект>.<нужное_поле_из_json>. Для координат из примера источники получаются следующие: pos.lat и pos.lon.
   

3. В топике присутствует значение другого параметра.

Действия

• Topic (Топик) – топик, с которым передается команда в виде сообщения на устройство;
• Payload (Данные) - полезная нагрузка, содержащая текст передаваемого сообщения;
• Ответить в - топик, при получении пакета с которым команда считается выполненной. Например, можно создать команду для получения состояния устройства и указать в поле Ответить в топик, по которому устройство отправляет свое состояние – leds/state. Тогда при отправке этой команды, даже если вы получите от устройства Ack (PUBACK – Publish acknowledgement) или какие-то пакеты с другими топиками, команда не будет считаться выполненной до тех пор, пока не придет пакет именно с указанным топиком leds/state. Если поле Ответить в не заполнено, то команда будет считаться выполненной при получении Ack от устройства.

Wialon IPS

Параметры

• базовые параметры: всегда присутствуют в пакете с данными, для них источники в шаблонной модели заранее определены;
• дополнительные параметры: любые параметры, которые можно дополнительно определить в устройстве. В пакете Wialon IPS каждый такой параметр представляет собой конструкцию NAME:TYPE:VALUE, где:
  • NAME – произвольная строка, длиной не более 15 байт;
  • TYPE – тип параметра, 1 –int/long long, 2 – double, 3 – string;
  • VALUE – значение в зависимости от типа.

Действия

WebSocket

Параметры

ws://ws.dev.rightech.io:80/api/v1/objects/:id/connect

{
  "stringKey": "value1",
  "booleanKey": true,
  "doubleKey": 3.1415,
  "longKey": 73,
  "jsonKey": {
    "someNumber": 42,
    "someArray": [1, 2, 3],
    "someNestedObject": {
      "key": "value"
    }
  }
}

• для строкового параметра stringKey;

• для числового параметра someNumber из вложенного JSON jsonKey;

• для второго элемента числового массива someArray из вложенного JSON jsonKey.

Действия

Galileosky

Параметры

Действия

Teltonika

Параметры

Действия

• для включения третьего реле из четырех возможных отправьте команду
  setdigout ??1?
• для выключения
  setdigout ??0?
• если реле всего два, то команда включения второго реле выглядит так
  setdigout ?1
• если нужно включить оба реле
  setdigout 11

💡

Если количество реле неизвестно, воспользуйтесь командой getio. В ответ на нее устройство отправит информацию об имеющихся входах и выходах. Количество параметров DO в поле response означает число реле в подключенном устройстве.

Navtelecom (Flex)

Параметры

Действия

LoRaWAN

Параметры

• DevAddr - адрес конечного устройства;
• FPort - номер порта фрейма;
• FCnt - номер фрейма;
• Payload - полезная нагрузка фрейма, то есть данные от устройства.

Действия

CoAP

Параметры

coap://dev.rightech.io:5683/api/v1/objects/:id/:path

• :id - идентификатор объекта на платформе,
• :path - путь, по которому устройство отправляет значение параметра.

coap://dev.rightech.io:5683/api/v1/objects/:id/base/state/humidity

coap://dev.rightech.io:5683/api/v1/objects/:id/state/telemetry1

{
  "stringKey": "value1",
  "booleanKey": true,
  "doubleKey": 3.1415,
  "longKey": 73,
  "jsonKey": {
    "someNumber": 42,
    "someArray": [1, 2, 3],
    "someNestedObject": {
      "key": "value"
    }
  }
}

1. Создайте параметр с типом данных Объект, в источнике укажите тот путь, по которому ожидаете данные – в данном случае state/telemetry1. Задайте некоторый идентификатор – например, telemetry1.
   
2. Создайте дополнительные параметры – под каждое поле из JSON. В данном случае получается 9 элементов:
   1. Параметр для поля stringKey
   2. Параметр для поля booleanKey
   3. Параметр для поля doubleKey
   4. Параметр для поля longKey
   5. Параметр для поля someNumber из вложенного JSON jsonKey
   6. Параметр для первого элемента массива поля someArray из вложенного JSON jsonKey
   7. Параметр для второго элемента массива поля someArray из вложенного JSON jsonKey
   8. Параметр для третьего элемента массива поля someArray из вложенного JSON jsonKey
   9. Параметр для поля key из вложенного JSON someNestedObject из вложенного в свою очередь JSON jsonKey

• для строкового параметра stringKey;

• для числового параметра someNumber из вложенного JSON jsonKey;

• для второго элемента числового массива someArray из вложенного JSON jsonKey.

Действия

LwM2M

Параметры

• ObjectId - номер объекта, то есть какого-то компонента устройства, например, датчика;
• ObjectInstance - номер экземпляра объекта. Например, в устройстве есть два датчика температуры и три датчика атмосферного давления. Тогда объектами являются датчик температуры и датчик давления, а экземплярами объектов являются конкретные экземпляры датчиков температуры и давления;
• ResourceID - номер ресурса. Например, для датчика это может быть значение величины и единица измерения.

Действия

• Method - GET/PUT/POST/DELETE;
• Path - путь, который фомируется так же, как в источнике для аргументов, однако здесь параметры ObjectInstance и ResourceID опциональны;
• Data - данные, которые можно указать в зависимости от типа LwM2M команды.

• Read – прочитать данные из единичного ресурса, экземпляра объекта или объекта целиком. Ответ от клиента должен быть представлен в SenML JSON формате. Спецификация >>>

{
  "method": "GET",
  "path": "/1"
}

• Write – обновить значения. Данные для записи должны быть представлены в Plain Text формате. Спецификация >>>

{
  "method": "PUT",
  "path": "/31024/10/1",
  "data": 254
}

• Execute – инициировать выполнение действий на ресурсе. Спецификация >>>

{
  "method": "POST",
  "path": "/31024/10/2"
}

• Create – создать экземпляр объекта. Данные для записи должны быть представлены в SenML JSON формате. Спецификация >>>

{
  "method": "POST",
  "path": "/31024",
  "data": [
    {
      "bn": "/31024/",
      "n": "11/1",
      "v": 8
    }
  ]
}

• Delete – удалить экземпляр объекта. Спецификация >>>

{
  "method": "DELETE",
  "path": "/31024/11"
}

• Write-Attributes – изменить значения атрибутов. Спецификация >>>

{
  "method": "PUT",
  "path": "/31024/10/1?pmin=5&pmax=60"
}

• Discover – получить список всех поддерживаемых объектов, экземпляров объектов и ресурсов. Ответ от клиента должен быть представлен в CoRE Link Format формате. Спецификация >>>

{
  "method": "GET",
  "path": "/1",
  "data": "discover"
}

• Observe – установить наблюдение. Ответ от клиента должен быть представлен в SenML JSON формате. Спецификация >>>

{
  "method": "GET",
  "path": "/3/0/9",
  "data": "observe"
}

• Cancel Observation – завершить наблюдение. Спецификация >>>

{
  "method": "GET",
  "path": "/3/0/9",
  "data": "cancel"
}