5.2. [DKSO 708.1.5] Настройка периодических отчётов

Страница «Отчёты»

Модуль отчётов предназначен для настройки и отправки периодических отчётов о состоянии датчиков, сторожа, бинарных входов и выходов.

Для настройки отчётов необходимо перейти на страницу Система → Отчёты (Рис. 5.2.1.):

Рис. 5.2.1. Страница «Отчёты» web-интерфейса устройства NetPing

На странице отображается список существующих отчётов с их основными параметрами и элементами управления:

Состояние — чек-бокс для включения/отключения отправки отчётов. По умолчанию — выключено.
Наименование — название отчёта.
Метод — способ доставки отчёта. Поддерживается метод Email. Параметры SMTP-сервера задаются на странице Система → Настройки SMTP-сервера.
Описание — краткое описание отчёта.
Настройки — кнопка вызова окна настройки отчёта.
Удалить — кнопка удаления отчёта.

Создание отчёта

Для создания отчёта нажать кнопку Добавить (Рис. 5.2.1.). Созданный отчёт с параметрами по умолчанию отобразится в списке отчётов. Для редактирования параметров отчёта нажать кнопку Настройки (Рис. 5.2.2.):

Рис. 5.2.2. Окно настройки отчёта устройства NetPing

Наименование — название отчёта.
Описание — краткое описание отчёта.
Метод — способ доставки отчёта. Поддерживается метод отправки отчёта по Email.
Выслать отчёт — email-адрес или список email-адресов через запятую, на которые отправляется отчёт.
Обратный вызов — выражение в виде JSON-списка, содержащее параметры для опроса модулей.
Текст — текст отчёта. Поддерживаются переменные для подстановки данных.
Частота отправки отчёта — форма для настройки периодичности отправки отчёта. Позволяет настроить следующие периоды отправки:
- Минута — ежеминутно.
- Час — ежечасно в определённую минуту часа.
- День — ежедневно в определённый час и минуту.
- Неделя — еженедельно в определённый день, час и минуту .

После настройки отчёта нажать кнопку Сохранить.

Внимание! Поддерживается создание не более 20 отчётов.

Описание обратных вызовов

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

Обратный вызов имеет синтаксис вида:
[ { "module" : "owrt_module", "method" : "owrt_method", "input_parameters" : { "parameter" : "value" } } ]

В таблице приведены варианты параметров запроса:

Опрашиваемый ресурс

module

method

input_parameters

Пример вызова

Сторож

owrt_pingers

get_pinger_state

Метод возвращает состояние и статус пингера сторожа.

name
Название пингера.

Название можно узнать на странице Управление → Сторож, вкладка Пингеры.

Примеры: Pinger1, Pinger2

[ { "module" : "owrt_pingers", "method" : "get_pinger_state", "input_parameters" : { "name":"Pinger1" } } ]

get_rule_state

Метод возвращает состояние и статус правила сторожа.

name

Название правила.

Название можно узнать на странице Управление → Сторож, вкладка Правила.

Примеры: Rule1, Rule2

[ { "module" : "owrt_pingers", "method" : "get_rule_state", "input_parameters" : { "name":"Rule1" } } ]

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

owrt_digital_inputs

get_state

Метод возвращает состояние, статус и значение счетчика импульсов на входе (по имени).

name

Наименование входа.

Наименование можно узнать на странице Службы → Бинарные входы, вкладка Настройки.

Примеры: IO1, IO2.

[ { "module" : "owrt_digital_inputs", "method" : "get_state", "input_parameters" : { "name" : "IO1", "ubus_rpc_session" : "" } } ]

Примечание: ubus_rpc_session - служебный параметр, необходим для корректной работы запроса.

get_state_by_id

Метод возвращает состояние, статус и значение счетчика импульсов на входе (по ID).

sensor_id

ID входа.

ID можно узнать на странице Службы → Бинарные входы, вкладка Настройки.

Примеры: 1, 2, 1000.

