viam.proto.service.navigation

@generated by Viam. Do not edit manually!

Classes

NavigationServiceBase	Helper class that provides a standard way to create an ABC using
NavigationServiceStub
UnimplementedNavigationServiceBase	Helper class that provides a standard way to create an ABC using
AddLocationRequest	Abstract base class for protocol messages.
AddLocationResponse	Abstract base class for protocol messages.
AddRouteRequest	Abstract base class for protocol messages.
AddRouteResponse	Abstract base class for protocol messages.
AddZoneRequest	Abstract base class for protocol messages.
AddZoneResponse	Abstract base class for protocol messages.
CancelRequest	Abstract base class for protocol messages.
CancelResponse	Abstract base class for protocol messages.
DeleteLocationRequest	Abstract base class for protocol messages.
DeleteLocationResponse	Abstract base class for protocol messages.
DeleteRouteRequest	Abstract base class for protocol messages.
DeleteRouteResponse	Abstract base class for protocol messages.
DeleteZoneRequest	Abstract base class for protocol messages.
DeleteZoneResponse	Abstract base class for protocol messages.
ExecutePlanRequest	Abstract base class for protocol messages.
ExecutePlanResponse	Abstract base class for protocol messages.
GetCostmapRequest	Abstract base class for protocol messages.
GetCostmapResponse	Abstract base class for protocol messages.
GetLocationRequest	Abstract base class for protocol messages.
GetLocationResponse	Abstract base class for protocol messages.
GetNavigationStatusRequest	Abstract base class for protocol messages.
GetNavigationStatusResponse	Abstract base class for protocol messages.
GetPositionRequest	Abstract base class for protocol messages.
GetPositionResponse	Abstract base class for protocol messages.
GetPropertiesRequest	Abstract base class for protocol messages.
GetPropertiesResponse	Abstract base class for protocol messages.
GetRouteRequest	Abstract base class for protocol messages.
GetRouteResponse	Abstract base class for protocol messages.
GetZoneRequest	Abstract base class for protocol messages.
GetZoneResponse	Abstract base class for protocol messages.
GoalState
GoalStatus	GoalStatus is one goal and its lifecycle. Returned (embedded in Status) by
GoToLocationRequest	Abstract base class for protocol messages.
GoToLocationResponse	Abstract base class for protocol messages.
GoToPointRequest	Abstract base class for protocol messages.
GoToPointResponse	Abstract base class for protocol messages.
ListLocationsRequest	Abstract base class for protocol messages.
ListLocationsResponse	Abstract base class for protocol messages.
ListRoutesRequest	Abstract base class for protocol messages.
ListRoutesResponse	Abstract base class for protocol messages.
ListZonesRequest	Abstract base class for protocol messages.
ListZonesResponse	Abstract base class for protocol messages.
Location	Location is a named Position on the active map.
MapType	MapType represents the type of map the navigation service operates on.
NavError	Abstract base class for protocol messages.
NavErrorCode
NavigateRouteRequest	Abstract base class for protocol messages.
NavigateRouteResponse	Abstract base class for protocol messages.
NavigateToLocationRequest	Abstract base class for protocol messages.
NavigateToLocationResponse	Abstract base class for protocol messages.
NavigateToPointRequest	Abstract base class for protocol messages.
NavigateToPointResponse	Abstract base class for protocol messages.
NavMode
Plan	Plan is a path preview returned by PlanToPoint and PlanToLocation.
PlanToLocationRequest	Abstract base class for protocol messages.
PlanToLocationResponse	Abstract base class for protocol messages.
PlanToPointRequest	Abstract base class for protocol messages.
PlanToPointResponse	Abstract base class for protocol messages.
Position	Position is a shared oneof for any map-typed position. Exactly one of pose or
Progress	Abstract base class for protocol messages.
Properties	Properties are returned by GetProperties and do not change while the service
ResumeRequest	Abstract base class for protocol messages.
ResumeResponse	Abstract base class for protocol messages.
Route	Route is an ordered list of waypoints. A location can appear in more than one
RouteProgress	Abstract base class for protocol messages.
Status	Status is the robot navigation state returned by GetNavigationStatus and by methods that
SuspendRequest	Abstract base class for protocol messages.
SuspendResponse	Abstract base class for protocol messages.
UpdateLocationRequest	Abstract base class for protocol messages.
UpdateLocationResponse	Abstract base class for protocol messages.
UpdateRouteRequest	Abstract base class for protocol messages.
UpdateRouteResponse	Abstract base class for protocol messages.
UpdateZoneRequest	Abstract base class for protocol messages.
UpdateZoneResponse	Abstract base class for protocol messages.
Velocity	Abstract base class for protocol messages.
Waypoint	Waypoint is a route stop: either the name of a saved Location or an inline
WaypointList	WaypointList is a wrapper so callers can distinguish an unset list from an
Zone	Zone is a named region on the active map. Geometry is a Struct following the

Package Contents

class viam.proto.service.navigation.NavigationServiceBase

Bases: abc.ABC

Helper class that provides a standard way to create an ABC using inheritance.

abstractmethod AddLocation(stream: grpclib.server.Stream[service.navigation.v1.navigation_pb2.AddLocationRequest, service.navigation.v1.navigation_pb2.AddLocationResponse]) → None

Async:

abstractmethod GetLocation(stream: grpclib.server.Stream[service.navigation.v1.navigation_pb2.GetLocationRequest, service.navigation.v1.navigation_pb2.GetLocationResponse]) → None

Async:

abstractmethod ListLocations(stream: grpclib.server.Stream[service.navigation.v1.navigation_pb2.ListLocationsRequest, service.navigation.v1.navigation_pb2.ListLocationsResponse]) → None

Async:

