From d04078068a6b0d3e64c58aaeab7e70eae2286af3 Mon Sep 17 00:00:00 2001 From: John Zhao Date: Tue, 10 Jul 2018 17:23:33 +0800 Subject: [PATCH] Update api doc --- doc/build.sh | 2 +- doc/zh-Hans/spec_control_api.md | 28 ++++++++++++++-------------- doc/zh-Hans/spec_control_channel.md | 20 ++++++++++---------- doc/zh-Hans/spec_hardware_info.md | 2 +- doc/zh-Hans/spec_image_data.md | 6 +++--- doc/zh-Hans/spec_image_params.md | 2 +- doc/zh-Hans/spec_imu_data.md | 6 +++--- doc/zh-Hans/specs_ctrl.md | 4 ++-- 8 files changed, 35 insertions(+), 35 deletions(-) diff --git a/doc/build.sh b/doc/build.sh index 78c61e7..c2f368c 100755 --- a/doc/build.sh +++ b/doc/build.sh @@ -56,7 +56,7 @@ for lang in "${LANGS[@]}"; do _echo_in "doxygen make latex" version=`cat $DOXYFILE | grep -m1 "^PROJECT_NUMBER\s*=" | \ sed -E "s/^.*=[[:space:]]*(.*)[[:space:]]*$/\1/g"` - filename="mynteye-apidoc"; \ + filename="mynt-eye-sdk-apidoc"; \ [ -n "$version" ] && filename="$filename-$version"; \ filename="$filename-$lang.pdf" cd "$OUTPUT/$lang/latex" && _texcjk refman.tex && make diff --git a/doc/zh-Hans/spec_control_api.md b/doc/zh-Hans/spec_control_api.md index 7a294a0..6301461 100644 --- a/doc/zh-Hans/spec_control_api.md +++ b/doc/zh-Hans/spec_control_api.md @@ -1,4 +1,4 @@ -# 控制 API 说明 {#spec_contorl_api} +# 控制 API 说明 {#spec_control_api} 控制有两种实现方式，一是通过 UVC 标准协议，二是通过 UVC 拓展通道自定义协议。 @@ -8,21 +8,21 @@ | :----- | :----- | :-------- | :-------- | :-------- | :-------- | :----------- | :----------- | :----- | | 增益 | gain | 2 | 24 | 0 | 48 | √ | 0x12 | 关闭自动曝光，手动设定的参数 | | 亮度 | brightness/exposure_time | 2 | 120 | 0 | 240 | √ | 0x14 | 关闭自动曝光，手动设定的参数 | -| 对比度 | contrast/black_level_calibration | 2 | 127 | 0 | 255 | √ | 0x10 | | +| 对比度 | contrast/black_level_calibration | 2 | 127 | 0 | 255 | √ | 0x10 | 关闭自动曝光，手动设定的参数 | > UVC 标准协议实现的控制，有现成的 API 进行 Get & Set ，包括 Min, Max, Default 。 ## 自定义协议 -| 名称 | 字段 | 字节数 | 默认值 | 最小值 | 最大值 | 是否储存 | Flash 地址 | 所属通道 | 通道地址 | 说明 | -| :----- | :----- | :-------- | :-------- | :-------- | :-------- | :----------- | :----------- | :----------- | :----------- | :----- | -| 图像帧率 | frame_rate | 2 | 25 | 10 | 60 | √ | 0x21 | XU_CAM_CTRL | 0x0100 | 步进为5，即有效值为{10,15,20,25,30,35,40,45,50,55,60} | -| IMU 频率 | imu_frequency | 2 | 200 | 100 | 500 | √ | 0x23 | XU_CAM_CTRL | 0x0100 | 有效值为{100,200,250,333,500} | -| 曝光模式 | exposure_mode | 1 | 0 | 0 | 1 | √ | 0x0F | XU_CAM_CTRL | 0x0100 | 0：开启自动曝光； 1：关闭 | -| 最大增益 | max_gain | 2 | 48 | 0 | 48 | √ | 0x1D | XU_CAM_CTRL | 0x0100 | 开始自动曝光，可设定的阈值 | -| 最大曝光时间 | max_exposure_time | 2 | 240 | 0 | 240 | √ | 0x1B | XU_CAM_CTRL | 0x0100 | 开始自动曝光，可设定的阈值 | -| 期望亮度 | desired_brightness | 2 | 192 | 0 | 255 | √ | 0x19 | XU_CAM_CTRL | 0x0100 | | -| IR 控制 | ir_control | 1 | 0 | 0 | 160 | × | - | XU_CAM_CTRL | 0x0100 | | -| HDR 模式 | hdr_mode | 1 | 0 | 0 | 1 | √ | 0x1F | XU_CAM_CTRL | 0x0100 | 0：10-bit；1：12-bit | -| 零漂标定 | zero_drift_calibration | | - | - | - | × | - | XU_HALF_DUPLEX | 0x0200 | | -| 擦除芯片 | erase_chip | | - | - | - | × | - | XU_HALF_DUPLEX | 0x0200 | | +| 名称 | 字段 | 字节数 | 默认值 | 最小值 | 最大值 | 是否储存 | Flash 地址 | 所属通道 | 说明 | +| :----- | :----- | :-------- | :-------- | :-------- | :-------- | :----------- | :----------- | :----------- | :----- | +| 图像帧率 | frame_rate | 2 | 25 | 10 | 60 | √ | 0x21 | XU_CAM_CTRL | 步进为5，即有效值为{10,15,20,25,30,35,40,45,50,55,60} | +| IMU 频率 | imu_frequency | 2 | 200 | 100 | 500 | √ | 0x23 | XU_CAM_CTRL | 有效值为{100,200,250,333,500} | +| 曝光模式 | exposure_mode | 1 | 0 | 0 | 1 | √ | 0x0F | XU_CAM_CTRL | 0：开启自动曝光； 1：关闭 | +| 最大增益 | max_gain | 2 | 48 | 0 | 48 | √ | 0x1D | XU_CAM_CTRL | 开始自动曝光，可设定的阈值 | +| 最大曝光时间 | max_exposure_time | 2 | 240 | 0 | 240 | √ | 0x1B | XU_CAM_CTRL | 开始自动曝光，可设定的阈值 | +| 期望亮度 | desired_brightness | 2 | 192 | 0 | 255 | √ | 0x19 | XU_CAM_CTRL | 开始自动曝光，可设定的阈值 | +| IR 控制 | ir_control | 1 | 0 | 0 | 160 | × | - | XU_CAM_CTRL | | +| HDR 模式 | hdr_mode | 1 | 0 | 0 | 1 | √ | 0x1F | XU_CAM_CTRL | 0：10-bit；1：12-bit | +| 零漂标定 | zero_drift_calibration | | - | - | - | × | - | XU_HALF_DUPLEX | | +| 擦除芯片 | erase_chip | | - | - | - | × | - | XU_HALF_DUPLEX | | diff --git a/doc/zh-Hans/spec_control_channel.md b/doc/zh-Hans/spec_control_channel.md index 9208182..64442d7 100644 --- a/doc/zh-Hans/spec_control_channel.md +++ b/doc/zh-Hans/spec_control_channel.md @@ -1,4 +1,4 @@ -# 拓展通道说明 {#spec_contorl_channel} +# 拓展通道说明 {#spec_control_channel} | 名称 | 字段 | 地址 | 带宽 | 说明 | | :----- | :----- | :----- | :----- | :----- | @@ -14,7 +14,7 @@ ## 半双工通道 -半双工通道是那些仅需 Get 或 Set 的控制通道，如请求零漂矫正。 +半双工通道是那些仅需 Set 的控制通道，如请求零漂矫正。 ## IMU 通道 @@ -25,18 +25,18 @@ 用来读写硬件信息、图像参数、 IMU 参数的通道。 | Name | Header | Size | File | Checksum | -| :--- | :- | :--- | :--- | :-------- | +| :--- | :----- | :--- | :--- | :-------- | | 字节数 | 1 | 2 | - | 1 | | 类型 | uint8_t | uint16_t | - | uint8_t | | 描述 | 标识 | 文件内容大小 | 文件内容 | 校验码（文件内容所有字节异或） | -| Header bit | Description | -| :--------- | :---------- | -| 0 | 0: Get; 1: Set | -| 1~4 | 未定义 | -| 5 | IMU 参数 | -| 6 | 图像参数 | -| 7 | 硬件信息 | +| Header Bit Subscript | Description | +| :------------------- | :---------- | +| 0 | 硬件信息 | +| 1 | 图像参数 | +| 2 | IMU 参数 | +| 3~6 | 未定义 | +| 7 | 0: Get; 1: Set | ### 文件内容包 diff --git a/doc/zh-Hans/spec_hardware_info.md b/doc/zh-Hans/spec_hardware_info.md index e0f5ea6..e05f1aa 100644 --- a/doc/zh-Hans/spec_hardware_info.md +++ b/doc/zh-Hans/spec_hardware_info.md @@ -5,7 +5,7 @@ | VID | vid | 0x04B4 | √ | × | 2 | | | PID | pid | 0x00F9 | √ | × | 2 | | | 设备名称 | name | MYNT-EYE-? | √ | √ Get | 16 | MYNT-EYE-S1000 | -| 序列号 | serial_number | - | √ | √ Get | 16 | | +| 序列号 | serial_number | - | √ | √ Get | 16 | | | 固件版本 | firmware_version | - | √ | √ Get | 2 | major,minor | | 硬件版本 | hardware_version | - | × | √ Get | 3 | major,minor,flag | | 协议版本 | spec_version | - | × | √ Get | 2 | major,minor | diff --git a/doc/zh-Hans/spec_image_data.md b/doc/zh-Hans/spec_image_data.md index 77efb87..8631da5 100644 --- a/doc/zh-Hans/spec_image_data.md +++ b/doc/zh-Hans/spec_image_data.md @@ -10,13 +10,13 @@ ## 图像数据包 -| Name | Header | Size | FrameID | Timestamp | ExposureTime | Checksum | -| :--- | :----- | :--- | :------ | :-------- | :----------- | :------- | +| Name | Header | Size | Frame ID | Timestamp | Exposure Time | Checksum | +| :--- | :----- | :--- | :------- | :-------- | :------------ | :------- | | 字节数 | 1 | 1 | 2 | 4 | 2 | 1 | | 类型 | uint8_t | uint8_t | uint16_t | uint32_t | uint16_t | uint8_t | | 描述 | 0x3B | 0x08 （数据内容大小） | 帧 ID | 时间戳 | 曝光时间 | 校验码（数据内容所有字节异或） | * 数据包校验不过，会丢弃该帧。 -* 时间的单位精度为： 0.01 ms / 10 us 。 +* 时间单位的精度为： 0.01 ms / 10 us 。 * 4 字节能表示的最大时间约是 11.9 小时，溢出后将重累计。 * 时间累计是从上电时从开始，而不是从打开时开始。 diff --git a/doc/zh-Hans/spec_image_params.md b/doc/zh-Hans/spec_image_params.md index 7f60fa7..dad04f8 100644 --- a/doc/zh-Hans/spec_image_params.md +++ b/doc/zh-Hans/spec_image_params.md @@ -13,7 +13,7 @@ | 畸变模型 | model | - | 1 | uint8_t; pinhole,... | | 畸变参数 | coeffs[5] | - | 40 | double; k1,k2,p1,p2,k3 | -> 图像内参不同分辨率会不同。如果多分辨率的话，就会有多个。 +> 图像分辨率不同，内参不同。多分辨率的话，需有多个内参。 ## 图像外参 diff --git a/doc/zh-Hans/spec_imu_data.md b/doc/zh-Hans/spec_imu_data.md index d6fbda1..e9072e9 100644 --- a/doc/zh-Hans/spec_imu_data.md +++ b/doc/zh-Hans/spec_imu_data.md @@ -30,11 +30,11 @@ IMU 包/小包，是一组 IMU 数据。 ### IMU 段 -| Name | Offset | FrameID | Accelerometer | Temperature | Gyroscope | -| :--- | :----- | :------ | :------------ | :---------- | :-------- | +| Name | Offset | Frame ID | Accelerometer | Temperature | Gyroscope | +| :--- | :----- | :------- | :------------ | :---------- | :-------- | | 字节数 | 2 | 2 | 6 | 2 | 6 | | 类型 | int16_t | uint16_t | int16_t * 3 | int16_t | int16_t * 3 | -| Description | 相对基准时间戳的偏移量 | 图像帧 ID | 加速度计 x y z 三轴的值 | IMU 的温度 | 陀螺仪 x y z 三轴的值 | +| 描述 | 相对基准时间戳的偏移量 | 图像帧 ID | 加速度计 x y z 三轴的值 | IMU 的温度 | 陀螺仪 x y z 三轴的值 | * 加速度计和陀螺仪的计量值换算成物理值公式： **real = data * range / 0x10000** 。 * 加速度计量程默认值为 **8 g** ，陀螺仪量程默认值为 **1000 deg/s** 。 diff --git a/doc/zh-Hans/specs_ctrl.md b/doc/zh-Hans/specs_ctrl.md index 9c49c9a..8232e93 100644 --- a/doc/zh-Hans/specs_ctrl.md +++ b/doc/zh-Hans/specs_ctrl.md @@ -1,4 +1,4 @@ # 设备控制说明 {#specs_ctrl} -* @subpage spec_contorl_api -* @subpage spec_contorl_channel +* @subpage spec_control_api +* @subpage spec_control_channel