docs(*): update doc

slightech · Jul 3, 2019 · 07297dd · 07297dd
1 parent 8b0016f
commit 07297dd
Show file tree

Hide file tree

Showing 99 changed files with 152 additions and 171 deletions.
diff --git a/docs/images/boardupdate.png → docs/images/firmware/boardupdate.png b/docs/images/boardupdate.png → docs/images/firmware/boardupdate.png
diff --git a/docs/images/firmware_update.png → docs/images/firmware/firmware_update.png b/docs/images/firmware_update.png → docs/images/firmware/firmware_update.png
diff --git a/docs/images/firmware_update_cypressUSB.png → ...s/firmware/firmware_update_cypressUSB.png b/docs/images/firmware_update_cypressUSB.png → ...s/firmware/firmware_update_cypressUSB.png
diff --git a/docs/images/firmware_update_dir.png → docs/images/firmware/firmware_update_dir.png b/docs/images/firmware_update_dir.png → docs/images/firmware/firmware_update_dir.png
diff --git a/docs/images/firmware_update_driver.png → ...mages/firmware/firmware_update_driver.png b/docs/images/firmware_update_driver.png → ...mages/firmware/firmware_update_driver.png
diff --git a/...images/firmware_update_driver_install.png → ...rmware/firmware_update_driver_install.png b/...images/firmware_update_driver_install.png → ...rmware/firmware_update_driver_install.png
diff --git a/docs/images/firmware_update_option.png → ...mages/firmware/firmware_update_option.png b/docs/images/firmware_update_option.png → ...mages/firmware/firmware_update_option.png
diff --git a/docs/images/firmware_update_select.png → ...mages/firmware/firmware_update_select.png b/docs/images/firmware_update_select.png → ...mages/firmware/firmware_update_select.png
diff --git a/docs/images/firmware_update_success.png → ...ages/firmware/firmware_update_success.png b/docs/images/firmware_update_success.png → ...ages/firmware/firmware_update_success.png
diff --git a/docs/images/firmware_update_warning.png → ...ages/firmware/firmware_update_warning.png b/docs/images/firmware_update_warning.png → ...ages/firmware/firmware_update_warning.png
diff --git a/docs/images/firmware_update_westbridge.png → ...s/firmware/firmware_update_westbridge.png b/docs/images/firmware_update_westbridge.png → ...s/firmware/firmware_update_westbridge.png
diff --git a/docs/images/stmsuccess.png → docs/images/firmware/stmsuccess.png b/docs/images/stmsuccess.png → docs/images/firmware/stmsuccess.png
diff --git a/docs/images/stmupdate.png → docs/images/firmware/stmupdate.png b/docs/images/stmupdate.png → docs/images/firmware/stmupdate.png
diff --git a/docs/images/mynteye_imu_coord.jpg → docs/images/product/mynteye_imu_coord.jpg b/docs/images/mynteye_imu_coord.jpg → docs/images/product/mynteye_imu_coord.jpg
diff --git a/docs/images/mynteye_avatar_imu_coord.jpg → docs/images/product/mynteye_s2_imu_coord.jpg b/docs/images/mynteye_avatar_imu_coord.jpg → docs/images/product/mynteye_s2_imu_coord.jpg
diff --git a/...images/mynteye_avatar_surface_zh-Hans.jpg → ...es/product/mynteye_s2_surface_zh-Hans.jpg b/...images/mynteye_avatar_surface_zh-Hans.jpg → ...es/product/mynteye_s2_surface_zh-Hans.jpg
diff --git a/docs/images/mynteye_surface_zh-Hans.jpg → ...mages/product/mynteye_surface_zh-Hans.jpg b/docs/images/mynteye_surface_zh-Hans.jpg → ...mages/product/mynteye_surface_zh-Hans.jpg
diff --git a/docs/images/tripod.png → docs/images/product/tripod.png b/docs/images/tripod.png → docs/images/product/tripod.png
diff --git a/docs/images/ir.png → docs/images/sdk/ir.png b/docs/images/ir.png → docs/images/sdk/ir.png
diff --git a/docs/images/imu_analytics.png → docs/images/sdk/tools/imu_analytics.png b/docs/images/imu_analytics.png → docs/images/sdk/tools/imu_analytics.png
diff --git a/docs/images/stamp_analytics.png → docs/images/sdk/tools/stamp_analytics.png b/docs/images/stamp_analytics.png → docs/images/sdk/tools/stamp_analytics.png
diff --git a/docs/images/vs_cmd.png → docs/images/sdk/vs_cmd.png b/docs/images/vs_cmd.png → docs/images/sdk/vs_cmd.png
diff --git a/docs/images/vs_cmd_menu.png → docs/images/sdk/vs_cmd_menu.png b/docs/images/vs_cmd_menu.png → docs/images/sdk/vs_cmd_menu.png
diff --git a/docs/images/vs_cmd_test.png → docs/images/sdk/vs_cmd_test.png b/docs/images/vs_cmd_test.png → docs/images/sdk/vs_cmd_test.png
diff --git a/docs/images/calibration001.png → docs/images/tools/calibration001.png b/docs/images/calibration001.png → docs/images/tools/calibration001.png
diff --git a/docs/images/calibration002.png → docs/images/tools/calibration002.png b/docs/images/calibration002.png → docs/images/tools/calibration002.png
diff --git a/docs/images/calibration003.png → docs/images/tools/calibration003.png b/docs/images/calibration003.png → docs/images/tools/calibration003.png
diff --git a/docs/images/calibration004.png → docs/images/tools/calibration004.png b/docs/images/calibration004.png → docs/images/tools/calibration004.png
diff --git a/docs/images/calibration005.png → docs/images/tools/calibration005.png b/docs/images/calibration005.png → docs/images/tools/calibration005.png
diff --git a/docs/images/calibration006.png → docs/images/tools/calibration006.png b/docs/images/calibration006.png → docs/images/tools/calibration006.png
diff --git a/docs/images/calibration007.png → docs/images/tools/calibration007.png b/docs/images/calibration007.png → docs/images/tools/calibration007.png
diff --git a/docs/images/calibration008.png → docs/images/tools/calibration008.png b/docs/images/calibration008.png → docs/images/tools/calibration008.png
diff --git a/docs/index.rst b/docs/index.rst
@@ -10,11 +10,9 @@ MYNT® EYE S SDK
    :titlesonly:
    :maxdepth: 2
 
