Skip to main content
Skip table of contents

10. [DKSO 708.1.5] Работа c HTTP API

Устройство предоставляет удобный HTTP API для получения информации о состоянии системы и управления её параметрами. API позволяет интегрировать устройство в существующую инфраструктуру, автоматизировать сбор данных и выполнять удалённое управление без необходимости доступа через web-интерфейс, SSH или SNMP.

Запросы имеют вид:

http://{login}:{password}@{host}:{port}/{module}/{command}?{attribute1}={value1}&{attribute2}={value2}&…&{attributeN}={valueN}

  • login — имя пользователя (visor).

  • password — пароль (ping).

  • host — адрес устройства.

  • port — порт, на котором работает API (8080).

  • module — название функционального модуля.

  • command — имя метода функционального модуля.

  • attributeN — имя входного параметра N метода.

  • valueN — значение входного параметра N метода.

Пример запроса для перевода реле с ID 5 в состояние “Включено”:

http://visor:ping@192.168.0.7:8080/owrt-digital-outs/set_val_relay?id_relay=5&value=1&ubus_rpc_session=String

Ответы приходят в формате JSON вида:

CODE 
{
“netping”: {
"command": "module/command",
"result": "'ok' or 'error'",
"message": "other result information'"
},
"payload":{
'Rest of response data'
}
}

Список команд API

В списке вызовы указаны в виде МЕТОД /путь, без учёта хоста и аутентификации.
Полный URL включает хост, порт и учётные данные для аутентификации. Например, для команды GET /system/info при доступе к серверу по адресу 192.168.0.7:8080 с логином visor и паролем ping, полный запрос будет: http://visor:ping@192.168.0.7:8080/system/info.

Команда

Вызов

Ответ

Описание полей в ответе

Системные ресурсы

Запрос информации о текущем состоянии системы

GET /system/info

{"netping": {"command": "system/info", "result": "ok"}, "payload": {"localtime": 1756461139, "uptime": 1335, "load": [386240, 384896, 311104], "memory": {"total": 520744960, "free": 360181760, "shared": 253952, "buffered": 3694592, "available": 354529280, "cached": 31952896}, "swap": {"total": 0, "free": 0}}}

localtime — текущее время в формате Unix timestamp.

uptime — время работы системы в секундах.

load — средняя нагрузка за 1, 5 и 15 минут.

memory — информация об использовании оперативной памяти (в байтах).

swap — информация о swap-разделе.

Запрос информации об оборудовании

GET /system/board

{"netping": {"command": "system/board", "result": "ok"}, "payload": {"kernel": "4.9.11", "hostname": "NetpingGSM", "system": "ARMv7 Processor rev 5 (v7l)", "model": "NetPing GSM Gateway 708G06", "board_name": "netping", "release": {"distribution": "OpenWrt", "version": "SNAPSHOT", "revision": "r12894-8946031", "target": "imx6/generic", "description": "OpenWrt SNAPSHOT r12894-8946031"}}}

kernel — версия ядра Linux.

hostname — имя устройства в сети.

system — архитектура процессора.

model — название устройства.

board_name — внутреннее имя платы.

release — подробная информация о версии прошивки OpenWrt.

Перезагрузка устройства

GET /system/reboot

Сторож

Запрос статуса пингера сторожа

GET /owrt_pingers/get_pinger_state?name={name}

Параметры запроса:

name — название пингера

{"netping": {"command": "owrt_pingers/get_pinger_state", "result": "ok"}, "payload": {"state": "1", "status": "1"}}

 state — состояние пингера. Возможные значения:

  • 0 - pinger выключен

  • 1 - pinger включен

status — статус пингера. Возможные значения:

  • 2 - при опросе пингера произошла ошибка

  • 1 - пингер не включен или еще не было произведено ни одного завершенного опроса с момента его запуска

  • 0 - пингер закончил опрос, однако опрашиваемый объект недоступен

  • 1 - пингер закончил опрос, опрашиваемый объект доступен

Запрос статуса правила сторожа

GET /owrt_pingers/get_rule_state?name={name}

Параметры запроса:

name — название правила

{"netping": {"command": "owrt_pingers/get_rule_state", "result": "ok"}, "payload": {"state": "1", "status": "1"}}

 state — состояние правила. Возможные значения:

  • 0 - правило выключено

  • 1 - правило включено

status — cтатус правила. Возможные значения:

  • -2 - при вычислении логического выражения произошла ошибка

  • -1 - правило не включено или еще не было произведено ни одного завершенного вычисления логического выражения правила с момента его запуска

  • 0 - правило вычислено, логическое выражение ложно

  • 1 - правило вычислено, логическое выражение истинно

Бинарные входы

Запрос состояния входа (по имени)

GET /owrt_digital_inputs/get_state?name={name}&ubus_rpc_session=String

Параметры запроса:

name — наименование входа

ubus_rpc_session — служебный параметр

{"netping": {"command": "owrt_digital_inputs/get_state", "result": "ok"}, "payload": {"state": "1", "status": "0", "count": 0, "state_desc": "ON"}}

state — cостояние входа. Возможные значения:

  • -1 - от входа не было получено ни одного состояния

  • 0 - состояние входа - 0

  • 1 - состояние входа - 1

status — статус входа. Возможные значения:

  • -2 - запрошенный вход в настоящее время не опрашивается

  • -1 - от входа не было получено ни одного статуса

  • 0 - последний цикл опроса был выполнен без ошибки

  • 1 - на последнем цикле опроса была получена ошибка таймаута

  • 2 - на последнем цикле опроса была получена ошибка и это не ошибка таймаута

count — количество изменений фронта по заданному методу подсчёта (0/1, 1/0 или 0/1/0).

Запрос состояния входа (по ID)

GET owrt_digital_inputs/get_state_by_id?sensor_id={sensor_id}&ubus_rpc_session=String

Параметры запроса:

sensor_id — ID входа

ubus_rpc_session — служебный параметр

{"netping": {"command": "owrt_digital_inputs/get_state_by_id", "result": "ok"}, "payload": {"state": "1", "status": "0", "count": 0, "state_desc": "ON"}}

state — cостояние входа. Возможные значения:

  • -1 - от входа не было получено ни одного состояния

  • 0 - состояние входа - 0

  • 1 - состояние входа - 1

status — статус входа. Возможные значения:

  • -2 - запрошенный вход в настоящее время не опрашивается

  • -1 - от входа не было получено ни одного статуса

  • 0 - последний цикл опроса был выполнен без ошибки

  • 1 - на последнем цикле опроса была получена ошибка таймаута

  • 2 - на последнем цикле опроса была получена ошибка и это не ошибка таймаута

count — количество изменений фронта по заданному методу подсчёта (0/1, 1/0 или 0/1/0).

Установка значения счётчика импульсов на входе

