Browse Source

Change spec to have one set_vrange command

This commit changes back to the original plan of having one set_vrange
command that sets both the vmin and vmax at once, instead of separate
set_vmin and set_vmax commands.  This will allow checking that the range
is valid every time it's set instead of having to wait until
configuration is written to flash.
Clara Hobbs 6 years ago
parent
commit
2b3953675d
1 changed files with 6 additions and 16 deletions
  1. 6
    16
      docs/console_config.md

+ 6
- 16
docs/console_config.md View File

1
 # PD Buddy Sink Serial Console Configuration Interface
1
 # PD Buddy Sink Serial Console Configuration Interface
2
 
2
 
3
-Version 1.2.0-dev, 2017-10-09
3
+Version 1.2.0-dev, 2017-10-10
4
 
4
 
5
 The PD Buddy Sink can be put into setup mode by holding the Setup button while
5
 The PD Buddy Sink can be put into setup mode by holding the Setup button while
6
 plugging it into a computer.  In this mode, the device runs a configuration
6
 plugging it into a computer.  In this mode, the device runs a configuration
76
 a closed range of acceptable voltages:
76
 a closed range of acceptable voltages:
77
 
77
 
78
     PDBS) set_v 13800
78
     PDBS) set_v 13800
79
-    PDBS) set_vmin 11000
80
-    PDBS) set_vmax 16000
79
+    PDBS) set_vrange 11000 16000
81
     PDBS) get_cfg
80
     PDBS) get_cfg
82
     status: valid
81
     status: valid
83
     flags: (none)
82
     flags: (none)
250
 
249
 
251
 Note: values are rounded down to the nearest 10 mV.
250
 Note: values are rounded down to the nearest 10 mV.
252
 
251
 
253
-#### set_vmin
252
+#### set_vrange
254
 
253
 
255
-Usage: `set_vmin voltage_in_mV`
254
+Usage: `set_vrange min_voltage_in_mV max_voltage_in_mV`
256
 
255
 
257
-Sets the minimum voltage of the configuration buffer, in millivolts.  Prints no
258
-message on success, an error message on failure.
259
-
260
-Note: values are rounded down to the nearest 10 mV.
261
-
262
-#### set_vmax
263
-
264
-Usage: `set_vmax voltage_in_mV`
265
-
266
-Sets the maximum voltage of the configuration buffer, in millivolts.  Prints no
267
-message on success, an error message on failure.
256
+Sets the minimum and maximum voltage of the configuration buffer, in
257
+millivolts.  Prints no message on success, an error message on failure.
268
 
258
 
269
 Note: values are rounded down to the nearest 10 mV.
259
 Note: values are rounded down to the nearest 10 mV.
270
 
260
 

Loading…
Cancel
Save