-   src/mynteye/contents
+   src/product/contents
    src/sdk/contents
    src/firmware/contents
-   src/data/contents
-   src/analytics/contents
    src/tools/contents
    src/slam/contents
    api/contents

diff --git a/docs/src/firmware/FirmwareUpdate.rst b/docs/src/firmware/FirmwareUpdate.rst
diff --git a/docs/src/firmware/contents.rst b/docs/src/firmware/contents.rst
@@ -4,6 +4,5 @@ FIRMWARE
 .. toctree::
    :maxdepth: 2
 
-   FirmwareContents
-   FirmwareUpdate
-   UpdateLogToDos
+   fw_info
+   fw_update
diff --git a/docs/src/firmware/UpdateLog.rst → docs/src/firmware/fw_changelog.rst b/docs/src/firmware/UpdateLog.rst → docs/src/firmware/fw_changelog.rst
@@ -1,4 +1,4 @@
-Update Log
+Change Log
 ==================
 
 .. toctree::

diff --git a/docs/src/firmware/FirmwareContents.rst → docs/src/firmware/fw_info.rst b/docs/src/firmware/FirmwareContents.rst → docs/src/firmware/fw_info.rst
@@ -1,9 +1,9 @@
-.. _firmware:
+.. _fw_info:
 
 Firmware Description
 ==================
 
 .. toctree::
    :maxdepth: 2
 
