From ef17e1c4ffd1707c0f462be826316852c4ff8880 Mon Sep 17 00:00:00 2001 From: Astro Date: Tue, 24 Sep 2019 01:55:19 +0200 Subject: [PATCH] README: describe all the commands --- firmware/README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/firmware/README.md b/firmware/README.md index 8496fad..6e2db54 100644 --- a/firmware/README.md +++ b/firmware/README.md @@ -61,12 +61,12 @@ The scope of this setting is per TCP session. | `pwm <0/1> ` | Set PWM duty cycle for **i_set** to manual *width / total* | | `pwm <0/1> pid` | Set PWM to be controlled by PID | | `pid` | Show PID configuration | -| `pid <0/1> target ` | | -| `pid <0/1> kp ` | | -| `pid <0/1> ki ` | | -| `pid <0/1> kd ` | | -| `pid <0/1> output_min ` | | -| `pid <0/1> output_max ` | | -| `pid <0/1> integral_min ` | | -| `pid <0/1> integral_max ` | | +| `pid <0/1> target ` | Set the PID controller target | +| `pid <0/1> kp ` | Set proportional gain | +| `pid <0/1> ki ` | Set integral gain | +| `pid <0/1> kd ` | Set differential gain | +| `pid <0/1> output_min ` | Set mininum output | +| `pid <0/1> output_max ` | Set maximum output | +| `pid <0/1> integral_min ` | Set integral lower bound | +| `pid <0/1> integral_max ` | Set integral upper bound | | `postfilter <0/1> rate ` | Set postfilter output data rate |