Erste Schritte mit der HTTP-API

Camera Software Administration
, , ,
1

Einführung

Eine Anwendungsprogrammierschnittstelle (API) ist eine Gruppe von Programmieranweisungen und Standards zum Zugreifen auf eine Softwareanwendung oder ein Webwerkzeug. Eine API ist eine Software-zu-Software-Schnittstelle, keine Benutzerschnittstelle. Mit APIs kommunizieren Anwendungen ohne Benutzerkenntnisse oder Interventionen.

MOBOTIX HTTP API

Die HTTP-API (Application Programming Interface) ist eine Software-Schnittstelle zur Kamera und ermöglicht die einfache Integration der Kamera in ein zentrales Managementsystem. Die Schnittstelle besteht aus mehreren CGI-Skripten, die über HTTP-Befehle mit Parametern und Werten aufgerufen werden können. Mit diesen Skripten können Sie die Einstellungen der Dialoge im Setup-Menü ändern und bestimmte Kamerafunktionen ausführen.

Häufigste Verwendung

  • Änderung der Konfiguration: Aufzeichnungen, Ereignisse, Aktionen usw.
  • Änderung der Bildeinstellungen: Belichtung, Bildqualität, Bildauflösung usw.
  • Statusanforderungen
  • Auslösen von Aktionen

API-HTTP-Anfragebeschreibung

Eine normale HTTP-Anfrage vom Browser sieht folgendermaßen aus:

http://<ip_address_for_the_camera>/control/control?list&section=recording

Welche wiefolgt aufgeteilt werden können:

  • Protokoll: http: //
  • Ziel: <ip_adress_for_the_camera>
  • CGI-Aufruf: /control /control
  • Parameter: list&section=recording

Somit hat eine wohlgeformte Anfrage hat die Form:

Protokoll + Ziel + CGI-Aufruf + Parameter

Die vorherige Anfrage wird die folgende HTTP-Antwort liefern:

imagen
imagen3358×1884 834 KB

Hier werden die aktuellen Konfigurationsoptionen für Aufzeichnungen angezeigt.

CGI-Anrufe

/control/control

Mit dem HTTP-Befehl

http://&lt;ip_address_for_the_camera&gt;/control/control

können Sie die Einstellungen des Setup-Menüs ändern.
Geben Sie

http://&lt;ip_address_for_the_camera&gt;/control/control?list

ein, um die verschiedenen verfügbaren Abschnitte anzuzeigen.

imagen
imagen1202×972 166 KB

/admin/control

Mit dem HTTP-Befehl

http://<ip_address_for_the_camera>/admin/control

können Sie die Einstellungen des Admin Menüs ändern.
Geben Sie

http://&lt;ip_address_for_the_camera&gt;/admin/control?list

ein, um die verschiedenen verfügbaren Abschnitte anzuzeigen.

imagen
imagen1154×538 105 KB

/control/rcontrol und /admin/rcontrol

Mit dem HTTP-Befehl

http://&lt;ip_address_for_the_camera&gt;/control/rcontrol?list

Können Sie sich bestimmte Aktionen anzeigen lassen, die ausgeführt werden können

http://&lt;ip_address_for_the_camera&gt;/control/rcontrol?action=sound&amp;soundfile=Alarm

Durch Aufruf dieser HTTP-Anfrage spielt die Kamera eine Audiodatei ab.

Einige dieser Funktionen können nur als Admin-Benutzer aufgerufen werden

imagen
imagen1368×92 26.9 KB

In diesem Fall wäre die HTTP-Anfrage:

http://&lt;ip_address_for_the_camera&gt;/admin/rcontrol?action=reboot

vPTZ Einstellungen

Als Konsequenz der Integration der Q-Kameramodelle bieten die Kameras vPTZ-Funktionen (virtuelles Schwenken / Neigen / Zoomen) auch in der HTTP-API. Die entsprechenden Features wurden in speziellen Hilfe-Dialogen dokumentiert, die über die entsprechenden Links geöffnet werden können:

click.cgi

Diese Schnittstelle bietet eingeschränkten Zugriff auf einfache vPTZ-Funktionen.
http://&lt;ip_address_for_the_camera&gt;/control/click.cgi?help

rotor.cgi

Diese Schnittstelle bietet vollen Zugriff auf alle vPTZ-Funktionen
http://&lt;ip_address_for_the_camera&gt;/control/rotorcgi?help

control?list&section=vptzcontrol

Die Steuerung bietet auch Zugriff auf einige vPTZ-Funktionen, wie im vptzcontrol-Abschnitt beschrieben.
http://&lt;ip_address_for_the_camera&gt;/control/control?list&amp;section=vptzcontrol

Bild CGI-Anrufe

Zusätzlich gibt es eine Reihe von CGI-Aufrufen, um Live-Bilder, Videostreams und Aufnahmen der Kamera direkt vom integrierten Webserver abzurufen.

/record/current.jpg

http://&lt;ip_address_for_the_camera&gt;/record/current.jpg

  • Ruft ein Kamerabild gemäß den aktuellen Bildeinstellungen ab
  • Sie können keine zusätzlichen Parameter angeben

/cgi-bin/image.jpg

http://&lt;ip_address_for_the_camera&gt;/cgi-bin/image.jpg

  • Ruft ein Kamerabild unter Verwendung zusätzlicher Bildparameter ab.
  • Die gespeicherte Konfiguration wird nicht geändert und hat keine
    Auswirkungen auf das Livebild.

http://&lt;ip_address_for_the_camera&gt;/cgi-bin/image.jpg?camera=right&amp;size=320x240&amp;quality=60

  • camera=right ist das richtige Objektiv auf Dual-Kameras
  • size=320x240 ist die Auflösung des Bildes
  • quality=60 ist der Qualitätsprozentsatz

Durch das Anhängen von ?help am Ende des Befehls wird die entsprechende Hilfeseite mit allen verfügbaren Optionen angezeigt:

http://&lt;ip_address_for_the_camera&gt;/cgi-bin/image.jpg?help

/cgi-bin/faststream.jpg or /control/faststream.jpg

Ruft den Live-Stream mit zusätzlichen Bildparametern von der Kamera ab.

  • /cgi-bin/faststream.jpg mit Gastzugang
  • /control/faststream.jpg mit Benutzerzugriff

/control/event.jpg

Bietet Zugriff auf die Ereignisse der Kamera und ermöglicht das Hinzufügen zusätzlicher Parameter.

http://&lt;ip_address_for_the_camera&gt;/cgi-bin/event.jpg

Die folgende Anfrage liefert beispielsweise das letzte Ereignisbild der Kamera:

http://&lt;ip_address_for_the_camera&gt;/control/event.jpg?sequence=head

Durch das Anhängen von ?help am Ende des Befehls wird die entsprechende Hilfeseite mit allen verfügbaren Optionen angezeigt:

http://&lt;ip_address_for_the_camera&gt;/control/event.jpg?help

Zusätzliche Hilfe

Die Hilfeseiten auf der Kamera bieten einen Überblick über die API-Befehle und zusätzliche Beispiele. Die Hilfeseiten können über das ? Symbol in der oberen rechten Ecke des Kamera-Web-Interface oder über die URL:

http://<ip_address_for_the_camera>/help/help

aufgerufen werden.

Am unteren Rand der MOBOTIX-Online-Hilfe befindet sich der Bereich Fernsteuerung

imagen
imagen816×202 36.7 KB