tami/MYNT-EYE-S-SDK
6
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs(*): update docs

Browse Source
This commit is contained in:
John Zhao 2019-06-04 10:08:13 +08:00
parent 7ef64208be
commit 82719ed1f0
46 changed files with 199 additions and 99 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/api/api.rst
View File

@ -1,3 +1,5 @@
.. _api:
API API
=== ===

12
docs/api/contents.rst
View File

@ -1,12 +0,0 @@
.. _api:
API DOC
=========
.. toctree::
api
device
enums
types
utils

2
docs/api/device.rst
View File

@ -1,3 +1,5 @@
.. _device:
Device Device
====== ======

2
docs/api/enums.rst
View File

@ -1,3 +1,5 @@
.. _enums:
Enums Enums
===== =====

2
docs/api/types.rst
View File

@ -1,3 +1,5 @@
.. _types:
Types Types
===== =====

2
docs/api/utils.rst
View File

@ -1,3 +1,5 @@
.. _utils:
Utils Utils
===== =====

89
docs/index.rst
View File

@ -7,19 +7,84 @@ MYNT® EYE S SDK
=============== ===============
.. toctree:: .. toctree::
:maxdepth: 2 :caption: Product
:titlesonly: :maxdepth: 6
src/mynteye/contents src/mynteye/product_description
src/sdk/contents src/mynteye/product_surface
src/firmware/contents src/mynteye/pro_intro
src/data/contents src/mynteye/support_resolutions
src/control/contents src/mynteye/imu_coord
src/log/contents
src/wrapper/contents .. toctree::
src/analytics/contents :caption: SDK
src/slam/contents :maxdepth: 5
api/contents
src/sdk/SDKContents
src/sdk/InstallContents
src/sdk/ProjectContents
src/sdk/LogContents
.. toctree::
:caption: Firmware
:maxdepth: 4
src/firmware/FirmwareContents
src/firmware/FirmwareUpdate
src/firmware/UpdateLog
.. toctree::
:caption: SDK Sample
:maxdepth: 13
src/data/get_device_info
src/data/get_img_params
src/data/get_imu_params
src/data/get_stereo
src/data/get_stereo_rectified
src/data/ get_disparity
src/data/get_depth
src/data/get_points
src/data/get_imu
src/data/get_imu_correspondence
src/data/get_from_callbacks
src/data/get_with_plugin
.. toctree::
:caption: SDK Tools
:maxdepth: 3
src/analytics/analytics_dataset
src/analytics/analytics_imu
src/analytics/analytics_stamp
.. toctree::
:caption: Open Source Support
:maxdepth: 7
src/slam/vins
src/slam/vins_fusion
src/slam/orb_slam2
src/slam/okvis
src/slam/viorb
src/slam/maplab
.. toctree::
:caption: API DOC
:maxdepth: 6
api/api
api/device
api/enums
api/types
api/utils
.. toctree::
:caption: Technical Support
:maxdepth: 3
api/api
api/device
.. ..
Indices and tables Indices and tables

4
docs/src/analytics/dataset.rst → docs/src/analytics/analytics_dataset.rst
View File

@ -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>`_ . 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>`_ .

2
docs/src/analytics/analytics_stamp.rst
View File

@ -1,6 +1,6 @@
.. _analytics_stamp: .. _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>`_ . 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>`_ .

10
docs/src/analytics/contents.rst
View File

@ -1,10 +0,0 @@
.. _analytics:
Data Analytics
===============
.. toctree::
dataset
analytics_imu
analytics_stamp

2
docs/src/data/get_depth.rst
View File

@ -1,4 +1,4 @@
.. _get_depth: .. _data_get_depth:
Get depth image Get depth image
=============== ===============

2
docs/src/data/get_device_info.rst
View File

@ -1,4 +1,4 @@
.. _get_device_info: .. _data_get_device_info:
Get device information Get device information
====================== ======================

2
docs/src/data/get_disparity.rst
View File

@ -1,4 +1,4 @@
.. _get_disparity: .. _data_get_disparity:
Get disparity image Get disparity image
=================== ===================

2
docs/src/data/get_from_callbacks.rst
View File