abstractmethod UpdateLocation(stream: grpclib.server.Stream[service.navigation.v1.navigation_pb2.UpdateLocationRequest, service.navigation.v1.navigation_pb2.UpdateLocationResponse]) → None

Async:

abstractmethod DeleteLocation(stream: grpclib.server.Stream[service.navigation.v1.navigation_pb2.DeleteLocationRequest, service.navigation.v1.navigation_pb2.DeleteLocationResponse]) → None

Async:

abstractmethod AddRoute(stream: grpclib.server.Stream[service.navigation.v1.navigation_pb2.AddRouteRequest, service.navigation.v1.navigation_pb2.AddRouteResponse]) → None

Async:

abstractmethod GetRoute(stream: grpclib.server.Stream[service.navigation.v1.navigation_pb2.GetRouteRequest, service.navigation.v1.navigation_pb2.GetRouteResponse]) → None

Async:

abstractmethod ListRoutes(stream: grpclib.server.Stream[service.navigation.v1.navigation_pb2.ListRoutesRequest, service.navigation.v1.navigation_pb2.ListRoutesResponse]) → None

Async:

abstractmethod UpdateRoute(stream: grpclib.server.Stream[service.navigation.v1.navigation_pb2.UpdateRouteRequest, service.navigation.v1.navigation_pb2.UpdateRouteResponse]) → None

Async:

abstractmethod DeleteRoute(stream: grpclib.server.Stream[service.navigation.v1.navigation_pb2.DeleteRouteRequest, service.navigation.v1.navigation_pb2.DeleteRouteResponse]) → None

Async:

abstractmethod AddZone(stream: grpclib.server.Stream[service.navigation.v1.navigation_pb2.AddZoneRequest, service.navigation.v1.navigation_pb2.AddZoneResponse]) → None

Async:

abstractmethod GetZone(stream: grpclib.server.Stream[service.navigation.v1.navigation_pb2.GetZoneRequest, service.navigation.v1.navigation_pb2.GetZoneResponse]) → None

Async:

abstractmethod ListZones(stream: grpclib.server.Stream[service.navigation.v1.navigation_pb2.ListZonesRequest, service.navigation.v1.navigation_pb2.ListZonesResponse]) → None

Async:

abstractmethod UpdateZone(stream: grpclib.server.Stream[service.navigation.v1.navigation_pb2.UpdateZoneRequest, service.navigation.v1.navigation_pb2.UpdateZoneResponse]) → None

Async:

abstractmethod DeleteZone(stream: grpclib.server.Stream[service.navigation.v1.navigation_pb2.DeleteZoneRequest, service.navigation.v1.navigation_pb2.DeleteZoneResponse]) → None

Async:

abstractmethod NavigateToLocation(stream: grpclib.server.Stream[service.navigation.v1.navigation_pb2.NavigateToLocationRequest, service.navigation.v1.navigation_pb2.NavigateToLocationResponse]) → None

Async:

abstractmethod NavigateToPoint(stream: grpclib.server.Stream[service.navigation.v1.navigation_pb2.NavigateToPointRequest, service.navigation.v1.navigation_pb2.NavigateToPointResponse]) → None

Async:

abstractmethod NavigateRoute(stream: grpclib.server.Stream[service.navigation.v1.navigation_pb2.NavigateRouteRequest, service.navigation.v1.navigation_pb2.NavigateRouteResponse]) → None

Async:

abstractmethod PlanToPoint(stream: grpclib.server.Stream[service.navigation.v1.navigation_pb2.PlanToPointRequest, service.navigation.v1.navigation_pb2.PlanToPointResponse]) → None

Async:

abstractmethod PlanToLocation(stream: grpclib.server.Stream[service.navigation.v1.navigation_pb2.PlanToLocationRequest, service.navigation.v1.navigation_pb2.PlanToLocationResponse]) → None

Async:

abstractmethod ExecutePlan(stream: grpclib.server.Stream[service.navigation.v1.navigation_pb2.ExecutePlanRequest, service.navigation.v1.navigation_pb2.ExecutePlanResponse]) → None

Async:

abstractmethod GoToLocation(stream: grpclib.server.Stream[service.navigation.v1.navigation_pb2.GoToLocationRequest, service.navigation.v1.navigation_pb2.GoToLocationResponse]) → None

Async:

abstractmethod GoToPoint(stream: grpclib.server.Stream[service.navigation.v1.navigation_pb2.GoToPointRequest, service.navigation.v1.navigation_pb2.GoToPointResponse]) → None

Async:

abstractmethod Suspend(stream: grpclib.server.Stream[service.navigation.v1.navigation_pb2.SuspendRequest, service.navigation.v1.navigation_pb2.SuspendResponse]) → None

Async:

abstractmethod Resume(stream: grpclib.server.Stream[service.navigation.v1.navigation_pb2.ResumeRequest, service.navigation.v1.navigation_pb2.ResumeResponse]) → None

Async:

abstractmethod Cancel(stream: grpclib.server.Stream[service.navigation.v1.navigation_pb2.CancelRequest, service.navigation.v1.navigation_pb2.CancelResponse]) → None

Async:

abstractmethod GetPosition(stream: grpclib.server.Stream[service.navigation.v1.navigation_pb2.GetPositionRequest, service.navigation.v1.navigation_pb2.GetPositionResponse]) → None

Async:

abstractmethod GetNavigationStatus(stream: grpclib.server.Stream[service.navigation.v1.navigation_pb2.GetNavigationStatusRequest, service.navigation.v1.navigation_pb2.GetNavigationStatusResponse]) → None

Async:

abstractmethod GetProperties(stream: grpclib.server.Stream[service.navigation.v1.navigation_pb2.GetPropertiesRequest, service.navigation.v1.navigation_pb2.GetPropertiesResponse]) → None

Async:

