Aus DreamboxWIKI

Allgemeines

Mit diesen Befehlen können Funktionen auf der Dreambox ausgelöst werden. Die Funktionsvielfalt reicht vom Anzeigen einer Information, bis zum Löschen von Verzeichnissen. Die folgend angegebenen Funktionen werden zum Beispiel vom Webinterface über den Browser oder wget aufgerufen. Sie müssen in der Formt <ipadresse><befehl> aufgerufen werden. Der Befehl /pda würde, wenn die Dreambox die IP Adresse 10.0.0.5 hat, im Browser folgendermaßen aussehen:

http://10.0.0.5/pda

Parameter die evtl. noch zusätzlich mit übergeben werden müssen sind in diesem Artikel kursiv geschrieben, .z.B. /cgi-bin/mkdir?usr/test. usr/test stellt hier den varierenden Parameter dar.

Als antwort kommt ein HTML/JavaScript-Code mit Informatinen oder weiteren Bedienmöglichkeiten. Wenn unten nichts anderes angegeben ist erhält der Browser diese Bestätigungsmeldung:

Anzeigen

Anzeige im Handheld-Format: /pda

Ruft ein Webinterface auf, dass an den Bildschirm eines PDA, etc. angepasst ist.

Virtuelle Fernbedienung: /showRemoteControl

Nach dem Aufruf erschein im Browser ein Bild der Fernbedienung. Diese Fernbedienung ist voll Funktionsfähig, d.h. durch klicken mit der Maus können die gleichen Befehle gesendet werden wie mit der realen Fernbedienung.

Tasten der Fernsteuerung: /cgi-bin/rc?<key>:<duration>:<reptime>,<key...>

Eine eingeblendete Fernsteuerung kann mit diesem Befehl einen Tastenbedienungen an die Dreambox senden. Optinal können mehrere, durch Komma getrennte, Tastenbedienungen als Parameter übergeben werden

• <key> - Zahlencode für die Taste
• <duration> - Dauer des Tastendrucks (Optional)
• <reptime> - Wiederholgeschwindigkeit (Optional)

--------------------------------------
Taste:Zahlencode             Power:116
                                      
(1):  2         (2): 3         (3):  4
(4):  5         (5): 6         (6):  7
(7):  8         (8): 9         (9): 10
(<):412         (0):11         (>):407
                                      
up:115         mute:113         up:402
 volume         EXIT:1        bouquet 
  down:114                  down:403  
                                      
INFO :358      up  :103      MENU :141
left :105      OK  :352      right:106
AUDIO:392      down:108      VIDEO:393
                                      
ROT:398  GRÜN :399  GELB:400  BLAU:401
<< :168  >    :207  ||  :119  >>  :208
                                      
TV :385  RADIO:377  TEXT: 66  HELP:138
#  :128  O    :167  [=]       [ ]     
--------------------------------------

VIDEO toggelt die unteren Tasten zwischen Video-Mode und Wiedergabeoptions-Mode; TEXT stellt auf fest auf Video-Mode. Im Video-Mode werden die Tasten des Wiedergabeoptions-Modes vom Webinterface automatisch in die Video-Mode-Zahlenodes geändert. Letztere sind immer verwendbar.

ROT  398: EPG          = 168: rewind
GRÜN 399: Angle-Select = 207: play
GELB 400: Audio-Select = 119: pause
BLAU 401: Plungins     = 208: forward
Schw 385: Radio-Mode   = 128: stop
Schw 377: TV-Mode      = 167: record

Antennen-Einstellung: /satFinder

Zeigt zyklisch die aktuellen Werte für die Empfangsqualität in Prozent an. Hilfreich zum Ausrichten der Antenne oder um die Quallität des Empfangs zu prüfen.
Siehe auch /body?mode=controlSatFinder

Gelöst ist alles mit HTML-Tabellen. Pro Wert werden auch Balken mittels 10 led_off- oder led_on.gif angezeigt. Das aussehen ist also unbeeinflußbar aus Box und ist so kaum weiter zu verarbeiten. Der HTML-Code sorgt auch dafür, das der Browser die Seite und damit die Werte zyklisch aktualisiert.

