control-API Dokumentation



API-Aufrufe
Die Kanalliste http://box_ip/control/channellist
EPG-Abfrage http://box_ip/control/epg
EPG-Suche http://box_ip/control/epgsearch
EPG-Suche mit XML Ausgabe http://box_ip/control/epgsearchxml
Die Box herunterfahren http://box_ip/control/shutdown
Standby Mode http://box_ip/control/standby
Lautstärke-Steuerung http://box_ip/control/volume
Programm umschalten / Playback http://box_ip/control/zapto
Radio/TV, Record Mode http://box_ip/control/setmode
Neutrino Mode Abfrage http://box_ip/control/getmode
Datum von der Box abfragen http://box_ip/control/getdate
Uhrzeit von der Box abfragen http://box_ip/control/gettime
Allgemeine Informationen http://box_ip/control/info
Box Informationen http://box_ip/control/boxinfo
Aktuellen Kanal abfragen http://box_ip/control/getonidsid
Transponder-Sender abfragen http://box_ip/control/currenttpchannels
Senderlogo-Pfad abfragen http://box_ip/control/get_logo
services.xml lesen http://box_ip/control/getservicesxml
bouquets.xml auslesen http://box_ip/control/getbouquetsxml
Bouquetlist abfragen http://box_ip/control/getbouquets
Bouquet abfragen http://box_ip/control/getbouquet
Fenster in Neutrino http://box_ip/control/message
Timerd Interface http://box_ip/control/timer
LCD-Interace http://box_ip/control/lcd
Shellscript ausführen http://box_ip/cgi-bin/exec
System-/Treiberfunktionen http://box_ip/control/system
Fernbedienung http://box_ip/control/rc
Die Box neu starten http://box_ip/control/reboot
Einige Einstellungen lesen http://box_ip/control/settings
Die /.versions-File lesen http://box_ip/control/version
Plugin ausführen http://box_ip/control/startplugin
Support für yweb http://box_ip/control/yweb
Aspektratio lesen http://box_ip/control/aspectratio
Videoformat lesen/setzen http://box_ip/control/videoformat
Videooutput lesen/setzen http://box_ip/control/videooutput
VCR-output lesen/setzen http://box_ip/control/vcroutput
Scartmode lesen/setzen http://box_ip/control/scartmode
Fernbedienungstasten emulieren http://box_ip/control/rcem
Bouquet-Editor: Attribute setzen http://box_ip/control/setbouquet
Bouquet-Editor: Bouquet-Liste http://box_ip/control/savebouquet
Bouquet-Editor: Bouquet verschieben http://box_ip/control/movebouquet
Bouquet-Editor: Bouquet löschen http://box_ip/control/deletebouquet
Bouquet-Editor: Bouquet hinzufügen http://box_ip/control/addbouquet
Bouquet-Editor: Bouquet umbenennen http://box_ip/control/renamebouquet
Bouquet-Editor: Bouquet Channels ändern http://box_ip/control/changebouquet
Settings neu laden http://box_ip/control/reloadsetup
Plugins neu laden http://box_ip/control/reloadplugins
Kanallisten neu laden http://box_ip/control/reloadchannels
Screenshot erstellen http://box_ip/control/screenshot
Signalstärke anzeigen http://box_ip/control/signal
Audio-Decoder Informationen http://box_ip/control/audio
CA-IDs abfragen http://box_ip/control/crypt
Verzeichnis-Inhalt anzeigen http://box_ip/control/file
Configs ansehen/bearbeiten http://box_ip/control/config
Dateisystemstatistiken http://box_ip/control/statfs
Streaming URL anfordern http://box_ip/control/build_live_url
Senderlogos auflisten http://box_ip/control/logolist
Neutrino-Ordner auflisten http://box_ip/control/getdir
   


Die Kanalliste
Handler: http://box_ip/control/channellist

Parameter: keine
Rückgabe:

Es wird die gesamte Kanalliste von Neutrino zurückgegeben.
Jede Zeile wird von einem Enter (\n) von der Nächsten getrennt.
Eine Zeile enthält ein Programm.

Rückgabe-Format: channel_id Programmname

Die channel_id dient als Handle für andere Operationen wie Zappen oder EPG.
Die channel_id ist eine 64 bit Hexadezimalzahl.
Beispiel:

>>>http://box_ip/control/channellist
16dca Das Erste
16e29 EinsExtra
16e2a EinsFestival
16e2b EinsMuXx
16d66 ZDF

EPG-Abfrage
Handler: http://box_ip/control/epg

Parameter: keine
Rückgabe:

Es werden alle verfügbaren EPG's aller Programme, zur aktuellen Zeit
zurückgegeben. Jede Zeile wird von einem Enter (\n) von der
nächsten getrennt. Eine Zeile enthält die Informationen über die
aktuell laufende Sendung.

Rückgabe-Format: channel_id EVENTID Titel der Sendung

Die EVENTID dient als Handle um genauere Informationen abzufragen.
Beispiel:

>>>http://box_ip/control/epg
8716804 571264467523 Wasserloch Nr. 3
8716304 571231699926 Ein Käfig voller Helden
8716311 571232198133 Cop Rock
Parameter: channel_id (64 bit, hexadezimal)
Rückgabe:

Als Rückgabe wird die Eventliste des durch die channel_id
identifizierten Senders gesendet, d. h. eine Liste, welche Filme auf
diesem Sender kommen. Jede Zeile wird von einem Enter (\n) von der
nächsten getrennt.

Rückgabe-Format: EVENTID Startzeit Dauer Titel der Sendung

Die EVENTID dient als Handle um genauere EPG-Informationen abzufragen.
Beispiel:

>>>http://box_ip/control/epg?8716304
571231699925 1021322700 1500 Shooting Stars
571231699926 1021324200 1500 Ein Käfig voller Helden
571231699927 1021325700 1500 The Hitchhiker
571231699928 1021327200 1500 The Hitchhiker
Parameter: id=channel_id
Rückgabe:

Als Rückgabe wird die Eventliste des durch die channel_id
identifizierten Senders gesendet, das heißt eine Liste, was für
Filme auf einem Sender kommen. Jeder Datensatz wird von einem
EnterEnter (\n\n) vom nächsten getrennt.

Rückgabe-Format:
EVENTID Startzeit DURATION
TITLE
INFO1
INFO2

Die EVENTID dient als Handle um genauere EPG-Informationen abzufragen.
Beispiel:

>>>http://box_ip/control/epg?id=16dcb
6143198520 1067754600 1800
Daten der Woche
Moderation: Andrea Müller
Themen: Kandidatenkür: Maas wird Spitzenkandidat
Aufsteiger: Auszeichnung für Scheer Diskussion: Längere
Arbeitszeiten; dazu ein Interview mit Christian Scholz,
Wirtschaftswissenschaftler Ladenschluss: Öffnungszeiten am
Sonntag

6143198521 1067756400 1800
Abendschau
Themen: Protestmarsch "Es reicht" Vorabdruck: Harry
Potter Militär-MusikfestŠAbendschauNews Ermittlungen
gegen Michael Krausz Bahnunfall am Alexanderplatz Aubis
Urteil

Parameter: eventid=EVENTID
Rückgabe:

Es wird die ausführliche Beschreibung eines Films
zurückgegeben. Diese besteht aus einem Titel, einer allgemeinen
Info und der Beschreibung. Titel, Info und Beschreibung werden mit
einem Enter (\n) voneinander getrennt. Es muss beachtet werden, dass
in der Beschreibung weitere Enter vorkommen können.

