Informacje

Interfejs /osc/info API zwraca podstawowe informacje o aparacie i obsługiwanych funkcjach.

Dane wejściowe

  • To polecenie nie wymaga wprowadzania danych.

Wyniki

Nazwa Typ Opis
manufacturer Ciąg znaków producenta aparatu,
model Ciąg znaków Model aparatu.
serialNumber Ciąg znaków Numer seryjny.
firmwareVersion Ciąg znaków Aktualna wersja oprogramowania układowego.
supportUrl Ciąg znaków Adres URL strony pomocy dotyczącej aparatu.
gps Wartość logiczna Prawda, jeśli aparat ma GPS.
gyro Wartość logiczna Prawda, jeśli aparat ma żyroskop.
uptime Liczba całkowita Liczba sekund od uruchomienia aparatu.
api Tablica ciągów Lista obsługiwanych interfejsów API.
endpoints Obiekt Obiekt JSON zawierający informacje o punktach końcowych kamery. Patrz następna tabela.
apiLevel Tablica liczb całkowitych Jeśli tego pola nie ma, wartość domyślna to [1]. [1, 2] oznacza, że zarówno interfejs API 1, jak i 2 są obsługiwane, a [2] oznacza tylko obsługiwany interfejs API 2. Deweloper ma obowiązek pobrać te informacje i zastosować je w różny sposób w zależności od wartości. To pole zostało dodane na poziomie 2 interfejsu API. Użyj też wartości 2, jeśli obsługujesz interfejs API 2.1.
cameraId Ciąg znaków Unikalny identyfikator reprezentujący aparat. To pole zostało dodane w interfejsie API na poziomie 2.1 i ma zastosowanie do przesyłania bezpośredniego.
_vendorSpecific type Dodatkowe informacje o aparacie od dostawcy. Do kluczy poszczególnych dostawców dodaj podkreślenie ( _), aby uniknąć kolizji z przestrzenią nazw.

endpoints obiekt

Ten obiekt JSON zawiera informacje o portach, których kamera używa na potrzeby punktów końcowych.

Uwaga: punkty końcowe HTTPS są opcjonalne.

Nazwa Typ Opis
httpPort Liczba całkowita Port serwera HTTP. (Domyślnie: 80)
httpUpdatesPort Liczba całkowita Port do odbierania aktualizacji przez HTTP
httpsPort Liczba całkowita (Opcjonalnie) Port serwera HTTP. (Domyślnie: 443).
httpsUpdatesPort Liczba całkowita (Opcjonalnie) Port na potrzeby odbierania aktualizacji przez HTTPS.

Błąd

  • To polecenie nie zwraca żadnych błędów.

Przykład
Wyślij prośbę 
GET /osc/info HTTP/1.1
Host: [camera ip address]:[httpPort]
Accept: application/json
X-XSRF-Protected: 1
Odpowiedź (API 2) 
HTTP/1.1 200 OK
Content-Type: application/json;charset=utf-8
Content-Length: {CONTENT_LENGTH}
X-Content-Type-Options: nosniff

{
        "manufacturer": "AAA",
        "model": "BBB",
        "serialNumber": "CCC",
        "firmwareVersion": "DDD",
        "supportUrl": "EEE",
        "endpoints": {
            "httpPort": 80,
            "httpUpdatesPort": 10080,
            ...
        },
        "gps": true,
        "gyro": false,
        "uptime": 600,
        "api": [
            "/osc/info",
            "/osc/state",
            "/osc/checkForUpdates",
            "/osc/commands/execute",
            "/osc/commands/status"
        ],
        "apiLevel": [1, 2]
}
Odpowiedź (API 1) 
HTTP/1.1 200 OK
Content-Type: application/json;charset=utf-8
Content-Length: {CONTENT_LENGTH}
X-Content-Type-Options: nosniff

{
        "manufacturer": "AAA",
        "model": "BBB",
        "serialNumber": "CCC",
        "firmwareVersion": "DDD",
        "supportUrl": "EEE",
        "endpoints": {
            "httpPort": 80,
            "httpUpdatesPort": 10080,
            ...
        },
        "gps": true,
        "gyro": false,
        "uptime": 600,
        "api": [
            "/osc/info",
            "/osc/state",
            "/osc/checkForUpdates",
            "/osc/commands/execute",
            "/osc/commands/status"
        ]
}