MOBOTIX M1-Hilfe Sprache: de  

Thema:  HTTP-API

Die HTTP-API

 

Die HTTP-API (Application Programming Interface) ist eine Software-Schnittstelle zur Kamera und bietet eine komfortable Möglichkeit, die Kamera in ein zentrales Management-System zu integrieren. Die Schnittstelle besteht aus zwei CGI-Skripten, die Sie über HTTP-Befehle mit Parametern und Werten aufrufen können. Über diese Skripte können Sie die Einstellungen der Untermenüs von Setup verändern, bzw. Kamerafunktionen ausführen.

Einstellungen des Setup-Menüs ändern

Der HTTP-Befehl http://10.x.x.x/control/control ermöglicht Ihnen, die Einstellungen des Setup-Menüs zu ändern.

Hinweis: Ersetzen Sie 10.x.x.x durch die aktuelle IP-Adresse der Kamera.

Kamerafunktionen ausführen

Der HTTP-Befehl http://10.x.x.x/control/rcontrol ermöglicht Ihnen, bestimmte Kamerafunktionen ausführen.

Wichtig: Einige Funktionen zum Sichern und Wiederherstellen der Konfiguration dürfen nur von einem Benutzer der Ebene admin ausgeführt werden. In diesem Fall muss das Skript rcontrol über einen anderen HTTP-Befehl aufgerufen werden:
http://10.x.x.x/admin/rcontrol

Schreibweise für Skript-Aufrufe:

Wenn Sie ein Skript mit Parametern ausführen möchten, muss der Verweis auf das Skript von den Parametern durch ein ? getrennt werden:

   http://10.x.x.x/control/rcontrol?action=ledson

Sollen mehrere Parameter übergeben werden, müssen diese durch ein & getrennt werden.

    http://10.x.x.x/control/rcontrol?action=ledson&time=5


Der Befehl control

Teilen Sie dem Skript als Erstes mit, welche Anweisung ausgeführt werden soll.

Anweisungen für control

Anweisung Beschreibung
set Schreibzugriff auf die Bildeinstellungen. Verwenden Sie diese Anweisung, um die Bildeinstellungen zu ändern.
http://10.x.x.x/control/control?set
read Lesezugriff auf die Bildeinstellungen. Verwenden Sie diese Anweisung, um Informationen zu den Bildeinstellungen abzufragen.
http://10.x.x.x/control/control?read
list Die Anweisung list gibt eine Aufstellung der Abschnitte der Konfigurationsdatei auf, die Sie verändern können.
http://10.x.x.x/control/control?list
Um die Parameter eines Abschnitts zu erhalten, erweitern Sie den Aufruf um section=abschnittname.
http://10.x.x.x/control/control?list&section=abschnittname
factory Mit der Anweisung factory können Sie die Parameter eines Abschnitts auf die werksseitigen Voreinstellungen zurücksetzen. Der Aufruf benötigt als weiteren Parameter noch den Abschnittnamen section=abschnittname.
http://10.x.x.x/control/control?factory&section=abschnittname
restore Mit der Anweisung restore setzen Sie die Parameter eines Abschnitts auf die zuletzt im Flash gesicherten Werte zurück. Der Aufruf benötigt als weiteren Parameter noch den Abschnittnamen section=abschnittname.
http://10.x.x.x/control/control?restore&section=abschnittname

Hinweise:

Parameter für den Abschnitt general

Parameter Beschreibung Wertebereich single/dual
camera Sensorauswahl right, left, both, RiL, LiR single
size Bildgröße 160x120, 320x240, 640x480 single
framerate Bildwiederholrate in Hz 12, 6, 4, 3, 2, 1 single
sharpen Bildschärfe 0 .. 10 dual
mirror Bildspiegelung no, vertical, horizontal, both single
rotate Bilddrehung 0, 180 single
nightlevel Schwellwert für die Nachtumschaltung in %
0 = deaktiviert
0, 2, 5, 7, 10, 12, 15, 17, 20, 25, 30, 35, 40 single
nightcamera Auswahl des Nachtobjektivs (üblicherweise links) right ,left, both, RiL, LiR single
darknoisesuppress Rauschunterdrückung off, medium, high single
coverimage Bildbereiche verdecken enable, disable, time single
coverimage_wakeup Beginn der Verdeckung eines Bildbereichs in Millisekunden 0 .. 86400000 single
coverimage_sleep Ende der Verdeckung eines Bildbereichs in Millisekunden 0 .. 86400000 single
coverimage_area Konfiguration des zu verdeckenden Bildbereichs.

