HomePosition class

Contains the home position. The home position is the default position that the system will return to and land on. The position must be set automatically by the system during the takeoff, and may also be explicitly set using MAV_CMD_DO_SET_HOME. The global and local positions encode the position in the respective coordinate frames, while the q parameter encodes the orientation of the surface. Under normal conditions it describes the heading and terrain slope, which can be used by the aircraft to adjust the approach. The approach 3D vector describes the point to which the system should fly in normal flight mode and then perform a landing sequence along the vector. Note: this message can be requested by sending the MAV_CMD_REQUEST_MESSAGE with param1=242 (or the deprecated MAV_CMD_GET_HOME_POSITION command).

HOME_POSITION

Implemented types

• MavlinkMessage

Constructors

HomePosition({required int32_t latitude, required int32_t longitude, required int32_t altitude, required float x, required float y, required float z, required List<float> q, required float approachX, required float approachY, required float approachZ, required uint64_t timeUsec})

HomePosition.parse(ByteData data_)

factory

Properties

altitude → int32_t

Altitude (MSL). Positive for up.

final

approachX → float

Local X position of the end of the approach vector. Multicopters should set this position based on their takeoff path. Grass-landing fixed wing aircraft should set it the same way as multicopters. Runway-landing fixed wing aircraft should set it to the opposite direction of the takeoff, assuming the takeoff happened from the threshold / touchdown zone.

final

approachY → float

Local Y position of the end of the approach vector. Multicopters should set this position based on their takeoff path. Grass-landing fixed wing aircraft should set it the same way as multicopters. Runway-landing fixed wing aircraft should set it to the opposite direction of the takeoff, assuming the takeoff happened from the threshold / touchdown zone.

final

approachZ → float

Local Z position of the end of the approach vector. Multicopters should set this position based on their takeoff path. Grass-landing fixed wing aircraft should set it the same way as multicopters. Runway-landing fixed wing aircraft should set it to the opposite direction of the takeoff, assuming the takeoff happened from the threshold / touchdown zone.

final

hashCode → int

The hash code for this object.

no setter, inherited

latitude → int32_t

Latitude (WGS84)

final

longitude → int32_t

Longitude (WGS84)

final

mavlinkCrcExtra → int

no setter, override

mavlinkMessageId → int

no setter, override

q → List<float>

Quaternion indicating world-to-surface-normal and heading transformation of the takeoff position. Used to indicate the heading and slope of the ground. All fields should be set to NaN if an accurate quaternion for both heading and surface slope cannot be supplied.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

timeUsec → uint64_t

Timestamp (UNIX Epoch time or time since system boot). The receiving end can infer timestamp format (since 1.1.1970 or since system boot) by checking for the magnitude of the number.

final

x → float

Local X position of this position in the local coordinate frame (NED)

final

y → float

Local Y position of this position in the local coordinate frame (NED)

final

z → float

Local Z position of this position in the local coordinate frame (NED: positive "down")

final

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

serialize() → ByteData

override

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Constants

mavlinkEncodedLength → const int