[ { "module" : "owrt_digital_inputs", "method" : "get_state", "input_parameters" : { "sensor_id" : "1", "ubus_rpc_session" : "" } } ]

Примечание: ubus_rpc_session - служебный параметр, необходим для корректной работы запроса.

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

owrt-digital-outs

get_state

Метод возвращает состояние и статус выхода (по ID).

id_relay

ID выхода.

ID можно узнать на странице Службы → Бинарные выходы, вкладка Настройки.

Примеры: 1, 5, 1000.

[ { "module" : "owrt-digital-outs", "method" : "get_state", "input_parameters" : { "id_relay":"5", "ubus_rpc_session" : "" } } ]

Примечание: ubus_rpc_session - служебный параметр, необходим для корректной работы запроса.

Датчики температуры и влажности

owrt-sensor-value

get_all_values_by_id

Метод возвращает значение и статус опрашиваемого датчика.

id_sensor

ID датчика.

ID можно узнать на странице Службы → Цифровые датчики, вкладка Настройки.

Примеры: 1, 2, 1000.

[ { "module" : "owrt-sensor-value", "method" : "get_all_values_by_id", "input_parameters" : { "id_sensor" : "1","ubus_rpc_session":"" } } ]

Примечание: ubus_rpc_session - служебный параметр, необходим для корректной работы запроса.

Переменные для текста отчётов

Текст отчёта позволяет динамически подставлять данные из ответов на обратный вызов. Например: текущее значение с датчика, состояние бинарного входа и т.д.

Для этого в тексте отчёта используются специальные переменные, которые автоматически заменяются на актуальные значения при отправке.

Доступные переменные:

Опрашиваемый ресурс	Метод обратного вызова	Переменная	Что подставляется
Сторож. (модуль `owrt_pingers`)	`get_pinger_state`	`%_owrt_pingers\|get_pinger_state\|state_%`	Состояние пингера. Возможные значения: `0` - pinger выключен `1` - pinger включен
	`get_pinger_state`	`%_owrt_pingers\|get_pinger_state\|status_%`	Cтатус пингера. Возможные значения: `2` - при опросе пингера произошла ошибка `1` - пингер не включен или еще не было произведено ни одного завершенного опроса с момента его запуска `0` - пингер закончил опрос, однако опрашиваемый объект недоступен `1` - пингер закончил опрос, опрашиваемый объект доступен
	`get_rule_state`	`%_owrt_pingers\|get_rule_state\|state_%`	Состояние правила. Возможные значения: `0` - правило выключено `1` - правило включено
	`get_rule_state`	`%_owrt_pingers\|get_rule_state\|status_%`	Статус правила. Возможные значения: `-2` - при вычислении логического выражения произошла ошибка `-1` - правило не включено или еще не было произведено ни одного завершенного вычисления логического выражения правила с момента его запуска `0` - правило вычислено, логическое выражение ложно `1` - правило вычислено, логическое выражение истинно
Бинарные входы (модуль `owrt_digital_inputs`)	`get_state`	`%_owrt_digital_inputs\|get_state\|state_%`	Состояние входа. Возможные значения: `-1` - от входа не было получено ни одного состояния `0` - состояние входа - 0 `1` - состояние входа - 1
		`%_owrt_digital_inputs\|get_state\|status_%`	Статус входа. Возможные значения: `-2` - запрошенный вход в настоящее время не опрашивается `-1` - от входа не было получено ни одного статуса `0` - последний цикл опроса был выполнен без ошибки `1` - на последнем цикле опроса была получена ошибка таймаута `2` - на последнем цикле опроса была получена ошибка и это не ошибка таймаута
		`%_owrt_digital_inputs\|get_state\|count_%`	Количество изменений фронта по заданному методу подсчёта (0/1, 1/0 или 0/1/0).
	`get_state_by_id`	`%_owrt_digital_inputs\|get_state_by_id\|state_%`	Состояние входа. Возможные значения: `-1` - от входа не было получено ни одного состояния `0` - состояние входа - 0 `1` - состояние входа - 1
		`%_owrt_digital_inputs\|get_state_by_id\|status_%`	Статус входа. Возможные значения: `-2` - запрошенный вход в настоящее время не опрашивается `-1` - от входа не было получено ни одного статуса `0` - последний цикл опроса был выполнен без ошибки `1` - на последнем цикле опроса была получена ошибка таймаута `2` - на последнем цикле опроса была получена ошибка и это не ошибка таймаута
		`%_owrt_digital_inputs\|get_state_by_id\|count_%`	Количество изменений фронта по заданному методу подсчёта (0/1, 1/0 или 0/1/0).
