Skip to content

Commit

Permalink
fix(docs): replace outdated links with updated instructions (#186)
Browse files Browse the repository at this point in the history
  • Loading branch information
eeberhard authored Oct 14, 2024
1 parent 59b244f commit e708467
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 22 deletions.
22 changes: 4 additions & 18 deletions docs/docs/getting-started/04-examples/03-mock-hardware-example.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,6 @@ AICA hardware collections include example URDFs, which are shown on the table wi
are not editable. Users can make an editable copy of a selected URDF with the "Save As" button, or upload and edit
custom URDFs.

:::note

Refer to the section on [Persistent user data](../04-run.md#persistent-user-data) on how to mount a container volume to
persist database content between containers.

:::

From the hardware manager table, select the entry named "Universal Robots 5e (mock interface)". The URDF content should
appear on the right side of the page.

Expand Down Expand Up @@ -181,22 +174,15 @@ to [component auto-lifecycle events](../../concepts/05-building-blocks/03-compon

:::info

Only users with a Linux host can visualize the robot with RViz. Follow the steps in
the [Display sharing](../04-run.md#display-sharing) section to attach a new terminal to the running container.
Only users with a Linux host can visualize the robot with RViz. On macOS, AICA Launcher will not show the RViz option.

:::

Open RViz in the container with the `rviz2` command.
Open RViz using the gear menu icon in the bottom right of AICA Launcher and choosing the "Launch RViz" option.

In the Displays panel under Global Options, set the Fixed Frame to `world`.

Press Add or CTRL+N to add a new display and select the RobotModel plugin.

Under the RobotModel Description Topic, enter `/mock_hardware/robot_description`.

:::tip
:::note

The robot description topic will correspond to the name of the hardware interface in the YAML application.
A native 3D viewer will be available in AICA Studio for all platforms in an upcoming version.

:::

Expand Down
9 changes: 5 additions & 4 deletions docs/docs/reference/custom-components/04-package-building.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,9 +42,10 @@ You can then build your component using the following command:
docker build -f aica-package.toml -t custom-component .
```

:::tip
## Launching your custom component

Refer to [this documentation page](../../getting-started/installation#configuring-a-runtime-image-with-add-on-packages)
to learn how to run an application with your new component.
In AICA Launcher, include the docker image path from the build step as a custom package in the system configuration.

:::
Refer to
the [installation and launch](../../getting-started/03-installation-and-launch.md#configuring-the-aica-system-image)
section for more details.

0 comments on commit e708467

Please sign in to comment.