GET owrt_digital_inputs/set_counter?sensor_id={sensor_id}&count={count}&ubus_rpc_session=String

Параметры запроса:

sensor_id — ID входа

count — значение счётчика импульсов на входе

ubus_rpc_session — служебный параметр

{"netping": {"command": "owrt_digital_inputs/set_counter", "result": "ok"}, "payload": {"result": "0"}}

result — результат выполнения команды:

  • -1 - ошибка в ходе выполнения команды

  • 0 - команда выполнена успешно

Запрос описания входа

GET owrt_digital_inputs/get_descr?sensor_id={sensor_id}&ubus_rpc_session=String

Параметры запроса:

sensor_id — ID входа

ubus_rpc_session — служебный параметр

{"netping": {"command": "owrt_digital_inputs/get_descr", "result": "ok"}, "payload": {"result": "0", "description": "Input 1"}}

result — результат выполнения команды:

  • -1 - ошибка в ходе выполнения команды

  • 0 - команда выполнена успешно

descr — текстовое описание входа

Изменение описания входа

GET /owrt_digital_inputs/set_descr?sensor_id={sensor_id}&descr={descr}&ubus_rpc_session=String

Параметры запроса:

sensor_id — ID входа

descr — текстовое описание входа

ubus_rpc_session — служебный параметр

{"netping": {"command": "owrt_digital_inputs/set_descr", "result": "ok"}, "payload": {"result": "0"}}

result — результат выполнения команды:

  • -1 - ошибка в ходе выполнения команды

  • 0 - команда выполнена успешно

Добавление нового входа

GET /owrt_digital_inputs/add_sensor?name={name}&description={description}&ton_desc={ton_desc}&toff_desc={toff_desc}&protocol={protocol}&protocol_params[param1]={param1}&protocol_params[param2]={param2}&ubus_rpc_session=String

Параметры запроса:

name — имя входа

description — описание входа

ton_desc — текст, отображаемый при значении “1”

toff_desc — текст, отображаемый при значении “0”

protocol — тип протокола датчика (gpio или snmp).

param1, param2... — параметры, специфичные для протокола:

  • для gpio:

    • countable — включить/выключить подсчет импульсов

    • min_pulse_time — минимальная длительность импульса

    • debounce_time — время устранения дребезга

    • count_type — направление подсчета импульсов

  • для snmp:

    • snmp_addr — адрес SNMP-агента

    • snmp_port — порт SNMP-агента

    • community — имя community

    • oid — oid

    • timeout — таймаут ответа от SNMP-агента

    • period — интервал опроса SNMP-агента

ubus_rpc_session — служебный параметр

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

http://visor:ping@192.168.0.5:8080/owrt_digital_inputs/add_sensor?name=IO2&description=In2&ton_desc=ON&toff_desc=OFF&protocol=gpio&protocol_params[count_type]=1/0&protocol_params[min_pulse_time]=4000&ubus_rpc_session=String

{"netping": {"command": "owrt_digital_inputs/add_sensor", "result": "ok"}, "payload": {"sensor_id": "2", "status": "Sensor (sensor_id = 2) successfully added", "result": 0}}

sensor_id — ID, присвоенный входу

status — текстовое описание результата добавления

result — результат операции:

  • !0 - добавление завершилось с ошибкой

  • 0 - добавление выполнено успешно

Обновление параметров существующего входа

GET /owrt_digital_inputs/update_sensor?sensor_id={sensor_id}&name={name}&description={description}&ton_desc={ton_desc}&toff_desc={toff_desc}&protocol={protocol}&protocol_params[param1]={param1}&protocol_params[param2]={param2}&ubus_rpc_session=String

Параметры запроса:

sensor_id — ID входа

name — имя сенсора

description — описание входа

ton_desc — текст, отображаемый при значении “1”

toff_desc — текст, отображаемый при значении “0”

protocol — тип протокола датчика (gpio или snmp).

param1, param2... — параметры, специфичные для протокола:

  • для gpio:

    • countable — включить/выключить подсчет импульсов

    • min_pulse_time — минимальная длительность импульса

    • debounce_time — время устранения дребезга

    • count_type — направление подсчета импульсов

  • для snmp:

    • snmp_addr — адрес SNMP-агента

    • snmp_port — порт SNMP-агента

    • community — имя community

    • oid — oid

    • timeout — таймаут ответа от SNMP-агента

    • period — интервал опроса SNMP-агента

ubus_rpc_session — служебный параметр

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

http://visor:ping@192.168.0.5:8080/owrt_digital_inputs/update_sensor?sensor_id=1&name=IO2&description=In222&ton_desc=ON2&toff_desc=OFF2&protocol=gpio&protocol_params[count_type]=1/0&protocol_params[min_pulse_time]=4000&ubus_rpc_session=String

{"netping": {"command": "owrt_digital_inputs/update_sensor", "result": "ok"}, "payload": {"sensor_id": "1", "status": "Sensor (sensor_id = 1) successfully updated", "result": 0}}

sensor_id — ID, присвоенный входу

status — текстовое описание результата обновления

result — результат операции:

  • !0 - добавление завершилось с ошибкой

  • 0 - добавление выполнено успешно

Удаление входа

GET /owrt_digital_inputs/del_sensor?sensor_id={sensor_id}&ubus_rpc_session=String

sensor_id — ID входа

ubus_rpc_session — служебный параметр

{"netping": {"command": "owrt_digital_inputs/del_sensor", "result": "ok"}, "payload": {"status": "Sensor (sensor_id = 2) successfully deleted", "result": 0}}

result — результат операции:

  • -1 - удаление завершилось с ошибкой

  • 0 - удаление выполнено успешно

status — текстовое описание результата добавления.

Запрос списка параметров входа

GET /owrt_digital_inputs/get_sensor_params?sensor_id={sensor_id}&ubus_rpc_session=String

sensor_id — ID входа

ubus_rpc_session — служебный параметр

{"netping": {"command": "owrt_digital_inputs/get_sensor_params", "result": "ok"}, "payload": {"status": {"protocol": "gpio", "countable": "0", "min_pulse_time": "100", "debounce_time": "100", "sensor_id": "1", "count_type": "1/0", "name": "IO2", "description": "In2", "ton_desc": "ON", "toff_desc": "OFF"}, "result": 0}}

status — JSON список параметров или сообщение об ошибке

result — результат выполнения команды:

  • -1 - ошибка в ходе выполнения команды

  • 0 - команда выполнена успешно

Запрос списка всех опрашиваемых входов

GET /owrt_digital_inputs/list_active_sensors?ubus_rpc_session=String

ubus_rpc_session — служебный параметр

