Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
v00g100skr authored Mar 3, 2024
1 parent 6825a95 commit ebbf13b
Showing 1 changed file with 25 additions and 11 deletions.
36 changes: 25 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,20 +24,21 @@

-->> [ПОРТАЛ ДАНИХ](http://alerts.net.ua) <<--

Прошивка використовує бібліотеку **_NeoPixelBus_** (треба додатково встановити в Arduinо IDE по аналогії з іншими попередніми, останню версію брати [тут](https://github.com/Makuna/NeoPixelBus))
Прошивка використовує бібліотеку **_NeoPixelBus_** (останню версію брати [тут](https://github.com/Makuna/NeoPixelBus))

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

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

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

### Прошивка має такі можливості:
- режим відображення повітряних тривог, оснований на офіційному api https://www.ukrainealarm.com/
- режим відображення погоди, оснований на даних сайту https://openweathermap.org/
- режим прапора
- режим випадкових кольорів
- режим лампи
- режим offline - мапа не відображає нічого
- режим лампи - підсвідка певним кольором

### Для отримання даних не треба мати ключі для апи тривог або openweathermap - все вже є в нашому api

Expand All @@ -46,7 +47,9 @@
### Режим дисплея вмикається окремо через налаштування:
- поточний час
- погода
- також є сервісні сповіщення при старті мапи та при проблемних ситуаціях з мапою
- технічна інформація мапи
- дані з датчика температури і вологості
- також є сервісні сповіщення при старті мапи, при проблемних ситуаціях з мапою та процессі перемикання режимів

### Мапа має _**вбудований web-сервер**_
для керування всіми налаштуваннями. Сторінка керування знаходиться по адресі [alarmmap.local](http://alarmmap.local) (або по ip). Також доступна сервісна сторінка [alarmmap.local:8080](http://alarmmap.local:8080), де можна змініти wifi, перевантажити мапу або перепрошити, якшо у вас e готовий зібраний файл прошивки і ви не хочете використовувати arduino ide
Expand All @@ -58,18 +61,27 @@
HA бачить мапу як окремий прилад розумного будинку і має можливість керувати мапою

### Мапа може бути обладнана _**сенсорною кнопкою**_ ttp223 (на платі jaam кнопка вже є)
Кнопка дозволяє перемикати всі наявні режими в мапі
- саму мапу (тривога,погода, прапор, вимикання, лампа)
- дисплей (вимикання, годинник, погода, технічна інформація)
- перезавантаження мапи
- вмикання-вимикання нічного режиму
- вмикання-вимикання одночасно екрана і мапи
Є підтримка довгого натиснення на кнопку - модна встановити долдатковий режим
Кнопка дозволяє перемикати всі наявні режими в мапі:
- саму мапу (тривога, погода, прапор, вимикання)
- дисплей (вимикання, годинник, погода)

Список можливих дій на кнопці:
- "Вимкнено"
- "Перемикання режимів мапи"
- "Перемикання режимів дисплея"
- "Увімк./Вимк. мапу"
- "Увімк./Вимк. дисплей"
- "Увімк./Вимк. мапу та дисплей"
- "Увімк./Вимк. нічний режим"
- "Перезавантаження пристрою" (доступно тількі для довгого натискання)


### Мапа підтримуе певний рівень кастомізацій:
- загальна яскравість
- яскравість, основана на часі (нічний режим з зниженою яскравістю)
- можливість окремого світодіода для Кієва, або замість Київської області, або обидна одночасно (дана кастомізація потребує окремого світодіода в позиції 9 після Киівської області, загальна довжина стрічкі збільшиться с 25 до 26 світодіодів). Також є комбінований режим "Кіїв-Киівська область" для одного діода, який показує тривогу, якщо вона є в Києві або області
- яскравість, основана на даних датчика освітлення (якщо встановлений)
- можливість окремого світодіода для Кієва, або замість Київської області, або обидна одночасно (дана кастомізація потребує окремого світодіода в позиції 8 перед Киівською областю, загальна довжина стрічкі збільшиться с 25 до 26 світодіодів). Також є комбінований режим "Кіїв-Киівська область" для одного діода, який показує тривогу, якщо вона є в Києві або області

This comment has been minimized.

Copy link
@yurnov

yurnov Mar 7, 2024

Contributor

Кієва => Києва

- можливість підсвічування нових тривог та відбоїв тривог певний час іншим кольором
- можливість окремо і незалежно виставити яскравість різних зон тривог відносно одна одної
- можливість окремо і незалежно виставити кольори різних зон тривог відносно одна одної
Expand All @@ -81,6 +93,8 @@ HA бачить мапу як окремий прилад розумного б
- підключення до сервера даних
- підключення до home assistant

### Мапа може оновлювати прошивку через веб інтерфейс


[![CodeQL](https://github.com/v00g100skr/ukraine_alarm_map/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/v00g100skr/ukraine_alarm_map/actions/workflows/github-code-scanning/codeql)

Expand Down

0 comments on commit ebbf13b

Please sign in to comment.