Als Wert übergeben Sie eine Definition des Bildbereichs wie in der Hilfe unter Allgemeine Bildeinstellungen beschrieben. Wenn Sie mehrere Definitionen übergeben möchten, trennen Sie diese durch das Zeilenendezeichen %0A:
coverimage_area=0,270,190,100,100,
    1%0A1,270,190,100,100,1

string dual

Parameter für den Abschnitt exposure

Parameter Beschreibung Wertebereich single/dual
automatic Automatischer Kontrast off, auto dual
brightness Bildhelligkeit -10 .. 0 .. 10 dual
backlight Gegenlichtkorrektur -10 .. 0 .. 10 dual
ca_night_improve Nachtsichtverbesserung off, on dual
ca_exp_window_type Messfenstertyp all, center, spot, top, middle, bottom, right, vertical, left, right_left, extra dual
ca_exp_window_weight Belichtungsanteil des Messfensters in % -1, 0, 10, 20, 30, 40, 50, 60, 70, 80, 90, 100 dual
ca_wbal_window_weight Anteil Weißabgleich in % -1, 0, 10, 20, 30, 40, 50, 60, 70, 80 90 100 dual
ca_avg_intensity Mittlere Helligkeit innerhalb des Messfensters 100, 150, 200, 250, 300, 350, 400, 450, 500, 550, 600, 650, 700, 750, 800 dual
ca_exp_window_draw Messfenster in das Bild einblenden on, off dual
ca_exp_max Maximale Belichtungszeit in Sekunden 100, 150, 200, 250, 300, 350, 400, 450, 500, 550, 600, 650, 700, 750, 800 single
ca_exp_min Minimale Belichtungszeit 100, 150, 200, 250, 300, 350, 400, 450, 500, 550, 600, 650, 700, 750, 800 single
ca_linefreq Frequenz des Stromnetzes 50, 60 single

Parameter für den Abschnitt action

Parameter Beschreibung Wertebereich single/dual
outputaction Schaltet den Schaltausgang für die gewählte Zeit. 0, 1, 2, 5, 10, 30, 60, 300  
ftpaction Erste FTP-Übertragung aktivieren/deaktivieren. Zum Aktivieren wird ein im Dialog FTP-Profile erstelltes Profil übergeben. off, oder ein gültiger Profilname single
ftpaction2 Zweite FTP-Übertragung aktivieren/deaktivieren. Zum Aktivieren wird ein im Dialog FTP-Profile erstelltes Profil übergeben. off, oder ein gültiger Profilname single
visualalarm Visueller Alarm enable, disable single
visualalarm_format Darstellung des visuellen Alarms im Bild bar1, bar2, box1, box2, sign1, sign2 single
visualalarm_color Farbe des visuellen Alarms
 0x000000
 0x800000
 0x008000
 0x808000
 0x000080
 0x800080
 0x008080
 0x808080
 0xC0C0C0
 0xFF0000
 0x00FF00
 0xFFFF00
 0x0000FF
 0xFF00FF
 0x00FFFF
 0xFFFFFF
single
visualalarm_erase Maximale Dauer der grafischen Einblendung in Sekunden 0, 1, 5, 10, 30 single
visualalarm_acknowledge Alarmquittierung enable, disable single
ringbuffer Ringpuffer aktivieren/deaktivieren on, off single
histcount Voralarmbilder 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 single
futcount Nachalarmbilder 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 single
storyinterval Aufnahmepause zwischen den Bildern einer Bildserie in Millisekunden 0 .. 600000 single

Parameter für den Abschnitt color

Parameter Beschreibung Wertebereich single/dual
colorprofile Farbprofil für den Weißabgleich auto, Neontube, Cloudy, Sunny single
color Farbsättigung -10 .. 0 .. 10 dual
blue Blauabgleich -10 .. 0 .. 10 dual
red Rotabgleich -10 .. 0 .. 10 dual

Parameter für den Abschnitt jpeg

