-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #154 from asv-soft/feat/cli-docs
feat(cli-docs): add docs about Params and Print Vehicle State commands
- Loading branch information
Showing
5 changed files
with
43 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
# Params | ||
|
||
```bash | ||
Asv.Mavlink.Shell.exe params --connection tcp://127.0.0.1:5762 | ||
``` | ||
|
||
Use this command to view the parameters of MAVLink devices available on a specified TCP connection. | ||
|
||
![image](asv-drones-params-command.png) | ||
|
||
This command provides an observer for UAV parameters, including navigation and search capabilities. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
# Print Vehicle State | ||
|
||
```bash | ||
Asv.Mavlink.Shell.exe print-vehicle-state --connection tcp://127.0.0.1:5762 | ||
``` | ||
This command starts the console implementation of UAV controls and Telemetry | ||
|
||
<note> | ||
<format color="Yellow" style="bold"> | ||
WARNING! Use this command only with a simulator. It does not provide the full functionality required for safe flight. | ||
Use this command only for education or introductory purposes. | ||
</format> | ||
</note> | ||
|
||
|
||
|
||
![image](asv-drones-print-vehicle-state.png) | ||
|
||
The Print Vehicle State command provides control over the UAV and displays telemetry data, including: | ||
- Link - current state of the link between the UAV and the router; | ||
- Home Position - the starting point for the UAV, which is also the target for the RTL (Return to Launch) command; | ||
- Global Position - current UAV location with altitudes MSL (Mean Sea Level) and AGL (Above Ground Level); | ||
- Current Azimuth - the current azimuth of the UAV; | ||
- Mavlink Version - the version of the protocol operating the process; | ||
- Base Mode - list of base modes supported by the current vehicle; | ||
- AutoPilot - the current type of autopilot in use; | ||
- System Status - the current status of the system; | ||
- Type - representation of the device type according to MAV_TYPE; | ||
|
||
The "Log" table displays a list of recent commands executed in the CLI. |