abstractmethod GetCostmap(stream: grpclib.server.Stream[service.navigation.v1.navigation_pb2.GetCostmapRequest, service.navigation.v1.navigation_pb2.GetCostmapResponse]) → None

Async:

abstractmethod DoCommand(stream: grpclib.server.Stream[common.v1.common_pb2.DoCommandRequest, common.v1.common_pb2.DoCommandResponse]) → None

Async:

abstractmethod GetStatus(stream: grpclib.server.Stream[common.v1.common_pb2.GetStatusRequest, common.v1.common_pb2.GetStatusResponse]) → None

Async:

__mapping__() → Dict[str, grpclib.const.Handler]

class viam.proto.service.navigation.NavigationServiceStub(channel: grpclib.client.Channel)

AddLocation

GetLocation

ListLocations

UpdateLocation

DeleteLocation

AddRoute

GetRoute

ListRoutes

UpdateRoute

DeleteRoute

AddZone

GetZone

ListZones

UpdateZone

DeleteZone

NavigateToLocation

NavigateToPoint

NavigateRoute

PlanToPoint

PlanToLocation

ExecutePlan

GoToLocation

GoToPoint

Suspend

Resume

Cancel

GetPosition

GetNavigationStatus

GetProperties

GetCostmap

DoCommand

GetStatus

class viam.proto.service.navigation.UnimplementedNavigationServiceBase

Bases: NavigationServiceBase

Helper class that provides a standard way to create an ABC using inheritance.

async AddLocation(stream: grpclib.server.Stream[service.navigation.v1.navigation_pb2.AddLocationRequest, service.navigation.v1.navigation_pb2.AddLocationResponse]) → None

async GetLocation(stream: grpclib.server.Stream[service.navigation.v1.navigation_pb2.GetLocationRequest, service.navigation.v1.navigation_pb2.GetLocationResponse]) → None

async ListLocations(stream: grpclib.server.Stream[service.navigation.v1.navigation_pb2.ListLocationsRequest, service.navigation.v1.navigation_pb2.ListLocationsResponse]) → None

async UpdateLocation(stream: grpclib.server.Stream[service.navigation.v1.navigation_pb2.UpdateLocationRequest, service.navigation.v1.navigation_pb2.UpdateLocationResponse]) → None

async DeleteLocation(stream: grpclib.server.Stream[service.navigation.v1.navigation_pb2.DeleteLocationRequest, service.navigation.v1.navigation_pb2.DeleteLocationResponse]) → None

async AddRoute(stream: grpclib.server.Stream[service.navigation.v1.navigation_pb2.AddRouteRequest, service.navigation.v1.navigation_pb2.AddRouteResponse]) → None

async GetRoute(stream: grpclib.server.Stream[service.navigation.v1.navigation_pb2.GetRouteRequest, service.navigation.v1.navigation_pb2.GetRouteResponse]) → None

async ListRoutes(stream: grpclib.server.Stream[service.navigation.v1.navigation_pb2.ListRoutesRequest, service.navigation.v1.navigation_pb2.ListRoutesResponse]) → None

async UpdateRoute(stream: grpclib.server.Stream[service.navigation.v1.navigation_pb2.UpdateRouteRequest, service.navigation.v1.navigation_pb2.UpdateRouteResponse]) → None

async DeleteRoute(stream: grpclib.server.Stream[service.navigation.v1.navigation_pb2.DeleteRouteRequest, service.navigation.v1.navigation_pb2.DeleteRouteResponse]) → None

async AddZone(stream: grpclib.server.Stream[service.navigation.v1.navigation_pb2.AddZoneRequest, service.navigation.v1.navigation_pb2.AddZoneResponse]) → None

async GetZone(stream: grpclib.server.Stream[service.navigation.v1.navigation_pb2.GetZoneRequest, service.navigation.v1.navigation_pb2.GetZoneResponse]) → None

async ListZones(stream: grpclib.server.Stream[service.navigation.v1.navigation_pb2.ListZonesRequest, service.navigation.v1.navigation_pb2.ListZonesResponse]) → None

async UpdateZone(stream: grpclib.server.Stream[service.navigation.v1.navigation_pb2.UpdateZoneRequest, service.navigation.v1.navigation_pb2.UpdateZoneResponse]) → None

async DeleteZone(stream: grpclib.server.Stream[service.navigation.v1.navigation_pb2.DeleteZoneRequest, service.navigation.v1.navigation_pb2.DeleteZoneResponse]) → None

async NavigateToLocation(stream: grpclib.server.Stream[service.navigation.v1.navigation_pb2.NavigateToLocationRequest, service.navigation.v1.navigation_pb2.NavigateToLocationResponse]) → None

async NavigateToPoint(stream: grpclib.server.Stream[service.navigation.v1.navigation_pb2.NavigateToPointRequest, service.navigation.v1.navigation_pb2.NavigateToPointResponse]) → None

async NavigateRoute(stream: grpclib.server.Stream[service.navigation.v1.navigation_pb2.NavigateRouteRequest, service.navigation.v1.navigation_pb2.NavigateRouteResponse]) → None

async PlanToPoint(stream: grpclib.server.Stream[service.navigation.v1.navigation_pb2.PlanToPointRequest, service.navigation.v1.navigation_pb2.PlanToPointResponse]) → None

async PlanToLocation(stream: grpclib.server.Stream[service.navigation.v1.navigation_pb2.PlanToLocationRequest, service.navigation.v1.navigation_pb2.PlanToLocationResponse]) → None

async ExecutePlan(stream: grpclib.server.Stream[service.navigation.v1.navigation_pb2.ExecutePlanRequest, service.navigation.v1.navigation_pb2.ExecutePlanResponse]) → None

async GoToLocation(stream: grpclib.server.Stream[service.navigation.v1.navigation_pb2.GoToLocationRequest, service.navigation.v1.navigation_pb2.GoToLocationResponse]) → None