• SNR: Signal/Rausch Verhältnis (Signal-to-noise ratio)
• AGC: Automatic Gain Control
• BER: Fehler-Bitrate (Bit error rate)

Sender-Programme anzeigen: /getMultiEPG?ref=4097

Es öffnet sich ein eigenes großes Fenster mit der Übersicht aller Sender und Sendungen, die die Dreambox bis dahin einlesen konnt. Leider werden hier nicht, wie beim OSD selbst, die aktuellen Timer angezeigt.

Ohne "ref"-Wert kommt nur die Zeitleiste ohne Sender.
Mit "ref=4097" kommen nur Infos, die seit dem letzten Wakeup eingelesen wurden?
Das MultiEPG zeigt alle vorhandenen Daten des aktuell angewählten Bouquets an. Es ist möglich, ein bestimmtes Bouquet abzurufen, so man dessen Dateinamen kennt:
ref=4097:7:0:796ab:0:0:0:0:0:0:/var/tuxbox/config/enigma/userbouquet.33fc5.tv

Version?: /version

Die Antwort besteht hier nur aus einem Wort. Die Versionen erhält man besser mit /body?mode=help

Anzeige-Elemente

Die Bedienoberfläche des Webinterface ist in feste Bereiche eingeteilt. Für jeden Bereich geibt es einen Darstellungsn-Befehl.

/header

/body?mode=zap&...

http://dbox/body?mode=help

Ruft den Haupt-/Informationsteil des Webinterface auf. Mögliche Parameter sind

• zap&zapmode=<0..4>&zapsubmode=<0..4>&curChannel=<-1..nn>
• controlScreenShot, controlFBShot, controlLCDShot, controlSatFinder, controlTimerList
• config, configFlashMgr, configMountMgr, configSwapFile, configSettings, configRotor
• updates, updatesInternet
• help, helpDMMSites, helpOtherSites, helpForums

Hier ein Beispiel für controlLCDShot:

<html>
    <head>
        <link rel="stylesheet" type="text/css" href="webif.css">
        <script language="javascript" type="text/javascript" src="window.js"></script>
        <script language="javascript" type="text/javascript" src="index.js"></script>
        <script language="javascript" type="text/javascript" src="timer.js"></script>
    </head>
    <body  leftmargin=0 topmargin=0 marginwidth=0 marginheight=0 id="mainbody">
        <table id="contentcell" width=100% height="100%" border="0"
         cellpadding="0" cellspacing="0">
        <tbody valign="top">
            <tr>
                <td>
                <script>parent.setTitle('CONTROL: LCDShot');</script>
                 <img width="630" src="/root/tmp/osdshot.png" border=0>
                </td>
            </tr>
        </tbody>
        </table>
    </body>
</html>

/leftnavi?mode=zap - Linke Menüleiste wechseln

Ruft die linke Menuleiste des Webinterface auf. Mögliche Parameter sind

• zap
• control
• updates
• help
• config - Nur beim Expert-Webinterface

/videodata

/data

