Move PX4 Guide source into /docs (#24490)

* 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>
2026-05-26 09:26:25 +08:00 · 2025-03-13 16:08:27 +11:00
parent 8e6d2ebe4a
commit 88d623bedb
5176 changed files with 558771 additions and 2 deletions
@@ -0,0 +1,5 @@
+# 串行总线
+
+本节包含关于串行总线和串行驱动程序的主题:
+
+- [Making Serial Port Drivers User-Configurable](../uart/user_configurable_serial_driver.md)
@@ -0,0 +1,58 @@
+# 使串口驱动为用户可配置。
+
+本主题介绍了如何设置一个串行驱动程序，使其能够被最终用户配置(通过参数) 在飞行控制器板的任何可配置串行端口上运行。
+
+## 操作前提
+
+假定驱动程序已经存在，并使用命令语法在shell中启动:
+
+```sh
+<driver_name> start -d <serial_port> [-b <baudrate> | -b p:<param_name>]
+```
+
+上述命令中：
+
+- `-d`: serial port name.
+- `-b`: Baud rate (optional) if the driver supports multiple baud rates.
+  If supported, the driver must allow you to specify the rate as both a bare baudrate and as a parameter name in the form `-b p:<param_name>` (which can be parsed with `px4_get_parameter_value()`).
+  :::tip
+  See the [gps driver](https://github.com/PX4/PX4-Autopilot/blob/main/src/drivers/gps/gps.cpp#L1023) for an example.
+
+:::
+
+## 使驱动程序可配置
+
+使驱动程序可配置：
+
+1. Create a YAML module configuration file:
+
+   - Add a new file in the driver's source directory named **module.yaml**
+   - Insert the following text and adjust as needed:
+
+     ```cmake
+     module_name: uLanding Radar
+     serial_config:
+         - command: ulanding_radar start -d ${SERIAL_DEV} -b p:${BAUD_PARAM}
+           port_config_param:
+             name: SENS_ULAND_CFG
+             group: Sensors
+     ```
+
+     ::: info
+     The full documentation of the module configuration file can be found in the [validation/module_schema.yaml](https://github.com/PX4/PX4-Autopilot/blob/main/validation/module_schema.yaml) file.
+     This is also used to validate all configuration files in CI.
+
+:::
+
+2. Add the module configuration to the **CMakeLists.txt** file for the driver module:
+
+   ```cmake
+   px4_add_module(
+   	MODULE drivers__ulanding
+   	MAIN ulanding_radar
+   	SRCS
+   		ulanding.cpp
+   	MODULE_CONFIG
+   		module.yaml
+   	)
+   ```