Merge branch 'feature/docs' into hotfix/2.3.9

* feature/docs: docs(*): fix requirements docs(*): update doc 更新Datasheet和标定文档新版文档更新 docs(*): update docs # Conflicts: # docs/src/sdk/exe_install_windows.rst
slightech · Jul 3, 2019 · 8b0016f · 8b0016f
2 parents 9293a80 + 01db7a8
commit 8b0016f
Show file tree

Hide file tree

Showing 67 changed files with 685 additions and 145 deletions.
diff --git a/docs/api/api.rst b/docs/api/api.rst
@@ -1,3 +1,5 @@
+.. _api:
+
 API
 ===
 

diff --git a/docs/api/contents.rst b/docs/api/contents.rst
@@ -1,12 +1,10 @@
-.. _api:
-
-API DOC
-=========
+API DOCS
+==============
 
 .. toctree::
 
    api
    device
    enums
    types
-   utils
+   utils
diff --git a/docs/api/device.rst b/docs/api/device.rst
@@ -1,3 +1,5 @@
+.. _device:
+
 Device
 ======
 

diff --git a/docs/api/enums.rst b/docs/api/enums.rst
@@ -1,3 +1,5 @@
+.. _enums:
+
 Enums
 =====
 

diff --git a/docs/api/types.rst b/docs/api/types.rst
@@ -1,3 +1,5 @@
+.. _types:
+
 Types
 =====
 

diff --git a/docs/api/utils.rst b/docs/api/utils.rst
@@ -1,3 +1,5 @@
+.. _utils:
+
 Utils
 =====
 

diff --git a/docs/images/calibration001.png b/docs/images/calibration001.png
diff --git a/docs/images/calibration002.png b/docs/images/calibration002.png
diff --git a/docs/images/calibration003.png b/docs/images/calibration003.png
diff --git a/docs/images/calibration004.png b/docs/images/calibration004.png
diff --git a/docs/images/calibration005.png b/docs/images/calibration005.png
diff --git a/docs/images/calibration006.png b/docs/images/calibration006.png
diff --git a/docs/images/calibration007.png b/docs/images/calibration007.png
diff --git a/docs/images/calibration008.png b/docs/images/calibration008.png
diff --git a/docs/images/tripod.png b/docs/images/tripod.png
diff --git a/docs/index.rst b/docs/index.rst
@@ -7,19 +7,18 @@ MYNT® EYE S SDK
 ===============
 
 .. toctree::
-   :maxdepth: 2
    :titlesonly:
+   :maxdepth: 2
 
    src/mynteye/contents
    src/sdk/contents
    src/firmware/contents
    src/data/contents
-   src/control/contents
-   src/log/contents
-   src/wrapper/contents
    src/analytics/contents
+   src/tools/contents
    src/slam/contents
    api/contents
+   src/support/contents
 
 ..
   Indices and tables

diff --git a/docs/src/analytics/dataset.rst → docs/src/analytics/analytics_dataset.rst b/docs/src/analytics/dataset.rst → docs/src/analytics/analytics_dataset.rst
@@ -1,6 +1,6 @@
-.. _dataset:
+.. _analytics_dataset:
 
-Recording data sets
+Recording Data Sets
 ====================
 
 The SDK provides the tool ``record`` for recording data sets. Tool details can be seen in `tools/README.md <https://github.com/slightech/MYNT-EYE-S-SDK/tree/master/tools>`_ .

diff --git a/docs/src/analytics/analytics_stamp.rst b/docs/src/analytics/analytics_stamp.rst
@@ -1,6 +1,6 @@
 .. _analytics_stamp:
 
-Analyze time stamps
+Analyze Time Stamps
 ====================
 
 SDK provides a script for timestamp analysis ``stamp_analytics.py`` . Tool details are visible in `tools/README.md <https://github.com/slightech/MYNT-EYE-S-SDK/tree/master/tools>`_ .

diff --git a/docs/src/analytics/contents.rst b/docs/src/analytics/contents.rst
@@ -1,10 +1,9 @@
-.. _analytics:
-
-Data Analytics
-===============
+SDK TOOLS
+==================
 
 .. toctree::
+   :maxdepth: 2
 
-   dataset
+   analytics_dataset
    analytics_imu
-   analytics_stamp
+   analytics_stamp
diff --git a/docs/src/data/contents.rst b/docs/src/data/contents.rst
@@ -1,6 +1,4 @@
-.. _data:
-
-MYNT® EYE Data
+SDK SAMPLES
 ==============
 
 .. toctree::
@@ -16,7 +14,4 @@ MYNT® EYE Data
    get_imu
    get_imu_correspondence
    get_from_callbacks
