Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Krypt0nC0R3 authored Feb 25, 2022
1 parent 35d24cc commit 48faa83
Showing 1 changed file with 29 additions and 22 deletions.
51 changes: 29 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,51 +53,52 @@
}
```
Разберем более подробно, для чего служит каждый параметр.

> Do_Output
____
#### Do_Output

Определяет, будет ли программа писать в станадартный вывод общую информацию. `true` если вывод необходим, `false` если вывод не нужен. **Информация об ошибках и предупреждениях выводится в любом случае**.
> Web_Port
____
#### Web_Port

Порт, который будет слушать программа и который должен быть доступен извне. На одном ПК можно запустить несколько копий программы на разных портах. Они не будут мешать друг другу. В качестве значения принимает число, отличное от нуля. **Желательно не использовать стандартные значиея, типа 21, 22, 88, 443 и т.д.**.

> Web_Path_Prefix
____
#### Web_Path_Prefix

Адрес, по которому программа будет принимать запросы на управление. Полный адрес для управления выглядит следующим образом `http://{Ваш IP}:{Web_Port}{Web_Path_Prefix}`. Принимает в качестве значения строку, начинающуюся с `/`.

> MQTT_address
____
#### MQTT_address

Адрес MQTT сервера, к которому подключена Ваша лампа/матрица. Если вы запускаете программу на том же ПК, где стоит MQTT-сервер можно вписать `localhost`. Принимает в качестве значения IP-адрес сервера или его WS:// адрес.

> MQTT_Port
____
#### MQTT_Port

Порт MQTT сервера. Зачастую можно оставить по умолчанию. В качестве значения принимает ненулевое число

> MQTT_Path
____
#### MQTT_Path

Путь (префикс) вашей лампы на MQTT-сервере. Должен совпадать с префиксом MQTT из настроек матрицы.


> MQTT_Username
____
#### MQTT_Username

Имя пользователя для аутентификации на MQTT-сервере. По умолчанию `null`. При таком значении авторизация по логину-паролю отключена. Значение - строка либо `null`.

> MQTT_Password
____
#### MQTT_Password

Пароль для аутентификации на MQTT-сервере. По умолчанию `null`. При таком значении авторизация по логину-паролю отключена. Значение - строка либо `null`.

> Secret_Phrase
____
#### Secret_Phrase

Секретная комбинация, без которой программа не будет воспринимать команды от "Кузи" и через `GET` запросы. Можно оставить значение по умолчанию (значение у каждого свое, генерируется при первом запуске) либо придумать свое. **Запрещается использовать символы, отличные от букв анлийского алфавита и цифр**.

# Настройка "Кузи"

Для начала нам понадобится [Ваш IP-адрес](https://2ip.ru/) или адрес Вашего домена, если он есть.
Вам необходим адрес, к которому мы будем добавлять различные суфффиксы. Адрес получается вида `http://{IP}:{Web_Port}/{Web_Path_Prefix}/`. Используя данные из примера выше получится следующее: `http://142.15.224.163:88/smarthome/lamp1/`. Назовем получивщуюся конструкицю `Базовым адресом`.
Вам необходим адрес, к которому мы будем добавлять различные суфффиксы. Адрес получается вида `http://{IP}:{Web_Port}/{Web_Path_Prefix}/`. Используя данные из примера выше получится следующее: `http://142.15.224.163:88/smarthome/lamp1/`. Назовем получивщуюся конструкицю **`Базовым адресом`**.
Для управления лампой/матрицей нам потребуется создать 8 HTTP правил и 1 RGB-лампу в приложении.

![image](https://user-images.githubusercontent.com/46594859/155583200-daad0655-793c-4837-a890-6978ee22ba47.png)
## Правила
____
### Правило запроса состояния
Отдает "Кузе" информацию о том, ключена лампа или нет.

Expand All @@ -107,40 +108,46 @@
![image](https://user-images.githubusercontent.com/46594859/155583588-bc159a90-1056-45d3-8ae4-dc1e6bd4c011.png)

**На всех правилах по запросу информации обязательно ставить галочку `Ждать ответ от сервера`. Без нее Ваша лампа будет отключаться спустя 5-10 секунд, т.к. "Кузя" не дождался ответа.**
____
### Правило установки состояния
Принимает от "Кузи" информацию о том, что нужно сделать с лампой - включить или выключить.

`URL управления устройством, доступный из интернета`: Базовый адрес + `setstate/{value}?secret={Secret_Phrase}`, заменяем `{Secret_Phrase}` на секретную фразу. `{value}` ни в коем случае не трогаем, оставляем как есть
В поле `Поиск значений в фразе` выбираем значение `Цифры, вкл/выкл`.

____
### Правило запроса цвета
Отдает информацию о том, какой последний цвет использовался для рисования.
> На версии прошивки 1.12 и ниже может не работать из-за [бага](https://github.com/vvip-68/GyverPanelWiFi/issues/217)
По умолчанию - Белый цвет.
По умолчанию - Черный цвет.

`URL управления устройством, доступный из интернета`: Базовый адрес + `getcolor/?secret={Secret_Phrase}`, заменяем `{Secret_Phrase}` на секретную фразу.

____
### Правило установки цвета
Принимает информацию от "Кузи" о том, каким цветом залить лампу/матрицу.

`URL управления устройством, доступный из интернета`: Базовый адрес + `setcolor/{r}.{g}.{b}?secret={Secret_Phrase}`, заменяем `{Secret_Phrase}` на секретную фразу.
____
### Правило запроса яркости
Отдает информацю "Кузе" о текущей яркости гирлянды.

`URL управления устройством, доступный из интернета`: Базовый адрес + `getbrightness/?secret={Secret_Phrase}`, заменяем `{Secret_Phrase}` на секретную фразу.
____
### Правило установки яркости
Принимает информацю у "Кузи" о текущей яркости гирлянды.

`URL управления устройством, доступный из интернета`: Базовый адрес + `setbrightness/{value}?secret={Secret_Phrase}`, заменяем `{Secret_Phrase}` на секретную фразу.
____
### Правило запроса текущего эффекта
Отдает информацю "Кузе" о текущем эффекте.

`URL управления устройством, доступный из интернета`: Базовый адрес + `geteffect/?secret={Secret_Phrase}`, заменяем `{Secret_Phrase}` на секретную фразу.
____
### Правило установки текущего эффекта
Принимает информацю у "Кузи" о текущем эфекте.

`URL управления устройством, доступный из интернета`: Базовый адрес + `seteffect/{value}?secret={Secret_Phrase}`, заменяем `{Secret_Phrase}` на секретную фразу.
____
## Настройка устройства
Создаем RGB-лампу. С помощью цветовой температуры мы будем управлять эффектами.
Выставляем в настройках правила следующим образом:
Expand Down

0 comments on commit 48faa83

Please sign in to comment.