Skip to content

Commit

Permalink
mkdocs
Browse files Browse the repository at this point in the history
  • Loading branch information
Martin Müllenhaupt committed Jan 17, 2024
1 parent a6324d5 commit 61d83f0
Show file tree
Hide file tree
Showing 39 changed files with 253 additions and 64 deletions.
3 changes: 3 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
*.mp4 filter=lfs diff=lfs merge=lfs -text
*.png filter=lfs diff=lfs merge=lfs -text
*.jpg filter=lfs diff=lfs merge=lfs -text
18 changes: 0 additions & 18 deletions doc/de/ProgSetupLinux.md

This file was deleted.

21 changes: 0 additions & 21 deletions doc/de/README.md

This file was deleted.

Binary file removed doc/img/baumsatz_back.png
Binary file not shown.
Binary file removed doc/img/baumsatz_front.png
Binary file not shown.
Binary file removed doc/img/setup_python_platformio.png
Binary file not shown.
Binary file removed doc/img/setup_windows_driver.png
Binary file not shown.
Binary file removed doc/img/setup_windows_python.png
Binary file not shown.
Binary file removed doc/img/unicorn_back.png
Binary file not shown.
Binary file removed doc/img/unicorn_front.png
Binary file not shown.
Binary file removed doc/img/unicorn_s_back.png
Binary file not shown.
Binary file removed doc/img/unicorn_s_front.png
Binary file not shown.
Binary file removed doc/img/unicorn_s_live.jpg
Binary file not shown.
4 changes: 2 additions & 2 deletions doc/de/KitBaumsatz.md → docs/KitBaumsatz.de.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Bau(m)satz

<img src="../img/baumsatz_front.png" width="200" height="200" alt="Bau(m)satz Vorderseite">
<img src="../img/baumsatz_back.png" width="200" height="200" alt="Bau(m)satz Rückseite">
<img src="../assets/images/baumsatz_front.png" width="200" height="200" alt="Bau(m)satz Vorderseite">
<img src="../assets/images/baumsatz_back.png" width="200" height="200" alt="Bau(m)satz Rückseite">

