Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Foroxon authored Nov 5, 2024
1 parent 1c62515 commit 19faa10
Showing 1 changed file with 18 additions and 13 deletions.
31 changes: 18 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,27 +20,29 @@

[Питання та пропозиції](https://github.com/J-A-A-M/ukraine_alarm_map/discussions)

-->> [FLASHER](https://flasher.alerts.net.ua/) <<-- (тут можна залити свіжу прошивку прямо з браузера!)

-->> [ТЕЛЕГРАМ КАНАЛ ПРОЕКТУ](https://t.me/jaam_project) <<--

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

Прошивка використовує бібліотеку **_NeoPixelBus_** (останню версію брати [тут](https://github.com/Makuna/NeoPixelBus))
Прошивка використовує бібліотеку **_FastLED_**

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

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

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

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

В режим тривог також є візуальна інформація про вибухи в регіонах
В режимі тривог також є візуальна інформація про вибухи в регіонах

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

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

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

### Всі _**налаштування зберігаються у внутрішній пам'яті**_
Відновлюються після перезавантаження та після перепрошивки мапи (якшо не вказувати примусове очищення)
Expand All @@ -64,7 +66,10 @@ HA бачить мапу як окремий прилад розумного б

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

Можна використовувати до двох кнопок

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

Expand Down Expand Up @@ -106,15 +111,15 @@ HA бачить мапу як окремий прилад розумного б
- Іксмен
- Месники

[Детальніше тут](https://github.com/v00g100skr/ukraine_alarm_map/wiki/%D0%94%D0%B8%D0%BD%D0%B0%D0%BC%D1%96%D0%BA-(buzzer))
[Детальніше тут](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))

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

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

[Детальніше тут](https://github.com/v00g100skr/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)
[Детальніше тут](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 All @@ -137,11 +142,11 @@ HA бачить мапу як окремий прилад розумного б
### Якщо нова прошивка доступна, то мапа може оновлювати прошивку через веб інтерфейс або кнопкою (при її наявності)


[![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)
[![CodeQL](https://github.com/J-A-A-M/ukraine_alarm_map/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/J-A-A-M/ukraine_alarm_map/actions/workflows/github-code-scanning/codeql)

[![GitHub version](https://img.shields.io/github/release/v00g100skr/ukraine_alarm_map.svg)](https://github.com/v00g100skr/ukraine_alarm_map/releases/latest)
[![GitHub commits](https://img.shields.io/github/commit-activity/t/v00g100skr/ukraine_alarm_map.svg)](https://github.com/v00g100skr/ukraine_alarm_map/commits/master)
[![GitHub issues](https://img.shields.io/github/issues/v00g100skr/ukraine_alarm_map.svg)](https://github.com/v00g100skr/ukraine_alarm_map/issues)
[![GitHub version](https://img.shields.io/github/release/J-A-A-M/ukraine_alarm_map.svg)](https://github.com/J-A-A-M/ukraine_alarm_map/releases/latest)
[![GitHub commits](https://img.shields.io/github/commit-activity/t/J-A-A-M/ukraine_alarm_map.svg)](https://github.com/J-A-A-M/ukraine_alarm_map/commits/master)
[![GitHub issues](https://img.shields.io/github/issues/J-A-A-M/ukraine_alarm_map.svg)](https://github.com/J-A-A-M/ukraine_alarm_map/issues)
[![GitHub Clones](https://img.shields.io/badge/dynamic/json?color=success&label=Clone&query=count&url=https://gist.github.com/v00g100skr/3834111d448e497c81a139b69756835c/raw/clone.json&logo=github)](https://github.com/MShawon/github-clone-count-badge)


Expand Down

0 comments on commit 19faa10

Please sign in to comment.