async GoToPoint(stream: grpclib.server.Stream[service.navigation.v1.navigation_pb2.GoToPointRequest, service.navigation.v1.navigation_pb2.GoToPointResponse]) → None

async Suspend(stream: grpclib.server.Stream[service.navigation.v1.navigation_pb2.SuspendRequest, service.navigation.v1.navigation_pb2.SuspendResponse]) → None

async Resume(stream: grpclib.server.Stream[service.navigation.v1.navigation_pb2.ResumeRequest, service.navigation.v1.navigation_pb2.ResumeResponse]) → None

async Cancel(stream: grpclib.server.Stream[service.navigation.v1.navigation_pb2.CancelRequest, service.navigation.v1.navigation_pb2.CancelResponse]) → None

async GetPosition(stream: grpclib.server.Stream[service.navigation.v1.navigation_pb2.GetPositionRequest, service.navigation.v1.navigation_pb2.GetPositionResponse]) → None

async GetNavigationStatus(stream: grpclib.server.Stream[service.navigation.v1.navigation_pb2.GetNavigationStatusRequest, service.navigation.v1.navigation_pb2.GetNavigationStatusResponse]) → None

async GetProperties(stream: grpclib.server.Stream[service.navigation.v1.navigation_pb2.GetPropertiesRequest, service.navigation.v1.navigation_pb2.GetPropertiesResponse]) → None

async GetCostmap(stream: grpclib.server.Stream[service.navigation.v1.navigation_pb2.GetCostmapRequest, service.navigation.v1.navigation_pb2.GetCostmapResponse]) → None

async DoCommand(stream: grpclib.server.Stream[common.v1.common_pb2.DoCommandRequest, common.v1.common_pb2.DoCommandResponse]) → None

async GetStatus(stream: grpclib.server.Stream[common.v1.common_pb2.GetStatusRequest, common.v1.common_pb2.GetStatusResponse]) → None

class viam.proto.service.navigation.AddLocationRequest(*, name: str = ..., location_name: str = ..., position: Global___Position | None = ..., extra: google.protobuf.struct_pb2.Struct | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

name: str

Name of the navigation service

location_name: str

Name of the location to save

position() → Global___Position

Omit to use the robot’s current Position

extra() → google.protobuf.struct_pb2.Struct

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: _WhichOneofArgType__position) → _WhichOneofReturnType__position | None

Returns the name of the field that is set inside a oneof group.

If no field is set, returns None.

Parameters:

oneof_group (str) – the name of the oneof group to check.

Returns:

The name of the group that is set, or None.

Return type:

str or None

Raises:

ValueError – no group with the given name exists