Shows Data of the current channel, e.g.:

 <html>
 <head>
 <script type="text/javascript">
 function update()
 {
	if (parent.headerUpdateEPGData)
		parent.headerUpdateEPGData(serviceName, nowT, nowD, nowSt, nextT, nextD, nextSt);
	if (parent.headerUpdateStatusBar)
		parent.headerUpdateStatusBar(vpid, apid, ip, lock, upTime, agc, snr, ber);
	if (parent.headerUpdateVolumeBar)
		parent.headerUpdateVolumeBar(volume, mute);
	if (parent.headerUpdateChannelStatusBar)
		parent.headerUpdateChannelStatusBar(dolby, crypt, format);
	if (parent.headerUpdateRecording)
		parent.headerUpdateRecording(recording);
	if (parent.updateVideoBar)
		parent.updateVideoBar(videoPosition, videoTime, diskGB, diskH);
 }
 </script>
 </head>
 <body onLoad="update()">
 <script>
	<!-- variables set by box -->
	var updateCycleTime = 10000;
	<!-- power state -->
	var standby = 0;
	<!-- service & epg data -->
	var serviceName = "kabel eins";
	var nowT = "14:33";
	var nowD = "(31)";
	var nowSt = "Bill Cosby Show";
	var nextT = "15:05";
	var nextD = "(29)";
	var nextSt = "Roseanne";
	<!-- status bar -->
	var diskGB = "11.28 GB";
	var diskH = "~5 h, 50 min";
	var apid = "0x300";
	var vpid = "0x2ff";
	var ip = "192.168.1.55";
	var lock = "locked";
	var upTime = "27:51 h up";
	<!-- volume bar -->
	var volume = 37;
	var mute = 0;
	<!-- channel stats -->
	var dolby = 0;
	var crypt = 0;
	var format = 0;
	<!-- recording -->
	var recording = 0;
	<!-- vlc streaming -->
	var vlcparms = "http://192.168.1.55:31339/0,0062,02ff,0300,02ff";
	var serviceReference = "1:0:1:445e:453:1:c00000:0:0:0:";
	var videoTime = "0:00";
	var videoPosition = 0;
	<!-- stream info -->
	var agc = 91;
	var snr = 93;
	var ber = 0;
	<!-- streaming client status -->
	var streamingClientStatus = 0;
 </script>
 </body>
 </html>

Channel-Navigation: /channavi

Abrufen eines JavaScript-Codes mit dem der Browser die Knopfzeile für die Channel-Navigation ausgibt:

[Audio] [Video] [EPG] [Info] [Stream Info] [Record bzw. Stop]

Hier mal ein Beispiel des HTML-Codes, wenn noch keine Wiedergabe läuft und nur zwei Knöpfe zu sehen sind:

<html>
    <head>
        <link rel="stylesheet" type="text/css" href="webif.css">
        <script language="javascript" type="text/javascript" src="window.js"></script>
        <script language="javascript" type="text/javascript" src="index.js"></script>
    </head>
    <body id="channavi">
        <input name="Audio"type="button" style='width:100px;height:22px;
         background-color: #FFCC33;' value="Audio" onclick=javascript:selectAudio()>
        <input name="Video"type="button" style='width:100px;height:22px;
         background-color: #FFCC33;' value="Video" onclick=javascript:selectSubChannel()>
    </body>
</html>

Man sieht, wie css und aus window.js und index.js weiterer JavaScript-Code genutzt wird. Da scheint auch ein Trick enthalten zu sein da dieser HTML-Code so nicht stehen bleibt sondern automatisch zur vollen Darstellung des Webinterfaces wechselt.

Wiedergabe und Aufnahme

Aufnahme starten: /cgi-bin/record

http://dbox/cgi-bin/videocontrol?command=record

Startet im TV- oder Radio-Mode eine Aufname der aktuellen Sendung, deren Wiedergabe man dann auch anhalten kann (Timesift).

Aufnahme stoppen: /cgi-bin/videocontrol?command=stop

http://dbox/cgi-bin/videocontrol?command=stop

Beendet die Aufnahme der aktuellen Sendung

Aufnahme pausieren: /cgi-bin/videocontrol?command=pause

http://dbox/cgi-bin/videocontrol?command=pause

Pausiert die Aufnahme der aktuellen Sendung

Wiedergabe starten: /cgi-bin/play

Wiedergabe beenden: /cgi-bin/stop

Wiedergabe unterbrechen: /cgi-bin/pause

Wiedergabe-Kommandos indirekt: /cgi-bin/videocontrol?command=...

Kontrolle der File-Wiedergabe in einem Kommando zusammengefaßt.
Keine Aufnahme, ansonsten selbsterklärend bzw. siehe oben.

