Skip to content

Commit

Permalink
Added new doc files for english
Browse files Browse the repository at this point in the history
  • Loading branch information
faebser committed Jan 21, 2016
1 parent 277fa19 commit 1e84baa
Show file tree
Hide file tree
Showing 9 changed files with 186 additions and 23 deletions.
14 changes: 7 additions & 7 deletions docs/index.md → docs/de/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Wir empfehlen die Nutzung eines LCD-Displays, da dies für die Ausgabe der aktue

Für unsere Version haben wir ein Gehäuse gebaut um den Rechner und die Komponenten zu schützen.

![raspi fertig](images/IMG_20150911_181422.jpg)
![raspi fertig](../images/IMG_20150911_181422.jpg)

## LCD-Display

Expand All @@ -26,31 +26,31 @@ Wir haben [dieses 16x2 LCD Kit von adafruit.com](http://www.adafruit.com/product

Ich habe ein Stück Holz mit der ungefähren Grösse des Rechners augeschnitten und in das Gehäuse geklebt.

![Raspi Gehaese Spacer](images/IMG_20150911_155047.jpg)
![Raspi kleben](images/IMG_20150911_155513.jpg)
![Raspi Gehaese Spacer](../images/IMG_20150911_155047.jpg)
![Raspi kleben](../images/IMG_20150911_155513.jpg)


* Löcher in Behälter schneiden

Die Grösse der Anschlüsse abmessen, diese auf dem Gehäuse markieren
und auschneiden.

![Raspi Löcher schneiden](images/IMG_20150911_170557.jpg)
![Raspi Löcher schneiden](../images/IMG_20150911_170557.jpg)

* Abdeckungen für Löcher zuschneiden

Um den Rechner und das Display zu schützen, Abdeckungen für die Kabel
zuschneiden und sie aussen auf das Gehauses kleben.

![Raspi lasercutter](images/IMG_20150911_173845.jpg)
![Raspi kleben abdeckungen](images/IMG_20150911_180205.jpg)
![Raspi lasercutter](../images/IMG_20150911_173845.jpg)
![Raspi kleben abdeckungen](../images/IMG_20150911_180205.jpg)

* Rechner befestigen

Den Rechner auf dem Abstandhalter befestigen. Die Kabel von aussen
in das Gehäuse schieben und anschliessen.

![Raspi fertig](images/IMG_20150911_181422.jpg)
![Raspi fertig](../images/IMG_20150911_181422.jpg)

# zur [Inbetriebnahme](https://github.com/faebser/pi-stream/blob/master/docs/manual.md)

Expand Down
22 changes: 11 additions & 11 deletions docs/manual.md → docs/de/manual.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,45 +2,45 @@

Vor Inbetriebnahme alle Kabel ausstecken.

![Raspi nicht eingesteckt](images/manual/IMG_20151022_230405.jpg)
![Raspi nicht eingesteckt](../images/manual/IMG_20151022_230405.jpg)

* Als erste das USB Kabel mit der USB-Aufnahmegerät und der Soundquelle verbinden.

![usbsound](images/manual/IMG_20151022_230938.jpg)
![usbsound](../images/manual/IMG_20151022_230938.jpg)

* Dann das Netzwerkkabel mit dem Router verbinden

![rj45](images/manual/IMG_20151022_231530.jpg)
![rj45](../images/manual/IMG_20151022_231530.jpg)

* Den Rechner an den Strom anschliessen

![strom](images/manual/IMG_20151022_232157.jpg)
![strom](../images/manual/IMG_20151022_232157.jpg)

* Der Rechner startet und die beiden Status-LED an der Seite des Rechners beginnen zu blinken.

![LED](images/manual/IMG_20151022_232553.jpg)
![LED](../images/manual/IMG_20151022_232553.jpg)

* Nach ungefähr einer Minute wird das Streaming-Programm gestartet.

![gif](images/manual/startup.gif)
![gif](../images/manual/startup.gif)

* Die Software benötigt einen kurzen Augenblick um alle Status-Tests durchzuführen.

![tests](images/manual/IMG_20151023_000826.jpg)
![tests](../images/manual/IMG_20151023_000826.jpg)

* Falls alle Tests ohne Probleme ausgeführt wurden, erscheint die Meldung mit der IP-Adresse des Rechners auf dem LCD-Display.

![ip](images/manual/IMG_20151023_001753.jpg)
![ip](../images/manual/IMG_20151023_001753.jpg)

* Anschliessend zeigt das LCD die Status-Meldungen der Software an. Es gibt drei verschiedene Arten von Meldungen:
* **grüner Hintergrundfarbe**: Alles gut (z.B. IP-Adresse, Streaming)
* **gelber Hintergrundfarbe**: Achtung, evtl ein Problem (z.B. Speicherplatz wird knapp, Soundkarte nicht erkannt)
* **roter Hintergrundfarbe**: kritischer Fehler (z.B. keine Netzwerkverbindung, keine Verbindung zum Server)


![ip](images/manual/IMG_20151023_001753.jpg)
![tests](images/manual/IMG_20151023_000826.jpg)
![error](images/manual/IMG_20151023_002215.jpg)
![ip](../images/manual/IMG_20151023_001753.jpg)
![tests](../images/manual/IMG_20151023_000826.jpg)
![error](../images/manual/IMG_20151023_002215.jpg)

# Zur [Benutzeroberfläche](https://github.com/faebser/pi-stream/blob/master/docs/software.md)

Expand Down
10 changes: 5 additions & 5 deletions docs/software.md → docs/de/software.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@ Die Benutzeroberfläche besteht aus mehreren Komponenten.

## Navigation

![nav](images/software/nav.png)
![nav](../images/software/nav.png)

Die Navigation der Seite besteht aus zwei Links:
* NoNoRadio.net führt zur Hompage des Projekts
* Documentation führt direkt zur Dokumentation der Software

## Stream Konfiguration

![form](images/software/config.png)
![form](../images/software/config.png)

In dieser Komponente kann man die Daten des Streams eintragen.
Name und Description werden für den Betrieb eines Streams benötigt.
Expand All @@ -40,19 +40,19 @@ In dieser Komponente erscheinen die selben Status-Meldungen wie auf dem LCD-Disp

Solange diese Anzeigen einen Fehler, also eine Meldung mit rotem Symbol, enthält ist der Stream Button deaktiert.

![status](images/software/status.png)
![status](../images/software/status.png)

## Buttons
Mit diesen beiden Buttons kann entweder der Stream gestartet werden oder die Status-Test können wiederholt werden.

z.B. Falls das Netzwerkkabel nicht eingesteckt war während dem Aufstarten und eine Fehlermeldung in der Liste erscheint, kann man die Test wiederholen und damit den Fehler entfernen.

![buttons](images/software/buttons.png)
![buttons](../images/software/buttons.png)


## Recordings
Diese Komponente enthält eine Liste aller auf dem Rechner verfügbaren Aufnahmen. Eine Aufnahme kann durch zweimaliges Klicken auf das **X** gelöscht werden.

![Recordings](images/software/downloads.png)
![Recordings](../images/software/downloads.png)


58 changes: 58 additions & 0 deletions docs/en/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
# Beschreibung

Diese Projekt versucht aus dem Raspberry Pi mit handelsüblichen Komponenten,
angepasstem Betriebssystem und Software einen
einfach zu bedienenden Stream- und Aufnahmestation zu machen.

# Sponsor

(Sponsor Info hinzfügen)

# Zusammenbau

Wir empfehlen die Nutzung eines LCD-Displays, da dies für die Ausgabe der aktuellen IP-Adresse genutzt wird. Die IP-Adresse des Rechners kann jedoch auch über andere Wege ermittelt werden.

Für unsere Version haben wir ein Gehäuse gebaut um den Rechner und die Komponenten zu schützen.

![raspi fertig](../images/IMG_20150911_181422.jpg)

## LCD-Display

Wir haben [dieses 16x2 LCD Kit von adafruit.com](http://www.adafruit.com/products/1110) verbaut.

## Gehäuse

* Abstandshalter einbauen

Ich habe ein Stück Holz mit der ungefähren Grösse des Rechners augeschnitten und in das Gehäuse geklebt.

![Raspi Gehaese Spacer](../images/IMG_20150911_155047.jpg)
![Raspi kleben](../images/IMG_20150911_155513.jpg)


* Löcher in Behälter schneiden

Die Grösse der Anschlüsse abmessen, diese auf dem Gehäuse markieren
und auschneiden.

![Raspi Löcher schneiden](../images/IMG_20150911_170557.jpg)

* Abdeckungen für Löcher zuschneiden

Um den Rechner und das Display zu schützen, Abdeckungen für die Kabel
zuschneiden und sie aussen auf das Gehauses kleben.

![Raspi lasercutter](../images/IMG_20150911_173845.jpg)
![Raspi kleben abdeckungen](../images/IMG_20150911_180205.jpg)

* Rechner befestigen

Den Rechner auf dem Abstandhalter befestigen. Die Kabel von aussen
in das Gehäuse schieben und anschliessen.

![Raspi fertig](../images/IMG_20150911_181422.jpg)

# zur [Inbetriebnahme](https://github.com/faebser/pi-stream/blob/master/docs/manual.md)



47 changes: 47 additions & 0 deletions docs/en/manual.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# Inbetriebnahme

Vor Inbetriebnahme alle Kabel ausstecken.

![Raspi nicht eingesteckt](../images/manual/IMG_20151022_230405.jpg)

* Als erste das USB Kabel mit der USB-Aufnahmegerät und der Soundquelle verbinden.

![usbsound](../images/manual/IMG_20151022_230938.jpg)

* Dann das Netzwerkkabel mit dem Router verbinden

![rj45](../images/manual/IMG_20151022_231530.jpg)

* Den Rechner an den Strom anschliessen

![strom](../images/manual/IMG_20151022_232157.jpg)

* Der Rechner startet und die beiden Status-LED an der Seite des Rechners beginnen zu blinken.

![LED](../images/manual/IMG_20151022_232553.jpg)

* Nach ungefähr einer Minute wird das Streaming-Programm gestartet.

![gif](../images/manual/startup.gif)

* Die Software benötigt einen kurzen Augenblick um alle Status-Tests durchzuführen.

![tests](../images/manual/IMG_20151023_000826.jpg)

* Falls alle Tests ohne Probleme ausgeführt wurden, erscheint die Meldung mit der IP-Adresse des Rechners auf dem LCD-Display.

![ip](../images/manual/IMG_20151023_001753.jpg)

* Anschliessend zeigt das LCD die Status-Meldungen der Software an. Es gibt drei verschiedene Arten von Meldungen:
* **grüner Hintergrundfarbe**: Alles gut (z.B. IP-Adresse, Streaming)
* **gelber Hintergrundfarbe**: Achtung, evtl ein Problem (z.B. Speicherplatz wird knapp, Soundkarte nicht erkannt)
* **roter Hintergrundfarbe**: kritischer Fehler (z.B. keine Netzwerkverbindung, keine Verbindung zum Server)


![ip](../images/manual/IMG_20151023_001753.jpg)
![tests](../images/manual/IMG_20151023_000826.jpg)
![error](../images/manual/IMG_20151023_002215.jpg)

# Zur [Benutzeroberfläche](https://github.com/faebser/pi-stream/blob/master/docs/software.md)


58 changes: 58 additions & 0 deletions docs/en/software.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
# Benutzeroberfläche

Um die Benutzeroberfläche zu erreichen, einfach die IP-Adresse des Rechners in den Browser eintippen.

Die Benutzeroberfläche besteht aus mehreren Komponenten.

## Navigation

![nav](../images/software/nav.png)

Die Navigation der Seite besteht aus zwei Links:
* NoNoRadio.net führt zur Hompage des Projekts
* Documentation führt direkt zur Dokumentation der Software

## Stream Konfiguration

![form](../images/software/config.png)

In dieser Komponente kann man die Daten des Streams eintragen.
Name und Description werden für den Betrieb eines Streams benötigt.

Eingabefelder mit rotem Kreuz sind ungültig und müssen korrigiert werden.
Solange das Formular ungültige Eingabefelder enthält, ist der Stream Button deaktiviert.

* Name

Der Name des Streams, ein Wort ist optimal.
* Description

Eine kurze Beschreibung des Streams, maximal 5 Worte.
* URL

Eine gültige URL (http muss nicht angegeben werden) mit weiteren Informationen zum Stream. Optional.
* Genre

Das Genre des Streams. Optional.

## Status Anzeige
In dieser Komponente erscheinen die selben Status-Meldungen wie auf dem LCD-Display, allerdings mit genauerer Beschreibung und statt einer Hintergrundfarbe haben sie ein Symbol in gelb oder rot.

Solange diese Anzeigen einen Fehler, also eine Meldung mit rotem Symbol, enthält ist der Stream Button deaktiert.

![status](../images/software/status.png)

## Buttons
Mit diesen beiden Buttons kann entweder der Stream gestartet werden oder die Status-Test können wiederholt werden.

z.B. Falls das Netzwerkkabel nicht eingesteckt war während dem Aufstarten und eine Fehlermeldung in der Liste erscheint, kann man die Test wiederholen und damit den Fehler entfernen.

![buttons](../images/software/buttons.png)


## Recordings
Diese Komponente enthält eine Liste aller auf dem Rechner verfügbaren Aufnahmen. Eine Aufnahme kann durch zweimaliges Klicken auf das **X** gelöscht werden.

![Recordings](../images/software/downloads.png)


Binary file added docs/images/manual/IMG_20151023_000826.xcf
Binary file not shown.
Binary file added docs/images/manual/IMG_20151023_001753.xcf
Binary file not shown.
Binary file added docs/images/manual/IMG_20151023_002215.xcf
Binary file not shown.

0 comments on commit 1e84baa

Please sign in to comment.