Informacje

Interfejs /osc/info API zwraca podstawowe informacje o aparacie i jego funkcjach. który obsługuje.

Dane wejściowe

  • To polecenie nie wymaga wprowadzania danych.

Wyniki

Nazwa Typ Opis
manufacturer Ciąg znaków Producent aparatu.
model Ciąg znaków Model aparatu.
serialNumber Ciąg znaków Numer seryjny.
firmwareVersion Ciąg znaków Aktualna wersja oprogramowania.
supportUrl Ciąg znaków Adres URL strony pomocy dotyczącej kamery.
gps Wartość logiczna Prawda, jeśli aparat ma GPS.
gyro Wartość logiczna Prawda, jeśli kamera jest wyposażona w żyroskop.
uptime Liczba całkowita Liczba sekund od uruchomienia kamery.
api Tablica z ciągami znaków Lista obsługiwanych interfejsów API.
endpoints Obiekt Obiekt JSON zawierający informacje o punktach końcowych kamery. Zobacz następną tabelę.
apiLevel Tablica liczb całkowitych Gdy brakuje tego pola, domyślnie przyjmuje się wartość [1]. [1, 2] oznacza obsługiwane interfejsy API 1 i 2, a [2] oznacza, że obsługiwany jest tylko interfejs API 2. Za pobranie tych informacji i wdrożenie ich w różny sposób na podstawie wartości odpowiada deweloper. To pole zostało dodane na poziomie interfejsu API 2. Użyj wartości 2, jeśli obsługujesz interfejs API 2.1.
cameraId Ciąg znaków Unikalny identyfikator kamery. To pole zostało dodane w interfejsie API poziomu 2.1 i jest związane z przesyłaniem bezpośrednim.
_vendorSpecific type Dodatkowe informacje o kamerze u dostawcy. Aby uniknąć konfliktów przestrzeni nazw, poprzedź klucze specyficzne dla dostawcy znakiem podkreślenia ( _ ).

endpoints obiekt

Ten obiekt JSON dostarcza informacje o portach używanych przez kamerę 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 dla serwera HTTPs. (Domyślnie 443)
httpsUpdatesPort Liczba całkowita (Opcjonalnie) Port do 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"
        ]
}