Rückgabe-Format:
Titel
Info
Beschreibung
Beispiel:

>>>http://box_ip/control/epg?eventid=571231699926
Ein Käfig voller Helden
Operation 'Tiger'
blablabla
Parameter: ext
Rückgabe:

Es werden alle verfügbaren EPG's aller Programme, zur aktuellen Zeit
zurückgegeben. Jede Zeile wird von einem Enter (\n) von der
nächsten getrennt. Eine Zeile enthält die Information über die
aktuell laufende Sendung.

Rückgabe-Format: channel_id Startzeit Dauer EVENTID Titel der Sendung

Die EVENTID dient als Handle um genauere Informationen abzufragen.
Beispiel:

>>>http://box_ip/control/epg?ext
8716330 1025382300 6900 571233417784 Rocky 2

Parameter: xml=true&channelid=<channel_id>|channelname=<channel_name> [&details=true][&max=<max items>][&stoptime=<long:stop time>][&search=<keywords>]
Rückgabe:
Liefert zum angegebenen Sender (angegeben durch channel_id oder channel_name) das EPG als XML-Liste zurück.
channel_name=Ein oder mehrere durch Komma getrennte Sendernamen.
Wird details=true angegeben, dann werden zusätzlich info1 and info2 mit ausgegeben.
Zur Begrenzung der Listeneinträge dient max für die Anzahl der Elemente, oder
stoptime für die Uhrzeit (Unix Zeit), bis zu der Angaben gemacht werden sollen.

ACHTUNG: Die Angabe von mehreren Sendern hat keinen Effekt. Nur Ergebnisse des ersten Senders werden angezeigt!

Beispiel:
>>>http://192.168.0.15/control/epg?xml=true&channelid=44d00016dca&details=true&max=2
<?xml version="1.0" encoding="iso-8859-1"?>
<epglist>
<channel_id>44d00016dca</channel_id>
<channel_name><![CDATA[Das Erste]]></channel_name>
<prog>
<eventid>309903955495411052</eventid>
<eventid_hex>44d00016dcadd6c</eventid_hex>
<start_sec>1148314800</start_sec>
<start_t>18:20</start_t>
<date>02.10.2006</date>
<stop_sec>1148316600</stop_sec>
<stop_t>18:50</stop_t>
<duration_min>30</duration_min>
<description><![CDATA[Marienhof]]></description>
<info1><![CDATA[(Folge 2868)]]></info1>
<info2><![CDATA[Sülo verachtet Constanze wegen ihrer Intrige. Luigi plündert das Konto und haut ab. Jessy will Carlos über ihre Chats aufklären.]]></info2>
</prog>
<prog>

<eventid>309903955495411054</eventid>
<eventid_hex>44d00016dcadd6e</eventid_hex>
<start_sec>1148316600</start_sec>
<start_t>18:50</start_t>
<stop_sec>1148320200</stop_sec>
<stop_t>19:50</stop_t>

<duration_min>60</duration_min>
<description><![CDATA[Großstadtrevier]]></description>
<info1><![CDATA[239. Fenstergespenster]]></info1>
<info2><![CDATA[Pech für Dirk Matthies: Da steigt er auf eine Leiter, weil ihn mal der Putzfimmel überkommt, und - knacks! - bricht eine Sprosse. Das Bein ist gebrochen, mehrere Rippen geprellt. Katja Metz versorgt ihn mit dem Nötigsten.]]></info2>
</prog>
</epglist>

EPG-Suche
Handler: http://box_ip/control/epgsearch

Parameter: keine
Rückgabe:

Es werden alle verfügbaren EPG-Daten aller Programme zurückgegeben.

Rückgabe-Format: Datum Startzeit Monat Wochentag Dauer in Minuten Sender Titel der Sendung Beschreibung
Beispiel:

>>>http://box_ip/control/epgsearch
2015-04-15 01:30 Apr Mi [30 min]
rbb Berlin HD
THADEUSZ
Gast: Bettina Tietjen
Wie vertrauenerweckend und freundlich Fernsehgesichter sein können,
bemerken Zuschauer spätestens dann, wenn Bettina Tietjen sie zu einer
ihrer Sendungen begrüßt. Seit mehr als 20 Jahren moderiert sie von einem
roten Sofa aus die Sendung "DAS!" für den NDR. Und aktuell macht sie sich
mit dem Buch "Unter Tränen gelacht. Mein Vater, die Demenz und ich"
auch als Autorin einen Namen.
fsk:0
Soap/Melodram/Folklore
----------------------------------------------------------
2015-04-15 01:30 Apr Mi [20 min]
TNT Serie HD
King of Queens
Dancing Queen
8. Staffel, Folge 1: Doug muss Überzeugungsarbeit leisten, um Carrie zu
einem Kurs im "Pole Dancing" zu überreden. Doch nach den ersten Stunden
gefällt es ihr überraschend gut.
USA 2005, mit Jerry Stiller, Kevin James, Leah Remini. 20 Min.
fsk:0
Soap/Melodram/Folklore

Parameter: Suchbegriffe
oder
Parameter: search=Suchbegriffe[&epginfo=true|false|search][&format=plain|xml|json]
Rückgabe:

Es werden alle Sendungen im EPG zurückgegeben, die den Suchbegriff
im Titel oder Beschreibungstext beinhalten.
Die Treffer lassen sich unter Angabe von epginfo=false auf Treffer im Titel beschränken.
Hier werden die Sendungsinhalte (info1 und info2) nicht mitgeliefert.
Mit der Angabe von epginfo=search werden die Sendungsinhalte (info1 und info2) zwar in die Suche
einbezogen, aber nicht mitgeliefert.
Die Ausgabe erfolgt im angegebenen Format. Ist kein Format angegeben, wird reiner Text ausgegeben

Rückgabe-Format: Datum Startzeit Monat Wochentag Dauer in Minuten Sender Titel der Sendung

Beispiel:

>>>http://box_ip/control/epgsearch?Nachtmagazin&epginfo=false
2015-04-14 00:15 Apr Di [20 min]
Das Erste
Nachtmagazin
fsk:0
Nachrichten
----------------------------------------------------------
2015-04-14 01:00 Apr Di [20 min]
tagesschau24 HD
Nachtmagazin
fsk:0
Nachrichten

EPG-Suche mit XML Ausgabe Deprecated!
Handler: http://box_ip/control/epgsearchxml

Die Box herunterfahren
Handler: http://box_ip/control/shutdown

Parameter: keine
Rückgabe:

Es wird der Text ok bei Erfolg oder error im Fehlerfall
zurückgegeben. Die Box schaltet sich bei ok sofort ab.

Rückgabe-Format: ok / error
Beispiel:

>>>http://box_ip/control/shutdown
ok

Standby Mode
Handler: http://box_ip/control/standby

Parameter: on
Rückgabe:

Schaltet in den Standby Mode

Rückgabe-Format: ok /error
Beispiel:

>>>http://box_ip/control/standby?on
ok
Parameter: off&cec=off
Rückgabe:

Schaltet den Standby Mode aus. Bei zusätzlicher Angabe von cec=off,
wird kein Einschalt-Signal von der Box gesendet - der Fernseher bleibt aus.

Rückgabe-Format: ok /error
Beispiel:

>>>http://box_ip/control/standby?off
ok

Parameter:
Rückgabe:

Zeigt den Standby Status an.

