`viam.gen.service.navigation.v1.navigation_pb2`

@generated by mypy-protobuf. Do not edit manually! isort:skip_file

Module Contents

Classes

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

Attributes

`DESCRIPTOR`
`MAP_TYPE_UNSPECIFIED`
`MAP_TYPE_NONE`
`MAP_TYPE_GPS`
`global___MapType`
`MODE_UNSPECIFIED`
`MODE_MANUAL`
`MODE_WAYPOINT`
`MODE_EXPLORE`
`global___Mode`
`global___GetModeRequest`
`global___GetModeResponse`
`global___SetModeRequest`
`global___SetModeResponse`
`global___Waypoint`
`global___GetLocationRequest`
`global___GetLocationResponse`
`global___GetWaypointsRequest`
`global___GetWaypointsResponse`
`global___AddWaypointRequest`
`global___AddWaypointResponse`
`global___RemoveWaypointRequest`
`global___RemoveWaypointResponse`
`global___GetObstaclesRequest`
`global___GetObstaclesResponse`
`global___Path`
`global___GetPathsRequest`
`global___GetPathsResponse`
`global___GetPropertiesRequest`
`global___GetPropertiesResponse`

viam.gen.service.navigation.v1.navigation_pb2.DESCRIPTOR: google.protobuf.descriptor.FileDescriptor

class viam.gen.service.navigation.v1.navigation_pb2.MapType

Bases: _MapType

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

viam.gen.service.navigation.v1.navigation_pb2.MAP_TYPE_UNSPECIFIED: MapType

viam.gen.service.navigation.v1.navigation_pb2.MAP_TYPE_NONE: MapType

viam.gen.service.navigation.v1.navigation_pb2.MAP_TYPE_GPS: MapType

viam.gen.service.navigation.v1.navigation_pb2.global___MapType

class viam.gen.service.navigation.v1.navigation_pb2.Mode: Bases: _Mode

viam.gen.service.navigation.v1.navigation_pb2.MODE_UNSPECIFIED: Mode

viam.gen.service.navigation.v1.navigation_pb2.MODE_MANUAL: Mode

viam.gen.service.navigation.v1.navigation_pb2.MODE_WAYPOINT: Mode

viam.gen.service.navigation.v1.navigation_pb2.MODE_EXPLORE: Mode

viam.gen.service.navigation.v1.navigation_pb2.global___Mode

class viam.gen.service.navigation.v1.navigation_pb2.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.

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

name: str

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.

viam.gen.service.navigation.v1.navigation_pb2.global___GetModeRequest

class viam.gen.service.navigation.v1.navigation_pb2.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

viam.gen.service.navigation.v1.navigation_pb2.global___GetModeResponse

class viam.gen.service.navigation.v1.navigation_pb2.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.

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

name: str

mode: global___Mode

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.

viam.gen.service.navigation.v1.navigation_pb2.global___SetModeRequest

class viam.gen.service.navigation.v1.navigation_pb2.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.

viam.gen.service.navigation.v1.navigation_pb2.global___SetModeResponse

class viam.gen.service.navigation.v1.navigation_pb2.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.

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

id: str

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.

viam.gen.service.navigation.v1.navigation_pb2.global___Waypoint

class viam.gen.service.navigation.v1.navigation_pb2.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.

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

name: str

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.

viam.gen.service.navigation.v1.navigation_pb2.global___GetLocationRequest

class viam.gen.service.navigation.v1.navigation_pb2.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.

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

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

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.

viam.gen.service.navigation.v1.navigation_pb2.global___GetLocationResponse

class viam.gen.service.navigation.v1.navigation_pb2.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.

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

name: str

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.

viam.gen.service.navigation.v1.navigation_pb2.global___GetWaypointsRequest

class viam.gen.service.navigation.v1.navigation_pb2.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]

viam.gen.service.navigation.v1.navigation_pb2.global___GetWaypointsResponse

class viam.gen.service.navigation.v1.navigation_pb2.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.

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

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

name: str

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.

viam.gen.service.navigation.v1.navigation_pb2.global___AddWaypointRequest

class viam.gen.service.navigation.v1.navigation_pb2.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.

viam.gen.service.navigation.v1.navigation_pb2.global___AddWaypointResponse

class viam.gen.service.navigation.v1.navigation_pb2.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.

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

name: str

id: str

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.

viam.gen.service.navigation.v1.navigation_pb2.global___RemoveWaypointRequest

class viam.gen.service.navigation.v1.navigation_pb2.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.

viam.gen.service.navigation.v1.navigation_pb2.global___RemoveWaypointResponse

class viam.gen.service.navigation.v1.navigation_pb2.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

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

name: str

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.

viam.gen.service.navigation.v1.navigation_pb2.global___GetObstaclesRequest

class viam.gen.service.navigation.v1.navigation_pb2.GetObstaclesResponse(*, obstacles: collections.abc.Iterable[viam.gen.common.v1.common_pb2.GeoObstacle] | 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.GeoObstacle]: List of all known geometries

viam.gen.service.navigation.v1.navigation_pb2.global___GetObstaclesResponse

class viam.gen.service.navigation.v1.navigation_pb2.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

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

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

viam.gen.service.navigation.v1.navigation_pb2.global___Path

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

Bases: google.protobuf.message.Message

Returns all the paths known to the navigation service

property extra: google.protobuf.struct_pb2.Struct

name: str: Name of the navigation service

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.

viam.gen.service.navigation.v1.navigation_pb2.global___GetPathsRequest

class viam.gen.service.navigation.v1.navigation_pb2.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]

viam.gen.service.navigation.v1.navigation_pb2.global___GetPathsResponse

class viam.gen.service.navigation.v1.navigation_pb2.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

viam.gen.service.navigation.v1.navigation_pb2.global___GetPropertiesRequest

class viam.gen.service.navigation.v1.navigation_pb2.GetPropertiesResponse(*, map_type: global___MapType = ...)

Bases: google.protobuf.message.Message

Returns properties information for the named navigation service

map_type: global___MapType

viam.gen.service.navigation.v1.navigation_pb2.global___GetPropertiesResponse

viam.gen.service.navigation.v1.navigation_pb2

Module Contents

Classes

Attributes

`viam.gen.service.navigation.v1.navigation_pb2`