Mirror/esphome_aux_ac_component
1
0
Fork 0
mirror of https://github.com/GrKoR/esphome_aux_ac_component.git synced 2025-12-06 03:26:56 +03:00
Code Issues Packages Projects Releases Wiki Activity

docs upd: how to request a feature

Browse Source
This commit is contained in:
GrKoR
2023-05-22 15:29:53 +04:00
parent 935e97e795
commit 8b17ca7052
2 changed files with 25 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
docs/HOW_TO_FEATURE_REQUEST-EN.md
View File

@@ -1,19 +1,18 @@
# How to request a feature for a component #
With any functions, the alignment is such that they simply cannot be written down by name.
We need a log from someone who has such functions.
We need a log from someone who has air conditioner with such functions. If you are such a person, then you can help yourself and the community.
The sequence of actions is as follows:
1. Run a specially written [tool](https://github.com/GrKoR/ac_python_logger) to collect logs and turn on the AC.
2. Wait 10+ seconds for all possible packet types to pass through the UART to the ESP.
3. Turn on the desired function.
4. Again I wait 10+ seconds. While you are waiting, you write down in a separate text what you did.
5. Turn off the desired function.
6. Again I wait 10+ seconds. And write down what you did.
7. Repeat steps 3..6 for all other functions you test.
8. Stop the log recording with a script.
To capture the log you need to do the following steps:
1. Run a specially written [tool](https://github.com/GrKoR/ac_python_logger) to collect logs.
2. Turn on the AC.
3. Wait 10+ seconds. (During this time, the ESP will receive all packets from AC).
4. Turn on the desired function using AC's IR remote.
5. Wait 10+ seconds ones more. While you are waiting, you can write down what you have done.
6. Turn off the desired function.
7. Wait 10+ seconds again and write down what you've done.
8. Repeat steps 4..7 for all other functions you interested in.
9. Stop the log recording with a script.
10. Send collected log and your notes (explanations to the log) to [issues](https://github.com/GrKoR/esphome_aux_ac_component/issues) or to [telegram chat](https://t.me/aux_ac).
Instead of a Python script, you can simply save the logs from the web-interface with copy-paste or from the command line, but there is a lot of extra stuff there. And it's easy to miss something. But in principle, it is also quite a working option.
As a result of all the efforts, you send the collected log and your notes (explanations to the log) to [issues](https://github.com/GrKoR/esphome_aux_ac_component/issues) or to [chat](https://t.me/aux_ac) . Using them, you can try to decipher the functionality and then you can file a new feature.
This is how we deciphered the fixed positions of the blinds at the air conditioner. Here you can see in [chat](https://t.me/aux_ac/6308).
Instead of a Python script from the step #1, you can simply save the logs from the esphome web-interface with copy-paste or from the command line, but there is a lot of extra stuff there. And it's easy to miss something. But in principle, it is also quite a working option.

26
docs/HOW_TO_FEATURE_REQUEST.md
View File

@@ -1,19 +1,17 @@
# Как запросить расширение функционала компонента #
С любыми функциями расклад такой, что просто по названию их не запилить.
Нужен лог от того, у кого такие функции есть.
С любыми новыми функциями кондиционера ситуация такая, что просто по названию из инструкции или с пульта их не сделать. Нужен лог от владельца кондиционера, у кого такие функции есть. Если вы такой владелей, то можете помочь себе и сообществу.
Последовательность действий такая:
1. Запускаешь специально написанную [тулзу](https://github.com/GrKoR/ac_python_logger) для сбора логов и включешь кондей.
2. Ждёшь 10+ секунд, чтобы все возможные типы пакетов прошли по UART на ESP.
3. Включаешь нужную функцию.
4. Опять ждёшь 10+ секунд. Пока ждёшь, записываешь в отдельный текстовик или на бумажку, что сделал.
5. Выключаешь нужную функцию.
6. Опять ждёшь 10+ секунд. И записываешь, что сделал.
7. Повторяешь шаги 3..6 для всех других функций, которые хочешь проверить.
8. Останавливаешь запись лога скриптом.
1. Запускате специально написанную [тулзу](https://github.com/GrKoR/ac_python_logger) для сбора логов.
2. Включете кондиционер.
3. Ждёте 10+ секунд, чтобы все возможные типы пакетов прошли по UART на ESP.
4. Включаете нужную функцию с помощью ИК-пульта.
5. Опять ждёте 10+ секунд. Во время ожидания можно записать в отдельный текстовый файл или на бумажку, что именно сделано.
6. Выключаете нужную функцию.
7. Опять ждёте 10+ секунд, не забывая записывать комментарии по сделанному.
8. Повторяете шаги 4..7 для всех других функций, которые хочется иметь в компоненте `aux_ac`.
9. Останавливаете запись лога.
10. Отправляете собранный лог и свои заметки (пояснения к логу) в [issues](https://github.com/GrKoR/esphome_aux_ac_component/issues) или в [телеграм](https://t.me/aux_ac).
Вместо скрипта на Python можно и просто логи из вебморды сохранять копипастом или из командной строки, но там много лишнего шлётся. И легко что-то прозевать. Но в принципе тоже вполне рабочий вариант.
По итогу всех махинаций отправляешь собранный лог и свои заметки (пояснения к логу) в [issues](https://github.com/GrKoR/esphome_aux_ac_component/issues) или в [телегу](https://t.me/aux_ac). По ним можно попробовать расшифровать функционал и тогда можно запилить новую фичу.
Мы так фиксированные положения жалюзи у кондея расшифровали. Вот можно посмотреть в [чате](https://t.me/aux_ac/6308).
Вместо использования Python-скрипта можно логи из веб-интерфейса esphome сохранять копипастом или из командной строки. Но там много лишнего шлётся и легко что-то пропустить. Но в принципе это тоже вполне рабочий вариант.