Rückgabe-Format: on / off
Beispiel:

>>>http://box_ip/control/standby
on

Lautstärke-Steuerung
Handler: http://box_ip/control/volume

Parameter: keine
Rückgabe:

Es wird die aktuell eingestellte Lautstärke zurückgegeben - die
Werte bewegen sich zwischen 0 (leise) und 100 (laut).

Rückgabe-Format: Lautstärke
Beispiel:

>>>http://box_ip/control/volume
80

Parameter: <Lautstärke als ganze Zahl in 5er Schritten>
Rückgabe:

Es kann die Lautstärke eingestellt werden - die Werte müssen
sich zwischen 0 (leise) und 100 (laut) bewegen. Es sollten nur Werte
in 5er-Schritten gesetzt werden (5,10,...).

Rückgabe-Format: ok / error
Beispiel:

>>>http://box_ip/control/volume?40
ok

Parameter: mute
Rückgabe:

Die Audio-Ausgabe wird abgeschaltet. Es kommt als Bestätigung der
String mute zurück.

Rückgabe-Format: ok
Beispiel:

>>>http://box_ip/control/volume?mute
mute

Parameter: unmute
Rückgabe:

Die Audio-Ausgabe wird wieder eingeschaltet. Es kommt als
Bestätigung der String unmute zurück.

Rückgabe-Format: ok
Beispiel:

>>>http://box_ip/control/volume?mute
unmute

Parameter: status
Rückgabe:

Es wird der Status (ob gerade mute aktiv ist) zurückgegeben.
0 - unmuted
1 - mute

Rückgabe-Format: 0 oder 1
Beispiel:

>>>http://box_ip/control/volume?status
1

Programm umschalten
Handler: http://box_ip/control/zapto

Parameter: keine
Rückgabe:

Es wird die channel_id (hex-value, 64 bit, kein 0x-prefix) des aktuell
laufenden Senders zurückgegeben.
Beispiel:

>>>http://box_ip/control/zapto
16dcb

Parameter: getpids
Rückgabe:

Es werden die VPID und die APID des laufenden Senders angezeigt. Die
beiden Werte sind durch ein Enter voneinander getrennt.

Rückgabe-Format:
VPID
APID
Beispiel:

>>>http://box_ip/control/zapto?getpids
305
306
Parameter: getallpids
Rückgabe:

Es werden die VTXT PID, VPID und alle APIDs des laufenden Senders
angezeigt. Die Werte sind durch ein Enter voneinander getrennt.
Hinter jeder APID wird eine kurze Beschreibung angegeben, bei AC3
Streams zusätzlich (AC3).

Rückgabe-Format:
VPID
APID <description> [(AC3)]
[APID...]
[VTXT PID]
Beispiel:

>>>http://box_ip/control/zapto?getallpids

00511
00512 deutsch
00513 englisch
00515 Dolby Digital 2.0
00032 vtxt
00101 pmt

oder

00101
00102 German
00104 vtxt
00100 pmt
Parameter: getallsubchannels
Rückgabe:

Es werden die Unterkanäle des aktuellen Senders zurückgegeben:

Rückgabe-Format:
channel_id channel_name
Beispiel:

>>>http://box_ip/control/zapto?getallsubchannels

400850012 Direkt Portal
1008500d4 D 1 - 11:30
3008500f1 D 1 - 12:00
3008500dc D 1 - 12:30
1008500d3 D 2 - 11:30
3008500f4 D 2 - 12:00
3008500f0 D 2 - 12:30
4008500d2 D 3 - 11:45
3008500f3 D 3 - 12:45
4008500d1 D 4 - 13:00
4008500d0 D 5 - 12:30

Parameter: stopplayback
Rückgabe:
Stoppt die Dekodierung, um Graben zu können. Zusätzlich wird der
sectionsd gestoppt. Rückgabewert sollte ok für Erfolg sein.

Rückgabe-Format: ok / error
Beispiel:

>>>http://box_ip/control/zapto?stopplayback
ok

Parameter: startplayback
Rückgabe:
Startet die Decodierung nach dem Graben wieder, sectionsd wird auch
wieder gestartet. Rückgabewert sollte ok für Erfolg sein.

Rückgabe-Format: ok
Beispiel:

>>>http://box_ip/control/zapto?startplayback
ok

Parameter: statusplayback
Rückgabe:
'1': Playback aktiv, '0': kein Playback aktiv

Rückgabe-Format: 0/1
Beispiel:

>>>http://box_ip/control/zapto?statusplayback
0

Parameter: stopsectionsd
Rückgabe:
Stoppt den sectionsd zum Grabben. Rückgabewert sollte ok für Erfolg sein.

Rückgabe-Format: ok
Beispiel:

>>>http://box_ip/control/zapto?stopsectionsd
ok

Parameter: startsectionsd
Rückgabe:
Startet sectionsd nach dem Grabben wieder. Rückgabewert sollte ok
für Erfolg sein.

Rückgabe-Format: ok
Beispiel:

>>>http://box_ip/control/zapto?startsectionsd
ok

Parameter: statussectionsd
Rückgabe:
gibt den Status des sectionsd zurück (scanning / kein scanning).

Rückgabe-Format: '1': sectionsd scanning an, '0': sectionsd scanning aus
Beispiel:

>>>http://box_ip/control/zapto?statussectionsd
1

Parameter: channel_id (64 bit, hexadezimal)
Rückgabe:

Zappt auf den angegebenen Kanal.
Als Rückgabe ist im Erfolgsfall ok zu erwarten.

Rückgabe-Format: ok / error
Beispiel:

>>>http://box_ip/control/zapto?16dcb
ok
Parameter: channel_name oder channel_names (Ein oder mehrere durch Komma getrennte Sendernamen; URI encoded)
Rückgabe:

Zappt auf den angegebenen Kanal.
Als Rückgabe ist im Erfolgsfall ok zu erwarten.

Rückgabe-Format: ok / error
Beispiel:

>>>http://box_ip/control/zapto?name=Das%20Erste
ok

Radio/TV, Record Mode
Handler: http://box_ip/control/setmode

Parameter: status
Rückgabe:

Es wird der aktuelle record mode Status zurückgegeben on / off
Beispiel:

>>>http://box_ip/control/setmode?status
on
Parameter: radio
Rückgabe:

Schaltet in den radio mode

Rückgabe-Format: ok / error
Beispiel:

>>>http://box_ip/control/setmode?radio
ok
Parameter: tv
Rückgabe:

Schaltet in den tv mode

Rückgabe-Format: ok / error
Beispiel:

>>>http://box_ip/control/setmode?tv
ok

Parameter: record
Rückgabe:

Schaltet in den record mode. Dies beinhaltet auch das Stoppen bzw.
das Starten des sectionsd scanning, das Starten des Playback (immer)
und das Stoppen des Playback (nur bei stopplayback=true).

Rückgabe-Format: ok / error
Beispiel:

>>>http://box_ip/control/setmode?record=start
ok

>>>http://box_ip/control/setmode?record=start&stopplayback=true
ok

>>>http://box_ip/control/setmode?record=stop
ok

Neutrino Mode Abfrage
Handler: http://box_ip/control/getmode

Parameter: keine
Rückgabe: "tv", "radio", "scart", "standby", "audio",
"pic", "ts", "webtv", "upnp", "unknown"

Es wird der aktuelle Modus der Box zurückgegeben
Beispiel:

>>>http://box_ip/control/getmode
tv

