API - методы модуля driver
Таблица 1. Сводная таблица всех API методов модуля driver
Описание | URL | Метод |
/api/send_dl | GET | |
/api/status_dl | GET | |
/api/read_setting | GET | |
/api/write_setting | GET | |
/api/get_roll | GET | |
/api/get_eav | GET | |
/api/reparse_modem | GET |
GET запрос:
URL | Список параметров | Пример запроса |
/api/send_dl | modem_id, data,timeout | /api/send_dl?modem_id=7520059,7520060&data={"datа":{<plugin_json_data>}}&timeout=1000 |
Ответ:
BODY |
{ "7520059": "5cf0f676549023020ed87622", "7520060": "5cf0f676549023020ed87623" } |
Описание параметров запроса
Имя параметра | Тип | Описание | Значение по умолчанию |
modem_id | int | номера(а) устройств | обязательный параметр |
data | JSON | данные в формате плагина appsandbox обслуживающего устройства | обязательный параметр |
timeout | int | таймаут исполнения даунлинка, сек | 30 суток |
Статус отправленных DL пакетов
GET запрос:
URL | Список параметров | Пример запроса |
/api/status_dl | db_id | /api/status_dl?db_id=5cf0f676549023020ed87622,5cf0f676549023020ed87623 |
Ответ:
BODY |
{ "5cf0f676549023020ed87622": "PENDING", "5cf0f676549023020ed87623": "PENDING" } |
Описание параметров запроса
Имя параметра | Тип | Описание | Значение по умолчанию |
db_id | string | перечень ID необходимых DL сообщений | обязательный параметр |
GET запрос:
URL | Список параметров | Пример запроса |
api/read_setting | modem_id, setting | /api/read_setting?modem_id=7520059,7520047&setting=0100010800FF,01000C0700FF |
Ответ:
BODY |
{ |
Описание параметров запроса
Имя параметра | Тип | Описание | Значение по умолчанию |
modem_id | int | номера(а) устройств | обязательный параметр |
setting | string | перечень параметров | все параметры |
GET запрос:
URL | Список параметров | Пример запроса |
api/write_setting | modem_id, setting, value | /api/write_setting?modem_id=7520059,7520047&setting=0100010800FF,01000C0700FF&value=100,10 |
Ответ:
BODY |
{ "7520047": "ok", "7520059": "ok" } |
Описание параметров запроса
Имя параметра | Тип | Описание | Значение по умолчанию |
modem_id | int | номера(а) устройств | обязательный параметр |
setting | string | перечень параметров | обязательный параметр |
value | int,doble,string | перечень значений | обязательный параметр |
GET запрос:
URL | Список параметров | Пример запроса |
api/get_roll | modem_id, limit, tag, from, to | /api/get_roll?modem_id=7520052,7520047&limit=2&tag=electro5.data_day&from=1555000000&to=1559298478 |
Ответ:
BODY |
{ "7520047":[ { "bs_timezone_offset":10800, "data":{ "data":{ "0100010600FF":0, "0100010801FF":0, "0100010802FF":0, "0100010803FF":0, "0100010804FF":0, "0100020801FF":0, "0100020802FF":0, "0100020803FF":0, "0100020804FF":0, "0100030801FF":0, "0100030802FF":0, "0100030803FF":0, "0100030804FF":0, "0100040801FF":0, "0100040802FF":0, "0100040803FF":0, "0100040804FF":0 }, "timestamp":1556184361 }, "extended_data":{ "0100010800FF":0, "0100020800FF":0, "0100030800FF":0, "0100040800FF":0 }, "hw_type":"phobos1_stm", "modem_id":7520047, "parse_status":"parsed", "payload":"4408bc5cc1a758818900000000828900000000838900000000848900000000818a00000000828a00000000838a00000000848a00000000818b00000000828b00000000838b00000000848b00000000818c00000000828c00000000838c00000000848c00000000816800000000", "phy":"UL_DBPSK_3200_PROT_D", "protocol":"electro5", "rssi":-99, "snr":55, "station_id":9500, "tag":"electro5.data_day", "time_detected":1556196731, "timestamp":1556184361, "unique_id":-1514654365089619700 }, { "bs_timezone_offset":10800, "data":{ "data":{ "0100010600FF":0, "0100010801FF":0, "0100010802FF":0, "0100010803FF":0, "0100010804FF":0, "0100020801FF":0, "0100020802FF":0, "0100020803FF":0, "0100020804FF":0, "0100030801FF":0, "0100030802FF":0, "0100030803FF":0, "0100030804FF":0, "0100040801FF":0, "0100040802FF":0, "0100040803FF":0, "0100040804FF":0 }, "timestamp":1556053201 }, "extended_data":{ "0100010800FF":0, "0100020800FF":0, "0100030800FF":0, "0100040800FF":0 }, "hw_type":"phobos1_stm", "modem_id":7520047, "parse_status":"parsed", "payload":"4408ab5cbfa700818900000000828900000000838900000000848900000000818a00000000828a00000000838a00000000848a00000000818b00000000828b00000000838b00000000848b00000000818c00000000828c00000000838c00000000848c00000000816800000000", "phy":"UL_DBPSK_3200_PROT_D", "protocol":"electro5", "rssi":-99, "snr":57, "station_id":9450, "tag":"electro5.data_day", "time_detected":1556064036, "timestamp":1556053201, "unique_id":-7080719924255875000 } ], "7520052":[ { "bs_timezone_offset":10800, "data":{ "data":{ "0100010600FF":0, "0100010801FF":75.982, "0100010802FF":0, "0100010803FF":0, "0100010804FF":0, "0100020801FF":0, "0100020802FF":0, "0100020803FF":0, "0100020804FF":0, "0100030801FF":0.277, "0100030802FF":0, "0100030803FF":0, "0100030804FF":0, "0100040801FF":158.05, "0100040802FF":0, "0100040803FF":0, "0100040804FF":0 }, "timestamp":1555448401 }, "extended_data":{ "0100010800FF":75.982, "0100020800FF":0, "0100030800FF":0.277, "0100040800FF":158.05 }, "hw_type":"phobos1_stm", "modem_id":7520052, "parse_status":"parsed", "payload":"4402f35cb66c808189000128ce828900000000838900000115848900026962818a00000000828a00000000838a00000000848a00000000818b00000000828b00000000838b00000000848b00000000818c00000000828c00000000838c00000000848c00000000816800000000", "phy":"UL_DBPSK_50_PROT_D", "protocol":"electro5", "rssi":-122, "snr":29, "station_id":9333, "tag":"electro5.data_day", "time_detected":1556627738, "timestamp":1555448401, "unique_id":8182095005285595000 } ] } |
Описание параметров запроса
Имя параметра | Тип | Описание | Значение по умолчанию |
modem_id | int | номера(а) устройств | обязательный параметр |
limit | int | ограничение возвращаемых записей на модем | 1000 |
tag | string | перечень тэгов | все варианты |
from | int | таймстамп времени начала данных | 0 |
to | int | таймстамп времени окончания данных | текущее время |
GET запрос:
URL | Список параметров | Пример запроса |
api/get_eav | modem_id, limit, tag, from, to, type, obis_code | /api/get_eav?type=value&modem_id=7520052,7520047&obis_code=0100010802FF,0100010801FF&tag=electro5.data_day&from=1555000000&to=1559298478&limit=3 |
Ответ:
BODY |
{ "7520047":[ { "message_id":"eafadde14356a146", "modem_id":7520047, "obis_code":"0100010801FF", "tag":"electro5.data_day", "timestamp":1556184361, "ttl":0, "value":0 }, { "message_id":"eafadde14356a146", "modem_id":7520047, "obis_code":"0100010802FF", "tag":"electro5.data_day", "timestamp":1556184361, "ttl":0, "value":0 }, { "message_id":"9dbc3abe80b29fdc", "modem_id":7520047, "obis_code":"0100010801FF", "tag":"electro5.data_day", "timestamp":1556053201, "ttl":0, "value":0 } ], "7520052":[ { "message_id":"718ca40e848bb78e", "modem_id":7520052, "obis_code":"0100010801FF", "tag":"electro5.data_day", "timestamp":1555448401, "ttl":0, "value":75.982 }, { "message_id":"718ca40e848bb78e", "modem_id":7520052, "obis_code":"0100010802FF", "tag":"electro5.data_day", "timestamp":1555448401, "ttl":0, "value":0 } ] } |
Описание параметров запроса
Имя параметра | Тип | Описание | Значение по умолчанию |
modem_id | int | номера(а) устройств | обязательный параметр |
limit | int | ограничение возвращаемых записей на модем | 1000 |
tag | string | перечень тэгов | все варианты |
from | int | таймстамп времени начала данных | 0 |
to | int | таймстамп времени окончания данных | текущее время |
type | string | тип запрашиваемых данных value/event | обязательный параметр |
obis_code | string | перечень параметров | все варианты |
Запрос на репарсинг бинарных пакетов
Запрос удаляет данные из баз appsandbox за выбранные период времени и перезапрашивает бинарные пакеты у telecom сервера
GET запрос:
URL | Список параметров | Пример запроса |
api/reparse_modem | modem_id, from, to, request | /api/reparse_modem?modem_id=7520059,7520047&from=1555000000&to=1559298478&request=true |
Ответ:
BODY |
{ "7520047": "ok", "7520059": "ok" } |
Описание параметров запроса
Имя параметра | Тип | Описание | Значение по умолчанию |
modem_id | int | номера(а) устройств | обязательный параметр |
from | int | таймстамп времени начала данных | 0 |
to | int | таймстамп времени окончания данных | текущее время |
request | string | выполнение запроса данных в telecom сервер true/false | false |