Просмотр кода страницы Lua

{{DISPLAYTITLE:Lua}}
{{Breadcrumbs|Lua}}

== Общие сведения ==
Cкрипт <code>homed.lua</code> это подключаемый модуль языка [https://www.lua.org Lua], упрощающий написание скриптов для автоматизации работы сервисов ''HOMEd''. Для работы скрипта '''''необходимо''''' наличие допонительных модулей:

<code class="value">lua-cjson</code><br>
<code class="value">lua-mosquitto</code>

Загрузить актуальную версию скрипта можно на [https://github.com/u236/homed-lua-module GitHub].

== Функции модуля ==

=== <code class="value">tickEvent(timestamp)</code> ===
Функция, которая вызывается каждую секунду в процессе работы скрипта. Аргументы:<br>
<code>timestamp</code> - текущая метка времени в формате Unix Time
----

=== <code class="value">deviceEvent(service, device, endpoint, data)</code> ===
Функция, которая вызывается каждый раз, когда скрипт получает сообщение с данными от устройства. Аргументы:<br>
<code>service</code> - сервис, например <code class="value">"zigbee"</code><br>
<code>device</code> - адрес или имя устройства (если в конфигурации включен параметр <code>names</code>)<br>
<code>endpoint</code> - номер конечной точки, от которого поступили данные (nil, если это "одноканальное" устройство)<br>
<code>data</code> - таблица с данными, соответствует содержимому JSON-объекта в MQTT-сообщении
----

=== <code class="value">deviceRequest(service, device, endpoint, data)</code> === 
Отправка запроса для управления устройством. Аргументы:<br>
<code>service</code> - сервис, например <code class="value">"zigbee"</code><br>
<code>device</code> - адрес или имя устройства<br>
<code>endpoint</code> - номер конечной точки, от которого поступили данные (nil, если это "одноканальное" устройство)<br>
<code>data</code> - таблица с данными, соответствует содержимому JSON-объекта в MQTT-сообщении
----

=== <code>setHost(value)</code> === 
Настройка адреса MQTT-брокера. Аргументы:<br>
<code class="value">value</code> - адрес, по умолчанию localhost
----

=== <code>setPort(value)</code> === 
Настройка номера порта MQTT-брокера. Аргументы:<br>
<code class="value">value</code> - номер порта, по умолчанию 1883
----

=== <code>setUsername(value)</code> === 
Настройка имени пользователя для подключения к MQTT-брокеру. Аргументы:<br>
<code class="value">value</code> - имя пользователя, по умолчанию отсутствует (nil)
----

=== <code>setPassword(value)</code> === 
Настройка пароля для подключения к MQTT-брокеру. Аргументы:<br>
<code class="value">value</code> - пароль, по умолчанию отсутствует (nil)
----

=== <code>setPrefix(value)</code> === 
Настройка корневого  MQTT-топика. Аргументы:<br>
<code class="value">value</code> - корневой топик, по умолчанию homed
----

=== <code>start()</code> === 
Запуск подключения к брокеру и таймера, вызывающего функцию <code>tickEvent</code>.
----

=== <code>stop()</code> === 
Отключение от брокера и остановка таймера, вызывающего функцию <code>tickEvent</code>.
----

== Использование скриптов ==
Чтобы написать скрипт автоматизации, нужно создать папку, в которой будет находиться скрипт, например:
{{#tag:pre|
$ mkdir -p /opt/lua
}}

В эту папку необходимо скачать файл модуля:
{{#tag:pre|
$ wget -O /opt/lua/homed.lua https://raw.githubusercontent.com/u236/homed-lua-module/main/homed.lua
}}

И создать файл скрипта, например, <code>/opt/lua/my.lua</code>. Пример скрипта:
<syntaxhighlight lang="lua">
homed = require('homed')

homed.tickEvent = function(timestamp)
    -- данный пример изменяет состояние реле каждые 5 минут
    time = os.date('*t')
    if time.sec == 0 and time.min % 5 == 0 then
        homed.deviceRequest('zigbee', 'my relay', nil, {status = 'toggle'})
    end
end

homed.deviceEvent = function(service, device, endpoint, data)
    -- данный пример включает реле, если обранужено нажатие на кнопку
    if (device == 'my button' and data['action'] == 'singleClick') then
        homed.deviceRequest('zigbee', 'my relay', nil, {status = 'on'})
    end
end

homed.start()
</syntaxhighlight>

Запуск скрипта:
{{#tag:pre|
$ lua /opt/lua/my.lua
}}