Parameter: channelsmode
Rückgabe: "tv", "radio", "unknown"

Es wird der eingestellte Kanalmodus der Box zurückgegeben
Beispiel:

>>>http://box_ip/control/getmode?channelmode
radio

Datum von der Box abfragen
Handler: http://box_ip/control/getdate

Parameter: keine
Rückgabe:

Es wird das Datum zurückgegeben.

Rückgabe-Format: dd.mm.yyyy
Beispiel:

>>>http://box_ip/control/getdate
11.01.2002

Zeit von der Box abfragen
Handler: http://box_ip/control/gettime

Parameter: keine
Rückgabe:

Es wird die Uhrzeit zurückgegeben.

Rückgabe-Format: hh:mm:ss
Beispiel:

>>>http://box_ip/control/gettime
20:34:24
Parameter: rawtime
Rückgabe:

Es wird das Uhrzeit im time_t Format zurückgegeben.

Rückgabe-Format: time_t
Beispiel:

>>>http://box_ip/control/gettime?rawtime
1046804654

Allgemeine Informationen abfragen
Handler: http://box_ip/control/info

Parameter: streaminfo
Rückgabe:

Es werden Streaminfos zurückgegeben. Die Werte sind durch Enter (\n) getrennt.

Rückgabe-Format: X_res Y_res Bitrate Videoformat Framerate Audioformat
Beispiel:

>>>http://box_ip/control/info?streaminfo
480
576
997500
4:3
25
joint stereo
Parameter: version
Rückgabe:

Es wird der Inhalt der Datei /.version zurückgegeben.
Beispiel:

>>>http://box_ip/control/info?version
version: 1.1.27032002-21.8
md5sum: f1d7d47578bb9040a82085182934ce0e
Erstellt von alexW
Parameter: settings
Rückgabe:

Aktuelle Settings und Box Typ
Beispiel:

>>>http://box_ip/control/info?settings
Boxtype Nokia
videooutput RGB
videoformat 4:3
Parameter: httpdversion
Rückgabe:

Version des httpd
1 : nhttpd (legacy api)
2 : thttpd
3 : nhttpd
Beispiel:

>>>http://box_ip/control/info?httpdversion
3
Parameter: nhttpd_version
Rückgabe: Version des nhttpd (Neutrino)
Beispiel:

>>>http://box_ip/control/info?nhttpd_version
2.2.1

Boxinfo abfragen
Handler: http://box_ip/control/boxinfo

Parameter:
Rückgabe:

Es wird der Hersteller, der Boxname und die Boxarchitektur zurückgegeben.

Beispiel:

>>>http://box_ip/control/boxinfo
vendor=AX
boxname=H51
boxarch=BCM7251S

Aktuellen Kanal abfragen
Handler: http://box_ip/control/getonidsid

Parameter:
Rückgabe:

Es wird die TSIDONIDSID des aktuellen Kanals zurückgegeben.

Diese Funktion sollte NICHT mehr verwendet werden und ist durch
folgenden Aufruf ersetzt:
http://box_ip/control/zapto

Rückgabe-Format: TSIDONIDSID
Beispiel:

>>>http://box_ip/control/getonidsid
44d00016dca

Transponder-Sender abfragen
Handler: http://box_ip/control/currenttpchannels

Parameter:
Rückgabe:

Es wird die channel_id (hex-value, 64 bit, kein 0x-prefix) gefolgt vom
Sendernamen aller Sender auf dem aktuellen Transponder zurückgegeben.

Beispiel:

>>>http://box_ip/control/currenttpchannels
b544000800850086 Sky Cinema+1 HD
b544000800850087 Sky Cinema+24 HD
...

Senderlogo-Pfad abfragen
Handler: http://box_ip/control/get_logo

Parameter: channel_id
Rückgabe:

Es wird der komplette Pfad des Logos ausgegeben.

Beispiel:

>>>http://box_ip/control/get_logo?b544000800850088
/share/tuxbox/neutrino/icons/logo/800850088.png

services.xml lesen
Handler: http://box_ip/control/getservicesxml

Parameter:
Rückgabe:

Es wird der Inhalt der Datei /var/tuxbox/config/zapit/services.xml
zurückgegeben.
Beispiel:

>>>http://box_ip/control/getservicesxml
<?xml version="1.0" encoding="iso-8859-1"?>
<ZAPIT>
<cable>
<transponder transportID="00001" networkID="0">
<cable frequency="04020" symbolRate="06900" fec="0" polarity="0"/>
...

bouquets.xml auslesen
Handler: http://box_ip/control/getbouquetsxml

Parameter:
Rückgabe:

Es wird der Inhalt der Datei /var/tuxbox/config/zapit/bouquet.xml
zurückgegeben.
Beispiel:

>>>http://box_ip/control/getbouquetsxml

<?xml version="1.0" encoding="iso-8859-1"?>
<ZAPIT>
<Bouquet name="beispielbouquet" hidden="0" locked="0">
<channel serviceID="6d67" name="3sat" onid="0001"/>
...

Bouquetlist abfragen
Handler: http://box_ip/control/getbouquets

Parameter:
Rückgabe:

Es werden alle Bouquets zurückgegeben.
Beispiel:

>>>http://box_ip/control/getbouquets
1 ARD
3 Premiere World
4 VisionProgramme
5 ZDFvision

Bouquet abfragen
Handler: http://box_ip/control/getbouquet

Parameter: bouquet=Bouquet Nr. und mode=TV | RADIO oder actual und mode=TV | RADIO optional: xml=true
Rückgabe:

Es werden alle Sender des Bouquets zurückgegeben. Bei Angabe des Parameters actual, wird das erste
Bouquet ausgegeben, das den aktuellen Sender enthält.
Nummer_des_Kanals channel_id Name_des_Senders
Beispiel:
>>>http://box_ip/control/getbouquet?bouquet=2&mode=TV
20 12ee3 RTL Television
21 85002e SAT.1
22 850382 ProSieben
23 12ef4 RTL2
24 12f1c VOX

Wird xml=1 angegeben, dann wird die Liste im XML-Format zurückgegeben:
Beispiel:
>>>http://192.168.0.15/control/getbouquet?bouquet=3&xml=true
<?xml version="1.0" encoding="iso-8859-1"?>
<bouquetlist>
<bouquet>
<bnumber>3</bnumber>
</bouquet>
<channel>
<number>33</number>
<id>44d00016dca</id>
<name><![CDATA[Das Erste]]></name>
</channel>
<channel>
<number>34</number>
<id>44d00016dcd</id>
<name><![CDATA[arte]]></name>
</channel>
</bouquetlist>

Fenster in Neutrino
Handler: http://box_ip/control/message

Parameter: popup=Text oder nmsg=Text

Rückgabewert: ok

Zeichensatz: UTF-8, Leerzeichen müssen als %20 gesendet werden

Öffnet ein Popup (popup) oder Message (nmsg) Window, in dem
der Textteil des Parameters angezeigt wird. Ein Popup Fenster schließt
sich nach einiger Zeit von selbst, während ein Message Window
vom Benutzer geschlossen werden muss.
Der Parameter "timeout" bestimmt, nach welcher Zeit das Fenster automatisch schließt.
Beispiele:

>>>http://box_ip/control/message?popup=Hallo%20World
öffnet ein Popup-Fenster auf dem Fernseher, in dem "Hallo World" steht.

