Меркурий коммуникатор

Введение¶

Программное обеспечение Меркурий Коммуникатор предназначено для создания единого коммуникационного пространства для устройств различных производителей, использующих технологию связи Ethernet/GPRS/3G/LTE/NBIoT.

Выполняется коммуникация между устройствами и программным обеспечением, например Системами сбора данных, Программами-Конфигураторами и т.д. При этом устройства и серверы, где установлено программное обеспечение, могут принадлежать разным локальным подсетям.

Типы устройств/протоколы передачи данных, поддерживаемые в программе Меркурий Коммуникатор, приведены в приложении Приложение А.

Программное обеспечение Меркурий Коммуникатор функционирует на физическом или виртуальном сервере под управлением ОС Windows или Linux.

Режимы работы¶

ПО Меркурий Коммуникатор может работать в следующих режимах:

• PORTS AND DEVICES – обеспечение связи по протоколу TCP IP между системами верхнего уровня и устройствами, имеющими "серый" IP-адрес;
• MODEMS – оперативная перерегистрация GPRS/GSM модема в сети и восстановление связи со счетчиком;
• TCP↔NIDD – трансляция потока TCP в сообщения NIDD и обратно.

PORTS AND DEVICES¶

ПО Меркурий Коммуникатор обеспечивает канал связи для обмена данными устройства (Device #) с системой верхнего уровня (Стороннее ПО) в случае, если устройство имеет "серый" IP-адрес. Механизм работы ПО Меркурий Коммуникатор заключается в замене адреса и порта устройства при прохождении пакета в одну сторону и обратной замене адреса и порта назначения в ответном пакете.

На рисунке 2.1 представлена функциональная схема работы Меркурий Коммуникатор в режиме PORTS AND DEVICES.

Рисунок 2.1 – Схема работы в режиме PORTS AND DEVICES

Описание схемы

Схема выполнена для случая, когда сервер Меркурий Коммуникатор имеет публичный "белый" IP-адрес.

В ПО Меркурий Коммуникатор необходимо открыть внешний порт (External Port). По данному порту сервер будет ожидать запросы устройства.

На стороне устройства для подключения к серверу необходимо указать IP-адрес сервера Меркурий Коммуникатор и номер открытого на сервере внешнего порта.

Устройства (Device #) с "серым" IP-адресом начинают отправлять запросы на внешний порт, например 2000, сервера Меркурий Коммуникатор. Если к серверу пытается подключиться новое устройство, информация о котором отсутствует в конфигурации, то такое устройство помечается как неизвестное (статус Unknown). Пользователь может принять устройство, указав его тип, или отклонить устройство, если его подключение к серверу не планируется.

Для каждого внешнего порта на сервере Меркурий коммуникатор необходимо открыть один или несколько локальных портов, по которым будет подключаться стороннее ПО. Например, для внешнего порта 2000 открыть локальные порты 101, 102 и пр. Через открытый локальный порт 101 стороннее ПО будет подключаться для управления устройством Device #1.

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

MODEMS¶

Режим MODEMS используется в автоматизированных системах сбора данных, в которые включены счетчики, оборудованные GSM/GPRS модемами со статическим IP адресом. При потере связи сервера системы со счетчиком модем должен перерегистрироваться в сети, чтобы восстановить связь.

В режиме MODEMS выполняется циклическая проверка наличия связи с модемами. В случае отсутствия связи с модемом из программы Меркурий Коммуникатор отправляются SMS-команды для перерегистрации модема в сети и настройки соединения с сервером.

TCP↔NIDD¶

Технология Non-IP Data Delivery (NIDD) предназначена для эффективной коммуникации между устройствами NB-IoT и приложениями, осуществляющими информационный обмен с устройствами. В этом случае устройству не присваивается IP адрес, данные передаются без использования протокола IP. Ответственность за доставку и получение сообщений берет на себя служба SCEF оператора мобильной связи.

Ключевыми функциями службы SCEF являются:

• Привязка идентификатора сим-карты (IMSI) к универсальному идентификатору устройства (External ID), который используется вместо телефонного номера или IP адреса, при этом к одному IMSI можно привязать несколько External ID.
• Передача non-IP трафика.
• Групповые операции: отправка команд устройствам, объединенным в логическую группу.
• Поддержка режима передачи данных с подтверждением.
• Буферизация данных.
• Аутентификация и авторизация устройств и серверов приложений.
• Одновременное использование данных одного устройства несколькими приложениями.
• Поддержка специальных функций контроля состояния устройств.
• Триггеринг устройств.
• Роуминг non-IP данных.

Т.к. существует большое количество приложений, которые выполняют обмен с устройствами только по протоколу TCP IP, необходим универсальный ретранслятор для перевода TCP IP запросов в NIDD сообщения и обратно.

В режиме TCP↔NIDD сервер Меркурий Коммуникатор выполняет следующие операции:

1. Получает от стороннего приложения (отправителя) запросы к NIDD устройствам по протоколу TCP IP;
2. Транслирует запросы в формат NIDD сообщений;
3. Передает сообщения на платформу оператора мобильной связи;
4. Получает ответы NIDD устройств с платформы мобильного оператора;
5. Транслирует NIDD ответы в формат протокола TCP IP;
6. Возвращает ответы отправителю.

На рисунке 2.2 представлена функциональная схема работы Меркурий Коммуникатор в режиме TCP↔NIDD.

Рисунок 2.2 – Схема работы в режиме TCP↔NIDD

Описание схемы

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

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

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

Требования к ПО¶

На компьютере должна быть установлена одна из перечисленных ниже операционных систем:

• Windows Client: 7, 8.1, 10 (1607+)
• Windows Server: 2008 R2 SP1+
• maxOS: 10.12+
• RHEL: 6+
• Fedora: 26+
• Ubuntu: 16.04+
• Debian: 9+
• SLES: 12+

На рабочих местах пользователей должен быть установлен современный браузер. Рекомендуется использовать Google Chrome, Firefox, Edge.

Установка и запуск¶

Порядок установки и запуска программы Меркурий Коммуникатор зависит от используемой операционной системы. В данном разделе приведена информация об установке и запуске программы в ОС Windows и в ОС Linux.

Установка и запуск программы в ОС Windows¶

Установка программы¶

Для установки программы выполните следующие действия:

1. Скачайте архив mercury_communicator_XX.zip, где XX – последняя версия программы.
2. Создайте папку, в которой будут храниться файлы.
3. Распакуйте архив в эту папку.

Запуск программы¶

Для запуска программы выполните следующие действия:

1. Откройте папку Win32 .
2. Запустите приложение Incotex . PaD . WebApp , см. рисунок 4.1.

Рисунок 4.1 – Запуск приложения Incotex.PaD.WebApp

На экране будет представлено системное окно запуска программы, см. рисунок 4.2.

Рисунок 4.2 – Системное окно запуска

После успешного прохождения всех этапов установки и запуска автоматически откроется вкладка браузера со стартовой формой программы Меркурий Коммуникатор см. рисунок 4.3.

Рисунок 4.3 – Стартовая форма в ОС Windows

Установка и запуск программы в ОС Linux¶

В данном разделе рассматривается пример установки и запуска программы для Ubuntu 18.04 – x64. Для запуска программы Меркурий Коммуникатор следует установить .NET Core SDK, инструкция по установке которого есть на сайте компании Microsoft: http://dotnet.microsoft.com/download/linux-package-manager/ubuntu18-04/sdk-current".

Установка программы¶

Для установки программы выполните следующие действия:

1. Откройте программу Terminal.
2. Скачайте архив mercury_communicator_XX.zip, где XX – последняя версия программы, в папку tmp:
3. /tmp/mercury_communicator_XX.zip
4. Создайте новую папку для программы Меркурий Коммуникатор:
5. sudo mkdir /opt/mercury_communicator
6. Распакуйте архивный файл ПО Меркурий Коммуникатор в новую папку:
7. sudo unzip -qd /opt/mercury_communicator/ /tmp/mercury_communicator_105.zip
8. Разрешите исполнение файла программы:
9. sudo chmod +x /opt/mercury_communicator/linux/Incotex.PaD.WebApp

Пример установки программы Меркурий Коммуникатор в ОС Linux представлен на рисунке 4.4.

Рисунок 4.4 – Установка программы в Linux

Запуск программы¶

Для запуска программы выполните следующие действия:

1. Откройте программу Terminal.
2. Перейдите в папку программы:
3. cd /opt/mercury_communicator/linux/
4. Запустите программу:
5. ./Incotex.PaD.WebApp

Пример запуска программы Меркурий Коммуникатор в ОС Linux представлен на рисунке 4.5.

Рисунок 4.5 – Установка программы в Linux

После успешного прохождения всех этапов установки и запуска автоматически откроется вкладка браузера со стартовой формой программы Меркурий Коммуникатор, см. рисунок 4.6.

Рисунок 4.6 – Стартовая форма в ОС Linux

Авторизация пользователя¶

Для выполнения операций, связанных с изменением конфигурации, требуется авторизация с правами администратора. К таким операциям относятся, например, создание и удаление внешнего порта, локальных портов и пр.

Неавторизованный пользователь имеет только право просмотра.

Рисунок 5.1 – Стартовая форма программы в ОС Windows

1. Нажмите кнопку Sign In для прохождения авторизации.

На экране будет представлена форма авторизации, см. рисунок 5.2.

Рисунок 5.2 – Форма авторизации

2. В поле Password введите пароль пользователя.
3. Нажмите кнопку Login для подтверждения действия.

В результате выполненных действий пользователь будет авторизован в программе Меркурий Коммуникатор.

Типовые операции¶

В программе Меркурий Коммуникатор предусмотрена возможность выполнения типовых операций в соответствии с текущими потребностями пользователя.

К типовым операциям относятся:

• Выбор режима работы
• Выбор периода обновления данных
• Поиск устройства по параметру
• Фильтрация информации об устройствах
• Обновление программы

Выбор режима работы¶

Выберите режим работы ПО Меркурий Коммуникатор:

Нажмите одну из кнопок: PORTS AND DEVICES, MODEMS, TCP↔NIDD в верхнем блоке формы.

Рисунок 6.1 – Выбор режима работы

Выбор периода обновления данных¶

В поле Refresh Time выберите период обновления данных на экране. Возможные значения:

• Disabled – не обновлять данные.
• 10 Secs – обновлять данные каждые 10 секунд.
• 30 Secs – обновлять данные каждые 30 секунд.
• 60 Secs – обновлять данные каждые 60 секунд.

Поиск устройства¶

Для поиска устройства по одному из параметров: Device Name (название устройства) или Identifier (идентификационный номер устройства), – в пустом поле фильтра введите символы (один или несколько), содержащиеся в любом из этих параметров. Информация в на форме будет обновляться с вводом каждого нового символа.

Фильтрация¶

Для фильтрации информации об устройствах нажмите значок в заголовке целевого столбца.

В столбцах возможно выполнить фильтрацию данных по одному из признаков:

• Is equal to – значение в ячейках столбца строго равно указанному параметру.
• Is not equal to – значение в ячейках столбца не равно указанному параметру.
• Is greater than or equal to – значение в ячейках столбца больше или равно указанному.
• Is greater than – значение в ячейках столбца больше указанного.
• Is less than or equal to – значение в ячейках столбца меньше или равно указанному.
• Is less than – значение в ячейках столбца меньше указанного.
• Is null – значение в ячейках столбца равно нулю.
• Is not null – значение в ячейках столбца не равно нулю.
• Contains – значение в ячейках столбца содержит указанный параметр.
• Does not contain – значение в ячейках столбца не содержит указанный параметр.
• Starts with – значение в ячейках столбца начинается на заданный набор символов
• Ends with – значение в ячейках столбца заканчивается на заданный набор символов.
• Is empty – ячейки столбца пусты.
• Is not empty – ячейки столбца не пусты.
• Any – отображать данные устройств в любом статусе соединения.
• WaitConnection – отображать данные устройств, статус которых Ожидание соединения.
• Connected – отображать данные устройств, статус которых Соединение.
• Transmitting – отображать данные устройств, статус которых Идет обмен данными с устройством.
• Error – отображать данные устройств, статус которых Ошибка.
• Unknown – отображать данные устройств, статус которых Не известно.

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

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

Переход на сайт компании¶

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

Обновление программы¶

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

Рисунок 6.2 – Доступна новая версия

Для обновления текущей версии ПО нажмите на ссылку Download и выполните необходимые шаги установки, см. разделы Установка и запуск программы в ОС Windows, Установка и запуск программы в ОС Linux.

Режим PORTS AND DEVICES¶

Общие сведения¶

В режиме PORTS AND DEVICES ПО Меркурий Коммуникатор обеспечивает канал связи для обмена данными устройства с системой верхнего уровня в случае, если устройство имеет "серый" IP-адрес, см. PORTS AND DEVICES.

В режиме PORTS AND DEVICES пользователь может просматривать информацию о внешних портах и подключенных к ним устройствах.

В процессе работы в программе Меркурий Коммуникатор пользователь имеет возможность изменять конфигурацию: создавать новые и удалять существующие внешние порты, для устройств со статусами Connected (Соединено), WaitConnection (Ожидание соединения), Error (Ошибка) и Transmitting (Обмен данными с устройством) создавать новые, менять параметры и удалять подключенные устройства. Устройства, статус которых Unknown (Не известно), могут быть приняты или отклонены. Кроме того, пользователь может экспортировать данные о внешних портах и подключенных к ним устройствах в файл.

Просмотр перечня устройств¶

Для просмотра перечня устройств, подключенных к целевому порту:

Выберите поле External Port с нужным номером внешнего порта.

На экране будет представлена информация о подключенных устройствах, см. рисунок 7.1.

Рисунок 7.1 – Информация о подключенных устройствах

Информация представлена в виде таблицы, которая содержит следующие сведения:

• Device Name – название устройства, для непринятых устройств Unknown.
• Identifier – идентификационный номер устройства, для непринятых устройств Unknown _ Serial _ Number.
• Local Port – номер локального порта, через который стороннее ПО будет подключаться к устройству, если локальный порт не задан n / a.
• Status Changed Time – время последнего изменения статуса подключения устройства.
• Status – текущее состояние подключения устройства. В следующем списке приведены цветовые коды статусов:

- Connected (Соединено).

- WaitConnection (Ожидание соединения).

- Unknown (Не известно).

- Error (Ошибка).

- мигающий индикатор – Transmitting (Обмен данными с устройством).

• MSISDN – Mobile Subscriber Integrated Services Digital Number (номер подключенного устройства в цифровой сети с интеграцией служб).
• IP – IP-адрес устройства.
• RSSI – Received signal strength indicator (показатель уровня принимаемого сигнала).
• Bytes Sent – количество байт, переданных устройством.
• Bytes Received – количество байт, полученных устройством.
• Actions – действия, которые может выполнять пользователь:

- Edit Device (Редактировать устройство).

- Delete (Удалить устройство).

- Accept (Принять устройство).

Создание нового внешнего порта¶

Для создания внешнего порта выполните следующие действия:

1. Нажмите кнопку Add External Port.

На экране будет представлена форма создания внешнего порта, см. рисунок 7.2.

Рисунок 7.2 – Создание внешнего порта

2. В поле Port Number укажите номер внешнего порта.
3. В поле Client Type в раскрывающемся списке выберите тип клиента, к которому будет относится внешний порт. Типы клиентов, поддерживаемые в программе Меркурий Коммуникатор, приведены в приложении Приложение А.
4. Нажмите кнопку Add External Port для подтверждения действия.

В результате выполненных действий в программе Меркурий Коммуникатор будет создан новый внешний порт. Информация о нем будет отображена на экране.

Рисунок 7.3 – Сообщение об ошибке

Удаление внешнего порта в программе Меркурий Коммуникатор¶

Для удаления внешнего порта выполните следующие действия:

1. Нажмите кнопку (Remove External Port) напротив внешнего порта, информация о котором должна быть удалена.

На экране отобразится форма подтверждения удаления.

Рисунок 7.4 – Форма подтверждения удаления

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

В результате выполненных действий внешний порт будет удален из программы Меркурий Коммуникатор.

Добавление нового устройства¶

Для добавления нового устройства выполните следующие действия:

1. Выберите внешний порт, к которому будет обращаться новое устройство, и нажмите кнопку Add Device.

На экране будет представлено форма добавления нового устройства

Рисунок 7.5 – Добавление нового устройства

2. В поле Device Name укажите название устройства, под которым оно должно быть зарегистрировано в программе.
3. В поле Identifier укажите идентификационный номер нового устройства.
4. В поле Local Port укажите номер локального порта, через который будет происходить подключение к устройству по соответствующему протоколу.
5. В поле External Port в раскрывающемся списке выберите внешний порт, для которого будет добавлено новое устройство.

После выбора внешнего порта на форме создания нового устройства отобразится поле Params Profile, см. рисунок 7.6.

Рисунок 7.6 – Поле Params Profile на форме создания нового устройства

6. В поле Params Profile в раскрывающемся списке выберите профиль для соединения с HTTP- или SSH-сервером на устройстве.
7. В поле MSISDN укажите MSISDN-номер устройства.
8. Нажмите кнопку Add Device для создания нового устройства.

В результате выполненных действий в программе Меркурий Коммуникатор будет создано новое устройство.

Изменение параметров устройства¶

В процессе работы пользователя в программе Меркурий Коммуникатор возможны ситуации, когда в параметры ранее зарегистрированного устройства требуется внести изменения. Отредактированы могут быть любые параметры устройства, кроме внешнего порта. Для изменения параметров устройства выполните следующие действия:

1. Нажмите кнопку (Edit Device) напротив нужного устройства.

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

Рисунок 7.7 –Изменение параметров устройства

2. В поле Device Name измените название устройства.
3. В поле Identifier измените идентификационный номер устройства.
4. В поле Local Port измените номер локального порта, через который будет происходить подключение к устройству.
5. В поле MSISDN измените MSISDN-номер устройства.
6. Нажмите кнопку Edit Device для изменения параметров устройства.

В результате выполненных действий параметры выбранного устройства будут изменены.

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

Для удаления устройства (или нескольких устройств одновременно) выполните следующие действия:

1. Нажмите кнопку (Remove Device) напротив устройства, информация о котором должна быть удалена.
2. или
3. Выберите несколько устройств для удаления, установив признаки в соответствующих полях, и нажмите кнопку Remove selected items.

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

Рисунок 7.8 –Подтверждение удаления одного устройства

Рисунок 7.9 – Подтверждение удаления нескольких устройств

4. Нажмите кнопку Remove Device или Remove при удалении нескольких устройств для подтверждения операции.

В результате выполненных действий выбранное устройство или несколько устройств будет удалено из программы Меркурий Коммуникатор.

Работа с неизвестными устройствами¶

При подключении к серверу нового устройства, информация о котором отсутствует в файле data.json (т.е. устройство не настроено пользователем, подробнее см. Описание файла data.json), устройству присваивается статус Unknown (Не известно). Пользователь может принять такое устройство, добавив необходимые атрибуты, или отклонить его.

Принятие устройства¶

Для принятия устройства выполните следующие действия:

1. Нажмите кнопку (Accept Unknown) напротив устройства, которое должно быть принято.

На экране будет представлена форма принятия.

Рисунок 7.10 – Форма принятия устройства

2. В поле Device Name введите название устройства.
3. В поле Identifier введите идентификационный номер устройства.
4. В поле Local Port введите номер локального порта, через который будет происходить подключение к устройству.
5. В поле MSISDN введите MSISDN-номер подключенного устройства.
6. Нажмите кнопку Accept Device для подтверждения принятия.

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

Отклонение устройства¶

Для отклонения устройства выполните следующие действия:

1. Нажмите кнопку (Reject Unknown) напротив устройства, которое должно быть отклонено.

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

Рисунок 7.11 – Форма отклонения устройства

2. В данной форме проверьте правильность параметров отклоняемого устройства.
3. Нажмите кнопку Reject Unknown для подтверждения отклонения.

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

Экспорт данных о внешних портах и устройствах в файл¶

Информация о внешних портах и устройствах в программе Меркурий Коммуникатор может быть экспортирована оператором в XLSX-файл.

Для экспорта выполните следующие действия:

1. Нажмите кнопку Export.

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

2. Выберите папку для хранения XLSX-файла, замените при необходимости название файла и нажмите кнопку Сохранить.

В результате информация о внешних портах и устройствах будет экспортирована в XLSX-файл.

Пример XSLX-файла представлен на рисунке 7.12.

Рисунок 7.12 – Пример экспортированного XLSX-файла

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

• Port Number – номер внешнего порта, к которому подключено устройство.
• Client Type – тип клиента, к которому относится внешний порт.
• Device Name – название устройства.
• Identifier – идентификационный номер устройства.
• Local Port – номер локального порта.
• Status changed time – время последнего изменения статуса устройства.
• Status – статус подключения устройства.
• MSISDN – MSISDN-номер устройства.
• Bytes Sent – количество байт, переданных устройством.
• Bytes Received – количество байт, полученных устройством.

Режим MODEMS¶

Общие сведения¶

Режим MODEMS предназначен для работы с устройствами передачи информации по GSM/GPRS каналу, например, GSM/GPRS модемов в составе счетчиков электрической энергии.

Данную функциональность целесообразно использовать для автоматизированных систем сбора данных, в которые включено большое количество счетчиков, оборудованных GSM/GPRS модемами и имеющих статический IP-адрес.

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

В программе Меркурий Коммуникатор выполняется циклическая проверка наличия связи с модемами, внесенными в перечень. В случае отсутствия связи с модемом из программы отправляются команды (SMS-команды) для перерегистрации модема в сети и настройки соединения с сервером.

Просмотр состояния связи¶

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

1. Нажмите кнопку MODEMS в главном окне программы.

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

При просмотре информации доступны возможности фильтрации по целевым полям таблицы, а также поиск модема по номеру SIM карты (MSISDN).

Рисунок 8.1 – Форма MODEMS – состояние подключения модемов

Описание полей таблицы:

• Comment – описание.
• Ip – статический IP-адрес счетчика.
• MSISDN (Mobile Subscriber Integrated Services Digital Number) – номер SIM карты модема, на который отправляются SMS-команды.
• Meter Serial – заводской номер счетчика.
• Status – состояние подключения устройства к сети.
• Success Ping Time – время последнего успешного подключения.
• Failed Ping time – время возникновения ошибки связи.
• Attempts Made – количество попыток подключения.
• Last Sent Time – время отправки последнего запроса.
• - Edit Modem (Редактировать параметры модема).
• - Remove Modem (Удалить модем).

Добавление и редактирование параметров модема¶

Добавление и редактирование параметров модема выполняется на формах Add Modem и Edit Modem соответственно.

Перечень полей на формах Add Modem и Edit Modem одинаков.

1. Нажмите кнопку Add Modem для перехода к добавлению нового модема.

   ИЛИ

   (Edit Modem) в целевой строке таблицы для перехода к редактированию существующего модема.

   

   Рисунок 8.2 – Форма Edit Modem – редактирование параметров модема

2. Введите значения параметров в поля формы в соответствии с описанием:

   • Modem Comment – описание.
   • Ip – статический IP-адрес счетчика.

   • MSISDN (Mobile Subscriber Integrated Services Digital Number) – номер SIM карты модема.

     Первый символ в номере SIM карты в РФ должен быть 7. Цифры номера вводятся без пробелов и иных символов.

   • Meter Serial – заводской номер счетчика.
   • Monitoring – контроль пребывания в сети включен/выключен (ON/OFF).
   • SMS Profile – профиль настройки, включающий тексты SMS-команд, отправляемых модему, содержится в файле modem-profiles.json, см. п. Описание файла modem-profiles.json.
3. Нажмите кнопку Add Modem / Edit Modem.

В результате выполненных действий будет создан/отредактирован модем, параметры которого сохранены в файле modems.json.

Настройка параметров восстановления связи¶

Настройка параметров восстановления связи, таких как периодичность запросов, максимальное количество попыток запроса и пр. выполняется на форме Edit Settings.

Рисунок 8.3 – Форма Edit Settings – редактирование параметров восстановления связи

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

1. Нажмите кнопку Settings в разделе MODEMS.

2. Введите значения параметров на форме Edit Settings в соответствии с описанием.

   • COM-port – номер COM порта, выделенного на компьютере при подключении модема.
   • Periodicity – периодичность передачи запросов, допустимые значения: от 1 до 1440 мин.
   • Max attempts before disabling – максимальное количество попыток отправки, от 3 до 10.
   • Delay between attempts – интервал между попытками отправки: от 0 до 60 мин.
   • Delay between ping – интервал между проверками соединения: от 0 до 60 с.
   • Delay between SMS – интервал между отправками SMS: от 10 до 300 с.
3. Нажмите кнопку Edit Settings.

В результате выполненных действий в файле modems-settings.json будут сохранены отредактированные значения параметров.

Экспорт параметров модема¶

Информация состоянии связи модемов в программе Меркурий Коммуникатор может быть экспортирована оператором в XLSX-файл.

Для экспорта выполните следующие действия:

1. Нажмите кнопку Export в разделе MODEMS.

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

2. Выберите папку для хранения XLSX-файла, замените при необходимости название файла и нажмите кнопку Сохранить.

В результате выполненных действий информация о состоянии связи модемов будет сохранена в XLSX-файле.

Пример XSLX-файла представлен на рисунке 8.4.

Рисунок 8.4 – Пример экспортированного XLSX-файла

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

• Comment – описание.
• Ip – IP-адрес счетчика.
• MSISDN (Mobile Subscriber Integrated Services Digital Number) – номер SIM карты модема.
• Meter Serial – заводской номер счетчика.
• Status – состояние подключения устройства к сети.
• Status changed time – время изменения состояния подключения.
• Failed Ping time – время возникновения ошибки связи.
• Attempts Made – количество попыток подключения.
• Last Sent Time – время отправки последнего запроса.

Режим TCP↔NIDD¶

Общие сведения¶

ПО Меркурий Коммуникатор обеспечивает связь между устройствами NB-IoT (NIDD) и приложениями, осуществляющими коммуникацию с устройствами по протоколу TCP IP. В режиме TCP↔NIDD ПО Меркурий Коммуникатор работает в качестве универсального ретранслятора и выполняет трансляция потока TCP в сообщения NIDD и обратно.

Поддержка групповых операций в ПО Меркурий Коммуникатор выполняется с помощью профилей, которые содержат общие параметры для логической группы подключений. В параметрах подключений указывается связь между идентификатором устройства и портом TCP.

Предварительные требования¶

Аппаратные требования к устройствам:

• SIM-карта NB-IoT с поддержкой NIDD.
• Устройство NB-IoT с поддержкой NIDD.

Порядок регистрации на платформе оператора:

1. Заключить корпоративный договор с оператором сотовой связи на пакет SIM карт для устройств, услуг NIDD и пакета NIDD сообщений.
2. Установить SIM карту в устройство.
3. Получить у оператора сотовой связи доступ к личному кабинету (ЛК) для управления SIM картами (например, M2M менеджер у МТС). Управление пакетом SIM карт привязано к номеру договора.
4. Получить у оператора сотовой связи Инструкцию по настройке NIDD.
5. Настроить NIDD в личном кабинете по инструкции оператора.
6. Создать подписку сервера Меркурий Коммуникатор на устройство по инструкции оператора сотовой связи.

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

Настройка группы SIM карт:

1. Создать группу SIM карт.
2. Назначить группе APN.
3. Добавить группе услугу SCEF APN.
4. Добавить группе услугу NIDD.

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

Настроить устройства для работы в режиме NIDD в специальной программе (например, для модемов счетчиков Меркурий настройки выполняются в приложении LpWAN Конфигуратор).

На сервере Меркурий Коммуникатор выдать разрешение на прослушивание URL, на который будут приходить ответы:

1. Запустить оболочку PowerShell от имени администратора.

2. Подать команду:

   netsh http add urlacl url=http://*:<port>/scef/callback user="${env:userdomain}\${env:username}"

   

3. Убедиться, что команда выполнена успешно.

Просмотр профилей и соединений¶

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

• Нажмите кнопку TCP↔NIDD в главном окне программы.

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

При просмотре информации доступна фильтрация по целевым полям таблицы.

Рисунок 9.1 – Форма TCP↔NIDD – профили и соединения

Описание профиля: Profile <Идентификатор приложения в ЛК>:<имя пользователя> Notification Uri: <Uri, на котором выполняется прослушивание сообщений>.

• - Edit Profile (Редактировать параметры профиля).
• - Remove Profile (Удалить профиль).
• Remove selected items – удалить выбранные соединения.

Описание полей таблицы подключений:

• Comment – описание.
• SCEF Config Id – уникальный идентификатор устройства, который возвращается в подписке после запроса.
• External Id – уникальный идентификатор устройства на платформе оператора.
• TCP Port – порт для связи с устройством, заданный в стороннем приложении.
• Status – состояние подключения устройства к сети.
• - Edit Connection (Редактировать параметры соединения).
• - Remove Connection (Удалить соединение).

Добавление и редактирование профиля¶

Добавление и редактирование параметров профиля выполняется на формах Add Profile и Edit Profile соответственно.

Перечень полей на формах Add Profile и Edit Profile одинаков.

1. Нажмите кнопку Add Profile для перехода к добавлению нового профиля.

   ИЛИ

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

Рисунок 9.2 – Форма Edit Profile – редактирование профиля

2. Введите значения параметров в поля формы в соответствии с описанием:

   • Login – логин в учетной записи (NIDD аккаунты в ЛК).
   • Password – пароль в учетной записи (NIDD аккаунты в ЛК).
   • ScsAsId – идентификатор приложения в ЛК.
   • Notification Uri – Uri, на котором выполняется прослушивание сообщений на сервере Меркурий Коммуникатор.
   • Answer Timeout, seconds – максимальное время ожидания ответа.
3. Нажмите кнопку Add Profile / Edit Profile.

В результате выполненных действий будет создан/отредактирован профиль, параметры которого сохранены в файле tcp2nidd.json.

Добавление и редактирование соединения¶

Добавление и редактирование параметров соединения выполняется на формах Add Connection и Edit Connection соответственно.

Перечень полей на формах Add Connection и Edit Connection одинаков, за исключением дополнительного поля Profile на форме Add Connection.

1. Нажмите кнопку Add Connection для перехода к добавлению нового соединения.

   ИЛИ

   в целевой строке описания соединения для перехода к редактированию существующего соединения.

Рисунок 9.3 – Форма Edit Connection – редактирование соединения

2. Введите значения параметров в поля формы в соответствии с описанием:

   • Comment – описание соединения.
   • Profile – <Идентификатор приложения в ЛК>:<имя пользователя>, выбор в выпадающем списке.
   • SCEF Config Id – уникальный идентификатор соединения по подписке, выбор в выпадающем списке.
   • Protocol – TCP/UDP, выбор в выпадающем списке.
   • Port – порт, по которому стороннее ПО соединяется с устройством, например, данный порт вводится как параметр канала TCP IP в Конфигураторе счетчиков, если он используется в качестве стороннего ПО.
   • Device Port – тип порта, определяет, тип адресата или отправителя при передаче данных. Выбор в выпадающем списке:

     • TCP протокол:

     • 2 - Main – для выполнения обмена данными между счетчиком и приложением, например, конфигуратором;;
     • 3 - RS485 – для выполнения обмена данными между приложением и счетчиком или другим устройством, которое соединено с модулем связи по RS485;

     • UDP протокол:

     • 0 - LpWan – для выполнения обмена данными между модулем и приложением, например, системой сбора данных.

   • Enabled – переключатель для выбора состояния соединения:

     • YES – разрешено соединение;
     • NO – запрещено соединение.
3. Нажмите кнопку Add Connection / Edit Connection.

В результате выполненных действий будет создано/отредактировано соединение, параметры которого сохранены в файле tcp2nidd.json.

Удаление соединений¶

Для удаления целевого соединения:

1. Нажмите кнопку в строке соединения.

Рисунок 9.4 – Подтверждение удаления одного соединения

2. Нажмите кнопку Remove Connection для подтверждения удаления.

Для удаления нескольких соединений:

1. Выберите соединения, предназначенные для удаления, в таблице.
2. Нажмите кнопку Remove selected items в строке профиля.

Рисунок 9.5 – Подтверждение удаления нескольких соединений

3. Нажмите кнопку Remove для подтверждения удаления.

Удаление профиля¶

Для удаления целевого профиля:

1. Нажмите кнопку в строке профиля.

Рисунок 9.6 –Подтверждение удаления профиля

2. Нажмите кнопку Remove Profile для подтверждения удаления.

Экспорт параметров TCP↔NIDD¶

Информация о профилях и соединениях может быть экспортирована оператором в XLSX-файл.

Для экспорта выполните следующие действия:

1. Нажмите кнопку Export в разделе TCP↔NIDD.

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

2. Выберите папку для хранения XLSX-файла, замените при необходимости название файла и нажмите кнопку Сохранить.

В результате выполненных действий информация о профилях и соединениях будет сохранена в XLSX-файле.

Пример XSLX-файла представлен на рисунке 9.7.

Рисунок 9.7 – Пример экспортированного XLSX-файла TCP↔NIDD

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

• Id – идентификатор соединения.
• Comment – описание соединения.
• Profile Login – логин в учетной записи (NIDD аккаунты в ЛК).
• Profile Password – пароль в учетной записи (NIDD аккаунты в ЛК).
• Profile ScsAsId – идентификатор приложения в ЛК.
• Profile Notification Uri – Uri, на котором выполняется прослушивание сообщений на сервере Меркурий Коммуникатор.
• Profile Answer Timeout, seconds – максимальное время ожидания ответа.
• Config Id – уникальный идентификатор устройства, который возвращается в подписке после запроса.
• External Id – уникальный идентификатор устройства на платформе оператора.
• Protocol – протокол передачи данных.
• Port – порт для связи с устройством, заданный в стороннем приложении.
• Device Port – тип порта, определяет получателя при передаче данных.
• Enabled – состояние соединения.

Описание JSON-файлов¶

Для корректной работы программы Меркурий Коммуникатор оператору необходимо выполнить настройки (или проверить правильность информации) JSON-файлов:

• Data/data;
• win32/appsettings (при работе в ОС Windows) или linux\appsettings (при работе в ОС Linux).
• win32/profiles (при работе в ОС Windows) или linux\profiles (при работе в ОС Linux).

Описание файла data.json¶

Файл data.json содержит данные из программы Меркурий Коммуникатор. Пример файла data.json:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46

{
    "ExternalPorts": [
        {
            "PortNumber": 1001,
            "ClientType": 1,
            "Clients": [
                {
                    "SerialNumber": "ABCD1_1",
                    "Name": "Device1",
                    "LocalPort": 2001
                },
                {
                    "SerialNumber": "ABCD1_2",
                    "Name": "Device2",
                    "LocalPort": 2002
                },
                {
                    "SerialNumber": "ABCD1_3",
                    "Name": "Device3",
                    "LocalPort": 2003
                }
            ]
        },
        {
            "PortNumber": 1002,
            "ClientType": 2,
            "Clients": [
                {
                    "SerialNumber": "ABCD2_1",
                    "Name": "Device1",
                    "LocalPort": 2021
                },
                {
                    "SerialNumber": "ABCD2_2",
                    "Name": "Device2",
                    "LocalPort": 2022
                },
                {
                    "SerialNumber": "ABCD2_3",
                    "Name": "Device3",
                    "LocalPort": 2023
                }
            ]
        }
    ],
}

• ExternalPorts – информация о внешних портах, зарегистрированных в программе:
• PortNumber – номер порта.
• ClientType – тип клиента для внешнего порта.
• Clients – информация об устройствах, подключенных к внешнему порту:
• SerialNumber – идентификационный номер устройства.
• Name – название устройства.
• LocalPort – номер локального порта.

Описание файла appsettings.json¶

Файл appsettings.JSON предназначен для хранения настроек программы. Пример файла appsettings.json:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

{
    "Logging": {
        "LogLevel": {
            "Default": "Warning"
        }
    },
    "AllowedHosts": "*",
    "AdminPassword": "123",
    "VersionCheck": {
        "Url": "https://rd.incotexcom.ru/communicator/versioninfo.json"
    }
}

где: - Logging – конфигурация ведения журналов. - Loglevel – минимальный уровень журнала для выбранных категорий.

Значение настройки: "Default", "Warning" – сохранение в журналах ошибок и предупреждений. - AllowedHosts – список хостов, для которых может работать сайт.

Значение настройки: "*" – без ограничений. - AdminPassword – пароль администратора. - VersionCheck – проверка версии программы.

Значение настройки: "Url" – URL-ссылка на сайт с актуальной версией программы.

Описание файла profiles.json¶

Файл profiles.json предназначен для хранения профилей содержатся предустановленные профили для соединения с HTTP- или SSH-сервером . Пример файла profiles.json:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

[
  {
    "Title": "TCP localhost:80",
    "Value": "{\"TCP\":{\"ip\":\"127.0.0.1\",\"port\":80}}"
  },
  {
    "Title": "COM1 9600...",
    "Value": "{\"COM\":{\"n\":\"tty1\",\"sp\":\"9600\",\"db\":\"8\",\"pt\":\"none\",\"sb\":\"one\"}}"
  }
]

• Title – название профиля.
• Value – значение.

Значение настройки: "TCP" – профиль, связывающий Internal Port внутри устройства с TCP-портом устройства. Значение настройки "{\"TCP\":{\"ip\":\"127.0.0.1\",\"port\":80}}" означает, что для устройств указанного профиля Internal порт приведет на WEB-сервер.

Значение настройки: "COM" – профиль, связывающий Internal Port с COM-портом устройства. Значение настройки: n (имя dev-порта), sp (скорость порта), db (биты данных), pt (четность: "none", "odd", "even"), sb (стоп биты: "none", "one", "two").

Описание файла modems.json¶

Файл modems.JSON предназначен для хранения параметров модемов. Пример файла modems.json:

1
2
3
4
5

[
{"Id":4,"Comment":"1","Ip":"10.129.3.125","MSISDN":"7XXXXXXXXXX","MeterSerial":"42480258","Enabled":false,"ProfileId":1},
{"Id":5,"Comment":"2","Ip":"10.129.10.236","MSISDN":"7XXXXXXXXXX","MeterSerial":"42877451","Enabled":false,"ProfileId":1},
{"Id":6,"Comment":"3","Ip":"10.129.10.237","MSISDN":"7XXXXXXXXXX","MeterSerial":"41921427","Enabled":false,"ProfileId":1}
]

• ID – идентификатор модема.
• Comment – описание.
• Ip – статический IP-адрес счетчика.
• MSISDN – номер SIM карты модема.
• MeterSerial – заводской номер счетчика.
• Enabled – контроль пребывания в сети true/false.
• ProfileId – идентификатор профиля SMS из файла modem-profiles.json.

Описание файла modems-settings.json¶

Файл modems-settings.JSON предназначен для хранения параметров восстановления связи. Пример файла modems-settings.json:

1

{"PeriodicityMins":5,"DelayBetweenPingsSecs":15,"DelayBetweenSmsSecs":60,"DelayBetweenAttemptsMins":5,"AttemptsBeforeDisable":3,"ComPort":"COM42"}

• PeriodicityMins – периодичность передачи запросов, мин.
• DelayBetweenPingsSecs – интервал между проверками соединения, с.
• DelayBetweenSmsSecs – интервал между отправками SMS, с.
• DelayBetweenAttemptsMins – интервал между попытками отправки, мин.
• AttemptsBeforeDisable – максимальное количество попыток отправки.
• ComPort – номер COM порта, выделенного при подключении модема.

Описание файла modem-profiles.json¶

Файл modems-profiles.JSON предназначен для хранения профилей SMS. Пример файла modems-profiles.json:

1
2
3

[
  { "Id": 1, "Comment": "Default", "Command1": "###!10!", "Command2": "###!20!" }
]

• ID – идентификатор профиля SMS.
• Comment – название профиля.
• Command1 – текстовая часть SMS-команды 1.
• Command2 – текстовая часть SMS-команды 2.

Описание файла modems-statuses.json¶

Файл modems-statuses.json содержит данные о состоянии связи из программы Меркурий Коммуникатор. Пример файла modems-statuses.json:

1
2
3
4
5

[
{"ModemId":4,"FailedPings":3,"FailedAttempts":3,"DateLastSuccessPingUtc":null,"DateLastFailedPingUtc":"2022-01-14T10:32:50.931469Z","DateSms1SentUtc":"2022-01-14T10:24:06.7894783Z","DateSms2SentUtc":"2022-01-14T10:25:09.6844163Z"},
{"ModemId":5,"FailedPings":3,"FailedAttempts":3,"DateLastSuccessPingUtc":null,"DateLastFailedPingUtc":"2022-01-14T10:37:24.4287422Z","DateSms1SentUtc":"2022-01-14T10:30:32.3503436Z","DateSms2SentUtc":"2022-01-14T10:31:35.0349989Z"},
{"ModemId":6,"FailedPings":0,"FailedAttempts":1,"DateLastSuccessPingUtc":"2022-01-14T10:37:40.9162636Z","DateLastFailedPingUtc":"2022-01-14T10:44:15.4220142Z","DateSms1SentUtc":"2022-01-14T10:44:33.4169761Z","DateSms2SentUtc":"2022-01-14T10:45:36.2956209Z"}
]

• ModemID – идентификатор модема.
• FailedPings – количество неуспешных попыток подключения.
• FailedAttempts – количество неуспешных попыток отправки.
• DateLastSuccessPingUtc – дата и время последнего успешного подключения.
• DateLastFailedPingUtc – дата и время последней ошибки связи.
• DateSms1SentUtc – дата и время отправки SMS 1.
• DateSms2SentUtc – дата и время отправки SMS 2.

Описание файла tcp2nidd.json¶

Файл tcp2nidd.json содержит данные о nidd-соединениях и профилях соединений из программы Меркурий Коммуникатор. Пример файла tcp2nidd.json:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

[
    {
        "Id": "7a60b697-9805-4d5b-9e40-aef006ffa7f7",
        "Login": "ivanov",
        "Password": "ivanov_pwd",
        "ScsAsId": "ivanov",
        "NotificationUri": "http://*:2400/scef/callback/",
        "AnswerTimeout": 30,
        "Connections": [
            {
                "Id": "3a75974d-d1ce-4d2e-a134-c55cd8ca2bc6",
                "Enabled": true,
                "Protocol": 1,
                "Port": 51111,
                "ConfigId": "61f8d8300a0b00920018e563",
                "Comment": "Тест, TCP:51111 <-> Main:2",
                "Error": null,
                "ExternalId": "test01.1@177730218461.iot.mts.ru",
                "DevicePort": 2
            }
        ]
    }
]

• ID – идентификатор профиля.
• Login – логин в учетной записи (NIDD аккаунты в ЛК).
• Password – пароль в учетной записи (NIDD аккаунты в ЛК).
• ScsAsId – идентификатор приложения в ЛК.
• NotificationUri – Uri, на котором выполняется прослушивание сообщений на сервере Меркурий Коммуникатор.
• AnswerTimeout – максимальное время ожидания ответа, с.
• Connections:[
• Id – идентификатор соединения.
• Enabled – состояние соединения. – Protocol – 1 – TCP; 2 – UDP.
• Port – порт для связи с устройством, заданный в стороннем приложении.
• ConfigId – уникальный идентификатор устройства, который возвращается в подписке после запроса.
• Comment – описание соединения.
• Error – ошибка соединения.
• ExternalId – уникальный идентификатор устройства на платформе оператора.
• DevicePort – 2 – Main:2 (конфигуратор-счетчик); 3 – RS485:3 (приложение-счетчик, соединенный с модулем связи по RS485); 0 – LpWan:0 (приложение-модуль связи). ]

Приложение А¶

(Справочное)

Поддерживаемое оборудование