@ -1,4 +1,4 @@
.. _get_from_callbacks: .. _data_get_from_callbacks:
Get data from callbacks Get data from callbacks
======================== ========================

2
docs/src/data/get_img_params.rst
View File

@ -1,4 +1,4 @@
.. _get_img_params: .. _data_get_img_params:
Get image calibration parameters Get image calibration parameters
================================ ================================

2
docs/src/data/get_imu.rst
View File

@ -1,4 +1,4 @@
.. _get_imu_data: .. _data_get_imu_data:
Get IMU data Get IMU data
============= =============

2
docs/src/data/get_imu_correspondence.rst
View File

@ -1,4 +1,4 @@
.. _get_imu_correspondence: .. _data_get_imu_correspondence:
Get IMU data with timestamp correspondence Get IMU data with timestamp correspondence
=========================================== ===========================================

2
docs/src/data/get_imu_params.rst
View File

@ -1,4 +1,4 @@
.. _get_imu_params: .. _data_get_imu_params:
Get IMU calibration parameters Get IMU calibration parameters
============================== ==============================

2
docs/src/data/get_points.rst
View File

@ -1,4 +1,4 @@
.. _get_points: .. _data_get_points:
Get point image Get point image
================ ================

2
docs/src/data/get_stereo.rst
View File

@ -1,4 +1,4 @@
.. _get_stereo: .. _data_get_stereo:
Get original binocular image Get original binocular image
============================= =============================

2
docs/src/data/get_stereo_rectified.rst
View File

@ -1,4 +1,4 @@
.. _get_stereo_rectified: .. _data_get_stereo_rectified:
Get stereo camera correction image Get stereo camera correction image
================================== ==================================

2
docs/src/data/get_with_plugin.rst
View File

@ -1,4 +1,4 @@
.. _get_with_plugin: .. _data_get_with_plugin:
Using the plugin to get data Using the plugin to get data
============================ ============================

2
docs/src/data/save_params.rst
View File

@ -1,4 +1,4 @@
.. _save_params: .. _data_save_params:
Save device infomation and parameters Save device infomation and parameters
===================================== =====================================

2
docs/src/data/write_img_params.rst
View File

@ -1,4 +1,4 @@
.. _write_img_params: .. _data_write_img_params:
Write image parameters Write image parameters
======================= =======================

2
docs/src/data/write_imu_params.rst
View File

@ -1,4 +1,4 @@
.. _write_imu_params: .. _data_write_imu_params:
Write IMU parameters Write IMU parameters
===================== =====================

9
docs/src/firmware/FirmwareContents.rst Normal file
View File

@ -0,0 +1,9 @@
.. _firmware:
Firmware Description
==================
.. toctree::
:maxdepth: 2
applicable

6
docs/src/firmware/contents.rst → docs/src/firmware/FirmwareUpdate.rst
View File

@ -1,11 +1,11 @@
.. _firmware: .. _firmware:
MYNT® EYE Firmware Upgrade Firmware
================== ==================
.. toctree:: .. toctree::
:maxdepth: 2
applicable
upgrade upgrade
stm_update stm_update
from_v1.rst from_v1

5
docs/src/firmware/UpdateLog.rst Normal file
View File

@ -0,0 +1,5 @@
Update Log
==================
.. toctree::
:maxdepth: 2

2
docs/src/firmware/from_v1.rst
View File

@ -1,4 +1,4 @@
.. _sdk_from_v1: .. _firmware_from_v1:
Change from SDK 1.x to 2.x Change from SDK 1.x to 2.x
=========================== ===========================

14
docs/src/mynteye/contents.rst
View File

@ -1,14 +0,0 @@
.. _mynteye:
MYNT® EYE product introduction
==============================
.. toctree::
intro
surface_s1030
imu_coord_s1030
spec_s1030
surface_s2100
imu_coord_s2100
spec_s2100

11
docs/src/mynteye/imu_coord.rst Normal file
View File

@ -0,0 +1,11 @@
.. _mynteye:
IMU Coordinata System
==================
.. toctree::
:maxdepth: 2
imu_coord_s1030
imu_coord_s2100

10
docs/src/mynteye/pro_intro.rst Normal file
View File

@ -0,0 +1,10 @@
.. _mynteye:
Product Introduction
==============================
.. toctree::
:maxdepth: 2
spec_s1030
spec_s2100