Бинарные выходы (модуль `owrt-digital-outs`)	`get_state`	`%_owrt-digital-outs\|get_state\|state_%`	Состояние выхода. Возможные значения: `-1` - от выхода не было получено ни одного состояния `0` - состояние выхода - 0 `1` - состояние выхода - 1
Бинарные выходы (модуль `owrt-digital-outs`)	`get_state`	`%_owrt-digital-outs\|get_state\|status_%`	Статус выхода. Возможные значения: `-2` - запрошенный выход в настоящее время не опрашивается `-1` - от выхода не было получено ни одного статуса `0` - последний цикл опроса был выполнен без ошибки `1` - на последнем цикле опроса была получена ошибка таймаута `2` - на последнем цикле опроса была получена ошибка и это не ошибка таймаута
Датчик 1-wire (модуль `owrt-sensor-value`)	`get_all_values_by_id`	`%_owrt-sensor-value\|get_all_values_by_id\|values[temperature[value]]_%`	Значение температуры с датчика 1-wire
		`%_owrt-sensor-value\|get_all_values_by_id\|values[humidity[value]]_%`	Значение влажности с датчика 1-wire
		`%_owrt-sensor-value\|get_all_values_by_id\|values[temperature[status]]_%`	Cтатус датчика температуры 1-wire. Возможные значения: `-2` - запрошенный датчик в настоящее время не опрашивается `-1` - от датчика не было получено ни одного статуса `0` - последний цикл опроса был выполнен без ошибки `1` - на последнем цикле опроса была получена ошибка таймаута `2` - на последнем цикле опроса была получена ошибка и это не ошибка таймаута
		`%_owrt-sensor-value\|get_all_values_by_id\|values[humidity[status]]_%`	Cтатус датчика влажности 1-wire. Возможные значения: `-2` - запрошенный датчик в настоящее время не опрашивается `-1` - от датчика не было получено ни одного статуса `0` - последний цикл опроса был выполнен без ошибки `1` - на последнем цикле опроса была получена ошибка таймаута `2` - на последнем цикле опроса была получена ошибка и это не ошибка таймаута

Примеры настройки отчётов

Настройка отчёта о состоянии бинарного входа с именем IO1 (Рис. 5.2.3.). Отчет отправляется на указанный адрес email ежеминутно.

Рис. 5.2.3. Пример настройки отчёта о состоянии входа

Текст отчета имеет вид:

CODE

  Состояние входа IO1: 1

Настройка отчёта о состоянии встроенного реле с ID 5 (Рис. 5.2.4.). Отчет отправляется на указанный адрес email ежечасно на каждой 30-й минуте.

Рис. 5.2.4. Пример настройки отчёта о состоянии реле

Текст отчета имеет вид:

CODE

  Состояние выхода PWR1: 1

Настройка отчёта о состоянии 1-wire датчика температуры с ID 1 (Рис. 5.2.5.). Отчет отправляется на указанный адрес email ежедневно в 09:00.

Рис. 5.2.5. Пример настройки отчёта о датчике THS

Текст отчета имеет вид:

CODE

Данные с датчика 1: 23 °C

Настройка отчёта о состоянии пингера сторожа Pinger1 (Рис. 5.2.6.). Отчет отправляется на указанный адрес email еженедельно по средам в 12:30.

Рис. 5.2.6. Пример настройки отчёта о пингере

Текст отчета имеет вид:

CODE

Состояние пингера Pinger1: 1