>>>http://box_ip/control/message?popup=Hallo%20World&timeout=30
öffnet ein Popup-Fenster auf dem Fernseher, in dem "Hallo World" steht und sich nach 30 Sekunden schließt.

>>>http://box_ip/control/message?nmsg=Hallo%20Welt
öffnet ein Message-Fenster auf dem Fernseher, in dem "Hallo Welt" steht.
KDE Konqueror Benutzer können folgendes Verfahren benutzen:
------------------------------------------------------------
Mit Hilfe von "Settings -> Web Shortcuts -> Add" einen neuen Search
Provider hinzufügen. z.B.:
- Search Provider Name: DBox Popup
- Search URI: http://box_ip/control/message?popup=\{@}
- URI shortcut: dbox
- Charset: UTF-8

Nun kann eine Popup Message direkt in die Location Bar eingegeben
werden, wenn man ein "dbox: " davor setzt. Beispiel:
dbox: Hallo ä ö ü Ä Ö Ü ß World


Google's UTF-8 Tutorial:
------------------------
http://www.google.com/search?q=%C3%A4%20%C3%B6%20%C3%BC%20%C3%84%20%C3%96%20%C3%9C%20%C3%9F&ie=UTF-8&oe=UTF-8

Timerd Interface
Handler: http://box_ip/control/timer

Parameter: [format=id]
Rückgabe:

Zeigt die Liste aller Timer.

Rückgabe-Format:
eventID eventType eventRepeat repcount announceTime alarmTime stopTime data

eventID ist der Timer-Platz.
eventType ist die Art des Timers, die kann sein:

1 = SHUTDOWN
2 = NEXTPROGRAM
3 = ZAPTO
4 = STANDBY
5 = RECORD
6 = REMIND
7 = SLEEPTIMER
8 = EXEC_PLUGIN


eventRepeat ist die Angabe der Timerwiederholung. Die kann sein:

0 = ONCE (Einmal)
1 = DAILY (Täglich)
2 = WEEKLY (Wöchentlich)
3 = BIWEEKLY (Alle 2 Wochen)
4 = FOURWEEKLY (Alle 4 Wochen)
5 = MONTHLY (Monatlich)
6 = BYEVENTDESCRIPTION (noch nicht implementiert)

Es gibt auch die Möglichkeit WEEKDAYS (Wochentage)
festzulegen, an denen die Aufnahme statfinden soll. Dies wird über einen
Bitschlüssel angegeben der Bit 9-15 für die Wochentage
ansieht. Das heißt:

0000000100000000 = 256 = Montag
0000001000000000 = 512 = Dinstag
0000010000000000 = 1024 = Mittwoch
0000100000000000 = 2048 = Donerstag
0001000000000000 = 4096 = Freitag
0010000000000000 = 8192 = Samstag
0100000000000000 = 16384 = Sontag

Dem zufolge ist Montag+Mittwoch+Samstag

0000000100000000 = 256
0000010000000000 = 1024
0010000000000000 = 8192
---------------- ----
0010010100000000 = 9472

repcount bestimmt die Anzahl der Timeraufrufe, nach der ein Timer
automatisch gelöscht wird. 0 bedeutet, dass es keine
Beschränkung gibt. Bei eventRepeat=ONCE hat diese Einstellung
keine Auswirkungen.

announceTime ist die Zeit, zu der ein Timer-Hinweis auf dem
Bildschirm erscheint. Siehe auch Kapitel 16: popup. alarmTime ist
die Zeit des Timer-Starts stopTime ist die Stoppzeit für den Timer
data ist der Name des Senders.

data enthält weitere Angaben zum Timer. Bei RECORD z. B. den Sendernamen.
Wurde format=id angegeben, so wird statt des Sendernamens die channel-id ausgegeben.
Beispiel:

>>>http://box_ip/control/timer
1 1 1 4 1034309516 1034309576 1034284376 555089

d. h. event 1, SHUTDOWN, DAILY, nach 4 Timerausführungen wird der
Timer gelöscht, Hinweiszeit, Alarm/Startzeit, Stoppzeit,
Kanal/Daten. Die Zeiten sind time_t (Unix Zeitstempel)
Parameter: get=pre | post
Rückgabe:

Gibt die voreingestellte Vor- bzw. Nachlaufzeit für RecordingSafty in Sekunden aus.

Rückgabe-Format: Sekunden

Beispiel:

>>>http://box_ip/control/timer&get=pre
120
 

Parameter:
action,[id],<alarm|ad,amo,ay,ah,ami|alDate,alTime>,<stop|sd,smo,sy,sh,smi|[stDate],stTime>,announce,type,rep,repcount,channel_id,msg,rs,
[update] Rückgabe: ok / error

announce, type, rep und repcount analog zum oben.
type: Default ist RECORD
rep: Default ist 0
repcount: Default ist 0

action kann entweder new oder modify sein. Bei modify mus noch ein
Parameter id angegeben werden um festzulegen welcher Timer modifiziert
wird.

Zeitangabe:
Variante 1)
Angabe im time_t Format (nur für action=new): announce, alarm und
stop mit einer time_t Zeit

Variante 2)
Angabe in Parametern :
a/sd = Tag
a/smo = Monat
a/sy = Jahr
a/sh = Stunde
a/smi = Minute
meint: ad für Alarm Day und sd für Stop Day usw.

Variante 3)
Formatierte Angabe (nur für action=new, Format muss genau eingehalten werden):
alDate = Datum Start, Format TT.MM.JJJJ
alTime = Uhrzeit Start, Format HH.MM
stDate = Datum Ende, Format TT.MM.JJJJ (optional)
stTime = Uhrzeit Ende, Format HH.MM

channel_id ist die Kennung des Senders (als Hexadezimalzahl ohne '0x'-Prefix).
Alternativ kann der Sendername direkt angegeben werden:
channel_name = Sendername (Ein oder mehrere durch Komma getrennte Sendernamen;
muss URI codiert sein, also Leerzeichen mit "%20" ersetzen)

msg ist die Message die bei REMIND gesendet wird

Ist der Parameter "rs" auf "1" gesetzt, so wird bei Aufnahmetimern,
die in Neutrino konfigurierte "Aufnahmestart/stop-Korrektur"
berücksichtigt

rec_dir kann einen Aufnahmepfad enthalten (er muss URI-codiert sein).

update=1 bei action=new löscht einen ggf. vorhandenen Timer mit
gleicher Startzeit vor dem Hinzufügen.

Rückgabe-Format: ok / error

Beispiel:

>>>http://box_ip/control/timer?action=new&alarm=1034309576&stop=1034284376&announce=1034309576&type=1&rep=1&channel_id=16dcb
ok
>>>http://box_ip/control/timer?action=new&alDate=24.01.2006&alTime=20.00&stTime=20.15&channel_name=Das%20Erste&update=1
ok

LCD Interface
Handler: http://box_ip/control/lcd

Parameter:
lock, clear, png, raw, line, rect, xpos, ypos, size, font, color, text, update
Rückgabe: ok /error

Ansteuerung des LCD-Interfaces über das Web-Interface

Folgende Parameter werden dabei unterstützt:

lock=n : n=1 -> das Display wird bis auf Widerruf für Neutrino gesperrt
n=0 -> das Display wird wieder für Neutrino freigegeben

clear=n : n=1 -> das Display wird gelöscht (sollte ganz vorn stehen)
n=0 -> das Display wird vor der neuen Ausgabe nicht
gelöscht (kann entfallen)

