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

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

Attributes

`DESCRIPTOR`
`MAP_TYPE_UNSPECIFIED`
`MAP_TYPE_LOCAL`	Positions are Poses in the active SLAM map's frame
`MAP_TYPE_GPS`	Positions are GeoPoses
`Global___MapType`
`GOAL_STATE_UNSPECIFIED`
`GOAL_STATE_ACTIVE`
`GOAL_STATE_SUSPENDED`	Held; see Resume
`GOAL_STATE_SUCCEEDED`
`GOAL_STATE_FAILED`	See error
`GOAL_STATE_CANCELED`
`Global___GoalState`
`NAV_MODE_UNSPECIFIED`
`NAV_MODE_PLANNED`	NavigateTo*, ExecutePlan
`NAV_MODE_DIRECT`	GoTo*
`NAV_MODE_ROUTE`	NavigateRoute
`Global___NavMode`
`NAV_ERROR_CODE_UNSPECIFIED`
`NAV_ERROR_CODE_NO_PATH`
`NAV_ERROR_CODE_BLOCKED`
`NAV_ERROR_CODE_LOCALIZATION_LOST`
`NAV_ERROR_CODE_BASE_ERROR`
`NAV_ERROR_CODE_TIMEOUT`
`NAV_ERROR_CODE_OTHER`
`Global___NavErrorCode`
`Global___Position`
`Global___Location`
`Global___Waypoint`
`Global___Route`
`Global___Zone`
`Global___Plan`
`Global___Velocity`
`Global___NavError`
`Global___Progress`
`Global___RouteProgress`
`Global___GoalStatus`
`Global___Status`
`Global___Properties`
`Global___AddLocationRequest`
`Global___AddLocationResponse`
`Global___GetLocationRequest`
`Global___GetLocationResponse`
`Global___ListLocationsRequest`
`Global___ListLocationsResponse`
`Global___UpdateLocationRequest`
`Global___UpdateLocationResponse`
`Global___DeleteLocationRequest`
`Global___DeleteLocationResponse`
`Global___AddRouteRequest`
`Global___AddRouteResponse`
`Global___GetRouteRequest`
`Global___GetRouteResponse`
`Global___ListRoutesRequest`
`Global___ListRoutesResponse`
`Global___WaypointList`
`Global___UpdateRouteRequest`
`Global___UpdateRouteResponse`
`Global___DeleteRouteRequest`
`Global___DeleteRouteResponse`
`Global___AddZoneRequest`
`Global___AddZoneResponse`
`Global___GetZoneRequest`
`Global___GetZoneResponse`
`Global___ListZonesRequest`
`Global___ListZonesResponse`
`Global___UpdateZoneRequest`
`Global___UpdateZoneResponse`
`Global___DeleteZoneRequest`
`Global___DeleteZoneResponse`
`Global___NavigateToLocationRequest`
`Global___NavigateToLocationResponse`
`Global___NavigateToPointRequest`
`Global___NavigateToPointResponse`
`Global___NavigateRouteRequest`
`Global___NavigateRouteResponse`
`Global___PlanToPointRequest`
`Global___PlanToPointResponse`
`Global___PlanToLocationRequest`
`Global___PlanToLocationResponse`
`Global___ExecutePlanRequest`
`Global___ExecutePlanResponse`
`Global___GoToLocationRequest`
`Global___GoToLocationResponse`
`Global___GoToPointRequest`
`Global___GoToPointResponse`
`Global___SuspendRequest`
`Global___SuspendResponse`
`Global___ResumeRequest`
`Global___ResumeResponse`
`Global___CancelRequest`
`Global___CancelResponse`
`Global___GetPositionRequest`
`Global___GetPositionResponse`
`Global___GetNavigationStatusRequest`
`Global___GetNavigationStatusResponse`
`Global___GetPropertiesRequest`
`Global___GetPropertiesResponse`
`Global___GetCostmapRequest`
`Global___GetCostmapResponse`

Classes

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

