Skip to content

Commit 197a1a6

Browse files
committed
docs: auto-sync metadata [skip ci]
Co-Authored-By: PX4 BuildBot <bot@px4.io>
1 parent 93955bd commit 197a1a6

File tree

8 files changed

+305
-178
lines changed

8 files changed

+305
-178
lines changed

docs/en/advanced_config/parameter_reference.md

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21557,6 +21557,49 @@ Maximum vertical drift speed to use GPS.
2155721557
| ------ | -------- | -------- | --------- | ------- | ---- |
2155821558
| &nbsp; | 0.1 | 1.5 | | 0.2 | m/s |
2155921559

21560+
### EKF2_RNGBC_CTRL (`INT32`) {#EKF2_RNGBC_CTRL}
21561+
21562+
Ranging beacon fusion control.
21563+
21564+
Enable/disable ranging beacon fusion.
21565+
21566+
**Values:**
21567+
21568+
- `0`: Disable ranging beacon fusion
21569+
- `1`: Enable ranging beacon fusion
21570+
21571+
| Reboot | minValue | maxValue | increment | default | unit |
21572+
| ------ | -------- | -------- | --------- | ------- | ---- |
21573+
| &nbsp; | | | | 0 | |
21574+
21575+
### EKF2_RNGBC_DELAY (`FLOAT`) {#EKF2_RNGBC_DELAY}
21576+
21577+
Ranging beacon measurement delay relative to IMU measurements.
21578+
21579+
| Reboot | minValue | maxValue | increment | default | unit |
21580+
| ------- | -------- | -------- | --------- | ------- | ---- |
21581+
| &check; | 0 | 1000 | | 0 | ms |
21582+
21583+
### EKF2_RNGBC_GATE (`FLOAT`) {#EKF2_RNGBC_GATE}
21584+
21585+
Gate size for ranging beacon fusion.
21586+
21587+
Sets the number of standard deviations used by the innovation consistency test.
21588+
21589+
| Reboot | minValue | maxValue | increment | default | unit |
21590+
| ------ | -------- | -------- | --------- | ------- | ---- |
21591+
| &nbsp; | 1.0 | | | 5.0 | SD |
21592+
21593+
### EKF2_RNGBC_NOISE (`FLOAT`) {#EKF2_RNGBC_NOISE}
21594+
21595+
Measurement noise for ranging beacon fusion.
21596+
21597+
Used to lower bound or replace the uncertainty included in the message
21598+
21599+
| Reboot | minValue | maxValue | increment | default | unit |
21600+
| ------ | -------- | -------- | --------- | ------- | ---- |
21601+
| &nbsp; | 0.1 | 500.0 | | 30.0 | m |
21602+
2156021603
### EKF2_RNG_A_HMAX (`FLOAT`) {#EKF2_RNG_A_HMAX}
2156121604

2156221605
Maximum height above ground allowed for conditional range aid mode.
@@ -40080,6 +40123,16 @@ This value is usually about few percent of the maximum thrust force.
4008040123
| ------ | -------- | -------- | --------- | ------- | ---- |
4008140124
| &nbsp; | 0.0 | | 0.05 | 0.1 | Nm |
4008240125

40126+
### SIH_RNGBC_NOISE (`FLOAT`) {#SIH_RNGBC_NOISE}
40127+
40128+
Ranging beacon measurement noise standard deviation.
40129+
40130+
Gaussian noise added to simulated ranging beacon measurements. Set to 0 to disable noise.
40131+
40132+
| Reboot | minValue | maxValue | increment | default | unit |
40133+
| ------ | -------- | -------- | --------- | ------- | ---- |
40134+
| &nbsp; | 0.0 | 100.0 | | 30.0 | m |
40135+
4008340136
### SIH_T_MAX (`FLOAT`) {#SIH_T_MAX}
4008440137

4008540138
Max propeller thrust force.

docs/en/middleware/dds_topics.md

Lines changed: 175 additions & 174 deletions
Large diffs are not rendered by default.

docs/en/msg_docs/EstimatorAidSource1d.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ pageClass: is-wide-page
44

55
# EstimatorAidSource1d (UORB message)
66

7-
**TOPICS:** estimator_aid_src_baro_hgt estimator_aid_src_ev_hgt estimator_aid_src_gnss_hgt estimator_aid_src_rng_hgt estimator_aid_src_airspeed estimator_aid_src_sideslip estimator_aid_src_fake_hgt estimator_aid_src_gnss_yaw estimator_aid_src_ev_yaw
7+
**TOPICS:** estimator_aid_src_baro_hgt estimator_aid_src_ev_hgt estimator_aid_src_gnss_hgt estimator_aid_src_rng_hgt estimator_aid_src_ranging_beacon estimator_aid_src_airspeed estimator_aid_src_sideslip estimator_aid_src_fake_hgt estimator_aid_src_gnss_yaw estimator_aid_src_ev_yaw
88

99
## Fields
1010

