Skip to content

Latest commit

 

History

History
314 lines (240 loc) · 12.5 KB

timers.md

File metadata and controls

314 lines (240 loc) · 12.5 KB
Raw

Таймеры

Введение

Шлюз может запускать скрипты с определенной периодичностью. Можно установить таймер запуска к любому скрипту, а так же отменить его.

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

Тип таймера передается в скрипт событием Event.Type

Типы таймеров

Однократный

Выполняется однократно в UNIX время. Дискретность 1 секунда. Event.Type = 4.

В моделях шлюза без микросхемы RTC, не следует инициализировать данный тип таймера в init.lua, поскольку UNIX время на момент инициализации таймера может быть не синхронизировано с NTP. Особенно при холодном старте.

Инициализация:

scripts.setTimer(script, os.time() + t[, Param])
-- script - STR, имя файла скрипта, без расширения `lua`
-- os.time() - функция LUA, возвращает UNIX время на текущий момент в сек.
-- t - INT, уставка времени в сек.
-- Param - STR, аргументы, передаваемые в скрипт

Периодический

Выполняется с заданной периодичностью. Дискретность 1 секунда. Event.Type = 5

Инициализация:

scripts.setTimer(script, t[, Param])
-- script - STR, имя файла скрипта, без расширения `lua`
-- t - INT, уставка времени в сек.
-- Param - STR, аргументы, передаваемые в скрипт

CRON

Таймер такой же и с таким же синтаксисом как UNIX cron. Единственное отличие: расписание может быть только одно для одного скрипта. Добавлен в версии прошивки 2022.04.24d11. Event.Type = 6. Протестировать и собрать нужный crontab можно здесь

Начиная с прошивки 2024.01.22d4 CRON управляется отдельно и может быть несколько расписаний на один скрипт, также сохраняются привязанные к скрипту периодический или однократный таймеры

Устанавливается командой scripts.addCron(); удаляется командой scripts.removeCron(). Описание команд см. далее.

Инициализация:

-- draft 
scripts.addCron(script, crontab[, Param])
-- script - STR, имя файла скрипта, без расширения `lua`
-- crontab - STR, уставка времени в формате UNIX CRON
-- Param - STR, аргументы, передаваемые в скрипт

-- deprecated 
scripts.setTimer(script, crontab[, Param])
-- script - STR, имя файла скрипта, без расширения `lua`
-- crontab - STR, уставка времени в формате UNIX CRON
-- Param - STR, аргументы, передаваемые в скрипт

Отмена таймеров

Для отмены любого типа таймера достаточно задать уставку времени равную 0. При этом, начиная с прошивки 2024.01.22d4, расписания CRON сохраняются. Удаляются они командой scripts.removeCron() :

scripts.setTimer(script, 0)
-- script - STR, имя файла скрипта, без расширения `lua`

-- удаление CRON
scripts.removeCron(script[, cron])
-- script - STR, имя файла скрипта, без расширения `lua`
-- cron - STR, расписание CRON, которое необходимо удалить, например "50 5 * * 1-5". Если не указывать - удалит все расписания CRON

API для работы с таймерами

HTTP API

Получить список скриптов с таймерами: /api/scripts

Возвращает JSON объект вида:

{
  "success": true,
  "result": [
    {
      "name": "tickOneMinute",
      "ts": 1676519822,
      "interval": 60,
      "timeout": 1676519822
    },
    {
      "name": "alarmClock",
      "ts": 0,
      "interval": 3600,
      "timeout": 1705991567,
      "cron": [
          "50 5 * * 1-5",
          "0 6 * * 1-5",
          "2 6 * * 1-5"
      ]
    },
    {
      "name": "tables",
      "ts": 1676519836,
      "timeout": 1676519896
    }
  ]
}

Здесь:

  • success - результат выполнения API команды
  • result - перечень скриптов с назначенными таймерами
    • name - имя скрипта
    • interval - интервал периодического таймера
    • cron - расписания CRON
    • ts - последнее время запуска скрипта
    • timeout - время последней сработки интервального таймера или время когда должен сработать фиксированный таймер

LUA

scripts.getTimer()

Возвращает оставшееся время таймера для скрипта в секундах.

