Skip to main content

common

enum ResponseStatus​

Response types for RPC functions.

Values 0-2 (OK, IN_PROGRESS, COMPLETED) are specific to the SteelEagle protocol. They determine what phase an RPC call is in:

  • OK -> ack
  • IN_PROGRESS -> in progress
  • COMPLETED -> completed

These intermediate phases are generally not exposed to user-facing code and are only used for streaming methods. In contrast to normal gRPC procedure, a call is only considered complete on a response of COMPLETED instead of OK. If an error occurs, SteelEagle defers to gRPC error codes, 3-18. More details on these codes can be found here. Note that the value of these codes is offset by 2 from their original form (e.g. CANCELLED = 3 vs = 1). Therefore, for error codes, the transformation from gRPC to SteelEagle response code is to add 2 to the code. The only codes that differ from their gRPC meaning are codes 9 and 18.

Fields​

field  OK  (0) — command acknowledged

field  IN_PROGRESS  (1) — command in progress

field  COMPLETED  (2) — command finished without error

field  CANCELLED  (3) — the operation was cancelled, typically by the caller

field  UNKNOWN  (4) — unknown error

field  INVALID_ARGUMENT  (5) — the client specified an invalid argument

field  DEADLINE_EXCEEDED  (6) — the deadline expired before the operation could complete

field  NOT_FOUND  (7) — some requested entity was not found

field  ALREADY_EXISTS  (8) — an entity the client attempted to create already exists

field  PERMISSION_DENIED  (9) — the provided identity is not permitted to execute this operation by the current law (unique to SteelEagle)

field  RESOURCE_EXHAUSTED  (10) — some resource has been exhausted

field  FAILED_PRECONDITION  (11) — the operation was rejected because the system is not in a state required for the operation's execution

field  ABORTED  (12) — the operation was aborted, typically due to a concurrency issue such as a sequencer check failure or transaction abort

field  OUT_OF_RANGE  (13) — the operation was attempted past the valid range

field  UNIMPLEMENTED  (14) — the operation is not implemented/supported by the service

field  INTERNAL  (15) — an internal error occured while executing the operation

field  UNAVAILABLE  (16) — the service is currently unavailable

field  DATA_LOSS  (17) — unrecoverable data loss or corruption

field  UNAUTHENTICATED  (18) — the client failed to provide an identity (unique to SteelEagle)

message Request​

Request object for additional request info.

Fields​

field  timestamp  (/google/protobuf/Timestamp) — request timestamp

message Response​

Global response message returned by all core services.

Fields​

field  status  (ResponseStatus) — response status

field  response_string  (string) — detailed message on reason for response

field  timestamp  (/google/protobuf/Timestamp) — response timestamp

message Pose​

Angular offsets or poses in 3 dimensions.

Fields​

field  pitch  (double) — pitch [degrees]

field  roll  (double) — roll [degrees]

field  yaw  (double) — yaw [degrees]

message Velocity​

Representation of velocity in 3-dimensions.

Fields​

field  x_vel  (double) — forward/north velocity [meters/s]

field  y_vel  (double) — right/east velocity [meters/s]

field  z_vel  (double) — up velocity [meters/s]

field  angular_vel  (double) — angular velocity [degrees/s]

message Position​

Position offset relative to home or current location.

Fields​

field  x  (double) — forward/north offset [meters]

field  y  (double) — right/east offset [meters]

field  z  (double) — up offset [meters]

field  angle  (double) — angular offset [degrees]

message Location​

Location in global coordinates.

Fields​

field  latitude  (double) — global latitude [degrees]

field  longitude  (double) — global longitude [degrees]

field  altitude  (double) — altitude above MSL or takeoff [meters]

field  heading  (double) — global heading [degrees]