docs: Update documentation after adding new feature

Author: blizniukp

README.md

@@ -48,13 +48,14 @@ The device connects to the OBD interface via Bluetooth and displays DPF status i
 
 The following parameters are displayed:
 
-* Soot mass measured (smm)
-* Soot mass calculated (smc)
-* Distance since last regeneration (dslr)
-* Time since last regeneration (tslr)
-* Oil Ash Residue (oar)
-* Input temperature (itemp)
-* Output temperature (otemp)
+* Soot mass measured
+* Soot mass calculated
+* Distance since last regeneration
+* Time since last regeneration
+* Oil Ash Residue
+* Input temperature
+* Output temperature
+* Soot load (%)
 
 
 The data is refreshed every 10 seconds. On the right side of the display, a correct `V` or incorrect `X` reading of a given parameter is marked.
@@ -85,7 +86,13 @@ The board selection is made in the `platformio.ini` file by leaving one of the o
 ;-DWEMOS_BOARD
 ```
 
-Optionally, you can add a buzzer (with a generator) that informs you when the DPF regeneration starts and stops. The buzzer should be connected between the GND and D12 pins.
+Optionally, you can add a buzzer (with a generator) that informs you when:
+- the DPF regeneration starts and stops
+- after exceeding 80% filter fill
+
+The buzzer should be connected between the GND and D12 pins.
+
+![buzzer](/docs/buzzer.png)
 
 <p align="right">(<a href="#top">back to top</a>)</p>
 
@@ -139,6 +146,12 @@ After connecting and accessing the 192.168.4.1 address, we have the ability to p
 The 'Remove bonded devices' button starts the procedure for removing paired Bluetooth devices on the ESP32 module.
 This is useful when a connection error occurs. And the problem occurs when you connect to the OBD interface from your phone, and then want to connect again using the device.
 
+The `Temperature threshold to activates the buzzer alarm` field is active only when the `Input temperature` reading option is selected.
+The default value is 400. The hysteresis is 10°C. Thus, the buzzer will turn on when the input temperature exceeds 410°C, and turn off when the input temperature decreases below 390°C.
+
+The `Maximum soot load (used to calculate the percentage)` field is active only when the `Soot load (%)` option is checked. The default value is 80% full. The hysteresis is 1%.
+The buzzer alarm is triggered when the filter exceeds 79% full and is played only once.
+
 <p align="right">(<a href="#top">back to top</a>)</p>
 
 ## Roadmap

README.pl.md

@@ -48,13 +48,14 @@ Urządznie łączy się z interfejsem OBD po Bluetooth i wyświetla informacje o
 
 Wyświetlane są następujące parametry:
 
-* Zmierzona masa sadzy (smm)
-* Wyliczona masa sadzy (smc)
-* Dystans od ostatniej regeneracji (dslr)
-* Czas od ostatniej regeneracji (tslr)
-* Pozostałość popiołu olejowego (oar)
-* Temperatura wejściowa (itemp)
-* Temperatura wyjściowa (otemp)
+* Zmierzona masa sadzy (Soot mass measured)
+* Wyliczona masa sadzy (Soot mass calculated)
+* Dystans od ostatniej regeneracji (Distance since last regeneration)
+* Czas od ostatniej regeneracji (Time since last regeneration)
+* Pozostałość popiołu olejowego (Oil Ash Residue)
+* Temperatura wejściowa (Input temperature)
+* Temperatura wyjściowa (Output temperature)
+* Procentowa wartość zapełnienia filtra (Soot load (%))
 
 
 Dane odświeżane są co 10 sekund. Po prawej stronie wyświetlacza zaznaczany jest prawidłowy `V` lub nieprawidłowy `X` odczyt danego parametru.
@@ -85,7 +86,13 @@ Wyboru płytki dokonujemy w pliku `platformio.ini` pozostawiając odkomentowaną
 ;-DWEMOS_BOARD
 ```
 
-Opcjonalnie można dodać buzzer (z generatorem) który informuje o momencie rozpoczęcia oraz zakończenia wypalania DPF. Buzzer należy wpiąc pomiędzy pin GND oraz D12.
+Opcjonalnie można dodać buzzer (z generatorem) który informuje o:
+- momencie rozpoczęcia oraz zakończenia wypalania DPF
+- przekroczeniu progu 80% zapełnienia filtra
+
+Buzzer należy wpiąc pomiędzy pin GND oraz D12.
+
+![buzzer](/docs/buzzer.png)
 
 <p align="right">(<a href="#top">powrót do góry</a>)</p>
 
@@ -139,6 +146,12 @@ Po połączeniu się i wejściu na adres 192.168.4.1 mamy możliwość podejrzen
 Przycisk 'Remove bonded devices' rozpoczyna procedurę usunięcia sparowanych urządzeń Bluetooth w module ESP32.
 Jest to przydatne w momencie występienia błędu podczas łączenia. A problem pojawia się, gdy do interfejsu OBD połączymy się z telefonu, a następnie ponownie chcemy połączyć się za pomocą urządzenia.
 
+Pole `Temperature threshold to activates the buzzer alarm.` (Próg temperatury po którym załączany jest alarm) jest aktywne dopiero po zaznaczeniu opcji odczytu Temperatury wejściowej `Input temperature`.
+Wartość domyślna to 400. Histereza wynosi 10°C. Zatem załączenie buzzera nastąpi po przekroczeniu 410°C, a jego wyłączenie gdy temperatura wejściowa spadnie poniżej 390°C.
+
+Pole `Maximum soot load (used to calculate the percentage)` (Maksymalna wartość sadzy - wyliczonej. (używana do wyliczania procentowej wartości zapełnienia filtra)) jest aktywne dopiero po zaznaczeniu opcji `Soot load (%)`. Wartość domyślna to 80% zapełnienia. Histereza wynosi 1%.
+Alarm z buzzera uruchamia się po przekroczeniu 79% zapełnienia filtra i jest odtwarzany tylko raz.
+
 <p align="right">(<a href="#top">powrót do góry</a>)</p>
 
 ## Plan rozwoju