{"netping": {"command": "owrt_digital_inputs/list_active_sensors", "result": "ok"}, "payload": {"1": {"name": "IO1", "proto": "gpio", "type": "local"}, "1000": {"name": "SNMP In1", "proto": "snmp", "type": "remote"}}}

Список опрашиваемых входов. Указывается ID входа и его параметры:

  • name — имя входа

  • proto — протокол подключения входа (gpio или SNMP)

  • type — тип входа (local или remote)

Запрос списка локальных входов, не добавленных на данный момент

GET owrt_digital_inputs/list_avail_local_sensors?ubus_rpc_session=String

ubus_rpc_session — служебный параметр

{"netping": {"command": "owrt_digital_inputs/list_avail_local_sensors", "result": "ok"}, "payload": {"result": 0, "devices": {"IO2": {"sensor_id": "2", "allow_dirs": "in/out"}}}}

result — результат выполнения команды:

  • -1 - ошибка в ходе выполнения команды

  • 0 - команда выполнена успешно

devices — список не добавленных линий. Указывается системное имя линии и ее параметры:

  • sensor_id — ID линии

  • allow_dirs — разрешенные направления работы

Бинарные выходы

Запрос состояния выхода

GET owrt-digital-outs/get_state?id_relay={id_relay}&ubus_rpc_session=String

Параметры запроса:

id_relay — ID выхода

ubus_rpc_session — служебный параметр

{"netping": {"command": "owrt-digital-outs/get_state", "result": "ok"}, "payload": {"state": 1, "status": 0, "result": 0}}

state — cостояние выхода. Возможные значения:

  • -1 - от выхода не было получено ни одного состояния

  • 0 - состояние выхода - 0

  • 1 - состояние выхода - 1

status — статус выхода. Возможные значения:

  • -2 - запрошенный выход в настоящее время не опрашивается

  • -1 - от выхода не было получено ни одного статуса

  • 0 - последний цикл опроса был выполнен без ошибки

  • 1 - на последнем цикле опроса была получена ошибка таймаута

  • 2 - на последнем цикле опроса была получена ошибка и это не ошибка таймаута

result — результат выполнения команды:

  • -1 - ошибка в ходе выполнения команды

  • 0 - команда выполнена успешно

Перевод выхода в указанное состояние

GET /owrt-digital-outs/set_val_relay?id_relay={id_relay}&value={value}&ubus_rpc_session=String

Параметры запроса:

id_relay — ID выхода

value — значение для установки выхода (0 или 1)

ubus_rpc_session — служебный параметр

{"netping": {"command": "owrt-digital-outs/set_val_relay", "result": "ok"}, "payload": {"result": 0, "status": "1796e053"}}

result — результат выполнения команды:

  • -1 - ошибка в ходе выполнения команды

  • 0 - команда выполнена успешно

status — уникальный id код, назначенный данной операции

Перевод выхода в противоположное состояние

GET /owrt-digital-outs/switch_relay?id_relay={id_relay}&ubus_rpc_session=String

Параметры запроса:

id_relay — ID выхода

ubus_rpc_session — служебный параметр

{"netping": {"command": "owrt-digital-outs/switch_relay", "result": "ok"}, "payload": {"result": 0, "status": "fb5287f5"}}

result — результат выполнения команды:

  • -1 - ошибка в ходе выполнения команды

  • 0 - команда выполнена успешно

status — уникальный id код, назначенный данной операции

Запуск одиночного положительного импульса на выходе.

Если выход находится в положении “Включено”, команда будет проигнорирована.

GET /owrt-digital-outs/impuls_on_relay?id_relay={id_relay}&time={time}&ubus_rpc_session=String

Параметры запроса:

id_relay — ID выхода

time — время в секундах, на которое следует установить выход в положение “Включить”

ubus_rpc_session — служебный параметр

{"netping": {"command": "owrt-digital-outs/impuls_on_relay", "result": "ok"}, "payload": {"result": 0, "status": "4678a28c"}}

result — результат выполнения команды:

  • -1 - ошибка в ходе выполнения команды

  • 0 - команда выполнена успешно

status — уникальный id код, назначенный данной операции

Запуск одиночного отрицательного импульса на выходе.

Если выход находится в положении “Выключить”, команда будет проигнорирована.

GET /owrt-digital-outs/impuls_off_relay?id_relay={id_relay}&time={time}&ubus_rpc_session=String

Параметры запроса:

id_relay — ID выхода

time — время в секундах, на которое следует установить выход в положение “Выключить”

ubus_rpc_session — служебный параметр

{"netping": {"command": "owrt-digital-outs/impuls_off_relay", "result": "ok"}, "payload": {"result": 0, "status": "3f44a00c"}}

result — результат выполнения команды:

  • -1 - ошибка в ходе выполнения команды

  • 0 - команда выполнена успешно

status — уникальный id код, назначенный данной операции

Добавление нового выхода

GET /owrt-digital-outs/add_relay?name={name}&memo={memo}&protocol={protocol}&start_state={start_state}&state_alias_0={state_alias_0}&state_alias_1={state_alias_1}&protocol_params[param1]={param1}&protocol_params[param2]={param2}&ubus_rpc_session=String

Параметры запроса:

name — имя выхода

memo — описание выхода

protocol — протокол подключения выхода (gpio или SNMP).

start_state — начальное состояние при включении (0, 1 или NO)

state_alias_0 - текст, отображаемый при значении “0”

state_alias_1 — текст, отображаемый при значении “1”

param1, param2... — параметры, специфичные для протокола:

  • для gpio:

    • period — интервал опроса состояния выхода в секундах

  • для snmp:

    • address — адрес SNMP-агента

    • oid_rd — OID для чтения

    • oid_wr — OID для записи

    • type_oid — тип OID

    • community_rd — имя community для операций чтения

    • community_wr — имя community для операций записи

    • port — порт SNMP-агента

    • period — интервал опроса SNMP-агента

    • timeout — таймаут ответа от SNMP-агента

ubus_rpc_session — служебный параметр

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

http://visor:ping@192.168.0.5:8080/owrt-digital-outs/add_relay?name=PWR2&memo=RelayGPIO2&protocol=gpio&start_state=NO&state_alias_0=OFF&state_alias_1=ON&protocol_params[period]=1&ubus_rpc_session=String

{"netping": {"command": "owrt-digital-outs/add_relay", "result": "ok"}, "payload": {"id": 6, "result": 0}}

id — значение id, назначенное новому выходу

result — результат выполнения команды:

  • -1 - ошибка в ходе выполнения команды

  • 0 - команда выполнена успешно

Удаление выхода

GET /owrt-digital-outs/del_relay?id_relay={id_relay}&ubus_rpc_session=String

Параметры запроса:

id_relay — ID выхода

ubus_rpc_session — служебный параметр

{"netping": {"command": "owrt-digital-outs/del_relay", "result": "ok"}, "payload": {"result": 0}}

