Lua - История изменений

Voznemozhno: /* tickEvent(timestamp) */

2025-04-23T12:34:49Z

tickEvent(timestamp)

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

Voznemozhno в 10:16, 29 января 2025

2025-01-29T10:16:12Z

← Предыдущая версия		Версия от 10:16, 29 января 2025
Строка 1:		Строка 1:
	{{DISPLAYTITLE:Lua}}		{{DISPLAYTITLE:Lua}}
	{{Breadcrumbs\|Lua}}		{{Breadcrumbs\|Lua}}

	{{Warning\|ВНИМАНИЕ! Информация на этой странице сильно устарела!}}		{{Warning\|ВНИМАНИЕ! Информация на этой странице сильно устарела!}}

Voznemozhno в 10:15, 29 января 2025

2025-01-29T10:15:10Z

← Предыдущая версия		Версия от 10:15, 29 января 2025
Строка 1:		Строка 1:
	{{DISPLAYTITLE:Lua}}		{{DISPLAYTITLE:Lua}}
	{{Breadcrumbs\|Lua}}		{{Breadcrumbs\|Lua}}

			{{Warning\|ВНИМАНИЕ! Информация на этой странице сильно устарела!}}

	== Общие сведения ==		== Общие сведения ==

Voznemozhno в 07:32, 20 марта 2024

2024-03-20T07:32:35Z

Voznemozhno в 11:40, 19 марта 2024

2024-03-19T11:40:29Z

Новая страница

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

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

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

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

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

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

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

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

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

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

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

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

=== <code>setPrefix(value)</code> ===
Настройка корневого топика mqtt. Аргументы: 
<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
}}

← Предыдущая версия		Версия от 07:32, 20 марта 2024
Строка 22:		Строка 22:
	<code>device</code> - адрес или имя устройства (если в конфигурации включен параметр <code>names</code>)<br>		<code>device</code> - адрес или имя устройства (если в конфигурации включен параметр <code>names</code>)<br>
	<code>endpoint</code> - номер конечной точки, от которого поступили данные (nil, если это "одноканальное" устройство)<br>		<code>endpoint</code> - номер конечной точки, от которого поступили данные (nil, если это "одноканальное" устройство)<br>
	<code>data</code> - таблица с данными, соответствует содержимому JSON-объекта в MQTT		<code>data</code> - таблица с данными, соответствует содержимому JSON-объекта в MQTT-сообщении
	----		----

Строка 30:		Строка 30:
	<code>device</code> - адрес или имя устройства<br>		<code>device</code> - адрес или имя устройства<br>
	<code>endpoint</code> - номер конечной точки, от которого поступили данные (nil, если это "одноканальное" устройство)<br>		<code>endpoint</code> - номер конечной точки, от которого поступили данные (nil, если это "одноканальное" устройство)<br>
	<code>data</code> - таблица с данными, соответствует содержимому JSON-объекта в MQTT		<code>data</code> - таблица с данными, соответствует содержимому JSON-объекта в MQTT-сообщении
	----		----

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

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

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

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

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