Browse Source

Minor documentation fixes

Clara Hobbs 6 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
 # PD Buddy Sink Serial Console Configuration Interface
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
 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
114
     flags: (none)
114
     flags: (none)
115
     v: 20.00 V
115
     v: 20.00 V
116
     p: 45.00 W
116
     p: 45.00 W
117
-    PDBS) set_r 8889
117
+    PDBS) set_r 8890
118
     PDBS) get_tmpcfg
118
     PDBS) get_tmpcfg
119
     status: valid
119
     status: valid
120
     flags: (none)
120
     flags: (none)
121
     v: 20.00 V
121
     v: 20.00 V
122
-    r: 8.88 Ω
122
+    r: 8.89 Ω
123
 
123
 
124
 In either case, the device will set the current it requests according to the
124
 In either case, the device will set the current it requests according to the
125
 configured value.  The value is kept constant across the entire configured
125
 configured value.  The value is kept constant across the entire configured
354
 The `v` field holds the preferred voltage of the configuration object, in
354
 The `v` field holds the preferred voltage of the configuration object, in
355
 volts.
355
 volts.
356
 The field's value is a floating-point decimal number, followed by a space and a
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
 ### vmin
359
 ### vmin
360
 
360
 
361
 The `vmin` field holds the lower end of the configuration object's voltage
361
 The `vmin` field holds the lower end of the configuration object's voltage
362
 range, in volts.
362
 range, in volts.
363
 The field's value is a floating-point decimal number, followed by a space and a
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
 When absent, this field's value may be assumed to be `0 V`.
366
 When absent, this field's value may be assumed to be `0 V`.
367
 
367
 
370
 The `vmax` field holds the upper end of the configuration object's voltage
370
 The `vmax` field holds the upper end of the configuration object's voltage
371
 range, in volts.
371
 range, in volts.
372
 The field's value is a floating-point decimal number, followed by a space and a
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
 When absent, this field's value may be assumed to be `0 V`.
375
 When absent, this field's value may be assumed to be `0 V`.
376
 
376
 
398
 
398
 
399
     PDO n: type
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
     name: value
407
     name: value
408
 
408
 

Loading…
Cancel
Save