Diese Platine orientiert sich größtenteils am [Digistump](http://digistump.com/wiki/digispark/tutorials/connecting).
Sie enthält auch den Microcontroller [ATtiny85](https://ww1.microchip.com/downloads/en/DeviceDoc/Atmel-2586-AVR-8-bit-Microcontroller-ATtiny25-ATtiny45-ATtiny85_Datasheet.pdf) und die USB-Schaltung.
Expand Down
6 changes: 3 additions & 3 deletions doc/de/KitUnicorn.md → docs/KitUnicorn.de.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Unicorn

<img src="../img/unicorn_front.png" width="200" height="200" alt="Unicorn Vorderseite">
<img src="../img/unicorn_back.png" width="200" height="200" alt="Unicorn Rückseite">
<img src="../img/unicorn_live.webp" width="260" height="200" alt="Unicorn Live">
<img src="../assets/images/unicorn_front.png" width="200" height="200" alt="Unicorn Vorderseite">
<img src="../assets/images/unicorn_back.png" width="200" height="200" alt="Unicorn Rückseite">
<img src="../assets/images/unicorn_live.webp" width="260" height="200" alt="Unicorn Live">

Diese Platine orientiert sich äußerlich am [Regenbogen Einhorn](https://shop.blinkyparts.com/de/Regenbogen-Einhorn-Loetbausatz-Einfacher-Anstecker-fuer-Anfaenger/blink232242). Die Bestückung ist allerdings gleich zum [Bau(m)satz](KitBaumsatz.md).

Expand Down
6 changes: 3 additions & 3 deletions doc/de/KitUnicornS.md → docs/KitUnicornS.de.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Unicorn S

<img src="../img/unicorn_s_front.png" width="200" height="200" alt="Unicorn S Vorderseite">
<img src="../img/unicorn_s_back.png" width="200" height="200" alt="Unicorn S Rückseite">
<img src="../img/unicorn_s_live.jpg" width="200" height="200" alt="Unicorn S Rückseite">
<img src="assets/images/unicorn_s_front.png" width="200" height="200" alt="Unicorn S Vorderseite">
<img src="assets/images/unicorn_s_back.png" width="200" height="200" alt="Unicorn S Rückseite">
<img src="assets/images/unicorn_s_live.jpg" width="200" height="200" alt="Unicorn S Rückseite">

Diese Platine ist praktisch baugleich zum [Regenbogen Einhorn](https://shop.blinkyparts.com/de/Regenbogen-Einhorn-Loetbausatz-Einfacher-Anstecker-fuer-Anfaenger/blink232242).
Es wurde nur ein anderer Schalter verwendet und die Beschriftung etwas modifiziert.
Expand Down
35 changes: 22 additions & 13 deletions doc/de/ProgExamples.md → docs/ProgExamples.de.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,16 @@
Um vorhandene Beispielprogramme auf die Platine zu installieren musst du [unsere Quelldateien](https://github.com/HaCraFu/assembly-kits/archive/refs/heads/main.zip) entpackt haben. Ungefähr so:
# Programmierbeispiele

## Download

Um vorhandene Beispielprogramme auf die Platine zu installieren musst du [unsere Quelldateien](https://github.com/HaCraFu/assembly-kits/archive/refs/heads/main.zip) entpackt haben. Ungefähr so:

https://user-images.githubusercontent.com/569476/201182708-acaa4405-1dc1-4569-b38f-cbbf6431099c.mp4
<figure class="video_container">
<video controls="true" allowfullscreen="true">
<source src="../assets/videos/extract.mp4" type="video/mp4">
</video>
</figure>

## Öffnen

Öffne dann in Visual Studio Code Ordner `firmware` um die folgenden Installationsbefehle ausführen zu können. Du darfst die Platine erst mit dem PC verbinden, wenn dich der Befehl mit dem Text
```
Expand All @@ -12,13 +19,15 @@ https://user-images.githubusercontent.com/569476/201182708-acaa4405-1dc1-4569-b3
dazu auffordert. Das ganze sieht dann ungefähr so aus:


https://user-images.githubusercontent.com/569476/201183405-0103f8cb-6e34-4ea9-b6d8-c2079674172b.mp4


<figure class="video_container">
<video controls="true" allowfullscreen="true">
<source src="../assets/videos/use_vscode.mp4" type="video/mp4">
</video>
</figure>

# Arrow
## Beispiel Arrow

Auf dem [Bau(m)satz](KitBaumsatz.md) zeigt dieses Programm eine kleine Pfeilanimation.
Auf dem [Bau(m)satz](KitBaumsatz.de.md) zeigt dieses Programm eine kleine Pfeilanimation.

Installieren mit dem Befehl
```
Expand All @@ -28,7 +37,7 @@ pio run -e arrow -t upload
Verändern des Programms in der Datei `firmware/src/arrow/main.cpp`


# Random
## Beispiel Random

Lässt zufällig eine der sechs LED beim Start leuchten. Keine Gewähr für [Gleichverteilung](https://de.wikipedia.org/wiki/Stetige_Gleichverteilung)!

Expand All @@ -40,7 +49,7 @@ pio run -e random -t upload
Verändern des Programms in der Datei `firmware/src/random/main.cpp`


# Random LED
## Beispiel Random LED

Wechselt nach kurzer Pause zu einer zufälligen LED.

Expand All @@ -52,7 +61,7 @@ pio run -e random_led -t upload
Verändern des Programms in der Datei `firmware/src/random_led/main.cpp`


# Provisioning Bau(m)satz
## Beispiel Provisioning Bau(m)satz

Die initiale Firmware. Schaltet nacheinander alle LEDs an. Wechselt danach alle 8 Sekunden zwischen LED-Paaren weiter.

Expand All @@ -64,7 +73,7 @@ pio run -e provisioning_baumsatz_usb -t upload
Verändern des Programms in der Datei `firmware/src/provisioning_baumsatz/main.cpp`


# Provisioning Unicorn
## Beispiel Provisioning Unicorn

Die initiale Firmware. Schaltet nacheinander alle LEDs an. Danach folgt eine Animation.

Expand All @@ -76,7 +85,7 @@ pio run -e provisioning_unicorn_usb -t upload
Verändern des Programms in der Datei `firmware/src/provisioning_unicorn/main.cpp`


# Keyboard
## Beispiel Keyboard

Beispielprogramm für Keyboardemulation.

Expand All @@ -91,7 +100,7 @@ pio run -e keyboard -t upload
Verändern des Programms in der Datei `firmware/src/keyboard/main.cpp`


# Touch dice
## Beispiel Touch dice

Beispielprogramm für Touch. Berührt man die USB-Pins mit dem feuchten Finger würfelt das Programm eine andere LED aus.

Expand Down
8 changes: 8 additions & 0 deletions docs/ProgSetupLinux.de.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Einrichtung der Programmierumgebung unter Linux

Installiere dir das Paket `platformio` um die Firmware kompilieren zu können.

Als Entwicklungsumgebung bietet sich [VS Code](https://code.visualstudio.com/docs/setup/linux) an.
Es bietet mit dem `platformio` Plugin eine gute Integration, aber jeder andere Editor tut es auch.

Eine Übersicht zu Programmierbeispielen und wie du sie ausführst findest du [hier](ProgExamples.de.md).
14 changes: 10 additions & 4 deletions doc/de/ProgSetupWindows.md → docs/ProgSetupWindows.de.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,20 @@
Die Programmierung unter Windows benötigt die Installation [dieses Treibers](https://github.com/digistump/DigistumpArduino/releases/download/1.6.7/Digistump.Drivers.zip). Hier eine kurze Videoanleitung:


https://user-images.githubusercontent.com/569476/201181683-92534c1a-1d4b-48df-86cc-ece778e53c06.mp4

<figure class="video_container">
<video controls="true" allowfullscreen="true">
<source src="../assets/videos/win_install_driver.mp4" type="video/mp4">
</video>
</figure>

## 2. Installation Platformio
Am einfachsten lässt sich der Microcontroller mit Hilfe von [Platformio](https://platformio.org/) unter Visual Studio Code programmieren. Hier eine kleine Videoanleitung:


https://user-images.githubusercontent.com/569476/201181769-0e4393ec-65b8-4a6d-b767-c9183d24455c.mp4
<figure class="video_container">
<video controls="true" allowfullscreen="true">
<source src="../assets/videos/win_install_vscode_pio.mp4" type="video/mp4">
</video>
</figure>

Wie im Video gezeigt, installiere bitte [Visual Studio Code](https://code.visualstudio.com/).
In Visual Studio Code installierst du dann die Erweiterung `PlatformIO`.
Expand Down
3 changes: 3 additions & 0 deletions docs/assets/images/baumsatz_back.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions docs/assets/images/baumsatz_front.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 61d83f0

Please sign in to comment.