-   get_with_plugin
-   save_params
-   write_img_params
-   write_imu_params
+   get_with_plugin
diff --git a/docs/src/data/get_depth.rst b/docs/src/data/get_depth.rst
@@ -1,6 +1,6 @@
-.. _get_depth:
+.. _data_get_depth:
 
-Get depth image
+Get Depth Image
 ===============
 
 Depth images belongs to the upper layer of synthetic data. You need to start the ``EnableStreamData()`` beforehand, to get it through ``GetStreamData()``. The depth image type is CV_16UC1. In addition, it should be check not be empty before use.

diff --git a/docs/src/data/get_device_info.rst b/docs/src/data/get_device_info.rst
@@ -1,6 +1,6 @@
-.. _get_device_info:
+.. _data_get_device_info:
 
-Get device information
+Get Device Information
 ======================
 
 Use ``GetInfo()`` function to get various current information values.

diff --git a/docs/src/data/get_disparity.rst b/docs/src/data/get_disparity.rst
@@ -1,6 +1,6 @@
-.. _get_disparity:
+.. _data_get_disparity:
 
-Get disparity image
+Get Disparity Image
 ===================
 
 Disparity image belongs to the upper layer of synthetic data. You need to start the ``EnableStreamData()`` beforehand, to get it through ``GetStreamData()``. In addition, it should be check not be empty before use.

diff --git a/docs/src/data/get_from_callbacks.rst b/docs/src/data/get_from_callbacks.rst
@@ -1,6 +1,6 @@
-.. _get_from_callbacks:
+.. _data_get_from_callbacks:
 
-Get data from callbacks
+Get Data From Callbacks
 ========================
 
 API offers function ``SetStreamCallback()`` and ``SetMotionCallback()`` to set callbacks for various data.

diff --git a/docs/src/data/get_img_params.rst b/docs/src/data/get_img_params.rst
@@ -1,6 +1,6 @@
-.. _get_img_params:
+.. _data_get_img_params:
 
-Get image calibration parameters
+Get Image Calibration Parameters
 ================================
 
 Use ``GetIntrinsics()`` & ``GetExtrinsics()`` to get image calibration parameters.

diff --git a/docs/src/data/get_imu.rst b/docs/src/data/get_imu.rst
@@ -1,6 +1,6 @@
-.. _get_imu_data:
+.. _data_get_imu_data:
 
-Get IMU data
+Get IMU Data
 =============
 
 The API offers ``Start()`` / ``Stop()`` function to start/stop capturing data. You can set the argument to``Source::MOTION_TRACKING`` to capture IMU data only, or set it to ``Source::ALL`` to capture both image and IMU data.

diff --git a/docs/src/data/get_imu_correspondence.rst b/docs/src/data/get_imu_correspondence.rst
@@ -1,6 +1,6 @@
-.. _get_imu_correspondence:
+.. _data_get_imu_correspondence:
 
-Get IMU data with timestamp correspondence
+Get IMU Data With Timestamp Correspondence
 ===========================================
 
 If wanna get image with timestamp in the middle of IMU datas, you could call `EnableTimestampCorrespondence()`` to enable this feature.

diff --git a/docs/src/data/get_imu_params.rst b/docs/src/data/get_imu_params.rst
@@ -1,6 +1,6 @@
-.. _get_imu_params:
+.. _data_get_imu_params:
 
-Get IMU calibration parameters
+Get IMU Calibration Parameters
 ==============================
 
 Use ``GetMotionIntrinsics()`` & ``GetMotionExtrinsics()`` to get current IMU calibration parameters.

diff --git a/docs/src/data/get_points.rst b/docs/src/data/get_points.rst
@@ -1,6 +1,6 @@
-.. _get_points:
+.. _data_get_points:
 
-Get point image
+Get Point Image
 ================
 
 Point images belongs to upper layer of synthetic data. To get this kind of data through ``GetStreamData()``, you need to start the ``EnableStreamData()`` beforehand. It should be check not empty before use.

diff --git a/docs/src/data/get_stereo.rst b/docs/src/data/get_stereo.rst
@@ -1,6 +1,6 @@
-.. _get_stereo:
+.. _data_get_stereo:
 
-Get original binocular image
+Get Original Binocular Image
 =============================
 
 Use ``Start()`` or ``Stop()`` , to start or stop data capturing. If you only need the image data, use ``Source::VIDEO_STREAMING`` .

diff --git a/docs/src/data/get_stereo_rectified.rst b/docs/src/data/get_stereo_rectified.rst
@@ -1,6 +1,6 @@
-.. _get_stereo_rectified:
+.. _data_get_stereo_rectified:
 
-Get stereo camera correction image
+Get Stereo Camera Correction Image
 ==================================
 
 The ``GetStreamData()`` API provided can only get the raw data of the hardware, for example, the stereo camera raw image.

diff --git a/docs/src/data/get_with_plugin.rst b/docs/src/data/get_with_plugin.rst
@@ -1,6 +1,6 @@
-.. _get_with_plugin:
+.. _data_get_with_plugin:
 
-Using the plugin to get data
+Using The Plugin To Get Data
 ============================
 
 API provides a ``EnablePlugin()`` function to enable plugins under a path.

diff --git a/docs/src/data/save_params.rst b/docs/src/data/save_params.rst
@@ -1,6 +1,6 @@
-.. _save_params:
+.. _data_save_params:
 
-Save device infomation and parameters
+Save Device Infomation And Parameters
 =====================================
 
 The SDK provides a tool ``save_all_infos`` for save information and parameters. For more information, please read `tools/README.md <https://github.com/slightech/MYNT-EYE-S-SDK/tree/master/tools>`_ .