@@ -55,7 +55,7 @@ float32 test_ratio_filtered # signed filtered test ratio
5555
bool innovation_rejected # true if the observation has been rejected
5656
bool fused # true if the sample was successfully fused
5757

58-
# TOPICS estimator_aid_src_baro_hgt estimator_aid_src_ev_hgt estimator_aid_src_gnss_hgt estimator_aid_src_rng_hgt
58+
# TOPICS estimator_aid_src_baro_hgt estimator_aid_src_ev_hgt estimator_aid_src_gnss_hgt estimator_aid_src_rng_hgt estimator_aid_src_ranging_beacon
5959
# TOPICS estimator_aid_src_airspeed estimator_aid_src_sideslip
6060
# TOPICS estimator_aid_src_fake_hgt
6161
# TOPICS estimator_aid_src_gnss_yaw estimator_aid_src_ev_yaw

docs/en/msg_docs/RangingBeacon.md

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
---
2+
pageClass: is-wide-page
3+
---
4+
5+
# RangingBeacon (UORB message)
6+
7+
Ranging beacon measurement data (e.g. LoRa, UWB).
8+
9+
**TOPICS:** ranging_beacon
10+
11+
## Fields
12+
13+
| Name | Type | Unit [Frame] | Range/Enum | Description |
14+
| ---------------- | --------- | ------------ | --------------------- | ------------------------------------------- |
15+
| timestamp | `uint64` | us | | time since system start |
16+
| timestamp_sample | `uint64` | us | | the timestamp of the raw data |
17+
| beacon_id | `uint8` | | |
18+
| range | `float32` | m | | Range measurement |
19+
| lat | `float64` | deg | | Latitude |
20+
| lon | `float64` | deg | | Longitude |
21+
| alt | `float32` | m | | Beacon altitude (frame defined in alt_type) |
22+
| alt_type | `uint8` | | [ALT_TYPE](#ALT_TYPE) | Altitude frame for alt field |
23+
| hacc | `float32` | m | | Groundbeacon horizontal accuracy |
24+
| vacc | `float32` | m | | Groundbeacon vertical accuracy |
25+
| sequence_nr | `uint8` | | |
26+
| status | `uint8` | | |
27+
| carrier_freq | `uint16` | MHz | | Carrier frequency |
28+
| range_accuracy | `float32` | m | | Range accuracy estimate |
29+
30+
## Enums
31+
32+
### ALT_TYPE {#ALT_TYPE}
33+
34+
| Name | Type | Value | Description |
35+
| ------------------------------------------- | ------- | ----- | ------------------------------------ |
36+
| <a id="#ALT_TYPE_WGS84"></a> ALT_TYPE_WGS84 | `uint8` | 0 | Altitude above WGS84 ellipsoid |
37+
| <a id="#ALT_TYPE_MSL"></a> ALT_TYPE_MSL | `uint8` | 1 | Altitude above Mean Sea Level (AMSL) |
38+
39+
## Source Message
40+
41+
[Source file (GitHub)](https://github.com/PX4/PX4-Autopilot/blob/main/msg/RangingBeacon.msg)
42+
43+
::: details Click here to see original file
44+
45+
```c
46+
# Ranging beacon measurement data (e.g. LoRa, UWB)
47+
48+
uint64 timestamp # [us] time since system start
49+
uint64 timestamp_sample # [us] the timestamp of the raw data
50+
uint8 beacon_id
51+
float32 range # [m] Range measurement
52+
53+
float64 lat # [deg] Latitude
54+
float64 lon # [deg] Longitude
55+
float32 alt # [m] Beacon altitude (frame defined in alt_type)
56+
uint8 alt_type # [@enum ALT_TYPE] Altitude frame for alt field
57+
uint8 ALT_TYPE_WGS84 = 0 # Altitude above WGS84 ellipsoid
58+
uint8 ALT_TYPE_MSL = 1 # Altitude above Mean Sea Level (AMSL)
59+
60+
float32 hacc # [m] Groundbeacon horizontal accuracy
61+
float32 vacc # [m] Groundbeacon vertical accuracy
62+
63+
uint8 sequence_nr
64+
uint8 status
65+
uint16 carrier_freq # [MHz] Carrier frequency
66+
float32 range_accuracy # [m] Range accuracy estimate
67+
68+
69+
# TOPICS ranging_beacon
70+
```
71+
72+
:::

docs/en/msg_docs/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -192,6 +192,7 @@ Graphs showing how these are used [can be found here](../middleware/uorb_graph.m
192192
- [QshellReq](QshellReq.md)
193193
- [QshellRetval](QshellRetval.md)
194194
- [RadioStatus](RadioStatus.md)
195+
- [RangingBeacon](RangingBeacon.md) — Ranging beacon measurement data (e.g. LoRa, UWB).
195196
- [RateCtrlStatus](RateCtrlStatus.md)
196197
- [RcChannels](RcChannels.md)
197198
- [RcParameterMap](RcParameterMap.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.
126 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)