Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

--- yms_handbuch [18.09.2026 07:00] – [Stauraum] thooge
+++ yms_handbuch [30.09.2026 06:19] (aktuell) – [Auswahllisten] thooge
@@ Zeile 1: / Zeile 1: @@
 ====== YMS Anleitung ======
-Hinweise zur Installation unter [[YMS Install]].
+Diese Anleitung geht davon aus, daß das System fertig istalliert wurde.
+Hinweise zur Installation gibt es unter [[YMS Install]].
 Grundlegende Bedienungshinweise sind auch in der Web-GUI eingebaut.
-Dazu auf das Buch-Symbol klicken.
+Dazu auf das Buch-Symbol oben in der Menüleiste klicken.
 Es gibt die Möglichkeit mit einem leeren System zu starten.
@@ Zeile 14: / Zeile 15: @@
 ===== Einstieg =====
+Inbetriebnahme des Programms
 ==== Leeres System ====
@@ Zeile 27: / Zeile 29: @@
 Es gibt einige vorbereitete Datensätze, die über SQL-Dateien direkt
-in die Datenbank eingespielt werden können.
+in die Datenbank eingespielt werden können:
+<code>
+mariadb yms < db/generic.sql
+</code>
 Geplant ist auch, einige Beispielboote bereitzustellen. Diese
@@ Zeile 43: / Zeile 48: @@
 Gurtpositionen für den Kran (achtern und vorne) erfaßt werden.
 gemessen ab Nullposition achtern.
+Die wichtigsten Daten werden direkt zu Yacht erfaßt. Zusätzliche
+Werte wie z.B. Vermessungsdaten können über die Meßwerte zugeordnet werden.
 ==== Koordinatensystem ====
@@ Zeile 52: / Zeile 61: @@
     * Backbordkoordinaten sind negativ
   * Z-Achse vertikal
-    * vom Wasserspiegel in Richtung Masttop
+    * von der Konstruktionswasserlinie nach oben in Richtung Masttop
-    * negative Werte sind unter der Wasseroberfläche
+    * negative Werte sind damit unter der Wasseroberfläche
 ===== Auswahllisten =====
@@ Zeile 67: / Zeile 76: @@
 Die Auswahllisten gelten gemeinsam für alle definierten Yachten.
-Einige Werte in den Auswahllisten sind als gesperrt markiert, diese werden
+Einige Werte in den Auswahllisten sind als gesperrt markiert (''fixed''), diese werden
 zwingend benötigt und können nicht verändert werden.
+Es kann auch eine gesamte Auswahlliste gesperrt sein (''locked''), dann kann diese
+überhaupt nicht bearbeitet werden, d.h. insbesondere keine weiteren Werte angefügt werden.
 ===== Stauraum =====
@@ Zeile 75: / Zeile 86: @@
 Die Lage eines Stauraums wird in Millimetern angegeben.
 Mit (x, y, z) wird der Mittelpunkt definiert,
-Die Abmaße werden mit (wx, wy, wz) angegeben, ebenfalls in Millimetern.
+Die Abmessungen werden mit (wx, wy, wz) angegeben, ebenfalls in Millimetern.
 Zusätzlich kann ein Winkel angegeben werden um den Stauraum in der Darstellung etwas um die Längsrichtung des Bootes gedreht anzeigen zu können.
@@ Zeile 84: / Zeile 95: @@
 Zusätzlich zu "normalem" Stauraum kann ein Stauraum auch als Tank oder etwas ganz anderes definiert werden.
 Die Stauraumtypen lassen sich über die Auswahllisten erweitern.
+==== Kapazität ====
 Für einen Stauraum kann optional eine Kapazität angegeben werden.
@@ Zeile 91: / Zeile 104: @@
   * stk – Stück
 Die Angabe ist optional. Für normale Stauräume wie Schapps oder Backskisten muß keine Kapazität angegeben werden.
-Die Kapazität beschreibt dabei nicht das geometrische Volumen des Stauraums. Die räumlichen Abmessungen werden unabhängig davon über Länge(wx), Breite(wy) und Höhe(wz) angegeben.
+Die Kapazität beschreibt die mögliche Inhaltsmenge und nicht das geometrische Volumen des Stauraums. Die räumlichen Abmessungen werden unabhängig davon über Länge(wx), Breite(wy) und Höhe(wz) angegeben.
-===== Kisten =====
-Zur besseren Organisation können Kisten angelegt werden.
-  * Kisten als Container für Dinge
+===== Box / Kisten / Beutel =====
-  * Es kann die Abmessung LxBxH angegeben werden
-  * Eine Kiste kann ein Gewicht haben
-  * Eine Kiste kann auch ein Eigengewicht haben
-  * Eine Kiste kann einen Preis haben
-  * Inventar kann in Kisten gelagert werden
-  * Eine Kiste muß einem Stauraum zugeordnet sein
+Zur besseren Organisation können Container angelegt werden.
+Eine Box ist eine Kiste wenn sie starre Abmessungen hat.
+Ohne diese Abmessungen kann es sich auch um einen Beutel handeln.
+  * Es kann die Abmessung LxBxH angegeben werden
+  * Eine Box kann ein Gewicht haben
+  * Eine Box kann auch ein Eigengewicht haben
+  * Eine Box kann einen Preis haben
+  * Inventar kann in Box gelagert werden
+  * Eine Box muß einem Stauraum zugeordnet sein
+Es ist vom System nicht vorgesehen Boxen zu verschachteln.
+Ein Sonderfall wäre der o.a. Beutel, der in einer Kiste liegen könnte.
+Das Datenmodell sieht hierfür ein Feld (''parent'') vor.
 ===== Ausrüstung  =====
