From c8f7900e95e305516c29cd4952820afd25156bc2 Mon Sep 17 00:00:00 2001 From: John Zhao Date: Sun, 15 Apr 2018 22:16:22 +0800 Subject: [PATCH] Update guide docs --- doc/zh-Hans/api.doxyfile | 2 ++ doc/zh-Hans/guide_ros.md | 30 +++++++++++++++++++++++++++++ doc/zh-Hans/guide_tools.md | 39 ++++++++++++++++++++++++++++++++++++++ doc/zh-Hans/guides.md | 2 ++ 4 files changed, 73 insertions(+) create mode 100644 doc/zh-Hans/guide_ros.md create mode 100644 doc/zh-Hans/guide_tools.md diff --git a/doc/zh-Hans/api.doxyfile b/doc/zh-Hans/api.doxyfile index 83fb421..5f2b81d 100644 --- a/doc/zh-Hans/api.doxyfile +++ b/doc/zh-Hans/api.doxyfile @@ -794,8 +794,10 @@ INPUT = mainpage.md \ guides.md \ guide_build_linux.md \ guide_samples.md \ + guide_tools.md \ guide_log.md \ guide_opencv.md \ + guide_ros.md \ specs_data.md \ spec_hardware_info.md \ spec_image_params.md \ diff --git a/doc/zh-Hans/guide_ros.md b/doc/zh-Hans/guide_ros.md new file mode 100644 index 0000000..534f94a --- /dev/null +++ b/doc/zh-Hans/guide_ros.md @@ -0,0 +1,30 @@ +# ROS 封装 {#guide_ros} + +ROS 封装实现在 ``/wrappers/ros`` 目录。 + +## 依赖 + +* [ROS](http://www.ros.org/) 环境。 + +## 编译 + +```bash +cd +make ros +``` + +## 运行 + +运行发布节点, + +```bash +source wrappers/ros/devel/setup.bash +roslaunch mynt_eye_ros_wrapper mynteye.launch +``` + +运行发布节点,同时打开 RViz 预览图像, + +```bash +source wrappers/ros/devel/setup.bash +roslaunch mynt_eye_ros_wrapper display.launch +``` diff --git a/doc/zh-Hans/guide_tools.md b/doc/zh-Hans/guide_tools.md new file mode 100644 index 0000000..3ad7f61 --- /dev/null +++ b/doc/zh-Hans/guide_tools.md @@ -0,0 +1,39 @@ +# 工具 {#guide_tools} + +样例在 `/tools` 目录,其提供一些有用的工具。 + +## 准备 + +```bash +make tools + +cd tools/ +sudo pip install -r requirements.txt +``` + +## 录制数据集 + +```bash +./tools/_output/bin/dataset/record +``` + +默认录制进 `dataset` 目录,加参数可指定该目录。 + +## 分析数据集 + +分析 IMU 数据, + +```bash +python tools/analytics/imu_analytics.py -i dataset -c tools/config/mynteye/mynteye_config.yaml \ +-al=-1.2,1.2 -gl= -gdu=d -gsu=d -kl= +``` + +分析图像 & IMU 时间戳, + +```bash +python tools/analytics/stamp_analytics.py -i dataset -c tools/config/mynteye/mynteye_config.yaml +``` + +## 结语 + +如果用 ROS ,分析脚本也支持 ROS Bag 格式。关于 ROS 的录制和分析,请见 `tools/README.md` 。 diff --git a/doc/zh-Hans/guides.md b/doc/zh-Hans/guides.md index df21aad..b1b46b7 100644 --- a/doc/zh-Hans/guides.md +++ b/doc/zh-Hans/guides.md @@ -2,5 +2,7 @@ * @subpage guide_build_linux * @subpage guide_samples +* @subpage guide_tools * @subpage guide_log * @subpage guide_opencv +* @subpage guide_ros