-   applicable
+   applicable
diff --git a/docs/src/firmware/fw_update.rst b/docs/src/firmware/fw_update.rst
@@ -0,0 +1,10 @@
+.. _fw_update:
+
+Firmware Update
+==================
+
+.. toctree::
+   :maxdepth: 2
+
+   update_main_chip
+   update_auxiliary_chip
diff --git a/docs/src/firmware/auxiliary_chip_update.rst → docs/src/firmware/update_auxiliary_chip.rst b/docs/src/firmware/auxiliary_chip_update.rst → docs/src/firmware/update_auxiliary_chip.rst
@@ -1,26 +1,26 @@
-.. _firmware_stm_update:
+.. _fw_update_auxiliary_chip:
 
-How to update the Auxiliary Chip
+Update Auxiliary Chip Firmware
 ==================================
 
-Update auxiliary chip(Only Support S2100/S210A)
------------------------------------------------
+Update auxiliary chip (Only Support S2100/S210A)
+------------------------------------------------
 
 * Plug in the MYNT® EYE camera into a USB3.0 port
 
 * Open MYNT EYE TOOL and select ``Options/BoardUpdate`` .
 
-.. image:: ../../images/boardupdate.png
+.. image:: ../../images/firmware/boardupdate.png
 
 * Click ``StmUpdate`` .
 
-.. image:: ../../images/stmupdate.png
+.. image:: ../../images/firmware/stmupdate.png
 
 * In the open file selection box, select the firmware ``MYNTEYE-S210x-auxiliary-chip-v1.0.bin``  and start upgrading.
 
 * Once the upgrade is complete, it will display update finished.
 
-.. image:: ../../images/stmsuccess.png
+.. image:: ../../images/firmware/stmsuccess.png
 
 
 

diff --git a/docs/src/firmware/upgrade.rst → docs/src/firmware/update_main_chip.rst b/docs/src/firmware/upgrade.rst → docs/src/firmware/update_main_chip.rst
@@ -1,6 +1,6 @@
-.. _firmware_upgrade:
+.. _fw_update_main_chip:
 
-How to update Main Processing Chip
+Update Main Chip Firmware
 ====================================
 
 Please use the MYNT EYE TOOL to update main processing chip.
@@ -42,11 +42,11 @@ Update Firmware
 
 * Open MYNT EYE TOOL and select ``Options/FirmwareUpdate`` .
 
-.. image:: ../../images/firmware_update_option.png
+.. image:: ../../images/firmware/firmware_update_option.png
 
 * Click ``Update`` .
 
-.. image:: ../../images/firmware_update.png
+.. image:: ../../images/firmware/firmware_update.png
    :width: 60%
 
 * A warning dialog box will pop up, click ``yes`` .
@@ -56,19 +56,19 @@ Update Firmware
     * Usually, the MYNT EYE TOOL automatically installs the driver during the upgrade process.
     * If the upgrade fails, refer to README.
 
-.. image:: ../../images/firmware_update_warning.png
+.. image:: ../../images/firmware/firmware_update_warning.png
    :width: 60%
 
-.. image:: ../../images/firmware_update_dir.png
+.. image:: ../../images/firmware/firmware_update_dir.png
    :width: 60%
 
 * In the open file selection box, select the firmware you want to upgrade and start upgrading.
 
-.. image:: ../../images/firmware_update_select.png
+.. image:: ../../images/firmware/firmware_update_select.png
 
 * Once the upgrade is complete, the status will changes to ``Succeeded``.
 
-.. image:: ../../images/firmware_update_success.png
+.. image:: ../../images/firmware/firmware_update_success.png
    :width: 60%
 
 * Close the MYNT EYE TOOL，finish.
@@ -85,13 +85,13 @@ Manually update drivers
 
 * Open device manager, locate ``WestBridge_driver`` device, and right click Update Driver,select ``[application directory]WestBridge_driver\\[corresponding system folders](If it is more than win7, choose wlh)\\[system bits]`` .
 
-.. image:: ../../images/firmware_update_westbridge.png
+.. image:: ../../images/firmware/firmware_update_westbridge.png
 
 * For example,if it is the win10 64 bit system computer,and the application is installed under the default path,you should select ``C:\Program Files (x86)\slightech\MYNT EYE TOOL 2.0\WestBridge_driver\wlh\x64``.
 
 * After the installation driver is successful, you can find the ``Cypress USB BootLoader`` device in the device manager.
 
