Skip to content

Commit

Permalink
Merge pull request #154 from asv-soft/feat/cli-docs
Browse files Browse the repository at this point in the history
feat(cli-docs): add docs about Params and Print Vehicle State commands
  • Loading branch information
asv-soft-u05 authored Jan 27, 2025
2 parents 5f49a00 + f9f5647 commit 2454467
Show file tree
Hide file tree
Showing 5 changed files with 43 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/Writerside/am.tree
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@
</toc-element>
</toc-element>
<toc-element toc-title="CLI">
<toc-element topic="print-vehicle-state.md"/>
<toc-element topic="params.md"/>
<toc-element topic="packet-code-generation.md"/>
<toc-element topic="packet-viewer.md"/>
<toc-element topic="proxy.md"/>
Expand Down
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.
11 changes: 11 additions & 0 deletions docs/Writerside/topics/CLI/params.md
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.
30 changes: 30 additions & 0 deletions docs/Writerside/topics/CLI/print-vehicle-state.md
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.

0 comments on commit 2454467

Please sign in to comment.