اطلاعات

API /osc/info اطلاعات اولیه در مورد دوربین و عملکردی که پشتیبانی می کند را برمی گرداند.

ورودی

  • این دستور هیچ ورودی نمی گیرد.

خروجی

نام تایپ کنید توضیحات
manufacturer رشته سازنده دوربین
model رشته مدل دوربین.
serialNumber رشته شماره سریال.
firmwareVersion رشته نسخه سیستم عامل فعلی
supportUrl رشته URL برای صفحه وب پشتیبانی دوربین.
gps بولی اگر دوربین GPS داشته باشد درست است.
gyro بولی اگر دوربین دارای ژیروسکوپ باشد درست است.
uptime عدد صحیح تعداد ثانیه از زمان بوت شدن دوربین.
api آرایه رشته ای لیست API های پشتیبانی شده
endpoints شیء یک شی JSON حاوی اطلاعاتی در مورد نقاط انتهایی دوربین. جدول بعدی را ببینید.
apiLevel آرایه عدد صحیح زمانی که این فیلد وجود نداشته باشد به طور پیش فرض [1] است. [1، 2] نشان دهنده هر دو API 1 و 2 است در حالی که [2] نشان دهنده تنها API 2 پشتیبانی می شود. این مسئولیت توسعه‌دهنده است که این اطلاعات را بازیابی کند و براساس مقدار آن را به روشی متفاوت پیاده‌سازی کند. این فیلد در سطح 2 API اضافه شده است. اگر از API 2.1 پشتیبانی می کنید، لطفاً از 2 نیز استفاده کنید.
cameraId رشته یک شناسه منحصر به فرد که نشان دهنده دوربین است. این فیلد در سطح API 2.1 اضافه شده است و مربوط به آپلود مستقیم است.
_vendorSpecific نوع اطلاعات اضافی خاص فروشنده درباره دوربین. لطفاً برای جلوگیری از برخورد فضای نام، کلیدهای خاص فروشنده را با یک زیرخط ( _ ) قرار دهید.

شیء endpoints

این شی JSON اطلاعاتی را در مورد پورت هایی که دوربین برای نقاط پایانی استفاده می کند ارائه می دهد.

توجه: نقاط پایانی HTTPS اختیاری هستند.

نام تایپ کنید توضیحات
httpPort عدد صحیح پورت برای سرور HTTP. (پیش فرض 80)
httpUpdatesPort عدد صحیح پورت برای دریافت به روز رسانی از طریق HTTP
httpsPort عدد صحیح (اختیاری) پورت برای سرور HTTP. (پیش فرض 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"
        ]
}