Browse Source

Documented some of the firmware changes

The new behavior of `write` has been documented, as well as a high-level
description of the new Setup mode behavior with Power Delivery
communications.

The new `output` command now has documented specifications.  Not a
single line of code has been written for it though, but this is isn't a
release so you shouldn't take everything the documentation file says as
true.
Clara Hobbs 6 years ago
parent
commit
7a940d8608
1 changed files with 21 additions and 4 deletions
  1. 21
    4
      docs/console_config.md

+ 21
- 4
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.0.1, 2017-06-19
3
+Version 1.1.0-dev, 2017-07-27
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 does not perform any USB
7
-Power Delivery communications, instead running a configuration console over a
8
-USB CDC-ACM virtual serial port.  This allows the user to change the voltage
6
+plugging it into a computer.  In this mode, the device runs a configuration
7
+interface over a USB CDC-ACM virtual serial port in addition to the usual USB
8
+Power Delivery communications.  This allows the user to change the voltage
9
 and current the Sink requests, as well as other settings related to the
9
 and current the Sink requests, as well as other settings related to the
10
 device's operation.
10
 device's operation.
11
 
11
 
108
 leveling is done to ensure long flash life, and the flash sector is
108
 leveling is done to ensure long flash life, and the flash sector is
109
 automatically erased if necessary.
109
 automatically erased if necessary.
110
 
110
 
111
+If the output is enabled, the newly written configuration is automatically
112
+negotiated.  The newly configured power is then made available on the output
113
+connector if it is available from the source.
114
+
111
 ### load
115
 ### load
112
 
116
 
113
 Usage: `load`
117
 Usage: `load`
175
 Blinks the LED quickly.  Useful for identifying which device you're connected
179
 Blinks the LED quickly.  Useful for identifying which device you're connected
176
 to if several are plugged in to your computer at once.
180
 to if several are plugged in to your computer at once.
177
 
181
 
182
+### output
183
+
184
+Usage: `output [enable|disable]`
185
+
186
+If no argument is provided, prints the state of the power output (`enabled` or
187
+`disabled`).
188
+
189
+If an argument is provided, sets the output to the specified state.
190
+
191
+This command only affects whether the output can be turned on during the
192
+ongoing run of Setup mode.  The output is disabled in Setup mode by default,
193
+and is always enabled in Sink mode.
194
+
178
 ## Configuration Format
195
 ## Configuration Format
179
 
196
 
180
 Wherever a configuration object is printed, the following format is used.
197
 Wherever a configuration object is printed, the following format is used.

Loading…
Cancel
Save