Module Contents

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 type of map the navigation service operates on. Each service instance uses exactly one map type.

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

viam.gen.service.navigation.v1.navigation_pb2.MAP_TYPE_LOCAL: MapType: Positions are Poses in the active SLAM map’s frame

viam.gen.service.navigation.v1.navigation_pb2.MAP_TYPE_GPS: MapType: Positions are GeoPoses

type viam.gen.service.navigation.v1.navigation_pb2.Global___MapType = MapType

class viam.gen.service.navigation.v1.navigation_pb2.GoalState: Bases: _GoalState

viam.gen.service.navigation.v1.navigation_pb2.GOAL_STATE_UNSPECIFIED: GoalState

viam.gen.service.navigation.v1.navigation_pb2.GOAL_STATE_ACTIVE: GoalState

viam.gen.service.navigation.v1.navigation_pb2.GOAL_STATE_SUSPENDED: GoalState: Held; see Resume

viam.gen.service.navigation.v1.navigation_pb2.GOAL_STATE_SUCCEEDED: GoalState

viam.gen.service.navigation.v1.navigation_pb2.GOAL_STATE_FAILED: GoalState: See error

viam.gen.service.navigation.v1.navigation_pb2.GOAL_STATE_CANCELED: GoalState

type viam.gen.service.navigation.v1.navigation_pb2.Global___GoalState = GoalState

class viam.gen.service.navigation.v1.navigation_pb2.NavMode: Bases: _NavMode

viam.gen.service.navigation.v1.navigation_pb2.NAV_MODE_UNSPECIFIED: NavMode

viam.gen.service.navigation.v1.navigation_pb2.NAV_MODE_PLANNED: NavMode: NavigateTo*, ExecutePlan

viam.gen.service.navigation.v1.navigation_pb2.NAV_MODE_DIRECT: NavMode: GoTo*

viam.gen.service.navigation.v1.navigation_pb2.NAV_MODE_ROUTE: NavMode: NavigateRoute

type viam.gen.service.navigation.v1.navigation_pb2.Global___NavMode = NavMode

class viam.gen.service.navigation.v1.navigation_pb2.NavErrorCode: Bases: _NavErrorCode

viam.gen.service.navigation.v1.navigation_pb2.NAV_ERROR_CODE_UNSPECIFIED: NavErrorCode

viam.gen.service.navigation.v1.navigation_pb2.NAV_ERROR_CODE_NO_PATH: NavErrorCode

viam.gen.service.navigation.v1.navigation_pb2.NAV_ERROR_CODE_BLOCKED: NavErrorCode

viam.gen.service.navigation.v1.navigation_pb2.NAV_ERROR_CODE_LOCALIZATION_LOST: NavErrorCode

viam.gen.service.navigation.v1.navigation_pb2.NAV_ERROR_CODE_BASE_ERROR: NavErrorCode

viam.gen.service.navigation.v1.navigation_pb2.NAV_ERROR_CODE_TIMEOUT: NavErrorCode

viam.gen.service.navigation.v1.navigation_pb2.NAV_ERROR_CODE_OTHER: NavErrorCode

type viam.gen.service.navigation.v1.navigation_pb2.Global___NavErrorCode = NavErrorCode

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

type viam.gen.service.navigation.v1.navigation_pb2.Global___Position = Position

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

type viam.gen.service.navigation.v1.navigation_pb2.Global___Location = Location

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

type viam.gen.service.navigation.v1.navigation_pb2.Global___Waypoint = Waypoint

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

type viam.gen.service.navigation.v1.navigation_pb2.Global___Route = Route

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

type viam.gen.service.navigation.v1.navigation_pb2.Global___Zone = Zone

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

type viam.gen.service.navigation.v1.navigation_pb2.Global___Plan = Plan

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

type viam.gen.service.navigation.v1.navigation_pb2.Global___Velocity = Velocity

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

type viam.gen.service.navigation.v1.navigation_pb2.Global___NavError = NavError

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

