Просмотр кода страницы Automation/Database/Actions

{{DISPLAYTITLE:Automation: Действия}}
{{Breadcrumbs|[[Automation]] > [[Automation/Database|База данных]] > Действия}}

== Действие "property" ==
Это действие управляет выбранным свойством, то есть отправляет команду устройству. Примеры описания действия:
<syntaxhighlight lang="json">
...
"actions":
[
  {
    "type": "property",
    "endpoint": "zigbee/kitchenLight",
    "property": "level",
    "increase": 10
  },
  {
    "type": "property",
    "endpoint": "zigbee/roomCurtain",
    "property": "position",
    "decrease": 25
  },
  {
    "type": "property",
    "endpoint": "zigbee/hallLight",
    "property": "status",
    "value": "off"
  }
]
...
</syntaxhighlight>

{{Warning|Поля <code>"increase"</code>, <code>"decrease"</code>, <code>"value"</code> не могут использоваться в одном действии одновременно.}}

=== <code>endpoint</code> ===
Конечная точка, которой управляет действие. Описывается в формате <code class="value">"сервис/устройство"</code> или <code class="value">"сервис/устройство/N"</code>, где <code class="value">N</code> это номер конечной точки для многоканальных устройств.

По сути, значение этого поля идентично части MQTT топика для отправки команд устройству после <code class="value">homed/td/</code>.

=== <code>property</code> ===
Свойство конечной точки, которым управляет действие. Другими словами - название поля в сообщении с командой.

=== <code>increase</code> ===
В команде будет передано ''числовое'' значение свойства, увеличенное на значение этого поля.

=== <code>decrease</code> ===
В команде будет передано ''числовое'' значение свойства, уменьшенное на значение этого поля.