-.. image:: ../../images/firmware_update_cypressUSB.png
+.. image:: ../../images/firmware/firmware_update_cypressUSB.png
 
 * Then plug in the camera and open the application again to update.
 
@@ -101,5 +101,5 @@ Manually update drivers
 
 .. ::
 
-  .. image:: ../../images/firmware_update_driver.png
-  .. image:: ../../images/firmware_update_driver_install.png
+  .. image:: ../../images/firmware/firmware_update_driver.png
+  .. image:: ../../images/firmware/firmware_update_driver_install.png
diff --git a/docs/src/mynteye/imu_coord_s2100.rst b/docs/src/mynteye/imu_coord_s2100.rst
diff --git a/docs/src/mynteye/contents.rst → docs/src/product/contents.rst b/docs/src/mynteye/contents.rst → docs/src/product/contents.rst
@@ -4,8 +4,7 @@ PRODUCT
 .. toctree::
    :maxdepth: 2
 
-   product_description
+   product_desc
    product_surface
-   pro_intro
-   support_resolutions
-   imu_coord
+   product_spec
+   imu_coord
diff --git a/docs/src/mynteye/imu_coord.rst → docs/src/product/imu_coord.rst b/docs/src/mynteye/imu_coord.rst → docs/src/product/imu_coord.rst
@@ -1,11 +1,10 @@
-.. _mynteye:
+.. _product_imu_coord:
 
-IMU Coordinata System
+IMU Coordinate System
 ==================
 
 .. toctree::
    :maxdepth: 2
 
    imu_coord_s1030
    imu_coord_s2100
-
diff --git a/docs/src/mynteye/imu_coord_s1030.rst → docs/src/product/imu_coord_s1030.rst b/docs/src/mynteye/imu_coord_s1030.rst → docs/src/product/imu_coord_s1030.rst
@@ -1,8 +1,8 @@
-.. _mynteye_imu_coord_s1030:
+.. _product_imu_coord_s1030:
 
-MYNTEYE-S1030 IMU coordinata system
+S1030 Coordinate System
 ====================================
 
 IMU coordinate system is right-handed,the axis directions are as follows:
 
-.. image:: ../../images/mynteye_imu_coord.jpg
+.. image:: ../../images/product/mynteye_imu_coord.jpg
diff --git a/docs/src/product/imu_coord_s2100.rst b/docs/src/product/imu_coord_s2100.rst
@@ -0,0 +1,8 @@
+.. _product_imu_coord_s2100:
+
+S2100 Coordinate System
+====================================
+
+IMU coordinate system is right-handed,the axis directions are as follows:
+
+.. image:: ../../images/product/mynteye_s2_imu_coord.jpg
diff --git a/docs/src/mynteye/product_description.rst → docs/src/product/product_desc.rst b/docs/src/mynteye/product_description.rst → docs/src/product/product_desc.rst
@@ -1,4 +1,4 @@
-.. _mynteye:
+.. _product_desc:
 
 Product Description
 ====================

diff --git a/docs/src/mynteye/pro_intro.rst → docs/src/product/product_spec.rst b/docs/src/mynteye/pro_intro.rst → docs/src/product/product_spec.rst
@@ -1,11 +1,11 @@
-.. _mynteye:
+.. _product_spec:
 
-Product Introduction
+Product Specification
 ==============================
 
 .. toctree::
    :maxdepth: 2
 
    spec_s1030
    spec_s1030_ir
-   spec_s2100
+   spec_s2100
diff --git a/docs/src/mynteye/product_surface.rst → docs/src/product/product_surface.rst b/docs/src/mynteye/product_surface.rst → docs/src/product/product_surface.rst
@@ -1,11 +1,10 @@
-.. _mynteye:
+.. _product_surface:
 
-Surface
+Product Surface
 ==================
 
 .. toctree::
    :maxdepth: 2
 
    surface_s1030
    surface_s2100
-
diff --git a/docs/src/mynteye/spec_s1030.rst → docs/src/product/spec_s1030.rst b/docs/src/mynteye/spec_s1030.rst → docs/src/product/spec_s1030.rst
@@ -3,7 +3,7 @@
 S1030-120/Mono Product Specification
 =========================================
 
