Skip to content

Commit

Permalink
Update web.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Цуркан Алексей Владимирович committed Mar 18, 2024
1 parent a7abf4a commit 622be70
Showing 1 changed file with 70 additions and 75 deletions.
145 changes: 70 additions & 75 deletions web.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
в разработке

# SLS. Интерфейс управления

Основной инструмент управления шлюзом SLS - это его веб-интерфейс. Рассмотрим в подробностях каждый его пунктик.
Expand All @@ -14,37 +12,37 @@

## Структура меню

- SLS
- UI
- Objects
- Zigbee
- Devices
- Join
- Map
- Config
- Reset to Default
- Soft Reset
- Start BSL
- Log
- Settings
- Network
- Time & Location
- Link
- Serial
- Services
- Users
- Hardware
- Help
- [SLS](/web.md#info)
- [UI](/web.md#ui)
- [Objects](/web.md#Objects)
- [Zigbee](/web.md#Zigbee)
- [Devices](/web.md#Devices)
- [Join](/web.md#join)
- [Map](/web.md#map)
- [Config](/web.md#Config)
- [Reset to Default](/web.md#reset-to-default)
- [Soft Reset](/web.md#Soft-Reset)
- [Start BSL](/web.md#Start-BSL)
- [Log](/web.md#log)
- [Settings](/web.md#Settings)
- [Network](/web.md#Network)
- [Time & Location](/web.md#time--location)
- [Link](/web.md#Link)
- [Serial](/web.md#Serial)
- [Services](/web.md#Services)
- [Users](/web.md#Users)
- [Hardware](/web.md#Hardware)
- [Help](/web.md#Help)
- Docs
- Telegram (Support, discussions)
- Supported devices
- Actions
- Files
- Backup
- Update Firmware
- Save
- Reboot System
- Logout
- [Actions](/web.md#Actions)
- [Files](/web.md#Files)
- [Backup](/web.md#Backup)
- [Update Firmware](/web.md#Update-Firmware)
- [Save](/web.md#Save)
- [Reboot System](/web.md#Reboot-System)
- [Logout](/web.md#Logout)

## Info

Expand Down Expand Up @@ -101,19 +99,19 @@
- **Current TimeZone**: часовой пояс (например, UTC+5:00).
- **Current NTP server**: сервер точного времени (например, pool.ntp.org).

_TODO: здесь будет видео с обзором данной вкладки_
[Видео-обзор главной страницы](https://youtu.be/VaNktA-VDPY)

## UI

Шлюз SLS позволяет пользователю создать свой, альтернативный, интерфейс. Например, такой:
Шлюз SLS позволяет пользователю создать свой, альтернативный, [интерфейс](/ui.md). Например, такой:

<img src="/img/web_ui_mobile.png" width="18%"> <img src="/img/web_ui_pc.png" width="78%">

_TODO: здесь будет ссылка на статью и видео с подробным разбором создания собственного UI_

## Objects

Объекты - это универсальная сущность для хранения и обмена данными между подсистемами шлюза, например между скриптами LUA. Здесь находятся инструменты для управления объектами:
[Объекты](/objects.md) - это универсальная сущность для хранения и обмена данными между подсистемами шлюза, например между скриптами LUA. Здесь находятся инструменты для управления объектами:

![](/img/web_objects.png)

Expand Down Expand Up @@ -152,21 +150,19 @@ _TODO: здесь будет ссылка на статью и видео с п
- **Script**: имя скрипта, привязанного к объекту - запускается при изменении значения.
- **Run on Write**: флаг запуска при каждой записи значения в объект, даже если оно не изменилось

_TODO: здесь будет видео с обзором данной вкладки_

_TODO: здесь будет ссылка на статью и видео с подробным разбором работы с объектами._
[Видео-обзор меню Objects](https://youtu.be/Q6a_vlqlDCo)

## Zigbee

Здесь собраны инструменты для работы с zigbee модулем. Структура меню:

- Devices
- Join
- Map
- Config
- Reset to Default
- Soft Reset
- Start BSL
- [Devices](/web.md#Devices)
- [Join](/web.md#join)
- [Map](/web.md#map)
- [Config](/web.md#Config)
- [Reset to Default](/web.md#reset-to-default)
- [Soft Reset](/web.md#Soft-Reset)
- [Start BSL](/web.md#Start-BSL)

### Devices

Expand Down Expand Up @@ -240,22 +236,22 @@ _TODO: здесь будет ссылка на статью и видео с п

Возле каждого значения (`Value`) состояния есть кнопки: `Get` - выполнить команду get в конвертере, если она поддерживается, устройство вернет новое значение; `Set` - установить значение состояние вручную, если оно доступно для записи, новое значение будет записано в устройство.

Также, на этой вкладке настраиваются автоматизации **Simple Bind**. На картинке видно правило SB напротив состояния `occupancy`. Если коротко, то правило выполняется при каждом изменении состояния.

_TODO: здесь будет ссылка на статью и видео о SB_
Также, на этой вкладке настраиваются автоматизации **[Simple Bind](/simplebind.md)**. На картинке видно правило SB напротив состояния `occupancy`. Если коротко, то правило выполняется при каждом изменении состояния.

Среди прочих состояний, стоит сказать о состоянии `last_seen`. В это состояние выводится время последнего репорта устройства в формате `unix timestamp`. По нему удобно контролировать, не отвалилось ли устройство. Например, так:

![](/img/web_zig_dev_states_sb.png)

Это код на языке программирования LUA. Подробнее в следующих публикациях.
Это код на языке программирования [LUA](/lua.md).

#### Вкладка Options

В некоторых устройствах имеется возможность настройки параметров (options). Например, в датчике движения на картинке, можно настроить время, которое устройство будет находиться в сработке:

![](/img/web_zig_dev_opt.png)

[Видео-обзор меню Zigbee - Devices](https://youtu.be/HA8MaVRJYug)

### Join

Здесь выполняется подключение новых устройств.
Expand All @@ -270,7 +266,7 @@ _TODO: здесь будет ссылка на статью и видео о SB_

Также, шлюз поддерживает сопряжение устройств по технологии _TouchLink (Lightlink)_, которая предусматривает поиск и идентификацию устройств перед подключением и не требует дополнительного ввода устройства в режим сопряжения. Например, лампы и пульты IKEA Tradfri.

_TODO: здесь будет видео о сопряжении нового устройства и обзором меню Devices_
[Видео-обзор меню Zigbee - Join и сопряжения устройства](https://youtu.be/sgehjvJy79E)

### Map

Expand Down Expand Up @@ -320,6 +316,8 @@ MQTT messages options применяются без перезагрузки, х

![](/img/web_zig_conf_apply.png)

[Видео-обзор меню Zigbee - Config, Reset и BSL ](https://youtu.be/kUT-J5TlK7A)

### Reset to Default

Позволяет сбросить настройки zigbee модуля на "заводские": очищает список устройств, сбрасывает PanId и Chanel на значения по умолчанию.
Expand All @@ -328,20 +326,15 @@ MQTT messages options применяются без перезагрузки, х

### Soft Reset

Перезапускает zigbee модуль по пину RST. Для правильной работы должен быть прописан RST пин zigbee-модуля. Подтверждение не запрашивает!
Перезапускает zigbee модуль по пину RST. Для правильной работы должен быть [прописан](/web.md#Hardware) RST пин zigbee-модуля. Подтверждение не запрашивает!

_TODO: ссылка на hardware_
Для проверки корректности рестарта можно посмотреть в [лог](/web.md#log)

Для проверки корректности рестарта можно посмотреть в лог

_TODO: ссылка на лог_
![](/img/web_zig_rst_soft.png)

### Start BSL

Режим включения zigbee модуля, позволяющий обновить его прошивку "по воздуху", без программатора - Serial Bootloader (BSL и SBL - это одно и тоже. Разные вендоры не смогли определиться с одинаковой аббревиатурой).

_TODO: здесь будет ссылка на статью и видео по обновлению прошивки модуля_
Режим включения zigbee модуля, позволяющий обновить его [прошивку](/flashing.md) "по воздуху", без программатора - Serial Bootloader (BSL и SBL - это одно и тоже. Разные вендоры не смогли определиться с одинаковой аббревиатурой).

## Log

Expand Down Expand Up @@ -369,18 +362,18 @@ Log - это журнал сообщений системы.
- **Clear logs cache**: кнопка очищает буфер вывода лога.
- **Follow log**: отключает прокрутку лога в окне.

_TODO: здесь будет видео с обзором лога_
[Видео-обзор меню Log](https://youtu.be/tN3-tevIiXI)

## Settings
Здесь собраны настройки системы. Структура меню:

- Network
- Time & Location
- Link
- Serial
- Services
- Users
- Hardware
- [Network](/web.md#Network)
- [Time & Location](/web.md#time--location)
- [Link](/web.md#Link)
- [Serial](/web.md#Serial)
- [Services](/web.md#Services)
- [Users](/web.md#Users)
- [Hardware](/web.md#Hardware)

### Network
Настройка подключения к локальной сети.
Expand All @@ -402,7 +395,7 @@ _TODO: здесь будет видео с обзором лога_

![](/img/web_settings-time.png)

Раздел **Location** - настройка геолокации. Здесь необходимо указать координаты устройства: _Latitude_ (широта) и _Longitude_ (долгота). Обязательно для использования функций астротаймера в скриптах LUA. TODO: здесь будет ссылка на разбор функций `os.sunrise()` и `os.sunset()`.
Раздел **Location** - настройка геолокации. Здесь необходимо указать координаты устройства: _Latitude_ (широта) и _Longitude_ (долгота). Обязательно для использования функций [астротаймера](/lua.md#ossunriseoffset) в скриптах LUA.

Раздел **Date & Time** - настройка времени и его синхронизации с NTP сервера:
- **Current time**: выводятся текущие дата и время устройства. Если распаян модуль RTC (Real Time Clock), то это указывается в скобках после надписи Current time.
Expand Down Expand Up @@ -497,18 +490,18 @@ serial:
- **Led Blue**: пин, к которому подключен Blue вывод RGB led. Для адресного не используется.
- **I2C SDA/SCL**: пины для подключения к шлюзу внешнего устройства по шине I2C.
Видео-обзор меню Settings:
[Видео-обзор меню Settings](https://youtu.be/z0d1HXdxecU)
## Actions
Здесь собраны различные инструменты для работы со шлюзом.
- Files
- Backup
- Update Firmware
- Save
- Reboot System
- Logout
- [Files](/web.md#Files)
- [Backup](/web.md#Backup)
- [Update Firmware](/web.md#Update-Firmware)
- [Save](/web.md#Save)
- [Reboot System](/web.md#Reboot-System)
- [Logout](/web.md#Logout)
### Files
Expand Down Expand Up @@ -562,12 +555,14 @@ serial:

Выход из системы. Если авторизация отключена, то этого пункта в меню нет.

Видео-обзор меню Actions
[Видео-обзор меню Actions](https://youtu.be/Fi1VqNXvgPs)

# Help

Здесь собраны полезные ссылки:

Docs: ссылка на [документацию](https://slsys.io/docs/basic).
Telegram (Support, discussions): ссылка на [Telegram канал проекта](https://t.me/slsys).
Docs: ссылка на [документацию](https://slsys.io/docs/basic)

Telegram (Support, discussions): ссылка на [Telegram канал проекта](https://t.me/slsys)

Supported devices: ссылка на [справочник ](https://slsys.io/ru/action/supported_devices)поддерживаемых устройств.

0 comments on commit 622be70

Please sign in to comment.