From 07297dd2f12a6dd31c95f933e44845a761799a3a Mon Sep 17 00:00:00 2001 From: John Zhao Date: Wed, 3 Jul 2019 13:55:25 +0800 Subject: [PATCH] docs(*): update doc --- docs/images/{ => firmware}/boardupdate.png | Bin .../images/{ => firmware}/firmware_update.png | Bin .../firmware_update_cypressUSB.png | Bin .../{ => firmware}/firmware_update_dir.png | Bin .../{ => firmware}/firmware_update_driver.png | Bin .../firmware_update_driver_install.png | Bin .../{ => firmware}/firmware_update_option.png | Bin .../{ => firmware}/firmware_update_select.png | Bin .../firmware_update_success.png | Bin .../firmware_update_warning.png | Bin .../firmware_update_westbridge.png | Bin docs/images/{ => firmware}/stmsuccess.png | Bin docs/images/{ => firmware}/stmupdate.png | Bin .../{ => product}/mynteye_imu_coord.jpg | Bin .../mynteye_s2_imu_coord.jpg} | Bin .../mynteye_s2_surface_zh-Hans.jpg} | Bin .../{ => product}/mynteye_surface_zh-Hans.jpg | Bin docs/images/{ => product}/tripod.png | Bin docs/images/{ => sdk}/ir.png | Bin docs/images/{ => sdk/tools}/imu_analytics.png | Bin .../{ => sdk/tools}/stamp_analytics.png | Bin docs/images/{ => sdk}/vs_cmd.png | Bin docs/images/{ => sdk}/vs_cmd_menu.png | Bin docs/images/{ => sdk}/vs_cmd_test.png | Bin docs/images/{ => tools}/calibration001.png | Bin docs/images/{ => tools}/calibration002.png | Bin docs/images/{ => tools}/calibration003.png | Bin docs/images/{ => tools}/calibration004.png | Bin docs/images/{ => tools}/calibration005.png | Bin docs/images/{ => tools}/calibration006.png | Bin docs/images/{ => tools}/calibration007.png | Bin docs/images/{ => tools}/calibration008.png | Bin docs/index.rst | 4 +- docs/src/firmware/FirmwareUpdate.rst | 11 ---- docs/src/firmware/contents.rst | 5 +- .../{UpdateLog.rst => fw_changelog.rst} | 2 +- .../{FirmwareContents.rst => fw_info.rst} | 4 +- docs/src/firmware/fw_update.rst | 10 ++++ ...p_update.rst => update_auxiliary_chip.rst} | 14 ++--- .../{upgrade.rst => update_main_chip.rst} | 24 ++++----- docs/src/mynteye/imu_coord_s2100.rst | 8 --- docs/src/{mynteye => product}/contents.rst | 7 ++- docs/src/{mynteye => product}/imu_coord.rst | 5 +- .../{mynteye => product}/imu_coord_s1030.rst | 6 +-- docs/src/product/imu_coord_s2100.rst | 8 +++ .../product_desc.rst} | 2 +- .../product_spec.rst} | 6 +-- .../{mynteye => product}/product_surface.rst | 5 +- docs/src/{mynteye => product}/spec_s1030.rst | 6 +-- .../{mynteye => product}/spec_s1030_ir.rst | 6 +-- docs/src/{mynteye => product}/spec_s2100.rst | 6 +-- .../{mynteye => product}/surface_s1030.rst | 4 +- .../{mynteye => product}/surface_s2100.rst | 4 +- docs/src/sdk/InstallContents.rst | 14 ----- docs/src/sdk/ProjectContents.rst | 12 ----- docs/src/sdk/contents.rst | 10 ++-- docs/src/{ => sdk}/control/auto_exposure.rst | 0 docs/src/{ => sdk}/control/contents.rst | 4 +- docs/src/{ => sdk}/control/framerate.rst | 0 docs/src/{ => sdk}/control/iic_address.rst | 0 .../{ => sdk}/control/imu_low_pass_filter.rst | 0 docs/src/{ => sdk}/control/imu_range.rst | 0 docs/src/{ => sdk}/control/infrared.rst | 2 +- .../src/{ => sdk}/control/manual_exposure.rst | 0 docs/src/{ => sdk}/data/contents.rst | 8 +-- docs/src/{ => sdk}/data/get_depth.rst | 0 docs/src/{ => sdk}/data/get_device_info.rst | 0 docs/src/{ => sdk}/data/get_disparity.rst | 0 .../src/{ => sdk}/data/get_from_callbacks.rst | 0 docs/src/{ => sdk}/data/get_img_params.rst | 0 docs/src/{ => sdk}/data/get_imu.rst | 0 .../{ => sdk}/data/get_imu_correspondence.rst | 0 docs/src/{ => sdk}/data/get_imu_params.rst | 0 docs/src/{ => sdk}/data/get_points.rst | 0 docs/src/{ => sdk}/data/get_stereo.rst | 0 .../{ => sdk}/data/get_stereo_rectified.rst | 0 docs/src/{ => sdk}/data/get_with_plugin.rst | 0 docs/src/{ => sdk}/data/save_params.rst | 0 docs/src/{ => sdk}/data/write_img_params.rst | 0 docs/src/{ => sdk}/data/write_imu_params.rst | 0 docs/src/{firmware => sdk}/from_v1.rst | 2 +- ...nstall_ros.rst => install_ros_wrapper.rst} | 6 +-- ...tall_ubuntu.rst => install_ubuntu_ppa.rst} | 4 +- ...tall_ubuntu.rst => install_ubuntu_src.rst} | 4 +- ...ll_windows.rst => install_windows_exe.rst} | 4 +- ...ll_windows.rst => install_windows_src.rst} | 10 ++-- .../sdk/{changelog.rst => sdk_changelog.rst} | 3 +- .../src/sdk/{SDKContents.rst => sdk_info.rst} | 5 +- docs/src/sdk/sdk_install.rst | 13 +++++ .../sdk/{LogContents.rst => sdk_projects.rst} | 6 +-- .../{platform.rst => support_platforms.rst} | 2 +- .../tools}/analytics_dataset.rst | 0 .../tools}/analytics_imu.rst | 2 +- .../tools}/analytics_stamp.rst | 2 +- .../src/{analytics => sdk/tools}/contents.rst | 4 +- docs/src/sdk/without_opencv.rst | 2 +- docs/src/tools/calibration_tool.rst | 51 +++++++++--------- docs/src/tools/contents.rst | 4 +- docs/src/wrapper/ros.rst | 2 +- 99 files changed, 152 insertions(+), 171 deletions(-) rename docs/images/{ => firmware}/boardupdate.png (100%) rename docs/images/{ => firmware}/firmware_update.png (100%) rename docs/images/{ => firmware}/firmware_update_cypressUSB.png (100%) rename docs/images/{ => firmware}/firmware_update_dir.png (100%) rename docs/images/{ => firmware}/firmware_update_driver.png (100%) rename docs/images/{ => firmware}/firmware_update_driver_install.png (100%) rename docs/images/{ => firmware}/firmware_update_option.png (100%) rename docs/images/{ => firmware}/firmware_update_select.png (100%) rename docs/images/{ => firmware}/firmware_update_success.png (100%) rename docs/images/{ => firmware}/firmware_update_warning.png (100%) rename docs/images/{ => firmware}/firmware_update_westbridge.png (100%) rename docs/images/{ => firmware}/stmsuccess.png (100%) rename docs/images/{ => firmware}/stmupdate.png (100%) rename docs/images/{ => product}/mynteye_imu_coord.jpg (100%) rename docs/images/{mynteye_avatar_imu_coord.jpg => product/mynteye_s2_imu_coord.jpg} (100%) rename docs/images/{mynteye_avatar_surface_zh-Hans.jpg => product/mynteye_s2_surface_zh-Hans.jpg} (100%) rename docs/images/{ => product}/mynteye_surface_zh-Hans.jpg (100%) rename docs/images/{ => product}/tripod.png (100%) rename docs/images/{ => sdk}/ir.png (100%) rename docs/images/{ => sdk/tools}/imu_analytics.png (100%) rename docs/images/{ => sdk/tools}/stamp_analytics.png (100%) rename docs/images/{ => sdk}/vs_cmd.png (100%) rename docs/images/{ => sdk}/vs_cmd_menu.png (100%) rename docs/images/{ => sdk}/vs_cmd_test.png (100%) rename docs/images/{ => tools}/calibration001.png (100%) rename docs/images/{ => tools}/calibration002.png (100%) rename docs/images/{ => tools}/calibration003.png (100%) rename docs/images/{ => tools}/calibration004.png (100%) rename docs/images/{ => tools}/calibration005.png (100%) rename docs/images/{ => tools}/calibration006.png (100%) rename docs/images/{ => tools}/calibration007.png (100%) rename docs/images/{ => tools}/calibration008.png (100%) delete mode 100644 docs/src/firmware/FirmwareUpdate.rst rename docs/src/firmware/{UpdateLog.rst => fw_changelog.rst} (81%) rename docs/src/firmware/{FirmwareContents.rst => fw_info.rst} (72%) create mode 100644 docs/src/firmware/fw_update.rst rename docs/src/firmware/{auxiliary_chip_update.rst => update_auxiliary_chip.rst} (54%) rename docs/src/firmware/{upgrade.rst => update_main_chip.rst} (83%) delete mode 100644 docs/src/mynteye/imu_coord_s2100.rst rename docs/src/{mynteye => product}/contents.rst (52%) rename docs/src/{mynteye => product}/imu_coord.rst (66%) rename docs/src/{mynteye => product}/imu_coord_s1030.rst (50%) create mode 100644 docs/src/product/imu_coord_s2100.rst rename docs/src/{mynteye/product_description.rst => product/product_desc.rst} (99%) rename docs/src/{mynteye/pro_intro.rst => product/product_spec.rst} (63%) rename docs/src/{mynteye => product}/product_surface.rst (69%) rename docs/src/{mynteye => product}/spec_s1030.rst (99%) rename docs/src/{mynteye => product}/spec_s1030_ir.rst (99%) rename docs/src/{mynteye => product}/spec_s2100.rst (99%) rename docs/src/{mynteye => product}/surface_s1030.rst (91%) rename docs/src/{mynteye => product}/surface_s2100.rst (84%) delete mode 100644 docs/src/sdk/InstallContents.rst delete mode 100644 docs/src/sdk/ProjectContents.rst rename docs/src/{ => sdk}/control/auto_exposure.rst (100%) rename docs/src/{ => sdk}/control/contents.rst (80%) rename docs/src/{ => sdk}/control/framerate.rst (100%) rename docs/src/{ => sdk}/control/iic_address.rst (100%) rename docs/src/{ => sdk}/control/imu_low_pass_filter.rst (100%) rename docs/src/{ => sdk}/control/imu_range.rst (100%) rename docs/src/{ => sdk}/control/infrared.rst (98%) rename docs/src/{ => sdk}/control/manual_exposure.rst (100%) rename docs/src/{ => sdk}/data/contents.rst (76%) rename docs/src/{ => sdk}/data/get_depth.rst (100%) rename docs/src/{ => sdk}/data/get_device_info.rst (100%) rename docs/src/{ => sdk}/data/get_disparity.rst (100%) rename docs/src/{ => sdk}/data/get_from_callbacks.rst (100%) rename docs/src/{ => sdk}/data/get_img_params.rst (100%) rename docs/src/{ => sdk}/data/get_imu.rst (100%) rename docs/src/{ => sdk}/data/get_imu_correspondence.rst (100%) rename docs/src/{ => sdk}/data/get_imu_params.rst (100%) rename docs/src/{ => sdk}/data/get_points.rst (100%) rename docs/src/{ => sdk}/data/get_stereo.rst (100%) rename docs/src/{ => sdk}/data/get_stereo_rectified.rst (100%) rename docs/src/{ => sdk}/data/get_with_plugin.rst (100%) rename docs/src/{ => sdk}/data/save_params.rst (100%) rename docs/src/{ => sdk}/data/write_img_params.rst (100%) rename docs/src/{ => sdk}/data/write_imu_params.rst (100%) rename docs/src/{firmware => sdk}/from_v1.rst (94%) rename docs/src/sdk/{install_ros.rst => install_ros_wrapper.rst} (97%) rename docs/src/sdk/{ppa_install_ubuntu.rst => install_ubuntu_ppa.rst} (95%) rename docs/src/sdk/{source_install_ubuntu.rst => install_ubuntu_src.rst} (98%) rename docs/src/sdk/{exe_install_windows.rst => install_windows_exe.rst} (96%) rename docs/src/sdk/{source_install_windows.rst => install_windows_src.rst} (97%) rename docs/src/sdk/{changelog.rst => sdk_changelog.rst} (99%) rename docs/src/sdk/{SDKContents.rst => sdk_info.rst} (55%) create mode 100644 docs/src/sdk/sdk_install.rst rename docs/src/sdk/{LogContents.rst => sdk_projects.rst} (59%) rename docs/src/sdk/{platform.rst => support_platforms.rst} (95%) rename docs/src/{analytics => sdk/tools}/analytics_dataset.rst (100%) rename docs/src/{analytics => sdk/tools}/analytics_imu.rst (95%) rename docs/src/{analytics => sdk/tools}/analytics_stamp.rst (96%) rename docs/src/{analytics => sdk/tools}/contents.rst (75%) diff --git a/docs/images/boardupdate.png b/docs/images/firmware/boardupdate.png similarity index 100% rename from docs/images/boardupdate.png rename to docs/images/firmware/boardupdate.png diff --git a/docs/images/firmware_update.png b/docs/images/firmware/firmware_update.png similarity index 100% rename from docs/images/firmware_update.png rename to docs/images/firmware/firmware_update.png diff --git a/docs/images/firmware_update_cypressUSB.png b/docs/images/firmware/firmware_update_cypressUSB.png similarity index 100% rename from docs/images/firmware_update_cypressUSB.png rename to docs/images/firmware/firmware_update_cypressUSB.png diff --git a/docs/images/firmware_update_dir.png b/docs/images/firmware/firmware_update_dir.png similarity index 100% rename from docs/images/firmware_update_dir.png rename to docs/images/firmware/firmware_update_dir.png diff --git a/docs/images/firmware_update_driver.png b/docs/images/firmware/firmware_update_driver.png similarity index 100% rename from docs/images/firmware_update_driver.png rename to docs/images/firmware/firmware_update_driver.png diff --git a/docs/images/firmware_update_driver_install.png b/docs/images/firmware/firmware_update_driver_install.png similarity index 100% rename from docs/images/firmware_update_driver_install.png rename to docs/images/firmware/firmware_update_driver_install.png diff --git a/docs/images/firmware_update_option.png b/docs/images/firmware/firmware_update_option.png similarity index 100% rename from docs/images/firmware_update_option.png rename to docs/images/firmware/firmware_update_option.png diff --git a/docs/images/firmware_update_select.png b/docs/images/firmware/firmware_update_select.png similarity index 100% rename from docs/images/firmware_update_select.png rename to docs/images/firmware/firmware_update_select.png diff --git a/docs/images/firmware_update_success.png b/docs/images/firmware/firmware_update_success.png similarity index 100% rename from docs/images/firmware_update_success.png rename to docs/images/firmware/firmware_update_success.png diff --git a/docs/images/firmware_update_warning.png b/docs/images/firmware/firmware_update_warning.png similarity index 100% rename from docs/images/firmware_update_warning.png rename to docs/images/firmware/firmware_update_warning.png diff --git a/docs/images/firmware_update_westbridge.png b/docs/images/firmware/firmware_update_westbridge.png similarity index 100% rename from docs/images/firmware_update_westbridge.png rename to docs/images/firmware/firmware_update_westbridge.png diff --git a/docs/images/stmsuccess.png b/docs/images/firmware/stmsuccess.png similarity index 100% rename from docs/images/stmsuccess.png rename to docs/images/firmware/stmsuccess.png diff --git a/docs/images/stmupdate.png b/docs/images/firmware/stmupdate.png similarity index 100% rename from docs/images/stmupdate.png rename to docs/images/firmware/stmupdate.png diff --git a/docs/images/mynteye_imu_coord.jpg b/docs/images/product/mynteye_imu_coord.jpg similarity index 100% rename from docs/images/mynteye_imu_coord.jpg rename to docs/images/product/mynteye_imu_coord.jpg diff --git a/docs/images/mynteye_avatar_imu_coord.jpg b/docs/images/product/mynteye_s2_imu_coord.jpg similarity index 100% rename from docs/images/mynteye_avatar_imu_coord.jpg rename to docs/images/product/mynteye_s2_imu_coord.jpg diff --git a/docs/images/mynteye_avatar_surface_zh-Hans.jpg b/docs/images/product/mynteye_s2_surface_zh-Hans.jpg similarity index 100% rename from docs/images/mynteye_avatar_surface_zh-Hans.jpg rename to docs/images/product/mynteye_s2_surface_zh-Hans.jpg diff --git a/docs/images/mynteye_surface_zh-Hans.jpg b/docs/images/product/mynteye_surface_zh-Hans.jpg similarity index 100% rename from docs/images/mynteye_surface_zh-Hans.jpg rename to docs/images/product/mynteye_surface_zh-Hans.jpg diff --git a/docs/images/tripod.png b/docs/images/product/tripod.png similarity index 100% rename from docs/images/tripod.png rename to docs/images/product/tripod.png diff --git a/docs/images/ir.png b/docs/images/sdk/ir.png similarity index 100% rename from docs/images/ir.png rename to docs/images/sdk/ir.png diff --git a/docs/images/imu_analytics.png b/docs/images/sdk/tools/imu_analytics.png similarity index 100% rename from docs/images/imu_analytics.png rename to docs/images/sdk/tools/imu_analytics.png diff --git a/docs/images/stamp_analytics.png b/docs/images/sdk/tools/stamp_analytics.png similarity index 100% rename from docs/images/stamp_analytics.png rename to docs/images/sdk/tools/stamp_analytics.png diff --git a/docs/images/vs_cmd.png b/docs/images/sdk/vs_cmd.png similarity index 100% rename from docs/images/vs_cmd.png rename to docs/images/sdk/vs_cmd.png diff --git a/docs/images/vs_cmd_menu.png b/docs/images/sdk/vs_cmd_menu.png similarity index 100% rename from docs/images/vs_cmd_menu.png rename to docs/images/sdk/vs_cmd_menu.png diff --git a/docs/images/vs_cmd_test.png b/docs/images/sdk/vs_cmd_test.png similarity index 100% rename from docs/images/vs_cmd_test.png rename to docs/images/sdk/vs_cmd_test.png diff --git a/docs/images/calibration001.png b/docs/images/tools/calibration001.png similarity index 100% rename from docs/images/calibration001.png rename to docs/images/tools/calibration001.png diff --git a/docs/images/calibration002.png b/docs/images/tools/calibration002.png similarity index 100% rename from docs/images/calibration002.png rename to docs/images/tools/calibration002.png diff --git a/docs/images/calibration003.png b/docs/images/tools/calibration003.png similarity index 100% rename from docs/images/calibration003.png rename to docs/images/tools/calibration003.png diff --git a/docs/images/calibration004.png b/docs/images/tools/calibration004.png similarity index 100% rename from docs/images/calibration004.png rename to docs/images/tools/calibration004.png diff --git a/docs/images/calibration005.png b/docs/images/tools/calibration005.png similarity index 100% rename from docs/images/calibration005.png rename to docs/images/tools/calibration005.png diff --git a/docs/images/calibration006.png b/docs/images/tools/calibration006.png similarity index 100% rename from docs/images/calibration006.png rename to docs/images/tools/calibration006.png diff --git a/docs/images/calibration007.png b/docs/images/tools/calibration007.png similarity index 100% rename from docs/images/calibration007.png rename to docs/images/tools/calibration007.png diff --git a/docs/images/calibration008.png b/docs/images/tools/calibration008.png similarity index 100% rename from docs/images/calibration008.png rename to docs/images/tools/calibration008.png diff --git a/docs/index.rst b/docs/index.rst index fd8bf518..4a5b55e1 100644 --- 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 deleted file mode 100644 index 356b58df..00000000 --- a/docs/src/firmware/FirmwareUpdate.rst +++ /dev/null @@ -1,11 +0,0 @@ -.. _firmware: - -Upgrade Firmware -================== - -.. toctree:: - :maxdepth: 2 - - upgrade - stm_update - from_v1 diff --git a/docs/src/firmware/contents.rst b/docs/src/firmware/contents.rst index acd46965..11fedcff 100644 --- a/docs/src/firmware/contents.rst +++ b/docs/src/firmware/contents.rst @@ -4,6 +4,5 @@ FIRMWARE .. toctree:: :maxdepth: 2 - FirmwareContents - FirmwareUpdate - UpdateLogToDos \ No newline at end of file + fw_info + fw_update diff --git a/docs/src/firmware/UpdateLog.rst b/docs/src/firmware/fw_changelog.rst similarity index 81% rename from docs/src/firmware/UpdateLog.rst rename to docs/src/firmware/fw_changelog.rst index 021635dd..416e6712 100644 --- a/docs/src/firmware/UpdateLog.rst +++ b/docs/src/firmware/fw_changelog.rst @@ -1,4 +1,4 @@ -Update Log +Change Log ================== .. toctree:: diff --git a/docs/src/firmware/FirmwareContents.rst b/docs/src/firmware/fw_info.rst similarity index 72% rename from docs/src/firmware/FirmwareContents.rst rename to docs/src/firmware/fw_info.rst index 09e8f796..d6724395 100644 --- a/docs/src/firmware/FirmwareContents.rst +++ b/docs/src/firmware/fw_info.rst @@ -1,4 +1,4 @@ -.. _firmware: +.. _fw_info: Firmware Description ================== @@ -6,4 +6,4 @@ Firmware Description .. toctree:: :maxdepth: 2 - applicable \ No newline at end of file + applicable diff --git a/docs/src/firmware/fw_update.rst b/docs/src/firmware/fw_update.rst new file mode 100644 index 00000000..479dcc68 --- /dev/null +++ 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 b/docs/src/firmware/update_auxiliary_chip.rst similarity index 54% rename from docs/src/firmware/auxiliary_chip_update.rst rename to docs/src/firmware/update_auxiliary_chip.rst index e35a6ca2..a92f1f5e 100644 --- a/docs/src/firmware/auxiliary_chip_update.rst +++ b/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 b/docs/src/firmware/update_main_chip.rst similarity index 83% rename from docs/src/firmware/upgrade.rst rename to docs/src/firmware/update_main_chip.rst index f270e70f..bb44696e 100644 --- a/docs/src/firmware/upgrade.rst +++ b/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 deleted file mode 100644 index e534c221..00000000 --- a/docs/src/mynteye/imu_coord_s2100.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. _mynteye_imu_coord_s2100: - -MYNTEYE-S2100 IMU coordinata system -==================================== - -IMU coordinate system is right-handed,the axis directions are as follows: - -.. image:: ../../images/mynteye_avatar_imu_coord.jpg diff --git a/docs/src/mynteye/contents.rst b/docs/src/product/contents.rst similarity index 52% rename from docs/src/mynteye/contents.rst rename to docs/src/product/contents.rst index 2591a5f8..d2ed4823 100644 --- a/docs/src/mynteye/contents.rst +++ b/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 \ No newline at end of file + product_spec + imu_coord diff --git a/docs/src/mynteye/imu_coord.rst b/docs/src/product/imu_coord.rst similarity index 66% rename from docs/src/mynteye/imu_coord.rst rename to docs/src/product/imu_coord.rst index 27bda434..4d987ffe 100644 --- a/docs/src/mynteye/imu_coord.rst +++ b/docs/src/product/imu_coord.rst @@ -1,6 +1,6 @@ -.. _mynteye: +.. _product_imu_coord: -IMU Coordinata System +IMU Coordinate System ================== .. toctree:: @@ -8,4 +8,3 @@ IMU Coordinata System imu_coord_s1030 imu_coord_s2100 - \ No newline at end of file diff --git a/docs/src/mynteye/imu_coord_s1030.rst b/docs/src/product/imu_coord_s1030.rst similarity index 50% rename from docs/src/mynteye/imu_coord_s1030.rst rename to docs/src/product/imu_coord_s1030.rst index 9e75ea8f..eb3851e8 100644 --- a/docs/src/mynteye/imu_coord_s1030.rst +++ b/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 new file mode 100644 index 00000000..1fc104f0 --- /dev/null +++ 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 b/docs/src/product/product_desc.rst similarity index 99% rename from docs/src/mynteye/product_description.rst rename to docs/src/product/product_desc.rst index e270bcbf..f173e87e 100644 --- a/docs/src/mynteye/product_description.rst +++ b/docs/src/product/product_desc.rst @@ -1,4 +1,4 @@ -.. _mynteye: +.. _product_desc: Product Description ==================== diff --git a/docs/src/mynteye/pro_intro.rst b/docs/src/product/product_spec.rst similarity index 63% rename from docs/src/mynteye/pro_intro.rst rename to docs/src/product/product_spec.rst index 538bcf5b..00db9b89 100644 --- a/docs/src/mynteye/pro_intro.rst +++ b/docs/src/product/product_spec.rst @@ -1,6 +1,6 @@ -.. _mynteye: +.. _product_spec: -Product Introduction +Product Specification ============================== .. toctree:: @@ -8,4 +8,4 @@ Product Introduction spec_s1030 spec_s1030_ir - spec_s2100 \ No newline at end of file + spec_s2100 diff --git a/docs/src/mynteye/product_surface.rst b/docs/src/product/product_surface.rst similarity index 69% rename from docs/src/mynteye/product_surface.rst rename to docs/src/product/product_surface.rst index 389b93c6..64512168 100644 --- a/docs/src/mynteye/product_surface.rst +++ b/docs/src/product/product_surface.rst @@ -1,6 +1,6 @@ -.. _mynteye: +.. _product_surface: -Surface +Product Surface ================== .. toctree:: @@ -8,4 +8,3 @@ Surface surface_s1030 surface_s2100 - \ No newline at end of file diff --git a/docs/src/mynteye/spec_s1030.rst b/docs/src/product/spec_s1030.rst similarity index 99% rename from docs/src/mynteye/spec_s1030.rst rename to docs/src/product/spec_s1030.rst index 0078d482..7271c466 100644 --- a/docs/src/mynteye/spec_s1030.rst +++ b/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 b/docs/src/product/spec_s1030_ir.rst similarity index 99% rename from docs/src/mynteye/spec_s1030_ir.rst rename to docs/src/product/spec_s1030_ir.rst index 3b6da591..dab6a920 100644 --- a/docs/src/mynteye/spec_s1030_ir.rst +++ b/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 b/docs/src/product/spec_s2100.rst similarity index 99% rename from docs/src/mynteye/spec_s2100.rst rename to docs/src/product/spec_s2100.rst index 1cdc48f1..05ad5fff 100644 --- a/docs/src/mynteye/spec_s2100.rst +++ b/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 b/docs/src/product/surface_s1030.rst similarity index 91% rename from docs/src/mynteye/surface_s1030.rst rename to docs/src/product/surface_s1030.rst index a834ca29..98468adb 100644 --- a/docs/src/mynteye/surface_s1030.rst +++ b/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 b/docs/src/product/surface_s2100.rst similarity index 84% rename from docs/src/mynteye/surface_s2100.rst rename to docs/src/product/surface_s2100.rst index d0556ce2..66f62440 100644 --- a/docs/src/mynteye/surface_s2100.rst +++ b/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 deleted file mode 100644 index c6bc918d..00000000 --- a/docs/src/sdk/InstallContents.rst +++ /dev/null @@ -1,14 +0,0 @@ -.. _sdk: - -Installation and Use -================== - -.. toctree:: - :maxdepth: 2 - - ppa_install_ubuntu - source_install_ubuntu - exe_install_windows - source_install_windows - install_ros - without_opencv \ No newline at end of file diff --git a/docs/src/sdk/ProjectContents.rst b/docs/src/sdk/ProjectContents.rst deleted file mode 100644 index ed143dcd..00000000 --- a/docs/src/sdk/ProjectContents.rst +++ /dev/null @@ -1,12 +0,0 @@ -.. _sdk: - -Project Reference -================== - -.. toctree:: - :maxdepth: 2 - - // 缺少: - cmake - vs2017 - qtcreator diff --git a/docs/src/sdk/contents.rst b/docs/src/sdk/contents.rst index a3561058..d13e7623 100644 --- a/docs/src/sdk/contents.rst +++ b/docs/src/sdk/contents.rst @@ -4,7 +4,9 @@ SDK .. toctree:: :maxdepth: 5 - platform - InstallContents - ProjectContentsToDos - changelog \ No newline at end of file + sdk_info + sdk_install + data/contents + control/contents + tools/contents + sdk_changelog diff --git a/docs/src/control/auto_exposure.rst b/docs/src/sdk/control/auto_exposure.rst similarity index 100% rename from docs/src/control/auto_exposure.rst rename to docs/src/sdk/control/auto_exposure.rst diff --git a/docs/src/control/contents.rst b/docs/src/sdk/control/contents.rst similarity index 80% rename from docs/src/control/contents.rst rename to docs/src/sdk/control/contents.rst index 573ca06c..143f2b8d 100644 --- a/docs/src/control/contents.rst +++ b/docs/src/sdk/control/contents.rst @@ -1,6 +1,6 @@ .. _ctrl: -MYNT® EYE Control +SDK Control Samples ================= .. toctree:: @@ -11,4 +11,4 @@ MYNT® EYE Control manual_exposure infrared imu_low_pass_filter - iic_address \ No newline at end of file + iic_address diff --git a/docs/src/control/framerate.rst b/docs/src/sdk/control/framerate.rst similarity index 100% rename from docs/src/control/framerate.rst rename to docs/src/sdk/control/framerate.rst diff --git a/docs/src/control/iic_address.rst b/docs/src/sdk/control/iic_address.rst similarity index 100% rename from docs/src/control/iic_address.rst rename to docs/src/sdk/control/iic_address.rst diff --git a/docs/src/control/imu_low_pass_filter.rst b/docs/src/sdk/control/imu_low_pass_filter.rst similarity index 100% rename from docs/src/control/imu_low_pass_filter.rst rename to docs/src/sdk/control/imu_low_pass_filter.rst diff --git a/docs/src/control/imu_range.rst b/docs/src/sdk/control/imu_range.rst similarity index 100% rename from docs/src/control/imu_range.rst rename to docs/src/sdk/control/imu_range.rst diff --git a/docs/src/control/infrared.rst b/docs/src/sdk/control/infrared.rst similarity index 98% rename from docs/src/control/infrared.rst rename to docs/src/sdk/control/infrared.rst index ab12e7e3..6d01e297 100644 --- a/docs/src/control/infrared.rst +++ b/docs/src/sdk/control/infrared.rst @@ -44,7 +44,7 @@ Reference running results on Linux: At this point, if the image is displayed, you can see IR speckle on the image, as below: -.. image:: ../../images/ir.png +.. image:: ../../../images/sdk/ir.png .. attention:: diff --git a/docs/src/control/manual_exposure.rst b/docs/src/sdk/control/manual_exposure.rst similarity index 100% rename from docs/src/control/manual_exposure.rst rename to docs/src/sdk/control/manual_exposure.rst diff --git a/docs/src/data/contents.rst b/docs/src/sdk/data/contents.rst similarity index 76% rename from docs/src/data/contents.rst rename to docs/src/sdk/data/contents.rst index b3e8c6c1..c441fa8d 100644 --- a/docs/src/data/contents.rst +++ b/docs/src/sdk/data/contents.rst @@ -1,5 +1,7 @@ -SDK SAMPLES -============== +.. _data: + +SDK Data Samples +================ .. toctree:: @@ -14,4 +16,4 @@ SDK SAMPLES get_imu get_imu_correspondence get_from_callbacks - get_with_plugin \ No newline at end of file + get_with_plugin diff --git a/docs/src/data/get_depth.rst b/docs/src/sdk/data/get_depth.rst similarity index 100% rename from docs/src/data/get_depth.rst rename to docs/src/sdk/data/get_depth.rst diff --git a/docs/src/data/get_device_info.rst b/docs/src/sdk/data/get_device_info.rst similarity index 100% rename from docs/src/data/get_device_info.rst rename to docs/src/sdk/data/get_device_info.rst diff --git a/docs/src/data/get_disparity.rst b/docs/src/sdk/data/get_disparity.rst similarity index 100% rename from docs/src/data/get_disparity.rst rename to docs/src/sdk/data/get_disparity.rst diff --git a/docs/src/data/get_from_callbacks.rst b/docs/src/sdk/data/get_from_callbacks.rst similarity index 100% rename from docs/src/data/get_from_callbacks.rst rename to docs/src/sdk/data/get_from_callbacks.rst diff --git a/docs/src/data/get_img_params.rst b/docs/src/sdk/data/get_img_params.rst similarity index 100% rename from docs/src/data/get_img_params.rst rename to docs/src/sdk/data/get_img_params.rst diff --git a/docs/src/data/get_imu.rst b/docs/src/sdk/data/get_imu.rst similarity index 100% rename from docs/src/data/get_imu.rst rename to docs/src/sdk/data/get_imu.rst diff --git a/docs/src/data/get_imu_correspondence.rst b/docs/src/sdk/data/get_imu_correspondence.rst similarity index 100% rename from docs/src/data/get_imu_correspondence.rst rename to docs/src/sdk/data/get_imu_correspondence.rst diff --git a/docs/src/data/get_imu_params.rst b/docs/src/sdk/data/get_imu_params.rst similarity index 100% rename from docs/src/data/get_imu_params.rst rename to docs/src/sdk/data/get_imu_params.rst diff --git a/docs/src/data/get_points.rst b/docs/src/sdk/data/get_points.rst similarity index 100% rename from docs/src/data/get_points.rst rename to docs/src/sdk/data/get_points.rst diff --git a/docs/src/data/get_stereo.rst b/docs/src/sdk/data/get_stereo.rst similarity index 100% rename from docs/src/data/get_stereo.rst rename to docs/src/sdk/data/get_stereo.rst diff --git a/docs/src/data/get_stereo_rectified.rst b/docs/src/sdk/data/get_stereo_rectified.rst similarity index 100% rename from docs/src/data/get_stereo_rectified.rst rename to docs/src/sdk/data/get_stereo_rectified.rst diff --git a/docs/src/data/get_with_plugin.rst b/docs/src/sdk/data/get_with_plugin.rst similarity index 100% rename from docs/src/data/get_with_plugin.rst rename to docs/src/sdk/data/get_with_plugin.rst diff --git a/docs/src/data/save_params.rst b/docs/src/sdk/data/save_params.rst similarity index 100% rename from docs/src/data/save_params.rst rename to docs/src/sdk/data/save_params.rst diff --git a/docs/src/data/write_img_params.rst b/docs/src/sdk/data/write_img_params.rst similarity index 100% rename from docs/src/data/write_img_params.rst rename to docs/src/sdk/data/write_img_params.rst diff --git a/docs/src/data/write_imu_params.rst b/docs/src/sdk/data/write_imu_params.rst similarity index 100% rename from docs/src/data/write_imu_params.rst rename to docs/src/sdk/data/write_imu_params.rst diff --git a/docs/src/firmware/from_v1.rst b/docs/src/sdk/from_v1.rst similarity index 94% rename from docs/src/firmware/from_v1.rst rename to docs/src/sdk/from_v1.rst index e5ee4949..3bc5d945 100644 --- a/docs/src/firmware/from_v1.rst +++ b/docs/src/sdk/from_v1.rst @@ -1,4 +1,4 @@ -.. _firmware_from_v1: +.. _sdk_from_v1: Change from SDK 1.x to 2.x =========================== diff --git a/docs/src/sdk/install_ros.rst b/docs/src/sdk/install_ros_wrapper.rst similarity index 97% rename from docs/src/sdk/install_ros.rst rename to docs/src/sdk/install_ros_wrapper.rst index fe57a646..adb02503 100644 --- a/docs/src/sdk/install_ros.rst +++ b/docs/src/sdk/install_ros_wrapper.rst @@ -1,7 +1,7 @@ -.. _sdk_install_ros: +.. _sdk_install_ros_wrapper: -ROS Installation -================ +ROS Wrapper Installation +======================== .. only:: html diff --git a/docs/src/sdk/ppa_install_ubuntu.rst b/docs/src/sdk/install_ubuntu_ppa.rst similarity index 95% rename from docs/src/sdk/ppa_install_ubuntu.rst rename to docs/src/sdk/install_ubuntu_ppa.rst index f97b7fbe..2d76a6df 100644 --- a/docs/src/sdk/ppa_install_ubuntu.rst +++ b/docs/src/sdk/install_ubuntu_ppa.rst @@ -1,6 +1,6 @@ -.. _sdk_ppa_install_ubuntu: +.. _sdk_install_ubuntu_ppa: -Ubuntu SDK PPA Installation +Ubuntu PPA Installation ============================ .. only:: html diff --git a/docs/src/sdk/source_install_ubuntu.rst b/docs/src/sdk/install_ubuntu_src.rst similarity index 98% rename from docs/src/sdk/source_install_ubuntu.rst rename to docs/src/sdk/install_ubuntu_src.rst index 30896224..745d27f6 100644 --- a/docs/src/sdk/source_install_ubuntu.rst +++ b/docs/src/sdk/install_ubuntu_src.rst @@ -1,6 +1,6 @@ -.. _sdk_source_install_ubuntu: +.. _sdk_install_ubuntu_src: -Ubuntu SDK Source Installation +Ubuntu Source Installation ============================== .. only:: html diff --git a/docs/src/sdk/exe_install_windows.rst b/docs/src/sdk/install_windows_exe.rst similarity index 96% rename from docs/src/sdk/exe_install_windows.rst rename to docs/src/sdk/install_windows_exe.rst index dd9f30d0..f232ba98 100644 --- a/docs/src/sdk/exe_install_windows.rst +++ b/docs/src/sdk/install_windows_exe.rst @@ -1,6 +1,6 @@ -.. _sdk_exe_install_windows: +.. _sdk_install_windows_exe: -Windows SDK exe Installation +Windows EXE Installation ============================= .. only:: html diff --git a/docs/src/sdk/source_install_windows.rst b/docs/src/sdk/install_windows_src.rst similarity index 97% rename from docs/src/sdk/source_install_windows.rst rename to docs/src/sdk/install_windows_src.rst index f99ac634..3793d2c1 100644 --- a/docs/src/sdk/source_install_windows.rst +++ b/docs/src/sdk/install_windows_src.rst @@ -1,6 +1,6 @@ -.. _sdk_source_install_windows: +.. _sdk_install_windows_src: -Windows SDK Source Installation +Windows Source Installation ================================ .. only:: html @@ -76,12 +76,12 @@ After installing Visual Studio, confirm that the following command can run in th Visual Studio Command Prompt can be opened from the Start menu, - .. image:: ../../images/vs_cmd_menu.png + .. image:: ../../images/sdk/vs_cmd_menu.png :width: 30% You can also open it from the Visual Studio Tools menu. - .. image:: ../../images/vs_cmd.png + .. image:: ../../images/sdk/vs_cmd.png :width: 40% However, if you do not have the Visual Studio 2015 Tools menu, you can add one yourself. @@ -99,7 +99,7 @@ After installing Visual Studio, confirm that the following command can run in th In Visual Studio command Prompt, you can use the compile command ``cl`` ``link`` ``lib`` ``msbuild``, etc.(need finish ``MSYS2``and ``Getting Source Code`` steps first) - .. image:: ../../images/vs_cmd_test.png + .. image:: ../../images/sdk/vs_cmd_test.png MSYS2 (provide Linux command) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/docs/src/sdk/changelog.rst b/docs/src/sdk/sdk_changelog.rst similarity index 99% rename from docs/src/sdk/changelog.rst rename to docs/src/sdk/sdk_changelog.rst index 4d9c86a9..cce16b16 100644 --- a/docs/src/sdk/changelog.rst +++ b/docs/src/sdk/sdk_changelog.rst @@ -1,13 +1,12 @@ .. _sdk_changelog: Change Log -========= +========== 2019-07-01(v2.3.9) ------------------- 1. Fix ros timestamp issue - 2019-05-20(v2.3.8) ------------------- 1. Improve VINS-Fusion supporting diff --git a/docs/src/sdk/SDKContents.rst b/docs/src/sdk/sdk_info.rst similarity index 55% rename from docs/src/sdk/SDKContents.rst rename to docs/src/sdk/sdk_info.rst index 2096f340..a194a7e0 100644 --- a/docs/src/sdk/SDKContents.rst +++ b/docs/src/sdk/sdk_info.rst @@ -1,4 +1,4 @@ -.. _sdk: +.. _sdk_info: SDK Description ================== @@ -6,4 +6,5 @@ SDK Description .. toctree:: :maxdepth: 2 - platform + support_platforms + without_opencv diff --git a/docs/src/sdk/sdk_install.rst b/docs/src/sdk/sdk_install.rst new file mode 100644 index 00000000..66acbc5f --- /dev/null +++ b/docs/src/sdk/sdk_install.rst @@ -0,0 +1,13 @@ +.. _sdk_install: + +SDK Installation +================== + +.. toctree:: + :maxdepth: 2 + + install_ubuntu_ppa + install_ubuntu_src + install_windows_exe + install_windows_src + install_ros_wrapper diff --git a/docs/src/sdk/LogContents.rst b/docs/src/sdk/sdk_projects.rst similarity index 59% rename from docs/src/sdk/LogContents.rst rename to docs/src/sdk/sdk_projects.rst index be51f694..6b147611 100644 --- a/docs/src/sdk/LogContents.rst +++ b/docs/src/sdk/sdk_projects.rst @@ -1,9 +1,7 @@ -.. _sdk: +.. _sdk_projects: -Change Log +Project Samples ================== .. toctree:: :maxdepth: 2 - - changelog diff --git a/docs/src/sdk/platform.rst b/docs/src/sdk/support_platforms.rst similarity index 95% rename from docs/src/sdk/platform.rst rename to docs/src/sdk/support_platforms.rst index 66cb0915..6fa7ce84 100644 --- a/docs/src/sdk/platform.rst +++ b/docs/src/sdk/support_platforms.rst @@ -1,4 +1,4 @@ -.. _sdk_platform: +.. _sdk_support_platforms: Supported Platforms ==================== diff --git a/docs/src/analytics/analytics_dataset.rst b/docs/src/sdk/tools/analytics_dataset.rst similarity index 100% rename from docs/src/analytics/analytics_dataset.rst rename to docs/src/sdk/tools/analytics_dataset.rst diff --git a/docs/src/analytics/analytics_imu.rst b/docs/src/sdk/tools/analytics_imu.rst similarity index 95% rename from docs/src/analytics/analytics_imu.rst rename to docs/src/sdk/tools/analytics_imu.rst index d5578b95..834c42b7 100644 --- a/docs/src/analytics/analytics_imu.rst +++ b/docs/src/sdk/tools/analytics_imu.rst @@ -29,7 +29,7 @@ Refer to run commands and results on Linux: The analysis result graph will be saved in the data set directory, as follows: -.. image:: ../../images/imu_analytics.png +.. image:: ../../../images/sdk/tools/imu_analytics.png In addition, the script specific options can be executed ``-h``: diff --git a/docs/src/analytics/analytics_stamp.rst b/docs/src/sdk/tools/analytics_stamp.rst similarity index 96% rename from docs/src/analytics/analytics_stamp.rst rename to docs/src/sdk/tools/analytics_stamp.rst index 2b6f8410..db155b6a 100644 --- a/docs/src/analytics/analytics_stamp.rst +++ b/docs/src/sdk/tools/analytics_stamp.rst @@ -42,7 +42,7 @@ Reference run commands and results on Linux: The analysis result graph will be saved in the dataset directory, as follows: -.. image:: ../../images/stamp_analytics.png +.. image:: ../../../images/sdk/tools/stamp_analytics.png In addition, the script specific options can be executed ``-h`` to understand: diff --git a/docs/src/analytics/contents.rst b/docs/src/sdk/tools/contents.rst similarity index 75% rename from docs/src/analytics/contents.rst rename to docs/src/sdk/tools/contents.rst index 0cb47844..9c0c922d 100644 --- a/docs/src/analytics/contents.rst +++ b/docs/src/sdk/tools/contents.rst @@ -1,4 +1,4 @@ -SDK TOOLS +SDK Tools ================== .. toctree:: @@ -6,4 +6,4 @@ SDK TOOLS analytics_dataset analytics_imu - analytics_stamp \ No newline at end of file + analytics_stamp diff --git a/docs/src/sdk/without_opencv.rst b/docs/src/sdk/without_opencv.rst index 35c80bbd..6a23e6f8 100644 --- a/docs/src/sdk/without_opencv.rst +++ b/docs/src/sdk/without_opencv.rst @@ -1,6 +1,6 @@ .. _sdk_without_opencv: -OpenCV independency +OpenCV Description =================== SDK provides a three-tier interface with OpenCV dependencies: diff --git a/docs/src/tools/calibration_tool.rst b/docs/src/tools/calibration_tool.rst index c1efc6e7..fd29d684 100644 --- a/docs/src/tools/calibration_tool.rst +++ b/docs/src/tools/calibration_tool.rst @@ -1,8 +1,7 @@ .. _calibration_tool: -MYNT EYE S Manual Calibration Tool -========== - +Calibration Tool Manual +======================= Introduction -------- @@ -15,7 +14,7 @@ Currently the calibration tool only supports Ubuntu 16.04 LTS, but support the o ==================== ==================== ====================== Platform Architecture Different dependence ==================== ==================== ====================== -Ubuntu 16.04 LTS x64(amd64) libopencv-dev +Ubuntu 16.04 LTS x64(amd64) libopencv-dev Ubuntu 16.04 LTS x64(amd64) ros-kinetic-opencv3 ==================== ==================== ====================== @@ -29,22 +28,22 @@ Deb/ppa installation package is available on Ubuntu. The architecture, dependenc * mynteye-s-calibrator-opencv-official-1.0.0_amd64.deb * mynteye-s-calibrator-opencv-ros-kinetic-1.0.0_amd64.deb -======================= ==================== ============================================================ -Dependency identifier Dependency package Detailed description ======================= ==================== ============================================================ -opencv-official libopencv-dev https://packages.ubuntu.com/xenial/libopencv-dev -opencv-ros-kinetic ros-kinetic-opencv3 http://wiki.ros.org/opencv3 +Dependency identifier Dependency package Detailed description +======================= ==================== ============================================================ +opencv-official libopencv-dev https://packages.ubuntu.com/xenial/libopencv-dev +opencv-ros-kinetic ros-kinetic-opencv3 http://wiki.ros.org/opencv3 ======================= ==================== ============================================================ 1.3 Deb Toolkit Get -------- -==================== ======================================================================== -Method of Obtaining Get address ==================== ======================================================================== -Baidu Cloud https://pan.baidu.com/s/19rW0fPKUlQj6eldZpZFoAA Extraction code: a6ps -Google Drive https://drive.google.com/open?id=1RsV2WEKAsfxbn-Z5nGjk5g3ml1UDEsDc +Method of Obtaining Get address +==================== ======================================================================== +Baidu Cloud https://pan.baidu.com/s/19rW0fPKUlQj6eldZpZFoAA Extraction code: a6ps +Google Drive https://drive.google.com/open?id=1RsV2WEKAsfxbn-Z5nGjk5g3ml1UDEsDc ==================== ======================================================================== @@ -96,7 +95,7 @@ If you encounter an error that the dependency package is not installed, for exam dependency problems - leaving unconfigured Errors were encountered while processing: mynteye-s-calibrator - + You can continue use sudo apt-get -f install to finished install .. code-block:: bash @@ -157,7 +156,7 @@ Options: -x WIDTH, --width=WIDTH The chessboard width, default: 11 -y HEIGHT, --height=HEIGHT The chessboard height, default: 7 -s METERS, --square=METERS The chessboard square size in meters, default: 0.036 --n NUMBER, --number=NUMBER The number of images to use for calibration, default: 11 +-n NUMBER, --number=NUMBER The number of imagestools to use for calibration, default: 11 -p PATH, --path=PATH The path to save the result, default: folder name using device's SN * -x -y -s Used to set the width, height, and grid size of the calibration plate. Width and height refer to the number of black and white intersections in the horizontal and vertical directions of the checkerboard. Square size in meters. @@ -170,43 +169,43 @@ Options: * Then, run the mynteye-s-calibrator command in the terminal. -.. image:: ../../images/calibration001.png +.. image:: ../../images/tools/calibration001.png :width: 60% * Follow the prompts to select an index for the camera's resolution, perform image calibration at this resolution * The S1030 camera only need calibrate 752*480 resolution. The S2100 camera need calibrate 2560*800 and 1280*400 resolutions. -* As far as possible, let the calibration plate cover the left and right eye images of the camera, -and take care of the surroundings (maximum distortion). The calibration tool will automatically +* As far as possible, let the calibration plate cover the left and right eye images of the camera, +and take care of the surroundings (maximum distortion). The calibration tool will automatically evaluate the qualified image for the calibration calculation and will indicate on the terminal how many have been selected. Reference acquisition image, as follows: -.. image:: ../../images/calibration002.png +.. image:: ../../images/tools/calibration002.png :width: 60% -.. image:: ../../images/calibration003.png +.. image:: ../../images/tools/calibration003.png :width: 60% -.. image:: ../../images/calibration004.png +.. image:: ../../images/tools/calibration004.png :width: 60% -.. image:: ../../images/calibration005.png +.. image:: ../../images/tools/calibration005.png :width: 60% -.. image:: ../../images/calibration006.png +.. image:: ../../images/tools/calibration006.png :width: 60% -* Note: p_x, p_y, size, skew respectively indicate the scale of the calibration plate on the x-axis, y-axis, +* Note: p_x, p_y, size, skew respectively indicate the scale of the calibration plate on the x-axis, y-axis, zoom, and tilt when the image is acquired. Make a point for reference. -* Once the number of images acquired by the calibration needs is reached, +* Once the number of images acquired by the calibration needs is reached, the calibration calculation will be performed. The output is as follows: -.. image:: ../../images/calibration007.png +.. image:: ../../images/tools/calibration007.png :width: 60% @@ -222,7 +221,7 @@ Reference acquisition image, as follows: * Finally, you will also be asked if you want to write to the camera device. Enter or `y` to confirm -.. image:: ../../images/calibration008.png +.. image:: ../../images/tools/calibration008.png :width: 60% * After writing to the device, you will be prompted with "Write to device done". diff --git a/docs/src/tools/contents.rst b/docs/src/tools/contents.rst index 9ad7c82e..8d8df5fb 100644 --- a/docs/src/tools/contents.rst +++ b/docs/src/tools/contents.rst @@ -1,8 +1,8 @@ .. _tools: TOOLS SUPPORT -======== +============== .. toctree:: - + calibration_tool diff --git a/docs/src/wrapper/ros.rst b/docs/src/wrapper/ros.rst index 8b07025c..31b9659e 100644 --- a/docs/src/wrapper/ros.rst +++ b/docs/src/wrapper/ros.rst @@ -3,7 +3,7 @@ How to use ROS ============== -Compile and run the node according to :ref:`sdk_install_ros` . +Compile and run the node according to :ref:`sdk_install_ros_wrapper` . .. tip::