/cgi-bin/videocontrol?command=rewind
/cgi-bin/videocontrol?command=forward
/cgi-bin/videocontrol?command=stop
/cgi-bin/videocontrol?command=pause
/cgi-bin/videocontrol?command=play

Wiedergabe-Lautstärke einstgellen: /setVolume?...

/setVolume?volume=9 - Lautstärke einstellen; 0 = Leise, 15 = Maximum
/setVolume?mute - Ton stumm / normal toggeln

Wiedergabe-Status abfragen: /cgi-bin/status

http://dbox/cgi-bin/status

Sender anwählen: /cgi-bin/switchService?egal=sid:namespace:tsid:onid:type

Der Name des Parameters wird nicht wohl beachtet. Der Wert besteht aus fünf durch Doppelpunkt getrennte IDs:

• SID: service_id
• DVBNS: DVB-Namespace
• TSID: transport_stream_id
• ONID: original_network_id
• type: service_type (Durch ausprobieren: 1 für TV, 2 für Radio)

Warscheinlich entspricht das Einträgen z.B. in der /cgi-bin/currentTransponderServices. Die Werte können auch über das Webinterface über den Button "Stream Info" abgefragt werden.

Sender anzappen: /cgi-bin/zapTo?...

http://dbox/cgi-bin/zapTo?path=<current Channel>

Parameter:

• mode=zap
• path= siehe unten
• curBouquet=<nn> (Optional)
• curChannel=<nn> (Optional)

Erst kommt als Antwort für maximal 3 Sekunden "Please wait..."
Dann ein +ok oder eine Fehlermeldung.

Ein paar Beispiele bei denen der Anfang der jeweiligen Media-Quellen angezapt wird:

TV:     "?mode=zap&path=0:7:1:0:0:0:0:0:0:0:"
Radio:  "?mode=zap&path=0:7:2:0:0:0:0:0:0:0:"
Data:   "?mode=zap&path=0:7:6:0:0:0:0:0:0:0:"
Root:   "?mode=zap&path=2:47:0:0:0:0:%2f"          (%2f ist der /)
Movies: "?mode=zap&path=4097:7:0:1:0:0:0:0:0:0:"

Die Bedeutung der einzelnen path-Elemente ist noch offen. Vermutungen für Element...

1. Darstellung (Wiederabe, Liste, ...)
2. root?
3. Quelle (TV,Radio,Data,File)
4. Movie?
5. ?
6. ?
7. Pfad
8. ?
9. ?

Administratives wie Shutdown: /cgi-bin/admin?command=<command>

Welche Kommandos hier einsetzbar sind, erfärt man, wenn man falsche Kommandos erteilt. Je nach Zustand der Box kommen die Meldungen:

• Unknown admin command. (valid commands are: shutdown, reboot, restart, standby, wakeup)
• Unknown admin command. (valid commands are: reboot, restart, standby, wakeup)

Antworten auf Zulässige Kommandos:

• shutdown: "Shutdown initiated..." oder "No shutdown function available for this box."
• reboot: "Reboot initiated..."
• restart: "Restart initiated..."
• wakeup: "Enigma is waking up..." oder "Enigma doesn't sleep."
• standby: "Standby initiated..." oder "Enigma is already sleeping."

Die Antwort kommt wie immer als komplette HTML-Seite.

/cgi-bin/audio

http://dbox/cgi-bin/audio

Zeigt den Audio-Status an (Lautstärke 0..63, Stumschaltung 0/1):

/cgi-bin/selectAudio

Ein javascript um den AudioChannel und das Tonformat (German, German AC3) einzustellen.
selectAudio führt keine Kommandos aus!

/cgi-bin/setAudio

Wird von selectAudio aufgerufen. Parameter sind:
?channel=0 == Left
?channel=1 == Stereo
?channel=2 == Right

?language=0x0131 == German
?language=0x0138 == German(AC3)

/cgi-bin/selectSubChannel

Timer

/addTimerEvent

/addTimerEvent?ref=' + ref + '&start=' + start + '&duration=' + duration + '&descr=' + description + '&channel=' + channel