png=Dateiname : eine lokal auf der Box liegende PNG-Datei wird in's
Display geladen
(z.B. /share/tuxbox/lcdd/icons/setup.png als
Hintergrund)

raw=x,y,xs,ys,d1,..,dn : überträgt die Daten d1 bis dn an die
Position (x,y) im Display mit xs Spalten und ys Zeilen. Die Daten werden dezimal
übertragen. Jeder Wert repräsentiert dabei 8 Punkte innerhalb einer Zeile. Das
höchstwertige Bit entspricht dem Pixel ganz links. Sollen in einer Zeile 9 Pixel
geschrieben werden, sind dafür zwei Datenwerte nötig, auch wenn die
restlichen 7 Bit des zweiten Wertes nicht verwendet werden. Die Werte werden
zeilenweise hintereinander geschrieben. Für ein Rechteck von 8 Zeilen zu 9 Pixeln sind
also 16 Werte erforderlich, beginnend mit dem Wert für die 8 Pixel ganz links oben,
gefolgt von dem Wert für das letzte Pixel der obersten Zeile (mit einem
Wert von 128 wenn es gesetzt werden soll). Dann folgt der Wert für die ersten 8 Pixel
der zweiten Zeile usw.

line=x1,y1,x2,y2,col : zeichnet eine Linie von (x1,y1) nach (x2,y2)
mit der Farbe col col=0 -> aus, col=1 ->
leuchtend, col=2 -> invertierend

rect=x1,y1,x2,y2,col1,col2: zeichnet ein Rechteck mit der linken
oberen Ecke (x1,y1) und der rechten unteren Ecke (x2,y2),
der Rahmenfarbe col1 welches mit der Farbe col2
ausgefüllt wird (Farben siehe "line")

update=1 : An dieser Stelle wird das Display upgedatet.
Somit kann man zunächst einige Ausgaben machen und dann erst
alles zusammen updaten. Dies verhindert ein Flackern des Displays.
Sequenzen ohne diesen Parameter haben auf die Anzeige also zunächst keine Auswirkung.

Die folgenden Parameter betreffen nur die Textausgabe:

text= : Auszugebender Text in UTF-8 Format (Leerzeichen = %20,
Zeilenumbruch = %0A usw.)

xpos=nn : Position des ersten Zeichens horizontal (default 10)

ypos=nn : Position der linken oberen Ecke des ersten Zeichens (default 10)

size=nn : Größe des Textes (default 12)

color=n : Textfarbe (default 1, siehe "line")

font=n : zu verwendender Font (default 0)
n=0 -> micron.ttf, n=1 -> micron_bold.ttf, n=2 -> pakenham.ttf

Hinweise:
----------------------------------
Innerhalb eines Aufrufes können mehrere Kommandos gleichzeitig angegeben werden.
Allerdings müssen sie von unterschiedlichem Typ sein.
Bei z. B. zwei rect-Parametern innerhalb eines Aufrufes wird der zweite Parameter
ignoriert. Abgearbeitet werden die Kommandos in der Reihenfolge:
lock, clear, png, raw, line, rect, xpos, ypos, size, color, font, text, update.
Der Parameter lock ist erforderlich, da ohne Sperrung das Displays für Neutrino,
die über den nhttpd gemachten Ausgaben auf dem Display, spätestens nach einer Sekunde
durch das zyklische Update von Neutrino wieder überschrieben werden würden.
Daher ist bei der ersten Ausgabe lock=1 zu setzen. Wird das Display nicht mehr benötigt,
muss lock=0 gesetzt werden, damit Neutrino wieder Zugriff auf das LCD erhält.
Beispiel:
----------------------------------

wget -O /tmp/nhttpd.res 'http://localhost/control/lcd?lock=1&clear=1&rect=10,10,110,50,1,0&xpos=20&ypos=27&size=22&font=2&text=%20Hallo%20Welt%0A%C3%9Cbungstext&update=1'
wget -O /tmp/nhttpd.res 'http://localhost/control/lcd?rect=10,10,110,50,1,2&update=1'

um das Display wieder freizugeben, sollte zum Schluß

wget -O /tmp/nhttpd.res 'http://localhost/control/lcd?lock=0'

ausgeführt werden.

Shellscript ausführen
Handler: http://box_ip/cgi-bin/exec

Parameter: <Scriptname> (ohne .sh!)
Rückgabe: Ausgabe des Scripts

Führt das Shellscript aus und liefert die Ausgabe an den Client zurück
Beispiel:

buli.sh gibt einen RSS-Feed zurück, der vom Newsticker angezeigt
wird. In newsticker.list muss dann der Aufruf folgendermassen aussehen:

http://box_ip/cgi-bin/exec?buli

System-/Treiberfunktionen
Handler: http://box_ip/control/system

Parameter: getAViAExtIec
Rückgabe: Status des Iec (optischer Ausgang)

0 = Iec deaktiviert
1 = Iec aktiviert
Beispiel:
http://box_ip/control/system?getAViAExtIec
1
Parameter: setAViAExtIec=on
Rückgabe: ok

Aktiviert den Iec
Beispiel:

http://box_ip/control/system?setAViAExtIec=on
ok
Parameter: setAViAExtIec=off
Rückgabe: ok

Deaktiviert den Iec
Beispiel:

http://box_ip/control/system?setAViAExtIec=off
ok
Parameter: getAViAExtPlayBack
Rückgabe: Gibt zurück, in welchem Dekoder-Modus der Avia läuft

0 = PES
1 = SPTS
Beispiel:

http://box_ip/control/system?getAViAExtPlayBack
1
Parameter: getAViAExtPlayBack=pes
Rückgabe: ok

Aktiviert den PES-Modus
Beispiel:

http://box_ip/control/system?setAViAExtPlayBack=pes
ok
Parameter: getAViAExtPlayBack=spts
Rückgabe: ok

Aktiviert den SPTS-Modus
Beispiel:

http://box_ip/control/system?setAViAExtPlayBack=spts
ok

Fernbedienung
Handler: http://box_ip/control/rc

Parameter:keine/status
Rückgabe:on/off

Zeigt den Status der Fernbedienung
Beispiel:

http://box_ip/control/rc?status
on
Parameter: lock
Rückgabe: ok

Sperrt die Fernbedienung
Beispiel:

http://box_ip/control/rc?lock
ok
Parameter: unlock
Rückgabe: ok

Entsperrt die Fernbedienung
Beispiel:

http://box_ip/control/rc?unlock
ok
Die Box neu starten
Handler: http://box_ip/control/reboot

Parameter: keine
Rückgabe:

Es wird der Text ok bei Erfolg oder error im Fehlerfall
zurückgegeben. Die Box startet sich bei ok sofort neu.

Rückgabe-Format:
ok / error
Beispiel:

>>>http://box_ip/control/reboot
ok

Einige Einstellungen lesen
Handler: http://box_ip/control/settings

Parameter: keine
Rückgabe: Text mit einer Beschreibung des Boxenherstellers,
Videooutputs und Videoformats.

Die /.versions-File lesen
Handler: http://box_ip/control/version

Parameter: keine
Rückgabe: Die Datei /.version wird ausgegeben.

Die gleiche Funktionalität bietet http://box_ip/control/info?version.

Plugin ausführen
Handler: http://box_ip/control/startplugin

Parameter: name=<pluginname>
Rückgabe: ok/error

Das Plugin mit dem Name <pluginname> wird gestartet.
Beispiel:

