Skip to content
BranchesTags

Latest commit

 

History

11 Commits

Folders and files

NameName
Last commit message
Last commit date
README.md
README.md
 
 
README_zh.md
README_zh.md
 
 
get_all_options.py
get_all_options.py
 
 
osc.html
osc.html
 
 
osc_cmd.js
osc_cmd.js
 
 
osc_cmd.py
osc_cmd.py
 
 

Repository files navigation

Insta360 OSC Get-Started

中文文档

Overview

Insta360 OSC is implemented based on Google OSC Note When your client connected to the AP of Insta360 ONE X/ONE R ，the ip address of the camera is：192.168.42.1 Strongly recomended ： Never send osc/commands request before you get the response of the previous one

  • HTTP Header required
Content-Type: application/json;charset=utf-8
Accept: application/json
Content-Length: {CONTENT_LENGTH}
X-XSRF-Protected: 1

Get Camera Info

  • Send a GET request to /osc/info to get basic info of the camera，the frequency of the request is recommend to no more than 1 request per second.
{
	"manufacturer": "Arashi Vision",
	"model": "Insta360 One2",
	"serialNumber": "IXE3619AYS76P6",
	"firmwareVersion": "v1.18.43",
	"supportUrl": "https://www.insta360.com/product/insta360-one2/",
	"endpoints": {
		"httpPort": 80,
		"httpUpdatesPort": 80
	},
	"gps": false,
	"gyro": true,
	"uptime": 48,
	"api": [
		"/osc/info",
		"/osc/state",
		"/osc/checkForUpdates",
		"/osc/commands/execute",
		"/osc/commands/status"
	],
	"apiLevel": [
		2
	],
	"_sensorModuleType": "4K",
	"_vendorVersion": "v1.1_build1"
}

_sensorModuleType : Indicates the current lens module type of the camera, only supported on ONE R. Available values are 4K, 4K_Selfie,Dual_Fisheye,Leica,Leica_Selfie. The Selfie suffix indicates the lens is facing the same direction with touch screen.

  • Send a POST request to /osc/state to get state of the camera device.

    /osc/state response example:

{
	"fingerprint": "FPR_52923",
	"state": {
		"_cardState": "pass",
		"batteryLevel": 1,
		"storageUri": "http://192.168.42.1:80/DCIM/Camera01/"
	}
}

  • state._cardState：card state of the camera device. Available values:

    • noCard: no card detected
    • pass: A card detected with supported format
    • noSpace: A card detected, but no space left
    • invalidFormat:: A card detected, but the format is not supported
    • writeProtect: A card detected, with WriteProtected on
    • otherError: Other unknown error

  • state.batteryLevel: batery level of the camera device, values in [0,1]

  • state.storageUri: the storage path where photos are saved.

Remmber to send request to /osc/info 、/osc/state before starting take picture

  • Use camera.getOptions command to get options and features of the camera device. photoStitchingSupport and photoStitching are newly added options to tell if the camera device support ondevice-stitching. camera.getOptions request example：
{
  "name":"camera.getOptions",
  "parameters": {
      "optionNames": [
          "iso",
          "isoSupport",
          "hdrSupport",
          "hdr",
          "totalSpace",
          "remainingSpace"
      ]
  }
}

camera.getOptions response example

{
  "results": {
      "options": {
           "iso": 200,
           "isoSupport": [100, 200, 400, 800, 1600],
           "hdrSupport":[hdr, off],
           "hdr":"off",
           "totalSpace":"31906594816",
           "remainingSpace":"10597040128"
      }
  }
}

camera.getOptions response example (with error):

{
	"name": "camera.getOptions",
	"state": "error",
	"error": {
		"code": "invalidParameterName ",
		"message": "parameter is not supported."
	}
}

After successfully connected to the camera，execute camera.getOptions to know if the camera firmware support on-device stitching.

{
  "name":"camera.getOptions",
  "parameters": {
      "optionNames": [
          "photoStitchingSupport",
          "photoStitching"
      ]
  }
}

If the on-device stitching is supported, the response will be like below.. Otherwise, the response may contain error or photoStitchingSupport only has value none.

{
  "results": {
      "options": {
           "photoStitchingSupport":["none","ondevice"],
           "photoStitching":"none"
      }
  }
}

iso: value of current iso isoSupport: list of supported iso values hdrSpport: list of supported hdr values hdr: current hdr value totalSpace: total SDcard space in byte remainingSpace: remaining space in byte photoStitchingSupport: list of supported photoStitching modes photoStitching: current photoStitching mode SetOptions/GetOptions allows you to query/set options as need, just put required options in the optionsName array

TakePicture

setOptions

  • use camera.setOptions command to set params

  • set HDR mode (Three original images will be returned upon takePicture successfully executed)

