INFO: This documentation isn't finished yet. When it will be finished, this note will disapear / Dokumentacja jeszcze nie jest dokończona. Gdy ją dokończę, ta informacja zniknie
NOTE: English version below
W tym repozytorium znajdziesz pełną dokumentację standardu STQC, czyli systemu selektywnego wywoływania używanego przez strażaków w OSP do aktywacji syren alarmowych.
Źródła danych można znaleźć w pliku CREDITS.
Niektóre programy zawarte w repozytorium wymagają programu FFmpeg do poprawnego działania.
Projekt jest udostępniony na licencji GNU GPL 3.0. Jej pełny zapis możesz znaleźć w pliku LICENSE.
Surowo zabronione jest używanie poniższej dokumentacji oraz programów do nielegalnego uruchamiania syren alarmowych!!
Projekt jest podzielony na kilka folderów w celu łatwiejszej nawigacji:
- STQC encoding and decoding - dokumentacje w tym folderze są poświęcone stricte samemu standardowi STQC, czyli temu, jak enkodować i dekodować liczby do odpowiednich tonów. Dokumentacja dostępna w językach: Polski, Angielski. W podfolderze examples/ znajdują się programy w Pythonie umożliwiające enkodowanie i dekodowanie liczb do/z odpowiednich sekwencji STQC. Źródło informacji
- STQC decoder - entry - wprowadzenie do metod enkodowania i dekodowania informacji przekazywanych syrenom alarmowym. W tym folderze znajdziesz również metodę, której używa Dekoder STQC Bartka (serwerbartka.pl) w wersjach 2.10, 2.15 i 2.16 do ustalenia numeru jednostki i komendy. Są one wszystkie wrzucone do jednego folderu, ponieważ są takie same dla każdej wersji, i zwyczajnie nie byłoby sensu opisywać tego samego w trzech różnych folderach.
- STQC decoder v2.10 - w tym folderze znajdują się (krótkie) informacje, jak Dekoder STQC Bartka (serwerbartka.pl) w wersji 2.10 wyznacza numer powiatu.
In this repository you can find full documentation of STQC - a system used by Polish firefighters to remotely enable and disable alarm sirens.
You can find all data sources that I used to create this documentation in the CREDITS file.
Some programs in this repo require FFmpeg to work.
Project is shared under terms of GNU GPL 3.0 licence. You can whole license in the LICENSE file.
Project is divided into folders for easier navigation:
- STQC encoding and decoding - documentations in this folder are focused stricte on the STQC standard - detailed instructions about encoding and decoding numbers to specific tones. Documentation is available in those languages: Polish, English. In the examples/ subfolder you can find Python programs that can encode/decode numbers to/from STQC sequences. Information source
- STQC decoder - entry - methods of encoding and decoding informations used to control alarm sirens. You can also find documented method, that Bartek's STQC decoder (serwerbartka.pl) in version 2.10, 2.15 and 2.16 is using to determine unit number and command. I put them into one folder, because they are the same for all versions, so there is no need to put the same stuff in 3 folders.
- STQC decoder v2.10 - in this folder you can find (short) documentation, how Bartek's STQC decoder in version 2.10 is decoding "powiat" number.