You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Get information regarding the current navigation service.
440
+
441
+
{{< tabs >}}
442
+
{{% tab name="Python" %}}
443
+
444
+
**Parameters:**
445
+
446
+
-`timeout`[(Optional\[float\])](https://docs.python.org/library/typing.html#typing.Optional): An option to set how long to wait (in seconds) before calling a time-out and closing the underlying RPC call.
447
+
448
+
**Returns:**
449
+
450
+
-[`MapType.ValueType`](https://python.viam.dev/autoapi/viam/proto/service/navigation/index.html#viam.proto.service.navigation.GetPropertiesResponse): Property information for the named navigation service.
# Get the properties of the current navigation service.
456
+
nav_properties =await my_nav.get_properties()
457
+
```
458
+
459
+
For more information, see the [Python SDK Docs](https://python.viam.dev/autoapi/viam/services/navigation/client/index.html#viam.services.navigation.client.NavigationClient.get_properties).
460
+
{{% /tab %}}
461
+
{{% tab name="Go" %}}
462
+
463
+
**Parameters:**
464
+
465
+
-`ctx`[(Context)](https://pkg.go.dev/context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
466
+
467
+
**Returns:**
468
+
469
+
-[Properties](https://pkg.go.dev/go.viam.com/[email protected]/services/navigation#Properties): Information regarding the current navigation service.
470
+
This includes the map type being ingested and used by the navigation service.
471
+
-[(error)](https://pkg.go.dev/builtin#error): An error, if one occurred.
472
+
473
+
For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/services/navigation#Service).
Get information regarding the current SLAM session.
166
+
167
+
{{< tabs >}}
168
+
{{% tab name="Python" %}}
169
+
170
+
**Parameters:**
171
+
172
+
-`timeout`[(Optional\[float\])](https://docs.python.org/library/typing.html#typing.Optional): An option to set how long to wait (in seconds) before calling a time-out and closing the underlying RPC call.
173
+
174
+
**Returns:**
175
+
176
+
- Tuple[[bool](https://docs.python.org/3/library/functions.html#bool), [MappingMode.ValueType](https://python.viam.dev/autoapi/viam/proto/service/slam/index.html#viam.proto.service.slam.MappingMode)]: A tuple containing a boolean which indicates whether the session is being run in the cloud, as well as the current session's mode.
177
+
178
+
For more information, see the [Python SDK Docs](https://python.viam.dev/autoapi/viam/services/slam/client/index.html#viam.services.slam.client.SLAMClient.get_properties).
Copy file name to clipboardExpand all lines: static/include/services/apis/navigation.md
+1Lines changed: 1 addition & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,6 +5,7 @@ Method Name | Description
5
5
[`SetMode`](/mobility/navigation/#setmode) | Set the mode the service is operating in.
6
6
[`Location`](/mobility/navigation/#location) | Get the current location of the robot.
7
7
[`Waypoints`](/mobility/navigation/#waypoints) | Get the waypoints currently in the service's data storage.
8
+
[`GetProperties`](/mobility/navigation/#getproperties) | Get information regarding the current service.
8
9
[`AddWaypoint`](/mobility/navigation/#addwaypoint) | Add a waypoint to the service's data storage.
9
10
[`RemoveWaypoint`](/mobility/navigation/#removewaypoint) | Remove a waypoint from the service's data storage.
10
11
[`Paths`](/mobility/navigation/#paths) | Get each path, the series of geo points the robot plans to travel through to get to a destination waypoint, in the robot's motion planning.
0 commit comments