-Product Specification:
+Product Specification
 -----------------------
 
 
@@ -82,14 +82,14 @@ Work Environment
 ===========================  ================================
 
 
-Package:
+Package
 ---------
 
 ===================  =======================================
   Package Contents      MYNT EYE x1   USB Micro-B Cable x1
 ===================  =======================================
 
-Warranty：
+Warranty
 ----------
 
 ====================  ============================================

diff --git a/docs/src/mynteye/spec_s1030_ir.rst → docs/src/product/spec_s1030_ir.rst b/docs/src/mynteye/spec_s1030_ir.rst → docs/src/product/spec_s1030_ir.rst
@@ -3,7 +3,7 @@
 S1030-IR-120/Mono Product Specification
 =========================================
 
-Product Specification:
+Product Specification
 -----------------------
 
 
@@ -84,14 +84,14 @@ Work Environment
 ===========================  ================================
 
 
-Package:
+Package
 ---------
 
 ===================  =======================================
   Package Contents      MYNT EYE x1   USB Micro-B Cable x1
 ===================  =======================================
 
-Warranty：
+Warranty
 ----------
 
 ====================  ============================================

diff --git a/docs/src/mynteye/spec_s2100.rst → docs/src/product/spec_s2100.rst b/docs/src/mynteye/spec_s2100.rst → docs/src/product/spec_s2100.rst
@@ -4,7 +4,7 @@
 S2100-146/Color Product Specification
 ========================================
 
-Product Specification:
+Product Specification
 -----------------------
 
 
@@ -81,14 +81,14 @@ Work Environment
 =========================  ==============================
 
 
-Package:
+Package
 ---------
 
 ===================  =======================================
   Package Contents      MYNT EYE x1   USB Micro-B Cable x1
 ===================  =======================================
 
-Warranty：
+Warranty
 ----------
 
 ====================  ============================================

diff --git a/docs/src/mynteye/surface_s1030.rst → docs/src/product/surface_s1030.rst b/docs/src/mynteye/surface_s1030.rst → docs/src/product/surface_s1030.rst
@@ -1,6 +1,6 @@
 .. _mynteye_surface_s1030:
 
-MYNTEYE-S1030 Size and structure
+S1030 Size and Structure
 =================================
 
 ============= ==============
@@ -9,7 +9,7 @@ Shell(mm)     PCBA board(mm)
 165x31.5x29.6 149x24
 ============= ==============
 
-.. image:: ../../images/mynteye_surface_zh-Hans.jpg
+.. image:: ../../images/product/mynteye_surface_zh-Hans.jpg
 
 A. Camera:please pay attention to protect the camera sensor lenses, to avoid imaging quality degradation.
 B. Infrared structured-light transmitter and outlet: the infrared structured-light can effectively solve the problem associated with the visual positioning calculations of white wall non-textured object(For non-IR version, the outlet is reserved but there is no internal structured-light emitter).

diff --git a/docs/src/mynteye/surface_s2100.rst → docs/src/product/surface_s2100.rst b/docs/src/mynteye/surface_s2100.rst → docs/src/product/surface_s2100.rst
@@ -1,6 +1,6 @@
 .. _mynteye_surface_s2100:
 
-MYNTEYE-S2100 Size and structure
+S2100 Size and Structure
 ================================
 
 ============= ==============
@@ -9,7 +9,7 @@ Shell(mm)     PCBA board(mm)
 125x47x40     100x15
 ============= ==============
 
-.. image:: ../../images/mynteye_avatar_surface_zh-Hans.jpg
+.. image:: ../../images/product/mynteye_s2_surface_zh-Hans.jpg
 
 A. Camera:please pay attention to protect the camera sensor lenses, to avoid imaging quality degradation.
 B. USB Micro-B interface and set screw holes: during usage, plug in the USB Micro-B cable and secure it by fastening the set screws to avoid damage to the interface and to ensure stability in connection.
diff --git a/docs/src/sdk/InstallContents.rst b/docs/src/sdk/InstallContents.rst