מידע

ה-API של /osc/info מחזיר מידע בסיסי על המצלמה ועל הפונקציונליות שבה היא תומכת.

קלט

  • פקודה זו לא מקבלת קלט.

פלט

שם תיאור התיאור
manufacturer מחרוזת יצרן המצלמה.
model מחרוזת דגם המצלמה.
serialNumber מחרוזת מספר סידורי.
firmwareVersion מחרוזת גרסת הקושחה הנוכחית.
supportUrl מחרוזת כתובת ה-URL של דף האינטרנט לתמיכה במצלמה.
gps בוליאני הערך הוא True אם במצלמה יש GPS.
gyro בוליאני הערך הוא True אם במצלמה יש ג'ירוסקופ.
uptime מספר שלם מספר השניות שחלפו מאז אתחול המצלמה.
api מערך מחרוזת רשימה של ממשקי API נתמכים.
endpoints אובייקט אובייקט JSON שמכיל מידע על נקודות הקצה של המצלמה. פרטים נוספים זמינים בטבלה הבאה.
apiLevel מערך שלם כשהשדה הזה חסר, ברירת המחדל שלו היא [1]. הסימנים [1, 2] מייצגים את API 1 ו-2 נתמכים, ואילו [2] מייצג רק את API 2. באחריות המפתח לאחזר את המידע הזה וליישם אותו באופן שונה בהתאם לערך. השדה הזה נוסף ברמת API 2. אם יש תמיכה ב-API 2.1, יש להשתמש גם ב-2.
cameraId מחרוזת מזהה ייחודי שמייצג את המצלמה. השדה הזה נוסף ברמת API 2.1 והוא רלוונטי להעלאה ישירה.
_vendorSpecific סוג פרטים נוספים ספציפיים לספק על המצלמה. כדי למנוע התנגשויות בין מרחבי שמות, יש להוסיף קו תחתון ( _ ) למפתחות ספציפיים לספק.

אובייקט אחד (endpoints)

אובייקט ה-JSON מספק מידע על היציאות שבהן המצלמה משתמשת לנקודות קצה.

הערה: נקודות הקצה מסוג HTTPS הן אופציונליות.

שם תיאור התיאור
httpPort מספר שלם יציאה לשרת HTTP. (ברירת מחדל 80)
httpUpdatesPort מספר שלם יציאה לקבלת עדכונים באמצעות HTTP
httpsPort מספר שלם (אופציונלי) יציאה לשרת HTTPs. (ברירת מחדל 443)
httpsUpdatesPort מספר שלם (אופציונלי) יציאה לקבלת עדכונים באמצעות HTTP.

שגיאה

  • פקודה זו לא מחזירה שגיאות.

דוגמה
שליחת בקשה 
GET /osc/info HTTP/1.1
Host: [camera ip address]:[httpPort]
Accept: application/json
X-XSRF-Protected: 1
תגובה (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]
}
תגובה (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"
        ]
}