protos/service/navigation library Protobuf Definitions

The proto definitions for navigation

Classes

AddLocationRequest
AddLocationResponse
AddRouteRequest
AddRouteResponse
AddZoneRequest
AddZoneResponse
CancelRequest
CancelResponse
DeleteLocationRequest
DeleteLocationResponse
DeleteRouteRequest
DeleteRouteResponse
DeleteZoneRequest
DeleteZoneResponse
ExecutePlanRequest
ExecutePlanResponse
GetCostmapRequest
GetCostmapResponse
GetLocationRequest
GetLocationResponse
GetNavigationStatusRequest
GetNavigationStatusResponse
GetPositionRequest
GetPositionResponse
GetPropertiesRequest
GetPropertiesResponse
GetRouteRequest
GetRouteResponse
GetZoneRequest
GetZoneResponse
GoalState
GoalStatus
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.
GoToLocationRequest
GoToLocationResponse
GoToPointRequest
GoToPointResponse
ListLocationsRequest
ListLocationsResponse
ListRoutesRequest
ListRoutesResponse
ListZonesRequest
ListZonesResponse
Location
Location is a named Position on the active map.
MapType
MapType represents the type of map the navigation service operates on. Each service instance uses exactly one map type.
Plan
Plan is a path preview returned by PlanToPoint and PlanToLocation.
PlanToLocationRequest
PlanToLocationResponse
PlanToPointRequest
PlanToPointResponse
Position
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.
Progress
Properties
Properties are returned by GetProperties and do not change while the service is running.
ResumeRequest
ResumeResponse
Route
Route is an ordered list of waypoints. A location can appear in more than one route, and more than once in the same route.
RouteProgress
Status
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.
SuspendRequest
SuspendResponse
UpdateLocationRequest
UpdateLocationResponse
UpdateRouteRequest
UpdateRouteResponse
UpdateZoneRequest
UpdateZoneResponse
Velocity
Waypoint
Waypoint is a route stop: either the name of a saved Location or an inline Position.
WaypointList
WaypointList is a wrapper so callers can distinguish an unset list from an empty one. Proto3 repeated fields have no presence.
Zone
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.

Enums

Position_Value
Waypoint_Value

Constants

AddLocationRequest$json → const Map<String, Object>
AddLocationResponse$json → const Map<String, Object>
AddRouteRequest$json → const Map<String, Object>
AddRouteResponse$json → const Map<String, Object>
AddZoneRequest$json → const Map<String, Object>
AddZoneResponse$json → const Map<String, Object>
CancelRequest$json → const Map<String, Object>
CancelResponse$json → const Map<String, Object>
DeleteLocationRequest$json → const Map<String, Object>
DeleteLocationResponse$json → const Map<String, String>
DeleteRouteRequest$json → const Map<String, Object>
DeleteRouteResponse$json → const Map<String, String>
DeleteZoneRequest$json → const Map<String, Object>
DeleteZoneResponse$json → const Map<String, String>
ExecutePlanRequest$json → const Map<String, Object>
ExecutePlanResponse$json → const Map<String, Object>
GetCostmapRequest$json → const Map<String, Object>
GetCostmapResponse$json → const Map<String, Object>
GetLocationRequest$json → const Map<String, Object>
GetLocationResponse$json → const Map<String, Object>
GetNavigationStatusRequest$json → const Map<String, Object>
GetNavigationStatusResponse$json → const Map<String, Object>
GetPositionRequest$json → const Map<String, Object>
GetPositionResponse$json → const Map<String, Object>
GetPropertiesRequest$json → const Map<String, Object>
GetPropertiesResponse$json → const Map<String, Object>
GetRouteRequest$json → const Map<String, Object>
GetRouteResponse$json → const Map<String, Object>
GetZoneRequest$json → const Map<String, Object>
GetZoneResponse$json → const Map<String, Object>
GoalState$json → const Map<String, Object>
GoalStatus$json → const Map<String, Object>
GoToLocationRequest$json → const Map<String, Object>
GoToLocationResponse$json → const Map<String, Object>
GoToPointRequest$json → const Map<String, Object>
GoToPointResponse$json → const Map<String, Object>
ListLocationsRequest$json → const Map<String, Object>
ListLocationsResponse$json → const Map<String, Object>
ListRoutesRequest$json → const Map<String, Object>
ListRoutesResponse$json → const Map<String, Object>
ListZonesRequest$json → const Map<String, Object>
ListZonesResponse$json → const Map<String, Object>
Location$json → const Map<String, Object>
MapType$json → const Map<String, Object>
Plan$json → const Map<String, Object>
PlanToLocationRequest$json → const Map<String, Object>
PlanToLocationResponse$json → const Map<String, Object>
PlanToPointRequest$json → const Map<String, Object>
PlanToPointResponse$json → const Map<String, Object>
Position$json → const Map<String, Object>
Progress$json → const Map<String, Object>
Properties$json → const Map<String, Object>
ResumeRequest$json → const Map<String, Object>
ResumeResponse$json → const Map<String, Object>
Route$json → const Map<String, Object>
RouteProgress$json → const Map<String, Object>
Status$json → const Map<String, Object>
SuspendRequest$json → const Map<String, Object>
SuspendResponse$json → const Map<String, Object>
UpdateLocationRequest$json → const Map<String, Object>
UpdateLocationResponse$json → const Map<String, Object>
UpdateRouteRequest$json → const Map<String, Object>
UpdateRouteResponse$json → const Map<String, Object>
UpdateZoneRequest$json → const Map<String, Object>
UpdateZoneResponse$json → const Map<String, Object>
Velocity$json → const Map<String, Object>
Waypoint$json → const Map<String, Object>
WaypointList$json → const Map<String, Object>
Zone$json → const Map<String, Object>