type viam.gen.service.navigation.v1.navigation_pb2.Global___Progress = Progress

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

type viam.gen.service.navigation.v1.navigation_pb2.Global___RouteProgress = RouteProgress

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

type viam.gen.service.navigation.v1.navigation_pb2.Global___GoalStatus = GoalStatus

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

type viam.gen.service.navigation.v1.navigation_pb2.Global___Status = Status

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

type viam.gen.service.navigation.v1.navigation_pb2.Global___Properties = Properties

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

type viam.gen.service.navigation.v1.navigation_pb2.Global___AddLocationRequest = AddLocationRequest

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

type viam.gen.service.navigation.v1.navigation_pb2.Global___AddLocationResponse = AddLocationResponse

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

type viam.gen.service.navigation.v1.navigation_pb2.Global___GetLocationRequest = GetLocationRequest

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

type viam.gen.service.navigation.v1.navigation_pb2.Global___GetLocationResponse = GetLocationResponse

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

type viam.gen.service.navigation.v1.navigation_pb2.Global___ListLocationsRequest = ListLocationsRequest

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

type viam.gen.service.navigation.v1.navigation_pb2.Global___ListLocationsResponse = ListLocationsResponse

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

type viam.gen.service.navigation.v1.navigation_pb2.Global___UpdateLocationRequest = UpdateLocationRequest

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

type viam.gen.service.navigation.v1.navigation_pb2.Global___UpdateLocationResponse = UpdateLocationResponse

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

type viam.gen.service.navigation.v1.navigation_pb2.Global___DeleteLocationRequest = DeleteLocationRequest

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

type viam.gen.service.navigation.v1.navigation_pb2.Global___DeleteLocationResponse = DeleteLocationResponse

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

type viam.gen.service.navigation.v1.navigation_pb2.Global___AddRouteRequest = AddRouteRequest

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

type viam.gen.service.navigation.v1.navigation_pb2.Global___AddRouteResponse = AddRouteResponse

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

type viam.gen.service.navigation.v1.navigation_pb2.Global___GetRouteRequest = GetRouteRequest

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

type viam.gen.service.navigation.v1.navigation_pb2.Global___GetRouteResponse = GetRouteResponse

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

type viam.gen.service.navigation.v1.navigation_pb2.Global___ListRoutesRequest = ListRoutesRequest

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

type viam.gen.service.navigation.v1.navigation_pb2.Global___ListRoutesResponse = ListRoutesResponse

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

type viam.gen.service.navigation.v1.navigation_pb2.Global___WaypointList = WaypointList

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

type viam.gen.service.navigation.v1.navigation_pb2.Global___UpdateRouteRequest = UpdateRouteRequest

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

type viam.gen.service.navigation.v1.navigation_pb2.Global___UpdateRouteResponse = UpdateRouteResponse

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

type viam.gen.service.navigation.v1.navigation_pb2.Global___DeleteRouteRequest = DeleteRouteRequest

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

type viam.gen.service.navigation.v1.navigation_pb2.Global___DeleteRouteResponse = DeleteRouteResponse

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

type viam.gen.service.navigation.v1.navigation_pb2.Global___AddZoneRequest = AddZoneRequest

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

type viam.gen.service.navigation.v1.navigation_pb2.Global___AddZoneResponse = AddZoneResponse

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

type viam.gen.service.navigation.v1.navigation_pb2.Global___GetZoneRequest = GetZoneRequest

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

type viam.gen.service.navigation.v1.navigation_pb2.Global___GetZoneResponse = GetZoneResponse

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

type viam.gen.service.navigation.v1.navigation_pb2.Global___ListZonesRequest = ListZonesRequest

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

type viam.gen.service.navigation.v1.navigation_pb2.Global___ListZonesResponse = ListZonesResponse

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

type viam.gen.service.navigation.v1.navigation_pb2.Global___UpdateZoneRequest = UpdateZoneRequest

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

type viam.gen.service.navigation.v1.navigation_pb2.Global___UpdateZoneResponse = UpdateZoneResponse

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

