aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--readme.md52
-rw-r--r--software/readme.md47
2 files changed, 49 insertions, 50 deletions
diff --git a/readme.md b/readme.md
index a8366b0..f391296 100644
--- a/readme.md
+++ b/readme.md
@@ -2,7 +2,53 @@
(in dutch again haha)
-ben lui dus ga niet nog een readme schrijven
+onze ledcube is iets anders dan de gemiddelde ledcube. onze leds zijn
+aangesloten als een 8x8 matrix waarbij alle anodes in rijen, en alle cathodes
+in kolommen zijn verbonden. hierdoor gebruikt onze ledcube maar acht
+weerstanden inplaats van zestien, en geen transistoren of mosfets. ook worden
+maar drie uitgangen van de arduino gebruikt voor de seriële ingang, seriële
+klok, en de latch klok van het shiftregister.
-[dit](software/readme.md) beschrijft 't zooitje wel goed, maar staat gelijk in
-een map waar ik het makkelijk kan inleveren
+## software
+
+de software is als gevolg hierdoor ook anders ingericht. de atmega328p heeft
+ingebouwde pwm timers, die je zou kunnen gebruiken om snel door de vier lagen
+van de ledcube heen te schakelen. omdat deze timers los van je code draaien kun
+je de ingebouwde `delay()` gewoon gebruiken om de animaties makkelijker te
+implementeren, maar dit werkt alleen wanneer je transistoren gebruikt en ze
+direct op pwm uitgangen aansluit.
+
+daarom gebruikt onze software geen `delay()` of andere 'blokkerende' functies,
+maar timers. dit zorgt ervoor dat de ingebouwde `loop()` functie van de arduino
+vaak genoeg draait om het te laten lijken alsof alle led's van de ledcube
+tegelijkertijd aan zijn.
+
+de software is opgesplitst in losse bestanden om overzichtelijkheid te
+behouden. alle documentatie bevindt zich in de header (.h) bestanden, is in het
+engels, en is in doxygen formaat. hier is een beknopte beschrijving van de
+bestanden:
+
+```
+software/
+├── animation.h --
+├── animation.ino helpfuncties voor animaties
+├── consts.h algemene constantes
+├── effects.h bevat ook opties voor de diavoorstelling van animaties
+├── effects.ino de animaties die weergeven worden
+├── readme.md dit bestand
+├── scan.h --
+├── scan.ino functies omtrent het schakelen van de rijen
+├── shift.h --
+├── shift.ino functies die het shiftregister besturen
+├── software.h --
+├── software.ino hoofdbestand/ingangspunt
+├── util.h --
+└── util.ino gereedschapsfuncties
+```
+
+de code voor de animaties is nog niet compleet af, animatie 1 en 3 doen het
+inmiddels, maar 2 heeft nog wat problemen door de `fill_plane` functie. deze ga
+ik opnieuw implementeren en woensdag testen.
+
+ook het algoritme om lege scanrijen over te slaan is nog niet afgewerkt en
+wordt dus ook op woensdag getest.
diff --git a/software/readme.md b/software/readme.md
deleted file mode 100644
index dbe77d2..0000000
--- a/software/readme.md
+++ /dev/null
@@ -1,47 +0,0 @@
-# software readme
-
-onze ledcube is iets anders dan de gemiddelde ledcube. onze leds zijn
-aangesloten als een 8x8 matrix waarbij alle anodes in rijen, en alle cathodes
-in kolommen zijn verbonden. hierdoor gebruikt onze ledcube maar acht
-weerstanden inplaats van zestien, en geen transistoren of mosfets. ook worden
-maar drie uitgangen van de arduino gebruikt voor de seriële ingang, seriële
-klok, en de latch klok van het shiftregister.
-
-de software is als gevolg hierdoor ook anders ingericht. de atmega328p heeft
-ingebouwde pwm timers, die je zou kunnen gebruiken om snel door de vier lagen
-van de ledcube heen te schakelen. omdat deze timers los van je code draaien kun
-je de ingebouwde `delay()` gewoon gebruiken om de animaties makkelijker te
-implementeren, maar dit werkt alleen wanneer je transistoren gebruikt en ze
-direct op pwm uitgangen aansluit.
-
-daarom gebruikt onze software geen `delay()` of andere 'blokkerende' functies,
-maar timers. dit zorgt ervoor dat de ingebouwde `loop()` functie van de arduino
-vaak genoeg draait om het te laten lijken alsof alle led's van de ledcube
-tegelijkertijd aan zijn.
-
-het project is opgesplitst in losse bestanden om overzichtelijkheid te
-behouden. alle documentatie bevindt zich in de header (.h) bestanden, is in het
-engels, en is in doxygen formaat. hier is een beknopte beschrijving van de
-bestanden:
-
-```
-.
-├── animation.h --
-├── animation.ino helpfuncties voor animaties
-├── consts.h algemene constantes
-├── effects.h bevat ook opties voor de diavoorstelling van animaties
-├── effects.ino de animaties die weergeven worden
-├── readme.md dit bestand
-├── scan.h --
-├── scan.ino functies omtrent het schakelen van de rijen
-├── shift.h --
-├── shift.ino functies die het shiftregister besturen
-├── software.h --
-├── software.ino hoofdbestand/ingangspunt
-├── util.h --
-└── util.ino gereedschapsfuncties
-```
-
-ik (loek) heb de software voor het laatst op vrijdag getest, dus ik weet niet
-zeker of mijn code voor de animaties helemaal werkt, maar ik ga deze maandag
-testen en bijwerken. dit is dus nog geen afgewerkte code.