接口列表

CameraConfig

GET/api/CameraConfig

  • 说明

    获取相机的拍照参数。

  • 返回结果示例

    {
  "ExpTime2D": 200,
  "Gain2D": 1,
  "ProjectorBrightness": 2,
  "FlashLightOn": true,
  "ParamsBatch3D": [
    {
      "ExpTime3D": 20,
      "Gain3D": 1
    }
  ],
  "PatternMode": 4,
  "SmoothLevel": 0
}

  • 返回结果

    状态码

    状态码含义

    数据类型

    说明

    200

    OK

    Inline

    Success

  • 返回数据结构

    状态码 200

    名称

    类型

    必选

    中文名

    ExpTime2D

    integer

    true

    2D曝光时间

    Gain2D

    integer

    true

    2D增益

    ProjectorBrightness

    integer

    true

    投影亮度

    FlashLightOn

    boolean

    true

    打开补光灯

    ParamsBatch3D

    [object]

    true

    3D参数组

    ExpTime3D

    integer

    true

    3D曝光时间

    Gain3D

    integer

    true

    3D增益

    PatternMode

    integer

    true

    投影模式

    SmoothLevel

    integer

    true

    平滑等级

PUT/api/CameraConfig

  • 说明

    设置相机拍照参数。

  • 请求参数

    {
  "ExpTime2D": 200,
  "Gain2D": 1,
  "ProjectorBrightness": 2,
  "FlashLightOn": true,
  "ParamsBatch3D": [
    {
      "ExpTime3D": 20,
      "Gain3D": 1
    }
  ],
  "PatternMode": 4,
  "SmoothLevel": 0
}

  • 返回结果示例

    {
  "ExpTime2D": 200,
  "Gain2D": 1,
  "ProjectorBrightness": 2,
  "FlashLightOn": true,
  "ParamsBatch3D": [
    {
      "ExpTime3D": 20,
      "Gain3D": 1
    }
  ],
  "PatternMode": 4,
  "SmoothLevel": 0
}

  • 返回结果

    状态码

    状态码含义

    数据类型

    说明

    200

    OK

    Inline

    Success

  • 返回数据说明

    状态码 200

    名称

    类型

    必选

    说明

    ExpTime2D

    integer

    true

    2D曝光时间

    Gain2D

    integer

    true

    2D增益

    ProjectorBrightness

    integer

    true

    投影亮度

    FlashLightOn

    boolean

    true

    打开补光灯

    ParamsBatch3D

    [object]

    true

    3D参数组

    ExpTime3D

    integer

    true

    3D曝光时间

    Gain3D

    integer

    true

    3D增益

    PatternMode

    integer

    true

    投影模式

    SmoothLevel

    integer

    true

    平滑等级

CameraParameters

GET/api/CameraParameters/Intrinsic/CameraMatrix

  • 说明

    获取相机内参。

  • 返回结果示例

    [
  1815.1392644283005,
  0,
  960.890136038176,
  0,
  1815.1392644283005,
  754.4678034865751,
  0,
  0,
  1
]

  • 返回结果

    状态码

    状态码含义

    数据类型

    说明

    200

    OK

    Inline

    Success

GET/api/CameraParameters/Intrinsic/Distortion

  • 说明

    获取相机的畸变参数。

  • 返回结果示例

    [
  0,
  0,
  0,
  0,
  0
]

  • 返回结果

    状态码

    状态码含义

    数据类型

    说明

    200

    OK

    Inline

    Success

  • 返回数据说明

    分别对应k1, k2, p1, p2, k3。

Depth

GET/api/Depth

  • 说明

    通过frameId获取对应帧的深度数据。

  • 请求参数

    名称

    位置

    类型

    说明

    frameId

    query

    string

    触发拍照获取到的frameId(frameId可通过api/Frame接口获得)

  • 返回结果

    状态码

    状态码含义

    数据类型

    说明

    200

    OK

    Inline

    Success

  • 返回数据结构

    EpicRaw格式文件。

EpicEye

GET/api/EpicEye/Info

  • 说明

    获取相机Info信息。

  • 返回示例

    {
  "version": "3.4.0",
  "sn": "SNxxxxxxxxxx",
  "ip": "127.0.0.1:5000",
  "model": "EpicEye Laser L",
  "alias": "A工厂-A线-A相机",
  "width": 2048,
  "height": 1536
}

  • 返回结果

    状态码

    状态码含义

    数据类型

    说明

    200

    OK

    Inline

    Success

  • 返回数据结构

    名称

    类型

    必选

    说明

    version

    string

    true

    EpicEye相机软件版本

    sn

    string

    true

    相机序列号

    ip

    string

    true

    相机IP

    model

    string

    true

    相机型号

    alias

    string

    true

    相机别名

    width

    integer

    true

    分辨率-宽

    height

    integer

    true

    分辨率-高

PUT/api/EpicEye/Info

  • 说明

    修改相机的别名。

  • 请求参数

    名称

    位置

    类型

    说明

    alias

    query

    string

    自定义的相机别名

  • 返回示例

    {
  "version": "3.4.0",
  "sn": "SNxxxxxxxxxx",
  "ip": "127.0.0.1:5000",
  "model": "EpicEye Laser L",
  "alias": "测试相机名字",
  "width": 2048,
  "height": 1536
}

  • 返回结果

    状态码

    状态码含义

    数据类型

    说明

    200

    OK

    Inline

    Success

Frame

POST/api/Frame

  • 说明

    触发相机进行一次拍照。

  • 请求参数

    名称

    位置

    类型

    必选

    说明

    pointCloud

    query

    boolean

    否

    控制当次拍照是否重建点云

  • 返回结果示例

    "385_3a7a49f6-3f50-49d0-981b-0c5cddb7261b"

  • 返回结果

    状态码

    状态码含义

    数据类型

    说明

    200

    OK

    Inline

    Success

GET/api/Frame

  • 说明

    通过frameId获取完整的EpicRaw数据。

  • 请求参数

    名称

    位置

    类型

    说明

    frameId

    query

    string

    触发拍照获取到的frameId

  • 返回结果

    状态码

    状态码含义

    数据类型

    说明

    200

    OK

    Inline

    Success

GET/api/Frame/Header

  • 说明

    通过frameId获取该frame的帧头信息。

  • 请求参数

    名称

    位置

    类型

    说明

    frameId

    query

    string

    触发拍照获取到的frameId

  • 请求示例

    {
  "width": 2048,
  "height": 1536,
  "dataType": 8,
  "cameraMatrixLength": 72,
  "distortionLength": 40,
  "configStrLength": 209,
  "depthDataLength": 12582912,
  "imageDataLength": 18874368
}

  • 返回结果

    状态码

    状态码含义

    数据类型

    说明

    200

    OK

    Inline

    Success

PointCloud

GET/api/PointCloud/PLY

  • 说明

    通过frameId获取.ply格式的点云。

  • 请求参数

    名称

    位置

    类型

    说明

    frameId

    query

    string

    触发拍照获取到的frameId

  • 返回结果

    状态码

    状态码含义

    数据类型

    说明

    200

    OK

    Inline

    Success

状态码说明

状态码

状态码含义

200

成功

400

错误