{
	"name": "camera.setOptions",
	"parameters": {
		"options": {
			"captureMode":"image",
			"hdr": "hdr",
			"photoStitching": "none" //add this option only when on-device stitching is supported
		}
	}
}
  • set HDR mode with ondevice-stitching ：(One stitched image with HDR effect will be returned upon takePicture successully executed)
{
	"name": "camera.setOptions",
	"parameters": {
		"options": {
			"captureMode":"image",
			"hdr": "hdr",
			"photoStitching": "ondevice" //add this option only when on-device stitching is supported
		}
	}
}

response on success：

{
    “name”:"camera.setOptions",
    "state":"done"
}

response on error:

{
    "error": {
        "code": "invalidParameterName",
        "message": "Parameter options contains unsupported option captureInterval."
    }
}

takePicture

  • use camera.takePicture command to start taking picture
{
    "name":"camera.takePicture"
}

response on success：

{
    "name":"camera.takePicture",
    "state":"inProgress",
    "id":"001996",
    "progress":
    {
        "completion":0
    }
}

response on error --camera not activated，Please remind user to download Insta360 official App to activate their camera when get this error:

{
	"name": "camera.takePicture",
	"state": "error",
	"error": {
		"code": "unactivated",
		"message": "Please activate your camera in insta360 official app."
	}
}

response on error-state error，This error often happens when camera is in standby mode or video mode, call setOptions (as described above) and try again：

{
	"name": "camera.takePicture",
	"state": "error",
	"error": {
		"code": "disabledCommand",
		"message": "Currently camera is not working in image mode"
	}
}

check capture status

  • use /osc/cammands/status to check capture statu
{
    "id": "001996"
}

id idendifies the capture task response example:

{
    "name":"camera.takePicture",
    "state":"inProgress",
    "id":"001996",
    "progress":
    {
        "completion":0.5
    }
}

completion 0.5 means the capture progress is 50% now

Get file url and download

  • check /osc/cammands/status repeatedly (recommend once per second ) until state is done in the response make a http request to download the file via fileUrl in the results
{
	"name": "camera.takePicture",
	"state": "done",
	"results": {
		"_fileGroup": ["http://192.168.42.1:80/DCIM/Camera01/IMG_20180101_051113_00_042.jpg"],
		"_localFileGroup": ["/DCIM/Camera01/IMG_20180101_051113_00_042.jpg"],
		"fileUrl": "http://192.168.42.1:80/DCIM/Camera01/IMG_20180101_051113_00_042.jpg"
	}
}

Delete the photo (optional)

  • use camera.delete to delete the file
{
    "name":"camera.delete",
    "parameters": {
        "fileUrls": [
            "url1",
            "url2",
            "url3",
            ...
            "urln"
        ]
    }
}

response on success：

{
	"name": "camera.delete",
	"results": {
		"fileUrls": []
	},
	"state": "done"
}

response on error:

{
    "error": {
        "code": "invalidParameterValue",
        "message": "Parameter url3 doesn't exist."
    }
}

Get File Lists

  • use camera.listFiles to list files on the device
{
	"name": "camera.listFiles",
	"parameters": {
		"fileType": "image",
		"entryCount": 1,
		"maxThumbSize": 100
	}
}

{
	"name": "camera.listFiles",
	"state": "done",
	"results": {
		"entries": [{
			"name": "IMG_20180106_180200_00_006.jpg",
			"fileUrl": "http://192.168.42.1:80/DCIM/Camera01/IMG_20180106_180200_00_006.jpg",
			"_localFileUrl": "/DCIM/Camera01/IMG_20180106_180200_00_006.jpg",
			"size": 4494224,
			"width": 6080,
			"height": 3040,
			"dateTimeZone": "2018:01:06 18:02:14+08:00",
			"_thumbnailSize": 37312,
			"isProcessed": true,
			"previewUrl": "",
			"thumbnail": "/9j/2wCEAAI...2Q==\n"//...表示省略
		}],
		"totalEntries": 3
	}
}

Recording

setOptions

  • set captureMode to video before start recording
{
	"name": "camera.setOptions",
	"parameters": {
		"options": {
			"captureMode":"video"
		}
	}
}

response on success：

{
	"name": "camera.setOptions",
	"state": "done"
}

startCapture

  • use camera.startCapture to start recording
{
    "name":"camera.stopCapture"
}

stopCapture

  • use camera.stopCapture to stop recording
{
    "name":"camera.stopCapture"
}

Make a http request to download the video files via fileUrls：

{
	"name": "camera.stopCapture",
	"state": "done",
	"results": {
		"fileUrls": [
			"http://192.168.42.1:80/DCIM/Camera01/VID_20180106_172302_10_005.mp4",
			"http://192.168.42.1:80/DCIM/Camera01/VID_20180106_172302_00_005.mp4"
		],
		"_localFileUrls": [
			"/DCIM/Camera01/VID_20180106_172302_10_005.mp4",
			"/DCIM/Camera01/VID_20180106_172302_00_005.mp4"
		]
	}
}

About

Python HTML/JS interface utilities for https://github.com/Insta360Develop/Insta360_OSC [BETA]

Resources

Readme
Activity

Stars

14 stars

Watchers

1 watching

Forks

3 forks
Report repository

Releases

Packages

Contributors

Languages