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
`AddWaypointRequest`	Abstract base class for protocol messages.
`AddWaypointResponse`	Abstract base class for protocol messages.
`GetLocationRequest`	Abstract base class for protocol messages.
`GetLocationResponse`	Abstract base class for protocol messages.
`GetModeRequest`	Abstract base class for protocol messages.
`GetModeResponse`	Abstract base class for protocol messages.
`GetObstaclesRequest`	GetObstacles will return the geopoint location and geometry of all
`GetObstaclesResponse`	Abstract base class for protocol messages.
`GetPathsRequest`	Returns all the paths known to the navigation service
`GetPathsResponse`	Abstract base class for protocol messages.
`GetPropertiesRequest`	Abstract base class for protocol messages.
`GetPropertiesResponse`	Returns properties information for the named navigation service
`GetWaypointsRequest`	Abstract base class for protocol messages.
`GetWaypointsResponse`	Abstract base class for protocol messages.
`MapType`	MapType represents the various types of maps the navigation service can ingest.
`Mode`
`Path`	A user provided destination and the set of geopoints that
`RemoveWaypointRequest`	Abstract base class for protocol messages.
`RemoveWaypointResponse`	Abstract base class for protocol messages.
`SetModeRequest`	Abstract base class for protocol messages.
`SetModeResponse`	Abstract base class for protocol messages.
`Waypoint`	Abstract base class for protocol messages.

Package Contents

class viam.proto.service.navigation.NavigationServiceBase[source]

Bases: abc.ABC

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

abstract GetMode(stream: grpclib.server.Stream[service.navigation.v1.navigation_pb2.GetModeRequest, service.navigation.v1.navigation_pb2.GetModeResponse]) → None[source]

Async:

abstract SetMode(stream: grpclib.server.Stream[service.navigation.v1.navigation_pb2.SetModeRequest, service.navigation.v1.navigation_pb2.SetModeResponse]) → None[source]

Async:

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

Async:

abstract GetWaypoints(stream: grpclib.server.Stream[service.navigation.v1.navigation_pb2.GetWaypointsRequest, service.navigation.v1.navigation_pb2.GetWaypointsResponse]) → None[source]

Async:

abstract AddWaypoint(stream: grpclib.server.Stream[service.navigation.v1.navigation_pb2.AddWaypointRequest, service.navigation.v1.navigation_pb2.AddWaypointResponse]) → None[source]

Async:

abstract RemoveWaypoint(stream: grpclib.server.Stream[service.navigation.v1.navigation_pb2.RemoveWaypointRequest, service.navigation.v1.navigation_pb2.RemoveWaypointResponse]) → None[source]

Async:

abstract GetObstacles(stream: grpclib.server.Stream[service.navigation.v1.navigation_pb2.GetObstaclesRequest, service.navigation.v1.navigation_pb2.GetObstaclesResponse]) → None[source]

Async:

abstract GetPaths(stream: grpclib.server.Stream[service.navigation.v1.navigation_pb2.GetPathsRequest, service.navigation.v1.navigation_pb2.GetPathsResponse]) → None[source]

Async:

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

Async:

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

Async:

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

class viam.proto.service.navigation.NavigationServiceStub(channel: grpclib.client.Channel)[source]

GetMode

SetMode

GetLocation

GetWaypoints

AddWaypoint

RemoveWaypoint

GetObstacles

GetPaths

GetProperties

DoCommand

class viam.proto.service.navigation.UnimplementedNavigationServiceBase[source]

Bases: NavigationServiceBase

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

async GetMode(stream: grpclib.server.Stream[service.navigation.v1.navigation_pb2.GetModeRequest, service.navigation.v1.navigation_pb2.GetModeResponse]) → None[source]

async SetMode(stream: grpclib.server.Stream[service.navigation.v1.navigation_pb2.SetModeRequest, service.navigation.v1.navigation_pb2.SetModeResponse]) → None[source]

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

async GetWaypoints(stream: grpclib.server.Stream[service.navigation.v1.navigation_pb2.GetWaypointsRequest, service.navigation.v1.navigation_pb2.GetWaypointsResponse]) → None[source]

async AddWaypoint(stream: grpclib.server.Stream[service.navigation.v1.navigation_pb2.AddWaypointRequest, service.navigation.v1.navigation_pb2.AddWaypointResponse]) → None[source]

async RemoveWaypoint(stream: grpclib.server.Stream[service.navigation.v1.navigation_pb2.RemoveWaypointRequest, service.navigation.v1.navigation_pb2.RemoveWaypointResponse]) → None[source]