remain_seconds = scripts.getTimer(script)
-- script - STR, имя проверяемого скрипта
-- remain_seconds - INT, оставшееся время в сек. или 0 для Cron и если таймера нет

Примеры

Запуск скрипта getMoney.lua каждые 60 секунд

scripts.setTimer("getMoney", 60, "$")

Запуск скрипта giveMoney.lua через 5 минут, однократно

scripts.setTimer("giveMoney", os.time() + 300)

Узнать когда запустится скрипт giveMoney.lua

print(scripts.getTimer("giveMoney"))

Запуск скрипта earnMoney.lua каждый будний день в 01:05 и в 11:15

scripts.addCron("earnMoney", "5 1 * * 1-5")
scripts.addCron("earnMoney", "15 11 * * 1-5")

Сброс таймера для скрипта OneMinTimer.lua

scripts.setTimer("OneMinTimer", 0)

Сброс таймера CRON на 01:05 для скрипта earnMoney.lua

scripts.removeCron("earnMoney", "5 1 * * 1-5")

Сброс всех расписаний CRON для скрипта earnMoney.lua

scripts.removeCron("earnMoney")

Определить тип таймера

Допустим, скрипт action.lua может запускаться по таймерам разного типа. Определение типа:

-- action.lua
if (Event.Type == 4) then
  print("Однократный таймер")
elseif (Event.Type == 5) then
  print("Периодический таймер")
elseif (Event.Type == 6) then
  print("Таймер CRON")
end

Отправка данных каждую минуту на narodmon.ru

function SendNarodmon(name, value)
  local MAC = "BC:DD:C2:D7:68:BC"
  http.request("http://narodmon.ru/get?ID=" .. MAC .. "&" .. name .. "=" .. tostring(value))
end

local value = zigbee.value("0x04CF8CDF3C771F6C", "illuminance")
SendNarodmon("illuminance", value)

Включение, выключение света в аквариуме

Инициализация:

-- init.lua
-- Аквариум
scripts.addCron("aquarium", "0 6 * * 1-5") -- Время включения 6:00 в будни
scripts.addCron("aquarium", "0 20 * * 1-5") -- Время выключения 20:00 в будни

Вариант обработки таймера

-- aquarium.lua
if (Event.Time.hour == 6 and Event.Time.min == 0) then
  zigbee.set("0xA4C138E56B96596D", "state", "ON") -- включить
elseif (Event.Time.hour == 20 and Event.Time.min == 0) then
  zigbee.set("0xA4C138E56B96596D", "state", "OFF") -- выключить
end

Включение, выключение света в аквариуме без скрипта

-- init.lua
-- Аквариум
scripts.addCron('#zigbee.set("0xA4C138E56B96596D", "state", "ON")', "0 6 * * 1-5") -- Время включения 6:00 в будни
scripts.addCron('#zigbee.set("0xA4C138E56B96596D", "state", "OFF")', "0 20 * * 1-5") -- Время выключения 20:00 в будни

Будильник

Алгоритм:

  • в 5:50 включить ночник
  • через 10 минут включить основной свет с небольшой яркостью
  • еще через пару минут выключить ночник и поднять яркость основного света до 100%

Инициализация:

scripts.addCron("alarmClock", "50 5 * * 1-5")
scripts.addCron("alarmClock", "0 6 * * 1-5")
scripts.addCron("alarmClock", "2 6 * * 1-5")

Обработка:

-- "50 5 * * 1-5"
if (Event.Time.hour == 5 and Event.Time.min == 50) then
  zigbee.set("lmp_bedroom-nightlight-papa", "brightness", 1) -- включить ночник через якость = 1
-- "0 6 * * 1-5"
elseif (Event.Time.hour == 6 and Event.Time.min == 0) then
  zigbee.set("lmp_bedroom", "brightness", 100) -- включить Люстру через якость = 50%
-- "2 6 * * 1-5"
elseif (Event.Time.hour == 6 and Event.Time.min == 2) then
  zigbee.set("lmp_bedroom-nightlight-papa", "state", "OFF") -- выключить ночник
  zigbee.set("lmp_bedroom", "brightness", 255) -- включить Люстру через якость = 100%
end

Внимание, скрипты OneMinTimer.lua и OneSecTimer.lua, начиная с версии прошивки 2022.01.30d1, не запускаются автоматически!!!