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

Программный интерфейс входит в состав системы отображения метеорологических данных МФ МГТУ им. Н.Э. Баумана. Основные функции программного интерфейса состоят в получении, передачи и обработке метеорологической информации в формате JSON.

В состав технических средств должен входить персональный компьютер (ПЭВМ), выполняющий роль сервера, включающий в себя:

• Процессор Pentium-2.0Hz, не менее
• Оперативную память объемом 1 ГБ, не менее
• Свободное место на диске объемом 1 ГБ, не менее. Данное требование обусловлено тем, что для корректной работы программного интерфейса необходимо установить ряд программных зависимостей

Для функционирования программного интерфейса необходимо инсталлировать резидентную систему управления базами данных класса NoSQL Redis версии 6.0.1. Также необходимо установить программную платформу Node.js версии 12.16.3, а также ряд npm-пакетов и модулей:

• express - фреймворк для языка JavaScript
• redis - модуль, работающий с базой данных Redis
• fs - модуль, позволяющий работать с файловой системой сервера
• request - модуль, необходимый для осуществления отправки асинхронных запросов
• http-errors - модуль обработчика HTTP-ошибок
• path - модуль, помогающий определить путь файла в файловой системе
• cookie-parser - модуль обработчика cookie-файлов
• morgan - модуль, позволяющий осуществлять логирование и вести системный журнал, в случае неполадок и критических ошибок
• moment - модуль, предоставляющий функции для работы со временем
• graphql - модуль, предоставляющий возможность проектирования, используя архитектуру GraphQL
• express-graphql - модуль, связывающий фреймворк express и graphql

Все вышеперечисленные модули устанавливаются с помощью команды:

$ npm install "имя пакета"

Все вышеописанное программное обеспечение необходимо устанавливать на операционные системы семейства Linux и Windows. При использовании Windows единственным ограничением будет необходимое использование операционной системы Windows 7 или выше.

Программный интерфейс работает в режиме 24/7 на сервере мониторинговой системы, ожидая запросы на получение данных. Вместе с программным интерфейсом постоянно работает Redis, который расположен на порте сервера 6379.

Входной информацией для программного интерфейса будет являться GET-запрос по протоколу HTTP к интерфейсу REST или GraphQL. Список всех возможных запросов к программному интерфейсу REST:

Для отправки запроса к программному интерфейсу REST необходимо обратиться к следующему URL:

 http://название_домена:3000/db_api_REST/запрос 

Список всех возможных запросов к программному интерфейсу GraphQL:

Для отправки запроса к программному интерфейсу GraphQL необходимо отправить GET-запрос по протоколу HTTP на следующий URL:

 http://название_домена:4000/graphql?query=GraphQL-запрос 

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

"1294425": {
"Date": "2020-05-14 11:15:38",
"uName": "Тест Студии",
"serial": "schHome",
"data": {
"system_Version": "2020-01-11",
"system_Upit": " 2.96",
"system_RSSI": "-61",
"system_MAC": "60:01:94:06:05:04",
"RTC_date": "2020-05-14",
"RTC_time": "11:15:32",
"BH1750_lux": "426.67",
"BH1750_blinkmin": "426",
"BH1750_blinkmax": "426",
"BH1750_blink": "0",
"TCS34725_red": "10091",
"TCS34725_green": "8868",
"TCS34725_blue": "9148",
"TCS34725_clear": "21810",
"TCS34725_redC": "6943",
"TCS34725_greenC": "5720",
"TCS34725_blueC": "6000",
"TCS34725_clearC": "18662",
"TCS34725_ir": "3148",
"TCS34725_colorTemp": "8804",
"TCS34725_colorTempCT": "4683.52",
"TCS34725_lux": "506.57",
"BMP280_temp": "14.49",
"BMP280_pressure": "744.43",
"BME280_temp": "13.87",
"BME280_humidity": "46.69",
"BME280_pressure": "743.2",
"DS18B20_temp": "13.69",
"AM2321_temp": "14",
"AM2321_humidity": "41.6"
}
}

Выше рассмотрена одна выходная запись, ключом которой является ее уникальный номер в базе – 1294425. Ее значение – словарь, в котором содержатся общие данные: время измерения, название прибора, его серийный номер. Также в значении записи находится словарь «data», в котором содержится вся метеорологическая и системная информация в формате «параметр – значение».