Files
OrbbecSDK_ROS2/en/.doctrees/source/camera_devices/3_quickstarts/quickstart.doctree
T

30 lines
13 KiB
Plaintext
Raw Normal View History

2026-01-04 01:12:38 +00:00
€•â3Œdocutils.nodes”Œdocument”“”)�”}”(Œ rawsource”Œ”Œchildren”]”hŒsection”“”)�”}”(hhh]”(hŒtitle”“”)�”}”(hŒROS Package QuickStarts”h]”hŒText”“”ŒROS Package QuickStarts”…”�”}”(Œparent”hŒ _document”hŒsource”NŒline”NubaŒ
attributes”}”(Œids”]”Œclasses”]”Œnames”]”Œdupnames”]”Œbackrefs”]”uŒtagname”hhKhh hŒi/home/runner/work/OrbbecSDK_ROS2/OrbbecSDK_ROS2/docs/en/source/camera_devices/3_quickstarts/quickstart.md”ubh
2025-10-22 03:11:03 +00:00
)�”}”(hhh]”(h)�”}”(hŒ Introduction”h]”hŒ Introduction”…”�”}”(hh/hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*hhKhh,hh+ubhŒ paragraph”“”)�”}”(hŒ]This section provides a quick start to using the Orbbec ROS 2 wrapper.
You will learn how to:”h]”(hŒFThis section provides a quick start to using the Orbbec ROS 2 wrapper.”…”�”}”(hh?hhhNhNubhŒ
”…”�”}”(hh?hhhNhNubhŒYou will learn how to:”…”�”}”(hh?hhhNhNubeh}”(h ]”h"]”h$]”h&]”h(]”uh*h=hKhh,hhhh+ubhŒ bullet_list”“”)�”}”(hhh]”(hŒ list_item”“”)�”}”(hhh]”h>)�”}”(hŒLaunch a camera node.”h]”hŒLaunch a camera node.”…”�”}”(hh_hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h=hKhh\hhhh+ubah}”(h ]”h"]”h$]”h&]”h(]”uh*hZhKhhWhhhh+ubh[)�”}”(hhh]”h>)�”}”(hŒ'Visualize depth/color streams in RViz2.”h]”(hŒ!Visualize depth/color streams in ”…”�”}”(hhvhhhNhNubhŒstrong”“”)�”}”(hŒRViz2”h]”hŒRViz2”…”�”}”(hh€hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h~hhvhhhh+hKubhŒ.”…”�”}”(hhvhhhNhNubeh}”(h ]”h"]”h$]”h&]”h(]”uh*h=hK hhshhhh+ubah}”(h ]”h"]”h$]”h&]”h(]”uh*hZhK hhWhhhh+ubh[)�”}”(hhh]”h>)�”}”(hŒ8Interact with topics and services using ROS 2 CLI tools.”h]”(hŒ(Interact with topics and services using ”…”�”}”(hh¡hhhNhNubh)�”}”(hŒROS 2 CLI tools”h]”hŒROS 2 CLI tools”…”�”}”(hh©hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h~hh¡hhhh+hKubhŒ.”…”�”}”(hh¡hhhNhNubeh}”(h ]”h"]”h$]”h&]”h(]”uh*h=hK
hhžhhhh+ubah}”(h ]”h"]”h$]”h&]”h(]”uh*hZhK
hhWhhhh+ubeh}”(h ]”h"]”h$]”h&]”h(]”uh*hUhKhh,hhhh+ubeh}”(h ]”Œ introduction”ah"]”h$]”Œ introduction”ah&]”h(]”uh*h hKhh hhhh+ubhŒ
transition”“”)�”}”(hhh]”h}”(h ]”h"]”h$]”h&]”h(]”uh*hÕhh hhhh+hKubh
)�”}”(hhh]”(h)�”}”(hŒ#Build your First Camera Application”h]”hŒ#Build your First Camera Application”…”�”}”(hhãhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*hhKhhàhh+ubh
2025-12-01 02:24:40 +00:00
)�”}”(hhh]”(h)�”}”(hŒ"Step 1: Source ROS 2 and Workspace”h]”hŒ"Step 1: Source ROS 2 and Workspace”…”�”}”(hhôhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*hhKhhñhh+ubh>)�”}”(hŒ;Make sure ROS 2 and your workspace environment are sourced:”h]”hŒ;Make sure ROS 2 and your workspace environment are sourced:”…”�”}”(hjhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h=hKhhñhhhh+ubhŒ
literal_block”“”)�”}”(hŒ&source /opt/ros/$ROS_DISTRO/setup.bash”h]”hŒ&source /opt/ros/$ROS_DISTRO/setup.bash”…”�”}”hjsbah}”(h ]”h"]”h$]”h&]”h(]”Œlanguage”Œbash”Œ xml:space”Œpreserve”uh*jhhñhhhh+hKubh>)�”}”(hŒSource code build requirements”h]”hŒSource code build requirements”…”�”}”(hj$hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h=hKhhñhhhh+ubj)�”}”(hŒ#source ~/ros2_ws/install/setup.bash”h]”hŒ#source ~/ros2_ws/install/setup.bash”…”�”}”hj2sbah}”(h ]”h"]”h$]”h&]”h(]”Œlanguage”Œbash”j"j#uh*jhhñhhhh+hKubeh}”(h ]”Œ!step-1-source-ros-2-and-workspace”ah"]”h$]”Œ"step 1: source ros 2 and workspace”ah&]”h(]”uh*h hKhhàhhhh+ubh
2025-10-22 03:11:03 +00:00
)�”}”(hhh]”(h)�”}”(hŒStep 2: Launch the Camera Node”h]”hŒStep 2: Launch the Camera Node”…”�”}”(hjMhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*hhKhjJhh+ubhV)�”}”(hhh]”h[)�”}”(hhh]”h>)�”}”(hŒ
On terminal 1”h]”hŒ
On terminal 1”…”�”}”(hjahhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h=hK hj^hhhh+ubah}”(h ]”h"]”h$]”h&]”h(]”uh*hZhK hj[hhhh+ubah}”(h ]”h"]”h$]”h&]”h(]”uh*hUhK hjJhhhh+ubj)�”}”(hŒ¿. ./install/setup.bash
2025-12-01 02:24:40 +00:00
ros2 run orbbec_camera list_devices_node #Check if the camera is connected
ros2 launch orbbec_camera gemini_330_series.launch.py # Or other launch file, see below table”h]”hŒ¿. ./install/setup.bash
ros2 run orbbec_camera list_devices_node #Check if the camera is connected
ros2 launch orbbec_camera gemini_330_series.launch.py # Or other launch file, see below table”…”�”}”hj{sbah}”(h ]”h"]”h$]”h&]”h(]”Œlanguage”Œbash”j"j#uh*jhjJhhhh+hKubh>)�”}”(hŒJIf you have multiple cameras connected, you can specify the serial number:”h]”(hŒ<If you have multiple cameras connected, you can specify the ”…”�”}”(hj‹hhhNhNubh)�”}”(hŒ
2025-10-22 03:11:03 +00:00
serial number”h]”hŒ
serial number”…”�”}”(hj“hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h~hj‹hhhh+hKubhŒ:”…”�”}”(hj‹hhhNhNubeh}”(h ]”h"]”h$]”h&]”h(]”uh*h=hK(hjJhhhh+ubj)�”}”(hŒSros2 launch orbbec_camera gemini_330_series.launch.py serial_number:=<YourCameraSN>”h]”hŒSros2 launch orbbec_camera gemini_330_series.launch.py serial_number:=<YourCameraSN>”…”�”}”hj«sbah}”(h ]”h"]”h$]”h&]”h(]”Œlanguage”Œbash”j"j#uh*jhjJhhhh+hKubeh}”(h ]”Œstep-2-launch-the-camera-node”ah"]”h$]”Œstep 2: launch the camera node”ah&]”h(]”uh*h hKhhàhhhh+ubh
)�”}”(hhh]”(h)�”}”(hŒStep 3: Visualize in RViz2”h]”hŒStep 3: Visualize in RViz2”…”�”}”(hjÆhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*hhK.hjÃhh+ubh>)�”}”(hŒ)Launch RViz2 and load the default config:”h]”hŒ)Launch RViz2 and load the default config:”…”�”}”(hjÔhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h=hK0hjÃhhhh+ubhV)�”}”(hhh]”h[)�”}”(hhh]”h>)�”}”(hŒ
2025-12-01 02:24:40 +00:00
On terminal 2”h]”hŒ
On terminal 2”…”�”}”(hjèhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h=hK2hjåhhhh+ubah}”(h ]”h"]”h$]”h&]”h(]”uh*hZhK2hjâhhhh+ubah}”(h ]”h"]”h$]”h&]”h(]”uh*hUhK2hjÃhhhh+ubj)�”}”(hŒrviz2”h]”hŒrviz2”…”�”}”hjsbah}”(h ]”h"]”h$]”h&]”h(]”Œlanguage”Œbash”j"j#uh*jhjÃhhhh+hKubhV)�”}”(hhh]”(h[)�”}”(hhh]”h>)�”}”(hŒ;Add an Image display, set topic to /camera/color/image_raw.”h]”(hŒAdd an ”…”�”}”(hjhhhNhNubh)�”}”(hŒImage”h]”hŒImage”…”�”}”(hj hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h~hjhhhh+hKubhŒ display, set topic to ”…”�”}”(hjhhhNhNubhŒliteral”“”)�”}”(hŒ/camera/color/image_raw”h]”hŒ/camera/color/image_raw”…”�”}”(hj4hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*j2hjhhhh+hKubhŒ.”…”�”}”(hjhhhNhNubeh}”(h ]”h"]”h$]”h&]”h(]”uh*h=hK8hjhhhh+ubah}”(h ]”h"]”h$]”h&]”h(]”uh*hZhK8hjhhhh+ubh[)�”}”(hhh]”h>)�”}”(hŒ6Add another Image display for /camera/depth/image_raw.”h]”(hŒ Add another ”…”�”}”(hjUhhhNhNubh)�”}”(hŒImage”h]”hŒImage”…”�”}”(hj]hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h~hjUhhhh+hKubhŒ
display for ”…”�”}”(hjUhhhNhNubj3)�”}”(hŒ/camera/depth/image_raw”h]”hŒ/camera/depth/image_raw”…”�”}”(hjohhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*j2hjUhhhh+hKubhŒ.”…”�”}”(hjUhhhNhNubeh}”(h ]”h"]”h$]”h&]”h(]”uh*h=hK9hjRhhhh+ubah}”(h ]”h"]”h$]”h&]”h(]”uh*hZhK9hjhhhh+ubh[)�”}”(hhh]”h>)�”}”(hŒ?Optionally, add a PointCloud2 display for /camera/depth/points.”h]”(hŒOptionally, add a ”…”�”}”(hj�hhhNhNubh)�”}”(hŒ PointCloud2”h]”hŒ PointCloud2”…”�”}”(hj˜hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h~hj�hhhh+hKubhŒ
display for ”…”�”}”(hj�hhhNhNubj3)�”}”(hŒ/camera/depth/points”h]”hŒ/camera/depth/points”…”�”}”(hjªhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*j2hj�hhhh+hKubhŒ.”…”�”}”(hj�hhhNhNubeh}”(h ]”h"]”h$]”h&]”h(]”uh*h=hK:hj�hhhh+ubah}”(h ]”h"]”h$]”h&]”h(]”uh*hZhK:hjhhhh+ubeh}”(h ]”h"]”h$]”h&]”h(]”uh*hUhK8hjÃhhhh+ubh>)�”}”(hŒOYou should now see the color stream, depth stream, and 3D point cloud in RViz2.”h]”hŒOYou should now see the color stream, depth stream, and 3D point cloud in RViz2.”…”�”}”(hjÎhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h=hK<hjÃhhhh+ubeh}”(h ]”Œstep-3-visualize-in-rviz2”ah"]”h$]”Œstep 3: visualize in rviz2”ah&]”h(]”uh*h hK.hhàhhhh+ubeh}”(h ]”Œ#build-your-first-camera-application”ah"]”h$]”Œ#build your first camera application”ah&]”h(]”uh*h hKhh hhhh+ubhÖ)�”}”(hhh]”h}”(h ]”h"]”h$]”h&]”h(]”uh*hÕhh hhhh+hKubh
2025-10-22 03:11:03 +00:00
)�”}”(hhh]”(h)�”}”(hŒSample Features”h]”hŒSample Features”…”�”}”(hjøhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*hhK@hjõhh+ubh>)�”}”(hŒ7After the node is running, try some ROS 2 CLI commands:”h]”hŒ7After the node is running, try some ROS 2 CLI commands:”…”�”}”(hjhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h=hKBhjõhhhh+ubh
)�”}”(hhh]”(h)�”}”(hŒ,List available topics / services/ parameters”h]”hŒ,List available topics / services/ parameters”…”�”}”(hjhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*hhKDhjhh+ubj)�”}”(hŒ1ros2 topic list
2025-12-01 02:24:40 +00:00
ros2 service list
2025-10-22 03:11:03 +00:00
ros2 param list”h]”hŒ1ros2 topic list
ros2 service list