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 mehreren CGI-Skripten, die Sie über HTTP-Befehle mit Parametern und Werten aufrufen können. Über diese Skripte können Sie die Einstellungen des Setup-Menüs verändern und bestimmte Kamerafunktionen ausführen.
Einstellungen des Setup-Menüs ändern
Der HTTP-Befehl http://31.47.87.165/control/control
ermöglicht Ihnen, die Einstellungen des Setup-Menüs zu ändern.
Verwenden der vPTZ-Funktionen
Mit Einführung der Q-Modellreihe wurden die Funktionen für die Bedienung des virtuellen PTZ (vPTZ - virtueller Pan/Tilt/Zoom) auch über die HTTP-API zugänglich gemacht. Die jeweiligen Funktionen sind in speziellen Seiten dokumentiert, die über die folgenden Links aufgerufen werden können:
click.cgi
: Dieses Interface bietet eingeschränkten Zugriff auf einfache vPTZ-Funktionen.rotorcgi
: Dieses Interface bietet den vollen Zugriff auf sämtliche vPTZ-Funktionen.control?list§ion=vptzcontrol
: Auch control
bietet Zugriff auf einige vPTZ-Funktionen, die im Abschnitt vptzcontrol dokumentiert sind.Kamerafunktionen ausführen
Der HTTP-Befehl http://31.47.87.165/control/rcontrol
ermöglicht Ihnen, bestimmte Kamerafunktionen auszufü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://31.47.87.165/admin/rcontrol
|
---|
Wenn Sie z. B. die Anweisung list
mit dem Befehl control
verwenden möchten, muss die nachfolgende Anweisung vom Befehl durch ein ? getrennt werden:
http://31.47.87.165/control/control?list
Um eine Anweisung mit einem Parameter auszuführen, muss die Anweisung vom Parameter durch ein & getrennt werden. Der Wert des Parameters wird durch ein =
kenntlich gemacht:
http://31.47.87.165/control/control?list§ion=actions
Sollen mehrere Parameter übergeben werden, müssen diese durch ein & getrennt werden:
http://31.47.87.165/control/rcontrol?action=ledson&time=5
Bei einigen Parametern ist es erforderlich, zwei Werte anzugeben, damit die Änderung für beide Objektive ausgeführt wird. Diese Parameter sind dadurch gekennzeichnet, dass als Standardwerte zwei Parameter angegeben werden (z. B. 0 0
). Im HTTP-Befehl selbst sind die Werte durch ein + zu trennen:
http://31.47.87.165/control/control?set§ion=general&sharpen=0+0
Soll der Befehlsaufruf einen oder mehrere Zeilenenden enthalten (z. B. um mehrere Fensterdefinitionen für die Bewegungserkennung zu definieren), sind diese durch das CGI-Ersatzzeichen %0A
darzustellen:
http://31.47.87.165/control/control?set§ion=general&
coverimage_area=0,540,380,200,200,2%0A1,320,100,100,150,2
Um die CGI-Formatierungszeichen selbst oder Sonderzeichen (Zeilenende, Leerzeichen, Umlaute, ...) zu verwenden, geben Sie die Zeichen URL-kodiert ein. Dabei verwenden Sie das Zeichen %
gefolgt von dem Hexadezimalwert des Zeichens, wie bei den folgenden Beispielen:
Zeichen | URL-Kodierung | Zeichen | URL-Kodierung | Zeichen | URL-Kodierung |
---|---|---|---|---|---|
(Zeilenende) | %0A |
(Leerzeichen) | %20 oder + |
% | %25 |
& | %26 |
+ | %2B |
= | %3D |
? | %3F |
© | %A9 |
® | %AE |
ß | %DF |
ä | %e4 |
Ä | %c4 |
ö | %F6 |
Ö | %D6 |
ü | %FC |
Ü | %DC |
Ç | %c7 |
à | %e0 |
á | %e1 |
â | %E2 |
æ | %E6 |
ç | %E7 |
è | %E8 |
é | %E9 |
ê | %EA |
ë | %EB |
î | %ee |
ï | %EF |
ô | %F4 |
ù | %F9 |
ú | %FA |
ù | %FB |
û | %fc |
Weitere Informationen hierzu finden Sie auf de.wikipedia.org/wiki/URL-Kodierung.
Für bestimmte Parameter können Farbwerte angegeben werden, auf den Hexadezimalwerten für Rot, Grün und Blau (RGB) beruhen. Jeweils zwei Zeichen definieren eine Farbe, 00
steht für den geringsten Farbwert (keine Farbe), FF
steht für den höchsten Farbwert (volle Farbe). Die jeweilige Farbe wird additiv gemischt, so dass 0x000000
Schwarz ergibt, 0xFFFFFF
Weiß.
Beispiele:
Rot | 0xFF0000 |
---|---|
Grün | 0x00FF00 |
Blau | 0x0000FF |
Farbname | Hexadezimal | Farbe | Farbname | Hexadezimal | Farbe |
---|---|---|---|---|---|
Schwarz | 0x000000 |
Rotbraun | 0x800000 |
||
Lindgrün | 0x008000 |
Olivgrün | 0x808000 |
||
Marineblau | 0x000080 |
Lila | 0x800080 |
||
Aquamarin | 0x008080 |
Dunkelgrau | 0x808080 |
||
Hellgrau | 0xC0C0C0 |
Rot | 0xFF0000 |
||
Grün | 0x00FF00 |
Gelb | 0xFFFF00 |
||
Blau | 0x0000FF |
Magenta | 0xFF00FF |
||
Zyan | 0x00FFFF |
Weiß | 0xFFFFFF |
Teilen Sie der Kamera als Erstes mit, welche Anweisung ausgeführt werden soll.
Anweisung | Beschreibung |
---|---|
set |
Schreibzugriff auf die Einstellungen. Verwenden Sie diese Anweisung, um Einstellungen zu ändern.http://31.47.87.165/control/control?set&<Parameter>=<Wert>[&<Parameter>=<Wert>]
|
read |
Lesezugriff auf die Einstellungen. Verwenden Sie diese Anweisung, um Informationen zu den Einstellungen abzufragen.http://31.47.87.165/control/control?read&<Parameter>[&<Parameter>]
|
list |
Die Anweisung list gibt eine Aufstellung der Abschnitte der Konfigurationsdatei aus, die Sie verändern können.
Beispiel: Dieser Befehl erlaubt sowohl das Auslesen der aktuellen Werte als auch, die möglichen Optionen und die angezeigten Texte durch andere Programme abzurufen. |
factory |
Mit der Anweisung factory können Sie die Parameter eines Abschnitts auf die werkseitigen Voreinstellungen zurücksetzen.
Der Aufruf benötigt als weiteren Parameter noch den Abschnittnamen section=<Abschnittname>.http://31.47.87.165/control/control?factory§ion=<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://31.47.87.165/control/control?restore§ion=<Abschnittname>
|
Ein Profil speichert mehrere Einstellungen in einem Wert:
<Profilbezeichner>=<Name>[:<Parameter>=<Wert>]
.
Dabei kann es mehrere Profile mit identischem <Profilbezeichner>
geben. Weil Profile mit den Anweisungen read
und set
nur unzureichend bearbeitet werden können, gibt es hierfür spezielle Befehle:
Anweisung | Beschreibung |
---|---|
read_profile |
Lesen eines Profils.http://31.47.87.165/control/control?read_profile=<Profilbezeichner>:<Name>
|
delete_profile |
Löschen eines Profils.http://31.47.87.165/control/control?delete_profile=<Profilbezeichner>:<Name>
|
set_profile |
Schreiben eines Profils.http://31.47.87.165/control/control?set_profile=<Profilbezeichner>:<Name>&<Parameter>=<Wert>[&<Parameter>=<Wert>]
|
add_profile |
Hinzufügen eines Profils.http://31.47.87.165/control/control?add_profile=<Profilbezeichner>:<Name>&<Parameter>=<Wert>[&<Parameter>=<Wert>]
|
Darüber hinaus gibt es in manchen Profilen besondere Parameter, die durch einen einleitenden Unterstrich gekennzeichnet werden:
Parameter | Beschreibung |
---|---|
_profilename | Dieses Profil hat einen Klarnamen. Anstatt des Wertes <Name> wird in der Oberfläche der Kamera stets der Wert des Klarnamens angezeigt. Dieser darf beliebige UTF-8-Zeichenketten enthalten (die zum Teil URL-encoded werden müssen, um die Syntax zu erhalten) und muss auch nicht zwingend eindeutig sein. |
_profilestate | Derzeit sind für den Wert des Profilzustandes nur die leere Zeichenkette (_profilestate= ) oder der Buchstabe i (_profilestate=i ) erlaubt. Damit wird das Profil aktiv (leer) oder inaktiv (i ) geschaltet (Beispiel: Ereignisprofile). |
Die hier angezeigten Abschnitte entsprechen allen Dialogen der Kamera, die Sie mit dem Befehl control
fernsteuern können. Klicken Sie auf einen der unten aufgeführten Links, um zum entsprechenden Abschnitt zu gelangen.
Hinweis: Der Inhalt dieses Rahmens kann nur angezeigt werden, wenn der öffentliche Zugriff auf das Recht API im Dialog Gruppen-Zugriffskontrolle (ACL) aktiviert wurde bzw. die Gruppe Ihres Benutzernamens über dieses Recht verfügt.
Dieses Interface bietet eingeschränkten Zugriff auf einfache vPTZ-Funktionen. Mit dem Befehl list
können Sie eine Liste der Befehle aufrufen, die dieses Interface zur Verfügung stellt:
http://31.47.87.165/control/click.cgi?list
Der Befehl help
liefert detaillierte Informationen und Beispiele zur Handhabung der einzelnen Befehle:
http://31.47.87.165/control/click.cgi?help
Der Befehl query
gibt Informationen über die aktuellen vPTZ-Einstellungen zurück:
http://31.47.87.165/control/click.cgi?query
Dieses Interface bietet vollständigen Zugriff auf vPTZ-Funktionen. Der Befehl help
liefert detaillierte Informationen zur Handhabung der einzelnen Befehle:
http://31.47.87.165/control/rotorcgi?help
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.
Hinweise:
Hinweis: |
Sie können sich alle Optionen für den Befehl rcontrol anzeigen lassen, indem Sie den Befehl |
---|
cn, de, en, es, fr, it, jp, ru |