class viam.proto.service.navigation.AddLocationResponse(*, location: Global___Location | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

location() → Global___Location

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.service.navigation.AddRouteRequest(*, name: str = ..., route_name: str = ..., waypoints: collections.abc.Iterable[Global___Waypoint] | None = ..., extra: google.protobuf.struct_pb2.Struct | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

name: str

Name of the navigation service

route_name: str

waypoints() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___Waypoint]

extra() → google.protobuf.struct_pb2.Struct

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.service.navigation.AddRouteResponse(*, route: Global___Route | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

route() → Global___Route

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.service.navigation.AddZoneRequest(*, name: str = ..., zone_name: str = ..., type: str = ..., geometry: google.protobuf.struct_pb2.Struct | None = ..., max_speed: float | None = ..., extra: google.protobuf.struct_pb2.Struct | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

name: str

Name of the navigation service

zone_name: str

type: str

“keepout” or “speed_limit”

max_speed: float

Max speed in meters/sec; required when type is “speed_limit”

geometry() → google.protobuf.struct_pb2.Struct

See Zone geometry shapes

extra() → google.protobuf.struct_pb2.Struct

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: _WhichOneofArgType__max_speed) → _WhichOneofReturnType__max_speed | None

Returns the name of the field that is set inside a oneof group.

If no field is set, returns None.

Parameters:

oneof_group (str) – the name of the oneof group to check.

Returns:

The name of the group that is set, or None.

Return type:

str or None

Raises:

ValueError – no group with the given name exists

class viam.proto.service.navigation.AddZoneResponse(*, zone: Global___Zone | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

zone() → Global___Zone

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.service.navigation.CancelRequest(*, name: str = ..., extra: google.protobuf.struct_pb2.Struct | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

name: str

Name of the navigation service

extra() → google.protobuf.struct_pb2.Struct

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.service.navigation.CancelResponse(*, status: Global___Status | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

status() → Global___Status

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.service.navigation.DeleteLocationRequest(*, name: str = ..., location_name: str = ..., extra: google.protobuf.struct_pb2.Struct | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

name: str

Name of the navigation service

location_name: str

extra() → google.protobuf.struct_pb2.Struct

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.service.navigation.DeleteLocationResponse

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

class viam.proto.service.navigation.DeleteRouteRequest(*, name: str = ..., route_name: str = ..., extra: google.protobuf.struct_pb2.Struct | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

name: str

Name of the navigation service

route_name: str

extra() → google.protobuf.struct_pb2.Struct

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.service.navigation.DeleteRouteResponse

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

class viam.proto.service.navigation.DeleteZoneRequest(*, name: str = ..., zone_name: str = ..., extra: google.protobuf.struct_pb2.Struct | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

name: str

Name of the navigation service

zone_name: str

extra() → google.protobuf.struct_pb2.Struct

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.service.navigation.DeleteZoneResponse

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

class viam.proto.service.navigation.ExecutePlanRequest(*, name: str = ..., plan: Global___Plan | None = ..., extra: google.protobuf.struct_pb2.Struct | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

name: str

Name of the navigation service

plan() → Global___Plan

extra() → google.protobuf.struct_pb2.Struct

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.service.navigation.ExecutePlanResponse(*, status: Global___Status | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

status() → Global___Status

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.service.navigation.GetCostmapRequest(*, name: str = ..., layer: str = ..., stride: int = ..., extra: google.protobuf.struct_pb2.Struct | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

name: str

Name of the navigation service

layer: str

Optional; “auto”, “local”, or “global”. Default “auto”

stride: int

Optional; downsample factor. Default 2

extra() → google.protobuf.struct_pb2.Struct

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.service.navigation.GetCostmapResponse(*, available: bool = ..., layer: str = ..., nav_backend: str = ..., origin_x: float = ..., origin_y: float = ..., resolution: float = ..., width: int = ..., height: int = ..., encoding: str = ..., data: bytes = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

available: bool

layer: str

nav_backend: str

origin_x: float

Map-frame origin, meters

origin_y: float

resolution: float

Meters per cell

width: int

Cells

height: int

encoding: str

“uint8_row_major”

data: bytes

Costs 0–100; unknown cells are 255

class viam.proto.service.navigation.GetLocationRequest(*, name: str = ..., location_name: str = ..., extra: google.protobuf.struct_pb2.Struct | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

name: str

Name of the navigation service

location_name: str

extra() → google.protobuf.struct_pb2.Struct

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.service.navigation.GetLocationResponse(*, location: Global___Location | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

location() → Global___Location

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.service.navigation.GetNavigationStatusRequest(*, name: str = ..., extra: google.protobuf.struct_pb2.Struct | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

name: str

Name of the navigation service

extra() → google.protobuf.struct_pb2.Struct

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.service.navigation.GetNavigationStatusResponse(*, status: Global___Status | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

status() → Global___Status

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.service.navigation.GetPositionRequest(*, name: str = ..., extra: google.protobuf.struct_pb2.Struct | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

name: str

Name of the navigation service

extra() → google.protobuf.struct_pb2.Struct

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.service.navigation.GetPositionResponse(*, position: Global___Position | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

position() → Global___Position

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.service.navigation.GetPropertiesRequest(*, name: str = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

name: str

Name of the navigation service

class viam.proto.service.navigation.GetPropertiesResponse(*, properties: Global___Properties | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

properties() → Global___Properties

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.service.navigation.GetRouteRequest(*, name: str = ..., route_name: str = ..., extra: google.protobuf.struct_pb2.Struct | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

name: str

Name of the navigation service

route_name: str

extra() → google.protobuf.struct_pb2.Struct

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.service.navigation.GetRouteResponse(*, route: Global___Route | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

route() → Global___Route

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.service.navigation.GetZoneRequest(*, name: str = ..., zone_name: str = ..., extra: google.protobuf.struct_pb2.Struct | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

name: str

Name of the navigation service

zone_name: str

extra() → google.protobuf.struct_pb2.Struct

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.service.navigation.GetZoneResponse(*, zone: Global___Zone | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

zone() → Global___Zone

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.service.navigation.GoalState

Bases: _GoalState

class viam.proto.service.navigation.GoalStatus(*, state: Global___GoalState = ..., mode: Global___NavMode = ..., target: Global___Position | None = ..., location: str | None = ..., progress: Global___Progress | None = ..., route: Global___RouteProgress | None = ..., suspend_reason: str | None = ..., error: Global___NavError | None = ..., started_at: google.protobuf.timestamp_pb2.Timestamp | None = ..., finished_at: google.protobuf.timestamp_pb2.Timestamp | None = ...)

Bases: google.protobuf.message.Message

GoalStatus is one goal and its lifecycle. Returned (embedded in Status) by every method that starts, suspends, resumes, or cancels motion, and embedded in Status from GetNavigationStatus. Only the latest goal is kept. SUCCEEDED, FAILED, and CANCELED are terminal.

state: Global___GoalState

mode: Global___NavMode

location: str

Set when the target is a saved location

suspend_reason: str

When SUSPENDED

target() → Global___Position

For a route, the current waypoint

progress() → Global___Progress

While ACTIVE

route() → Global___RouteProgress

When mode == NAV_MODE_ROUTE

error() → Global___NavError

When FAILED

started_at() → google.protobuf.timestamp_pb2.Timestamp

finished_at() → google.protobuf.timestamp_pb2.Timestamp

Set once terminal

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: _WhichOneofArgType__error) → _WhichOneofReturnType__error | None

WhichOneof(oneof_group: _WhichOneofArgType__finished_at) → _WhichOneofReturnType__finished_at | None

WhichOneof(oneof_group: _WhichOneofArgType__location) → _WhichOneofReturnType__location | None

WhichOneof(oneof_group: _WhichOneofArgType__progress) → _WhichOneofReturnType__progress | None

WhichOneof(oneof_group: _WhichOneofArgType__route) → _WhichOneofReturnType__route | None

WhichOneof(oneof_group: _WhichOneofArgType__suspend_reason) → _WhichOneofReturnType__suspend_reason | None

Returns the name of the field that is set inside a oneof group.

If no field is set, returns None.

Parameters:

oneof_group (str) – the name of the oneof group to check.

Returns:

The name of the group that is set, or None.

Return type:

str or None

Raises:

ValueError – no group with the given name exists

class viam.proto.service.navigation.GoToLocationRequest(*, name: str = ..., location_name: str = ..., wait: bool | None = ..., linear_m_per_sec: float | None = ..., extra: google.protobuf.struct_pb2.Struct | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

name: str

Name of the navigation service

location_name: str

wait: bool

Optional; default true

linear_m_per_sec: float

extra() → google.protobuf.struct_pb2.Struct

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: _WhichOneofArgType__linear_m_per_sec) → _WhichOneofReturnType__linear_m_per_sec | None

WhichOneof(oneof_group: _WhichOneofArgType__wait) → _WhichOneofReturnType__wait | None

Returns the name of the field that is set inside a oneof group.

If no field is set, returns None.

Parameters:

oneof_group (str) – the name of the oneof group to check.

Returns:

The name of the group that is set, or None.

Return type:

str or None

Raises:

ValueError – no group with the given name exists

class viam.proto.service.navigation.GoToLocationResponse(*, status: Global___Status | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

status() → Global___Status

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.service.navigation.GoToPointRequest(*, name: str = ..., destination: Global___Position | None = ..., wait: bool | None = ..., linear_m_per_sec: float | None = ..., extra: google.protobuf.struct_pb2.Struct | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

name: str

Name of the navigation service

wait: bool

Optional; default true

linear_m_per_sec: float

destination() → Global___Position

extra() → google.protobuf.struct_pb2.Struct

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: _WhichOneofArgType__linear_m_per_sec) → _WhichOneofReturnType__linear_m_per_sec | None

WhichOneof(oneof_group: _WhichOneofArgType__wait) → _WhichOneofReturnType__wait | None

Returns the name of the field that is set inside a oneof group.

If no field is set, returns None.

Parameters:

oneof_group (str) – the name of the oneof group to check.

Returns:

The name of the group that is set, or None.

Return type:

str or None

Raises:

ValueError – no group with the given name exists

class viam.proto.service.navigation.GoToPointResponse(*, status: Global___Status | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

status() → Global___Status

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.service.navigation.ListLocationsRequest(*, name: str = ..., extra: google.protobuf.struct_pb2.Struct | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

name: str

Name of the navigation service

extra() → google.protobuf.struct_pb2.Struct

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.service.navigation.ListLocationsResponse(*, locations: collections.abc.Iterable[Global___Location] | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

locations() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___Location]

class viam.proto.service.navigation.ListRoutesRequest(*, name: str = ..., extra: google.protobuf.struct_pb2.Struct | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

name: str

Name of the navigation service

extra() → google.protobuf.struct_pb2.Struct

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.service.navigation.ListRoutesResponse(*, routes: collections.abc.Iterable[Global___Route] | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

routes() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___Route]

class viam.proto.service.navigation.ListZonesRequest(*, name: str = ..., type: str = ..., extra: google.protobuf.struct_pb2.Struct | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

name: str

Name of the navigation service

type: str

Optional; “keepout” or “speed_limit”

extra() → google.protobuf.struct_pb2.Struct

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.service.navigation.ListZonesResponse(*, zones: collections.abc.Iterable[Global___Zone] | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

zones() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___Zone]

class viam.proto.service.navigation.Location(*, name: str = ..., position: Global___Position | None = ...)

Bases: google.protobuf.message.Message

Location is a named Position on the active map.

name: str

position() → Global___Position

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.service.navigation.MapType

Bases: _MapType

MapType represents the type of map the navigation service operates on. Each service instance uses exactly one map type.

class viam.proto.service.navigation.NavError(*, code: Global___NavErrorCode = ..., message: str = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

code: Global___NavErrorCode

message: str

class viam.proto.service.navigation.NavErrorCode

Bases: _NavErrorCode

class viam.proto.service.navigation.NavigateRouteRequest(*, name: str = ..., route_name: str = ..., waypoints: collections.abc.Iterable[Global___Waypoint] | None = ..., start_index: int = ..., start_nearest: bool = ..., loop: bool = ..., wait: bool = ..., extra: google.protobuf.struct_pb2.Struct | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

name: str

Name of the navigation service

route_name: str

Optional; a saved route

start_index: int

Optional; default 0

start_nearest: bool

Optional; overrides start_index

loop: bool

Optional; default false

wait: bool

Optional; default false. With loop, only returns when stopped

waypoints() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___Waypoint]

Optional; inline waypoints

extra() → google.protobuf.struct_pb2.Struct

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.service.navigation.NavigateRouteResponse(*, status: Global___Status | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

status() → Global___Status

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.service.navigation.NavigateToLocationRequest(*, name: str = ..., location_name: str = ..., extra: google.protobuf.struct_pb2.Struct | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

name: str

Name of the navigation service

location_name: str

extra() → google.protobuf.struct_pb2.Struct

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.service.navigation.NavigateToLocationResponse(*, status: Global___Status | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

status() → Global___Status

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.service.navigation.NavigateToPointRequest(*, name: str = ..., destination: Global___Position | None = ..., extra: google.protobuf.struct_pb2.Struct | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

name: str

Name of the navigation service

destination() → Global___Position

extra() → google.protobuf.struct_pb2.Struct

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.service.navigation.NavigateToPointResponse(*, status: Global___Status | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

status() → Global___Status

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.service.navigation.NavMode

Bases: _NavMode

class viam.proto.service.navigation.Plan(*, path: collections.abc.Iterable[Global___Position] | None = ..., location: str | None = ..., length_m: float = ...)

Bases: google.protobuf.message.Message

Plan is a path preview returned by PlanToPoint and PlanToLocation.

location: str

Set by PlanToLocation

length_m: float

path() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___Position]

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: _WhichOneofArgType__location) → _WhichOneofReturnType__location | None

Returns the name of the field that is set inside a oneof group.

If no field is set, returns None.

Parameters:

oneof_group (str) – the name of the oneof group to check.

Returns:

The name of the group that is set, or None.

Return type:

str or None

Raises:

ValueError – no group with the given name exists

class viam.proto.service.navigation.PlanToLocationRequest(*, name: str = ..., location_name: str = ..., start: Global___Position | None = ..., extra: google.protobuf.struct_pb2.Struct | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

name: str

Name of the navigation service

location_name: str

start() → Global___Position

Optional; defaults to GetPosition

extra() → google.protobuf.struct_pb2.Struct

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: _WhichOneofArgType__start) → _WhichOneofReturnType__start | None

Returns the name of the field that is set inside a oneof group.

If no field is set, returns None.

Parameters:

oneof_group (str) – the name of the oneof group to check.

Returns:

The name of the group that is set, or None.

Return type:

str or None

Raises:

ValueError – no group with the given name exists

class viam.proto.service.navigation.PlanToLocationResponse(*, plan: Global___Plan | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

plan() → Global___Plan

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.service.navigation.PlanToPointRequest(*, name: str = ..., destination: Global___Position | None = ..., start: Global___Position | None = ..., extra: google.protobuf.struct_pb2.Struct | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

name: str

Name of the navigation service

destination() → Global___Position

start() → Global___Position

Optional; defaults to GetPosition

extra() → google.protobuf.struct_pb2.Struct

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: _WhichOneofArgType__start) → _WhichOneofReturnType__start | None

Returns the name of the field that is set inside a oneof group.

If no field is set, returns None.

Parameters:

oneof_group (str) – the name of the oneof group to check.

Returns:

The name of the group that is set, or None.

Return type:

str or None

Raises:

ValueError – no group with the given name exists

class viam.proto.service.navigation.PlanToPointResponse(*, plan: Global___Plan | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

plan() → Global___Plan

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.service.navigation.Position(*, pose: common.v1.common_pb2.Pose | None = ..., geo_pose: common.v1.common_pb2.GeoPose | None = ...)

Bases: google.protobuf.message.Message

Position is a shared oneof for any map-typed position. Exactly one of pose or geo_pose is set; the service rejects a value that does not match GetProperties map type.

pose() → common.v1.common_pb2.Pose

MAP_TYPE_LOCAL — common.Pose in the map frame

geo_pose() → common.v1.common_pb2.GeoPose

MAP_TYPE_GPS — common.GeoPose

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: _WhichOneofArgType_value) → _WhichOneofReturnType_value | None

Returns the name of the field that is set inside a oneof group.

If no field is set, returns None.

Parameters:

oneof_group (str) – the name of the oneof group to check.

Returns:

The name of the group that is set, or None.

Return type:

str or None

Raises:

ValueError – no group with the given name exists

class viam.proto.service.navigation.Progress(*, distance_remaining_m: float = ..., path: collections.abc.Iterable[Global___Position] | None = ..., length_m: float = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

distance_remaining_m: float

length_m: float

Same meaning as Plan.length_m

path() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___Position]

PLANNED and ROUTE only; updates on replan

class viam.proto.service.navigation.Properties(*, map_type: Global___MapType = ..., footprint_length_m: float = ..., footprint_width_m: float = ..., robot_radius_m: float = ..., planning_supported: bool = ..., costmap_supported: bool = ..., zones_supported: bool = ..., routes_supported: bool = ...)

Bases: google.protobuf.message.Message

Properties are returned by GetProperties and do not change while the service is running.

map_type: Global___MapType

footprint_length_m: float

footprint_width_m: float

robot_radius_m: float

planning_supported: bool

PlanTo*, ExecutePlan, NavigateTo*

costmap_supported: bool

GetCostmap

zones_supported: bool

Keep-out / speed-limit zones

routes_supported: bool

Route store + NavigateRoute

class viam.proto.service.navigation.ResumeRequest(*, name: str = ..., extra: google.protobuf.struct_pb2.Struct | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

name: str

Name of the navigation service

extra() → google.protobuf.struct_pb2.Struct

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.service.navigation.ResumeResponse(*, status: Global___Status | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

status() → Global___Status

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.service.navigation.Route(*, name: str = ..., waypoints: collections.abc.Iterable[Global___Waypoint] | None = ...)

Bases: google.protobuf.message.Message

Route is an ordered list of waypoints. A location can appear in more than one route, and more than once in the same route.

name: str

waypoints() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___Waypoint]

class viam.proto.service.navigation.RouteProgress(*, name: str = ..., waypoints: collections.abc.Iterable[Global___Waypoint] | None = ..., index: int = ..., loop: bool = ..., lap: int = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

name: str

Empty for inline routes

index: int

Current waypoint; waypoints[index] is the target

loop: bool

lap: int

waypoints() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___Waypoint]

class viam.proto.service.navigation.Status(*, position: Global___Position | None = ..., localized: bool = ..., velocity: Global___Velocity | None = ..., goal: Global___GoalStatus | None = ..., updated_at: google.protobuf.timestamp_pb2.Timestamp | None = ..., extra: google.protobuf.struct_pb2.Struct | None = ...)

Bases: google.protobuf.message.Message

Status is the robot navigation state returned by GetNavigationStatus and by methods that start, suspend, or resume motion. The robot is idle when goal is unset or goal.state is terminal. It is moving when goal.state == GOAL_STATE_ACTIVE. Methods that start motion fail while localized is false.

localized: bool

Pose is trusted; false blocks new goals

position() → Global___Position

Same as GetPosition

velocity() → Global___Velocity

Current body-frame velocity; zero when stopped

goal() → Global___GoalStatus

Latest goal; unset until the first one

updated_at() → google.protobuf.timestamp_pb2.Timestamp

extra() → google.protobuf.struct_pb2.Struct

Backend-specific diagnostics

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: _WhichOneofArgType__goal) → _WhichOneofReturnType__goal | None

Returns the name of the field that is set inside a oneof group.

If no field is set, returns None.

Parameters:

oneof_group (str) – the name of the oneof group to check.

Returns:

The name of the group that is set, or None.

Return type:

str or None

Raises:

ValueError – no group with the given name exists

class viam.proto.service.navigation.SuspendRequest(*, name: str = ..., reason: str = ..., extra: google.protobuf.struct_pb2.Struct | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

name: str

Name of the navigation service

reason: str

Optional; reported on the suspended goal

extra() → google.protobuf.struct_pb2.Struct

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.service.navigation.SuspendResponse(*, status: Global___Status | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

status() → Global___Status

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.service.navigation.UpdateLocationRequest(*, name: str = ..., location_name: str = ..., position: Global___Position | None = ..., new_name: str | None = ..., extra: google.protobuf.struct_pb2.Struct | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

name: str

Name of the navigation service

location_name: str

new_name: str

Omit to leave name unchanged

position() → Global___Position

Omit to leave position unchanged

extra() → google.protobuf.struct_pb2.Struct

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: _WhichOneofArgType__new_name) → _WhichOneofReturnType__new_name | None

WhichOneof(oneof_group: _WhichOneofArgType__position) → _WhichOneofReturnType__position | None

Returns the name of the field that is set inside a oneof group.

If no field is set, returns None.

Parameters:

oneof_group (str) – the name of the oneof group to check.

Returns:

The name of the group that is set, or None.

Return type:

str or None

Raises:

ValueError – no group with the given name exists

class viam.proto.service.navigation.UpdateLocationResponse(*, location: Global___Location | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

location() → Global___Location

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.service.navigation.UpdateRouteRequest(*, name: str = ..., route_name: str = ..., new_name: str | None = ..., waypoints: Global___WaypointList | None = ..., extra: google.protobuf.struct_pb2.Struct | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

name: str

Name of the navigation service

route_name: str

new_name: str

Omit to leave name unchanged

waypoints() → Global___WaypointList

Unset: leave waypoints unchanged. Set, including empty: replace them.

extra() → google.protobuf.struct_pb2.Struct

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: _WhichOneofArgType__new_name) → _WhichOneofReturnType__new_name | None

WhichOneof(oneof_group: _WhichOneofArgType__waypoints) → _WhichOneofReturnType__waypoints | None

Returns the name of the field that is set inside a oneof group.

If no field is set, returns None.

Parameters:

oneof_group (str) – the name of the oneof group to check.

Returns:

The name of the group that is set, or None.

Return type:

str or None

Raises:

ValueError – no group with the given name exists

class viam.proto.service.navigation.UpdateRouteResponse(*, route: Global___Route | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

route() → Global___Route

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.service.navigation.UpdateZoneRequest(*, name: str = ..., zone_name: str = ..., type: str | None = ..., geometry: google.protobuf.struct_pb2.Struct | None = ..., max_speed: float | None = ..., new_name: str | None = ..., extra: google.protobuf.struct_pb2.Struct | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

name: str

Name of the navigation service

zone_name: str

type: str

Optional; “keepout” or “speed_limit”

max_speed: float

Max speed in meters/sec

new_name: str

geometry() → google.protobuf.struct_pb2.Struct

Optional; see Zone geometry shapes

extra() → google.protobuf.struct_pb2.Struct

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: _WhichOneofArgType__geometry) → _WhichOneofReturnType__geometry | None

WhichOneof(oneof_group: _WhichOneofArgType__max_speed) → _WhichOneofReturnType__max_speed | None

WhichOneof(oneof_group: _WhichOneofArgType__new_name) → _WhichOneofReturnType__new_name | None

WhichOneof(oneof_group: _WhichOneofArgType__type) → _WhichOneofReturnType__type | None

Returns the name of the field that is set inside a oneof group.

If no field is set, returns None.

Parameters:

oneof_group (str) – the name of the oneof group to check.

Returns:

The name of the group that is set, or None.

Return type:

str or None

Raises:

ValueError – no group with the given name exists

class viam.proto.service.navigation.UpdateZoneResponse(*, zone: Global___Zone | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

zone() → Global___Zone

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.service.navigation.Velocity(*, linear_m_per_sec: float = ..., angular_deg_per_sec: float = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

linear_m_per_sec: float

Forward linear velocity

angular_deg_per_sec: float

Yaw rate, counterclockwise positive

class viam.proto.service.navigation.Waypoint(*, location: str = ..., position: Global___Position | None = ...)

Bases: google.protobuf.message.Message

Waypoint is a route stop: either the name of a saved Location or an inline Position.

location: str

position() → Global___Position

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: _WhichOneofArgType_value) → _WhichOneofReturnType_value | None

Returns the name of the field that is set inside a oneof group.

If no field is set, returns None.

Parameters:

oneof_group (str) – the name of the oneof group to check.

Returns:

The name of the group that is set, or None.

Return type:

str or None

Raises:

ValueError – no group with the given name exists

class viam.proto.service.navigation.WaypointList(*, waypoints: collections.abc.Iterable[Global___Waypoint] | None = ...)

Bases: google.protobuf.message.Message

WaypointList is a wrapper so callers can distinguish an unset list from an empty one. Proto3 repeated fields have no presence.

waypoints() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___Waypoint]

class viam.proto.service.navigation.Zone(*, name: str = ..., type: str = ..., geometry: google.protobuf.struct_pb2.Struct | None = ..., max_speed: float | None = ...)

Bases: google.protobuf.message.Message

Zone is a named region on the active map. Geometry is a Struct following the Geometry shapes described in the Navigation API (circle, box, or polygon). Units follow the map type: millimeters on local maps, meters for GPS radii and sizes.

name: str

type: str

“keepout” or “speed_limit”

max_speed: float

Max speed in meters/sec; required when type is “speed_limit”

geometry() → google.protobuf.struct_pb2.Struct

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: _WhichOneofArgType__max_speed) → _WhichOneofReturnType__max_speed | None

Returns the name of the field that is set inside a oneof group.

If no field is set, returns None.

Parameters:

oneof_group (str) – the name of the oneof group to check.

Returns:

The name of the group that is set, or None.

Return type:

str or None

Raises:

ValueError – no group with the given name exists