Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/services/navigation/select-base-frame.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 0 additions & 6 deletions docs/reference/apis/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,6 @@ aliases:
- /program/apis/
- /build/program/apis/
- /appendix/apis/
- /reference/apis/services/SLAM/
- /reference/apis/services/slam/
- /dev/reference/apis/services/SLAM/
- /dev/reference/apis/services/slam/
- /appendix/apis/services/slam/
no_list: true
date: "2024-10-01"
# updated: "" # When the content was last entirely checked
Expand Down Expand Up @@ -111,7 +106,6 @@ See every service API and its methods at a glance in one compact grid.
{{% card link="/reference/apis/services/vision/" customTitle="Vision service API" noimage="True" %}}
{{% card link="/reference/apis/services/ml/" customTitle="ML model service API" noimage="True" %}}
{{% card link="/reference/apis/services/motion/" customTitle="Motion service API" noimage="True" %}}
{{% card link="/reference/apis/services/navigation/" customTitle="Navigation service API" noimage="True" %}}
{{% card link="/reference/apis/services/generic/" customTitle="Generic service API" noimage="True" %}}
{{% card link="/reference/apis/services/base-rc/" customTitle="Base Remote Control service API" noimage="True" %}}
{{% card link="/reference/apis/services/discovery/" customTitle="Discovery service API" noimage="True" %}}
Expand Down
24 changes: 20 additions & 4 deletions docs/reference/apis/services/navigation.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,29 @@ title: "Navigation service API"
linkTitle: "Navigation"
weight: 70
type: "docs"
description: "The navigation service API has been removed."
date: "2026-05-22"
tags: ["navigation", "services", "base", "rover"]
description: "Give commands to define waypoints and move your machine along those waypoints while avoiding obstacles."
date: "2022-01-01"
aliases:
- /dev/reference/apis/services/navigation/
- /appendix/apis/services/navigation/
build:
render: always
list: never
publishResources: true
---

The navigation service API has been removed.
{{< alert title="Discontinued" color="caution" >}}
Support for the navigation service has been discontinued.
This page is retained for reference only.
{{< /alert >}}

For motion planning APIs, see [Motion service API](/reference/apis/services/motion/).
The navigation service API allows you to define waypoints and move your machine along those waypoints while avoiding obstacles.

The [navigation service](/reference/services/navigation/) supports the following methods:

{{< readfile "/static/include/services/apis/generated/navigation-table.md" >}}

## API

{{< readfile "/static/include/services/apis/generated/navigation.md" >}}
31 changes: 31 additions & 0 deletions docs/reference/apis/services/slam.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
title: "SLAM service API"
linkTitle: "SLAM"
weight: 60
type: "docs"
tags: ["slam", "services"]
description: "Give commands to get a machine's position within a map."
date: "2022-01-01"
aliases:
- /dev/reference/apis/services/slam/
- /appendix/apis/services/slam/
build:
render: always
list: never
publishResources: true
---

{{< alert title="Discontinued" color="caution" >}}
Support for the SLAM service has been discontinued.
This page is retained for reference only.
{{< /alert >}}

The SLAM service API allows you to get a machine's position within a map.

The [SLAM service](/reference/services/slam/) supports the following methods:

{{< readfile "/static/include/services/apis/generated/slam-table.md" >}}

## API

{{< readfile "/static/include/services/apis/generated/slam.md" >}}
1 change: 0 additions & 1 deletion docs/reference/services/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@ Configuration reference for Viam built-in services. Each page covers available m
{{% card link="/reference/services/frame-system/" %}}
{{% card link="/reference/services/generic/" %}}
{{% card link="/reference/services/motion/" %}}
{{% card link="/reference/services/navigation/" %}}
{{% card link="/reference/services/vision/" %}}
{{% card link="/reference/services/motion/" %}}
{{< /cards >}}
Loading
Loading