telemetry
class MotionStatus
Inherits from: int, enum.Enum
Information about the motion of the vehicle.
Attributes
attr MOTORS_OFF (0)
attr RAMPING_UP (1)
attr IDLE (2)
attr IN_TRANSIT (3)
attr RAMPING_DOWN (4)
View Source
class MotionStatus(int, Enum):
"""Information about the motion of the vehicle.
Attributes:
MOTORS_OFF (0): motors of the vehicle are off
RAMPING_UP (1): motors of the vehicle are ramping
IDLE (2): the vehicle is on but idle
IN_TRANSIT (3): the vehicle is in motion
RAMPING_DOWN (4): motors of the vehicle are ramping down
"""
MOTORS_OFF = 0
RAMPING_UP = 1
IDLE = 2
IN_TRANSIT = 3
RAMPING_DOWN = 4
class ImagingSensorType
Inherits from: int, enum.Enum
Imaging sensor types.
Attributes
attr RGB (0)
attr STEREO (1)
attr THERMAL (2)
attr NIGHT (3)
attr LIDAR (4)
attr RGBD (5)
attr TOF (6)
attr RADAR (7)
View Source
class ImagingSensorType(int, Enum):
"""Imaging sensor types.
Attributes:
RGB (0): RGB camera
STEREO (1): stereo camera
THERMAL (2): thermal camera
NIGHT (3): night vision camera
LIDAR (4): LIDAR sensor
RGBD (5): RGB-Depth camera
TOF (6): ToF (time of flight) camera
RADAR (7): RADAR sensor
"""
RGB = 0
STEREO = 1
THERMAL = 2
NIGHT = 3
LIDAR = 4
RGBD = 5
TOF = 6
RADAR = 7
class BatteryWarning
Inherits from: int, enum.Enum
Battery warnings and alerts.
Attributes
attr NONE (0)
attr LOW (1)
attr CRITICAL (2)
View Source
class BatteryWarning(int, Enum):
"""Battery warnings and alerts.
Attributes:
NONE (0): the vehicle is above 30% battery
LOW (1): the vehicle is below 30% battery
CRITICAL (2): the vehicle is below 15% battery
"""
NONE = 0
LOW = 1
CRITICAL = 2
class GPSWarning
Inherits from: int, enum.Enum
GPS fix warnings and alerts.
Attributes
attr NO_GPS_WARNING (0)
attr WEAK_SIGNAL (1)
attr NO_FIX (2)
View Source
class GPSWarning(int, Enum):
"""GPS fix warnings and alerts.
Attributes:
NO_GPS_WARNING (0): GPS readings are nominal and a fix has been achieved
WEAK_SIGNAL (1): weak GPS fix, expect errant global position data
NO_FIX (2): no GPS fix
"""
NO_GPS_WARNING = 0
WEAK_SIGNAL = 1
NO_FIX = 2
class MagnetometerWarning
Inherits from: int, enum.Enum
Magnetometer warnings and alerts.
Attributes
attr NO_MAGNETOMETER_WARNING (0)
attr PERTURBATION (1)
View Source
class MagnetometerWarning(int, Enum):
"""Magnetometer warnings and alerts.
Attributes:
NO_MAGNETOMETER_WARNING (0): magnetometer readings are nominal
PERTURBATION (1): the vehicle is experiencing magnetic perturbations
"""
NO_MAGNETOMETER_WARNING = 0
PERTURBATION = 1
class ConnectionWarning
Inherits from: int, enum.Enum
Connection warnings and alerts.
Attributes
attr NO_CONNECTION_WARNING (0)
attr DISCONNECTED (1)
attr WEAK_CONNECTION (2)
View Source
class ConnectionWarning(int, Enum):
"""Connection warnings and alerts.
Attributes:
NO_CONNECTION_WARNING (0): connection to remote server is nominal
DISCONNECTED (1): contact has been lost with the remote server
WEAK_CONNECTION (2): connection is experiencing interference or is weak
"""
NO_CONNECTION_WARNING = 0
DISCONNECTED = 1
WEAK_CONNECTION = 2
class CompassWarning
Inherits from: int, enum.Enum
Compass warnings and alerts.
Attributes
attr NO_COMPASS_WARNING (0)
attr WEAK_HEADING_LOCK (1)
attr NO_HEADING_LOCK (2)
View Source
class CompassWarning(int, Enum):
"""Compass warnings and alerts.
Attributes:
NO_COMPASS_WARNING (0): absolute heading is nominal
WEAK_HEADING_LOCK (1): absolute heading is available but may be incorrect
NO_HEADING_LOCK (2): no absolute heading available from the vehicle
"""
NO_COMPASS_WARNING = 0
WEAK_HEADING_LOCK = 1
NO_HEADING_LOCK = 2
class MissionExecState
Inherits from: int, enum.Enum
Execution state of the current mission.
Attributes
attr READY (0)
attr IN_PROGRESS (1)
attr PAUSED (2)
attr COMPLETED (3)
attr CANCELED (4)
View Source
class MissionExecState(int, Enum):
"""Execution state of the current mission.
Attributes:
READY (0): mission is ready to be executed
IN_PROGRESS (1): mission is in progress
PAUSED (2): mission is paused
COMPLETED (3): mission has been completed
CANCELED (4): mission was cancelled
"""
READY = 0
IN_PROGRESS = 1
PAUSED = 2
COMPLETED = 3
CANCELED = 4
class TelemetryStreamInfo
Inherits from: Datatype
Information about the telemetry stream.
Attributes
attr current_frequency (int)
attr max_frequency (int)
attr uptime (google.protobuf.duration_pb2.Duration)
View Source
@register_data
class TelemetryStreamInfo(Datatype):
"""Information about the telemetry stream.
Attributes:
current_frequency (int): current frequency of telemetry messages [Hz]
max_frequency (int): maximum frequency of telemetry messages [Hz]
uptime (Duration): uptime of the stream
"""
current_frequency: int
max_frequency: int
uptime: Duration
class BatteryInfo
Inherits from: Datatype
Information about the vehicle battery.
Attributes
attr percentage (int)
View Source
@register_data
class BatteryInfo(Datatype):
"""Information about the vehicle battery.
Attributes:
percentage (int): battery level [0-100]%
"""
percentage: int
class GPSInfo
Inherits from: Datatype
Information about the vehicle GPS fix.
Attributes
attr satellites (int)
View Source
@register_data
class GPSInfo(Datatype):
"""Information about the vehicle GPS fix.
Attributes:
satellites (int): number of satellites used in GPS fix
"""
satellites: int
class CommsInfo
Inherits from: Datatype
Future: information about the vehicle's communication links.
View Source
@register_data
class CommsInfo(Datatype):
"""Future: information about the vehicle's communication links.
"""
pass
class VehicleInfo
Inherits from: Datatype
Information about the vehicle.
This includes the name, make, model and its current status (battery, GPS, comms, motion).
Attributes
attr name (str)
attr model (str)
attr manufacturer (str)
attr motion_status (MotionStatus)
attr battery_info (BatteryInfo)
attr gps_info (GPSInfo)
attr comms_info (CommsInfo)
View Source
@register_data
class VehicleInfo(Datatype):
"""Information about the vehicle.
This includes the name, make, model and its current status (battery, GPS, comms, motion).
Attributes:
name (str): the vehicle that this telemetry corresponds to
model (str): model of the vehicle
manufacturer (str): manufacturer of the vehicle
motion_status (MotionStatus): current status of the vehicle
battery_info (BatteryInfo): battery info for the vehicle
gps_info (GPSInfo): GPS sensor info for the vehicle
comms_info (CommsInfo): communications info for the vehicle
"""
name: str
model: str
manufacturer: str
motion_status: MotionStatus
battery_info: BatteryInfo
gps_info: GPSInfo
comms_info: CommsInfo
class SetpointInfo
Inherits from: Datatype
Information about the current setpoint.
Provides the current setpoint for the vehicle. A setpoint is a position or velocity target
that the vehicle is currently moving towards. By default, when the vehicle is idle, this
setpoint is a position_body_sp object set to all zeros. The frame of reference for each
setpoint is implied by the name; e.g. velocity_neu_sp uses the NEU (North, East, Up)
reference frame and velocity_body_sp uses the body (forward, right, up) reference frame.
Attributes
attr position_body_sp (Position)
attr position_neu_sp (Position)
attr global_sp (Location)
attr velocity_body_sp (Velocity)
attr velocity_neu_sp (Velocity)
View Source
@register_data
class SetpointInfo(Datatype):
"""Information about the current setpoint.
Provides the current setpoint for the vehicle. A setpoint is a position or velocity target
that the vehicle is currently moving towards. By default, when the vehicle is idle, this
setpoint is a `position_body_sp` object set to all zeros. The frame of reference for each
setpoint is implied by the name; e.g. velocity_neu_sp uses the NEU (North, East, Up)
reference frame and velocity_body_sp uses the body (forward, right, up) reference frame.
Attributes:
position_body_sp (common.Position): default all zeros idle setpoint
position_neu_sp (common.Position): NEU (North, East, Up) position setpoint
global_sp (common.Location): global setpoint
velocity_body_sp (common.Velocity): body (forward, right, up) velocity setpoint
velocity_neu_sp (common.Velocity): NEU (North, East, Up) velocity setpoint
"""
position_body_sp: common.Position
position_neu_sp: common.Position
global_sp: common.Location
velocity_body_sp: common.Velocity
velocity_neu_sp: common.Velocity
class PositionInfo
Inherits from: Datatype
Information about the vehicle position.
Includes home position, global position (only valid with a GPS fix), relative position (only available on some vehicles), current velocity, and the current setpoint.
Attributes
attr home (Location)
attr global_position (Location)
attr relative_position (Position)
attr velocity_neu (Velocity)
attr velocity_body (Velocity)
attr setpoint_info (SetpointInfo)
View Source
@register_data
class PositionInfo(Datatype):
"""Information about the vehicle position.
Includes home position, global position (only valid with a GPS fix), relative position (only available on some vehicles), current velocity, and the current setpoint.
Attributes:
home (common.Location): global position that will be used when returning home
global_position (common.Location): current global position of the vehicle
relative_position (common.Position): current local position of the vehicle in the global NEU (North, East, Up) coordinate frame, relative to start position
velocity_neu (common.Velocity): current velocity of the vehicle in the global NEU (North, East, Up) coordinate frame
velocity_body (common.Velocity): current velocity of the vehicle in the body (forward, right, up) coordinate frame
setpoint_info (SetpointInfo): info on the current vehicle setpoint
"""
home: common.Location
global_position: common.Location
relative_position: common.Position
velocity_neu: common.Velocity
velocity_body: common.Velocity
setpoint_info: SetpointInfo
class GimbalStatus
Inherits from: Datatype
Status of a gimbal.
Attributes
attr id (int)
attr pose_body (Pose)
attr pose_neu (Pose)
View Source
@register_data
class GimbalStatus(Datatype):
"""Status of a gimbal.
Attributes:
id (int): ID of the gimbal
pose_body (common.Pose): current pose in the body (forward, right, up) reference frame
pose_neu (common.Pose): current pose in the NEU (North, East, Up) reference frame
"""
id: int
pose_body: common.Pose
pose_neu: common.Pose
class GimbalInfo
Inherits from: Datatype
Info of all attached gimbals.
Attributes
attr num_gimbals (int)
attr gimbals (List[GimbalStatus])
View Source
@register_data
class GimbalInfo(Datatype):
"""Info of all attached gimbals.
Attributes:
num_gimbals (int): number of connected gimbals
gimbals (List[GimbalStatus]): list of connected gimbals
"""
num_gimbals: int
gimbals: List[GimbalStatus]
class ImagingSensorStatus
Inherits from: Datatype
Status of an imaging sensor.
Includes information about its type and resolution/stream settings.
Attributes
attr id (int)
attr type (ImagingSensorType)
attr active (bool)
attr supports_secondary (bool)
attr current_fps (int)
attr max_fps (int)
attr h_res (int)
attr v_res (int)
attr channels (int)
attr h_fov (int)
attr v_fov (int)
attr gimbal_mounted (bool)
attr gimbal_id (int)
View Source
@register_data
class ImagingSensorStatus(Datatype):
"""Status of an imaging sensor.
Includes information about its type and resolution/stream settings.
Attributes:
id (int): ID of the imaging sensor
type (ImagingSensorType): type of the imaging sensor
active (bool): indicates whether the imaging sensor is currently streaming
supports_secondary (bool): indicates whether the imaging sensor supports background streaming
current_fps (int): current streaming frames per second
max_fps (int): maximum streaming frames per second
h_res (int): horizontal resolution
v_res (int): vertical resolution
channels (int): number of image channels
h_fov (int): horizontal FOV
v_fov (int): vertical FOV
gimbal_mounted (bool): indicates if imaging sensor is gimbal mounted
gimbal_id (int): indicates which gimbal the imaging sensor is mounted on
"""
id: int
type: ImagingSensorType
active: bool
supports_secondary: bool
current_fps: int
max_fps: int
h_res: int
v_res: int
channels: int
h_fov: int
v_fov: int
gimbal_mounted: bool
gimbal_id: int
class ImagingSensorStreamStatus
Inherits from: Datatype
Information about all imaging sensor streams.
Attributes
attr stream_capacity (int)
attr num_streams (int)
attr primary_cam (int)
attr secondary_cams (List[int])
View Source
@register_data
class ImagingSensorStreamStatus(Datatype):
"""Information about all imaging sensor streams.
Attributes:
stream_capacity (int): the total number of allowed simultaneously streaming cameras
num_streams (int): the total number of currently streaming cameras
primary_cam (int): ID of the primary camera
secondary_cams (List[int]): IDs of the secondary active cameras
"""
stream_capacity: int
num_streams: int
primary_cam: int
secondary_cams: List[int]
class ImagingSensorInfo
Inherits from: Datatype
Information about all attached imaging sensors.
Attributes
attr stream_status (ImagingSensorStreamStatus)
attr sensors (List[ImagingSensorStatus])
View Source
@register_data
class ImagingSensorInfo(Datatype):
"""Information about all attached imaging sensors.
Attributes:
stream_status (ImagingSensorStreamStatus): status of current imaging sensor streams
sensors (List[ImagingSensorStatus]): list of connected imaging sensors
"""
stream_status: ImagingSensorStreamStatus
sensors: List[ImagingSensorStatus]
class AlertInfo
Inherits from: Datatype
Information about all vehicle warning and alerts.
Attributes
attr battery_warning (BatteryWarning)
attr gps_warning (GPSWarning)
attr magnetometer_warning (MagnetometerWarning)
attr connection_warning (ConnectionWarning)
attr compass_warning (CompassWarning)
View Source
@register_data
class AlertInfo(Datatype):
"""Information about all vehicle warning and alerts.
Attributes:
battery_warning (BatteryWarning): battery warnings
gps_warning (GPSWarning): GPS warnings
magnetometer_warning (MagnetometerWarning): magnetometer warnings
connection_warning (ConnectionWarning): connection warnings
compass_warning (CompassWarning): compass warnings
"""
battery_warning: BatteryWarning
gps_warning: GPSWarning
magnetometer_warning: MagnetometerWarning
connection_warning: ConnectionWarning
compass_warning: CompassWarning
class DriverTelemetry
Inherits from: Datatype
Telemetry message for the vehicle, originating from the driver module.
This message outlines all the current information about the vehicle. It
is one of three messages (DriverTelemetry, Frame, MissionTelemetry)
that is broadcast to attached compute services.
Attributes
attr timestamp (google.protobuf.timestamp_pb2.Timestamp)
attr telemetry_stream_info (TelemetryStreamInfo)
attr vehicle_info (VehicleInfo)
attr position_info (PositionInfo)
attr gimbal_info (GimbalInfo)
attr imaging_sensor_info (ImagingSensorInfo)
attr alert_info (AlertInfo)
View Source
@register_data
class DriverTelemetry(Datatype):
"""Telemetry message for the vehicle, originating from the driver module.
This message outlines all the current information about the vehicle. It
is one of three messages (`DriverTelemetry`, `Frame`, `MissionTelemetry`)
that is broadcast to attached compute services.
Attributes:
timestamp (Timestamp): timestamp of message
telemetry_stream_info (TelemetryStreamInfo): info about current telemetry stream
vehicle_info (VehicleInfo): the vehicle that this telemetry corresponds to
position_info (PositionInfo): positional info about the vehicle
gimbal_info (GimbalInfo): status on attached gimbals and their orientations
imaging_sensor_info (ImagingSensorInfo): information about the vehicle imaging sensors
alert_info (AlertInfo): enumeration of vehicle warnings
"""
timestamp: Timestamp
telemetry_stream_info: TelemetryStreamInfo
vehicle_info: VehicleInfo
position_info: PositionInfo
gimbal_info: GimbalInfo
imaging_sensor_info: ImagingSensorInfo
alert_info: AlertInfo
class Frame
Inherits from: Datatype
Imaging sensor frames, originating from the driver module.
This message provides frame data from currently streaming imaging sensors. It
is one of three messages (DriverTelemetry, Frame, MissionTelemetry)
that is broadcast to attached compute services.
Attributes
attr timestamp (google.protobuf.timestamp_pb2.Timestamp)
attr data (bytes)
attr h_res (int)
attr v_res (int)
attr d_res (int)
attr channels (int)
attr id (int)
attr vehicle_info (VehicleInfo)
attr position_info (PositionInfo)
attr gimbal_info (GimbalInfo)
attr imaging_sensor_info (ImagingSensorInfo)
View Source
@register_data
class Frame(Datatype):
"""Imaging sensor frames, originating from the driver module.
This message provides frame data from currently streaming imaging sensors. It
is one of three messages (`DriverTelemetry`, `Frame`, `MissionTelemetry`)
that is broadcast to attached compute services.
Attributes:
timestamp (Timestamp): capture timestamp of the frame
data (bytes): raw bytes representing the frame
h_res (int): horizontal frame resolution in pixels
v_res (int): vertical frame resolution in pixels
d_res (int): depth resolution in pixels
channels (int): number of channels
id (int): frame ID for future correlation
vehicle_info (VehicleInfo): the vehicle that this telemetry corresponds to
position_info (PositionInfo): positional info about the vehicle
gimbal_info (GimbalInfo): status on attached gimbals and their orientations
imaging_sensor_info (ImagingSensorInfo): information about the vehicle imaging sensors
"""
timestamp: Timestamp
data: bytes
h_res: int
v_res: int
d_res: int
channels: int
id: int
vehicle_info: VehicleInfo
position_info: PositionInfo
gimbal_info: GimbalInfo
imaging_sensor_info: ImagingSensorInfo
class MissionInfo
Inherits from: Datatype
Information about the current mission.
Attributes
attr name (str)
attr hash (int)
attr age (google.protobuf.timestamp_pb2.Timestamp)
attr exec_state (MissionExecState)
attr task_state (str)
View Source
@register_data
class MissionInfo(Datatype):
"""Information about the current mission.
Attributes:
name (str): mission name
hash (int): mission hash to establish version uniqueness
age (Timestamp): timestamp of upload
exec_state (MissionExecState): execution state of the mission
task_state (str): task state of the mission (plaintext), if active
"""
name: str
hash: int
age: Timestamp
exec_state: MissionExecState
task_state: str
class MissionTelemetry
Inherits from: Datatype
Telemetry message for the mission, originating from the mission module.
This message outlines all current information about the mission. It
is one of three messages (DriverTelemetry, Frame, MissionTelemetry)
that is broadcast to attached compute services.
Attributes
attr timestamp (google.protobuf.timestamp_pb2.Timestamp)
attr telemetry_stream_info (TelemetryStreamInfo)
attr mission_info (List[MissionInfo])
View Source
@register_data
class MissionTelemetry(Datatype):
"""Telemetry message for the mission, originating from the mission module.
This message outlines all current information about the mission. It
is one of three messages (`DriverTelemetry`, `Frame`, `MissionTelemetry`)
that is broadcast to attached compute services.
Attributes:
timestamp (Timestamp): timestamp of message
telemetry_stream_info (TelemetryStreamInfo): info about the current telemetry stream
mission_info (List[MissionInfo]): info about the current mission states
"""
timestamp: Timestamp
telemetry_stream_info: TelemetryStreamInfo
mission_info: List[MissionInfo]