Skip to content

Commit

Permalink
chore(docs): Sync wiki to docs [skip-cd]
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Jan 21, 2025
1 parent 487afc6 commit ba53c6b
Showing 1 changed file with 11 additions and 10 deletions.
21 changes: 11 additions & 10 deletions docs/Опис-функціоналу.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Прошивка використовує _**async**_ в роботі, що дозволяє запускати декілька процесів одночасно і швидше реагувати на зміни

Прошивка використовує _**власний сервер даних**_ [jaam.net.ua](http://jaam.net.ua/) для отримування даних про тривоги, вибухи та погоду
Прошивка використовує _**власний сервер даних**_ [jaam.net.ua](https://jaam.net.ua/) для отримування даних про тривоги, вибухи та погоду

Прошивка використовує _**Websockets**_ для звʼязку із сервером даних, що дозволяє майже миттєво отримувати оновлення

Expand All @@ -26,15 +26,15 @@
- також є сервісні сповіщення при старті мапи, при проблемних ситуаціях з мапою та процессі перемикання режимів

### Мапа має _**вбудований web-сервер**_
для керування налаштуваннями. Сторінка керування знаходиться за адресою [jaam.local](http://jaam.local) (або по IP). Також доступна сервісна сторінка [jaam.local:8080](http://jaam.local:8080), де можна змінити WiFi налаштуванння, перезавантажити мапу або перепрошити, якшо у вас є готовий зібраний файл прошивки і ви не хочете використовувати Arduino IDE
для керування налаштуваннями. Сторінка керування знаходиться за адресою [jaam.local](http://jaam.local) (або по IP). Також доступна сервісна сторінка [jaam.local:8080](http://jaam.local:8080), де можна змінити WiFi налаштуванння, перезавантажити мапу або перепрошити, якшо у вас є готовий зібраний файл прошивки і ви не хочете збирати прошивку за допомогою PlatformIO чи прошити її через [Flasher](https://flasher.jaam.net.ua)

### Всі _**налаштування зберігаються у внутрішній пам'яті**_
Відновлюються після перезавантаження та після перепрошивки мапи (якшо не вказувати примусове очищення)

### Мапа інтегрується в сервіс _**home assistant**_
HA бачить мапу як окремий прилад розумного будинку і має можливість керувати мапою
HA бачить мапу як окремий прилад розумного будинку і дає можливість керувати мапою

### Мапа може бути обладнана _**фоновою лед-стрічкою**_ (на платі jaam вже є)
### Мапа може бути обладнана _**фоновою лед-стрічкою**_ (на платі jaam 2 вже є)
Фонова стрічка повторює колір і режим в домашньому регіоні

### Мапа може бути обладнана _**двома кнопками**_ (на платі jaam вже є)
Expand All @@ -55,14 +55,15 @@ HA бачить мапу як окремий прилад розумного б
- "Увімк./Вимк. режим лампи" (доступно тількі для короткого натискання)
- "Перезавантаження пристрою" (доступно тількі для довгого натискання)
- "Збільшити яскравість лампи" (доступно тількі для довгого натискання)
"Зменшити яскравість лампи" (доступно тількі для довгого натискання)
- "Зменшити яскравість лампи" (доступно тількі для довгого натискання)

### Мапа може бути обладнана _**пасивним бузером**_ (на платі jaam вже є)
Бузер використовується для озвучення таких подій:
### Мапа може бути обладнана _**пасивним бузером**_ (на платі jaam 2 вже є)
Бузер використовується для сповіщення про такі події:
- натискання на кнопку
- годинне оповіщення
- щогодинне оповіщення
- початок тривоги
- відбій тривоги
- вибухи
- хвилина мовчання

Набір звуків і рінгтонів:
Expand Down Expand Up @@ -91,10 +92,10 @@ HA бачить мапу як окремий прилад розумного б

[Детальніше тут](https://github.com/J-A-A-M/ukraine_alarm_map/wiki/%D0%94%D0%B8%D0%BD%D0%B0%D0%BC%D1%96%D0%BA-(buzzer))

### Мапа може бути обладнана _**кліматичним датчиком**_ (на платі jaam вже є)
### Мапа може бути обладнана _**кліматичним датчиком**_ (на платі jaam 2 вже є)
Прошивка підтримує наступні сенсори: BME280*/BMP280, сімейство сенсорів SHT3x (SHT30*, SHT31, SHT35, SHT85), а також сімейство сенсорів SHT2x (SHT20, SHT21, SHT25, HTU20*, HTU21, Si7021). Сенсори відмічені зірочкою (*) тестувались разом з прошивкою, підтримка інших сенсорів зі списку вище теоретично можлива, але не перевірялась.

### Мапа може бути обладнана _**сенсором освітлення**_ (на платі jaam вже є)
### Мапа може бути обладнана _**сенсором освітлення**_ (на платі jaam 2 вже є)
Це може бути цифровий сенсор BH1750 або аналоговий фоторезитор

[Детальніше тут](https://github.com/J-A-A-M/ukraine_alarm_map/wiki/%D0%A1%D0%B5%D0%BD%D1%81%D0%BE%D1%80-%D0%BE%D1%81%D0%B2%D1%96%D1%82%D0%BB%D0%B5%D0%BD%D0%BD%D1%8F)
Expand Down

0 comments on commit ba53c6b

Please sign in to comment.