fly316/PX4-Autopilot
7
0
Fork 0
mirror of https://gitee.com/mirrors_PX4/PX4-Autopilot.git synced 2026-10-17 05:13:35 +08:00
Code Issues Packages Projects Releases Wiki Activity

Move PX4 Guide source into /docs (#24490)

Browse Source 
* Add vitepress tree

* Update existing workflows so they dont trigger on changes in the docs path

* Add nojekyll, package.json, LICENCE etc

* Add crowdin docs upload/download scripts

* Add docs flaw checker workflows

* Used docs prefix for docs workflows

* Crowdin obvious fixes

* ci: docs move to self hosted runner

runs on a beefy server for faster builds

Signed-off-by: Ramon Roche <mrpollo@gmail.com>

* ci: don't run build action for docs or ci changes

Signed-off-by: Ramon Roche <mrpollo@gmail.com>

* ci: update runners

Signed-off-by: Ramon Roche <mrpollo@gmail.com>

* Add docs/en

* Add docs assets and scripts

* Fix up editlinks to point to PX4 sources

* Download just the translations that are supported

* Add translation sources for zh, uk, ko

* Update latest tranlsation and uorb graphs

* update vitepress to latest

---------

Signed-off-by: Ramon Roche <mrpollo@gmail.com>
Co-authored-by: Ramon Roche <mrpollo@gmail.com>
This commit is contained in:
Hamish Willee
2025-03-13 16:08:27 +11:00
committed by GitHub
co-authored by Ramon Roche
parent 8e6d2ebe4a
commit 88d623bedb
5176 changed files with 558771 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/zh/dev_setup/vscode.md
+141
View File
@@ -0,0 +1,141 @@
# Visual Studio Code IDE (VSCode)
[Visual Studio Code](https://code.visualstudio.com/) is a powerful cross-platform source code editor/IDE that can be used for PX4 development on Ubuntu, Windows, and macOS.
使用 VSCode 进行PX4 开发的原因：
- Getting setup _really_ only takes a few minutes.
- A rich extension ecosystem that enables a huge range of tools needed for PX4 development: C/C++ (with solid _cmake_ integration), _Python_, _Jinja2_, ROS messages, and even DroneCAN dsdl.
- 非常好的Github 集成功能
本主题解释了如何设置IDE并开始开发。
:::info
There are other powerful IDEs, but they typically take more effort to integrate with PX4.
With _VScode_, configuration is stored in the PX4/PX4-Autopilot tree ([PX4-Autopilot/.vscode](https://github.com/PX4/PX4-Autopilot/tree/main/.vscode)) so the setup process is as simple as adding the project folder.
:::
## 操作前提
You must already have installed the command line [PX4 developer environment](../dev_setup/dev_env.md) for your platform and downloaded the _Firmware_ source code repo.
## Installation & Setup
1. [Download and install VSCode](https://code.visualstudio.com/) (you will be offered the correct version for your OS).
2. Open VSCode and add the PX4 source code:
- Select _Open folder ..._ option on the welcome page (or using the menu: **File > Open Folder**):
![Open Folder](../../assets/toolchain/vscode/welcome_open_folder.jpg)
- A file selection dialog will appear.
Select the **PX4-Autopilot** directory and then press **OK**.
The project files and configuration will then load into _VSCode_.
3. Press **Install All** on the _This workspace has extension recommendations_ prompt (this will appear on the bottom right of the IDE).
![Install extensions](../../assets/toolchain/vscode/prompt_install_extensions.jpg)
VSCode will open the _Extensions_ panel on the left hand side so you can watch the progress of installation.
![PX4 loaded into VSCode Explorer](../../assets/toolchain/vscode/installing_extensions.jpg)
4. A number of notifications/prompts may appear in the bottom right corner
:::tip
If the prompts disappear, click the little "alarm" icon on the right of the bottom blue bar.
:::
- If prompted to install a new version of _cmake_:
- Say **No** (the right version is installed with the [PX4 developer environment](../dev_setup/dev_env.md)).
- If prompted to sign into _github.com_ and add your credentials:
- This is up to you! It provides a deep integration between Github and the IDE, which may simplify your workflow.
- Other prompts are optional, and may be installed if they seem useful. <!-- perhaps add screenshot of these prompts -->
<a id="building"></a>
## Building PX4
To build:
1. Select your build target ("cmake build config"):
- The current _cmake build target_ is shown on the blue _config_ bar at the bottom (if this is already your desired target, skip to next step).
![Select Cmake build target](../../assets/toolchain/vscode/cmake_build_config.jpg)
::: info
The cmake target you select affects the targets offered for when [building/debugging](#debugging) (i.e. for hardware debugging you must select a hardware target like `px4_fmu-v6`).
:::
- Click the target on the config bar to display other options, and select the one you want (this will replace any selected target).
- _Cmake_ will then configure your project (see notification in bottom right).
![Cmake config project](../../assets/toolchain/vscode/cmake_configuring_project.jpg)
- Wait until configuration completes.
When this is done the notification will disappear and you'll be shown the build location:
![Cmake config project](../../assets/toolchain/vscode/cmake_configuring_project_done.jpg).
2. You can then kick off a build from the config bar (select either **Build** or **Debug**).
![Run debug or build](../../assets/toolchain/vscode/run_debug_build.jpg)
After building at least once you can now use [code completion](#code completion) and other _VSCode_ features.
## 调试
<a id="debugging_sitl"></a>
### SITL Debugging
To debug PX4 on SITL:
1. Select the debug icon on the sidebar (marked in red) to display the debug panel.
![Run debug](../../assets/toolchain/vscode/vscode_debug.jpg)
2. Then choose your debug target (e.g. _Debug SITL (Gazebo Iris)_) from the top bar debug dropdown (purple box).
::: info
The debug targets that are offered (purple box) match your build target (yellow box on the bottom bar).
For example, to debug SITL targets, your build target must include SITL.
:::
3. Start debugging by clicking the debug "play" arrow (next to the debug target in the top bar - pink box).
While debugging you can set breakpoints, step over code, and otherwise develop as normal.
### Hardware Debugging
The instructions in [SWD Debug Port](../debug/swd_debug.md) explain how to connect to the SWD interface on common flight controllers (for example, using the Dronecode or Blackmagic probes).
After connecting to the SWD interface, hardware debugging in VSCode is then the same as for [SITL Debugging](#debugging_sitl) except that you select a debug target appropriate for your debugger type (and firmware) - e.g. `jlink (px4_fmu-v5)`.
:::tip
To see the `jlink` option you must have selected a [cmake target for building firmware](#building-px4).
:::
![Image showing hardware targets with options for the different probes](../../assets/toolchain/vscode/vscode_hardware_debugging_options.png)
<a id="code completion"></a>
## Code Completion
In order for the code completion to work (and other IntelliSense magic) you need an active configuration and to have [built the code](#building).
Once that is done you don't need to do anything else; the toolchain will automatically offer you symbols as you type.
![IntelliSense](../../assets/toolchain/vscode/vscode_intellisense.jpg)
## 故障处理
This section includes guidance on setup and build errors.
### Ubuntu 18.04: "Visual Studio Code is unable to watch for file changes in this large workspace"
This error surfaces on startup.
On some systems, there is an upper-limit of 8192 file handles imposed on applications, which means that VSCode might not be able to detect file modifications in `/PX4-Autopilot`.
You can increase this limit to avoid the error, at the expense of memory consumption.
Follow the [instructions here](https://code.visualstudio.com/docs/setup/linux#_visual-studio-code-is-unable-to-watch-for-file-changes-in-this-large-workspace-error-enospc).
A value of 65536 should be more than sufficient.