Skip to content
This repository has been archived by the owner on Jan 7, 2023. It is now read-only.

Commit

Permalink
update docs (#28)
Browse files Browse the repository at this point in the history
  • Loading branch information
ahuizxc authored and yechun1 committed Jul 19, 2019
1 parent d0b85f3 commit ed08720
Show file tree
Hide file tree
Showing 13 changed files with 20 additions and 9 deletions.
Binary file modified docs/doctrees/environment.pickle
Binary file not shown.
Binary file modified docs/doctrees/index.doctree
Binary file not shown.
Binary file modified docs/doctrees/pages/navigation.doctree
Binary file not shown.
Binary file modified docs/doctrees/pages/oa.doctree
Binary file not shown.
Binary file modified docs/doctrees/pages/vino.doctree
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/html/_sources/index.rst.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. robot_sdk_tutorial documentation master file, created by
.. robot_devkit_tutorial documentation master file, created by
sphinx-quickstart on Mon May 13 15:16:06 2019.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Expand Down
4 changes: 2 additions & 2 deletions docs/html/_sources/pages/navigation.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Example: See `turtlebot3_gazebo models`_ for details.
source /opt/robot_devkit/robot_devkit_setup.bash
export GAZEBO_MODEL_PATH=$GAZEBO_MODEL_PATH:~/robot_devkit/rdk_ws/turtlebot3_ws/src/turtlebot3/turtlebot3_simulations/turtlebot3_gazebo/models/
gazebo --verbose -s libgazebo_ros_init.so $HOME/robot_devkit/rdk_ws/turtlebot3_ws/src/navigation2/navigation2/nav2_system_tests/words/turtlebot3_ros2_demo.world
gazebo --verbose -s libgazebo_ros_init.so $HOME/robot_devkit/rdk_ws/turtlebot3_ws/src/navigation2/navigation2/nav2_system_tests/worlds/turtlebot3_ros2_demo.world
**view result at rviz2 and gazebo**

Expand All @@ -67,7 +67,7 @@ Example: See `turtlebot3_gazebo`_ for details.
source /opt/robot_devkit/robot_devkit_setup.bash
# Launch the nav2 system
ros2 launch nav2_bringup nav2_bringup_launch.py use_sim_time:=True autostart:=True \
map:=$HOME/robot_devkit/rdk_ws/turtlebot3_ws/src/navigation2/navigation2/nav2_system_tests/maps/map_circular.pgm
map:=$HOME/robot_devkit/rdk_ws/turtlebot3_ws/src/navigation2/navigation2/nav2_system_tests/maps/map_circular.yaml
**Terminal 4: Run RViz with navigation2 config file**

Expand Down
2 changes: 1 addition & 1 deletion docs/html/_sources/pages/oa.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ default, backend of object detection is Intel® movidius ncs2.
.. code:: bash
# Start OA demo with OpenVINO
source /opt/robot_sdk/robot_sdk_setup.bash
source /opt/robot_devkit/robot_devkit_setup.bash
ros2 launch object_analytics_node object_analytics_with_openvino_sdk.launch.py
**OA demo video:**
Expand Down
7 changes: 6 additions & 1 deletion docs/html/_sources/pages/vino.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ Currently, the inference feature list is supported:
|Person Reidentification |Person Reidentification based on object detection. |
+------------------------+---------------------------------------------------------------------------------------------------+

.. note::
.. note::
For preparing and optimizing your own trained model, you can follow this instruction `Model Optimizer Developer Guide`_.


Expand Down Expand Up @@ -155,6 +155,11 @@ OpenCV based image window is natively supported by the package. To enable window
5. Launching
------------

**source enviroment**
.. code::
source /opt/intel/openvino/bin/setupvars.sh
export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/opt/intel/openvino/deployment_tools/inference_engine/samples/build/intel64/Release/lib
* run face detection sample code input from StandardCamera.(connect Intel® Neural Compute Stick 2)

ros2 launch dynamic_vino_sample pipeline_people_myriad.launch.py
Expand Down
4 changes: 2 additions & 2 deletions docs/html/pages/navigation.html
Original file line number Diff line number Diff line change
Expand Up @@ -212,7 +212,7 @@ <h4>Pre-requisites:<a class="headerlink" href="#pre-requisites" title="Permalink
<p>Example: See <a class="reference external" href="https://github.com/ROBOTIS-GIT/turtlebot3_simulations/tree/ros2/turtlebot3_gazebo/models">turtlebot3_gazebo models</a> for details.</p>
<div class="code bash highlight-default notranslate"><div class="highlight"><pre><span></span>source /opt/robot_devkit/robot_devkit_setup.bash
export GAZEBO_MODEL_PATH=$GAZEBO_MODEL_PATH:~/robot_devkit/rdk_ws/turtlebot3_ws/src/turtlebot3/turtlebot3_simulations/turtlebot3_gazebo/models/
gazebo --verbose -s libgazebo_ros_init.so $HOME/robot_devkit/rdk_ws/turtlebot3_ws/src/navigation2/navigation2/nav2_system_tests/words/turtlebot3_ros2_demo.world
gazebo --verbose -s libgazebo_ros_init.so $HOME/robot_devkit/rdk_ws/turtlebot3_ws/src/navigation2/navigation2/nav2_system_tests/worlds/turtlebot3_ros2_demo.world
</pre></div>
</div>
<p><strong>view result at rviz2 and gazebo</strong></p>
Expand All @@ -228,7 +228,7 @@ <h4>Pre-requisites:<a class="headerlink" href="#pre-requisites" title="Permalink
<div class="code bash highlight-default notranslate"><div class="highlight"><pre><span></span>source /opt/robot_devkit/robot_devkit_setup.bash
# Launch the nav2 system
ros2 launch nav2_bringup nav2_bringup_launch.py use_sim_time:=True autostart:=True \
map:=$HOME/robot_devkit/rdk_ws/turtlebot3_ws/src/navigation2/navigation2/nav2_system_tests/maps/map_circular.pgm
map:=$HOME/robot_devkit/rdk_ws/turtlebot3_ws/src/navigation2/navigation2/nav2_system_tests/maps/map_circular.yaml
</pre></div>
</div>
<p><strong>Terminal 4: Run RViz with navigation2 config file</strong></p>
Expand Down
2 changes: 1 addition & 1 deletion docs/html/pages/oa.html
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,7 @@ <h2>1. Overview<a class="headerlink" href="#overview" title="Permalink to this h
<h2>2. Running the demo<a class="headerlink" href="#running-the-demo" title="Permalink to this headline"></a></h2>
<p><strong>Object Analytics with OpenVINO toolkit</strong></p>
<div class="code bash highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># Start OA demo with OpenVINO</span>
<span class="n">source</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">robot_sdk</span><span class="o">/</span><span class="n">robot_sdk_setup</span><span class="o">.</span><span class="n">bash</span>
<span class="n">source</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">robot_devkit</span><span class="o">/</span><span class="n">robot_devkit_setup</span><span class="o">.</span><span class="n">bash</span>
<span class="n">ros2</span> <span class="n">launch</span> <span class="n">object_analytics_node</span> <span class="n">object_analytics_with_openvino_sdk</span><span class="o">.</span><span class="n">launch</span><span class="o">.</span><span class="n">py</span>
</pre></div>
</div>
Expand Down
6 changes: 6 additions & 0 deletions docs/html/pages/vino.html
Original file line number Diff line number Diff line change
Expand Up @@ -377,6 +377,12 @@ <h4>Image Window<a class="headerlink" href="#image-window" title="Permalink to t
</div>
<div class="section" id="launching">
<h2>5. Launching<a class="headerlink" href="#launching" title="Permalink to this headline"></a></h2>
<p><strong>source enviroment</strong>
.. code:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>source /opt/intel/openvino/bin/setupvars.sh
export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/opt/intel/openvino/deployment_tools/inference_engine/samples/build/intel64/Release/lib
</pre></div>
</div>
<ul>
<li><p class="first">run face detection sample code input from StandardCamera.(connect Intel® Neural Compute Stick 2)</p>
<blockquote>
Expand Down
2 changes: 1 addition & 1 deletion docs/html/searchindex.js

Large diffs are not rendered by default.

0 comments on commit ed08720

Please sign in to comment.