Skip to content

Commit 6001533

Browse files
Updated the structure of Autonomous Robotics (open-edge-platform#2127)
Co-authored-by: Golebiewski, SebastianX <sebastianx.golebiewski@intel.com>
1 parent 256d19d commit 6001533

File tree

8 files changed

+91
-85
lines changed

8 files changed

+91
-85
lines changed

robotics-ai-suite/docs/index.rst

Lines changed: 24 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,12 +31,33 @@ Click each icon to learn more.
3131

3232
Install a Robot Kit.
3333

34-
.. grid-item-card:: Developer Guide
35-
:link: robotics/dev_guide/index
34+
.. grid-item-card:: Get Started with Autonomous Mobile Robot
35+
:link: robotics/gsg_robot/index
3636
:link-type: doc
3737
:link-alt: clickable cards
3838

39-
Resources to get started with development.
39+
Install a Robot Kit.
40+
41+
.. grid-item-card:: How it works
42+
:link: robotics/dev_guide/index_howitworks
43+
:link-type: doc
44+
:link-alt: clickable cards
45+
46+
Describes how the software works
47+
48+
.. grid-item-card:: Tutorials
49+
:link: robotics/dev_guide/index_tutorials
50+
:link-type: doc
51+
:link-alt: clickable cards
52+
53+
Provides a learning path for developers to use and configure Autonomous Mobile Robot
54+
55+
.. grid-item-card:: System Integrators
56+
:link: robotics/dev_guide/index_systemintegrator
57+
:link-type: doc
58+
:link-alt: clickable cards
59+
60+
Information specifically for System Integrators.
4061

4162
Stationary Robot Vision & Control Framework
4263
**************************************************

robotics-ai-suite/docs/robotics/dev_guide/how_it_works/robot-algorithms.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ For details, see `Model Zoo
2121
ADBSCAN
2222
++++++++
2323

24-
**Tutorial**: :doc:`../../dev_guide/tutorials_amr/navigation/adbscan/index`
24+
**Tutorial**: :doc:` ADBSCAN Algorithm <../tutorials_amr/navigation/adbscan/index>`
2525

2626

2727
DBSCAN (Density-Based Spatial Clustering of Applications with Noise) is an
@@ -35,7 +35,7 @@ average.
3535
3D Pointcloud Groundfloor Segmentation
3636
++++++++++++++++++++++++++++++++++++++
3737

38-
**Tutorial**: :doc:`../../dev_guide/tutorials_amr/perception/pointcloud-groundfloor-segmentation`
38+
**Tutorial**: :doc:` 3D Pointcloud Groundfloor Segmentation for Intel® RealSense™ Camera and 3D LiDAR <../tutorials_amr/perception/pointcloud-groundfloor-segmentation>`
3939

4040
An algorithm, along with a demo application, that transforms (Intel® RealSense™) Depth Camera images to 3D
4141
pointclouds. This algorithm further assigns classification labels such as 'ground floor' or
@@ -71,7 +71,7 @@ https://github.com/CCNYRoboticsLab/imu_tools:
7171
FastMapping
7272
++++++++++++
7373

74-
**Tutorial**: :doc:`../../dev_guide/tutorials_amr/navigation/run-fastmapping-algorithm`
74+
**Tutorial**: :doc:` FastMapping Algorithm <../tutorials_amr/navigation/run-fastmapping-algorithm>`
7575

7676
FastMapping, is an algorithm to create a 3D voxel map of a robot's
7777
surrounding, based on Intel® RealSense™ Depth Camera sensor data.
@@ -80,7 +80,7 @@ surrounding, based on Intel® RealSense™ Depth Camera sensor data.
8080
Collaborative Visual SLAM
8181
++++++++++++++++++++++++++
8282

83-
**Tutorial**: :doc:`../../dev_guide/tutorials_amr/navigation/collaborative-slam`
83+
**Tutorial**: :doc:` Collaborative Visual SLAM <../tutorials_amr/navigation/collaborative-slam>`
8484

8585
Collaborative visual SLAM is a framework for service robots which utilizes simultaneous localization
8686
and mapping (SLAM). An edge server maintains a map database and handles global optimization. Each robot can
@@ -165,7 +165,7 @@ The SLAM toolbox is a set of tools and capabilities for 2D SLAM that includes th
165165
ITS Global Path Planner
166166
++++++++++++++++++++++++
167167

168-
**Tutorial**: :doc:`../../dev_guide/tutorials_amr/navigation/its-path-planner-plugin`
168+
**Tutorial**: :doc:` ITS Path Planner ROS 2 Navigation Plugin <../tutorials_amr/navigation/its-path-planner-plugin>`
169169

170170
The Intelligent Sampling and Two-Way Search (ITS) Global Path Planner is a plugin for the ROS 2 Navigation package.
171171
It performs a path planning search on a roadmap from two directions
@@ -203,7 +203,7 @@ the integration of GPS data.
203203
Navigation 2
204204
+++++++++++++
205205

206-
**Tutorials**: :doc:`../../dev_guide/tutorials_amr/navigation/index`
206+
**Tutorials**: :doc:` Navigation <../tutorials_amr/navigation/index>`
207207

208208
ROS 2 Navigation stack, which seeks a safe way to have a mobile robot move
209209
from point A to point B. This completes dynamic path planning, computes

robotics-ai-suite/docs/robotics/dev_guide/index.rst

Lines changed: 0 additions & 38 deletions
This file was deleted.

robotics-ai-suite/docs/robotics/dev_guide/how_it_works/index.rst renamed to robotics-ai-suite/docs/robotics/dev_guide/index_howitworks.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. |how_it_works| image:: ../../images/icons/How_it_Works.png
1+
.. |how_it_works| image:: ../images/icons/How_it_Works.png
22
:width: 70
33
:align: bottom
44

@@ -45,12 +45,12 @@ This diagram shows the software components included in the Autonomous Mobile Rob
4545
package.
4646

4747

48-
.. image:: ../../images/amr_sdk_software_components.png
48+
.. image:: ../images/amr_sdk_software_components.png
4949

5050

5151
The Autonomous Mobile Robot software stack relies on the underlying hardware platform, software supported by and integrated into
5252
their respective Unified Extensible Firmware Interface (UEFI) based boot processes, and supported Linux
53-
operating system. For requirement details, see :doc:`../../dev_guide/requirements`.
53+
operating system. For requirement details, see :doc:`../dev_guide/requirements`.
5454

5555

5656
Autonomous Mobile Robot Drivers
@@ -71,10 +71,10 @@ specifically important for Autonomous Mobile Robot include:
7171
- The Serial Driver, the serial stream as used in Ethernet and USB interfaces.
7272

7373

74-
.. include:: tools.rst
74+
.. include:: how_it_works/tools.rst
7575

76-
.. include:: robot-apps.rst
76+
.. include:: how_it_works/robot-apps.rst
7777

78-
.. include:: robot-algorithms.rst
78+
.. include:: how_it_works/robot-algorithms.rst
7979

80-
.. include:: robot-middleware.rst
80+
.. include:: how_it_works/robot-middleware.rst

robotics-ai-suite/docs/robotics/dev_guide/system_integrator/index.rst renamed to robotics-ai-suite/docs/robotics/dev_guide/index_systemintegrator.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. |sys_integrator| image:: ../../images/icons/Integrate.png
1+
.. |sys_integrator| image:: ../images/icons/Integrate.png
22
:width: 70
33
:align: bottom
44

@@ -10,7 +10,7 @@ This chapter details information specifically for system integrators.
1010
.. toctree::
1111
:maxdepth: 1
1212

13-
benchmark_profiling/index
14-
performance
15-
security
13+
system_integrator/benchmark_profiling/index
14+
system_integrator/performance
15+
system_integrator/security
1616

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
.. |tutorials_robot| image:: ../images/icons/Tutorial_Robot.png
2+
:width: 70
3+
:align: bottom
4+
5+
.. tutorials-amr:
6+
7+
Tutorials |tutorials_robot|
8+
===========================
9+
10+
Prerequisite: Follow the instructions in :doc:`../gsg_robot/index`.
11+
12+
With step-by-step instructions covering real world usage scenarios,
13+
these tutorials provide a learning path for developers to use and configure Autonomous Mobile Robot.
14+
15+
16+
.. toctree::
17+
:maxdepth: 1
18+
19+
tutorials_amr/developer_kit/index
20+
tutorials_amr/perception/index
21+
tutorials_amr/navigation/index
22+
tutorials_amr/simulation/index
23+
tutorials_amr/robot-tutorials-troubleshooting

robotics-ai-suite/docs/robotics/dev_guide/tutorials_amr/index.rst

Lines changed: 0 additions & 23 deletions
This file was deleted.

robotics-ai-suite/docs/robotics/index.rst

Lines changed: 27 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
11
Autonomous Mobile Robot
22
************************
33

4+
The Autonomous Mobile Robot provides software packages and pre-validated hardware modules for sensor data ingestion, classification, environment modeling, action planning, action control. Built on the (ROS 2 Humble) robot operating system, it also features reference algorithms and working examples.
5+
6+
Beyond autonomous mobility, this package demonstrates map building and Simultaneous Localization And Mapping (SLAM) loop closure functionality. It utilizes an open source version of visual SLAM with input from an Intel® RealSense™ camera. Optionally, the package allows you to run Light Detection and Ranging (LiDAR) based SLAM and compare those results with visual SLAM results on accuracy and performance indicators. Additionally, it detects and highlights the objects on the map. Depending on the platform that is used, workloads are executed on an integrated GPU or on Intel® CPU.
7+
8+
The Autonomous Mobile Robot addresses industrial, manufacturing, consumer market, and smart cities use cases, facilitating data collection, storage, and analytics across various nodes on the factory floor.
49
Develop, build, and deploy end-to-end mobile robot applications with this purpose-built, open, and modular software development kit that includes libraries, middleware, and sample applications based on the open source ROS 2 Humble robot operating system.
510

611
Click each icon to learn more.
@@ -14,17 +19,35 @@ Click each icon to learn more.
1419

1520
Install a Robot Kit.
1621

17-
.. grid-item-card:: Developer Guide
18-
:link: dev_guide/index
22+
.. grid-item-card:: How it works
23+
:link: dev_guide/index_howitworks
24+
:link-type: doc
25+
:link-alt: clickable cards
26+
27+
Describes how the software works
28+
29+
.. grid-item-card:: Tutorials
30+
:link: dev_guide/index_tutorials
31+
:link-type: doc
32+
:link-alt: clickable cards
33+
34+
Provides a learning path for developers to use and configure Autonomous Mobile Robot
35+
36+
.. grid-item-card:: System Integrators
37+
:link: dev_guide/index_systemintegrator
1938
:link-type: doc
2039
:link-alt: clickable cards
2140

22-
Resources to get started with development.
41+
Information specifically for System Integrators.
2342

2443

2544
.. toctree::
2645
:maxdepth: 1
2746
:hidden:
2847

2948
gsg_robot/index
30-
dev_guide/index
49+
dev_guide/index_howitworks
50+
dev_guide/requirements
51+
dev_guide/index_tutorials
52+
dev_guide/index_systemintegrator
53+
dev_guide/terminology

0 commit comments

Comments
 (0)