Back to Some3C

Configuration related

Some3C.com – A Professional Solution for iOS Development and Testing

1.Get a list of connected hardware

Calling

  • Request Parameters

parameter

type

illustrate

Remark

fun

String

/config/usb/get

Request function name

  • httpGet request example

curl --request GET \
  --url 'http://192.168.9.9:9911/api/config/usb/get'

  • httpPost request example

curl --request POST \
  --url http://192.168.9.9:9911/api \
  --header 'content-type: multipart/form-data' \
  --form fun=/config/usb/get

  • httpPost json request example [websocket can also send the same json request]

curl --request POST \
  --url http://192.168.9.9:9911/api \
  --header 'Content-Type: application/json' \
  --data '{
    "fun": "/config/usb/get",
    "data": {
    }
}'

Response 

 {
  "data": {
    "list": [
      {
        "vid": "720D",
        "pid": "1F2D",
        "uid": "1F2D24BD",
        "ver": "4.4",
        "state": 2
      },
      {
        "vid": "720D",
        "pid": "FF2D",
        "uid": "FF2D24BD",
        "ver": "4.4",
        "state": 2
      }
    ],
    "code": 0,
    "id": "",
    "message": "成功"
  },
  "status": 200,
  "message": "成功",
  "msgid": 0,
  "fun": "/config/usb/get"
}

  • Response data field description

Fields

illustrate

Remark

vid

-

pid

-

uid

Hardware ID

-

ver

Hardware version

-

2.Get a list of supported device type libraries

Calling

  • Request Parameters

parameter

type

illustrate

Remark

fun

String

/config/devicemodel/get

Request function name

  • httpGet request example

curl --request GET \
  --url 'http://192.168.9.9:9911/api/config/devicemodel/get'

  • httpPost request example

curl --request POST \
  --url http://192.168.9.9:9911/api \
  --header 'content-type: multipart/form-data' \
  --form fun=/config/devicemodel/get

  • httpPost json request example [websocket can also send the same json request]

curl --request POST \
  --url http://192.168.9.9:9911/api \
  --header 'Content-Type: application/json' \
  --data '{
    "fun": "/config/devicemodel/get",
    "data": {
    }
}'

Response 

 {
  "data": {
    "list": [
      太多了省略
    ],
    "code": 0,
    "id": "",
    "message": "成功"
  },
  "status": 200,
  "message": "成功",
  "msgid": 0,
  "fun": "/config/devicemodel/get"
}

  • Response data data field description list array records the obtained data.

3.Get kernel configuration

Calling

  • Request Parameters

parameter

type

illustrate

Remark

fun

String

/config/imserver/get

Request function name

  • httpGet request example

curl --request GET \
  --url 'http://192.168.9.9:9911/api/config/imserver/get'

  • httpPost request example

curl --request POST \
  --url http://192.168.9.9:9911/api \
  --header 'content-type: multipart/form-data' \
  --form fun=/config/imserver/get

  • httpPost json request example [websocket can also send the same json request]

curl --request POST \
  --url http://192.168.9.9:9911/api \
  --header 'Content-Type: application/json' \
  --data '{
    "fun": "/config/imserver/get",
    "data": {
    }
}'

Response 

 {
  "data": {
    "air_play_name": "iMouseXP-D2B6",
    "lang": "简体中文",
    "mdns_type": 0,
    "connect_failed_retry": 3,
    "air_play_ratio": 0,
    "opencv_num": 1,
    "ocr_num": 1,
    "allow_ip_list": [],
    "air_play_fps": 30,
    "air_play_img_fps": 0,
    "air_play_refresh_rate": 60,
    "air_play_port": 17000,
    "air_play_audio": true,
    "auto_connect": false,
    "auto_updata": false,
    "thread_mode": false,
    "mouse_mode": true,
    "flip_right": true,
    "code": 0,
    "id": "",
    "message": "成功"
  },
  "status": 200,
  "message": "成功",
  "msgid": 0,
  "fun": "/config/imserver/get"
}

  • Response data field description

Fields

illustrate

Remark

air_play_name

Display name on screen

-

mdns_type

Screencast Discovery Rules

0 allows all, 1 specifies the IP, 2 is the IP in the list

connect_failed_retry

Connection failed retry times

0 Infinite retries

air_play_ratio

Screen projection resolution

0Adaptive,720,1080,1400,1920,2650

