Browse Source

Minor documentation fixes

Clara Hobbs 4 years ago
parent
commit
500774f203
1 changed files with 11 additions and 11 deletions
  1. 11
    11
      docs/console_config.md

+ 11
- 11
docs/console_config.md View File

@@ -1,6 +1,6 @@
1 1
 # PD Buddy Sink Serial Console Configuration Interface
2 2
 
3
-Version 1.2.0-dev.1, 2018-01-01
3
+Version 1.2.0-dev.1, 2018-01-09
4 4
 
5 5
 The PD Buddy Sink can be put into setup mode by holding the Setup button while
6 6
 plugging it into a computer.  In this mode, the device runs a configuration
@@ -114,12 +114,12 @@ version 1.2.0, the PD Buddy Sink supports setting these directly:
114 114
     flags: (none)
115 115
     v: 20.00 V
116 116
     p: 45.00 W
117
-    PDBS) set_r 8889
117
+    PDBS) set_r 8890
118 118
     PDBS) get_tmpcfg
119 119
     status: valid
120 120
     flags: (none)
121 121
     v: 20.00 V
122
-    r: 8.88 Ω
122
+    r: 8.89 Ω
123 123
 
124 124
 In either case, the device will set the current it requests according to the
125 125
 configured value.  The value is kept constant across the entire configured
@@ -354,14 +354,14 @@ this configuration object:
354 354
 The `v` field holds the preferred voltage of the configuration object, in
355 355
 volts.
356 356
 The field's value is a floating-point decimal number, followed by a space and a
357
-capital V.  For example: `20.00 V`.
357
+capital V.  For example: `20.000 V`.
358 358
 
359 359
 ### vmin
360 360
 
361 361
 The `vmin` field holds the lower end of the configuration object's voltage
362 362
 range, in volts.
363 363
 The field's value is a floating-point decimal number, followed by a space and a
364
-capital V.  For example: `20.00 V`.
364
+capital V.  For example: `20.000 V`.
365 365
 
366 366
 When absent, this field's value may be assumed to be `0 V`.
367 367
 
@@ -370,7 +370,7 @@ When absent, this field's value may be assumed to be `0 V`.
370 370
 The `vmax` field holds the upper end of the configuration object's voltage
371 371
 range, in volts.
372 372
 The field's value is a floating-point decimal number, followed by a space and a
373
-capital V.  For example: `20.00 V`.
373
+capital V.  For example: `20.000 V`.
374 374
 
375 375
 When absent, this field's value may be assumed to be `0 V`.
376 376
 
@@ -398,11 +398,11 @@ When a list of PDOs is printed, each PDO is numbered with a line as follows:
398 398
 
399 399
     PDO n: type
400 400
 
401
-`n` is the index of the PDO.  `type` is one of `fixed`, `typec_virtual`, or the
402
-entire PDO represented as a 32-bit hexadecimal number if the type is unknown.
403
-If `type` is not a hexadecimal number, the rest of the PDO is printed as a list
404
-of fields, one per line, each indented by a single ASCII tab character.  Each
405
-field is of the format:
401
+`n` is the index of the PDO.  `type` is one of `fixed`, `pps`, `typec_virtual`,
402
+or the entire PDO represented as a 32-bit hexadecimal number if the type is
403
+unknown.  If `type` is not a hexadecimal number, the rest of the PDO is printed
404
+as a list of fields, one per line, each indented by a single ASCII tab
405
+character.  Each field is of the format:
406 406
 
407 407
     name: value
408 408
 

Loading…
Cancel
Save