Browse Source

Documentation updates before 1.2.0

Clara Hobbs 4 years ago
parent
commit
50c84a3846
1 changed files with 13 additions and 9 deletions
  1. 13
    9
      docs/console_config.md

+ 13
- 9
docs/console_config.md View File

@@ -72,16 +72,17 @@ unplugged at any time.
72 72
 The preferred voltage may be set to any value for programmable power supplies.
73 73
 This means uncommon voltages may be set, e.g. 13.8 V.  Few non-programmable
74 74
 power supplies offer such a voltage.  To ensure a Sink configured this way can
75
-still work with as many power supplies as possible, it is possible to configure
76
-a closed range of acceptable voltages:
75
+still work with as many power supplies as possible, the Sink can be configured
76
+with a range of acceptable voltages over which it may request a fixed supply
77
+PDO if the preferred voltage is not available:
77 78
 
78 79
     PDBS) set_v 13800
79
-    PDBS) set_vrange 11000 16000
80
+    PDBS) set_vrange 12000 16000
80 81
     PDBS) get_cfg
81 82
     status: valid
82 83
     flags: (none)
83 84
     v: 13.80 V
84
-    vmin: 11.00 V
85
+    vmin: 12.00 V
85 86
     vmax: 16.00 V
86 87
     i: 2.25 A
87 88
 
@@ -94,7 +95,7 @@ lower ones, it is possible to set this as well:
94 95
     status: valid
95 96
     flags: HV_Preferred
96 97
     v: 13.80 V
97
-    vmin: 11.00 V
98
+    vmin: 12.00 V
98 99
     vmax: 16.00 V
99 100
     i: 2.25 A
100 101
 
@@ -103,9 +104,10 @@ simply set the top and bottom of the range to 0 V.
103 104
 
104 105
 ### Alternate Configuration Types
105 106
 
106
-While configuring a current to be requested at any voltage works well for some
107
-use cases (e.g. linear regulators), for others, it may make more sense to set
108
-the power required, or even the resistance of a resistive load.  As of firmware
107
+While configuring a constant current to be requested at any voltage works well
108
+for some use cases (e.g. providing input to linear regulators), for others, it
109
+may make more sense to set the power required (e.g. providing power to
110
+switching regulators), or the resistance of a resistive load.  As of firmware
109 111
 version 1.2.0, the PD Buddy Sink supports setting these directly:
110 112
 
111 113
     PDBS) set_p 45000
@@ -123,7 +125,7 @@ version 1.2.0, the PD Buddy Sink supports setting these directly:
123 125
 
124 126
 In either case, the device will set the current it requests according to the
125 127
 configured value.  The value is kept constant across the entire configured
126
-voltage range, allowing the current to vary accordingly.
128
+voltage range, allowing the current requested to vary accordingly.
127 129
 
128 130
 ## Commands
129 131
 
@@ -264,6 +266,8 @@ Usage: `set_vrange min_voltage_in_mV max_voltage_in_mV`
264 266
 Sets the minimum and maximum voltage of the configuration buffer, in
265 267
 millivolts.  Prints no message on success, an error message on failure.
266 268
 
269
+To clear the voltage range, set both the minimum and maximum voltage to 0.
270
+
267 271
 Note: values are rounded down to the nearest 20 mV, 50 mV, or 100 mV for
268 272
 various parts of the USB Power Delivery protocol.
269 273
 

Loading…
Cancel
Save