Skip to content

Commit 0ffa4e7

Browse files
PX4BuildBotPX4BuildBot
committed
docs: auto-sync metadata [skip ci]
 Co-Authored-By: PX4 BuildBot <bot@px4.io>
1 parent c8a1a38 commit 0ffa4e7

8 files changed

Lines changed: 305 additions & 178 deletions

File tree

‎docs/en/advanced_config/parameter_reference.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21790,6 +21790,32 @@ EKF2 selector maximum accumulated velocity threshold for comparing accelerometer
2179021790
| ------ | -------- | -------- | --------- | ------- | ---- |
2179121791
| &nbsp; | | | | 2.0 | m/s |
2179221792

21793+
### EKF2_SENS_EN (`INT32`) {#EKF2_SENS_EN}
21794+
21795+
Sensor fusion enable bitmask.
21796+
21797+
Bitmask to control which sensor fusion sources are enabled. Sources whose bit is cleared will be disabled. Only applied while disarmed. For in-flight changes use the MAVLink command VEHICLE_CMD_ESTIMATOR_SENSOR_ENABLE or the individual CTRL params (e.g. EKF2_GPS_CTRL, EKF2_BARO_CTRL).
21798+
21799+
**Bitmask:**
21800+
21801+
- `0`: GNSS 0
21802+
- `1`: GNSS 1
21803+
- `2`: Optical flow
21804+
- `3`: External vision
21805+
- `4`: Aux global position 0
21806+
- `5`: Aux global position 1
21807+
- `6`: Aux global position 2
21808+
- `7`: Aux global position 3
21809+
- `8`: Barometer
21810+
- `9`: Range finder
21811+
- `10`: Magnetometer
21812+
- `11`: Airspeed
21813+
- `12`: Ranging beacon
21814+
21815+
| Reboot | minValue | maxValue | increment | default | unit |
21816+
| ------ | -------- | -------- | --------- | ------- | ---- |
21817+
| &nbsp; | 0 | 8191 | | 8191 | |
21818+
2179321819
### EKF2_SYNT_MAG_Z (`INT32`) {#EKF2_SYNT_MAG_Z}
2179421820

2179521821
Enable synthetic magnetometer Z component measurement.

‎docs/en/middleware/dds_topics.md‎

Lines changed: 177 additions & 176 deletions
Large diffs are not rendered by default.