Parameter Beschreibung Wertebereich single/dual
motionjpeg MxPEG-Video-Codec enable, disable single
jpegmode Qualitätsmodus für die Bilderzeugung quality, maxsize single
quality JPEG-Qualität in % 10, 20, 30, 40, 50, 60, 70, 80, 90 single
jpegmaxsize Maximale JPEG-Größe in kB 20 .. 2048 single

Parameter für den Abschnitt text

Parameter Beschreibung Wertebereich single/dual
textdisplay Texteinblendung disable, enable, datetime single
textbgcolor Texthintergrundfarbe
 0x000000
 0x800000
 0x008000
 0x808000
 0x000080
 0x800080
 0x008080
 0x808080
 0xC0C0C0
 0xFF0000
 0x00FF00
 0xFFFF00
 0x0000FF
 0xFF00FF
 0x00FFFF
 0xFFFFFF
single
textbgtrans Transparenz der Texthintergrundfarbe in % 0, 25, 50, 75, 100 single
errortext Einblendung von Fehlermeldungen ins Bild aktivieren/deaktivieren 0, 1 single
date Zeitformat auswählen 0, 1, 2, 3, 4, 5, 6 single
print Kommentar einblenden String single
imageinfo Symbole für Ereignisse und Aktionen einblenden 0, 1, 2 single
chartdrawmode Pegelanzeige off, bar, scrollchart single
chartdatasource Quelle für die Pegelanzeige PI, MI, IL, SI, EC, TP single
objecttracing Objektverfolgung disable, enable single
objectcamera Bildsensor, der für die Objektverfolgung verwendet werden soll right, left single

Parameter für den Abschnitt eventcontrol

Parameter Beschreibung Wertebereich single/dual
pircheck Ereigniserkennung Passiv-Infrarot-Sensor aktivieren/deaktivieren on, off single
pir Schwellwert für das Auslösen des Passiv-Infrarot-Sensors 0 .. 100 single
motioncheck Ereigniserkennung Bewegungserkennungsfenster aktivieren/deaktivieren on, off single
motion Bewegungserkennungsfenster definieren. Trennen Sie mehrere Definitionen durch das Zeilenendezeichen %0A:
motion=0,270,190,100,100,
    1%0A1,270,190,100,100,1
string  
motionwintype Darstellung des Rahmens für Bewegungserkennungsfenster off, on, highlight single
motiondarksuppress Bewegungserkennung bei Nacht deaktivieren 0, 2, 5, 7, 10, 12, 15, 17, 20, 25, 30, 35, 40 dual
miccheck Ereigniserkennung Mikrofon aktivieren/deaktivieren on, off single
mic Schwellwert für das Auslösen eines Ereignis 0 .. 100 single
micwidth Mindestdauer eines Geräusches lauter als der Schwellwert in Millisekunden 50, 100, 150, 200, 250, 300, 400, 500, 750, 1000, 2000 single
inputswitch Ereigniserkennung Schaltausgang off, close, open single
buttoncheck Ereigniserkennung Kamerataster on, off single
button Tastenkombination, die ein Ereignis auslöst right, left, rightORleft, rightANDleft single
ircheck Ereigniserkennung IR-Fernbedienung aktivieren/deaktivieren on, off single
timercheck Ereigniserkennung Periodisches Ereignis aktivieren/deaktivieren on, off single
timerunit Maßeinheit für das Intervall zwischen periodischen Ereignissen sec, ms, Hz single
timer Wert für das Intervall zwischen periodischen Ereignissen 0 .. 86400 single
timetaskclick Ereigniserkennung Zeitgesteuerte Ereignisse aktivieren/deaktivieren 0, 1 single
userclick Ereigniserkennung Benutzer-Klick aktivieren/deaktivieren 0, 1 single
ipreceivecheck Ereigniserkennung Netzwerkmeldung empfangen aktivieren/deaktivieren 0, 1 single
ipreceiveport Der Port, auf dem die Kamera Netzwerkmeldungen erwartet 1 .. 65536 single
ipreceivematch Vergleichsart für die Netzwerkmeldung strcmp = Textvergleich
regex = Regulärer Ausdruck
single
ipreceivemessage Der erwartete Meldungstext für den Textvergleich, bzw. der reguläre Ausdruck string single
randomcheck Ereignissensor Zufallsereignis aktivieren/deaktivieren on, off single
randomrange Anzahl der Zufallsereignisse pro Stunde, z. B. 1.000 oder 10 string single
eventdurationmode Ereignisfilter aktivieren/deaktivieren on, off single
eventduration Zeitfenster, in Sekunden, in dem eine bestimmte Anzahl Ereignisse erwartet wird 1 .. 3600 single
eventdurationevent Anzahl der erwarteten Ereignisse, innerhalb des Zeitfensters 1 .. 3600 single
eventdurationcondition Bedingung für das Auslösen eines Ereignis durch den Ereigniszähler more, less single
eventdurationaction Häufigkeit, mit der eine Aktion beim Eintreten eines Ereignis ausgeführt wird
first Nur einmal, wenn die Bedingung erfüllt ist
every Jede Sekunde, solange die Bedingung erfüllt ist
single
outputaction Schaltdauer in Sekunden 0, 1, 2, 5, 10, 30, 60, 300 single

