[[ru:Заглавная_страница]]
[[en:Main_Page]]
[[zh:首页]]
<div style="margin-bottom: 30px; padding-bottom: 20px; border-bottom: 1px solid #eee; font-family: sans-serif; color: #333; line-height: 1.5;">
Здесь собрана база знаний со статьями, технической документацией и руководствами по продуктам Light Stream.
<br>
Официальный сайт: [https://lightstream.pro/ lightstream.pro]
</div>

{| style="width:100%; border-spacing: 40px 0; border-collapse: separate; background: transparent; font-family: sans-serif;"
|-
| valign="top" style="width:50%;" |
<div style="border-bottom: 1px solid #eee; margin-bottom: 15px; padding-bottom: 5px;">
=== 🚀 Light Stream Software ===
</div>
<div style="border-left: 3px solid #e0e0e0; padding-left: 15px; margin: 12px 0;"> [[Light_Stream_-_Быстрый_старт|Быстрый старт]] <small style="color: #b0b0b0; margin-left: 5px;">— черновик</small> </div>
<div style="border-left: 3px solid #e0e0e0; padding-left: 15px; margin: 12px 0;"> [[Light_Stream_-_Руководство_пользователя|Руководство пользователя]] <small style="color: #b0b0b0; margin-left: 5px;">— черновик</small> </div>
<div style="border-left: 3px solid #e0e0e0; padding-left: 15px; margin: 12px 0;"> [[Не_отправляется_Art-Net|Не отправляется Art-Net]] <small style="color: #b0b0b0; margin-left: 5px;">— черновик</small> </div>
<div style="border-left: 3px solid #e0e0e0; padding-left: 15px; margin: 12px 0;"> [[Приборы|Приборы]] <small style="color: #b0b0b0; margin-left: 5px;">— черновик</small> </div>

| valign="top" style="width:50%;" |
<div style="border-bottom: 1px solid #eee; margin-bottom: 15px; padding-bottom: 5px;">
=== 📱 Light Stream Player ===
</div>
<div style="border-left: 3px solid #e0e0e0; padding-left: 15px; margin: 12px 0;"> [[Light_Stream_Player_-_Руководство_пользователя|Руководство пользователя]] <small style="color: #b0b0b0; margin-left: 5px;">— черновик</small> </div>
<div style="border-left: 3px solid #e0e0e0; padding-left: 15px; margin: 12px 0;"> [[Подключение_LS_Player_к_интернету|Подключение плеера к интернету]] </div>
<div style="border-left: 3px solid #e0e0e0; padding-left: 15px; margin: 12px 0;"> [[Адресация_приборов|Адресация приборов]] </div>
<div style="border-left: 3px solid #e0e0e0; padding-left: 15px; margin: 12px 0;"> [[Light_Stream_-_Автоматизация|Автоматизация]] </div>
<div style="border-left: 3px solid #e0e0e0; padding-left: 15px; margin: 12px 0;"> [[LS_Player_MQTT_API|LS Player MQTT API]] </div>

|-
| valign="top" |
<div style="border-bottom: 1px solid #eee; margin-bottom: 15px; padding-bottom: 5px; margin-top: 20px;">
=== 🎮 LS Software Unreal Plugin ===
</div>
<div style="border-left: 3px solid #e0e0e0; padding-left: 15px; margin: 12px 0;"> [[Light_Stream_Plugin_-_Unreal_Engine|Light Stream Plugin — Unreal Engine]] </div>

| valign="top" |
<div style="border-bottom: 1px solid #eee; margin-bottom: 15px; padding-bottom: 5px; margin-top: 20px;">
=== ⚙️ Light Stream Devices ===
</div>
<div style="border-left: 3px solid #e0e0e0; padding-left: 15px; margin: 12px 0;"> [[Converter_6_-_Руководство_пользователя|Converter 6 — Руководство пользователя]] </div>

|-
| valign="top" |
<div style="border-bottom: 1px solid #eee; margin-bottom: 15px; padding-bottom: 5px; margin-top: 20px;">
=== 🌐 Общие статьи ===
</div>
<div style="border-left: 3px solid #e0e0e0; padding-left: 15px; margin: 12px 0;"> [[Таблица_управляемых_чипов_(IC)|Таблица управляемых чипов (IC)]] </div>
<div style="border-left: 3px solid #e0e0e0; padding-left: 15px; margin: 12px 0;"> [[Возможности_DMX_интерфейсов|Возможности DMX интерфейсов]] </div>

| valign="top" |
<div style="border-bottom: 1px solid #eee; margin-bottom: 15px; padding-bottom: 5px; margin-top: 20px;">
=== 🔄 Списки изменений ===
</div>
<div style="border-left: 3px solid #e0e0e0; padding-left: 15px; margin: 12px 0;"> [[Список_изменений_Player|Список изменений Player]] </div>
<div style="border-left: 3px solid #e0e0e0; padding-left: 15px; margin: 12px 0;"> [[Список_изменений_Software|Список изменений Software]] </div>
<div style="border-left: 3px solid #e0e0e0; padding-left: 15px; margin: 12px 0;"> [[Список_изменений_Converter|Список изменений Converter]] </div>
|}
__БЕЗ_РЕДАКТИРОВАНИЯ_РАЗДЕЛА__

База управляемых чипов (IC)

2026-03-12T13:33:28Z

LightStream: LightStream переименовал страницу База управляемых чипов (IC) в Таблица управляемых чипов (IC)

#перенаправление [[Таблица управляемых чипов (IC)]]

Таблица управляемых чипов (IC)

2026-03-12T13:33:28Z

LightStream: LightStream переименовал страницу База управляемых чипов (IC) в Таблица управляемых чипов (IC)

Возможности DMX интерфейсов

2026-03-06T04:21:50Z

LightStream:

'''DMX-интерфейс''' — это физический порт устройства, предназначенный для подключения управляемых светильников, пикселей и других световых приборов, работающих по протоколу '''Art-Net''' в стандартах '''DMX''' или '''SPI'''. На устройствах '''Light Stream''' DMX-интерфейс выполнен в виде коннектора с тремя отверстиями для подключения проводов.

<span id="таблица-сравнений-ls-устройств"></span>
= Таблица сравнений LS устройств =

{| class="wikitable"
|-
! Возможности
! style="text-align: center;"| '''Player V2 (v1.1.2)'''<br>[[File:Device_Player_V2_ort_350px.png|170px]]
! style="text-align: center;"| '''Player V2 (v1.2.0)'''<br>[[File:Device_Player_V2_ort_350px.png|170px]]
! style="text-align: center;"| '''Converter 2'''<br>[[File:Device_Converter2_rev3_ort_350px.png|130px]]
! style="text-align: center;"| '''Converter 6'''<br>[[File:Device_Converter6_rev3_ort_350px.png|170px]]
! style="text-align: center;"| '''Converter 8 LITE'''<br>[[File:Device_Converter8_LITE_rev1_ort_350px.png|150px]]
|-
| '''Art-Net'''
| style="text-align: center;"| OUT
| style="text-align: center;"| IN, OUT
| style="text-align: center;"| IN
| style="text-align: center;"| IN
| style="text-align: center;"| IN
|-
| '''DMX OUT'''
| style="text-align: center;"| 1U на порт
| style="text-align: center;"| 1U на порт
| style="text-align: center;"| 1U, 2U на порт
| style="text-align: center;"| 1U, 2U на порт
| style="text-align: center;"| 1U, 2U на порт
|-
| '''DMX IN'''
| style="text-align: center;"| ➖
| style="text-align: center;"| ➖
| style="text-align: center;"| 1U на порт
| style="text-align: center;"| 1U на порт
| style="text-align: center;"| ➖
|-
| '''SPI OUT'''
| style="text-align: center;"| ➖
| style="text-align: center;"| ➖
| style="text-align: center;"| 1U, 2U, 4U на порт
| style="text-align: center;"| 1U, 2U, 4U на порт
| style="text-align: center;"| 1U, 2U, 4U на порт
|-
| '''RDM (DMX512)'''
| style="text-align: center;"| ➖
| style="text-align: center;"| ➖
| style="text-align: center;"| ✅
| style="text-align: center;"| ✅
| style="text-align: center;"| ➖
|-
| '''Адрессация DMX'''*
| style="text-align: center;"| ➖
| style="text-align: center;"| ➖
| style="text-align: center;"| ✅
| style="text-align: center;"| ✅
| style="text-align: center;"| ✅
|-
| '''RS-485 (Modbus)'''
| style="text-align: center;"| ✅
| style="text-align: center;"| ✅
| style="text-align: center;"| ➖
| style="text-align: center;"| ➖
| style="text-align: center;"| ➖
|}

<code>*</code> '''Адрессация DMX приборов''' — поддерживаемые чипы: '''UCS512''' и '''TM512''', доступно на версиях ПО '''CvOS v1.9.19.0''' и новее

Возможности DMX интерфейсов

2026-03-06T04:19:48Z

2026-01-28T07:35:24Z

LightStream:

LS Player MQTT API

2025-12-29T12:26:06Z

LightStream:

LS Player MQTT API

2025-12-29T12:24:55Z

LightStream:

== 1. Управление проигрыванием и получение статистики ==
Описывает MQTT API сервиса.

Сервис осуществляет проигрывание анимаций.

=== SUB <code>lm/player</code> ===
Принимает команды управления проигрыванием.

==== Play ====
Payload command format
{
"cmd": 'play',
"what_playing": Union['playlist', 'cue'],
"entity": Union[int, str],
"count": Optional[int],
"priority": int,
}
Example
{
"cmd": "play",
"what_playing": "playlist",
"entity": 19,
"count": Null,
"priority": 4,
}
* '''cmd''' - Название команды.
* '''what_playing''' - Тип сущности для воспроизведения. Принимает два значения “playlist” и “cue”.
* '''entity''' - ID или наименование проигрываемой сущности.
* '''count''' - Опциональный параметр. Количество повторений проигрывания. Если не задан или значение равно Null то проигрывание продолжится до получения следующей команды с равным или боле высоким приоритетом.
* '''priority''' - Приоритет команды. Значение от 1 до 100. Чем больше значение - тем выше приоритет. Команда с более низким приоритетом не может отменять команду с более высоким приоритетом. Текущие сопоставления приоритетов: Расписание - 60, Триггер - 50, Ручной запуск - 40.

==== Stop ====
Payload stop command format
{
"cmd": 'stop',
"priority": int,
}
Example
{
"cmd": "stop",
"priority": 4,
}
* '''cmd''' - Название команды.
* '''priority''' - Приоритет команды. Значение от 1 до 100. Чем больше значение - тем выше приоритет. Команда с более низким приоритетом не может отменять команду с более высоким приоритетом. Текущие сопоставления приоритетов: Расписание - 60, Триггер - 50, Ручной запуск - 40.

=== PUB <code>lm/statistic/playing_progress_info</code> ===
Публикует статистику проигрывания.

Зная текущее значение fps можно перевести значения во время.

Например при fps равном 40 frame_count равном 1000 и frame_number равном 120 мы получим:<br />1 / 40 * 1000 = 25 - Общая продолжительность анимации в секундах. 1 / 40 * 120 = 3 - На текущий момент анимация проиграла 3 секунды.

Payload format
Представляет из себя строку в формате <code>"{frame_count}, {frame_number}"</code>
Example
“1000, 35”
* '''frame_count''' - Общее количество фреймов.
* '''frame_number''' - Сколько фреймов проиграно на текущий момент.

=== PUB <code>lm/statistic/playing_ent_info</code> ===
Публикует Наименования того, что сейчас проигрывается.

Payload format
{
"playlist": Optional[str],
'scene': Optional[int],
'cue': Optional[str],
}
Example
{
"playlist": "NewYearPlaylist",
"scene": 1,
"cue": "BLUE.cue",
}
* '''playlist''' - Наименование проигрываемого плейлиста. Может быть None.
* '''scene''' - Порядковый номер в плейлисте. Может быть None.
* '''cue''' - Наименование проигрываемой анимации. Может быть None.

=== PUB <code>lm/statistic/current_playing_priority</code> ===
Публикует текущий приоритет проигрывания.

Payload format
int
Example
60

== 2. Управление настройками проигрывания и сущностей ==

=== PUB <code>lm/settings/location/coordinates</code> ===
Публикует координаты плеера.

Payload command format
{
"latitude": float,
"longitude": float,
}
Example
{
"latitude": "56.821019190097616",
"longitude": "60.59559633825789"
}

=== PUB <code>lm/settings/location/address</code> ===
Публикует адрес устройства.

Payload format
{
"address": str
}
Example
{
"address": "Yekaterinburg"
}

=== PUB <code>lm/settings/datetime/timezone</code> ===
Публикует часовой пояс плеера.

Payload format
{
"timezone": str
}
Example
{
"timezone": "Asia/Yekaterinburg"
}
* '''timezone''' - Часовой пояс плеера.

=== PUB <code>lm/settings/player/fps</code> ===
Публикует настройки fps.

Payload format
{
"fps": int,
}
Example
{
"fps": 40
}

=== PUB <code>lm/settings/player/artsync</code> ===
Публикует статус отправки artsync.

Payload format
{
"artsync": bool,
}
Example
{"artsync": false}

=== PUB <code>lm/settings/player/blackout_between_playing_command</code> ===
Публикует настройку необходимости blackout между событиями проигрывания.

Payload format
{
"blackout_between_playing_command": bool,
}
Example
{
"blackout_between_playing_command": false
}

=== PUB <code>lm/settings/player/playing_priority</code> ===
Публикует приоритеты проигрывания плеера.

Payload command format
{
"buttons": int,
"triggers": int,
"scheduler": int,
}
Example
{
"buttons": 4,
"triggers": 5,
"scheduler": 6,
}
Приоритет представляет из себя целое число от 1 до 100. Чем выше число тем меньше приоритет.

=== PUB <code>lm/settings/player/universes</code> ===
Публикует настройки вселенных плеера.

Payload format
[
{
"number": int,
"device": {
"name": str,
"description": str,
"network_mode": str,
"ip": str,
"port": int,
} | None
}
]
Example
[
{
"number": 1,
"device": {
"name": "artnet_device_1",
"description": "Main ArtNet converter",
"network_mode": "unicast",
"ip": "192.168.1.100",
"port": 6454
}
},
{
"number": 2,
"device": null
}
]
* '''number''' - Номер вселенной (0-32768).
* '''device''' - Настройки ArtNet устройства для данной вселенной. Может быть null если устройство не назначено.
** '''name''' - Уникальное имя ArtNet устройства (до 32 символов).
** '''description''' - Описание устройства (до 255 символов, может быть пустым).
** '''network_mode''' - Режим работы сети (“unicast” или “broadcast”).
** '''ip''' - IP адрес устройства.
** '''port''' - Порт устройства (по умолчанию 6454, диапазон 1-65534).

=== PUB <code>lm/cues</code> ===
Публикует список cue файлов загруженных на плеер

Payload format
[
{
"id": int,
"filename": str,
"uni_count": int,
"frame_count": int,
"created": str,
}
]
Example
[
{
"id": 47,
"filename": "00-5.cue",
"uni_count": 1,
"frame_count": 220,
"created": "2024-03-07T08:30:16.926447Z"
}
]
* '''id''' - Уникальный идентификатор анимации.
* '''filename''' - Имя файла.
* '''uni_count''' - Количество вселенных в файле.
* '''frame_count''' - Количество фреймов в файле.
* '''created''' - Время загрузки анимации в ISO формате.

=== PUB <code>lm/playlists</code> ===
Публикует список cue файлов загруженных на плеер

Payload format
[
{
"id": int,
"name": str,
"scenes": [
{
"id": int,
"order": int,
"cue": {
"created": str,
"filename": str,
"frame_count": int,
"id": int,
"uni_count": int
},
"fade_in": float,
"fade_out": float,
"transition_time": float,
"repeat_value": int,
}
]
}
]
Example
[
{
"id": 19,
"name": "Test",
"scenes": [
{
"id": 71,
"order": 0,
"cue": {
"created": "2024-03-07T08:27:23.567083Z",
"filename": "5-8.cue",
"frame_count": 220,
"id": 51,
"uni_count": 1
},
"fade_in": 1.0,
"fade_out": 0.0,
"transition_time": 2.0,
"repeat_value": 3600
}
]
}
]
* '''id''' - Уникальный идентификатор плейлиста.
* '''name''' - Название плейлиста.
* '''scenes''' - Сцены.В сценах содержится вся информация об эффектах примененных к cue и порядковый номер воспроизведения внутри плейлиста.
** '''id''' - Уникальный идентификатор сцены.
** '''order''' - Порядковый номер воспроизведения внутри плейлиста.
** '''cue''' - Параметры анимации. [[#pub-lmcues|Подробнее]]
** '''fade_in''' - Время fade_in.
** '''fade_out''' - Время fade_out.
** '''transition_time''' - Время перехода.
** '''repeat_value''' - Количество повторений.

== 3. Управление расписанием ==
<span id="pub-lmschedulererror"></span>

=== PUB <code>lm/scheduler/error</code> ===
Публикует ошибки.

Выставляет заголовок '''Correlation data''' если он был установлен в запросе.

Payload format<pre>{
msg: str
data: Any
}</pre>
* '''msg''' - contain error message
* '''data''' - contain related error data

<span id="pub-lmschedulerevents"></span>

<span id="pub-lmschedulerevents"></span>

=== PUB <code>lm/scheduler/events</code> ===
Публикует список всех событий календаря.

Payload format
[
{
"id": str,
"title": str,
"priority": int,
"actions": {
"player": Optional[{
"cmd": Literal['play'],
"entity_type": Union['playlist', 'cue'],
"entity_id": int,
}],
"do1": Optional[{
"state": Literal[0, 1],
}],
"do2": Optional[{
"state": Literal[0, 1],
}],
"do3": Optional[{
"state": Literal[0, 1],
}],
},
"rrule": {
"freq": Union['YEARLY', 'MONTHLY', 'WEEKLY', 'DAILY', 'HOURLY'],
"interval": int,
"start_date": str,
"start_time_type": Union['sunset', 'sunrise', 'time'],
"start_time": Optional[str],
"start_time_offset": Optional[int],

"until_date": Optional[str],
"until_time_type": Optional[Union['sunset', 'sunrise', 'time']],
"until_time": Optional[str],
"until_time_offset": Optional[int],
"count": Optional[int],
"from_time_type": Optional[Union['sunset', 'sunrise', 'time']],
"from_time": Optional[str],
"from_time_offset": Optional[int],
"to_time_type": Optional[Union['sunset', 'sunrise', 'time']],
"to_time": Optional[str],
"to_time_offset": Optional[int],
"bymonth": Optional[
list[
Union[
'January', 'February', 'March', 'April', 'May', 'June', 'July',
'August', 'September', 'October', 'November', 'December',
],
],
],
"bymonthday": Optional[list[int]],
"byweekday": Optional[list[Union['MO', 'TU', 'WE', 'TH', 'FR', 'SA', 'SU']]],

"from_min": Optional[int],
"to_min": Optional[int],
}
}
]
<span id="example-1"></span>Example
[
{
"id": "abe4c633-8e3f-4938-94e2-efd135d993fc",
"title": "holiday",
"priority": 1,
"actions": {
"player": {
"cmd": "play",
"entity_type": "playlist",
"entity_id": 19
},
"do1": {
"state": 1
},
"do2": null,
"do3": null
},
"rrule": {
"freq": "DAILY",
"interval": 1,
"start_date": "2024-01-20",
"start_time_type": "time",
"start_time": "00:00",
"start_time_offset": null,
"count": 1,
"until_date": null,
"until_time_type": null,
"until_time": null,
"until_time_offset": null,
"from_time_type": "sunset",
"from_time": null,
"from_time_offset": 0,
"to_time_type": "sunset",
"to_time": null,
"to_time_offset": 0,
"bymonth": null,
"bymonthday": null,
"byweekday": null,
"from_min": null,
"to_min": null
}
}
]
* '''id''' - Уникальный идентификатор события (UUID).
* '''title''' - Название события.
* '''priority''' - Приоритет события. Чем выше значение тем выше приоритет.
* '''actions''' - Действия которые должны быть выполнены при наступлении события.
* '''player''' - Действие для плеера. Содержит команду воспроизведения.
* '''cmd''' - Команда для плеера. Всегда равна ‘play’.
* '''entity_type''' - Тип сущности для воспроизведения. Может принимать значения ‘playlist’, ‘cue’.
* '''entity_id''' - Уникальный идентификатор сущности для воспроизведения.
* '''do1''' - Действие для цифрового выхода DO1.
* '''do2''' - Действие для цифрового выхода DO2.
* '''do3''' - Действие для цифрового выхода DO3.
* '''state''' - Состояние цифрового выхода. Может принимать значения 0 (выключен) или 1 (включен).
* '''rrule''' - Правила повторения события (recurrence rule).
* '''freq''' - Частота повторений события. Может принимать значения: ‘YEARLY’, ‘MONTHLY’, ‘WEEKLY’, ‘DAILY’, ‘HOURLY’.
* '''interval''' - Периодичность повторения события.
* '''start_date''' - Дата старта события. Формат YYYY-mm-dd.
* '''start_time_type''' - Тип времени старта события. Может принимать значения: ‘sunset’, ‘sunrise’, ‘time’.
* '''start_time''' - Время старта события. Формат: %H:%M. Заполнено если start_time_type равен ‘time’.
* '''start_time_offset''' - Сдвиг времени старта события. Может принимать отрицательные значения. Заполнено если start_time_type равен ‘sunset’ или ‘sunrise’.
* '''count''' - Количество повторений события. Не может быть заполнен одновременно с полем until_date. Если оба поля не заполнены то событие не никогда не завершается.
* '''until_date''' - Дата завершения события. Формат YYYY-mm-dd. Не может быть заполнен одновременно с полем count. Если оба поля не заполнены то событие не никогда не завершается.
* '''until_time_type''' - Тип времени завершения события. Может принимать значения: ‘sunset’, ‘sunrise’, ‘time’. Заполнено если заполнено поле until_date.
* '''until_time''' - Время завершения события. Формат: %H:%M. Заполнено если заполнено поле until_date и until_time_type равен ‘time’.
* '''until_time_offset''' - Сдвиг времени завершения события. Заполнено если заполнено поле until_date и until_time_type равен ‘sunset’ или ‘sunrise’.
* '''from_time_type''' - Тип времени начала события. Может принимать значения: ‘sunset’, ‘sunrise’, ‘time’. Заполнено если поле freq не равно ‘HOURLY’.
* '''from_time''' - Время начала события. Формат: %H:%M. Заполнено если поле freq не равно ‘HOURLY’ и from_time_type равен ‘time’.
* '''from_time_offset''' - Сдвиг времени начала события. Может принимать отрицательные значения. Заполнено если поле freq не равно ‘HOURLY’ и from_time_type равен ‘sunset’ или ‘sunrise’.
* '''to_time_type''' - Тип времени окончания события. Может принимать значения: ‘sunset’, ‘sunrise’, ‘time’. Заполнено если поле freq не равно ‘HOURLY’.
* '''to_time''' - Время окончания события. Формат: %H:%M. Заполнено если заполнено поле freq не равно ‘HOURLY’ и to_time_type равен ‘time’.
* '''to_time_offset''' - Сдвиг времени завершения события. Заполнено если заполнено поле freq не равно ‘HOURLY’ и to_time_type равен ‘sunset’ или ‘sunrise’.
* '''bymonth''' - Месяцы в которые событие активно. Заполнено если поле freq равно ‘YEARLY’.
* '''bymonthday''' - Дни месяца в которые событие активно. Заполнено если поле freq равно ‘MONTHLY’.
* '''byweekday''' - Дни недели в которые событие активно. Заполнено если поле freq равно ‘WEEKLY’.
* '''from_min''' - Минута с которой начинается событие. Заполнено если поле freq равно ‘HOURLY’.
* '''to_min''' - Минута окончания события. Заполнено если поле freq равно ‘HOURLY’.<span id="sub-lmschedulereventsadd"></span>

=== SUB <code>lm/scheduler/events/add</code> ===
Добавляет новое событие.

Payload format
{
"title": str,
"priority": int,
"actions": {
"player": Optional[{
"cmd": Literal['play'],
"entity_type": Union['playlist', 'cue'],
"entity_id": int,
}],
"do1": Optional[{
"state": Literal[0, 1],
}],
"do2": Optional[{
"state": Literal[0, 1],
}],
"do3": Optional[{
"state": Literal[0, 1],
}],
},
"rrule": {
"freq": Union['YEARLY', 'MONTHLY', 'WEEKLY', 'DAILY', 'HOURLY'],
"interval": int,
"start_date": str,
"start_time_type": Union['sunset', 'sunrise', 'time'],
"start_time": Optional[str],
"start_time_offset": Optional[int],

"until_date": Optional[str],
"until_time_type": Optional[Union['sunset', 'sunrise', 'time']],
"until_time": Optional[str],
"until_time_offset": Optional[int],
"count": Optional[int],
"from_time_type": Optional[Union['sunset', 'sunrise', 'time']],
"from_time": Optional[str],
"from_time_offset": Optional[int],
"to_time_type": Optional[Union['sunset', 'sunrise', 'time']],
"to_time": Optional[str],
"to_time_offset": Optional[int],
"bymonth": Optional[
list[
Union[
'January', 'February', 'March', 'April', 'May', 'June', 'July',
'August', 'September', 'October', 'November', 'December',
],
],
],
"bymonthday": Optional[list[int]],
"byweekday": Optional[list[Union['MO', 'TU', 'WE', 'TH', 'FR', 'SA', 'SU']]],

"from_min": Optional[int],
"to_min": Optional[int],
}
}
Example
{
"title": "holiday",
"priority": 1,
"actions": {
"player": {
"cmd": "play",
"entity_type": "playlist",
"entity_id": 19
},
"do1": {
"state": 1
},
"do2": null,
"do3": null
},
"rrule": {
"freq": "DAILY",
"interval": 1,
"start_date": "2024-01-20",
"start_time_type": "time",
"start_time": "00:00",
"start_time_offset": null,
"count": 1,
"until_date": null,
"until_time_type": null,
"until_time": null,
"until_time_offset": null,
"from_time_type": "sunset",
"from_time": null,
"from_time_offset": 0,
"to_time_type": "sunset",
"to_time": null,
"to_time_offset": 0,
"bymonth": null,
"bymonthday": null,
"byweekday": null,
"from_min": null,
"to_min": null
}
}
* '''title''' - Название события.
* '''priority''' - Приоритет события. Чем выше значение тем выше приоритет.
* '''actions''' - Действия которые должны быть выполнены при наступлении события.
* '''player''' - Действие для плеера. Содержит команду воспроизведения.
* '''cmd''' - Команда для плеера. Всегда равна ‘play’.
* '''entity_type''' - Тип сущности для воспроизведения. Может принимать значения ‘playlist’, ‘cue’.
* '''entity_id''' - Уникальный идентификатор сущности для воспроизведения.
* '''do1''' - Действие для цифрового выхода DO1.
* '''do2''' - Действие для цифрового выхода DO2.
* '''do3''' - Действие для цифрового выхода DO3.
* '''state''' - Состояние цифрового выхода. Может принимать значения 0 (выключен) или 1 (включен).
* '''rrule''' - Правила повторения события (recurrence rule).
* '''freq''' - Частота повторений события. Может принимать значения: ‘YEARLY’, ‘MONTHLY’, ‘WEEKLY’, ‘DAILY’, ‘HOURLY’.
* '''interval''' - Периодичность повторения события.
* '''start_date''' - Дата старта события. Формат YYYY-mm-dd.
* '''start_time_type''' - Тип времени старта события. Может принимать значения: ‘sunset’, ‘sunrise’, ‘time’.
* '''start_time''' - Время старта события. Формат: %H:%M. Заполнено если start_time_type равен ‘time’.
* '''start_time_offset''' - Сдвиг времени старта события. Может принимать отрицательные значения. Заполнено если start_time_type равен ‘sunset’ или ‘sunrise’.
* '''count''' - Количество повторений события. Не может быть заполнен одновременно с полем until_date. Если оба поля не заполнены то событие не никогда не завершается.
* '''until_date''' - Дата завершения события. Формат YYYY-mm-dd. Не может быть заполнен одновременно с полем count. Если оба поля не заполнены то событие не никогда не завершается.
* '''until_time_type''' - Тип времени завершения события. Может принимать значения: ‘sunset’, ‘sunrise’, ‘time’. Заполнено если заполнено поле until_date.
* '''until_time''' - Время завершения события. Формат: %H:%M. Заполнено если заполнено поле until_date и until_time_type равен ‘time’.
* '''until_time_offset''' - Сдвиг времени завершения события. Заполнено если заполнено поле until_date и until_time_type равен ‘sunset’ или ‘sunrise’.
* '''from_time_type''' - Тип времени начала события. Может принимать значения: ‘sunset’, ‘sunrise’, ‘time’. Заполнено если поле freq не равно ‘HOURLY’.
* '''from_time''' - Время начала события. Формат: %H:%M. Заполнено если поле freq не равно ‘HOURLY’ и from_time_type равен ‘time’.
* '''from_time_offset''' - Сдвиг времени начала события. Может принимать отрицательные значения. Заполнено если поле freq не равно ‘HOURLY’ и from_time_type равен ‘sunset’ или ‘sunrise’.
* '''to_time_type''' - Тип времени окончания события. Может принимать значения: ‘sunset’, ‘sunrise’, ‘time’. Заполнено если поле freq не равно ‘HOURLY’.
* '''to_time''' - Время окончания события. Формат: %H:%M. Заполнено если заполнено поле freq не равно ‘HOURLY’ и to_time_type равен ‘time’.
* '''to_time_offset''' - Сдвиг времени завершения события. Заполнено если заполнено поле freq не равно ‘HOURLY’ и to_time_type равен ‘sunset’ или ‘sunrise’.
* '''bymonth''' - Месяцы в которые событие активно. Заполнено если поле freq равно ‘YEARLY’.
* '''bymonthday''' - Дни месяца в которые событие активно. Заполнено если поле freq равно ‘MONTHLY’.
* '''byweekday''' - Дни недели в которые событие активно. Заполнено если поле freq равно ‘WEEKLY’.
* '''from_min''' - Минута с которой начинается событие. Заполнено если поле freq равно ‘HOURLY’.
* '''to_min''' - Минута окончания события. Заполнено если поле freq равно ‘HOURLY’.

=== SUB <code>lm/scheduler/events/delete</code> ===
Удаляет событие.

Payload format
{
id: str
}
Example
{
"id": "abe4c633-8e3f-4938-94e2-efd135d993fc",
}
* '''id''' - Уникальный идентификатор события. ___

=== SUB <code>lm/scheduler/events/update</code> ===
Обновляет параметры события.

Payload format
{
"id": str,
"title": str,
"priority": int,
"actions": {
"player": Optional[{
"cmd": Literal['play'],
"entity_type": Union['playlist', 'cue'],
"entity_id": int,
}],
"do1": Optional[{
"state": Literal[0, 1],
}],
"do2": Optional[{
"state": Literal[0, 1],
}],
"do3": Optional[{
"state": Literal[0, 1],
}],
},
"rrule": {
"freq": Union['YEARLY', 'MONTHLY', 'WEEKLY', 'DAILY', 'HOURLY'],
"interval": int,
"start_date": str,
"start_time_type": Union['sunset', 'sunrise', 'time'],
"start_time": Optional[str],
"start_time_offset": Optional[int],

"until_date": Optional[str],
"until_time_type": Optional[Union['sunset', 'sunrise', 'time']],
"until_time": Optional[str],
"until_time_offset": Optional[int],
"count": Optional[int],
"from_time_type": Optional[Union['sunset', 'sunrise', 'time']],
"from_time": Optional[str],
"from_time_offset": Optional[int],
"to_time_type": Optional[Union['sunset', 'sunrise', 'time']],
"to_time": Optional[str],
"to_time_offset": Optional[int],
"bymonth": Optional[
list[
Union[
'January', 'February', 'March', 'April', 'May', 'June', 'July',
'August', 'September', 'October', 'November', 'December',
],
],
],
"bymonthday": Optional[list[int]],
"byweekday": Optional[list[Union['MO', 'TU', 'WE', 'TH', 'FR', 'SA', 'SU']]],

"from_min": Optional[int],
"to_min": Optional[int],
}
}
Example
{
"id": "abe4c633-8e3f-4938-94e2-efd135d993fc",
"title": "holiday",
"priority": 1,
"actions": {
"player": {
"cmd": "play",
"entity_type": "playlist",
"entity_id": 19
},
"do1": {
"state": 1
},
"do2": null,
"do3": null
},
"rrule": {
"freq": "DAILY",
"interval": 1,
"start_date": "2024-01-20",
"start_time_type": "time",
"start_time": "00:00",
"start_time_offset": null,
"count": 1,
"until_date": null,
"until_time_type": null,
"until_time": null,
"until_time_offset": null,
"from_time_type": "sunset",
"from_time": null,
"from_time_offset": 0,
"to_time_type": "sunset",
"to_time": null,
"to_time_offset": 0,
"bymonth": null,
"bymonthday": null,
"byweekday": null,
"from_min": null,
"to_min": null
}
}
* '''id''' - Уникальный идентификатор события (UUID).
* '''title''' - Название события.
* '''priority''' - Приоритет события. Чем выше значение тем выше приоритет.
* '''actions''' - Действия которые должны быть выполнены при наступлении события.
* '''player''' - Действие для плеера. Содержит команду воспроизведения.
* '''cmd''' - Команда для плеера. Всегда равна ‘play’.
* '''entity_type''' - Тип сущности для воспроизведения. Может принимать значения ‘playlist’, ‘cue’.
* '''entity_id''' - Уникальный идентификатор сущности для воспроизведения.
* '''do1''' - Действие для цифрового выхода DO1.
* '''do2''' - Действие для цифрового выхода DO2.
* '''do3''' - Действие для цифрового выхода DO3.
* '''state''' - Состояние цифрового выхода. Может принимать значения 0 (выключен) или 1 (включен).
* '''rrule''' - Правила повторения события (recurrence rule).
* '''freq''' - Частота повторений события. Может принимать значения: ‘YEARLY’, ‘MONTHLY’, ‘WEEKLY’, ‘DAILY’, ‘HOURLY’.
* '''interval''' - Периодичность повторения события.
* '''start_date''' - Дата старта события. Формат YYYY-mm-dd.
* '''start_time_type''' - Тип времени старта события. Может принимать значения: ‘sunset’, ‘sunrise’, ‘time’.
* '''start_time''' - Время старта события. Формат: %H:%M. Заполнено если start_time_type равен ‘time’.
* '''start_time_offset''' - Сдвиг времени старта события. Может принимать отрицательные значения. Заполнено если start_time_type равен ‘sunset’ или ‘sunrise’.
* '''count''' - Количество повторений события. Не может быть заполнен одновременно с полем until_date. Если оба поля не заполнены то событие не никогда не завершается.
* '''until_date''' - Дата завершения события. Формат YYYY-mm-dd. Не может быть заполнен одновременно с полем count. Если оба поля не заполнены то событие не никогда не завершается.
* '''until_time_type''' - Тип времени завершения события. Может принимать значения: ‘sunset’, ‘sunrise’, ‘time’. Заполнено если заполнено поле until_date.
* '''until_time''' - Время завершения события. Формат: %H:%M. Заполнено если заполнено поле until_date и until_time_type равен ‘time’.
* '''until_time_offset''' - Сдвиг времени завершения события. Заполнено если заполнено поле until_date и until_time_type равен ‘sunset’ или ‘sunrise’.
* '''from_time_type''' - Тип времени начала события. Может принимать значения: ‘sunset’, ‘sunrise’, ‘time’. Заполнено если поле freq не равно ‘HOURLY’.
* '''from_time''' - Время начала события. Формат: %H:%M. Заполнено если поле freq не равно ‘HOURLY’ и from_time_type равен ‘time’.
* '''from_time_offset''' - Сдвиг времени начала события. Может принимать отрицательные значения. Заполнено если поле freq не равно ‘HOURLY’ и from_time_type равен ‘sunset’ или ‘sunrise’.
* '''to_time_type''' - Тип времени окончания события. Может принимать значения: ‘sunset’, ‘sunrise’, ‘time’. Заполнено если поле freq не равно ‘HOURLY’.
* '''to_time''' - Время окончания события. Формат: %H:%M. Заполнено если заполнено поле freq не равно ‘HOURLY’ и to_time_type равен ‘time’.
* '''to_time_offset''' - Сдвиг времени завершения события. Заполнено если заполнено поле freq не равно ‘HOURLY’ и to_time_type равен ‘sunset’ или ‘sunrise’.
* '''bymonth''' - Месяцы в которые событие активно. Заполнено если поле freq равно ‘YEARLY’.
* '''bymonthday''' - Дни месяца в которые событие активно. Заполнено если поле freq равно ‘MONTHLY’.
* '''byweekday''' - Дни недели в которые событие активно. Заполнено если поле freq равно ‘WEEKLY’.
* '''from_min''' - Минута с которой начинается событие. Заполнено если поле freq равно ‘HOURLY’.
* '''to_min''' - Минута окончания события. Заполнено если поле freq равно ‘HOURLY’.<span id="pub-lmschedulereventschanges"></span>

=== PUB <code>lm/scheduler/events/changes</code> ===
Публикует вновь созданные/измененные/удаленные события.<span id="payload-format-5"></span>

Payload format
{
status: Literal['created', 'updated', 'deleted'],
event: {
"id": str,
"title": str,
"priority": int,
"actions": {
"player": Optional[{
"cmd": Literal['play'],
"entity_type": Union['playlist', 'cue'],
"entity_id": int,
}],
"do1": Optional[{
"state": Literal[0, 1],
}],
"do2": Optional[{
"state": Literal[0, 1],
}],
"do3": Optional[{
"state": Literal[0, 1],
}],
},
"rrule": {
"freq": Union['YEARLY', 'MONTHLY', 'WEEKLY', 'DAILY', 'HOURLY'],
"interval": int,
"start_date": str,
"start_time_type": Union['sunset', 'sunrise', 'time'],
"start_time": Optional[str],
"start_time_offset": Optional[int],

"until_date": Optional[str],
"until_time_type": Optional[Union['sunset', 'sunrise', 'time']],
"until_time": Optional[str],
"until_time_offset": Optional[int],
"count": Optional[int],
"from_time_type": Optional[Union['sunset', 'sunrise', 'time']],
"from_time": Optional[str],
"from_time_offset": Optional[int],
"to_time_type": Optional[Union['sunset', 'sunrise', 'time']],
"to_time": Optional[str],
"to_time_offset": Optional[int],
"bymonth": Optional[
list[
Union[
'January', 'February', 'March', 'April', 'May', 'June', 'July',
'August', 'September', 'October', 'November', 'December',
],
],
],
"bymonthday": Optional[list[int]],
"byweekday": Optional[list[Union['MO', 'TU', 'WE', 'TH', 'FR', 'SA', 'SU']]],

"from_min": Optional[int],
"to_min": Optional[int],
}
}
}
Example
{
"status": "created",
"event": {
"id": "abe4c633-8e3f-4938-94e2-efd135d993fc",
"title": "holiday",
"priority": 1,
"actions": {
"player": {
"cmd": "play",
"entity_type": "playlist",
"entity_id": 19
},
"do1": {
"state": 1
},
"do2": null,
"do3": null
},
"rrule": {
"freq": "DAILY",
"interval": 1,
"start_date": "2024-01-20",
"start_time_type": "time",
"start_time": "00:00",
"start_time_offset": null,
"count": 1,
"until_date": null,
"until_time_type": null,
"until_time": null,
"until_time_offset": null,
"from_time_type": "sunset",
"from_time": null,
"from_time_offset": 0,
"to_time_type": "sunset",
"to_time": null,
"to_time_offset": 0,
"bymonth": null,
"bymonthday": null,
"byweekday": null,
"from_min": null,
"to_min": null
}
}
}
* '''status''' - Тип изменения. Может принимать значения ‘created’, ‘updated’, ‘deleted’.
* '''event''' - Событие со всеми параметрами в формате SchedulerEvent. ___

=== SUB <code>lm/scheduler/events/periods</code> ===
Принимает запрос на публикацию всех одиночных событий за указанный период.

Запрос должен содержать cor data для последующей идентификации ответа. Запрос может содержать resp_topic. В противном случае ответ будет опубликован в топик <code>lm/scheduler/events/periods/response</code>.

Payload format
{
from_datetime: str,
to_datetime: str,
filters: Optional[{
player: bool,
do1: bool,
do2: bool,
do3: bool,
}]
}
Example
{
"from_datetime": "2024-02-25T05:00:00",
"to_datetime": "2024-04-08T05:00:00",
"filters": {
"player": true,
"do1": false,
"do2": false,
"do3": false
}
}
* '''from_datetime''' - Дата и время начала диапазона в iso формате.
* '''to_datetime''' - Дата и время окончания диапазона в iso формате.
* '''filters''' - Опциональные фильтры для типов действий. Если не указаны, возвращаются события со всеми типами действий.
* '''player''' - Включать события с действиями плеера.
* '''do1''' - Включать события с действиями для цифрового выхода DO1.
* '''do2''' - Включать события с действиями для цифрового выхода DO2.
* '''do3''' - Включать события с действиями для цифрового выхода DO3.

=== PUB <code>lm/scheduler/events/periods/response</code> ===
Публикует список одиночных событий календаря за указанный период. Период задается в запросе. Запрос принимается на топик <code>lm/scheduler/events/periods</code>

Payload format
[
{
id: str
title: str
start: str
end: str
priority: int
duration: float
}
]
Example
[
{
"id": "abe4c633-8e3f-4938-94e2-efd135d993fc",
"title": "holiday",
"priority": 1,
"start": "2024-02-29T12:00:00+03:00",
"end": "2024-03-02T12:00:00+03:00",
"duration": 259200.0
}
]
* '''id''' - Уникальный идентификатор события.
* '''title''' - Название события.
* '''priority''' - Приоритет события. Чем выше значение тем выше приоритет.
* '''start''' - Дата и время начала события в ISO формате.
* '''end''' - Дата и время окончания события в ISO формате.
* '''duration''' - Продолжительность события в секундах.

=== PUB <code>lm/scheduler/player/status</code> ===
Публикует текущее активное событие плеера если оно есть.

Payload format<span id="событие-есть"></span>Событие есть:
{
status: Literal['running'],
event: {
id: str,
title: str,
action: {
cmd: Literal['play']
entity_type: Literal['playlist', 'cue']
entity_id: int
}
}
}
Example
{
"status": "running",
"event": {
"id": "abe4c633-8e3f-4938-94e2-efd135d993fc",
"title": "holiday",
"action": {
"cmd": "play",
"entity_type": "playlist",
"entity_id": 19
}
}
}

События нет:
{
status: Literal['no_event'],
}
Example
{
"status": "no_event"
}
* '''status''' - Текущий статус расписания. Может принимать значения ‘running’, ‘no_event’.
* '''event''' - Активное событие со всеми параметрами. Присутствует только когда status равен ‘running’.
* '''id''' - Уникальный идентификатор события.
* '''title''' - Название события.
* '''action''' - Действие которое должно быть выполнено для данного события.
* '''cmd''' - Команда для выполнения. Всегда равна ‘play’.
* '''entity_type''' - Тип сущности для воспроизведения. Может принимать значения ‘playlist’, ‘cue’.
* '''entity_id''' - Уникальный идентификатор сущности для воспроизведения.

=== PUB <code>lm/scheduler/do/*/status</code> ===
Публикует текущее активное событие управления цифровым выходом DO1 если оно есть.

PUB <code>lm/scheduler/do/1/status</code><span id="pub-lmschedulerdo2status"></span>PUB <code>lm/scheduler/do/2/status</code><span id="pub-lmschedulerdo3status"></span>PUB <code>lm/scheduler/do/3/status</code>

Payload format<span id="событие-есть-1"></span>Событие есть:
{
status: Literal['running'],
event: {
id: str,
title: str,
action: {
state: Literal[0, 1]
}
}
}
Example
{
"status": "running",
"event": {
"id": "abe4c633-8e3f-4938-94e2-efd135d993fc",
"title": "holiday",
"action": {
"state": 1
}
}
}

События нет:
{
status: Literal['no_event'],
}
Example
{
"status": "no_event"
}
* '''status''' - Текущий статус расписания для DO1. Может принимать значения ‘running’, ‘no_event’.
* '''event''' - Активное событие со всеми параметрами. Присутствует только когда status равен ‘running’.
* '''id''' - Уникальный идентификатор события.
* '''title''' - Название события.
* '''action''' - Действие которое должно быть выполнено для данного события.
* '''state''' - Состояние цифрового выхода. Может принимать значения 0 (выключен) или 1 (включен).

=== SUB <code>lm/settings/datetime/timezone</code> ===
Получает текущую таймзону.

Payload format
{
timezone: str
}
Example
{
"timezone": "Europe/Moscow",
}

=== SUB <code>lm/settings/location/coordinates</code> ===
Получает координаты устройства для расчета солнечного времени.

Payload format
{
latitude: float
longitude: float
}
Example
{
latitude: 56.821019190097616
longitude: 60.59559633825789
}

== 4 Управление устройствами Art-Net ==
Сервис осуществляет мониторинг и управления ArtNet и RDM устройствами.

<span id="pub-lmartnet_devices_management_serviceerror"></span>

=== PUB <code>lm/artnet_devices_management_service/error</code> ===
Публикует ошибки.

Выставляет заголовок '''Correlation data''' если он был установлен в запросе.

Payload format<pre>{
msg: str
data: Any
}</pre>
* '''msg''' - contain error message
* '''data''' - contain related error data

=== PUB <code>lm/artnet_devices_management_service/artnet/devices/changes</code> ===
Публикует вновь созданные/измененные/удаленные ArtNet устройства.

Payload format
{
status: Literal['created', 'updated', 'deleted']
device: {
mac_address: str
ip_address: str
subnet_mask: str
default_gateway: str
dhcp_status: bool
name: str
style: str
firmware_version: str
ports: dict[
int,
{
bind_index: int
is_input: bool
is_output: bool
port_type: Literal[
'DALI',
'ArtNet',
'ADB',
'Colortran_CMX',
'Avab',
'MIDI',
'DMX512',
]
name: str
universe: int
is_rdm_on: bool
physical_port: Optional[int]
out_signal: Optional[Literal['DMX', 'SPI']]
is_data_transmitting: bool
}
]
status: str
dev_mode: Optional[str]
spi_settings: Optional[
{
chip: str
mode: str
period: int
time_high_0: int
time_high_1: int
time_reset: int
gamma: int
bit_mode: str
}
]
dmx_settings: Optional[
{
break_time: int
mab_time: int
chan_time: int
pause_time: int
chan_num: int
}
]
rdm_devices_count: int
}
}

=== PUB <code>lm/artnet_devices_management_service/rdm/devices/changes</code> ===
Публикует вновь созданные/измененные/удаленные RDM устройства.

Payload format
{
status: Literal['created', 'updated', 'deleted']
device: {
uid: str
art_net_device_mac: str
art_net_device_ip: str
port: int
supported_params: dict[str, Any]
}
}
* '''uid''' - Уникальный идентификатор устройства.
* '''art_net_device_mac''' - Mac адрес ArtNet устройства к которому подключено данное rdm устройство.
* '''art_net_device_ip''' - IP адрес ArtNet устройства к которому подключено данное rdm устройство.
* '''port''' - Номер порта ArtNet устройства к которому подключено данное rdm устройство.
* '''supported_params''' - Словарь параметров и их значений.

=== PUB <code>lm/artnet_devices_management_service/cmd_response</code> ===
Публикует результаты выполнения асинхронных команд.

Используется для уведомления о завершении длительных операций, которые выполняются в фоновом режиме. Клиент получает <code>transaction_uid</code> при инициации команды и может отслеживать её статус через данный топик.

Payload format
{
"transaction_uid": "string",
"status": "string"
}
* '''transaction_uid''' - Уникальный идентификатор транзакции, возвращаемый при инициации асинхронной команды
* '''status''' - Статус выполнения команды. Возможные значения: “done”, “error”

Example
{
"transaction_uid": "550e8400-e29b-41d4-a716-446655440000",
"status": "done"
}

== 5 Управление триггерами ==
<span id="pub-lmtrigger_servicetriggertrigger_list"></span>

=== PUB <code>'lm/trigger_service/trigger/trigger_list'</code> ===
Публикует список всех триггеров. Топик всегда содержит актуальный список.

Payload format
[
{
name: str
tr_type: str
params: dict[str, Any]
}
]
* '''name''' - Имя триггера.
* '''tr_type''' - Тип триггера.
* '''params''' - Словарь с параметрами триггера.

Example
[
{
"name": "TriggerFromMqtt",
"tr_type": "RawUDP",
"params": {
"network_type": "udp",
"listen_ip": "0.0.0.0",
"listen_port": "5555",
"data": "any"
}
}
]

=== PUB <code>lm/trigger_service/action/action_list</code> ===
Публикует список всех action. <br />Топик всегда содержит актуальный список.

Payload format
[
{
name: str
action_type: str
params: dict[str, Any]
}
]
* '''name''' - Имя action.
* '''action_type''' - Тип action.
* '''params''' - Словарь с параметрами action.

Example
[
{
"name": "default",
"action_type": "send_trigger_to_mqtt",
"params": {
"topic": "lm/trigger_service/trigger/",
"payload": "",
"retain": false
}
}
]

=== PUB <code>lm/trigger_service/relation_list</code> ===
Публикует список всех связей между триггером и action.

Payload format
[
{
trigger: {
name: str
tr_type: str
params: dict[str, Any]
}
action: {
name: str
action_type: str
params: dict[str, Any]
}
}
]
* '''trigger''' - Словарь с триггером.
* '''action''' - Словарь с action.

Example
[
{
"trigger": {
"name": "TriggerFromMqtt",
"tr_type": "RawUDP",
"params": {
"network_type": "udp",
"listen_ip": "0.0.0.0",
"listen_port": "5555",
"data": "any"
}
},
"action": {
"name": "default",
"action_type": "send_trigger_to_mqtt",
"params": {
"topic": "lm/trigger_service/trigger/",
"payload": "",
"retain": false
}
}
}
]

=== SUB <code>lm/trigger_service/trigger/add</code> ===
Добавляет новый триггер.

На данный момент доступны три типа триггера: <code>RawUDP</code> и <code>ArtNet</code> и <code>Mqtt</code>.

* RawUDP - Срабатывает при получении UDP пакета удовлетворяющего заданным параметрам.
* ArtNet - Срабатывает при получении ArtNet пакета удовлетворяющего заданным параметрам.
* Mqtt - Срабатывает при получении Mqtt сообщения удовлетворяющего заданным параметрам.

Payload format
{
name: str
tr_type: str
params: dict[str, Any]
}
* '''name''' - Имя триггера.
* '''tr_type''' - Тип триггера.
* '''params''' - Словарь с параметрами триггера. Параметры отличаются в зависимости от типа триггера.

Example
{
"name": "TriggerFromMqtt",
"tr_type": "RawUDP",
"params": {
"network_type": "udp",
"listen_ip": "0.0.0.0",
"listen_port": "5555",
"data": "any"
}
}

'''Ожидаемые Параметры'''

Параметры для <u>триггера с типом RawUDP</u>
{
network_type: Literal['udp']
listen_ip: str
listen_port: int
data: str
}
* '''network_type''' - Тип сети. Должен быть ‘udp’.
* '''listen_ip''' - Прослушиваемый ip.
* '''listen_port''' - Прослушиваемый порт.
* '''data''' - Полезная нагрузка. Принимает строку полностью отражающую полезную нагрузку UDP пакета.
Example RawUDP params
{
"network_type": "udp",
"listen_ip": "0.0.0.0",
"listen_port": "5555",
"data": "any"
}

Параметры для <u>триггера с типом ArtNet</u>
{
network_type: Literal['tcp', 'udp']
listen_ip: str
listen_port: int
universe: int
channel: int
min_level: int
max_level: int
}
* '''network_type''' - Тип сети. Принимает значения ‘tcp’ или ‘udp’.
* '''listen_ip''' - Прослушиваемый ip.
* '''listen_port''' - Прослушиваемый порт.
* '''universe''' - Отражает значение параметра subuni из ArtNet пакета.
* '''channel''' - Номер канала в ArtNet пакете.
* '''min_level''' - Минимальное значение в канале для срабатывания триггера.
* '''max_level''' - Максимальное значение в канале для срабатывания триггера.<span id="example-artnet-params"></span>Example ArtNet params
{
"network_type": "udp",
"listen_ip": "0.0.0.0",
"listen_port": "6454",
"universe": 3,
"channel": 5,
"min_level": 1,
"max_level": 124
}

Параметры для <u>триггера с типом Mqtt</u>
{
topic: str
payload: str
}
* '''topic''' - Mqtt топик для отслеживания.
* '''payload''' - Полезная нагрузка mqtt сообщения в виде байт. Должна точно совпадать.<span id="example-mqtt-params"></span>Example Mqtt params
{
"topic": "lm/di/port/1",
"payload": "\x01"
}

=== SUB <code>lm/trigger_service/trigger/delete</code> ===
Удаляет триггер.

<span id="payload-format-4"></span>
=== Payload format ===
{
name: str
}
* '''name''' - Имя триггера.<span id="example-4"></span>Example
{
"name": "TriggerFromMqtt",
}

=== SUB <code>lm/trigger_service/action/add</code> ===
Добавляет новый action.

На данный момент доступны два типа action: <code>send_mqtt_msg_raw</code> и <code>send_trigger_to_mqtt</code>.

* '''send_mqtt_msg_raw''' - Отправляет по mqtt сообщение записанное в параметрах не внося в него никаких изменений.
* '''send_trigger_to_mqtt''' - Отправляет по mqtt сообщение в теле которого находится сработавший триггер.

Payload format
{
name: str
action_type: str
params: dict[str, Any]
}
* '''name''' - Имя action.
* '''action_type''' - Тип action.
* '''params''' - Словарь с параметрами action. Различается в зависимости от типа action.<span id="example-5"></span>Example
{
"name": "default",
"action_type": "send_trigger_to_mqtt",
"params": {
"topic": "lm/trigger_service/trigger/",
"payload": "",
"retain": false
}
}

'''Ожидаемые Параметры'''

Параметры для actions с типом <code>send_trigger_to_mqtt</code> и <code>send_trigger_to_mqtt</code> совпадают.
{
topic: str
payload: str
retain: bool
}
* '''topic''' - Mqtt topic в который будет отправлено сообщение.
* '''payload''' - Mqtt payload. Полезная нагрузка сообщения.
* '''retain''' - Mqtt retain param.

Типа <code>send_trigger_to_mqtt</code> игнорирует поля '''payload''' и '''retain''' но в сообщении они должны присутствовать.

Example params
{
"topic": "lm/trigger_service/trigger/",
"payload": "",
"retain": false
}

=== SUB <code>lm/trigger_service/action/delete</code> ===
Удаляет action.

Payload format
{
name: str
}
* '''name''' - Имя action.

Example
{
"name": "default",
}

=== SUB <code>lm/trigger_service/set_trigger_to_action_relation</code> ===
Создает связь между триггером и action.

Payload format
trigger: {
name: str
tr_type: str
params: dict[str, Any]
}
action: {
name: str
action_type: str
params: dict[str, Any]
}
* '''trigger''' - Словарь с триггером.
* '''action''' - Словарь с action.

Example
{
"trigger": {
"name": "TriggerFromMqtt",
"tr_type": "RawUDP",
"params": {
"network_type": "udp",
"listen_ip": "0.0.0.0",
"listen_port": "5555",
"data": "any"
}
},
"action": {
"name": "default",
"action_type": "send_trigger_to_mqtt",
"params": {
"topic": "lm/trigger_service/trigger/",
"payload": "",
"retain": false
}
}
}

=== SUB <code>lm/trigger_service/delete_trigger_to_action_relation</code> ===
Удаляет связь между триггером и action.

Payload format
trigger: {
name: str
tr_type: str
params: dict[str, Any]
}
action: {
name: str
action_type: str
params: dict[str, Any]
}
* '''trigger''' - Словарь с триггером.
* '''action''' - Словарь с action.

Example
{
"trigger": {
"name": "TriggerFromMqtt",
"tr_type": "RawUDP",
"params": {
"network_type": "udp",
"listen_ip": "0.0.0.0",
"listen_port": "5555",
"data": "any"
}
},
"action": {
"name": "default",
"action_type": "send_trigger_to_mqtt",
"params": {
"topic": "lm/trigger_service/trigger/",
"payload": "",
"retain": false
}
}
}

=== PUB <code>lm/trigger_service/error</code> ===
Публикует ошибки.

Выставляет заголовок '''Correlation data''' если он был установлен в запросе.

Payload format<pre>{
msg: str
data: Any
}</pre>
* '''msg''' - contain error message
* '''data''' - contain related error data

=== SUB <code>lm/trigger_service/delete_trigger_with_related_actions</code> ===
Удаляет триггер и все связанные с ним действия.

Payload format
{
name: str
}
* '''name''' - Имя триггера.<span id="example-10"></span>Example
{
"name": "TriggerFromMqtt",
}

== 6. Настройки системы ==
Сервис осуществляет конфигурирование системных настроек ОС.

=== PUB <code>lm/system_configurator/error</code> ===
Публикует ошибки.

Выставляет заголовок '''Correlation data''' если он был установлен в запросе.

Payload format<pre>{
msg: str
data: Any
}</pre>
* '''msg''' - contain error message
* '''data''' - contain related error data

=== PUB <code>lm/system_settings/external_access/certificates</code> ===
Публикует список всех x509 сертификатов.<br />Топик всегда содержит актуальный список.

Payload format
[
{
name: str
cert_type: str
public_bytes: str
params: dict[str, Any]
}
]
* '''name''' - Имя сертификата.
* '''cert_type''' - Тип сертификата. Может принимать значения ‘csr’ или ‘certificate’
* '''params''' - Словарь с параметрами сертификата. Набор параметров отличается в зависимости от [[#certificate-params-format|типа]] сертификата.

Example
[
{
"cert_type": "certificate",
"name": "cert_name",
"params": {
"issuer": "OU=test ou,CN=domain.com,O=test o,L=123,ST=st,C=UA",
"san": "IP=192.168.0.3",
"subject": "OU=test ou,CN=domain.com,O=test o,L=123,ST=st,C=UA",
"valid_from": "1664440221.0",
"valid_to": "1759048221.0"
},
"public_bytes": "-----BEGIN CERTIFICATE-----\n"
"-----END CERTIFICATE-----\n"}]
}
]

=== PUB <code>lm/system_settings/external_access/web_access_settings</code> ===
Публикует список настроек web доступа.<br />Топик всегда содержит актуальный список.

Payload format
{
http_port: int
https_port: int
is_https_enabled: bool
is_http_redirected: bool
cert_name: str
}
* '''http_port''' - Http порт. По умолчанию 80.
* '''https_port''' - Https порт. По умолчанию 443.
* '''is_https_enabled''' - Индикатор включен ли https.
* '''is_http_redirected''' - Индикатор включена ли переадресация http to https.
* '''cert_name''' - Имя сертификата сервера.

Example
{
"http_port": 80,
"https_port": 443,
"is_https_enabled": false,
"is_http_redirected": true,
"cert_name": ""
}

=== SUB <code>lm/system_settings/external_access/change_web_access_settings</code> ===
Меняет настройки web доступа.

Payload format
{
http_port: int
https_port: int
is_https_enabled: bool
is_http_redirected: bool
cert_name: str
}
* '''http_port''' - Http порт. По умолчанию 80.
* '''https_port''' - Https порт. По умолчанию 443.
* '''is_https_enabled''' - Индикатор включен ли https.
* '''is_http_redirected''' - Индикатор включена ли переадресация http to https.
* '''cert_name''' - Имя сертификата сервера.

Example
{
"http_port": 80,
"https_port": 443,
"is_https_enabled": false,
"is_http_redirected": true,
"cert_name": ""
}

=== SUB <code>lm/system_settings/certificates/upload_certificate</code> ===
Загружает сертификат и его ключ для дальнейшего использования в настройках доступа.

Payload format
{
cert_name: str
certificate: bytes
key: bytes
intermediate: bytes
}
* '''cert_name''' - Читаемое имя сертификата.
* '''certificate''' - x.509 сертификат в pem формате.
* '''key''' - Приватный ключ в pem формате.
* '''intermediate''' - (Опционально) промежуточный сертификат.

=== SUB <code>lm/system_settings/certificates/upload_certificate_corresponding_csr</code> ===
Загружает сертификат относящийся к сформированному ранее csr.

Payload format
{
cert_name: str
certificate: bytes
}
* '''cert_name''' - Имя csr сертификата.
* '''certificate''' - x.509 сертификат в pem формате.

=== SUB <code>lm/system_settings/certificates/delete_certificate</code> ===
Удаляет сертификат и все связанные с ним файлы.

Payload format
{
id: int
name: str
cert_type: str
public_bytes: str
params: dict[str, Any]
}
* '''id''' - (Опционально) Идентификатор сертификата.
* '''name''' - Имя сертификата.
* '''cert_type''' - Тип сертификата. Может принимать значения ‘csr’ или ‘certificate’
* '''public_bytes''' - Открытый ключ сертификата.
* '''params''' - Словарь с параметрами сертификата. Набор параметров отличается в зависимости от [[#certificate-params-format|типа]] сертификата.<span id="example-4"></span>

Example
{
"cert_type": "certificate",
"name": "cert_name",
"params": {
"issuer": "OU=test ou,CN=domain.com,O=test o,L=123,ST=st,C=UA",
"san": "IP=192.168.0.3",
"subject": "OU=test ou,CN=domain.com,O=test o,L=123,ST=st,C=UA",
"valid_from": "1664440221.0",
"valid_to": "1759048221.0"
},
"public_bytes": "-----BEGIN CERTIFICATE-----\n"
"-----END CERTIFICATE-----\n"}]

=== SUB <code>lm/system_settings/certificates/generate_csr</code> ===
Генерирует Certificate Signing Request.

Payload format
{
cert_name: str
cert_type: str
key_size: int
subject: str
san: str
}
* '''cert_name''' - Имя сертификата.
* '''cert_type''' - Тип сертификата. Может принимать значения ‘csr’ или ‘certificate’
* '''key_size''' - Размер ключа в байтах. Принимает значения 2048 иои 4096.
* '''subject''' - Строка в формате rfc4514.
* '''san''' - Стока представляющее расширение SubjectAltName. Принимаются только ip адреса или dns имена идущие подряд через запятую без пробелов с префиксами <code>IP=</code> или <code>DNS=</code>.<span id="example-5"></span>

Example
{
"cert_name": "ss_cert23",
"cert_type": "certificate",
"key_size": 2048,
"subject": "OU=test ou,CN=domain.com,O=test o,L=123,ST=st,C=UA",
"san": "IP=192.168.0.3,DNS=domain.com"
}

=== SUB <code>lm/system_settings/certificates/generate_self_sign_certificate</code> ===
Генерирует самоподписанный сертификат.

Payload format
{
cert_name: str
cert_type: str
key_size: int
subject: str
san: str
}
* '''cert_name''' - Имя сертификата.
* '''cert_type''' - Тип сертификата. Может принимать значения ‘csr’ или ‘certificate’.
* '''key_size''' - Размер ключа в байтах. Принимает значения 2048 иои 2096.
* '''subject''' - Строка в формате rfc4514.
* '''san''' - Стока представляющее расширение SubjectAltName. Принимаются только ip адреса или dns имена идущие подряд через запятую без пробелов с префиксами <code>IP=</code> или <code>DNS=</code>.

Example
{
"cert_name": "ss_cert23",
"cert_type": "certificate",
"key_size": 2048,
"subject": "OU=test ou,CN=domain.com,O=test o,L=123,ST=st,C=UA",
"san": "IP=192.168.0.3,DNS=domain.com"
}

=== PUB <code>lm/system_settings/network/interfaces/wired/eth*/statistics</code> ===
<code>PUB lm/system_settings/network/interfaces/wired/eth0/statistics</code>

<code>PUB lm/system_settings/network/interfaces/wired/eth1/statistics</code>

Публикует информацию о проводном интерфейсе ethernet каждые 10 секунд.

Payload format
{
status: str
ip_assign_method: Literal['manual', 'dhcp']
ip: str
netmask: str
gateway: str
dns_assign_method: Literal['manual', 'dhcp']
dns_servers: list[str]
mac_address: str
}
* '''status''' - Статус интерфейса. Может быть <code>up</code> или <code>down</code>.
* '''ip_assign_method''' - Способ назначения ip адреса. Может быть <code>manual</code> или <code>dhcp</code>.
* '''ip''' - IP адрес интерфейса.
* '''netmask''' - Маска интерфейса.
* '''gateway''' - Шлюз по умолчанию.
* '''dns_assign_method''' - Способ назначения dns серверов. Может быть <code>manual</code> или <code>dhcp</code>.
* '''dns_servers''' - Список dns серверов.
* '''mac_address''' - MAC адрес интерфейса.

Example
{
"status": "up",
"ip_assign_method": "manual",
"ip": "192.168.0.205",
"netmask": "255.255.255.0",
"gateway": "192.168.0.1",
"dns_assign_method": "manual",
"dns_servers": ["8.8.8.8", "8.8.4.4"],
"mac_address": "e4:5f:01:a8:e0:6c"
}

=== SUB <code>lm/system_settings/network/interfaces/wired/eth*/set_ip_credential</code> ===
SUB <code>lm/system_settings/network/interfaces/wired/eth0/set_ip_credential</code><span id="sub-lmsystem_settingsnetworkinterfaceswiredeth1set_ip_credential"></span>SUB <code>lm/system_settings/network/interfaces/wired/eth1/set_ip_credential</code>

Устанавливает ip адресацию и шлюз на интерфейс.

Поддерживает статическое назначение ip и назначение через dhcp.

<span id="payload-format-10"></span>
=== Payload format ===

Статическая адресация:
{
ip_assign_method: Literal['manual']
static_ip: str
static_netmask: str
static_gateway: str
}
* '''ip_assign_method''' - Способ назначения ip адреса. Должно быть <code>manual</code>.
* '''static_ip''' - IPv4 адрес интерфейса
* '''static_netmask''' - Сетевая маска интерфейса.
* '''static_gateway''' - Шлюз по умолчанию.

Example
{
"ip_assign_method": "manual",
"static_ip": "192.168.0.205",
"static_netmask": "255.255.255.0",
"static_gateway": "192.168.0.1"
}

Динамическая адресация
{
ip_assign_method: Literal['dhcp']
}
* '''ip_assign_method''' - Способ назначения ip адреса. Должно быть <code>dhcp</code>.
<span id="example-9"></span>Example
{
"ip_assign_method": "dhcp"
}

=== SUB <code>lm/system_settings/network/interfaces/wired/eth*/set_dns_credential</code> ===
SUB <code>lm/system_settings/network/interfaces/wired/eth0/set_dns_credential</code>

SUB <code>lm/system_settings/network/interfaces/wired/eth1/set_dns_credential</code>

Назначение dns серверов на интерфейс.

Поддерживает статическое и динамическое (dhcp) назначение dns серверов.

Payload format

Статическое назначение:
{
dns_assign_method: Literal['manual']
static_dns_servers: list[str]
}
* '''dns_assign_method''' - Способ назначения dns серверов. Должно быть <code>manual</code>.
* '''static_dns_servers''' - Список DNS серверов.<span id="example-10"></span>Example
{
"dns_assign_method": "manual",
"static_dns_servers": ["8.8.8.8", "8.8.4.4"]
}
Динамическое назначение:
{
dns_assign_method: Literal['dhcp']
}
* '''dns_assign_method''' - Способ назначения dns серверов. Должно быть <code>dhcp</code>.

Example
{
"dns_assign_method": "dhcp"
}

=== PUB <code>lm/system_settings/network/interfaces/modem/statistics</code> ===
Публикует информацию о модемном интерфейсе каждые 10 секунд.

Payload format
{
ip_assign_method: Literal['manual', 'dhcp']
ip: str
netmask: str
gateway: str
dns_assign_method: Literal['manual', 'dhcp']
dns_servers: list[str]
apn: {
apn: str,
username: str,
password: str,
}
modem_status: {
state: str,
state_failed_reason: str,
power_state: str,
signal_quality: int,
access_technologies: list[str]
}
}
* '''status''' - Статус интерфейса. Может быть <code>up</code> или <code>down</code>.
* '''ip_assign_method''' - Способ назначения ip адреса. Может быть <code>manual</code> или <code>dhcp</code>.
* '''netmask''' - IP адрес интерфейса.
* '''gateway''' - Шлюз по умолчанию.
* '''dns_assign_method''' - Способ назначения dns серверов. Может быть <code>manual</code> или <code>dhcp</code>.
* '''dns_servers''' - Список dns серверов.
* '''apn''':
** '''apn''': APN сервер.
** '''username''': Имя пользователя для apn сервера.
** '''password''': Пароль для apn сервера.
* '''modem_status''':
** '''state''': Состояние подключения.
** '''state_failed_reason''': Причина ошибки если таковая есть.
** '''power_state''': Состояние питания модема.
** '''signal_quality''': Качество сигнала в процентах.
** '''access_technologies''': Список текущих режимов (LTE, UMTS и т.д.).

Example
{
"status": "up",
"ip_assign_method": "manual",
"ip": "192.168.0.205",
"netmask": "255.255.255.0",
"gateway": "192.168.0.1",
"dns_assign_method": "manual",
"dns_servers": ["8.8.8.8", "8.8.4.4"],
"apn": {
"apn": "internet.mts.ru",
"username": "mts",
"password": "mts"
},
"modem_status": {
"state": "connected",
"state_failed_reason": "--",
"power_state": "on",
"signal_quality": 81,
"access_technologies": ["LTE"]
}
}

=== SUB <code>lm/system_settings/network/interfaces/modem/set_ip_credential</code> ===
Устанавливает ip адресацию и шлюз на интерфейс.

Поддерживает статическое назначение ip и назначение через dhcp.

Payload format

Статическая адресация
{
ip_assign_method: Literal['manual']
static_ip: str
static_netmask: str
static_gateway: str
}
* '''ip_assign_method''' - Способ назначения ip адреса. Должно быть <code>manual</code>.
* '''static_ip''' - IPv4 адрес интерфейса
* '''static_netmask''' - Сетевая маска интерфейса.
* '''static_gateway''' - Шлюз по умолчанию.<span id="example-13"></span>Example
{
"ip_assign_method": "manual",
"static_ip": "192.168.0.205",
"static_netmask": "255.255.255.0",
"static_gateway": "192.168.0.1"
}

Динамическая адресация
{
ip_assign_method: Literal['dhcp']
}
* '''ip_assign_method''' - Способ назначения ip адреса. Должно быть <code>dhcp</code>.
<span id="example-14"></span>Example
{
"ip_assign_method": "dhcp"
}

=== SUB <code>lm/system_settings/network/interfaces/modem/set_dns_credential</code> ===
Назначение dns серверов на интерфейс.

Поддерживает статическое и динамическое (dhcp) назначение dns серверов.

Payload format

Статическое назначение:
{
dns_assign_method: Literal['manual']
static_dns_servers: list[str]
}
* '''dns_assign_method''' - Способ назначения dns серверов. Должно быть <code>manual</code>.
* '''static_dns_servers''' - Список DNS серверов.

Example
{
"dns_assign_method": "manual",
"static_dns_servers": ["8.8.8.8", "8.8.4.4"]
}

Динамическое назначение
{
dns_assign_method: Literal['dhcp']
}
* '''dns_assign_method''' - Способ назначения dns серверов. Должно быть <code>dhcp</code>.<span id="example-16"></span>

Example
{
"dns_assign_method": "dhcp"
}

=== SUB <code>lm/system_settings/network/interfaces/modem/set_apn_credential</code> ===
Назначение настроек apn на интерфейс.

Поддерживается только статическое назначение.

Payload format

Статическое назначение:
{
apn: str
username: str
password: str
}
* '''apn''' - APN сервер.
* '''username''' - Имя пользователя если есть либо пустая строка.
* '''password''' - Пароль если есть либо пустая строка.

Example
{
"apn": "internet.mts.ru",
"username": "mts",
"password": "mts"
}

=== PUB <code>lm/system_settings/datetime/rtc_status</code> ===
Публикует статус rtc модуля

Payload format
{
is_active: bool
}
* '''is_active''' - Активен ли rtc модуль.

Example
{
"is_active": true,
}

=== SUB <code>lm/system_settings/datetime</code> ===
Принимает [[#base-format-for-command-payload|команды]] на изменение даты и времени конфигурации системы.

Список принимаемых команд

'''Set Date'''

Description: > Set system date.

Values:

command: str > set_date

data: dict > date: str - date in format ‘Y:M:D’

Example:<br /><code>{'command': 'set_date', 'data': {'date': '1970:01:01'}}</code>

'''Set Time'''

Description: > Set system time.

Values:

command: str > set_time

data: dict > time: str - time in format ‘HH:mm:ss’

Example:<br /><code>{'command': 'set_time', 'data': {'time': '13:00:00'}}</code>

'''Set Datetime'''

Description: > Set system date and time.

Values:

command: str > set_datetime

data: dict > datetime: str - time in format ‘Y:M:D HH:mm:ss’

Example:<br /><code>{'command': 'set_datetime', 'data': {'datetime': '1970:01:01 13:00:00'}}</code>

'''Change Ntp Status'''

Description: > Enable or disable ntp synchronization.

Values:

command: str > change_ntp_status

data: dict > ntp: bool - is ntp sync enable

Example:<br /><code>{'command': 'change_ntp_status', 'data': {'ntp': True}}</code>

'''Set Ntp Servers'''

Description: > Set ntp servers. > Generate ntp config, replace it then restart systemd-timesyncd.service > Accepts list of ip addresses or domain names

Values:

command: str > set_ntp_servers

data: dict > ntp_servers: list[str] - list of servers ip addresses or dns names

Example:<br /><code>{'command': 'set_ntp_servers', 'data': {'ntp_servers': ['192.168.0.2', 'ntp1.stratum2.com']}}</code>

'''Set timezone'''

Description: > Set system timezone.

Values:

command: str > set_timezone

data: dict > timezone: str - timezone name

Example:<br /><code>{'command': 'set_timezone', 'data': {'timezone': 'Europe/London'}}</code>

Base format for command payload
{
'command': str
'data': dict[str, Any]
}
* '''command''' - command name

* '''data''' - any data for command

Example:

<code>{'command': 'set_ip', 'data': {'ifname': 'eth0', 'ip': '192.168.0.1'}}</code>

=== SUB <code>lm/system_settings/power_control</code> ===
Управляет питанием устройства

Payload format
{
command: str
delay: int
}
* '''command''' - Команда управления питанием. Может принимать значения “reboot” и “shutdown”.
* '''delay''' - Задержка срабатывания команды в минутах.

Example
{
"command": "reboot",
"delay": "0",
}

'''Certificate params format'''

Парамеры сертификата отличаются в зависимости от его типа. В данный момент поддерживается два типа сертификата x509: <code>certificate</code> и <code>csr</code>.

x509 certificate params format
{
subject: str
san: str
issuer: str
valid_from: float
valid_to: float
}
* '''subject''' - Строка в формате rfc4514.
* '''san''' - Стока представляющее расширение SubjectAltName. Принимаются только ip адреса или dns имена идущие подряд через запятую без пробелов с префиксами <code>IP=</code> или <code>DNS=</code>.
* '''issuer''' - Строка в формате rfc4514.
* '''valid_from''' - Дата с которой сертификат действителен. Формат Posix timestamp.
* '''valid_to''' - Дата по которую сертификат действителен. Формат Posix timestamp.

Example
{
"issuer": "OU=test ou,CN=domain.com,O=test o,L=123,ST=st,C=UA",
"san": "IP=192.168.0.3",
"subject": "OU=test ou,CN=domain.com,O=test o,L=123,ST=st,C=UA",
"valid_from": "1664440221.0",
"valid_to": "1759048221.0"
}

'''x509 csr params format'''
{
subject: str
san: str
}
* '''subject''' - Строка в формате rfc4514.
* '''san''' - Стока представляющее расширение SubjectAltName. Принимаются только ip адреса или dns имена идущие подряд через запятую без пробелов с префиксами <code>IP=</code> или <code>DNS=</code>.

Example
{ “subject”: “OU=test ou,CN=domain.com,O=test o,L=123,ST=st,C=UA”, “san”: “IP=192.168.0.3”, }

== 7. Управление Di Do интерфейсами плеера ==

=== PUB <code>lm/di/port/*</code> ===
<span id="pub-lmdiport0-player-v1-only"></span>PUB <code>lm/di/port/0</code> (player V1 only)<span id="pub-lmdiport1"></span>PUB <code>lm/di/port/1</code><span id="pub-lmdiport2-player-v2-only"></span>PUB <code>lm/di/port/2</code> (player V2 only)<span id="pub-lmdiport3-player-v2-only"></span>PUB <code>lm/di/port/3</code> (player V2 only)

Публикует состояние di порта

* '''di_port_number''' - Номер di порта.

Payload format
int
Example
1
* '''int''' - Статус Di порта. 1 - активен, 0 - неактивен.

<span id="pub-lmdoport0-player-v1-only"></span>

=== PUB <code>lm/do/port/*</code> ===
PUB <code>lm/do/port/0</code> (player V1 only)

PUB <code>lm/do/port/1</code><span id="pub-lmdoport2-player-v2-only"></span>PUB <code>lm/do/port/2</code> (player V2 only)<span id="pub-lmdoport3-player-v2-only"></span>PUB <code>lm/do/port/3</code> (player V2 only)

Публикует состояние do порта

* '''do_port_number''' - Номер do порта.

Payload format
int
Example
1
* '''int''' - Статус DO порта. 1 - активен, 0 - неактивен.

=== SUB <code>lm/do/change_state</code> ===
Принимает команды для изменения состояния DO порта.

Payload command format
{
"port": int,
"state": int,
}
Example
{
"port": 1,
"state": 1,
}
* '''port''' - Номер do порта.
* '''state''' - Статус порта. 1 - активен, 0 - неактивен.

== 8. Управление RS485 интерфейсами плеера ==
<span id="pub-lmserialport_controllererror"></span>

=== PUB <code>lm/serialport_controller/error</code> ===
Публикует ошибки.

Выставляет заголовок '''Correlation data''' если он был установлен в запросе.

Payload format<pre>{
msg: str
data: Any
}</pre>
* '''msg''' - contain error message
* '''data''' - contain related error data

=== PUB <code>lm/serialport_controller/ports</code> ===
Публикует список rs485 портов.

Payload format
[
{
name: str
mode: Literal['rs485', 'dmxOut']
}
]
* '''name''' - Имя порта.
* '''mode''' - Предназначение порта.

Example
[
{
"name": "port1",
"mode": "rs485",
},
{
"name": "port2",
"mode": "rs485",
},
{
"name": "port3",
"mode": "dmxOut",
},
{
"name": "port4",
"mode": "dmxOut",
}
]

=== SUB <code>lm/serialport_controller/ports/change_mode</code> ===
Меняет предназначение порта.

Payload format
{
name: str
mode: Literal['rs485', 'dmxOut']
}
* '''name''' - Имя порта.
* '''mode''' - Предназначение порта.

Example
{
"name": "port1",
"mode": "rs485",
}

== 9. Управление светодиодами плеера ==
<span id="pub-lmledsstate"></span>

=== PUB <code>'lm/leds/state'</code> ===
Публикует состояние диодов rs485 портов

Payload format
{
Port1: {
green: bool,
red: bool,
},
Port2: {
green: bool,
red: bool,
},
Port3: {
green: bool,
red: bool,
},
Port4: {
green: bool,
red: bool,
},
}

Example
{
"Port1": {
"green": true,
"red": true,
},
"Port2": {
"green": true,
"red": true,
},
"Port3": {
"green": true,
"red": true,
},
"Port4": {
"green": true,
"red": true,
},
}
* '''green''' - Статус зеленого светодиода.
* '''red''' - Статус красного светодиода.

=== SUB <code>lm/leds/change_state</code> ===
Принимает команды для изменения состояния диодов у rs485 порта.

Payload command format
{
pub port: Literal['Port1', 'Port2', 'Port3', 'Port4'],
green: bool,
red: bool,
}

Example
{
"port": "Port1",
"green": true,
"red": false,
}
* '''port''' - Имя rs485 порта.
* '''green''' - Статус зеленого светодиода.
* '''red''' - Статус красного светодиода.

=== SUB <code>lm/leds/blink</code> ===
Принимает команды для мигания всех светодиодов на всех rs485 портах.

Payload format
{
times: int,
interval: int,
}
Example
{
"times": 5,
"interval": 1000
}
* '''times''' - Количество миганий (от 1 до 255).
* '''interval''' - Интервал между миганиями в миллисекундах.

== 10. Обновление программного обеспечения плеера ==
<span id="pub-lmupdate_serviceversionversion_list"></span>

=== PUB <code>lm/update_service/version/version_list</code> ===
Публикует список версий всех модулей. Топик всегда содержит актуальный список.

Payload format<pre>[
{
id: int
version: str
subversion: Optional[str]
module: str
description: Optional[str]
}
]</pre>
* '''id''' - version id
* '''version''' - version number
* '''subversion''' - (Optional) subversion.
* '''module''' - module name
* '''description''' - (Optional) description

Example
[
{
"id": 1,
"version": "20",
"subversion": null,
"module": "frontend",
"description": null
}
]

=== PUB <code>lm/update_service/update/update_list'</code> ===
Публикует список обновлений. Топик всегда содержит актуальный список.

Payload format<pre>[
{
id: int
version: str
status: str
filename: Optional[str]
update_path: str
extracted_path: Optional[str]
backup_path: Optional[str]
description: Optional[str]
}
]</pre>
* '''id''' - update id.
* '''version''' - update version.
* '''status''' - update status.
* '''filename''' - (Optional) update filename.
* '''update_path''' - path to update file.
* '''extracted_path''' - path to extracted files.
* '''backup_path''' - (Optional) update version.
* '''description''' - (Optional) description.

Example
[
{
"id": 1,
"version": "2022",
"status": "installed",
"filename": "lmp_2022.update",
"update_path": "/home/lightmaster/lightmaster/updater/lmp_2022.update",
"extracted_path": "/home/lightmaster/lightmaster/updates_store/lmp_2022",
"backup_path": "/home/lightmaster/lightmaster/backups_store/20220519181452_lmp_v0_full_backup",
"description": "A error occurred during installation update. Installation filed. None"
}
]

=== SUB <code>lm/update_service/update/add_update</code> ===
Добавляет обновление в базу.

Payload format<pre>{
file: str
}</pre>
* '''file: str''' - путь до файла обновления
<span id="example-2"></span>Example
{"file": "/home/lightmaster/projects/wess-group/lightmaster/updater/lmp_2022.update"}

=== SUB <code>lm/update_service/update/check_update</code> ===
Проверяет совместимость обновления.

Payload format<pre>{
id: int
}</pre>
* '''id''' - id обновления

Example
{'id': 5}
<span id="sub-lmupdate_serviceupdateinitial_update"></span>

=== SUB <code>lm/update_service/update/initial_update</code> ===
Совмещает добавление обновления в базу и его проверку.

Payload format<pre>{
file: str
}</pre>
* '''file: str''' - путь до файла обновления

Example
{"file": "/home/lightmaster/projects/wess-group/lightmaster/updater/lmp_2022.update"}

=== SUB <code>lm/update_service/update/install_update</code> ===
Устанавливает обновление

Payload format<pre>{
id: int
}</pre>
* '''id''' - id обновления

Example
{'id': 5}

=== SUB <code>lm/update_service/update/restore_update</code> ===
Откатывает обновление на предыдущую версию.

Payload format<pre>{
id: int
}</pre>
* '''id''' - id обновления

Example
{'id': 5}

=== SUB <code>lm/update_service/update/delete_update</code> ===
Удаляет обновление и все связанные с ним файлы.

Payload format<pre>{
id: int
}</pre>
* '''id''' - id обновления

Example
{'id': 5}

=== SUB <code>lm/update_service/version/get_versions_list</code> ===
Запрос на публикацию списка версий всех модулей.<br />

Публикация происходит в топик <code>lm/update_service/version/get_versions_list/response</code>

В заголовок запроса могут быть включены необязательные поля:

* Correlation data
* Response topic

'''Corelation data''' любой уникальный идентификатор запроса. Зеркально устанавливается в публикуемый ответ и служит для идентификации ответа со стороны клиента.

'''Response topic''' если установлен то ответ публикуется в указанный топик вместо стандартного.

=== PUB <code>lm/update_service/version/get_versions_list/response</code> ===
Публикует ответ на запрос из топика <code>lm/update_service/version/get_versions_list</code>.

Выставляет заголовок '''Correlation data''' если он был установлен в запросе.

Payload format<pre>[
{
id: int
version: str
subversion: Optional[str]
module: str
description: Optional[str]
}
]</pre>
* '''id''' - version id
* '''version''' - version number
* '''subversion''' - (Optional) subversion.
* '''module''' - module name
* '''description''' - (Optional) description

Example
[
{
"id": 1,
"version": "20",
"subversion": null,
"module": "frontend",
"description": null
}
]

=== SUB <code>lm/update_service/version/get_module_version</code> ===
Публикует версию конкретного модуля.

Публикация происходит в топик <code>lm/update_service/version/get_module_version/response</code>

В заголовок запроса могут быть включены необязательные поля:

* Correlation data
* Response topic

'''Corelation data''' любой уникальный идентификатор запроса. Зеркально устанавливается в публикуемый ответ и служит для идентификации ответа со стороны клиента.

'''Response topic''' если установлен то ответ публикуется в указанный топик вместо стандартного.

Payload format<pre>{
module: str
}</pre>
* '''module''' - название модуля

Example
{'module': 'update_service'}

=== PUB <code>lm/update_service/version/get_module_version/response</code> ===
Публикует ответ на запрос из топика <code>lm/update_service/version/get_module_version</code>.

Выставляет заголовок '''Correlation data''' если он был установлен в запросе.

Payload format<pre>{
id: int
version: str
subversion: Optional[str]
module: str
description: Optional[str]
}</pre>
* '''id''' - version id
* '''version''' - version number
* '''subversion''' - (Optional) subversion.
* '''module''' - module name
* '''description''' - (Optional) description

Example
{
"id": 1,
"version": "20",
"subversion": null,
"module": "frontend",
"description": null
}

=== SUB <code>lm/update_service/update/get_updates_list</code> ===
Запрос на публикацию списка всех обновлений добавленных в базу.

Публикация происходит в ветку <code>lm/update_service/update/get_updates_list/response</code>

В заголовок запроса могут быть включены необязательные поля:

* Correlation data
* Response topic

'''Corelation data''' любой уникальный идентификатор запроса. Зеркально устанавливается в публикуемый ответ и служит для идентификации ответа со стороны клиента.

'''Response topic''' если установлен то ответ публикуется в указанный топик вместо стандартного.

=== PUB <code>lm/update_service/update/get_updates_list/response</code> ===
Публикует ответ на запрос из топика <code>lm/update_service/update/get_updates_list</code>.

Выставляет заголовок '''Correlation data''' если он был установлен в запросе.

Payload format<pre>[
{
id: int
version: str
status: str
filename: Optional[str]
update_path: str
extracted_path: Optional[str]
backup_path: Optional[str]
description: Optional[str]
}
]</pre>
* '''id''' - update id.
* '''version''' - update version.
* '''status''' - update status.
* '''filename''' - (Optional) update filename.
* '''update_path''' - path to update file.
* '''extracted_path''' - path to extracted files.
* '''backup_path''' - (Optional) update version.
* '''description''' - (Optional) description.

Example
[
{
"id": 1,
"version": "2022",
"status": "installed",
"filename": "lmp_2022.update",
"update_path": "/home/lightmaster/lightmaster/updater/lmp_2022.update",
"extracted_path": "/home/lightmaster/lightmaster/updates_store/lmp_2022",
"backup_path": "/home/lightmaster/lightmaster/backups_store/20220519181452_lmp_v0_full_backup",
"description": "A error occurred during installation update. Installation filed. None"
}
]

=== PUB <code>lm/update_service/error</code> ===
Публикует ошибки.

Выставляет заголовок '''Correlation data''' если он был установлен в запросе.

Payload format<pre>{
msg: str
data: Any
}</pre>
* '''msg''' - contain error message
* '''data''' - contain related error data

2025-06-09T04:08:50Z

LightStream: Отступы

LS Player MQTT API

2025-06-09T04:07:59Z

LightStream: Отступы