‎docs/en/msg_docs/EstimatorFusionControl.md‎

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
---
2+
pageClass: is-wide-page
3+
---
4+
5+
# EstimatorFusionControl (UORB message)
6+
7+
**TOPICS:** estimator_fusion_control
8+
9+
## Fields
10+
11+
| Name | Type | Unit [Frame] | Range/Enum | Description |
12+
| --------------- | --------- | ------------ | ---------- | -------------------------------------- |
13+
| timestamp | `uint64` | | | time since system start (microseconds) |
14+
| gps_intended | `bool[2]` | | |
15+
| of_intended | `bool` | | |
16+
| ev_intended | `bool` | | |
17+
| agp_intended | `bool[4]` | | |
18+
| baro_intended | `bool` | | |
19+
| rng_intended | `bool` | | |
20+
| mag_intended | `bool` | | |
21+
| aspd_intended | `bool` | | |
22+
| rngbcn_intended | `bool` | | |
23+
| gps_active | `bool[2]` | | |
24+
| of_active | `bool` | | |
25+
| ev_active | `bool` | | |
26+
| agp_active | `bool[4]` | | |
27+
| baro_active | `bool` | | |
28+
| rng_active | `bool` | | |
29+
| mag_active | `bool` | | |
30+
| aspd_active | `bool` | | |
31+
| rngbcn_active | `bool` | | |
32+
33+
## Source Message
34+
35+
[Source file (GitHub)](https://github.com/PX4/PX4-Autopilot/blob/main/msg/EstimatorFusionControl.msg)
36+
37+
::: details Click here to see original file
38+
39+
```c
40+
uint64 timestamp # time since system start (microseconds)
41+
42+
# sensor intended for fusion (enabled via EKF2_SENS_EN AND CTRL param != disabled)
43+
bool[2] gps_intended
44+
bool of_intended
45+
bool ev_intended
46+
bool[4] agp_intended
47+
bool baro_intended
48+
bool rng_intended
49+
bool mag_intended
50+
bool aspd_intended
51+
bool rngbcn_intended
52+
53+
# whether the estimator is actively fusing data from each source
54+
bool[2] gps_active
55+
bool of_active
56+
bool ev_active
57+
bool[4] agp_active
58+
bool baro_active
59+
bool rng_active
60+
bool mag_active
61+
bool aspd_active
62+
bool rngbcn_active
63+
```
64+
65+
:::

‎docs/en/msg_docs/VehicleCommand.md‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1458,6 +1458,20 @@ None
14581458
| 6 | | | ? |
14591459
| 7 | | | ? |
14601460

1461+
### VEHICLE_CMD_ESTIMATOR_SENSOR_ENABLE (43006)
1462+
1463+
Enable/disable estimator sensor fusion.
1464+
1465+
| Param | Units | Range/Enum | Description |
1466+
| ----- | ----- | ---------- | ---------------------------------- |
1467+
| 1 | | | Source (FUSION*SOURCE*\*) |
1468+
| 2 | | | Sensor instance (0-based) |
1469+
| 3 | | | Enable (1) or Disable (0) |
1470+
| 4 | | | Estimator Instance (NaN: not used) |
1471+
| 5 | | | Empty |
1472+
| 6 | | | Empty |
1473+
| 7 | | | Empty |
1474+
14611475
### VEHICLE_CMD_PX4_INTERNAL_START (65537)
14621476

14631477
Start of PX4 internal only vehicle commands (> UINT16_MAX).
@@ -1544,6 +1558,15 @@ Change mode by specifying nav_state directly.
15441558
| --------------------------------------------------------------------------------------------------------- | -------- | ----- | ----------------------------------------------------------------------------------------------------- |
15451559
| <a id="#MESSAGE_VERSION"></a> MESSAGE_VERSION | `uint32` | 0 |
15461560
| <a id="#PREFLIGHT_CALIBRATION_TEMPERATURE_CALIBRATION"></a> PREFLIGHT_CALIBRATION_TEMPERATURE_CALIBRATION | `uint16` | 3 | Param value for VEHICLE_CMD_PREFLIGHT_CALIBRATION to start temperature calibration. |
1561+
| <a id="#FUSION_SOURCE_GPS"></a> FUSION_SOURCE_GPS | `uint8` | 0 | GNSS (EKF2_GPS{i}\_CTRL, use instance param) |
1562+
| <a id="#FUSION_SOURCE_OF"></a> FUSION_SOURCE_OF | `uint8` | 1 | Optical Flow (EKF2_OF_CTRL) |
1563+
| <a id="#FUSION_SOURCE_EV"></a> FUSION_SOURCE_EV | `uint8` | 2 | External Vision (EKF2_EV_CTRL) |
1564+
| <a id="#FUSION_SOURCE_AGP"></a> FUSION_SOURCE_AGP | `uint8` | 3 | Auxiliary Global Position (EKF2_AGP{i}\_CTRL, use instance param) |
1565+
| <a id="#FUSION_SOURCE_BARO"></a> FUSION_SOURCE_BARO | `uint8` | 4 | Barometer (EKF2_BARO_CTRL) |
1566+
| <a id="#FUSION_SOURCE_RNG"></a> FUSION_SOURCE_RNG | `uint8` | 5 | Range Finder (EKF2_RNG_CTRL) |
1567+
| <a id="#FUSION_SOURCE_MAG"></a> FUSION_SOURCE_MAG | `uint8` | 6 | Magnetometer (EKF2_MAG_TYPE) |
1568+
| <a id="#FUSION_SOURCE_ASPD"></a> FUSION_SOURCE_ASPD | `uint8` | 7 | Airspeed (EKF2_ARSP_THR) |
1569+
| <a id="#FUSION_SOURCE_RNGBCN"></a> FUSION_SOURCE_RNGBCN | `uint8` | 8 | Ranging Beacon |
15471570
| <a id="#VEHICLE_MOUNT_MODE_RETRACT"></a> VEHICLE_MOUNT_MODE_RETRACT | `uint8` | 0 | Load and keep safe position (Roll,Pitch,Yaw) from permanent memory and stop stabilization. |
15481571
| <a id="#VEHICLE_MOUNT_MODE_NEUTRAL"></a> VEHICLE_MOUNT_MODE_NEUTRAL | `uint8` | 1 | Load and keep neutral position (Roll,Pitch,Yaw) from permanent memory. |
15491572
| <a id="#VEHICLE_MOUNT_MODE_MAVLINK_TARGETING"></a> VEHICLE_MOUNT_MODE_MAVLINK_TARGETING | `uint8` | 2 | Load neutral position and start MAVLink Roll,Pitch,Yaw control with stabilization. |
@@ -1710,6 +1733,17 @@ uint16 VEHICLE_CMD_DO_WINCH = 42600 # Command to operate winch.
17101733

17111734
uint16 VEHICLE_CMD_EXTERNAL_POSITION_ESTIMATE = 43003 # External reset of estimator global position when dead reckoning.
17121735
uint16 VEHICLE_CMD_EXTERNAL_WIND_ESTIMATE = 43004
1736+
uint16 VEHICLE_CMD_ESTIMATOR_SENSOR_ENABLE = 43006 # Enable/disable estimator sensor fusion. |Source (FUSION_SOURCE_*)|Sensor instance (0-based)|Enable (1) or Disable (0)|Estimator Instance (NaN: not used)|Empty|Empty|Empty|
1737+
# Sensor fusion source types for VEHICLE_CMD_ESTIMATOR_SENSOR_ENABLE
1738+
uint8 FUSION_SOURCE_GPS = 0 # GNSS (EKF2_GPS{i}_CTRL, use instance param)
1739+
uint8 FUSION_SOURCE_OF = 1 # Optical Flow (EKF2_OF_CTRL)
1740+
uint8 FUSION_SOURCE_EV = 2 # External Vision (EKF2_EV_CTRL)
1741+
uint8 FUSION_SOURCE_AGP = 3 # Auxiliary Global Position (EKF2_AGP{i}_CTRL, use instance param)
1742+
uint8 FUSION_SOURCE_BARO = 4 # Barometer (EKF2_BARO_CTRL)
1743+
uint8 FUSION_SOURCE_RNG = 5 # Range Finder (EKF2_RNG_CTRL)
1744+
uint8 FUSION_SOURCE_MAG = 6 # Magnetometer (EKF2_MAG_TYPE)
1745+
uint8 FUSION_SOURCE_ASPD = 7 # Airspeed (EKF2_ARSP_THR)
1746+
uint8 FUSION_SOURCE_RNGBCN = 8 # Ranging Beacon
17131747

17141748
# PX4 vehicle commands (beyond 16 bit MAVLink commands).
17151749
uint32 VEHICLE_CMD_PX4_INTERNAL_START = 65537 # Start of PX4 internal only vehicle commands (> UINT16_MAX).

‎docs/en/msg_docs/index.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,7 @@ Graphs showing how these are used [can be found here](../middleware/uorb_graph.m
9595
- [EstimatorBias](EstimatorBias.md)
9696
- [EstimatorBias3d](EstimatorBias3d.md)
9797
- [EstimatorEventFlags](EstimatorEventFlags.md)
98+
- [EstimatorFusionControl](EstimatorFusionControl.md)
9899
- [EstimatorGpsStatus](EstimatorGpsStatus.md)
99100
- [EstimatorInnovations](EstimatorInnovations.md)
100101
- [EstimatorSelectorStatus](EstimatorSelectorStatus.md)

‎docs/public/config/failsafe/index.js‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/public/config/failsafe/index.wasm‎

30 Bytes
Binary file not shown.

‎docs/public/config/failsafe/parameters.json‎

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)