From ee26616c09a4cf88ec62c1a2d8e5554c46608e33 Mon Sep 17 00:00:00 2001 From: atse Date: Fri, 16 Aug 2024 12:39:10 +0800 Subject: [PATCH] README: Document PWM value clamping --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index e4558a3..3e7943b 100644 --- a/README.md +++ b/README.md @@ -96,10 +96,10 @@ formatted as line-delimited JSON. |----------------------------------|-------------------------------------------------------------------------------| | `report` | Show current input | | `pwm` | Show current PWM settings | -| `pwm <0/1> max_i_pos ` | Set maximum positive output current | -| `pwm <0/1> max_i_neg ` | Set maximum negative output current | -| `pwm <0/1> max_v ` | Set maximum output voltage | -| `pwm <0/1> i_set ` | Disengage PID, set fixed output current | +| `pwm <0/1> max_i_pos ` | Set maximum positive output current, clamped to [0, 2] | +| `pwm <0/1> max_i_neg ` | Set maximum negative output current, clamped to [0, 2] | +| `pwm <0/1> max_v ` | Set maximum output voltage, clamped to [0, 4] | +| `pwm <0/1> i_set ` | Disengage PID, set fixed output current, clamped to [-2, 2] | | `pwm <0/1> pid` | Let output current to be controlled by the PID | | `center <0/1> ` | Set the MAX1968 0A-centerpoint to the specified fixed voltage | | `center <0/1> vref` | Set the MAX1968 0A-centerpoint to measure from VREF |