Informations

L'API /osc/info renvoie des informations de base sur l'appareil photo et ses fonctionnalités.

Entrée

  • Cette commande ne requiert aucune entrée.

Sortie

Nom Type Description
manufacturer Chaîne Fabricant de l'appareil photo.
model Chaîne Modèle de l'appareil photo.
serialNumber Chaîne Numéro de série.
firmwareVersion Chaîne Version de microprogramme actuelle.
supportUrl Chaîne URL de la page Web consacrée au support de l'appareil photo.
gps Valeur booléenne True si l'appareil photo est équipé d'une fonction GPS.
gyro Valeur booléenne True si l'appareil photo est équipé d'une fonction gyroscope.
uptime Entier Nombre de secondes écoulées depuis le démarrage de l'appareil photo.
api Tableau de chaînes Liste des API prises en charge.
endpoints Objet Objet JSON contenant des informations sur les points d'extrémité de l'appareil photo. Voir le tableau ci-dessous.
apiLevel Tableau de nombres entiers La valeur par défaut est [1] si ce champ est manquant. [1, 2] signifie que les API 1 et 2 sont prises en charge tandis que [2] signifie que seulement l'API 2 est prise en charge. Il relève de la responsabilité du développeur d'extraire cette information et d'adapter l'implémentation selon cette valeur. Ce champ a été ajouté dans l'API niveau 2.
_vendorSpecific [type] (facultatif) Informations supplémentaires spécifiques du fournisseur concernant l'appareil photo. Ajoutez un tiret bas ( _ ) devant les clés spécifiques du fournisseur afin d'éviter les conflits d'espace de noms.

Objet endpoints

Cet objet JSON fournit des informations sur les ports utilisés par l'appareil photo pour les points d'extrémité.

Nom Type Description
httpPort Entier Port pour serveur HTTP. (80 par défaut)
httpUpdatesPort Entier Port de réception des mises à jour via HTTP
httpsPort Entier (facultatif) Port pour serveur HTTPs. (443 par défaut)
httpsUpdatesPort Entier (facultatif) Port de réception des mises à jour via HTTPs.

Erreur

  • Cette commande ne renvoie aucune erreur.

Exemple
Requête 
GET /osc/info HTTP/1.1
Host: [camera ip address]:[httpPort]
Accept: application/json
X-XSRF-Protected: 1
Réponse (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]
}
Réponse (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"
        ]
}