opencv_num

Number of image search plugin instances

-

ocr_num

Number of OCR text recognition plug-in instances

Only the GPU version is effective

allow_ip_list

Allowed ip list

It only takes effect when the rule is 1.

air_play_fps

Screen projection fps

Maximum 30, minimum 1

air_play_img_fps

Projected image fps

Maximum 30, minimum 1

air_play_refresh_rate

Screen refresh rate

Maximum 60, minimum 1

air_play_port

Screen projection communication port

Default 17000

air_play_audio

Screen projection sound

true to enable, false to disable

auto_connect

Automatically connect to screen projection

-

auto_updata

Automatic Upgrade

-

thread_mode

Use thread mode to batch operate hardware

-

mouse_mode

Use fast and accurate mouse movement

-

flip_right

Horizontal screen flip right mode

-

4.Setting the kernel configuration

Calling

  • Request Parameters

parameter

type

illustrate

Remark

fun

String

/config/imserver/set

Request function name

air_play_name

String

Display name on screen

-

lang

String

Console Language

-

mdns_type

Integer

Screencast Discovery Rules

0 allows all, 1 specifies the IP, 2 is the IP in the list

connect_failed_retry

Integer

Connection failed retry times

0 Infinite retries

air_play_ratio

Integer

Screen projection resolution

0Adaptive,720,1080,1400,1920,2650

opencv_num

Integer

Number of image search plugin instances

-

ocr_num

Integer

Number of OCR text recognition plug-in instances

Only the GPU version is effective

allow_ip_list

String Array

Allowed ip list

It only takes effect when the rule is 1.

air_play_fps

Integer

Screen projection fps

Maximum 30, minimum 1

air_play_img_fps

Integer

Projected image fps

Maximum 30, minimum 1

air_play_refresh_rate

Integer

Screen refresh rate

Maximum 60, minimum 1

air_play_port

Integer

Screen projection communication port

Default 17000

air_play_audio

Boolean

Screen projection sound

true to enable, false to disable

auto_connect

Boolean

Automatically connect to screen projection

-

auto_updata

Boolean

Automatic Upgrade

-

thread_mode

Boolean

Use thread mode to batch operate hardware

-

mouse_mode

Boolean

Use fast and accurate mouse movement

-

flip_right

Boolean

Horizontal screen flip right mode

-

  • httpGet request example

curl --request GET \
  --url 'http://192.168.9.9:9911/api/config/imserver/set?air_play_name=iMouseXP-D2B6&lang=%E7%AE%80%E4%BD%93%E4%B8%AD%E6%96%87&mdns_type=0&connect_failed_retry=2&air_play_ratio=1080&opencv_num=1&ocr_num=1&allow_ip_list=[]&air_play_fps=30&air_play_img_fps=30&air_play_refresh_rate=60&air_play_port=17000&air_play_audio=true&auto_connect=true&auto_updata=true&thread_mode=true&flip_right=true&auto_updata=true&mouse_mode=true'

  • httpPost request example

curl --request POST \
  --url http://192.168.9.9:9911/api \
  --header 'content-type: multipart/form-data' \
  --form fun=/config/imserver/set \
  --form air_play_name=iMouseXP-D2B6 \
  --form lang=%E7%AE%80%E4%BD%93%E4%B8%AD%E6%96%87 \
  --form mdns_type=0 \
  --form connect_failed_retry=1 \
  --form air_play_ratio=0 \
  --form opencv_num=1 \
  --form ocr_num=1 \
  --form air_play_fps=30 \
  --form air_play_img_fps=30 \
  --form air_play_refresh_rate=60 \
  --form air_play_port=17000 \
  --form air_play_audio=true \
  --form auto_connect=true \
  --form auto_updata=true \
  --form mouse_mode=true \
  --form thread_mode=true \
  --form flip_right=true

  • httpPost json request example [websocket can also send the same json request]

curl --request POST \
  --url http://192.168.9.9:9911/api \
  --header 'Content-Type: application/json' \
  --data '{
    "fun": "/config/imserver/set",
    "data": {
        "air_play_name": "iMouseXP-D2B6",
        "lang": "简体中文",
        "mdns_type": 0,
        "connect_failed_retry": 3,
        "air_play_ratio": 0,
        "opencv_num": 1,
        "ocr_num": 1,
        "allow_ip_list": [],
        "air_play_fps": 30,
        "air_play_img_fps": 0,
        "air_play_refresh_rate": 60,
        "air_play_port": 17000,
        "air_play_audio": true,
        "auto_connect": false,
        "auto_updata": false,
        "thread_mode": false,
        "mouse_mode": true,
        "flip_right": true
    }
}'