>>>http://box_ip/control/startplugin?name=tuxtxt
ok

Support für yweb
Handler: http://box_ip/control/yweb

Parameter:
Rückgabe:

Supportfunktionen für yweb. Es wird empfohlen, diese nicht
ausserhalb von yweb zu benutzen.

Aspektratio lesen
Handler: http://box_ip/control/aspectratio

Parameter: keine
Rückgabe: 4:3/16:9

Videoformat lesen/setzen
Handler: http://box_ip/control/videoformat

Parameter: keine/status
Rückgabe: automatic/4:3 (LB)/4:3 (PS)/16:9

Parameter: automatic/4:3-LB/4:3-PS/16:9
Rückgabe: ok

Setzt aktuelles Videoformat.

Videooutput lesen/setzen
Handler: http://box_ip/control/videooutput

Parameter: keine/status
Rückgabe: CVBS/RGB with CVBS/S-Video/YUV with VBS/YUV with CVBS

Parameter: cvbs/rgb/s-video/yuv-vbs/yuv-cvbs
Rückgabe: ok

Setzt Videooutputtyp.

VCR-output lesen/setzen
vHandler: http://box_ip/control/vcroutput
Parameter: keine/status
Rückgabe: CVBS/S-Video

Parameter: cvbs/s-video
Rückgabe: ok/error

Setzt VCRoutputtyp. S-Video ist möglich nur bei Videooutput CVBS
und S-Video.

Scartmode lesen/setzen
Handler: http://box_ip/control/scartmode

Parameter: keine/status
Rückgabe: on/off

Parameter: on/off
Rückgabe: ok

Schaltet Scartmode ein oder aus.

Fernbedienungstasten emulieren
Handler: http://box_ip/control/rcem

Parameter: <keyname>, repeat=<n> (default 1), delay=<delaytime> (default 250)
Rückgabe: ok

Die Taste mit dem Namen <keyname> wird emuliert. <keyname> sind
alle existierende Tasten, auch Tastaturtasten. Es werden <n>
Tastendrücke geschickt, mit einer Pause von <delaytime>
dazwischen. Im Detail: Erstmals wird ein KEY_PRESSED Event geschickt,
danach, <n> - 1 KEY_AUTOREPEAT Events mit <delaytime>
Millisekunden Verzögerung, danach ein KEY_RELEASED Event.

Parameter: <keyname>, duration=<time>, delay=<delaytime> (default 250)
Rückgabe: ok

Äquivalent zur ersten Form, mit repeat = <time>*1000/<delaytime>.
Das bedeutet, die Taste <keyname> für <delaytime> Sekunden zu senden.
Dies ist die Semantik der Argumenten des Programms rcsim.
Beispiel:

>>>http://box_ip/control/rcem?KEY_HELP
ok

>>>http://box_ip/control/rcem?KEY_UP?repeat=4?delay=300
ok

Bouquet-Editor: Attribute setzen
Handler: http://box_ip/control/setbouquet

Parameter: selected=<id>&action=hide|show|lock|unlock
Rückgabe: ok / error

Ändert für "selected" Bouquet das Sichtbarkeitsattribut (hide/show) oder Zugriffsattribut
(lock/unlock). Die Funktion läuft im ZapIt-Bouqueteditor.

/control/savebouquet schreibt die Daten dauerhaft in das Bouquet-File.

Beispiel:

>>>http://box_ip/control/setbouquet?selected=2&action=lock
ok
 

Bouquet-Editor: Bouquet-Liste speichern
Handler: http://box_ip/control/savebouquet

Parameter:
Rückgabe: ok
/control/savebouquet schreibt die Daten dauerhaft in das Bouquet-File.
Beispiel:

>>>http://box_ip/control/savebouquet
ok
 

Bouquet-Editor: Bouquet verschieben
Handler: http://box_ip/control/movebouquet

Parameter: selected=<id>&action=up|down
Rückgabe: ok / error

Verschiebt das "selected"-Bouquet um eine Zeile nach oben oder unten in der Bouquet-Liste.
Die Funktion läuft im ZapIt-Bouqueteditor.

/control/savebouquet schreibt die Daten dauerhaft in das Bouquet-File.

Beispiel:

>>>http://box_ip/control/movebouquet?selected=2&action=down
ok
 

Bouquet-Editor: Bouquet löschen
Handler: http://box_ip/control/deletebouquet

Parameter: selected=<id>
Rückgabe: ok / error

Löscht "selected"-Bouquet aus der Bouquet-Liste.
Die Funktion läuft im ZapIt-Bouqueteditor.

/control/savebouquet schreibt die Daten dauerhaft in das Bouquet-File.

Beispiel:

>>>http://box_ip/control/deletebouquet?selected=2
ok
 
 


Bouquet-Editor: Bouquet hinzufügen
Handler: http://box_ip/control/addbouquet

Parameter: name=<bouquetname>
Rückgabe: ok / error

Fügt ein neues Bouquet mit bouquetname hinzu.
Die Funktion läuft im ZapIt-Bouqueteditor.

/control/savebouquet schreibt die Daten dauerhaft in das Bouquet-File.

Beispiel:

>>>http://box_ip/control/addbouquet?name=neuer%20sender
ok
 

Bouquet-Editor: Bouquet umbenennen
Handler: http://box_ip/control/renamebouquet

Parameter: selected=<id>&nameto=<new name>
Rückgabe: ok / error

Benennt "selected"-Bouquet in new name um.
Die Funktion läuft im ZapIt-Bouqueteditor.

/control/savebouquet schreibt die Daten dauerhaft in das Bouquet-File.

Beispiel:

>>>http://box_ip/control/renamebouquet?selected=2&nameto=Lieblingssender
ok
 

Bouquet-Editor: Bouquet Channels ändern
Handler: http://box_ip/control/changebouquet

Parameter: selected=<id>&bchannels=<channel_id>[,<channel_id>]*[&redirect=url]
Rückgabe: ok / error

Fügt die unter bchannels angegebenen Channels dem "selected"-Bouquet zu.
Die Funktion läuft im ZapIt-Bouqueteditor.

/control/savebouquet schreibt die Daten dauerhaft in das Bouquet-File.

Beispiel:

>>>http://box_ip/control/changebouquet?selected=2&bchannels=2712f001d099, 43700016d66
ok
 

Settings neu laden.
Handler: http://box_ip/control/reloadsetup

Parameter: keine
Rückgabe:

Es wird der Text ok bei Erfolg oder error im Fehlerfall
zurückgegeben. Die Settings werden erneut geladen und Änderungen übernommen.

Rückgabe-Format: ok / error
Beispiel:

>>>http://box_ip/control/reloadsetup
ok

Plugins neu laden
Handler: http://box_ip/control/reloadplugins

Parameter: keine
Rückgabe: ok

Die Pluginliste wird neu geladen.

Kanallisten neu laden
Handler: http://box_ip/control/reloadchannels

Parameter: keine oder hardreload=1
Rückgabe: ok

Die Kanallisten werden neu geladen.
Der Parameter hardreload=1 unterbindet das Speichern der Kanallisten vor dem Neuladen.

Screenshot erstellen
Handler: http://box_ip/control/screenshot

Parameter: name=<dateiname>&osd=1|0&video=1|0

Rückgabe: ok

Screenshot mit TV Bild und OSD wird erstellt und unter /tmp/<dateiname>.png abgelegt.
Beispiel:

>>>http://box_ip/control/screenshot?osd=0&video=1
ok

 
Signalstärke zeigen
Handler: http://box_ip/control/signal

Parameter: keine oder sig, snr, ber

Rückgabe:
SIG: 100
SNR: 90
BER: 0

Signalstärke SIG in %, SNR in % und BER wird ausgegeben. Wird ein spezieller Wert als Parameter angegeben, wird keine Beschreibung ausgegeben.
Beispiel:

>>>http://box_ip/control/signal?sig
100
 
Audio-Decoder Informationen
Handler: http://box_ip/control/audio

Parameter:

Rückgabe: Format Modus Frequenz

Gibt die Audio-Decoder Informationen zum MPEG-2 oder Dolby Digital Tonformat aus.
Beispiel:

>>>http://box_ip/control/audio
DD CH1/CH2 (48000)
 
CA-IDs anzeigen
Handler: http://box_ip/control/crypt

Parameter:

Rückgabe: CA-IDs des Senders

Beispiel:

>>>http://box_ip/control/crypt
Nagra:1830
Nagra:1843
Nagra:1860
Nagra:186a
Videoguard:98c
Videoguard:9c4
 
Verzeichnis-Inhalt anzeigen
Handler: http://box_ip/control/file

Parameter: action=list&path=<Pfad>

Rückgabe: DateinameDateitypFullnameBerechtigungLinkanzahlBesitzerGruppeGrößeÄnderungszeitpunktUnixänderungszeitpunkt
Ohne die unten genannten format-Parameter Zu empfehlen ist die Ausgabe per Parameter format=json

Gibt Inhalt und Datei-Informationen eines Verzeichnisses aus. Die oben genannten Parameter action=list&path=<Pfad>
sind Pflicht. Weitere Aktionen sind noch nicht umgesetzt.
Beispiel:

>>>http://box_ip/control/file?action=list&path=/var/tuxbox/config
..dir4/var/tuxbox/config/..41edld3rootroot0Tue Mar 17 16:06:57 20151426604817
recording.endfile8/var/tuxbox/config/recording.end81edld1rootroot56Tue Mar 17 15:57:49 20151426604269

...
Parameter: ;format=json oder format=xml

Rückgabe: Dateiname,Dateityp,Fullname,Berechtigung,Linkanzahl,Besitzer,Gruppe,Größe,Änderungszeitpunkt,Unixänderungszeitpunkt
ACHTUNG: Die Ausgabe der XML funktioniert unter Umständen nicht fehlerfrei.
Daher sollte plain text, oder JSON genutzt werden.
Beispiel:

>>>http://box_ip/control/file?action=list&path=/var/tuxbox/config&format=json
...
,{"name": "recording.end",
"type_str": "file",
"type": "8",
"fullname": "/var/tuxbox/config/recording.end",
"mode": "81edld",
"nlink": "1",
"user": "root",
"group": "root",
"size": "56",
"time": "Tue Mar 17 15:57:49 2015",
"time_t": "1426604269"
}
...
 
Configs ansehen/bearbeiten
Handler: http://box_ip/control/config

Parameter: config=neutrino oder config=nhttpd oder config=yweb; format=json oder format=xml

Rückgabe: Gibt die entsprechende Konfigurationsdatei als plain text, oder bei entsprechender
Option (format=...) als JSON oder XML aus

Beispiel:

>>>http://box_ip/control/config?config=neutrino
analog_mode1=770
analog_mode2=516
analog_out=1
...
Parameter: action=submit&key1=value1&key2=value2&...

Rückgabe: bearbeitete Konfigurationsdatei im ausgewählten Format

ACHTUNG: Das Schreiben führt zum Setzen von Pseudo-Werten in die Konfigurationsdatei, wie bspw:
2=config
4=action
6=analog_mode1
8=analog_mode2
Dies zerstört die XML-Ausgabe. Der Befehl sollte nicht verwendet werden.
Beispiel:

>>>http://box_ip/control/config?config=neutrino&action=submit&analog_mode1=799&analog_mode2=522&format=xml
...
<config>
<analog_mode1>799</analog_mode1>
<analog_mode2>522</analog_mode2>
<analog_out>1</analog_out>
...
 
Dateisystemstatistiken
Handler: http://box_ip/control/statfs

Parameter: keine oder path=<path>; format=<plain|xml|json>


Streaming URL anfordern
Handler: http://box_ip/control/build_live_url

Parameter: audio_no=<audio-track>;vlc_link=true

Rückgabe: Live-URL des aktuellen Senders oder redirection Link auf vlc.m3u-Datei
Die Werte nach <box_ip> und <Port> sind die Hex-Werte von PMTpid,Vpid,Apid

Beispiel:

>>>http://box_ip/control/build_live_url
http://box_ip:31339/0,0x0064,0x04ff,0x0503

Beim Aufruf mit dem Parameter vlc_link=true wird ein REDIRECT zu der Datei
tmp/vlc.m3u vom Server mit dem gleichen Inhalt wie oben ausgegeben
Die Datei bzw. den Pfad kann man ebenfalls mit dem VLC-Player öffnen.
Bei Radio Streams muss neben der Audio-ID auch die PMT-ID übermittelt werden,
da VLC die Wiedergabe sonst nicht startet.


Kann als veraltet betrachtet werden, da es auch möglich den Stream direkt aufzurufen.
Handler: http://box_ip:31339/

Parameter: id=<channel_id>

Mit Angabe der channel_id kann Stream eines bestimmten Kanals aufgerufen werden.
Es ist möglich mehrere Streams zu laden. Alle Tonspuren sind werden gesendet.
Wenn möglich (gleicher Transponder oder freier Tuner) findet das Streaming im Hintergrund statt.

Beispiel:
http://box_ip:31339/id=bae8000600850083
 
Senderlogos auflisten
Handler: http://box_ip/control/logolist

Parameter: files

Rückgabe: ChannelID;Channelname;Logoname ohne Erweiterung[;benutztes Logo[;Ziel des Symlinks]]

Liste aller Kanäle incl. Logonamen
Bei Angabe des Parameters files, wird - sofern vorhanden - der Dateiname des benutzen
Senderlogos angehängt.
Ist diese Datei ein symbolischer Link, wird noch zusätzlich das Ziel diesen Links angehängt.

Beispiel:

>>>http://box_ip/control/logolist?files
4c9d044d00016dca;Das Erste;44d00016dca;/share/logo/44d00016dca.png
66dd03fb0001283d;Das Erste HD;3fb0001283d;/share/logo/3fb0001283d.png;/share/logo/3f300012b5c.png
5b9d045900013355;BTV;45900013355
519d0007008532da;Folx TV;7008532da
 
Neutrino-Ordner auflisten
Handler: http://box_ip/control/getdir

Parameter: dir, subdirs, format

Dir kann folgende Werte erhalten:
  • moviedir - gibt alle Pfade der moviebrowser.conf zurück
  • recordingdir - gibt den Aufnahmeordner der neutrino.conf zurück
  • allmoviedirs - moviedir + recordingdir

  • subdirs gibt an ob die Unterordner mit ausgegeben werden sollen (true/false)
    format gibt das Ausgabeformat an (xml,json)

    Rückgabe: dir [absoluter Pfad zum Ordner]


    Beispiel:

    >>>http://box_ip/control/getdir?dir=allmoviedirs&subdirs=true&format=json

    {"success": "true", "data":{"dirs": [{"dir": "/mnt/series/", } ,{"dir": "/mnt/movies/", }] }}