/TVBrowserTimerEvent

/deleteTimerEvent

/showEditTimerEventWindow

/showAddTimerEventWindow

/changeTimerEvent

/cleanupTimerList

Löscht abgearbeitete Einträge aus der Timerliste.

/clearTimerList

Löscht alle Einträge aus der Timerliste.

Informationen

/EPGDetails

EPG

/cgi-bin/getPMT

? PMT, Program Main Table - Abfrage der Daten des aktuell Wiedergegebenen ?

/cgi-bin/getEIT

/cgi-bin/getcurrentepg oder /getcurrentepg

/cgi-bin/streaminfo

http://dbox/cgi-bin/streaminfo

/cgi-bin/channelinfo

/channels/getcurrent

Kontrolle der Video und Audio-IDs: /control/zapto?getpids

Kontrolle der Network-ID: /control/getonidsid

Kontrolle der Kanalliste: /control/channellist

?

Dateien und Verzeichnisse

Inhaltsverzeichnis anzeigen: /cgi-bin/ls?hdd

Dieser Befehl gibt den Inhalt eines definierten Verzeichnisses im XML-Format aus. Das Verzeichnis muss im Befehl hinter dem Fragezeichnen definiert werden. Im Beispiel hdd

Ordner anlegen: /cgi-bin/mkdir?usr/test

Mit Hilfe des Befehls mkdir können Ordner auf der Dreambox angelegt werden. Als Parameter muss der anzulegende Ordner übergeben werden. In diesem Beispiel mir der Ordner test im Verzeichnis usr angelegt.

Ordner löschen: /cgi-bin/rmdir?usr/test

Dieser Befehl ist das Gegenstück zum Befehl mkdir. Es können also Verzeichnisse gelöscht werden. Der Parameter ist das zu löschende Verzeichnis.

Datei löschen: /cgi-bin/rm?usr/test/test.txt

Mit diesem Befehl können Dateien auf der Dreambox gelöscht werden. Hier wird die Datei test.txt im Verzeichnis /usr/test gelöscht.

Datei verschieben: /cgi-bin/mv?source=usr/test1/test.txt&dest=usr/test2/test.txt

Mit Hilfe des mv-Befehl können Datei verschoben werden. Folgende Parameter sind anzugeben

• source= Pfad und Name der Datei die verschoben werden soll
• dest= Hier kann angegeben werden wohin die neue Datei verschoben werden soll und mit welchem Namen

im Beispiel wird die Datei test.txt aus dem Verzeichnis usr/test1 in das Verzeichnis usr/test2 verschoben. Der ursprüngliche Name test.txt wird im Beispiel beibehalten.

Link erstellen: /cgi-bin/ln?source=usr/test1/test.txt&dest=usr/test2/test.txt

Mit Hilfe des ln-Befehl können Links zu Datei angelegt werden. Folgende Parameter sind anzugeben

• source= Pfad und Name der Datei die verlinkt werden soll
• dest= Hier kann angegeben werden wo der Link angelegt werden soll und mit welchem Namen

im Beispiel wird ein Links von der Datei test.txt aus dem Verzeichnis usr/test1 in das Verzeichnis usr/test2 angelegt. Der ursprüngliche Name test.txt wird im Beispiel auch für den Link beibehalten.

Datensicherung / Wiederherstellung

/cgi-bin/deleteMovie - Eine Aufnahme löschen

Löscht alle Dateien einer Aufnahme: Transponder-Strings, Markierungen.

/cgi-bin/recoverRecordings - Aktuallisieren der Aufnahme-Liste

Generiert die Datei recordings.epl neu.

/cgi-bin/saveRecordings - Sichern der Aufnahme-Liste

Schreibt die Datei recordings.epl auf die Festplatte des Bedienrechners.

/cgi-bin/savePlaylist

/cgi-bin/saveUserBouquets

/cgi-bin/saveTimerList - Sichern aller programmierten Timer

/cgi-bin/reloadSettings

/cgi-bin/reloadEncodingTable