result — результат выполнения команды:

  • -1 - ошибка в ходе выполнения команды

  • 0 - команда выполнена успешно

Запрос списка параметров выхода

GET /owrt-digital-outs/get_relay_params?id_relay={id_relay}&ubus_rpc_session=String

Параметры запроса:

id_relay — ID выхода

ubus_rpc_session — служебный параметр

{"netping": {"command": "owrt-digital-outs/get_relay_params", "result": "ok"}, "payload": {"status": {"name": "PWR1", "memo": "RelayGPIO1", "protocol": "gpio", "start_state": "NO", "state_alias_0": "OFF", "state_alias_1": "ON", "period": "1"}, "result": 0}}

status — JSON список параметров или сообщение об ошибке

result — результат выполнения команды:

  • -1 - ошибка в ходе выполнения команды

  • 0 - команда выполнена успешно

Обновление параметров существующего выхода

GET /owrt-digital-outs/update_relay?id_relay={id_relay}&name={name}&memo={memo}&protocol={protocol}&start_state={start_state}&state_alias_0={state_alias_0}&state_alias_1={state_alias_1}&protocol_params[param1]={param1}&protocol_params[param2]={param2}&ubus_rpc_session=String

Параметры запроса:

id_relay — ID выхода

name — имя выхода

memo — описание выхода

protocol — протокол подключения выхода (gpio или SNMP)

start_state — начальное состояние при включении (0, 1 или NO)

state_alias_0 — текст, отображаемый при значении “0”

state_alias_1 — текст, отображаемый при значении “1”

param1, param2... — параметры, специфичные для протокола:

  • для gpio:

    • period — интервал опроса состояния выхода в секундах

  • для snmp:

    • address — адрес SNMP-агента

    • oid_rd — OID для чтения

    • oid_wr — OID для записи

    • type_oid — тип OID (Integer)

    • community_rd — имя community для операций чтения

    • community_wr — имя community для операций записи

    • port — порт SNMP-агента

    • period — интервал опроса SNMP-агента

    • timeout — таймаут ответа от SNMP-агента

ubus_rpc_session — служебный параметр

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

http://visor:ping@192.168.25.219:8080/owrt-digital-outs/update_relay?id_relay=1000&name=SNMP1&memo=RelaySNMP1&protocol=snmp&start_state=NO&state_alias_0=OFF&state_alias_1=ON&protocol_params[address]=192.168.0.109&protocol_params[oid_rd]=.1.3.6.1.4.1.25728.5500.5.1.2.5&protocol_params[oid_wr]=.1.3.6.1.4.1.25728.5500.5.1.2.5&protocol_params[type_oid]=integer&protocol_params[community_rd]=public&protocol_params[community_wr]=private&protocol_params[port]=161&protocol_params[period]=2&protocol_params[timeout]=7&ubus_rpc_session=String

{"netping": {"command": "owrt-digital-outs/update_relay", "result": "ok"}, "payload": {"result": 0}}

result — результат выполнения команды:

  • -1 - ошибка в ходе выполнения команды

  • 0 - команда выполнена успешно

Запрос списка локальных выходов, не добавленных на данный момент

GET /owrt-digital-outs/list_avail_local_relays?ubus_rpc_session=String

Параметры запроса:

ubus_rpc_session — служебный параметр

{"netping": {"command": "owrt-digital-outs/list_avail_local_relays", "result": "ok"}, "payload": {"devices": {"PWR2": {"sensor_id": "6", "allow_dirs": "out"}}, "result": 0}}

devices — список не добавленных линий. Указывается системное имя линии и ее параметры:

sensor_id — ID линии

allow_dirs — разрешенные направления работы

result - результат выполнения команды:

  • -1 - ошибка в ходе выполнения команды

  • 0 - команда выполнена успешно

Запрос списка всех опрашиваемых выходов

GET /owrt-digital-outs/list_active_relays?ubus_rpc_session=String

Параметры запроса:

id_relay — ID выхода

ubus_rpc_session — служебный параметр

{"netping": {"command": "owrt-digital-outs/list_active_relays", "result": "ok"}, "payload": {"3": {"name": "IO3", "proto": "gpio", "type": "local"}, "4": {"name": "IO4", "proto": "gpio", "type": "local"}, "5": {"name": "PWR1", "proto": "gpio", "type": "local"}, "1000": {"name": "SNMP1", "proto": "snmp", "type": "remote"}, "1001": {"name": "SNMP2", "proto": "snmp", "type": "remote"}}}

Список опрашиваемых выходов. Указывается ID выхода и его параметры:

  • name — имя выхода

  • proto — протокол подключения выхода (gpio или SNMP)

  • type — тип выхода (local или remote)

Запрос результата операции с указанным id

GET /owrt-digital-outs/get_result_operation?uniq_id={uniq_id}&ubus_rpc_session=String

Параметры запроса:

uniq_id — уникальный id код, назначенный операции

ubus_rpc_session — служебный параметр

{"netping": {"command": "owrt-digital-outs/get_result_operation", "result": "ok"}, "payload": {"status_oper": "Value 1 set to relay PWR1 successfully", "result_oper": "0", "result": 0}}

status_oper — статус операции

result_oper — результат операции. . Возможные значения:

  • -2 - операция еще не завершена

  • -1 - ошибка при выполнении операции

  • 0 - операция выполнена успешно

result — результат выполнения команды:

  • -1 - ошибка в ходе выполнения команды

  • 0 - команда выполнена успешно

Запрос установленного значения длительности импульса

GET /owrt-digital-outs/get_pulse_duration?id_relay={id_relay}&ubus_rpc_session=String

Параметры запроса:

id_relay — ID выхода

ubus_rpc_session — служебный параметр

{"netping": {"command": "owrt-digital-outs/get_pulse_duration", "result": "ok"}, "payload": {"nploSinglePulseDuration": 15000, "result": 0}}

nploSinglePulseDuration — значение длительности импульса в миллисекундах

result — результат выполнения команды:

  • -1 - ошибка в ходе выполнения команды

  • 0 - команда выполнена успешно

Установка длительности импульса

GET /owrt-digital-outs/set_pulse_duration?id_relay={id_relay}&duration={duration}&ubus_rpc_session=String

Параметры запроса:

id_relay — ID выхода

duration — значение длительности импульса в миллисекундах (допустимые значения от 100 мс до 25500 мс, с шагом 100 мс)

ubus_rpc_session — служебный параметр

{"netping": {"command": "owrt-digital-outs/set_pulse_duration", "result": "ok"}, "payload": {"result": 0}}

result — результат выполнения команды:

  • -1 - ошибка в ходе выполнения команды

  • 0 - команда выполнена успешно

Цифровые датчики 1-Wire и SNMP

Запрос списка идентификаторов подключенных 1-Wire датчиков

