package mavsdk.rpc.geofence

Get desktop application:
View/edit binary Protocol Buffers messages

Enable setting a geofence.

• rpc ClearGeofence (ClearGeofenceRequest, ClearGeofenceResponse)

  geofence.proto:28

  Clear all geofences saved on the vehicle.

  message ClearGeofenceRequest

  geofence.proto:76

  (message has no fields)

  message ClearGeofenceResponse

  geofence.proto:77

  • optional GeofenceResult geofence_result = 1

• rpc DownloadGeofence (DownloadGeofenceRequest, DownloadGeofenceResponse)

  geofence.proto:24

  Download geofences from the vehicle. Downloads polygon and circular geofences from the vehicle.

  message DownloadGeofenceRequest

  geofence.proto:70

  (message has no fields)

  message DownloadGeofenceResponse

  geofence.proto:71

  • optional GeofenceResult geofence_result = 1

  • optional GeofenceData geofence_data = 2

    Downloaded geofence data

• rpc UploadGeofence (UploadGeofenceRequest, UploadGeofenceResponse)

  geofence.proto:18

  Upload geofences. Polygon and Circular geofences are uploaded to a drone. Once uploaded, the geofence will remain on the drone even if a connection is lost.

  message UploadGeofenceRequest

  geofence.proto:62

  • optional GeofenceData geofence_data = 1

    Circle(s) and/or Polygon(s) representing the geofence(s)

  message UploadGeofenceResponse

  geofence.proto:66

  • optional GeofenceResult geofence_result = 1

Circular type.

Used in: GeofenceData

• optional Point point = 1

  Point defining the center

• float radius = 2

  Radius of the circular fence

• FenceType fence_type = 3

  Fence type

Geofence types.

Used in: Circle, Polygon

• FENCE_TYPE_INCLUSION = 0

  Type representing an inclusion fence

• FENCE_TYPE_EXCLUSION = 1

  Type representing an exclusion fence

Geofence data type.

Used in: DownloadGeofenceResponse, UploadGeofenceRequest

• repeated Polygon polygons = 1

  Polygon(s) representing the geofence(s)

• repeated Circle circles = 2

  Circle(s) representing the geofence(s)

Result type.

Used in: ClearGeofenceResponse, DownloadGeofenceResponse, UploadGeofenceResponse

• GeofenceResult.Result result = 1

  Result enum value

• string result_str = 2

  Human-readable English string describing the result

Possible results returned for geofence requests.

Used in: GeofenceResult

• RESULT_UNKNOWN = 0

  Unknown result

• RESULT_SUCCESS = 1

  Request succeeded

• RESULT_ERROR = 2

  Error

• RESULT_TOO_MANY_GEOFENCE_ITEMS = 3

  Too many objects in the geofence

• RESULT_BUSY = 4

  Vehicle is busy

• RESULT_TIMEOUT = 5

  Request timed out

• RESULT_INVALID_ARGUMENT = 6

  Invalid argument

• RESULT_NO_SYSTEM = 7

  No system connected

Point type.

Used in: Circle, Polygon

• double latitude_deg = 1

  Latitude in degrees (range: -90 to +90)

• double longitude_deg = 2

  Longitude in degrees (range: -180 to +180)

Polygon type.

Used in: GeofenceData

• repeated Point points = 1

  Points defining the polygon

• FenceType fence_type = 2

  Fence type