/cgi-bin/reloadNetworks - satellites.xml neu laden

/cgi-bin/reloadRecordings - Aufnahme-Liste in die Box laden

Liest die Film-Dateien von der Festplatte und ändert die Datei recordings.epl entsprechend.

siehe auch Howtos#Recording-Liste_.Ändern

/cgi-bin/reloadPlaylist

/cgi-bin/reloadUserBouquets

lädt die UserBouquets neu aus den Dateien in /var/tuxbox/config/enigma/ ein. Nützlich z.B. wenn man die userbouquet-Dateien in /var/tuxbox/config/enigma/ von Hand verändert hat oder neue Files per FTP kopiert hat.

/cgi-bin/reloadTimerList - Timer-Programmierung in die Box laden

Config

/cgi-bin/osdshot

Zeigt einen Screenshot vom aktuellen OSD an.

/cgi-bin/currentService

/cgi-bin/startPlugin

/cgi-bin/audioChannels

Zeigt die verfügbaren Audiokanäle an

/cgi-bin/videoChannels

Zeigt die verfügbaren Videokanäle an

/cgi-bin/currentTransponderServices

Dieser Befehl listet alle auf dem derzeit gewählten Transpoder sendenden Sender auf.

/cgi-bin/getServices

Dieser Befehl listet Verzeichnisse und Sender auf.

/cgi-bin/getServices?ref=0 liefert

/cgi-bin/getServices?ref=2:47:0:0:0:0:0:0:0:0:/hdd/

liefert den Inhalt des Root-Verzeichnisses der Festplatte.

Spezielles

/cgi-bin/setStreamingServiceRef

Video-Position: /setVideo?position=1..20

Anfang des Videobilds auf 1. bis 20. Zeile stellen.

Video-Link: /video.m3u

Lädt von der Box eine m3u Datei. Öffnet man diese Datei mit einem entsprechenden Programm, wird das aktuelle Audio-/Videosignal wiedergegeben.

Audio-Link; /audio.m3u

Lädt von der Box eine m3u Datei. Öffnet man diese Datei mit einem entsprechenden Programm, wird das aktuelle Audiosignal wiedergegeben.

Message einblenden: /cgi-bin/xmessage

Über der Wiedergabe der Box wird ein Nachrichtenfenster dargestellt. Wenn die Box am Web ist, kann so man seinen fernsehschauenden Lieben eine Mitteilung vorsetzen :-)

Parameter:

• timeout: Zeit, bis die Nachricht von selbst verschwindet in Sekunden; Wert kleiner Null => Message muß mit OK bestätigt werden.
• caption: Fenster-Überschrift
• body: Nachrichtentext
• type: (Optional) Wert ungleich -1 => alle noch nicht angezeigten Meldungen, die über /cgi-bin/xmessage gesetzt wurden, löschen

Ab CVS-Stand 5.November 2005:

• charset: Kann auf latin1 gesetzt werden, dann konvertiert enigma den body- und caption-Text von Latin1 nach UTF-8
• icon: Zeigt zusätzlich ein Status-Icon neben der Meldung an (0=kein Icon, 1=Info, 2=Warnung, 3=Frage, 4=Fehler)

Die Antwort ist "+ok" oder eine Fehlermeldung.

Fehlermeldungen: "E: no timeout set", "E: no caption set" oder "E: no body set"

Sonderzeichen: Die Daten müssen im UTF-8 Format vorliegen. "\n" erzeugt eine neue Zeile.

Beispiel:
http://127.0.0.1/cgi-bin/xmessage?caption=Grüße&timeout=0&body=Hallo%20Box - Eine Meldung&icon=1"

Message ausblenden: /cgi-bin/message oder /control/message

Schließt das aktuelle (Message-) Fenster mit

<script language="javascript">window.close();</script>

Message abfragen: /tvMessageWindow

Die letze von der Box angezeigte Message wird zurückgegeben.
Gelesen wird sie aus der Datei "sendMessage.tmp" im TMP-Verzeichnis der Box.