:py:mod:`viam.gen.service.navigation.v1.navigation_pb2` ======================================================= .. py:module:: viam.gen.service.navigation.v1.navigation_pb2 .. autoapi-nested-parse:: @generated by mypy-protobuf. Do not edit manually! isort:skip_file Module Contents --------------- Classes ~~~~~~~ .. autoapisummary:: viam.gen.service.navigation.v1.navigation_pb2.MapType viam.gen.service.navigation.v1.navigation_pb2.Mode viam.gen.service.navigation.v1.navigation_pb2.GetModeRequest viam.gen.service.navigation.v1.navigation_pb2.GetModeResponse viam.gen.service.navigation.v1.navigation_pb2.SetModeRequest viam.gen.service.navigation.v1.navigation_pb2.SetModeResponse viam.gen.service.navigation.v1.navigation_pb2.Waypoint viam.gen.service.navigation.v1.navigation_pb2.GetLocationRequest viam.gen.service.navigation.v1.navigation_pb2.GetLocationResponse viam.gen.service.navigation.v1.navigation_pb2.GetWaypointsRequest viam.gen.service.navigation.v1.navigation_pb2.GetWaypointsResponse viam.gen.service.navigation.v1.navigation_pb2.AddWaypointRequest viam.gen.service.navigation.v1.navigation_pb2.AddWaypointResponse viam.gen.service.navigation.v1.navigation_pb2.RemoveWaypointRequest viam.gen.service.navigation.v1.navigation_pb2.RemoveWaypointResponse viam.gen.service.navigation.v1.navigation_pb2.GetObstaclesRequest viam.gen.service.navigation.v1.navigation_pb2.GetObstaclesResponse viam.gen.service.navigation.v1.navigation_pb2.Path viam.gen.service.navigation.v1.navigation_pb2.GetPathsRequest viam.gen.service.navigation.v1.navigation_pb2.GetPathsResponse viam.gen.service.navigation.v1.navigation_pb2.GetPropertiesRequest viam.gen.service.navigation.v1.navigation_pb2.GetPropertiesResponse Attributes ~~~~~~~~~~ .. autoapisummary:: viam.gen.service.navigation.v1.navigation_pb2.DESCRIPTOR viam.gen.service.navigation.v1.navigation_pb2.MAP_TYPE_UNSPECIFIED viam.gen.service.navigation.v1.navigation_pb2.MAP_TYPE_NONE viam.gen.service.navigation.v1.navigation_pb2.MAP_TYPE_GPS viam.gen.service.navigation.v1.navigation_pb2.global___MapType viam.gen.service.navigation.v1.navigation_pb2.MODE_UNSPECIFIED viam.gen.service.navigation.v1.navigation_pb2.MODE_MANUAL viam.gen.service.navigation.v1.navigation_pb2.MODE_WAYPOINT viam.gen.service.navigation.v1.navigation_pb2.MODE_EXPLORE viam.gen.service.navigation.v1.navigation_pb2.global___Mode viam.gen.service.navigation.v1.navigation_pb2.global___GetModeRequest viam.gen.service.navigation.v1.navigation_pb2.global___GetModeResponse viam.gen.service.navigation.v1.navigation_pb2.global___SetModeRequest viam.gen.service.navigation.v1.navigation_pb2.global___SetModeResponse viam.gen.service.navigation.v1.navigation_pb2.global___Waypoint viam.gen.service.navigation.v1.navigation_pb2.global___GetLocationRequest viam.gen.service.navigation.v1.navigation_pb2.global___GetLocationResponse viam.gen.service.navigation.v1.navigation_pb2.global___GetWaypointsRequest viam.gen.service.navigation.v1.navigation_pb2.global___GetWaypointsResponse viam.gen.service.navigation.v1.navigation_pb2.global___AddWaypointRequest viam.gen.service.navigation.v1.navigation_pb2.global___AddWaypointResponse viam.gen.service.navigation.v1.navigation_pb2.global___RemoveWaypointRequest viam.gen.service.navigation.v1.navigation_pb2.global___RemoveWaypointResponse viam.gen.service.navigation.v1.navigation_pb2.global___GetObstaclesRequest viam.gen.service.navigation.v1.navigation_pb2.global___GetObstaclesResponse viam.gen.service.navigation.v1.navigation_pb2.global___Path viam.gen.service.navigation.v1.navigation_pb2.global___GetPathsRequest viam.gen.service.navigation.v1.navigation_pb2.global___GetPathsResponse viam.gen.service.navigation.v1.navigation_pb2.global___GetPropertiesRequest viam.gen.service.navigation.v1.navigation_pb2.global___GetPropertiesResponse .. py:data:: DESCRIPTOR :type: google.protobuf.descriptor.FileDescriptor .. py:class:: MapType Bases: :py:obj:`_MapType` MapType represents the various types of maps the navigation service can ingest. .. py:data:: MAP_TYPE_UNSPECIFIED :type: MapType .. py:data:: MAP_TYPE_NONE :type: MapType .. py:data:: MAP_TYPE_GPS :type: MapType .. py:data:: global___MapType .. py:class:: Mode Bases: :py:obj:`_Mode` .. py:data:: MODE_UNSPECIFIED :type: Mode .. py:data:: MODE_MANUAL :type: Mode .. py:data:: MODE_WAYPOINT :type: Mode .. py:data:: MODE_EXPLORE :type: Mode .. py:data:: global___Mode .. py:class:: GetModeRequest(*, name: str = ..., extra: google.protobuf.struct_pb2.Struct | None = ...) Bases: :py:obj:`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. .. py:property:: extra :type: google.protobuf.struct_pb2.Struct Additional arguments to the method .. py:attribute:: name :type: str .. py:method:: HasField(field_name: Literal[extra, b'extra']) -> bool Checks if a certain field is set for the message. For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, :exc:`ValueError` will be raised. :param field_name: The name of the field to check for presence. :type field_name: str :returns: Whether a value has been set for the named field. :rtype: bool :raises ValueError: if the `field_name` is not a member of this message. .. py:data:: global___GetModeRequest .. py:class:: GetModeResponse(*, mode: global___Mode = ...) Bases: :py:obj:`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. .. py:attribute:: mode :type: global___Mode .. py:data:: global___GetModeResponse .. py:class:: SetModeRequest(*, name: str = ..., mode: global___Mode = ..., extra: google.protobuf.struct_pb2.Struct | None = ...) Bases: :py:obj:`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. .. py:property:: extra :type: google.protobuf.struct_pb2.Struct Additional arguments to the method .. py:attribute:: name :type: str .. py:attribute:: mode :type: global___Mode .. py:method:: HasField(field_name: Literal[extra, b'extra']) -> bool Checks if a certain field is set for the message. For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, :exc:`ValueError` will be raised. :param field_name: The name of the field to check for presence. :type field_name: str :returns: Whether a value has been set for the named field. :rtype: bool :raises ValueError: if the `field_name` is not a member of this message. .. py:data:: global___SetModeRequest .. py:class:: SetModeResponse Bases: :py:obj:`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. .. py:data:: global___SetModeResponse .. py:class:: Waypoint(*, id: str = ..., location: viam.gen.common.v1.common_pb2.GeoPoint | None = ...) Bases: :py:obj:`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. .. py:property:: location :type: viam.gen.common.v1.common_pb2.GeoPoint .. py:attribute:: id :type: str .. py:method:: HasField(field_name: Literal[location, b'location']) -> bool Checks if a certain field is set for the message. For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, :exc:`ValueError` will be raised. :param field_name: The name of the field to check for presence. :type field_name: str :returns: Whether a value has been set for the named field. :rtype: bool :raises ValueError: if the `field_name` is not a member of this message. .. py:data:: global___Waypoint .. py:class:: GetLocationRequest(*, name: str = ..., extra: google.protobuf.struct_pb2.Struct | None = ...) Bases: :py:obj:`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. .. py:property:: extra :type: google.protobuf.struct_pb2.Struct Additional arguments to the method .. py:attribute:: name :type: str .. py:method:: HasField(field_name: Literal[extra, b'extra']) -> bool Checks if a certain field is set for the message. For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, :exc:`ValueError` will be raised. :param field_name: The name of the field to check for presence. :type field_name: str :returns: Whether a value has been set for the named field. :rtype: bool :raises ValueError: if the `field_name` is not a member of this message. .. py:data:: global___GetLocationRequest .. py:class:: GetLocationResponse(*, location: viam.gen.common.v1.common_pb2.GeoPoint | None = ..., compass_heading: float = ...) Bases: :py:obj:`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. .. py:property:: location :type: viam.gen.common.v1.common_pb2.GeoPoint .. py:attribute:: compass_heading :type: float A number from [0-360) where 0 is north 90 is east, 180 is south, 270 is west .. py:method:: HasField(field_name: Literal[location, b'location']) -> bool Checks if a certain field is set for the message. For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, :exc:`ValueError` will be raised. :param field_name: The name of the field to check for presence. :type field_name: str :returns: Whether a value has been set for the named field. :rtype: bool :raises ValueError: if the `field_name` is not a member of this message. .. py:data:: global___GetLocationResponse .. py:class:: GetWaypointsRequest(*, name: str = ..., extra: google.protobuf.struct_pb2.Struct | None = ...) Bases: :py:obj:`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. .. py:property:: extra :type: google.protobuf.struct_pb2.Struct Additional arguments to the method .. py:attribute:: name :type: str .. py:method:: HasField(field_name: Literal[extra, b'extra']) -> bool Checks if a certain field is set for the message. For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, :exc:`ValueError` will be raised. :param field_name: The name of the field to check for presence. :type field_name: str :returns: Whether a value has been set for the named field. :rtype: bool :raises ValueError: if the `field_name` is not a member of this message. .. py:data:: global___GetWaypointsRequest .. py:class:: GetWaypointsResponse(*, waypoints: collections.abc.Iterable[global___Waypoint] | None = ...) Bases: :py:obj:`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. .. py:property:: waypoints :type: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Waypoint] .. py:data:: global___GetWaypointsResponse .. py:class:: AddWaypointRequest(*, name: str = ..., location: viam.gen.common.v1.common_pb2.GeoPoint | None = ..., extra: google.protobuf.struct_pb2.Struct | None = ...) Bases: :py:obj:`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. .. py:property:: location :type: viam.gen.common.v1.common_pb2.GeoPoint .. py:property:: extra :type: google.protobuf.struct_pb2.Struct Additional arguments to the method .. py:attribute:: name :type: str .. py:method:: HasField(field_name: Literal[extra, b'extra', location, b'location']) -> bool Checks if a certain field is set for the message. For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, :exc:`ValueError` will be raised. :param field_name: The name of the field to check for presence. :type field_name: str :returns: Whether a value has been set for the named field. :rtype: bool :raises ValueError: if the `field_name` is not a member of this message. .. py:data:: global___AddWaypointRequest .. py:class:: AddWaypointResponse Bases: :py:obj:`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. .. py:data:: global___AddWaypointResponse .. py:class:: RemoveWaypointRequest(*, name: str = ..., id: str = ..., extra: google.protobuf.struct_pb2.Struct | None = ...) Bases: :py:obj:`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. .. py:property:: extra :type: google.protobuf.struct_pb2.Struct Additional arguments to the method .. py:attribute:: name :type: str .. py:attribute:: id :type: str .. py:method:: HasField(field_name: Literal[extra, b'extra']) -> bool Checks if a certain field is set for the message. For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, :exc:`ValueError` will be raised. :param field_name: The name of the field to check for presence. :type field_name: str :returns: Whether a value has been set for the named field. :rtype: bool :raises ValueError: if the `field_name` is not a member of this message. .. py:data:: global___RemoveWaypointRequest .. py:class:: RemoveWaypointResponse Bases: :py:obj:`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. .. py:data:: global___RemoveWaypointResponse .. py:class:: GetObstaclesRequest(*, name: str = ..., extra: google.protobuf.struct_pb2.Struct | None = ...) Bases: :py:obj:`google.protobuf.message.Message` GetObstacles will return the geopoint location and geometry of all known obstacles on the navigation map. Obstacles that are detected through the vision service will only be returned if this endpoint is called when the robot is sensing the obstacle .. py:property:: extra :type: google.protobuf.struct_pb2.Struct Additional arguments to the method .. py:attribute:: name :type: str .. py:method:: HasField(field_name: Literal[extra, b'extra']) -> bool Checks if a certain field is set for the message. For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, :exc:`ValueError` will be raised. :param field_name: The name of the field to check for presence. :type field_name: str :returns: Whether a value has been set for the named field. :rtype: bool :raises ValueError: if the `field_name` is not a member of this message. .. py:data:: global___GetObstaclesRequest .. py:class:: GetObstaclesResponse(*, obstacles: collections.abc.Iterable[viam.gen.common.v1.common_pb2.GeoGeometry] | None = ...) Bases: :py:obj:`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. .. py:property:: obstacles :type: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[viam.gen.common.v1.common_pb2.GeoGeometry] List of all known geometries .. py:data:: global___GetObstaclesResponse .. py:class:: Path(*, destination_waypoint_id: str = ..., geopoints: collections.abc.Iterable[viam.gen.common.v1.common_pb2.GeoPoint] | None = ...) Bases: :py:obj:`google.protobuf.message.Message` A user provided destination and the set of geopoints that the robot is expected to take to get there .. py:property:: geopoints :type: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[viam.gen.common.v1.common_pb2.GeoPoint] List of geopoints that the motion planner output to reach the destination The first geopoint is the starting position of the robot for that path .. py:attribute:: destination_waypoint_id :type: str The id of the user specified waypoint .. py:data:: global___Path .. py:class:: GetPathsRequest(*, name: str = ..., extra: google.protobuf.struct_pb2.Struct | None = ...) Bases: :py:obj:`google.protobuf.message.Message` Returns all the paths known to the navigation service .. py:property:: extra :type: google.protobuf.struct_pb2.Struct .. py:attribute:: name :type: str Name of the navigation service .. py:method:: HasField(field_name: Literal[extra, b'extra']) -> bool Checks if a certain field is set for the message. For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, :exc:`ValueError` will be raised. :param field_name: The name of the field to check for presence. :type field_name: str :returns: Whether a value has been set for the named field. :rtype: bool :raises ValueError: if the `field_name` is not a member of this message. .. py:data:: global___GetPathsRequest .. py:class:: GetPathsResponse(*, paths: collections.abc.Iterable[global___Path] | None = ...) Bases: :py:obj:`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. .. py:property:: paths :type: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Path] .. py:data:: global___GetPathsResponse .. py:class:: GetPropertiesRequest(*, name: str = ...) Bases: :py:obj:`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. .. py:attribute:: name :type: str Name of the navigation service .. py:data:: global___GetPropertiesRequest .. py:class:: GetPropertiesResponse(*, map_type: global___MapType = ...) Bases: :py:obj:`google.protobuf.message.Message` Returns properties information for the named navigation service .. py:attribute:: map_type :type: global___MapType .. py:data:: global___GetPropertiesResponse