GET /owrt-1wire-dev/get_1wire_list?ubus_rpc_session=String

Параметры запроса:

ubus_rpc_session — служебный параметр

{"netping": {"command": "owrt-1wire-dev/get_1wire_list", "result": "ok"}, "payload": {"1wire_dev": ["28.E2E7C00E0000", "26.CA8B96000000"]}}

1wire_dev — список 1-Wire устройств

Запрос списка подключенных 1-Wire датчиков указанного семейства

GET /owrt-1wire-dev/get_1wire_list_family?id_family={id_family}&ubus_rpc_session=String

Параметры запроса:

id_family — ID семейство датчика 1-wire (26 для датчика влажности, 28 для датчика температуры)

ubus_rpc_session — служебный параметр

{"netping": {"command": "owrt-1wire-dev/get_1wire_list_family", "result": "ok"}, "payload": {"family_1wire": ["26.CA8B96000000"]}}

family_1wire — список 1-Wire устройств указанного семейства

Запрос списка ресурсов для чтения/записи для конкретного 1-Wire датчика

GET /owrt-1wire-dev/get_1wire_resources?id_1wire={id_1wire}&ubus_rpc_session=String

Параметры запроса:

id_1wire — идентификатор 1-wire датчика

ubus_rpc_session — служебный параметр

{"netping": {"command": "owrt-1wire-dev/get_1wire_resources", "result": "ok"}, "payload": {"rd": ["temperature", "humidity"], "wr": ["offset"]}}

rd — список директорий для запроса значений от 1-Wire датчика

wr — список директорий для записи значения в 1-Wire датчик

Запрос значения, полученного от 1-Wire датчика.

GET /owrt-1wire-dev/get_value_1wire?id_1wire={id_1wire}&name_val={name_val}&ubus_rpc_session=String

Параметры запроса:

id_1wire — идентификатор 1-wire датчика

name_val — имя директории для получения данных (temperature или humidity)

ubus_rpc_session — служебный параметр

{"netping": {"command": "owrt-1wire-dev/get_value_1wire", "result": "ok"}, "payload": {"value": "22.7588", "status": "0"}}

value — значение с 1-Wire датчика

status — статус выполнения команды:

  • -1 - ошибка в ходе выполнения команды

  • 0 - команда выполнена успешно

Передача значения в 1-Wire датчик

GET /owrt-1wire-dev/set_value_1wire?id_1wire={id_1wire}&resource={resource}&value={value}&ubus_rpc_session=String

Параметры запроса:

id_1wire — идентификатор 1-wire датчика

resource — имя директории, доступной для записи значения в датчик

value — значение для записи

ubus_rpc_session — служебный параметр

{"netping": {"command": "owrt-1wire-dev/set_value_1wire", "result": "ok"}, "payload": {"result": "0"}}

result — статус выполнения команды:

  • -1 - ошибка в ходе выполнения команды

  • 0 - команда выполнена успешно

Запрос состояния датчика (по ID)

GET /owrt-sensor-value/get_all_values_by_id?id_sensor={id_sensor}&ubus_rpc_session=String

Параметры запроса:

id_sensor — ID датчика

ubus_rpc_session — служебный параметр

{"netping": {"command": "owrt-sensor-value/get_all_values_by_id", "result": "ok"}, "payload": {"id_sensor": "1", "values": {"humidity": {"value": "59", "unit": "%", "status": "0"}, "temperature": {"value": "21.8", "unit": "C", "status": "0"}}}}

humidity — данные о температуре с датчика:

  • value — значение температуры

  • unit — единица измерения

temperature — данные о температуре с датчика:

  • value — значение температуры

  • unit — единица измерения

status — статус датчика. Возможные значения:

  • -2 - запрошенный датчик в настоящее время не опрашивается

  • -1 - от датчика не было получено ни одного статуса

  • 0 - последний цикл опроса был выполнен без ошибки

  • 1 - на последнем цикле опроса была получена ошибка таймаута

  • 2 - на последнем цикле опроса была получена ошибка и это не ошибка таймаута

Запрос состояния датчика (по каналу OID SNMP)

GET /owrt-sensor-value/get_values_by_oid?oid={oid}&type_sensor={type_sensor}&ubus_rpc_session=String

Параметры запроса:

oid — SNMP идентификатор датчика (канал)

type_sensor — тип датчика (temperature или humidity)

ubus_rpc_session — служебный параметр

{"netping": {"command": "owrt-sensor-value/get_values_by_oid", "result": "ok"}, "payload": {"params": {"index_local": "2", "memo": "Datchik temperatury THS", "val_temp": "23.4", "val_hum": "", "status_temp": "0", "status_hum": ""}, "status": "0"}}

params — значения датчика:

  • index_local — локальный индекс датчика

  • memo — описание датчика

  • val_temp — значение температуры

  • val_hum — значение влажности

  • status_temp — статус датчика температуры

  • status_hum — статус датчика влажности

status — статус выполнения команды:

  • -1 - ошибка в ходе выполнения команды

  • 0 - команда выполнена успешно

Запрос списка опрашиваемых 1-Wire датчиков.

GET /owrt-sensor-value/get_list_1wire_polling?ubus_rpc_session=String

Параметры запроса:

ubus_rpc_session — служебный параметр

{"netping": {"command": "owrt-sensor-value/get_list_1wire_polling", "result": "ok"}, "payload": {"list_1wire": ["1", "2"]}}

list_1wire — список ID опрашиваемых 1-Wire датчиков

Запрос списка всех добавленных 1-Wire датчиков

GET /owrt-sensor-value/get_list_1wire_all?ubus_rpc_session=String

Параметры запроса:

ubus_rpc_session — служебный параметр

{"netping": {"command": "owrt-sensor-value/get_list_1wire_all", "result": "ok"}, "payload": {"list_1wire_all": ["1", "2"]}}

list_1wire_all — список ID всех 1-Wire датчиков, описание которых имеется в config файле

Запрос списка опрашиваемых SNMP датчиков.

GET /owrt-sensor-value/get_list_snmp_polling?ubus_rpc_session=String

Параметры запроса:

ubus_rpc_session — служебный параметр

{"netping": {"command": "owrt-sensor-value/get_list_snmp_polling", "result": "ok"}, "payload": {"list_snmp": ["1001", "1000"]}}

list_snmp — список ID опрашиваемых SNMP датчиков

Запрос списка всех добавленных SNMP датчиков.

GET /owrt-sensor-value/get_list_snmp_all?ubus_rpc_session=String

Параметры запроса:

ubus_rpc_session — служебный параметр

{"netping": {"command": "owrt-sensor-value/get_list_snmp_all", "result": "ok"}, "payload": {"list_snmp_all": ["1000", "1001"]}}