Properties

addLocationRequestDescriptor → Uint8List
Descriptor for AddLocationRequest. Decode as a google.protobuf.DescriptorProto.
final
addLocationResponseDescriptor → Uint8List
Descriptor for AddLocationResponse. Decode as a google.protobuf.DescriptorProto.
final
addRouteRequestDescriptor → Uint8List
Descriptor for AddRouteRequest. Decode as a google.protobuf.DescriptorProto.
final
addRouteResponseDescriptor → Uint8List
Descriptor for AddRouteResponse. Decode as a google.protobuf.DescriptorProto.
final
addZoneRequestDescriptor → Uint8List
Descriptor for AddZoneRequest. Decode as a google.protobuf.DescriptorProto.
final
addZoneResponseDescriptor → Uint8List
Descriptor for AddZoneResponse. Decode as a google.protobuf.DescriptorProto.
final
cancelRequestDescriptor → Uint8List
Descriptor for CancelRequest. Decode as a google.protobuf.DescriptorProto.
final
cancelResponseDescriptor → Uint8List
Descriptor for CancelResponse. Decode as a google.protobuf.DescriptorProto.
final
deleteLocationRequestDescriptor → Uint8List
Descriptor for DeleteLocationRequest. Decode as a google.protobuf.DescriptorProto.
final
deleteLocationResponseDescriptor → Uint8List
Descriptor for DeleteLocationResponse. Decode as a google.protobuf.DescriptorProto.
final
deleteRouteRequestDescriptor → Uint8List
Descriptor for DeleteRouteRequest. Decode as a google.protobuf.DescriptorProto.
final
deleteRouteResponseDescriptor → Uint8List
Descriptor for DeleteRouteResponse. Decode as a google.protobuf.DescriptorProto.
final
deleteZoneRequestDescriptor → Uint8List
Descriptor for DeleteZoneRequest. Decode as a google.protobuf.DescriptorProto.
final
deleteZoneResponseDescriptor → Uint8List
Descriptor for DeleteZoneResponse. Decode as a google.protobuf.DescriptorProto.
final
executePlanRequestDescriptor → Uint8List
Descriptor for ExecutePlanRequest. Decode as a google.protobuf.DescriptorProto.
final
executePlanResponseDescriptor → Uint8List
Descriptor for ExecutePlanResponse. Decode as a google.protobuf.DescriptorProto.
final
getCostmapRequestDescriptor → Uint8List
Descriptor for GetCostmapRequest. Decode as a google.protobuf.DescriptorProto.
final
getCostmapResponseDescriptor → Uint8List
Descriptor for GetCostmapResponse. Decode as a google.protobuf.DescriptorProto.
final
getLocationRequestDescriptor → Uint8List
Descriptor for GetLocationRequest. Decode as a google.protobuf.DescriptorProto.
final
getLocationResponseDescriptor → Uint8List
Descriptor for GetLocationResponse. Decode as a google.protobuf.DescriptorProto.
final
getNavigationStatusRequestDescriptor → Uint8List
Descriptor for GetNavigationStatusRequest. Decode as a google.protobuf.DescriptorProto.
final
getNavigationStatusResponseDescriptor → Uint8List
Descriptor for GetNavigationStatusResponse. Decode as a google.protobuf.DescriptorProto.
final
getPositionRequestDescriptor → Uint8List
Descriptor for GetPositionRequest. Decode as a google.protobuf.DescriptorProto.
final
getPositionResponseDescriptor → Uint8List
Descriptor for GetPositionResponse. Decode as a google.protobuf.DescriptorProto.
final
getPropertiesRequestDescriptor → Uint8List
Descriptor for GetPropertiesRequest. Decode as a google.protobuf.DescriptorProto.
final
getPropertiesResponseDescriptor → Uint8List
Descriptor for GetPropertiesResponse. Decode as a google.protobuf.DescriptorProto.
final
getRouteRequestDescriptor → Uint8List
Descriptor for GetRouteRequest. Decode as a google.protobuf.DescriptorProto.
final
getRouteResponseDescriptor → Uint8List
Descriptor for GetRouteResponse. Decode as a google.protobuf.DescriptorProto.
final
getZoneRequestDescriptor → Uint8List
Descriptor for GetZoneRequest. Decode as a google.protobuf.DescriptorProto.
final
getZoneResponseDescriptor → Uint8List
Descriptor for GetZoneResponse. Decode as a google.protobuf.DescriptorProto.
final
goalStateDescriptor → Uint8List
Descriptor for GoalState. Decode as a google.protobuf.EnumDescriptorProto.
final
goalStatusDescriptor → Uint8List
Descriptor for GoalStatus. Decode as a google.protobuf.DescriptorProto.
final
goToLocationRequestDescriptor → Uint8List
Descriptor for GoToLocationRequest. Decode as a google.protobuf.DescriptorProto.
final
goToLocationResponseDescriptor → Uint8List
Descriptor for GoToLocationResponse. Decode as a google.protobuf.DescriptorProto.
final
goToPointRequestDescriptor → Uint8List
Descriptor for GoToPointRequest. Decode as a google.protobuf.DescriptorProto.
final
goToPointResponseDescriptor → Uint8List
Descriptor for GoToPointResponse. Decode as a google.protobuf.DescriptorProto.
final
listLocationsRequestDescriptor → Uint8List
Descriptor for ListLocationsRequest. Decode as a google.protobuf.DescriptorProto.
final
listLocationsResponseDescriptor → Uint8List
Descriptor for ListLocationsResponse. Decode as a google.protobuf.DescriptorProto.
final
listRoutesRequestDescriptor → Uint8List
Descriptor for ListRoutesRequest. Decode as a google.protobuf.DescriptorProto.
final
listRoutesResponseDescriptor → Uint8List
Descriptor for ListRoutesResponse. Decode as a google.protobuf.DescriptorProto.
final
listZonesRequestDescriptor → Uint8List
Descriptor for ListZonesRequest. Decode as a google.protobuf.DescriptorProto.
final
listZonesResponseDescriptor → Uint8List
Descriptor for ListZonesResponse. Decode as a google.protobuf.DescriptorProto.
final
locationDescriptor → Uint8List
Descriptor for Location. Decode as a google.protobuf.DescriptorProto.
final
mapTypeDescriptor → Uint8List
Descriptor for MapType. Decode as a google.protobuf.EnumDescriptorProto.
final
Descriptor for NavErrorCode. Decode as a google.protobuf.EnumDescriptorProto.
final
Descriptor for NavError. Decode as a google.protobuf.DescriptorProto.
final
Descriptor for NavigateRouteRequest. Decode as a google.protobuf.DescriptorProto.
final
Descriptor for NavigateRouteResponse. Decode as a google.protobuf.DescriptorProto.
final
Descriptor for NavigateToLocationRequest. Decode as a google.protobuf.DescriptorProto.
final
Descriptor for NavigateToLocationResponse. Decode as a google.protobuf.DescriptorProto.
final
Descriptor for NavigateToPointRequest. Decode as a google.protobuf.DescriptorProto.
final
Descriptor for NavigateToPointResponse. Decode as a google.protobuf.DescriptorProto.
final
Descriptor for NavMode. Decode as a google.protobuf.EnumDescriptorProto.
final
planDescriptor → Uint8List
Descriptor for Plan. Decode as a google.protobuf.DescriptorProto.
final
planToLocationRequestDescriptor → Uint8List
Descriptor for PlanToLocationRequest. Decode as a google.protobuf.DescriptorProto.
final
planToLocationResponseDescriptor → Uint8List
Descriptor for PlanToLocationResponse. Decode as a google.protobuf.DescriptorProto.
final
planToPointRequestDescriptor → Uint8List
Descriptor for PlanToPointRequest. Decode as a google.protobuf.DescriptorProto.
final
planToPointResponseDescriptor → Uint8List
Descriptor for PlanToPointResponse. Decode as a google.protobuf.DescriptorProto.
final
positionDescriptor → Uint8List
Descriptor for Position. Decode as a google.protobuf.DescriptorProto.
final
progressDescriptor → Uint8List
Descriptor for Progress. Decode as a google.protobuf.DescriptorProto.
final
propertiesDescriptor → Uint8List
Descriptor for Properties. Decode as a google.protobuf.DescriptorProto.
final
resumeRequestDescriptor → Uint8List
Descriptor for ResumeRequest. Decode as a google.protobuf.DescriptorProto.
final
resumeResponseDescriptor → Uint8List
Descriptor for ResumeResponse. Decode as a google.protobuf.DescriptorProto.
final
routeDescriptor → Uint8List
Descriptor for Route. Decode as a google.protobuf.DescriptorProto.
final
routeProgressDescriptor → Uint8List
Descriptor for RouteProgress. Decode as a google.protobuf.DescriptorProto.
final
statusDescriptor → Uint8List
Descriptor for Status. Decode as a google.protobuf.DescriptorProto.
final
suspendRequestDescriptor → Uint8List
Descriptor for SuspendRequest. Decode as a google.protobuf.DescriptorProto.
final
suspendResponseDescriptor → Uint8List
Descriptor for SuspendResponse. Decode as a google.protobuf.DescriptorProto.
final
updateLocationRequestDescriptor → Uint8List
Descriptor for UpdateLocationRequest. Decode as a google.protobuf.DescriptorProto.
final
updateLocationResponseDescriptor → Uint8List
Descriptor for UpdateLocationResponse. Decode as a google.protobuf.DescriptorProto.
final
updateRouteRequestDescriptor → Uint8List
Descriptor for UpdateRouteRequest. Decode as a google.protobuf.DescriptorProto.
final
updateRouteResponseDescriptor → Uint8List
Descriptor for UpdateRouteResponse. Decode as a google.protobuf.DescriptorProto.
final
updateZoneRequestDescriptor → Uint8List
Descriptor for UpdateZoneRequest. Decode as a google.protobuf.DescriptorProto.
final
updateZoneResponseDescriptor → Uint8List
Descriptor for UpdateZoneResponse. Decode as a google.protobuf.DescriptorProto.
final
velocityDescriptor → Uint8List
Descriptor for Velocity. Decode as a google.protobuf.DescriptorProto.
final
waypointDescriptor → Uint8List
Descriptor for Waypoint. Decode as a google.protobuf.DescriptorProto.
final
waypointListDescriptor → Uint8List
Descriptor for WaypointList. Decode as a google.protobuf.DescriptorProto.
final
zoneDescriptor → Uint8List
Descriptor for Zone. Decode as a google.protobuf.DescriptorProto.
final