diff --git a/docs/src/data/write_img_params.rst b/docs/src/data/write_img_params.rst
@@ -1,6 +1,6 @@
-.. _write_img_params:
+.. _data_write_img_params:
 
-Write image parameters
+Write Image Parameters
 =======================
 
 The SDK provides a tool ``img_params_writer`` for writing image parameters. For details, read `tools/README.md <https://github.com/slightech/MYNT-EYE-S-SDK/tree/master/tools>`_ .

diff --git a/docs/src/data/write_imu_params.rst b/docs/src/data/write_imu_params.rst
@@ -1,6 +1,6 @@
-.. _write_imu_params:
+.. _data_write_imu_params:
 
-Write IMU parameters
+Write IMU Parameters
 =====================
 
 SDK provides the tool ``imu_params_writer`` to write IMU parameters. For deltail, please read `tools/README.md <https://github.com/slightech/MYNT-EYE-S-SDK/tree/master/tools>`_ .

diff --git a/docs/src/firmware/FirmwareContents.rst b/docs/src/firmware/FirmwareContents.rst
@@ -0,0 +1,9 @@
+.. _firmware:
+
+Firmware Description
+==================
+
+.. toctree::
+   :maxdepth: 2
+
+   applicable
diff --git a/docs/src/firmware/FirmwareUpdate.rst b/docs/src/firmware/FirmwareUpdate.rst
@@ -0,0 +1,11 @@
+.. _firmware:
+
+Upgrade Firmware
+==================
+
+.. toctree::
+   :maxdepth: 2
+
+   upgrade
+   stm_update
+   from_v1
diff --git a/docs/src/firmware/UpdateLog.rst b/docs/src/firmware/UpdateLog.rst
@@ -0,0 +1,5 @@
+Update Log
+==================
+
+.. toctree::
+   :maxdepth: 2
diff --git a/docs/src/firmware/contents.rst b/docs/src/firmware/contents.rst
@@ -1,11 +1,9 @@
-.. _firmware:
-
-MYNT® EYE Firmware
+FIRMWARE
 ==================
 
 .. toctree::
+   :maxdepth: 2
 
-   applicable
-   upgrade
-   stm_update
-   from_v1.rst
+   FirmwareContents
+   FirmwareUpdate
+   UpdateLogToDos
diff --git a/docs/src/firmware/from_v1.rst b/docs/src/firmware/from_v1.rst
@@ -1,4 +1,4 @@
-.. _sdk_from_v1:
+..  _firmware_from_v1:
 
 Change from SDK 1.x to 2.x
 ===========================

diff --git a/docs/src/mynteye/contents.rst b/docs/src/mynteye/contents.rst
@@ -1,14 +1,11 @@
-.. _mynteye:
-
-MYNT® EYE product introduction
-==============================
+PRODUCT
+==================
 
 .. toctree::
+   :maxdepth: 2
 
-   intro
-   surface_s1030
-   imu_coord_s1030
-   spec_s1030
-   surface_s2100
-   imu_coord_s2100
-   spec_s2100
+   product_description
+   product_surface
+   pro_intro
+   support_resolutions
+   imu_coord
diff --git a/docs/src/mynteye/imu_coord.rst b/docs/src/mynteye/imu_coord.rst
@@ -0,0 +1,11 @@
+.. _mynteye:
+
+IMU Coordinata System
+==================
+
+.. toctree::
+   :maxdepth: 2
+
+   imu_coord_s1030
+   imu_coord_s2100
+
diff --git a/docs/src/mynteye/pro_intro.rst b/docs/src/mynteye/pro_intro.rst
@@ -0,0 +1,11 @@
+.. _mynteye:
+
+Product Introduction
+==============================
+
+.. toctree::
+   :maxdepth: 2
+
+   spec_s1030
+   spec_s1030_ir
+   spec_s2100
diff --git a/docs/src/mynteye/intro.rst → docs/src/mynteye/product_description.rst b/docs/src/mynteye/intro.rst → docs/src/mynteye/product_description.rst
@@ -1,11 +1,11 @@
-.. _mynteye_intro:
+.. _mynteye:
 