type viam.gen.service.navigation.v1.navigation_pb2.Global___DeleteZoneRequest = DeleteZoneRequest

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

type viam.gen.service.navigation.v1.navigation_pb2.Global___DeleteZoneResponse = DeleteZoneResponse

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

type viam.gen.service.navigation.v1.navigation_pb2.Global___NavigateToLocationRequest = NavigateToLocationRequest

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

type viam.gen.service.navigation.v1.navigation_pb2.Global___NavigateToLocationResponse = NavigateToLocationResponse

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

type viam.gen.service.navigation.v1.navigation_pb2.Global___NavigateToPointRequest = NavigateToPointRequest

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

type viam.gen.service.navigation.v1.navigation_pb2.Global___NavigateToPointResponse = NavigateToPointResponse

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

type viam.gen.service.navigation.v1.navigation_pb2.Global___NavigateRouteRequest = NavigateRouteRequest

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

type viam.gen.service.navigation.v1.navigation_pb2.Global___NavigateRouteResponse = NavigateRouteResponse

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

type viam.gen.service.navigation.v1.navigation_pb2.Global___PlanToPointRequest = PlanToPointRequest

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

type viam.gen.service.navigation.v1.navigation_pb2.Global___PlanToPointResponse = PlanToPointResponse

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

type viam.gen.service.navigation.v1.navigation_pb2.Global___PlanToLocationRequest = PlanToLocationRequest

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

type viam.gen.service.navigation.v1.navigation_pb2.Global___PlanToLocationResponse = PlanToLocationResponse

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

type viam.gen.service.navigation.v1.navigation_pb2.Global___ExecutePlanRequest = ExecutePlanRequest

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

type viam.gen.service.navigation.v1.navigation_pb2.Global___ExecutePlanResponse = ExecutePlanResponse

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

type viam.gen.service.navigation.v1.navigation_pb2.Global___GoToLocationRequest = GoToLocationRequest

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

type viam.gen.service.navigation.v1.navigation_pb2.Global___GoToLocationResponse = GoToLocationResponse

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

type viam.gen.service.navigation.v1.navigation_pb2.Global___GoToPointRequest = GoToPointRequest

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

type viam.gen.service.navigation.v1.navigation_pb2.Global___GoToPointResponse = GoToPointResponse

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

type viam.gen.service.navigation.v1.navigation_pb2.Global___SuspendRequest = SuspendRequest

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

type viam.gen.service.navigation.v1.navigation_pb2.Global___SuspendResponse = SuspendResponse

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

type viam.gen.service.navigation.v1.navigation_pb2.Global___ResumeRequest = ResumeRequest

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

type viam.gen.service.navigation.v1.navigation_pb2.Global___ResumeResponse = ResumeResponse

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

type viam.gen.service.navigation.v1.navigation_pb2.Global___CancelRequest = CancelRequest

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

type viam.gen.service.navigation.v1.navigation_pb2.Global___CancelResponse = CancelResponse

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

type viam.gen.service.navigation.v1.navigation_pb2.Global___GetPositionRequest = GetPositionRequest

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

type viam.gen.service.navigation.v1.navigation_pb2.Global___GetPositionResponse = GetPositionResponse

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

type viam.gen.service.navigation.v1.navigation_pb2.Global___GetNavigationStatusRequest = GetNavigationStatusRequest

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

type viam.gen.service.navigation.v1.navigation_pb2.Global___GetNavigationStatusResponse = GetNavigationStatusResponse

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

type viam.gen.service.navigation.v1.navigation_pb2.Global___GetPropertiesRequest = GetPropertiesRequest

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

type viam.gen.service.navigation.v1.navigation_pb2.Global___GetPropertiesResponse = GetPropertiesResponse

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

type viam.gen.service.navigation.v1.navigation_pb2.Global___GetCostmapRequest = GetCostmapRequest

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

type viam.gen.service.navigation.v1.navigation_pb2.Global___GetCostmapResponse = GetCostmapResponse