docs(params): Fix up params that render badly after prettier (#27211)

This commit is contained in:
Hamish Willee
2026-04-29 11:55:09 +10:00
committed by GitHub
parent 1a3d232e7b
commit 95d6a3c171
3 changed files with 14 additions and 2 deletions
+6 -2
View File
@@ -9,8 +9,12 @@ parameters:
Parameter used to model the nonlinear relationship between Parameter used to model the nonlinear relationship between
motor control signal (e.g. PWM) and static thrust. motor control signal (e.g. PWM) and static thrust.
The model is: rel_thrust = factor * rel_signal^2 + (1-factor) * rel_signal, The model is:
where rel_thrust is the normalized thrust between 0 and 1, and
```
rel_thrust = factor * rel_signal^2 + (1-factor) * rel_signal
```
, where rel_thrust is the normalized thrust between 0 and 1, and
rel_signal is the relative motor control signal between 0 and 1. rel_signal is the relative motor control signal between 0 and 1.
type: float type: float
default: 0.0 default: 0.0
@@ -235,7 +235,9 @@ parameters:
description: description:
short: Tuning parameter for the speed reduction based on the course error short: Tuning parameter for the speed reduction based on the course error
long: |- long: |-
```
Reduced_speed = RO_MAX_THR_SPEED * (1 - normalized_course_error * RO_SPEED_RED) Reduced_speed = RO_MAX_THR_SPEED * (1 - normalized_course_error * RO_SPEED_RED)
```
The normalized course error is the angle between the current course and the bearing setpoint The normalized course error is the angle between the current course and the bearing setpoint
interpolated from [0, 180] -> [0, 1]. interpolated from [0, 180] -> [0, 1].
Higher value -> More speed reduction. Higher value -> More speed reduction.
@@ -60,9 +60,11 @@ parameters:
Global gain of the controller. Global gain of the controller.
This gain scales the P, I and D terms of the controller: This gain scales the P, I and D terms of the controller:
```
output = MC_ROLLRATE_K * (MC_ROLLRATE_P * error output = MC_ROLLRATE_K * (MC_ROLLRATE_P * error
+ MC_ROLLRATE_I * error_integral + MC_ROLLRATE_I * error_integral
+ MC_ROLLRATE_D * error_derivative) + MC_ROLLRATE_D * error_derivative)
```
Set MC_ROLLRATE_P=1 to implement a PID in the ideal form. Set MC_ROLLRATE_P=1 to implement a PID in the ideal form.
Set MC_ROLLRATE_K=1 to implement a PID in the parallel form. Set MC_ROLLRATE_K=1 to implement a PID in the parallel form.
type: float type: float
@@ -128,9 +130,11 @@ parameters:
Global gain of the controller. Global gain of the controller.
This gain scales the P, I and D terms of the controller: This gain scales the P, I and D terms of the controller:
```
output = MC_PITCHRATE_K * (MC_PITCHRATE_P * error output = MC_PITCHRATE_K * (MC_PITCHRATE_P * error
+ MC_PITCHRATE_I * error_integral + MC_PITCHRATE_I * error_integral
+ MC_PITCHRATE_D * error_derivative) + MC_PITCHRATE_D * error_derivative)
```
Set MC_PITCHRATE_P=1 to implement a PID in the ideal form. Set MC_PITCHRATE_P=1 to implement a PID in the ideal form.
Set MC_PITCHRATE_K=1 to implement a PID in the parallel form. Set MC_PITCHRATE_K=1 to implement a PID in the parallel form.
type: float type: float
@@ -196,9 +200,11 @@ parameters:
Global gain of the controller. Global gain of the controller.
This gain scales the P, I and D terms of the controller: This gain scales the P, I and D terms of the controller:
```
output = MC_YAWRATE_K * (MC_YAWRATE_P * error output = MC_YAWRATE_K * (MC_YAWRATE_P * error
+ MC_YAWRATE_I * error_integral + MC_YAWRATE_I * error_integral
+ MC_YAWRATE_D * error_derivative) + MC_YAWRATE_D * error_derivative)
```
Set MC_YAWRATE_P=1 to implement a PID in the ideal form. Set MC_YAWRATE_P=1 to implement a PID in the ideal form.
Set MC_YAWRATE_K=1 to implement a PID in the parallel form. Set MC_YAWRATE_K=1 to implement a PID in the parallel form.
type: float type: float