=== <code>value</code> ===
Конкретное значение свойства, передаваемое в команде. Текстовое значение состояния может содержать [[Automation/Database/Actions#Шаблоны|шаблоны]].

== Действие "mqtt" ==
Это действие отправляет сообщение в заданный MQTT топик. Примеры описания действия:
<syntaxhighlight lang="json">
...
"actions":
[
  {
    "type": "mqtt",
    "topic": "my/action/topic",
    "message": "hello world"
  },
  {
    "type": "mqtt",
    "topic": "other/topic",
    "message": "retained message",
    "retain": true
  }
]
...
</syntaxhighlight>

=== <code>topic</code> ===
MQTT топик.

=== <code>message</code> ===
Текст отправляемого сообщения. Сообщение может содержать [[Automation/Database/Actions#Шаблоны|шаблоны]].

=== <code>retain</code> ===
Отправка сообщения с флагом '''retain'''.

== Действие "state" ==
Это действие позволяет устанавливать или удалять [[Automation/Database#Состояния|состояния]]. Примеры описания действий:
<syntaxhighlight lang="json"> 
...
"actions":
[
  {
    "type": "state",
    "name": "myFavoriteState",
    "value": true
  },
  {
    "type": "state",
    "name": "otherState",
    "value": "hello there"
  },
  {
    "type": "state",
    "name": "uselessState"
  }
]
...
</syntaxhighlight>

=== <code>name</code> ===
Название состояния.

=== <code>value</code> ===
Значение состояния, устанавливаемое действием. Текстовое значение состояния может содержать [[Automation/Database/Actions#Шаблоны|шаблоны]]. Если это поле остутствует или равно <code class="value">null</code>, состояние будет удалено.

== Действие "telegram" ==
Это действие отправляет текстовое сообщение с помощью Telegram-бота. Пример описания действия:
<syntaxhighlight lang="json">
...
"actions":
[
  {
    "type": "telegram",
    "message": "свет в гараже выключен",
    "silent": true
  },
  {
    "type": "telegram",
    "message": "входная дверь открыта!",
    "chats": [123456789, 4815162342]
  }
]
...
</syntaxhighlight>

=== <code>message</code> ===
Текст отправляемого сообщения. Сообщение может содержать [[Automation/Database/Actions#Шаблоны|шаблоны]].

=== <code>silent</code> ===
Отправка сообщения с уведомлением без звука.

=== <code>chats</code> ===
Массив идентификаторов чатов, в которые будет отправлено сообщение. В случае отсутствия этого поля сообщение будет отправлено в чат, идентификатор которого указан в [[Automation/Configuration|конфигурации]].

== Действие "shell" ==
Это действие запускает заданную shell-команду. Пример описания действия:
<syntaxhighlight lang="json">
...
"actions":
[
  {
    "type": "shell",
    "command": "sh /home/user/script.sh"
  }
]
...
</syntaxhighlight>

=== <code>command</code> ===
Shell-команда, которая будет запущена. Команда может содержать [[Automation/Database/Actions#Шаблоны|шаблоны]].

== Действие "condition" ==
Это действие является контейнером для других действий, которые будут выполнены при соблюдении или несоблюдении заданных [[Automation/Database/Conditions|условий]]. Пример описания действия:
<syntaxhighlight lang="json">
...
"actions":
[
  {
    "type": "condition",
    "conditions":
    [
       {
         "type": "date",
         ...
       },
       {
         "type": "time",
         ...
       }
    ],
    "then":
    [
       {
         "type": "property",
         ...
       }
    ],
    "else":
    [
       {
         "type": "telegram",
         ...
       }
    ]
  }
]
...
</syntaxhighlight>

=== <code>conditions</code> ===
Массив условий.

=== <code>then</code> ===
Массив действий, которые будут выполнены, если условия соблюдены.

=== <code>else</code> ===
Массив действий, которые будут выполнены, если условия ''не'' соблюдены.

== Действие "delay" ==
Это действие добавляет задержку перед выполнением следующего по списку действия. Пример описания действия:
<syntaxhighlight lang="json">
...
"actions":
[
  {
    "type": "delay",
    "delay": 10
  }
]
...
</syntaxhighlight>

=== <code>delay</code> ===
Время задержки в секундах.

== Дополнительные условия ==
Условия для выполнения действий могут определяться не тольлько действием [[#Действие "condition"|"condition"]], но и тем, какой именно триггер вызвал срабатывание автоматизации, если для триггеров заданы [[Automation/Database/Triggers#Имена триггеров|имена]]. В этом случае нужные действия будут выполнены только при срабатывании соответсвующего им триггера, например:
<syntaxhighlight lang="json">
...
"actions":
[
  {
    "type": "property",
    "triggerName": "a",
    ...
  },
  {
    "type": "telegram",
    "triggerName": "b",
    ...
  }
]
...
</syntaxhighlight>

== Шаблоны ==
Шаблоны позволяют использовать в действиях свойства устройств, данные из MQTT топиков, состояния, метки времени и имена триггеров. Примеры использования шаблонов приведены ниже.

Показания датчика температуры:
{{#tag:pre|<nowiki>{{ property | zigbee/kitchenThermometer | temperature }}</nowiki>}}

MQTT сообщение целиком:
{{#tag:pre|<nowiki>{{ mqtt | test/topic }}</nowiki>}}

Поле <code>fieldName</code> из MQTT сообщения, содержащего  JSON:
{{#tag:pre|<nowiki>{{ mqtt | test/json/topic | fieldName }}</nowiki>}}

Значение состояния <code>myState</code>:
{{#tag:pre|<nowiki>{{ state | myState }}</nowiki>}}

Текущее время и дата:
{{#tag:pre|<nowiki>{{ timestamp }}</nowiki>}}

Текущее время и дата в заданном формате:
{{#tag:pre|<nowiki>{{ timestamp | dd.MM.yy hh:mm }}</nowiki>}}

Имя триггера, вызвавшего срабатывание автоматизации:
{{#tag:pre|<nowiki>{{ triggerName }}</nowiki>}}

Кроме того, шаблоны могут содержать математические выражения. Каждое выражение может содержать любые математические операции (сложение, вычитание, умножение, деление, возведение в степень), включая операции в скобках, некоторые функции, а так же любые другие шаблоны. Если выражение некорретно, результатом вычислений будет <code class="value">nan</code>. Список досутпных функций можно посмотреть [https://github.com/u236/homed-service-automation/blob/570f97ad640606624f24eff20606cf71ca2324ad/expression.cpp#L86-L107 здесь].

Примеры:
{{#tag:pre|<nowiki>
[[ sqrt(2 ^ 2) ]]
[[ {{ state | counter }} + 1 ]]
[[ {{ propery | zigbee/sensor | temperature }} * 0.99 ]]
</nowiki>}}

В одном действии может быть использовано любое количество шаблонов и математических операций. 

[[Category:Automation]]