docs(scanstation(: Full Docs

content/scanstation/_index.de.md

@@ -0,0 +1,37 @@
+---
+linkTitle: "Scannerstationen"
+title: Über die Scannerstationen
+weight: 1
+prev: /
+next: /scanstation/install
+cascade:
+  type: docs
+---
+
+Die Scannerstation ist die Kombination aus Hardware und Software, die dazu genutzt wird Läuferkarten zu scannen und damit gelaufene Distanzen im System zu erfassen.
+Wir schreiben grundsätzlich keine Hardware oder Software vor - stellen aber selbst eine Software bereit und empfehlen Hardware.
+
+Die API für Scannerstationen im Läufersystem ist grundsätzlich so gestaltet, dass Scans live erfasst und validiert (Läufer, Track, Rundenzeit) werden.
+
+## Bedienung
+
+{{< callout type="info" >}}
+  Die Bedienung kann erst nach der [Konfiguration](./config) erfolgen.
+{{< /callout >}}
+
+
+Die Bedienung der Software als Helfer an der Scannerstation ist relativ einfach.
+
+
+{{% steps %}}
+
+### Scannen
+
+Den Handscanner auf den Barcode der Läuferkarte halten und auf den Bestätigungs-Ton warten.
+
+### Validierung
+
+Schau auf den Bildschirm deiner Scannerstation, ob der Scan valide war.
+Hier wird auch die aktuelle Kilometerzahl und die Rundenzeit angezeigt.
+
+{{% /steps %}}

content/scanstation/_index.en.md

@@ -0,0 +1,35 @@
+---
+linkTitle: "Scannerstationen"
+title: "About the Scanner Stations"
+weight: 1
+prev: /
+next: /scanstation/install
+cascade:
+  type: docs
+---
+
+The scanner station is the combination of hardware and software used to scan runner cards and record the distances run in the system.
+We do not prescribe any specific hardware or software - but we do provide our own software and recommend hardware.
+
+The API for scanner stations in the runner system is designed to capture and validate scans live (runner, track, lap time).
+
+## Operation
+
+{{< callout type="info" >}}
+  Operation can only be performed after [configuration](./config).
+{{< /callout >}}
+
+Operating the software as a helper at the scanner station is relatively simple.
+
+{{% steps %}}
+
+### Scanning
+
+Hold the handheld scanner over the barcode of the runner card and wait for the confirmation tone.
+
+### Validation
+
+Look at the screen of your scanner station to see if the scan was valid.
+The current kilometer count and lap time are also displayed here.
+
+{{% /steps %}}

content/scanstation/config.de.md

@@ -0,0 +1,48 @@
+---
+title: Scannerstation Konfig
+weight: 3
+prev: /scanstation/install
+---
+
+## Start
+
+{{% steps %}}
+
+### API Endpunkt
+
+Wenn du die Scanclient Software öffnest wirst du als erstes nach einem API Endpunkt gefragt.
+Hier musst du die URL deines LfK-Backends eintragen (z.B.: `https://lauf-fuer-kaya.de`).
+
+### Client-Token
+
+Als nächstes musst du noch einen Client Token gefragt.
+Die Anlage ist unter [Token anlegen](/user/scanstation) beschrieben.
+
+### Bestätigen
+
+Solltest du dich beim API-Endpunkt vertippt haben kannst du anstatt eines Client Token auch `rst` eingeben, um diesen nochmal zu setzen.
+Sobald du den Token eingegeben hast kannst du auf den Button "Konfigurieren" klicken und der Scanclient wird gestartet.
+
+{{% /steps %}}
+
+## Konfiguration ändern
+
+{{% steps %}}
+
+### Config-Modus starten
+
+Tippe `cnf` in das Läuferkarten-Feld und bestätige mit Enter.
+
+### Config-Modus
+
+Jetzt öffnet sich die Konfigurationsübersicht, in der alle Details zur Konfigurierten Scannerstation aufgelistet sind.
+
+### Einstellungen speichern
+
+Wenn du fertig bist kannst du über den Button "Back to Scanner" wieder in den Scan-Modus wechseln.
+
+### Abmelden
+
+Wenn du die Software vom Läufersystem abmelden oder den Token ändern willst klicke auf "Log out from this Client".
+
+{{% /steps %}}

content/scanstation/config.en.md

@@ -0,0 +1,48 @@
+---
+title: Scanner Station Configuration
+weight: 3
+prev: /scanstation/install
+---
+
+## Start
+
+{{% steps %}}
+
+### API Endpoint
+
+When you open the Scanclient software, you will first be asked for an API endpoint.
+Here you need to enter the URL of your LfK backend (e.g., `https://lauf-fuer-kaya.de`).
+
+### Client Token
+
+Next, you will be asked for a Client Token.
+The setup is described under [Create Token](/user/scanstation).
+
+### Confirm
+
+If you made a typo in the API endpoint, you can enter `rst` instead of a Client Token to set it again.
+Once you have entered the token, you can click the "Configure" button and the Scanclient will start.
+
+{{% /steps %}}
+
+## Change Configuration
+
+{{% steps %}}
+
+### Start Config Mode
+
+Type `cnf` in the runner card field and press Enter.
+
+### Config Mode
+
+Now the configuration overview opens, listing all the details of the configured scanner station.
+
+### Save Settings
+
+When you are done, you can switch back to scan mode by clicking the "Back to Scanner" button.
+
+### Log Out
+
+If you want to log out the software from the runner system or change the token, click on "Log out from this Client".
+
+{{% /steps %}}

content/scanstation/hardware.de.md

@@ -0,0 +1,19 @@
+---
+title: Hardwareempfehlungen
+weight: 4
+prev: /scanstation/config
+---
+
+Known-good Hardware, die wir für die Scannerstationen empfehlen können.
+
+## Computer
+
+* Raspberry Pi 3 oder neuer
+* Prozessor: Minimum: Intel Core 2 Duo
+* Arbeitsspeicher: Minimum 4GB
+
+## Barcodescanner
+
+* Datalogic Gryphon GD4130-BK/WH USB Scanner (1D)
+* Datalogic Gryphon GD4200 USB Scanner (1D)
+* Datalogic Gryphon GD4400 USB Scanner (2D)

content/scanstation/hardware.en.md

@@ -0,0 +1,19 @@
+---
+title: Hardware Recommendations
+weight: 4
+prev: /scanstation/config
+---
+
+Known-good hardware that we can recommend for the scanning stations.
+
+## Computer
+
+* Raspberry Pi 3 or newer
+* Processor: Minimum: Intel Core 2 Duo
+* Memory: Minimum 4GB
+
+## Barcode Scanner
+
+* Datalogic Gryphon GD4130-BK/WH USB Scanner (1D)
+* Datalogic Gryphon GD4200 USB Scanner (1D)
+* Datalogic Gryphon GD4400 USB Scanner (2D)

content/scanstation/install.de.md

@@ -0,0 +1,71 @@
+---
+title: Scannerstation Installation
+weight: 2
+prev: /scanstation
+next: /scanstation/config
+---
+
+Es gibt aktuell zwei Varianten, um die Scanclient Software zu installieren/nutzen.
+
+1. Als Livesystem starten (empfohlen)
+2. Für Windows oder Linux herunterladen
+
+## Livesystem
+
+{{< callout type="info" >}}
+  Wir empfehlen die Nutzung des Livesystems, da es keine Installation erfordert und immer die aktuellste Version verwendet.
+{{< /callout >}}
+
+{{% steps %}}
+
+### Download
+
+Lade dir die aktuellste Version des Betriebssystems herunter: [Versionsübersicht](https://git.odit.services/lfk/scanclient-live/releases)
+
+* Den neusten (obersten) Release auswählen.
+* Unter "Downloads" die Datei lfk-scanclient-live_X.Y.Z_x64.zip anklicken
+
+### Stick Formatieren
+
+Einen USB-Stick einstecken und als FAT32 formatieren (Achtung: Hierbei gehen alle Daten verloren, die auf dem Stick sind).
+
+### Kopieren und Entpacken
+
+Die ZIP-Datei auf den Stick kopieren und entpacken.
+Du solltest einen neuen Order `slax` erhalten
+
+### Den Stick bootfähig machen
+
+* Windows: Die Datei `USBSTICK\slax\boot\bootinst.bat` als Administrator ausführen
+* Linux/Mac: Die Datei `USBSTICK/slax/boot/bootinst.sh` mit Root-Rechten (sudo) ausführen
+
+### Booten
+
+Den Stick in den Rechner deiner Wahl einstecken und von ihm Starten.
+Bei den meisten Rechner geht das, indem du beim Hochfahren F12 und/oder Entf drückst und dann den USB-Stick auswählst.
+
+{{% /steps %}}
+
+## Windows/Linux
+
+{{% steps %}}
+
+### Herunterladen
+
+Programm aus dem Git Repo herunterladen: [Versionsübersicht](https://git.odit.services/lfk/scanclient-electron/releases)
+
+* Den neusten (obersten) Release auswählen.
+* Unter "Downloads" die Datei für dein Betriebssystem anklicken
+  * Windows: `@lfk-scanclient-electron-win32-x64.zip`
+  * Linux: `@lfk-scanclient-electron-linux-x64.zip`
+
+### Entpacken
+
+Die ZIP-Datei entpacken und den Ordner `lfk-scanclient-electron-win32-x64` öffnen.
+
+### Starten
+
+* Windows: Die Datei `@lfk-scanclient-electron.exe` öffnen.
+* Linux: Die Datei `@lfk-scanclient-electron` öffnen.
+
+{{% /steps %}}

content/scanstation/install.en.md

@@ -0,0 +1,71 @@
+---
+title: Scannerstation Installation
+weight: 2
+prev: /scanstation
+next: /scanstation/config
+---
+
+There are currently two ways to install/use the Scanclient software.
+
+1. Start as a live system (recommended)
+2. Download for Windows or Linux
+
+## Live System
+
+{{< callout type="info" >}}
+  We recommend using the live system as it requires no installation and always uses the latest version.
+{{< /callout >}}
+
+{{% steps %}}
+
+### Download
+
+Download the latest version of the operating system: [Version Overview](https://git.odit.services/lfk/scanclient-live/releases)
+
+* Select the latest (top) release.
+* Under "Downloads" click on the file lfk-scanclient-live_X.Y.Z_x64.zip
+
+### Format Stick
+
+Insert a USB stick and format it as FAT32 (Warning: This will erase all data on the stick).
+
+### Copy and Unzip
+
+Copy the ZIP file to the stick and unzip it.
+You should get a new folder `slax`
+
+### Make the Stick Bootable
+
+* Windows: Run the file `USBSTICK\slax\boot\bootinst.bat` as Administrator
+* Linux/Mac: Run the file `USBSTICK/slax/boot/bootinst.sh` with root privileges (sudo)
+
+### Boot
+
+Insert the stick into the computer of your choice and boot from it.
+On most computers, you can do this by pressing F12 and/or Delete during startup and then selecting the USB stick.
+
+{{% /steps %}}
+
+## Windows/Linux
+
+{{% steps %}}
+
+### Download
+
+Download the program from the Git repo: [Version Overview](https://git.odit.services/lfk/scanclient-electron/releases)
+
+* Select the latest (top) release.
+* Under "Downloads" click on the file for your operating system
+  * Windows: `@lfk-scanclient-electron-win32-x64.zip`
+  * Linux: `@lfk-scanclient-electron-linux-x64.zip`
+
+### Unzip
+
+Unzip the ZIP file and open the folder `lfk-scanclient-electron-win32-x64`.
+
+### Start
+
+* Windows: Open the file `@lfk-scanclient-electron.exe`.
+* Linux: Open the file `@lfk-scanclient-electron`.
+
+{{% /steps %}}