From 933a0474f59f1eb5af71744893f81c37b7979bf2 Mon Sep 17 00:00:00 2001 From: Dorian Zedler Date: Fri, 15 Jan 2021 17:47:52 +0100 Subject: [PATCH] Added more docs --- .vscode/settings.json | 41 ++++++++++++++++++++++---- de/README.md | 10 ++++++- de/basics.md | 21 ------------- de/components.md | 16 ---------- de/introduction/components.md | 40 +++++++++++++++++++++++++ de/usage/basics.md | 54 ++++++++++++++++++++++++++++++++++ de/usage/race-configuration.md | 27 +++++++++++++++++ index.dev.js | 17 +++++++++-- 8 files changed, 181 insertions(+), 45 deletions(-) delete mode 100644 de/basics.md delete mode 100644 de/components.md create mode 100644 de/introduction/components.md create mode 100644 de/usage/basics.md create mode 100644 de/usage/race-configuration.md diff --git a/.vscode/settings.json b/.vscode/settings.json index 5758150..4b78844 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -1,6 +1,37 @@ { - "cSpell.words": [ - "komponenten" - ], - "ltex.language": "de-DE" -} \ No newline at end of file + "cSpell.words": ["komponenten"], + "ltex.language": "de-DE", + "ltex.dictionary": { + "en-US": ["adaptivity", "precomputed", "subproblem"], + "de-DE": [ + "Startpad", + "Toppad", + "start", + "sequence", + "At", + "your", + "marks", + "Ready", + "delay", + "Delay", + "Delays", + "ScStw", + "ScStwBasestation", + "Basestation", + "base", + "station", + "connect", + "settings", + "extensions", + "ScStwApp", + "Appstore", + "Lanes", + "Lane", + "Startpads", + "Toppads", + "Technical", + "incident" + ] + }, + "ltex.disabledRules": { "de-DE": ["TYPOGRAFISCHE_ANFUEHRUNGSZEICHEN"] } +} diff --git a/de/README.md b/de/README.md index 8ea652b..be918ff 100644 --- a/de/README.md +++ b/de/README.md @@ -1,11 +1,19 @@ # Über die Speed Climbing Stopwatch + Die Speed Climbing Stopwatch, ab jetzt nur noch ScStw genannt, ist eine Anlage zum Messen von Zeiten beim Speed-Klettern. Im Vergleich zu anderen, ähnlichen Anlagen hat sie folgende Vorteile: - Sie ist komplett Kabellos, alle Komponenten interagieren über WLAN. - Dadurch ist sie sehr schnell aufbaubar, die Komponenten müssen nur eingeschaltet werden, der Rest passiert automatisch. Kabel verlegen war gestern. -- Sie ist die erste derartige Stoppuhr auf dem Markt, die auch die Ansagen "At your marks" und "Ready" autonom wiedergeben kann. +- Sie ist die erste derartige Stoppuhr auf dem Markt, die auch die Ansagen "At your marks" und "Ready" automatisch wiedergeben kann. - Durch diesen Automatismus ist es auch alleine möglich mit ihr zu Wettkampf-gerechten Bedingungen zu trainieren. - Die Bedienung der ScStw stammt aus dem 21. Jahrhundert: Sie wird ausschließlich über eine App bedient und ist sehr einfach zu handhaben. - Sie ist erschwinglich genug, dass auch Athleten und lokale Verbände sie für ihr Training verwenden können. Auf den folgenden Seiten finden sich detaillierte Anleitungen rund um die ScStw. + + + +Dies ist die erste Version dieser Anleitung, sie kann daher Fehler enthalten.
+Falls sie einen Fehler oder eine Lücke finden, wenden sie sich gerne über unsere Webseite oder per Mail an contact@itsblue.de an uns. + + diff --git a/de/basics.md b/de/basics.md deleted file mode 100644 index 8797598..0000000 --- a/de/basics.md +++ /dev/null @@ -1,21 +0,0 @@ -# Grundlagen der ScStw -Um die ScStw zu benutzen, wird die [ScStw-App](https://itsblue.de/apps/speed-climbing-stopwatch) benötigt. -Sie steht im Google Playstore und im Apple Appstore zum Download zur Verfügung. - -## WLAN-Verbingung zur Basestation -Um eine Verbindung mit der ScStwBasestation herzustellen, muss ein Gerät, auf dem die ScStwApp installiert ist, mit dem WLAN-Hotspot der Basestation verbunden werden. Da der Hotspot aus Sicherheitsgründen nicht sichtbar ist, muss das Netzwerk in den jeweiligen Einstellungen manuell hinzugefügt werden. -Die entsprechende Einstellung findet man in der Regel unter WLAN > Netzwerk hinzufügen. Als Netzwerkname ist der Name der ScStw zu wählen. Bei Sicherheit muss WPA2/PSK gewählt werden. Den Namen und das Passwort erfahren sie beim Kauf der Stoppuhr. -Es ist im Moment nicht möglich, Name oder Passwort der ScStw zu ändern, wir arbeiten aber daran. - -## Verbindung von App und Basestation -In der ScStwApp findet sich in den Einstellungen der Eintrag "base station". -Dort lässt sich durch einen Klick auf den obersten Eintrag "connect" die Verbindung zu Basestation herstellen. -War die Verbindung erfolgreich, erscheint im Kästchen rechts ein grüner Haken. - -## Konfiguration der Basestation -Ist erfolgreich eine Verbindung hergestellt, kann die Basestation konfiguriert werden. -Unter dem Eintgrag "settings" finden sich einige grundlegende Funktionen, wie die Lautstärke der Basestation und der Wettkampfmodus. [Weitere Informationen](/competition-mode). -Unter dem Eintrag "extensions" findet sich eine Übersicht aller konfigurierten Pads und ihrem status. [Weitere Informationen](/configure-extensions). - -## Starten eines Rennes -Um ein Rennen zu starten, muss nur auf der Startseite der ScStwApp auf "start" getippt werden. \ No newline at end of file diff --git a/de/components.md b/de/components.md deleted file mode 100644 index e5b3600..0000000 --- a/de/components.md +++ /dev/null @@ -1,16 +0,0 @@ -# Die Komponenten der ScStw -Die ScStw ist sehr modular und besteht aus mehreren Teilen, die verschiedene Funktionen erfüllen. - -## Die Basestation -Die Basestation ist die zentrale Steuereinheit der ScStw. Sie steuert das Rennen und gibt sowohl den IFSC Startton als auch die Ansagen "At your marks" und "Ready" wieder. - -## Die App -Die App wird für die Bedienung der ScStw verwendet. Über sie kann alles gesteuert und eingestellt werden, was nötig ist um Zeitmessungen durchzuführen. - -## Die Startpads -Die Startpads werden verwendet, um Fehlstarts der Kletterer zu erkennen. Sie verbinden sich Kabellos mit der Basestation und agiren autonom. -Für jede Lane wird - -## Die Toppads -Die Toppads sind dazu da, die Zeitmessung zu beenden, sobald der Athlet oben angekommen ist. -Dafür werden sie oben an der Wand an einer festgelegten Position befästigt. \ No newline at end of file diff --git a/de/introduction/components.md b/de/introduction/components.md new file mode 100644 index 0000000..28a1d8f --- /dev/null +++ b/de/introduction/components.md @@ -0,0 +1,40 @@ +# Die Komponenten der ScStw + +Die ScStw ist sehr modular und besteht aus mehreren Teilen, die verschiedene Funktionen erfüllen. Sie eignet sich daher für den Einsatz auf zwei oder nur einer Lane. + +## Die Basestation + +Die Basestation ist die zentrale Steuereinheit der ScStw. Sie steuert das Rennen und gibt sowohl den IFSC Startton als auch die Ansagen "At your marks" und "Ready" wieder. + + + +## Die App + +Die App wird für die Bedienung der ScStw verwendet. Über sie kann alles gesteuert und eingestellt werden, was nötig ist um Zeitmessungen durchzuführen. + +## Die Toppads + +Die Toppads sind dazu da, die Zeitmessung zu beenden, sobald der Athlet oben angekommen ist. +Dafür werden sie oben an der Wand an einer festgelegten Position befestigt. +Sie verbinden sich kabellos mit der Basestation und agieren autonom. +Für jede Lane wird ein Toppad benötigt. + + + + +## Die Startpads + +Die Startpads werden verwendet, um Fehlstarts der Athlet zu erkennen. +Sie verbinden sich kabellos mit der Basestation und agieren autonom. +Für jede Lane wird ein Startpad benötigt. + + \ No newline at end of file diff --git a/de/usage/basics.md b/de/usage/basics.md new file mode 100644 index 0000000..58d8cc4 --- /dev/null +++ b/de/usage/basics.md @@ -0,0 +1,54 @@ +# Grundlagen der ScStw + +Um die ScStw zu benutzen, wird die [ScStw-App](https://itsblue.de/apps/speed-climbing-stopwatch) benötigt. +Sie steht im Google Playstore und im Apple Appstore zum Download zur Verfügung. + +## WLAN-Verbindung zur Basestation + +Um eine Verbindung mit der ScStwBasestation herzustellen, muss ein Gerät, auf dem die ScStwApp installiert ist, mit dem WLAN-Hotspot der Basestation verbunden werden. Da der Hotspot aus Sicherheitsgründen nicht sichtbar ist, muss das Netzwerk in den jeweiligen Einstellungen manuell hinzugefügt werden. +Die entsprechende Einstellung findet man in der Regel unter WLAN > Netzwerk hinzufügen. Als Netzwerkname ist der Name der ScStw zu wählen. Bei Sicherheit muss WPA2/PSK gewählt werden. Den Namen und das Passwort erfahren sie beim Kauf der Stoppuhr. +Es ist im Moment nicht möglich, Name oder Passwort der ScStw zu ändern, wir arbeiten aber daran. + +## Verbindung von App und Basestation + +In der ScStwApp findet sich in den Einstellungen der Eintrag "base station". +Dort lässt sich durch einen Klick auf den obersten Eintrag "connect" die Verbindung zu Basestation herstellen. +War die Verbindung erfolgreich, erscheint im Kästchen rechts ein grüner Haken. +Falls stattdessen ein rotes Ausrufezeichen erscheint, ist die Verbindung fehlgeschlagen. Überprüfen Sie in diesem Fall bitte, ob ihr Gerät mit dem WLAN_Netzwerk der Basestation verbunden ist und starten sie die Basestation gegebenenfalls neu. + +Sobald die Verbindung hergestellt ist, erscheinen in der oberen rechten Ecke der App einige Symbole: +- Das Pyramiden-Symbol zeigt, dass eine Verbindung besteht. +- Die Farbe der Kästchen mit "A" und "B" zeigt den Status der Lanes: + - Grün: Beide Pads sind verbunden und haben den Akkustand "ok". + - Gelb: Beide Pads sind verbunden, doch mindestens eins hat den Akkustand "Warnung" + - Rot: Nicht alle Pads sind verbunden, oder mindestens eins hat den Akkustand "kritisch" + +## Konfiguration der Basestation + +Ist erfolgreich eine Verbindung hergestellt, kann die Basestation konfiguriert werden. +- Unter dem Eintrag "settings" finden sich einige grundlegende Funktionen, wie die Lautstärke der Basestation und der Wettkampfmodus. [Weitere Informationen](/usage/race-configuration#der-wettkampfmodus). + + + +Die maximale Lautstärke ist sehr hoch und kann bei zu geringem Abstand zu der Basestation zu Gehörschäden führen. + + + +- Unter dem Eintrag "extensions" findet sich eine Übersicht aller konfigurierten Pads und ihrem Status. Ein Pad ist verbunden, wenn das Kästchen rechts einen grünen Haken enthält. Außerdem gibt es drei mögliche Akkustände: + - "gut": Der Akku ist grün + - "Warnung": Der Akku ist gelb und sollte demnächst aufgeladen werden + - "kritisch": Der Akku ist rot und muss unverzüglich aufgeladen werden. + +## Verbinden der Pads + +Um die Pads mit der Basestation zu verbinden, müssen sie nur angeschaltet werden. Alles Weitere passiert automatisch. + + + +Bei neueren Versionen der ScStw ist der An-/Ausschalter in die Pads eingelassen, um zu verhindern, dass diese aus Versehen betätigt werden. Mit einem Kugelschreiber ist es dennoch leicht möglich, sie zu betätigen. + + + +## Starten eines Rennes +Um ein Rennen zu starten, muss nur auf der Startseite der ScStwApp auf "start" getippt werden. +Weitere Informationen zur Konfiguration des Rennens finden sie unter dem Punkt [Konfiguration des Rennens](/race-configuration). \ No newline at end of file diff --git a/de/usage/race-configuration.md b/de/usage/race-configuration.md new file mode 100644 index 0000000..18f9fba --- /dev/null +++ b/de/usage/race-configuration.md @@ -0,0 +1,27 @@ +# Konfigurieren eines Rennens + +## Automatische Ansagen + +Die ScStw ist in der Lage, die Ansagen "At your marks" und "Ready" autonom wiederzugeben. +Diese können in den Einstellungen der App im Eintrag "start sequence" konfiguriert werden. Das hie anzugebende "delay" ist die Länge der Verzögerung bevor die jeweilige Ansage gemacht wird. + + + +Wenn der Wettkampfmodus aktiviert ist, müssen beide Starter für die Dauer des Delays vor der Ansage "Ready" auf dem Startpad stehen, damit das Rennen beginnt. Hebt einer der Athleten seinen Fuß, beginnt das Delay von vorne. + + + +## Aktivieren und Deaktivieren von Lanes + +Einzelne Lanes lassen sich aktivieren und deaktivieren, hierbei gibt es aber Unterschiede, je nachdem, ob der Wettkampfmodus aktiviert ist, oder nicht: +- **Ist der Wettkampfmodus deaktiviert**, geschieht die Aktivierung und Deaktivierung der Lanes automatisch. Lane A ist hierbei immer aktiviert und Lane B wird aktiviert, sobald ein Pad verbunden ist. +- **Ist der Wettkampfmodus aktiviert**, muss die Aktivierung und Deaktivierung der Lanes manuell vorgenommen werden. Standardmäßig sind immer beide Lanes aktiviert. Beim Start des Rennens kann eine Lane deaktiviert werden (zum Beispiel, wenn ein Athlet durch einen Fehlstart alleine starten muss). Dazu muss die entsprechende Lane in der App beim Start nur angetippt werden. Nach dem Ende des Einzelrennens sind automatisch wieder beide Lanes aktiv. + +## Der Wettkampfmodus + +Ist die ScStw im Wettkampfmodus, verändert sich ihr Verhalten an einigen Stellen: +- beim Start eines Rennens müssen die Startpads aller aktiven Lanes gedrückt sein. +- Die Aktivierung/Deaktivierung der Lanes erfolgt nicht automatisch (siehe oben). +- Ist ein Pad nicht verbunden oder hat einen kritischen Akkustand, ist es nicht möglich ein Rennen zu starten. +- Verliert ein Pad während einem Rennen oder während des Starts die Verbindung, wir das Rennen sofort mit der Meldung "Technical incident" abgebrochen. +- Veränderungen an der ScStw, die den Betrieb unterbrechen könnten, sind nicht möglich. (zum Beispiel Firmware Updates) diff --git a/index.dev.js b/index.dev.js index aa2fea0..7576988 100644 --- a/index.dev.js +++ b/index.dev.js @@ -26,7 +26,7 @@ new Docute({ }, { title: "Komponenten", - link: "/components", + link: "/introduction/components", }, ], }, @@ -35,11 +35,24 @@ new Docute({ children: [ { title: "Grundlagen", - link: "/basics", + link: "/usage/basics", + }, + { + title: "Konfiguration des Rennens", + link: "/usage/race-configuration", }, ], }, ], + + // Define footer + footer: ` +
+ Hinweis zum Sprachgebrauch: Aus Gründen der besseren Lesbarkeit wird auf die Verwendung der männlichen und weiblichen Sprachform verzichtet. Sämtliche Personenbezeichnungen gelten für alle Geschlechter.

+ Sie haben weitere Fragen? Wenden sie sich gerne über unsere Webseite oder per Mail an contact@itsblue.de an uns.
+ © ${new Date().getFullYear()} Itsblue Development. +
+ `, }, }, detectSystemDarkTheme: true,