Parameter für den Abschnitt settings

Parameter Beschreibung Wertebereich single/dual
edactiv Ereignisscharfschaltung aktivieren/deaktivieren enable, disable, close, open, time single
edwakeup Beginn der Ereignischarfschaltung in Millisekunden 0 .. 86400000 single
edfallasleep Ende der Ereignischarfschaltung in Millisekunden 0 .. 86400000 single
freezeactiv Stopp-Aktion aktivieren/deaktivieren on, off single
freezecondition Ereignis, das die Stopp-Aktion auslöst PI, VM, MI, SI, BT, IR, PE, TT, UC, RC, RD, EC single
freezedelay Verzögerungszeit bis zum Stoppen der Aktionen in Sekunden 0 .. 86400 single
actiondelay Aktionsverzögerung in Sekunden 0 .. 3600 single
notifydelay Meldungstotzeit in Sekunden 0 .. 3600 single
eventdelay Ereignistotzeit in Sekunden 0 .. 3600 single

Parameter für den Abschnitt message

Parameter Beschreibung Wertebereich single/dual
playsound Wiedergabe einer Audiodatei bei einem Ereignis No Sound, Boing, Camera, Cow, Default, Ding, Explode, Glass, Notify, Pain, Sheep, Tada, Standard single
emailaction Aktion E-Mail senden aktivieren off, oder
jedes in E-Mail-Profile erstellte Profil.
single
emailaction_attachment Anhang für die E-Mail festlegen. Wenn Sie keinen Wert übergeben, werden die Angaben aus E-Mail-Profile verwendet. off, img, story, comment single
emailaction2 Aktion Zweite E-Mail aktivieren off, oder
jedes in E-Mail-Profile erstellte Profil.
single
emailaction2_attachment Anhang für die E-Mail festlegen. Wenn Sie keinen Wert übergeben, werden die Angaben aus E-Mail-Profile benutzt. off, img, story, comment single
callaction ISDN-Telefonanruf off, oder
jedes in Profile für ISDN-Sprachbenachrichtigung erstellte Profil.
single
ipnotifycheck Aktion Netzwerkmeldung senden aktivieren/deaktivieren on, off single
ipnotifyaddress Adresse und Port, an den die Netzwerkmeldung gesendet werden soll. Die Adresse ist durch einen Doppelpunkt von dem Port zu trennen.
Beispiel: 10.x.x.x:8000
string single
ipnotifymessage Text, der mit der Netzwerkmeldung gesendet wird string, oder
Systeminformationen, auf die Sie über spezielle Variablen zugreifen können
single

Parameter für den Abschnitt signalout

