Position ex-client
You can also use the higher-level IPositionClientEx, which provides convenient reactive properties and helper methods for common operations such as takeoff, landing, setting targets, and ROI management.
IPositionClientEx
Represents a higher-level wrapper over IPositionClient providing convenient reactive properties and additional helper methods.
Property | Type | Description |
|---|---|---|
|
| The underlying base client. |
|
| Pitch angle in degrees. |
|
| Pitch angular speed in radians per second. |
|
| Roll angle in degrees. |
|
| Roll angular speed in radians per second. |
|
| Yaw angle in degrees. |
|
| Yaw angular speed in radians per second. |
|
| Current global position in degrees with MSL altitude in meters. |
|
| Current global target in degrees with altitude in meters. |
|
| Home position in degrees with MSL altitude in meters. |
|
| Altitude above home in meters. |
|
| Distance from the current position to home. |
|
| Distance from the current position to the target. |
|
| Represents a property that indicates whether the object is armed. |
|
| Gets the armed time as an observable value of type TimeSpan. |
|
| Gets the Roi property. |
Method | Return Type | Description |
|---|---|---|
|
| Requests the vehicle to publish its home position. |
|
| Sets the vehicle home position. |
|
| Arms or disarms the system. |
|
| Sets the region of interest (ROI) using the specified location. |
|
| Clears the region of interest (ROI). |
|
| Sends a global position target to the vehicle. |
|
| Initiates the takeoff process. |
|
| Initiates vertical takeoff. |
|
| VTOL landing procedure. |
IPositionClientEx.GetHomePosition
Parameter | Type | Description |
|---|---|---|
|
| Optional cancellation token. |
The command response confirms that the request was accepted. The position itself is received through the Home property.
IPositionClientEx.SetHomePosition
Parameter | Type | Description |
|---|---|---|
|
| New home latitude, longitude, and altitude. |
|
| Optional cancellation token. |
IPositionClientEx.ArmDisarm
Parameter | Type | Description |
|---|---|---|
|
| True to arm, false to disarm. |
|
| Optional cancellation token. |
IPositionClientEx.SetRoi
Parameter | Type | Description |
|---|---|---|
|
| The geographical point representing the location of the ROI. |
|
| Optional cancellation token. |
IPositionClientEx.ClearRoi
Parameter | Type | Description |
|---|---|---|
|
| Optional cancellation token. |
IPositionClientEx.SetTarget
Parameter | Type | Description |
|---|---|---|
|
| Target position to set. |
|
| Cancellation token. |
IPositionClientEx.TakeOff
Parameter | Type | Description |
|---|---|---|
|
| Target altitude in meters. |
|
| Optional cancellation token. |
IPositionClientEx.QTakeOff
Parameter | Type | Description |
|---|---|---|
|
| Target altitude in meters. |
|
| Optional cancellation token. |
IPositionClientEx.QLand
Parameter | Type | Description |
|---|---|---|
|
| VTOL landing option. |
|
| Approach altitude, NaN if unspecified. |
|
| Optional cancellation token. |