4
docs/src/mynteye/intro.rst → docs/src/mynteye/product_description.rst
View File

@ -1,6 +1,6 @@
.. _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. 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.

11
docs/src/mynteye/product_surface.rst Normal file
View File

@ -0,0 +1,11 @@
.. _mynteye:
Surface
==================
.. toctree::
:maxdepth: 2
surface_s1030
surface_s2100

12
docs/src/sdk/contents.rst → docs/src/sdk/InstallContents.rst
View File

@ -1,16 +1,14 @@
.. _sdk: .. _sdk:
MYNT® EYE SDK Installation and Use
============= ==================
.. toctree:: .. toctree::
:maxdepth: 2
changelog
platform
ppa_install_ubuntu ppa_install_ubuntu
exe_install_windows
source_install_ubuntu source_install_ubuntu
exe_install_windows
source_install_windows source_install_windows
install_macos
install_ros install_ros
without_opencv without_opencv

9
docs/src/sdk/LogContents.rst Normal file
View File

@ -0,0 +1,9 @@
.. _sdk:
Update Log
==================
.. toctree::
:maxdepth: 2
changelog

12
docs/src/sdk/ProjectContents.rst Normal file
View File

@ -0,0 +1,12 @@
.. _sdk:
Program Reference
==================
.. toctree::
:maxdepth: 2
// 缺少:
cmake
vs2017
qtcreator

9
docs/src/sdk/SDKContents.rst Normal file
View File

@ -0,0 +1,9 @@
.. _sdk:
SDK Description
==================
.. toctree::
:maxdepth: 2
platform

2
docs/src/sdk/platform.rst
View File

@ -1,4 +1,4 @@
.. _sdk_platform: .. _sdk:
Supported platforms Supported platforms
==================== ====================

13
docs/src/slam/contents.rst
View File

@ -1,13 +0,0 @@
.. _slam:
Open Source project Support
============================
.. toctree::
vins
vins_fusion
orb_slam2
okvis
viorb
maplab

2
docs/src/slam/maplab.rst
View File

@ -1,4 +1,4 @@
.. _slam_maplab: .. _maplab:
How to use in `Maplab <https://github.com/ethz-asl/maplab>`_ x How to use in `Maplab <https://github.com/ethz-asl/maplab>`_ x
=============================================================== ===============================================================

2
docs/src/slam/okvis.rst
View File

@ -1,4 +1,4 @@
.. _slam_okvis: .. _okvis:
How to use in `OKVIS <https://github.com/ethz-asl/okvis>`_ How to use in `OKVIS <https://github.com/ethz-asl/okvis>`_
============================================================= =============================================================

2
docs/src/slam/orb_slam2.rst
View File

@ -1,4 +1,4 @@
.. _slam_orb_slam2: .. _orb_slam2:
How to use in `ORB_SLAM2 <https://github.com/raulmur/ORB_SLAM2>`_ How to use in `ORB_SLAM2 <https://github.com/raulmur/ORB_SLAM2>`_
================================================================== ==================================================================

2
docs/src/slam/vins.rst
View File

@ -1,4 +1,4 @@
.. _slam_vins: .. _vins:
How to use in `VINS-Mono <https://github.com/HKUST-Aerial-Robotics/VINS-Mono>`_ How to use in `VINS-Mono <https://github.com/HKUST-Aerial-Robotics/VINS-Mono>`_
================================================================================ ================================================================================

2
docs/src/slam/vins_fusion.rst
View File

@ -1,4 +1,4 @@
.. _slam_vins_fusion: .. _vins_fusion:
How to use in `VINS-Fusion <https://github.com/HKUST-Aerial-Robotics/Vins-Fusion>`_ How to use in `VINS-Fusion <https://github.com/HKUST-Aerial-Robotics/Vins-Fusion>`_
==================================================================================== ====================================================================================

2
docs/src/slam/viorb.rst
View File

@ -1,4 +1,4 @@
.. _slam_viorb: .. _viorb:
How to use in `VIORB <https://github.com/jingpang/LearnVIORB>`_ How to use in `VIORB <https://github.com/jingpang/LearnVIORB>`_
================================================================ ================================================================