Parameter Beschreibung Wertebereich single/dual
so_activ Aktion Erweiterter Schaltausgang aktivieren/deaktivieren enable, disable, time single
so_wakeup Zeitpunkt der Aktivierung in Sekunden 0 .. 86400000 single
so_sleep Zeitpunkt der Deaktivierung in Millisekunden 0 .. 86400000 single
so_time Schaltdauer des erweiterten Schaltausgangs in Sekunden 0 .. 86400 single
so_deadtime Totzeit des erweiterten Schaltausgangs in Sekunden 0 .. 3600 single
so_imageinfo Ereignissymbole in das Bild einblenden on, off single
so_illicheck Beleuchtungsfilter aktivieren/deaktivieren on, off single
so_illi Schwellwert für den Beleuchtungsfilter 0 .. 100 single
so_pircheck Passiv-Infrarot-Sensor aktivieren/deaktivieren on, off single
so_pir Schwellwert für das Auslösen des Passiv-Infrarot-Sensors 0 .. 100 single
so_motioncheck Bewegungserkennungsfenster aktivieren/deaktivieren on, off single
so_miccheck on, off Mikrofon aktivieren/deaktivieren single
so_inputswitch Schalteingang aktivieren/deaktivieren off, close, open single
so_buttoncheck Tasten auf der Kamera-Vorderseite aktivieren/deaktivieren on, off single
so_button Tastenkombination right, left, rightORleft, rightANDleft single
so_ircheck IR-Fernbedienung aktivieren/deaktivieren on, off single
so_timercheck Periodisches Ereignis aktivieren/deaktivieren on, off single
so_timer Wert für das Intervall zwischen periodischen Ereignissen in Sekunden 0 .. 86400 single
so_timetaskclick Zeitgesteuertes Ereignis aktivieren/deaktivieren on, off single
so_userclick Benutzer-Klick aktivieren/deaktivieren on, off single
so_ipreceivecheck Netzwerkmeldung empfangen aktivieren/deaktivieren on, off single
so_randomcheck Zufallsereignis aktivieren/deaktivieren on, off single
so_randomrange Anzahl der Zufallsereignisse pro Stunde. Beispiel: 1.000 oder 10 string single

Der Befehl rcontrol

Das Skript erwartet als ersten Wert immer den Namen der Aktion, die ausgeführt werden soll. Abhängig von der Aktion kann es erforderlich sein, noch zusätzliche Parameter anzugeben. Bei den zusätzlichen Parametern wird zwischen Pflicht- und Wahlparametern unterschieden.

Parameter für rcontrol

Aktion Beschreibung Pflichtparameter Wahlparameter
sigouthigh Der Schaltausgang wird geschlossen. Der optionale Parameter time öffnet den Schaltausgang nach Ablauf der angegebenen Zeit wieder. keine
time
Zeitangabe in Sekunde
sigoutlow Der Schaltausgang wird geöffnet. Der optionale Parameter time schliesst den Schaltausgang nach Ablauf der angegebenen Zeit wieder. keine
time
Zeitangabe in Sekunden
sound Gibt die Audiodatei boing wieder. Mit dem optionalen Parameter soundfile können Sie eine Audiodatei angeben. Sie können eine in der Software enthalten Audiodatei verwenden, oder jede in Sprachmeldungen aufnehmen und verwalten aufgenommene Audiodatei. keine
soundfile
Name der Audiodatei
ledson Schaltet alle LEDs ein. Der optionale Parameter time setzt die LEDs nach Ablauf der angegebenen Zeit wieder auf die werksseitigen Voreinstellungen zurück. keine
time
Zeitangabe in Sekunden
ledsoff Schaltet alle LEDs aus. Der optionale Parameter time setzt die LEDs nach Ablauf der angegebenen Zeit wieder auf die werksseitigen Voreinstellungen zurück. keine
time
Zeitangabe in Sekunden
ledsdefault Setzt die LEDs auf die werksseitige Voreinstellung zurück. keine keine
ledsstring Der Zustand jeder LED kann explizit geändert werden. Dazu ist der Parameter leds erforderlich. Als Wert muss ein sechs Zeichen langer String übergeben werden, wobei jedes Zeichen den Zustand einer LED bestimmt. Die Zuordnung erfolgt im Uhrzeigersinn, das erste Zeichen ist der LED auf zwölf Uhr zugeordnet.
Beispiel: http://10.x.x.x/
    control/rcontrol?
    action=ledsstring
    &leds=01BD11

leds

0=LED aus
1=LED an
B=LED blinkt
D=Werksseitige Voreinstellung
time
Zeitangabe in Sekunden
putrs232 Senden eines Textes über die serielle Schnittstelle. Wenn Sie den Parameter rs232outtext nicht setzen, wird lediglich "hello world" übertragen. keine
rs232outtext
string
getrs232 Text von der seriellen Schnittstelle lesen. Ohne weitere Parameterangabe werden die letzten 2048 bytes aus dem Puffer gelesen. keine <<<<<<< cgi-remotecontrol.html
nrofbytes 0 .. 102400 bytes