async GetObstacles(stream: grpclib.server.Stream[service.navigation.v1.navigation_pb2.GetObstaclesRequest, service.navigation.v1.navigation_pb2.GetObstaclesResponse]) → None[source]

async GetPaths(stream: grpclib.server.Stream[service.navigation.v1.navigation_pb2.GetPathsRequest, service.navigation.v1.navigation_pb2.GetPathsResponse]) → None[source]

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

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

class viam.proto.service.navigation.AddWaypointRequest(*, name: str = ..., location: viam.gen.common.v1.common_pb2.GeoPoint | 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

property location: viam.gen.common.v1.common_pb2.GeoPoint

property extra: google.protobuf.struct_pb2.Struct: Additional arguments to the method

HasField(field_name: Literal['extra', b'extra', 'location', b'location']) → 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.AddWaypointResponse

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.GetLocationRequest(*, 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

property extra: google.protobuf.struct_pb2.Struct: Additional arguments to the method

HasField(field_name: Literal['extra', b'extra']) → 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: viam.gen.common.v1.common_pb2.GeoPoint | None = ..., compass_heading: 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.

compass_heading: float: A number from [0-360) where 0 is north 90 is east, 180 is south, 270 is west

property location: viam.gen.common.v1.common_pb2.GeoPoint

HasField(field_name: Literal['location', b'location']) → 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.GetModeRequest(*, 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

property extra: google.protobuf.struct_pb2.Struct: Additional arguments to the method

HasField(field_name: Literal['extra', b'extra']) → 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.GetModeResponse(*, mode: global___Mode = ...)

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.

mode: global___Mode

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

Bases: google.protobuf.message.Message

GetObstacles will return the geopoint location and geometry of all known obstacles on the navigation map. Obstacles that are detected through the vision service will only be returned if this endpoint is called when the robot is sensing the obstacle

name: str

property extra: google.protobuf.struct_pb2.Struct: Additional arguments to the method

HasField(field_name: Literal['extra', b'extra']) → 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.GetObstaclesResponse(*, obstacles: collections.abc.Iterable[viam.gen.common.v1.common_pb2.GeoGeometry] | 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.

property obstacles: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[viam.gen.common.v1.common_pb2.GeoGeometry]: List of all known geometries

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

Bases: google.protobuf.message.Message

Returns all the paths known to the navigation service

name: str: Name of the navigation service

property extra: google.protobuf.struct_pb2.Struct

HasField(field_name: Literal['extra', b'extra']) → 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.GetPathsResponse(*, paths: collections.abc.Iterable[global___Path] | 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.

property paths: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Path]

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(*, map_type: global___MapType = ...)

Bases: google.protobuf.message.Message

Returns properties information for the named navigation service

map_type: global___MapType

class viam.proto.service.navigation.GetWaypointsRequest(*, 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

property extra: google.protobuf.struct_pb2.Struct: Additional arguments to the method

HasField(field_name: Literal['extra', b'extra']) → 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.GetWaypointsResponse(*, waypoints: collections.abc.Iterable[global___Waypoint] | 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.

property waypoints: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Waypoint]

class viam.proto.service.navigation.MapType

Bases: _MapType

MapType represents the various types of maps the navigation service can ingest.

class viam.proto.service.navigation.Mode: Bases: _Mode

class viam.proto.service.navigation.Path(*, destination_waypoint_id: str = ..., geopoints: collections.abc.Iterable[viam.gen.common.v1.common_pb2.GeoPoint] | None = ...)

Bases: google.protobuf.message.Message

A user provided destination and the set of geopoints that the robot is expected to take to get there

destination_waypoint_id: str: The id of the user specified waypoint

property geopoints: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[viam.gen.common.v1.common_pb2.GeoPoint]: List of geopoints that the motion planner output to reach the destination The first geopoint is the starting position of the robot for that path

class viam.proto.service.navigation.RemoveWaypointRequest(*, name: str = ..., id: 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

id: str

property extra: google.protobuf.struct_pb2.Struct: Additional arguments to the method

HasField(field_name: Literal['extra', b'extra']) → 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.RemoveWaypointResponse

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.SetModeRequest(*, name: str = ..., mode: global___Mode = ..., 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

mode: global___Mode

property extra: google.protobuf.struct_pb2.Struct: Additional arguments to the method

HasField(field_name: Literal['extra', b'extra']) → 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.SetModeResponse

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.Waypoint(*, id: str = ..., location: viam.gen.common.v1.common_pb2.GeoPoint | 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.

id: str

property location: viam.gen.common.v1.common_pb2.GeoPoint

HasField(field_name: Literal['location', b'location']) → 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.