-Product description
+Product Description
 ====================
 
 MYNT® EYE S Series includes MYNT EYE S, MYNT EYE SE and MYNT EYE SC. The “Binocular + IMU” inertial navigation solution for MYNT® EYE S Series provides accurate six-axis complementary data for vSLAM applications and is more accurate and robust than other single solutions.
 
-Combined with self-developed camera synchronization, auto exposure, and white balance control camera technology, MYNT® EYE S Series provides a CUDA-based GPU real-time acceleration solution that outputs high-precision, synchronized image sources to help reduce the difficulty of algorithm development and speed up the efficiency of algorithm research and development. At the same time, MYNT EYE S is equipped with a six-axis sensor (IMU) and an infrared active light (IR). Among them, six-axis sensor (IMU) can provide data complementation and correction for the research of visual positioning algorithm, suitable for algorithm research of visual inertial odometer (VIO), help improve positioning accuracy; infrared active light (IR) can help solve the problem of identifying indoor white walls and non-textured objects, and improve the recognition accuracy of image sources. The difference between MYNT EYE SE and MYNT EYE S is that MYNT EYE SE does not include IR and offers customers with lower cost hardware. MYNT EYE SC provides 8cm/12cm optional baseline solution, super wide angle 146°FOV, providing a wider depth recognition range and accuracy level, with color image sensor, upgraded brand new BMI088 six-axis IMU, IR active light, I2C time synchronization Chip, global shutter, etc., with resolutions up to 1280x800/60fps and accuracy is up to centimeters. In addition, MYNT EYE S Series also provides a rich SDK interface and VSLAM open source project support, which can help customers quickly integrate solutions, accelerate the product development process, and achieve rapid productization and implementation.
+Combined with self-developed camera synchronization, auto exposure, and white balance control camera technology, MYNT® EYE S Series provides a CUDA-based GPU real-time acceleration solution that outputs high-precision, synchronized image sources to help reduce the difficulty of algorithm development and speed up the efficiency of algorithm research and development. At the same time, MYNT EYE S is equipped with a six-axis sensor (IMU) and an infrared active light (IR). Among them, six-axis sensor (IMU) can provide data complementation and correction for the research of visual positioning algorithm, suitable for algorithm research of visual inertial odometer (VIO), help improve positioning accuracy; infrared active light (IR) can help solve the problem of identifying indoor white walls and non-textured objects, and improve the recognition accuracy of image sources. The difference between MYNT EYE SE and MYNT EYE S is that MYNT EYE SE does not include IR and offers customers with lower cost hardware. MYNT EYE SC provides 8cm/12cm optional baseline solution, super wide angle 146°FOV, providing a wider depth recognition range and accuracy level, with color image sensor, upgraded brand new BMI088 six-axis IMU, IR active light, I2C time synchronization Chip, global shutter, etc., with resolutions up to 2560x800\@30fps and accuracy is up to centimeters. In addition, MYNT EYE S Series also provides a rich SDK interface and VSLAM open source project support, which can help customers quickly integrate solutions, accelerate the product development process, and achieve rapid productization and implementation.
 
 As a hardware product for research and development of stereo vision computing applications, MYNT® EYE S Series can be widely used in a field of visual positioning navigation (vSLAM), including visual real-time positioning navigation system of driverless vehicle and robots, visual positioning system of UAV, obstacle avoidance navigation system for driverless Vehicle, Augmented Reality (AR), Virtual Reality (VR), etc. At the same time, it can be used in a field of visual recognition, including Stereoscopic face recognition, three-dimensional object recognition, space motion tracking, three-dimensional gestures, and somatosensory recognition. And of course, you can use it for measurement which includes assisted driving system (ADAS), binocular volume calculation, industrial visual screening, etc. At present, MYNTAI has carried out service and cooperation with more than 500 domestic and foreign enterprise clients.
 

diff --git a/docs/src/mynteye/product_surface.rst b/docs/src/mynteye/product_surface.rst
@@ -0,0 +1,11 @@
+.. _mynteye:
+
+Surface
+==================
+
+.. toctree::
+   :maxdepth: 2
+
+   surface_s1030
+   surface_s2100
+
-Original file line number
+Diff line change
@@ -1,3 +1,5 @@
+    .. _api:
     API
     ===
@@ Expand Down @@