Response 

 {
  "data": {
    "air_play_name": "iMouseXP-D2B6",
    "lang": "简体中文",
    "mdns_type": 0,
    "connect_failed_retry": 3,
    "air_play_ratio": 0,
    "opencv_num": 1,
    "ocr_num": 1,
    "allow_ip_list": [],
    "air_play_fps": 30,
    "air_play_img_fps": 0,
    "air_play_refresh_rate": 60,
    "air_play_port": 17000,
    "air_play_audio": true,
    "auto_connect": false,
    "auto_updata": false,
    "thread_mode": false,
    "mouse_mode": true,
    "flip_right": true,
    "code": 0,
    "id": "",
    "message": "成功"
  },
  "status": 200,
  "message": "成功",
  "msgid": 0,
  "fun": "/config/imserver/get"
}

  • Response data field description

Fields

illustrate

Remark

air_play_name

Display name on screen

-

lang

Console Language

-

mdns_type

Screencast Discovery Rules

0 allows all, 1 specifies the IP, 2 is the IP in the list

connect_failed_retry

Connection failed retry times

0 Infinite retries

air_play_ratio

Screen projection resolution

0Adaptive,720,1080,1400,1920,2650

opencv_num

Number of image search plugin instances

-

ocr_num

Number of OCR text recognition plug-in instances

Only the GPU version is effective

allow_ip_list

Allowed ip list

It only takes effect when the rule is 1.

air_play_fps

Screen projection fps

Maximum 30, minimum 1

air_play_img_fps

Projected image fps

Maximum 30, minimum 1

air_play_refresh_rate

Screen refresh rate

Maximum 60, minimum 1

air_play_port

Screen projection communication port

Default 17000

air_play_audio

Screen projection sound

true to enable, false to disable

auto_connect

Automatically connect to screen projection

-

auto_updata

Automatic Upgrade

-

thread_mode

Use thread mode to batch operate hardware

-

mouse_mode

Use fast and accurate mouse movement

-

flip_right

Horizontal screen flip right mode

-

5.Re-broadcast screen

Calling

  • Request Parameters

parameter

type

illustrate

Remark

fun

String

/imserver/regmdns

Request function name

  • httpGet request example

curl --request GET \
  --url 'http://192.168.9.9:9911/api/imserver/regmdns'

  • httpPost request example

curl --request POST \
  --url http://192.168.9.9:9911/api \
  --header 'content-type: multipart/form-data' \
  --form fun=/imserver/regmdns

  • httpPost json request example [websocket can also send the same json request]

curl --request POST \
  --url http://192.168.9.9:9911/api \
  --header 'Content-Type: application/json' \
  --data '{
    "fun": "/imserver/regmdns",
    "data": {
        
    }
}'

Response 

   {
  "data": {
    "code": 0,
    "id": "90:81:58:EE:D1:9E",
    "message": "成功"
  },
  "status": 200,
  "message": "成功",
  "msgid": 0,
  "fun": "/imserver/regmdns"
}

  • Response data data field description None

6.Restart the kernel

Calling

  • Request Parameters

parameter

type

illustrate

Remark

fun

String

/imserver/restart

Request function name

  • httpGet request example

curl --request GET \
  --url 'http://192.168.9.9:9911/api/imserver/restart'

  • httpPost request example

curl --request POST \
  --url http://192.168.9.9:9911/api \
  --header 'content-type: multipart/form-data' \
  --form fun=/imserver/restart

  • httpPost json request example [websocket can also send the same json request]

curl --request POST \
  --url http://192.168.9.9:9911/api \
  --header 'Content-Type: application/json' \
  --data '{
    "fun": "/imserver/restart",
    "data": {
        
    }
}'

Response 

   {
  "data": {
    "code": 0,
    "id": "90:81:58:EE:D1:9E",
    "message": "成功"
  },
  "status": 200,
  "message": "成功",
  "msgid": 0,
  "fun": "/imserver/restart"
}

  • Response data data field description None

PreviousEquipment relatedNextUser related

Last updated