list_snmp_all — список ID всех SNMP датчиков, описание которых имеется в config файле

Запрос списка всех активных датчиков

GET /owrt-sensor-value/get_list_active_sensors?ubus_rpc_session=String

Параметры запроса:

ubus_rpc_session — служебный параметр

{"netping": {"command": "owrt-sensor-value/get_list_active_sensors", "result": "ok"}, "payload": {"1000": {"memo": "Datchik SNMP 1", "proto": "SNMP", "type": "remote"}, "2": {"memo": "Datchik temperatury THS", "proto": "1wire", "type": "local", "num_ch_oid": "1", "id_1wire": "28.E2E7C00E0000"}, "1": {"memo": "Datchik vlazhnosti HS", "proto": "1wire", "type": "local", "num_ch_oid": "1", "id_1wire": "26.CA8B96000000"}, "1001": {"memo": "Datchik SNMP 2", "proto": "SNMP", "type": "remote"}}}

payload — список активных датчиков. Указывается ID датчика и его параметры:

  • memo — значение памятки

  • proto — протокол (1wire или SNMP)

  • type — тип датчика (local или remote)

  • num_ch_oid — канал OID для SNMP (только для локальных датчиков)

  • id_1wire — идентификатор 1wire датчика (только для локальных датчиков)

Запрос списка доступных шаблонов датчиков

GET /owrt-sensor-value/get_list_template_sensors?ubus_rpc_session=String

Параметры запроса:

ubus_rpc_session — служебный параметр

{"netping": {"command": "owrt-sensor-value/get_list_template_sensors", "result": "ok"}, "payload": {"list_template_sensors": ["SNMP sensor Netping THS", "1-wire sensor Netping THS", "SNMP sensor Netping HS", "1-wire sensor Netping HS"]}}

list_template_sensors — список доступных шаблонов

Запрос параметров датчика

GET /owrt-sensor-value/get_config_sensor?id_sensor={id_sensor}&ubus_rpc_session=String

Параметры запроса:

id_sensor— ID датчика

ubus_rpc_session — служебный параметр

{"netping": {"command": "owrt-sensor-value/get_config_sensor", "result": "ok"}, "payload": {"params": {"memo": "Datchik vlazhnosti HS", "proto": "1wire", "id_family": "26", "type_sensor": "humidity", "resource_sensor_1": "1a97e98f", "resource_sensor_2": "2934d4d8", "id_1wire": "26.CA8B96000000", "num_ch_oid": "1"}, "status": "0"}}

params — параметры датчика в зависимости от протокола

status — статус выполнения команды:

  • -1 - ошибка в ходе выполнения команды

  • 0 - команда выполнена успешно

Запрос параметров ресурса датчика

GET /owrt-sensor-value/get_config_resource?id_resource={id_resource}&ubus_rpc_session=String

Параметры запроса:

id_resource — ID ресурса (соответствует параметру resource_sensor_1 или resource_sensor_2 в параметрах датчика)

ubus_rpc_session — служебный параметр

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

http://visor:ping@192.168.0.7:8080/owrt-sensor-value/get_config_resource?id_resource=1a97e98f&ubus_rpc_session=String

{"netping": {"command": "owrt-sensor-value/get_config_resource", "result": "ok"}, "payload": {"params": {"unit": "%", "precision": "0", "type_resource": "humidity", "max_hysteresis": "1", "min_hysteresis": "1", "period": "1.0", "resource": "humidity"}, "status": "0"}}

params — параметры ресурса в зависимости от протокола

status — статус выполнения команды:

  • -1 - ошибка в ходе выполнения команды

  • 0 - команда выполнена успешно

Запрос списка свободных OID каналов по семейству 1-Wire датчиков

GET /owrt-sensor-value/get_free_channel_oid?id_family={id_family}&ubus_rpc_session=String

Параметры запроса:

id_family — ID семейство 1-Wire датчика (соответствует параметру id_family в параметрах датчика, 26 для датчика влажности, 28 для датчика температуры)

ubus_rpc_session — служебный параметр

{"netping": {"command": "owrt-sensor-value/get_free_channel_oid", "result": "ok"}, "payload": {"free_channel_oid": [2]}}

free_channel_oid — список доступных OID каналов для обращения по SNMP к локальным 1-Wire датчикам запрашиваемого ID семейства

Добавление 1-Wire датчика (без ресурсов).

GET /owrt-sensor-value/add_new_1wire_sensor?ubus_rpc_session=String

Параметры запроса:

id_sensor — ID датчика

{"netping": {"command": "owrt-sensor-value/add_new_1wire_sensor", "result": "ok"}, "payload": {"id_sensor": "3", "status": "0"}}

id_sensor — ID добавленного 1-Wire датчика

status — статус выполнения команды:

  • -1 - ошибка в ходе выполнения команды

  • 0 - команда выполнена успешно

Добавление SNMP датчика (без ресурсов)

GET /owrt-sensor-value/add_new_snmp_sensor?ubus_rpc_session=String

Параметры запроса:

ubus_rpc_session — служебный параметр

{"netping": {"command": "owrt-sensor-value/add_new_snmp_sensor", "result": "ok"}, "payload": {"id_sensor": "1002", "status": "0"}}

id_sensor — ID добавленного датчика SNMP

status — статус выполнения команды:

  • -1 - ошибка в ходе выполнения команды

  • 0 - команда выполнена успешно

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

GET /owrt-sensor-value/add_new_resource?id_sensor={id_sensor}&ubus_rpc_session=String

Параметры запроса:

id_sensor — ID датчика, для которого добавляется ресурс

ubus_rpc_session — служебный параметр

{"netping": {"command": "owrt-sensor-value/add_new_resource", "result": "ok"}, "payload": {"id_sensor": "3", "id_resource": "17b1945b", "status": "0"}}

id_sensor — ID датчика, для которого добавляется ресурс

id_resource — ID добавленного ресурса

status — статус выполнения команды:

  • -1 - ошибка в ходе выполнения команды

  • 0 - команда выполнена успешно

Добавление датчика в соответствии с шаблоном

GET /owrt-sensor-value/add_template?name_template={name_template}&ubus_rpc_session=String

Параметры запроса:

name_template — имя шаблона для добавления датчика (1-wire sensor Netping HS, 1-wire sensor Netping THS, SNMP sensor Netping HS, SNMP sensor Netping THS

ubus_rpc_session — служебный параметр

{"netping": {"command": "owrt-sensor-value/add_template", "result": "ok"}, "payload": {"id_sensor": "3", "status": "0"}}

id_sensor — ID добавленного датчика

status — статус выполнения команды:

  • -1 - ошибка в ходе выполнения команды

  • 0 - команда выполнена успешно

Обновление параметров датчика

GET /owrt-sensor-value/update_sensor?id_sensor={id_sensor}&protocol={protocol}&protocol_params[param1]={param1}&protocol_params[param2]={param2}&ubus_rpc_session=String

Параметры запроса:

id_sensor — ID датчика, который будет обновлен

ubus_rpc_session — служебный параметр

protocol — протокол по которому работает датчик (1wire или SNMP)

param1, param2... — параметры, специфичные для протокола:

  • для 1wire:

    • memo — памятка датчика

    • type_sensor — тип датчика (temperature или humidity)

    • id_1wire — идентификатор 1-wire датчика

    • num_ch_oid — SNMP идентификатор датчика (канал)

  • для snmp:

    • memo — памятка датчика

    • address — адрес SNMP-агента

    • port — порт SNMP-агента

    • community — имя community

    • timeout — таймаут ответа от SNMP-агента

ubus_rpc_session — служебный параметр

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

http://visor:ping@192.168.0.7:8080/owrt-sensor-value/update_sensor?id_sensor=1&protocol=1wire&protocol_params[memo]=Datchik1&protocol_params[num_ch_oid]=2&ubus_rpc_session=String

{"netping": {"command": "owrt-sensor-value/update_sensor", "result": "ok"}, "payload": {"id_sensor": "1", "status": "0"}}

id_sensor — ID датчика, который будет обновлен

status — статус выполнения команды:

  • -1 - ошибка в ходе выполнения команды

  • 0 - команда выполнена успешно

Обновление параметров ресурса датчика.

GET /owrt-sensor-value/update_resource?id_resource={id_resource}&protocol_params[param1]={param1}&protocol_params[param2]={param2}&ubus_rpc_session=String

Параметры запроса:

id_resource — ID ресурса (соответствует параметру resource_sensor_1 или resource_sensor_2 в параметрах датчика)

param1, param2... — параметры, специфичные для протокола:

  • для 1wire:

    • unit — единица измерения

    • precision — точность

    • max_hysteresis — верхняя граница гистерезиса

    • min_hysteresis — нижняя граница гистерезиса

    • period — интервал опроса датчика

    • type_resource — тип ресурса (temperature или humidity)

    • resource — имя ресурса (директории), предоставляемого 1-Wire датчиком для получения значения (temperature или humidity)

  • для snmp:

    • unit — единица измерения

    • precision — точность

    • max_hysteresis — верхняя граница гистерезиса

    • min_hysteresis — нижняя граница гистерезиса

    • period — интервал опроса датчика

    • type_resource — тип ресурса (temperature или humidity)

    • oid — oid для чтения данных

ubus_rpc_session — служебный параметр

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

http://visor:ping@192.168.0.7:8080/owrt-sensor-value/update_resource?id_resource=bf32bb07&protocol_params[unit]=C&protocol_params[type_resource]=temperature&protocol_params[oid]=.1.3.6.1.4.1.25728.8800.1.1.2.1&ubus_rpc_session=String

{"netping": {"command": "owrt-sensor-value/update_resource", "result": "ok"}, "payload": {"id_resource": "bf32bb07", "status": "0"}}

id_resource — ID ресурса, который будет обновлен

status — статус выполнения команды:

  • -1 - ошибка в ходе выполнения команды

  • 0 - команда выполнена успешно

Удаление датчика со всеми его ресурсами.

GET /owrt-sensor-value/delete_sensor?id_sensor={id_sensor}&ubus_rpc_session=String

Параметры запроса:

id_sensor — ID датчика

ubus_rpc_session — служебный параметр

{"netping": {"command": "owrt-sensor-value/delete_sensor", "result": "ok"}, "payload": {"id_sensor": "1002", "status": "0"}}

id_sensor — ID датчика, который будет удален

status — статус выполнения команды:

  • -1 - ошибка в ходе выполнения команды

  • 0 - команда выполнена успешно

Удаление ресурса датчика

GET /owrt-sensor-value/delete_resource?id_resource={id_resource}&ubus_rpc_session=String

Параметры запроса:

id_resource — ID ресурса (соответствует параметру resource_sensor_1 или resource_sensor_2 в параметрах датчика)

ubus_rpc_session — служебный параметр

{"netping": {"command": "owrt-sensor-value/delete_resource", "result": "ok"}, "payload": {"id_resource": "bf32bb07", "status": "0"}}

id_resource — ID ресурса, который будет удален

status — статус выполнения команды:

  • -1 - ошибка в ходе выполнения команды

  • 0 - команда выполнена успешно

Отчеты

Запрос списка настроенных отчётов

GET /owrt_reports/get_reports?ubus_rpc_session=String

Параметры запроса:

ubus_rpc_session — служебный параметр

{"netping": {"command": "owrt_reports/get_reports", "result": "ok"}, "payload": {"retcode": 0, "reports": "[ {'name': 'Default report1', 'id': 1}, {'name': 'Default report2', 'id': 2}, {'name': 'Default report3', 'id': 3}]"}}

retcode — статус выполнения команды:

  • -1 - ошибка в ходе выполнения команды

  • 0 - команда выполнена успешно

reports — список отчетов:

  • name - имя отчёта

  • id - id отчёта

SMS

Включение режима передачи данных (интернет).

GET /owrt_sms_proto/connect?ubus_rpc_session=String

Параметры запроса:

ubus_rpc_session — служебный параметр

{"netping": {"command": "owrt_sms_proto/connect", "result": "ok"}, "payload": {"method": "connect", "modem": "MMModem('SARA-U270-03S-00')", "result": "ok", "descr": "successfully connected the modem"}}

method — выполненная команда

modem — название модема

result — результат выполнения команды (ok или error)

descr — текстовое описание результата

Выключение режима передачи данных (интернет).

GET /owrt_sms_proto/disconnect?ubus_rpc_session=String

Параметры запроса:

ubus_rpc_session — служебный параметр

{"netping": {"command": "owrt_sms_proto/disconnect", "result": "ok"}, "payload": {"method": "disconnect", "modem": "MMModem('SARA-U270-03S-00')", "result": "ok", "descr": ""}}

method — выполненная команда

modem — название модема

result — результат выполнения команды (ok или error)

descr — текстовое описание результата

Отправка СМС

GET /owrt_sms_proto/sendSMS?phoneno={phoneno}&text={text}&ubus_rpc_session=String

Параметры запроса:

phoneno —- телефон абонента в международном формате. Знак “+” необходимо указать в URL-кодировке: %2B.

text — текст СМС

ubus_rpc_session — служебный параметр

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

http://visor:ping@192.168.0.7:8080/owrt_sms_proto/sendSMS?phoneno=%2B79123456789&text=Test_SMS&ubus_rpc_session=String

{"netping": {"command": "owrt_sms_proto/sendSMS", "result": "ok"}, "payload": {"method": "sendsms", "phoneno": "+79123456789", "text": "Test_SMS", "modem": "MMModem('SARA-U270-03S-00')", "descr": "SMS successfully sent to '+79123456789' with text: 'Test_SMS'", "result": "ok"}}

method — выполненная команда

phoneno — телефон абонента

text — текст СМС

modem — название модема

result — результат выполнения команды (ok или error)

descr — текстовое описание результата

Запрос списка входящих СМС сообщений

GET /owrt_sms_proto/readIncomingSMS?ubus_rpc_session=String

Параметры запроса:

ubus_rpc_session — служебный параметр

{"netping": {"command": "owrt_sms_proto/readIncomingSMS", "result": "ok"}, "payload": {"method": "readIncomingSMS", "modem": "MMModem('SARA-U270-03S-00')", "result": "ok", "msgs": {"0": ["+79123456789", "Test1", "2025-09-04T09:39:26+03:00"], "0": ["+79123456789", "Test2", "2025-09-04T09:39:57+03:00"]}}}

method — выполненная команда

phoneno — телефон абонента

modem — название модема

result — результат выполнения команды (ok или error)

msgs — список входящих смс (индекс, телефон, сообщение, дата)

Запрос списка отправленных СМС сообщений.

GET /owrt_sms_proto/readOutgoingSMS?ubus_rpc_session=String

Параметры запроса:

ubus_rpc_session — служебный параметр

{"netping": {"command": "owrt_sms_proto/readOutgoingSMS", "result": "ok"}, "payload": {"method": "readIncomingSMS", "modem": "MMModem('SARA-U270-03S-00')", "result": "ok", "msgs": {"0": ["+79123456789", "Test SMS message 1"], "1": ["+79123456789", "Test SMS message 2"], "2": ["+79123456789", "Test SMS message 3"]}}}

method — выполненная команда

modem — название модема

result — результат выполнения команды (ok или error)

msgs — список исходящих смс (индекс, телефон, сообщение)

Выполнение USSD-команды

GET /owrt_sms_proto/sendUSSD?ussd_cmd={ussd_cmd}&ubus_rpc_session=String

Параметры запроса:

ussd_cmd — USSD-команда. Знаки “*”, “#” необходимо указать в URL-кодировке: %2A, %23.

ubus_rpc_session — служебный параметр

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

http://visor:ping@192.168.25.219:8080/owrt_sms_proto/sendUSSD?ussd_cmd=%2A100%23&ubus_rpc_session=String

{"netping": {"command": "owrt_sms_proto/sendUSSD", "result": "ok"}, "payload": {"method": "sendussd", "ussd": "*100#", "modem": "MMModem('SARA-U270-03S-00')", "reply": "104.58 \u0440.", "result": "ok"}}

method — выполненная команда

ussd — USSD-команда

modem — название модема

reply — ответ оператора на USSD-команду

result — результат выполнения команды (ok или error)

Запрос информации о качестве и мощности сигнала модема.

GET /owrt_sms_proto/getModemState?ubus_rpc_session=String

Параметры запроса:

ubus_rpc_session — служебный параметр

{"netping": {"command": "owrt_sms_proto/getModemState", "result": "ok"}, "payload": {"method": "getmodemstate", "modem": "MMModem('SARA-U270-03S-00')", "result": "ok", "quality": "40", "reg_state": "home", "operator": "MegaFon #1"}}

method — выполненная команда

modem — название модема

result — результат выполнения команды (ok или error)

quaility — качество сигнала модема

reg_state — статус регистрации

operator — мобильный оператор

Запрос IMEI модема.

GET /owrt_sms_proto/getIMEI?ubus_rpc_session=String

Параметры запроса:

ubus_rpc_session — служебный параметр

{"netping": {"command": "owrt_sms_proto/getIMEI", "result": "ok"}, "payload": {"method": "getimei", "modem": "MMModem('SARA-U270-03S-00')", "result": "ok", "imei": "353738082061308"}}

method — выполненная команда

modem — название модема

result — результат выполнения команды (ok или error)

IMEI — 15-значный IMEI-номер

Установка режима работы модема

GET /owrt_sms_proto/setMode?mode={mode}&ubus_rpc_session=String

Параметры запроса:

mode — режим модема (2g или 3g)

ubus_rpc_session — служебный параметр

{"netping": {"command": "owrt_sms_proto/setMode", "result": "ok"}, "payload": {"method": "setmode", "modem": "MMModem('SARA-U270-03S-00')", "result": "ok", "mode": "3g"}}

method — выполненная команда

modem — название модема

result — результат выполнения команды (ok или error)

mode — режим работы модема (2g или 3g)

Сброс модема

GET /owrt_sms_proto/reset?ubus_rpc_session=String

Параметры запроса:

ubus_rpc_session — служебный параметр

{"netping": {"command": "owrt_sms_proto/reset", "result": "ok"}, "payload": {"method": "reset", "modem": "MMModem('SARA-U270-03S-00')", "result": "ok", "descr": "successfully reseted the modem"}}

method — выполненная команда

modem — название модема

result — результат выполнения команды (ok или error)

descr — текстовое описание результата

Запрос состояния модема

GET /owrt_sms_proto/getStatus?ubus_rpc_session=String

Параметры запроса:

ubus_rpc_session — служебный параметр

{"netping": {"command": "owrt_sms_proto/getStatus", "result": "ok"}, "payload": {"method": "getstatus", "modem": "MMModem('SARA-U270-03S-00')", "result": "ok", "mode": "2g", "power": "on"}}

method — выполненная команда

modem — название модема

result — результат выполнения команды (ok или error)

mode — режим работы модема (2g или 3g)

power — наличие питания у модема (on или off)

Email

Отправка email-сообщения

GET /owrt_email/send_mail?fromaddr={fromaddr}&toaddr= {toaddr}&text={text}&subject={subject}&signature={signature}&ubus_rpc_session=String

Параметры запроса:

fromaddr — адрес отправителя

toaddr — адрес получателя

text — сообщение

subject — тема письма

signature — подпись

ubus_rpc_session — служебный параметр

{"netping": {"command": "owrt_email/send_mail", "result": "ok"}, "payload": {"status": "0"}}

status — код возврата. Возможные значения:

  • 0 - метод завершился успешно

  • 1 - ошибка шифрования сессии. Возможно, сервер не поддерживает шифрование или выбран неверный метод шифрования

  • 2 - ошибка аутентификации на smtp сервере. Указан неверный логин/пароль

  • 3 - ошибка подключения к серверу. Необходимо проверить адрес/порт smtp сервера

  • 4 - ошибка отправки письма. Сервер отклонил адреса получателей письма.

  • 5 - ошибка отправки письма. Сервер отклонил адрес отправителя письма.

  • -1 - неизвестная ошибка отправки письма

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.

Contact Support Close