Demon käyttöohje

ollpu · May 4, 2021 · fc76159 · fc76159
1 parent 9f14abd
commit fc76159
Show file tree

Hide file tree

Showing 2 changed files with 34 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -17,10 +17,7 @@ Aja sitten demo suorittamalla (grafiikkakirjastojen kääntämisessä kestää j
 cargo run --release --example demo
 ```
 
-"Vakauta"-valintaruudulla itse algoritmin saa päälle tai pois. Vaimenemisajan liu'ut
-vaikuttavat siihen, kuinka nopeasti näytettävä signaali vaihtuu. Muistille on oma liukunsa,
-jotta algoritmi saadaan muistamaan suurpiirteisen aaltomuodon pidempään.
-
+#### [Demon käyttöohjeet](dokumentaatio/käyttöohje.md)
 
 Testit voidaan ajaa suorittamalla
 

diff --git a/dokumentaatio/käyttöohje.md b/dokumentaatio/käyttöohje.md
@@ -0,0 +1,33 @@
+# Demon käyttöohje
+
+Demoikkunan tulisi näyttää jotakuinkin tältä:
+
+![ikkuna](https://user-images.githubusercontent.com/7241014/117027750-aafbc300-ad05-11eb-9064-d489f2180c9a.png)
+
+Äänilähteenä voit käyttää joko mikrofonia tai testisignaalia. Terminaaliin tulisi ilmestyä joko
+teksti `Käytetään äänilaitetta: "laitteen nimi"` tai virheviesti, jos mikrofoni ei toimi.
+Vaihda testisignaaliin "Äänilähde"-pudotusvalikosta:
+
+![äänilähde](https://user-images.githubusercontent.com/7241014/117027961-e39b9c80-ad05-11eb-8eba-3385633b2e76.png)
+
+Mikrofonilla kannattaa kokeilla esimerkiksi hyräilyä. Jos saat järjestelmäasetukset
+asetettua siten, että ohjelma monitoroi kaiuttimien uloslähtöä, voit kokeilla mitä
+tahansa äänisignaalia.
+
+Testisignaali on siniaalto, jonka taajuus vaihtelee noin 200 Hz ympärillä.
+
+Alareunassa oleva harmaa palkki ilmaisee, mikä kohta saadusta signaalista näytetään tällä
+hetkellä. Perustaajuudesta riippuen sen on tarkoituskin hyppiä edestakaisin.
+
+"Vakauta"-valintaruudusta voit ottaa algoritmin pois käytöstä. Tällöin alareunan palkki
+pysyy paikoillaan, eli näytöllä näkyy aina suhteessa sama kohta.
+
+Näytön ja muistin vaimenemisajan liu'ut säätävät, kuinka pitkään vanhaa signaalia
+muistetaan. Suuremmalla näytön vaimenemisajalla näkymä on sulavampi, mutta
+se eroaa hieman oikeasti luetusta signaalista. Suuremmalla muistin vaimenemisajalla
+algoritmi pystyy muistamaan aiemmin näytettyä kuvaajaa, eli näkymä pysyy vakaana
+riippumatta hetkellisistä häiriöistä.
+
+Kun viet hiiren muistin vaimenemisajan liu'un päälle, näkyy näytöllä toinen kuvaaja,
+joka ilmaisee muistin tämänhetkisen sisällön. Tämä on siis se taulukko, jota verrataan
+uuteen signaaliin.