From 227a157e9ef5a3a976d3628b3a0392279eb79e3a Mon Sep 17 00:00:00 2001 From: atse Date: Tue, 13 Aug 2024 17:46:37 +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 bf6cff8..5e539ff 100644 --- a/README.md +++ b/README.md @@ -100,10 +100,10 @@ formatted as line-delimited JSON. | `report mode` | Show current report mode | | `report mode ` | Set report mode | | `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 at [0, 2] | +| `pwm <0/1> max_i_neg ` | Set maximum negative output current, clamped at [0, 2] | +| `pwm <0/1> max_v ` | Set maximum output voltage, clamped at [0, 4] | +| `pwm <0/1> i_set ` | Disengage PID, set fixed output current, clamped at [-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 |