====== YMS Anleitung ======
Hinweise zur Installation unter [[YMS Install]].
Grundlegende Bedienungshinweise sind auch in der Web-GUI eingebaut.
Dazu auf das Buch-Symbol klicken.
Es gibt die Möglichkeit mit einem leeren System zu starten.
Der Vorteil dabei ist, daß man alles nach eigenen Wünschen
einstellen kann ohne viel zu löschen. Der Nachteil natürlich
daß viele Vorüberlegungen angestellt werden müssen und sich
der Beginn "zäher" gestaltet.
===== Einstieg =====
Inbetriebnahme des Programms
==== Leeres System ====
Folgende Schritte sind bevorzugt in dieser Reihenfolge abzuarbeiten:
- Anlage der Benutzer
- Anlage des Bootsdatensatzes
- Anlage der Auswahllisten
- Anlage der Stauräume und ggf. Kisten
- Anlage der Hersteller der verwendeten Ausrüstungsgegenstände
- Anlage der persönlich genutzen Lieferanten
==== System mit Basisdaten ====
Es gibt einige vorbereitete Datensätze, die über SQL-Dateien direkt
in die Datenbank eingespielt werden können.
Geplant ist auch, einige Beispielboote bereitzustellen. Diese
können komplett importiert werden und im Normalfall sollten nur
einige Kleinigkeiten angepaßt werden müssen.
Insbesondere vordefinierte Stauräume mit korrekten Koordinaten sollten vorhanden sein.
Wichtig ist, keine Daten einzuspielen die nachher ggf. nicht genutzt
werden. Die Basisdaten tauchen in Auswahllisten auf die dann unnötig
lang werden.
===== Yacht =====
Neben den normalen Daten wie Länge, Breite etc. können auch die
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 ====
Koordinatenursprung ist die achtere Bootsmitte Auf Wasserspiegelebene.
* X-Achse von achtern nach vorn. Negative X-Werte sind nicht zulässig
* Y-Achse in Richtung Bootsbreite
* Steuerbord-Koordinaten sind positiv
* Backbordkoordinaten sind negativ
* Z-Achse vertikal
* von der Konstruktionswasserlinie nach oben in Richtung Masttop
* negative Werte sind damit unter der Wasseroberfläche
===== Auswahllisten =====
* Einheiten \\ z.B. kg, m, etc.
* Firmentypen \\ z.B. Lieferant, Hersteller, Werft, etc.
* Stauraumtypen
* Kategorien für Ausrüstung \\ z.B. Rumpf, Deck, Rigg, Elektrik, etc.
* Kategorien für Proviant \\ z.B. Getränke, Konserven, Naschkram, etc.
* Einheiten für Proviant \\ z.B. kg, Liter, Stück, Dose, etc.
* Kistentypen \\ z.B. Werkzeugkiste, Plastikbox, Sortimentskasten etc.
Die Auswahllisten gelten gemeinsam für alle definierten Yachten.
Einige Werte in den Auswahllisten sind als gesperrt markiert, diese werden
zwingend benötigt und können nicht verändert werden.
===== Stauraum =====
Stauraum ist fest mit dem Boot verbunden.
Die Lage eines Stauraums wird in Millimetern angegeben.
Mit (x, y, z) wird der Mittelpunkt definiert,
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.
Bei Neuanlage einer Yacht empfiehlt es sich einen Stauraum "An Bord" o.ä. anzulegen.
Dieser Stauraum kann der Yacht als Standard-Stauraum zugeordnet werden.
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.
Die Kapazität besteht aus einem Zahlenwert und einer Einheit. Zur Verfügung stehen:
* l – Liter
* kg – Kilogramm
* 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 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
* 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
===== Ausrüstung =====
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 =====
* kann einem Stauraum zugeordnet werden
* kann in Kisten gelegt werden
* kann einer Ausrüstung zugeordnet werden und dient dann als Ersatzteil für diese
* kann zwischen Booten bewegt werden
* Das Gewicht bezieht sich auf ein einzelnes Teil. Über die Anzahl kann das Gesamtgewicht ermittelt werden
===== Proviant =====
Da das Proviant Einfluß auf die Stauraumbelegung hat, wird es im System
ebenfalls abgebildet:
* hat ein Haltbarkeitsdatum
* kann in das System vorab ohne Yachtzuordnung eingebucht werden
* hat ein Brutto- und Nettogewicht
* hat zugeordnete Kalorien
===== Projekte =====
* Projekte haben zugeordnete Aufgaben
* Projekte werden einmalig durchgeführt
* Sie sollen einen Zeitrahmen und einen Gesamtstatus mitführen
* Es muß immer eine verantwortliche Person geben
* geplant ist ggf. Kosten mitführen zu können
===== Kabel =====
Kabel haben spezielle Eigenschaften wie z.B. die Anzahl der Adern, der Querschnitt, der Gesamtdurchmesser etc.
===== Sicherungen =====
Sicherungen haben spezielle Eigenschaften wie z.B. Typ, Stromstärke etc.
Eine Sicherung kann einem Kabel zugeordnet werden
===== Aufgaben =====
Aufgaben können einem Projekt zugeordnet sein, müssen es aber nicht
===== Wartung =====
Einmalige Wartung
oder regelmäßige Wartung
* nach Zeit
* nach Betriebsstunden
*
===== Messung =====
Zur Erfassung diverser Maße. Meßqualität. Zuordnung zu einer Ausrüstung möglich.
Eine Messung kann aus bis zu drei Dimensionen bestehen.
Damit es z.B. möglich eine Position im Raum oder die Maße einer Box zu erfassen (x, y, z).
Alle Dimensionen müssen die gleiche Einheit haben.
===== Checklisten =====
Modul in Planung.
Checklistitems
Gruppieren von Einträgen. Eine Gruppierung kann einen Titel haben.
Zusammenstellen von Items(Checks) in verschiedenen Listen
* Item checkitem
* Verbindungstabelle checkref: Ein Check kann in mehreren Listen verwendet werden
Eine Checkliste mit mehreren zugeordneten Items kann als Vorlage für eine
neu abzuarbeitende Checkliste verwendet werden. Z.B. kann die Checkliste "Einwintern"
in jedem Jahr wiederverwendet werden. Die Abarbeitung wird dann als "abgearbeitete
Checkliste" gespeichert.
Einer nicht abgeschlossenen Checkliste können jederzeit neue Items hinzugefügt werden.
===== Notizen =====
Können an Aufgaben, Wartungen und Ausrüstung angehängt werden.
Eine Notiz ist prinzipiell nicht in der Länge beschränkt im
gegensatz zu den Bemerkungsfeldern die auf 150 Zeichen beschränkt sind.
Zu einer Notiz wird immer das Anlagedatum und der jeweilige Benutzer gespeichert.
===== Marker (Tags) =====
Können zu verschiedenen Objekten vergeben werden.
Haben optional eine Farbe und eine Beschreibung.
===== Dokumente =====
* Dokument
* Allgemein
* Rechnung
* Handbuch
* Bild
* Zeichnung
===== Signal K =====
Es ist ein //experimenteller// Support für [[signalk|Signal K]] vorhanden.
Werte für einen Ausrüstungsgegenstand können live abgefragt werden.
Dazu muß der Server in den Einstellungen definiert werden.
Zusätzlich die Signal K - Datenpfade in der Zuordnungstabelle ''signalk''.
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''
mysqldump -Q --single-transaction yms | gzip -9 > /path/to/usbstick/yms_$(date +"%Y%m%d").gz
* Das Dokumentenverzeichnis am besten mit RSync
rsync -av --exclude='/thumb/' /var/local/lib/yms/ /path/to/usbstick/yms_$(date +"%Y%m%d")/