-Unterscheidbare, fest dem Boot zugeordnete Dinge.
+Ausrüstung sind Dinge die fest zum Boot gehören.
 Ausrüstung hat einen Hersteller und Lieferanten und kann gewartet werden.
 Es kann unter anderem eine Seriennummer, Kaufdatum und Preis eingegeben werden.
 Einer Ausrüstung können Dokumente wie Handbücher, Fotos und Rechnungen zugeordnet werden.
+==== Gewicht und Position ====
+Für Ausrüstung kann optional das Gewicht angegeben werden.
+Ebenfalls optional kann die Position des Schwerpunkts angegeben werden. Diese wird in Millimetern
+relativ zum Boot über (x, y, z) angegeben.
 ===== Inventar  =====
@@ Zeile 119: / Zeile 146: @@
   * Das Gewicht bezieht sich auf ein einzelnes Teil. Über die Anzahl kann das Gesamtgewicht ermittelt werden
+Wichtig: Es besteht absichtlich keine Verknüpfung direkt zur Yacht.
+Diese kann indirekt über den Stauraum oder eine Kiste ermittelt werden.
+Damit ist es z.B. leicht möglich eine Kiste mit einer Menge Inventar zu
+einem anderen Boot oder in ein Lager zu verschieben.
 ===== Proviant =====
@@ Zeile 199: / Zeile 230: @@
 Können zu verschiedenen Objekten vergeben werden.
 Haben optional eine Farbe und eine Beschreibung.
+===== Freie Eigenchaften =====
+Die Objekte Yacht, Ausrüstung, Inventar, Projekt und Wartung können neben den Standardeigenschaften auch noch weitere, frei definierbare Eigenschaften besitzen.
+Diese werden als Schlüssel-Wert-Paare separat gespeichert und können für selten genutzte oder spezielle Eigeschaften genutzt werden.
+Als Beispiel: Einem Funkgerät könnte MMSI und Callsign zugeordnet werden.
 ===== Dokumente =====
-  * Dokument
+  * Dokument (PDF)
     * Allgemein
     * Rechnung
     * Handbuch
-  * Bild
+  * Bild (PNG oder JPG)
-  * Zeichnung
+  * Zeichnung (SVG)
+Dokumente können verschiedenen Objekten zugeordnet werden:
+  * einer Yacht
+  * einer Box
+  * einem Ausrüstungsgegenstand
+  * einem Projekt
+  * einer Wartung
+  * einer Aufgabe
+  * einem Benutzer
+  * einer Firma
+Dabei sind Mehrfachzuordnungen möglich oder aber Dokumente ganz ohne
+Zuordnung.
 ===== Signal K =====
@@ Zeile 215: / Zeile 265: @@
 Dazu muß der Server in den Einstellungen definiert werden.
 Zusätzlich die Signal K - Datenpfade in der Zuordnungstabelle ''signalk''.
-Eine graphische Oberfläche dafür gibt es in der aktuellen Version nicht.
+Die Zuordnung kann über ''mid'' mit einem Messwert verknüpft werden:
+  * Ist ''mid'' gesetzt, übernimmt YMS den bei der Abfrage von Signal K ermittelten Wert in den zugeordneten Messwert.
+  * Ist ''mid'' nicht gesetzt, kann der Signal-K-Wert weiterhin live abgefragt werden, wird jedoch nicht als Messwert in YMS gespeichert.
+Eine graphische Oberfläche für diese Funktion dafür gibt es in der aktuellen Version nicht.
+===== Backup =====
+Für eine Datensicherung empfiehlt es sich einen USB-Stick zu verwenden.
+Dieser kann einfach an den Raspberry angesteckt werden und steht dann als
+Datenspeicher mit ausreichender Kapazität zur Verfügung.
+Es muß gesichert werden
+  * Die Datenbank mit ''mysqldump''<code>
+mysqldump -Q --single-transaction yms | gzip -9 > /path/to/usbstick/yms_$(date +"%Y%m%d").gz
+</code>
+  * Das Dokumentenverzeichnis am besten mit RSync<code>
+rsync -av --exclude='/thumb/' /var/local/lib/yms/ /path/to/usbstick/yms_$(date +"%Y%m%d")/
+</code>