rs232delafterread
Puffer nach dem Lesen löschen =======
nrofbytes
0 .. 102400 bytes
rs232delafterread
Puffer nach dem Lesen löschen >>>>>>> 1.9.2.16
0=nicht löschen
1=löschen
<<<<<<< cgi-remotecontrol.html
======= >>>>>>> 1.9.2.16
getrs232hex Entspricht der Funktion getrs232, allerdings werden die Zeichen in Hex-Code ausgegeben. keine wie getrs232
userclick Führt die Funktion Benutzer-Klick aus. keine keine
gettemp Gibt die interne Temperatur der Kamera zurück.
Hinweis:
Dieser Befehl steht bei Basic-Kameras nicht zur Verfügung.
keine keine
rs232sigin Gibt den Status von Pin 9 der seriellen Schnittstelle zurück keine keine
setrs232sig Setzt die Pins der seriellen Schnittstelle. Beachten Sie, dass die serielle Schnittstelle im Dialog Einrichten von Schnittstelle und Modem korrekt konfiguriert sein muss.
24V 0, 1
RTS 0, 1
TXD 0, 1
DTR 0, 1
keine
ftplastevent Überträgt das letzte, gespeicherte Alarmbild per FTP. Erwartet als weitere Angabe den Namen eines FTP-Profils. Das Profil muss in FTP-Profile definiert sein.
profile
Profilname
keine
ftpcurrent Überträgt das aktuelle Bild per FTP. Erwartet als weitere Angabe den Namen eines FTP-Profils. Das Profil muss in FTP-Profile definiert sein.
profile
Profilname
keine
emaillastevent Überträgt das letzte, gespeicherte Alarmbild per E-Mail. Erwartet als weitere Angabe den Namen eines E-Mail-Profils. Das Profil muss in E-Mail-Profile definiert sein.
profile
Profilname
keine
emailcurrent Überträgt das aktuelle Bild per E-Mail. Erwartet als weitere Angabe den Namen eines E-Mail-Profils. Das Profil muss in E-Mail-Profile definiert sein.
profile
Profilname
keine
sendmessage Sendet eine Netzwerkmeldung an die angegebene Adresse
Hinweis:
Dieser Befehl steht bei Basic-Kameras nicht zur Verfügung.
message string
addr ip-adresse:port
keine
actionactivityon Aktiviert sämtliche Aktionen keine keine
actionactivityoff Deaktiviert sämtliche Aktionen keine keine
actionactivitytime Aktiviert sämtliche Aktionen für die in Allgemeine Ereigniseinstellungen definierte Zeit. keine keine
eventack Quittiert einen Alarm keine keine
isdnphone Löst eine Sprachmeldung der Kamera per Telefonanruf aus. Erwartet als weitere Angabe den Namen eines in Profile für ISDN-Sprachbenachrichtigung definierten Profils.
profile
Profilname
keine
speakip Gibt die aktuelle IP-Adresse über den Lautsprecher wieder.
Hinweis:
Dieser Befehl steht bei Basic-Kameras nicht zur Verfügung.
keine keine

Sichern und Wiederherstellen der Konfiguration

Funktionen zum Sichern und Wiederherstellen der Konfiguration dürfen nur von Benutzern der Ebene admin ausgeführt werden.

Beispiel: http://10.x.x.x/admin/rcontrol?action=storeconfig
Hinweis:
Diese Befehle stehen bei Basic-Kameras nicht zur Verfügung.

Funktionen für Benutzer der Ebene admin

Funktion Beschreibung Pflichtparameter Wahlparameter
storeconfig Speichert die aktuelle Konfiguration in den permanenten Speicher der Kamera. keine keine
restoreconfig Lädt die letzte gespeicherte Konfiguration aus dem permanenten Speicher der Kamera. keine keine
resetconfig Lädt die werksseitigen Voreinstellungen der Kamera. keine keine
reboot Führt einen Neustart der Kamera durch. keine keine


©2003 MOBOTIX AG, Deutschland · http://www.mobotix.com/ · E-Mail: info@mobotix.com