|
@@ -1,6 +1,6 @@
|
1
|
1
|
# PD Buddy Sink Serial Console Configuration Interface
|
2
|
2
|
|
3
|
|
-Version 1.2.0-dev, 2017-09-11
|
|
3
|
+Version 1.2.0-dev, 2017-10-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
|
|
@@ -83,31 +83,49 @@ and a question mark. For example:
|
83
|
83
|
PDBS) foo bar
|
84
|
84
|
foo ?
|
85
|
85
|
|
86
|
|
-### help
|
|
86
|
+### Miscellaneous
|
|
87
|
+
|
|
88
|
+#### help
|
87
|
89
|
|
88
|
90
|
Usage: `help`
|
89
|
91
|
|
90
|
92
|
Prints short help messages about all available commands.
|
91
|
93
|
|
92
|
|
-### license
|
|
94
|
+#### license
|
93
|
95
|
|
94
|
96
|
Usage: `license`
|
95
|
97
|
|
96
|
98
|
Prints licensing information for the firmware.
|
97
|
99
|
|
98
|
|
-### erase
|
|
100
|
+#### identify
|
99
|
101
|
|
100
|
|
-Usage: `erase`
|
|
102
|
+Usage: `identify`
|
101
|
103
|
|
102
|
|
-Synchronously erases all stored configuration from flash. This can be used to
|
103
|
|
-restore a device to its default state.
|
|
104
|
+Blinks the LED quickly. Useful for identifying which device you're connected
|
|
105
|
+to if several are plugged in to your computer at once.
|
104
|
106
|
|
105
|
|
-Note: The `erase` command is mainly intended for development and testing.
|
106
|
|
-Stored configuration is automatically erased if necessary when `write` is run,
|
107
|
|
-and wear leveling is performed as well. Unless you really know what you're
|
108
|
|
-doing, there should be no reason to ever run `erase`.
|
|
107
|
+### Storage
|
|
108
|
+
|
|
109
|
+#### get_cfg
|
|
110
|
+
|
|
111
|
+Usage: `get_cfg [index]`
|
|
112
|
+
|
|
113
|
+If no index is provided, prints the current configuration from flash. If there
|
|
114
|
+is no configuration, `No configuration` is printed instead.
|
|
115
|
+
|
|
116
|
+For developers: if an index is provided, prints a particular location in the
|
|
117
|
+configuration flash sector. If the index lies outside the configuration flash
|
|
118
|
+sector, `Invalid index` is printed instead.
|
|
119
|
+
|
|
120
|
+#### load
|
|
121
|
+
|
|
122
|
+Usage: `load`
|
|
123
|
+
|
|
124
|
+Loads the current configuration from flash into the buffer. Useful if you want
|
|
125
|
+to change some settings while leaving others alone. If there is no
|
|
126
|
+configuration, `No configuration` is printed instead.
|
109
|
127
|
|
110
|
|
-### write
|
|
128
|
+#### write
|
111
|
129
|
|
112
|
130
|
Usage: `write`
|
113
|
131
|
|
|
@@ -119,38 +137,33 @@ If the output is enabled, the newly written configuration is automatically
|
119
|
137
|
negotiated. The newly configured power is then made available on the output
|
120
|
138
|
connector if it is available from the source.
|
121
|
139
|
|
122
|
|
-### load
|
123
|
|
-
|
124
|
|
-Usage: `load`
|
|
140
|
+#### erase
|
125
|
141
|
|
126
|
|
-Loads the current configuration from flash into the buffer. Useful if you want
|
127
|
|
-to change some settings while leaving others alone. If there is no
|
128
|
|
-configuration, `No configuration` is printed instead.
|
129
|
|
-
|
130
|
|
-### get_cfg
|
|
142
|
+Usage: `erase`
|
131
|
143
|
|
132
|
|
-Usage: `get_cfg [index]`
|
|
144
|
+Synchronously erases all stored configuration from flash. This can be used to
|
|
145
|
+restore a device to its default state.
|
133
|
146
|
|
134
|
|
-If no index is provided, prints the current configuration from flash. If there
|
135
|
|
-is no configuration, `No configuration` is printed instead.
|
|
147
|
+Note: The `erase` command is mainly intended for development and testing.
|
|
148
|
+Stored configuration is automatically erased if necessary when `write` is run,
|
|
149
|
+and wear leveling is performed as well. Unless you really know what you're
|
|
150
|
+doing, there should be no reason to ever run `erase`.
|
136
|
151
|
|
137
|
|
-For developers: if an index is provided, prints a particular location in the
|
138
|
|
-configuration flash sector. If the index lies outside the configuration flash
|
139
|
|
-sector, `Invalid index` is printed instead.
|
|
152
|
+### Configuration
|
140
|
153
|
|
141
|
|
-### get_tmpcfg
|
|
154
|
+#### get_tmpcfg
|
142
|
155
|
|
143
|
156
|
Usage: `get_tmpcfg`
|
144
|
157
|
|
145
|
158
|
Prints the contents of the configuration buffer.
|
146
|
159
|
|
147
|
|
-### clear_flags
|
|
160
|
+#### clear_flags
|
148
|
161
|
|
149
|
162
|
Usage: `clear_flags`
|
150
|
163
|
|
151
|
164
|
Clears all the flags in the configuration buffer.
|
152
|
165
|
|
153
|
|
-### toggle_giveback
|
|
166
|
+#### toggle_giveback
|
154
|
167
|
|
155
|
168
|
Usage: `toggle_giveback`
|
156
|
169
|
|
|
@@ -159,7 +172,7 @@ power supply to temporarily remove power from the Sink's output if another
|
159
|
172
|
device needs more power. Recommended if the Sink is being used to charge a
|
160
|
173
|
battery.
|
161
|
174
|
|
162
|
|
-### set_v
|
|
175
|
+#### set_v
|
163
|
176
|
|
164
|
177
|
Usage: `set_v voltage_in_mV`
|
165
|
178
|
|
|
@@ -169,7 +182,7 @@ on success, an error message on failure.
|
169
|
182
|
Note: values are rounded down to the nearest Power Delivery voltage unit
|
170
|
183
|
(50 mV).
|
171
|
184
|
|
172
|
|
-### set_i
|
|
185
|
+#### set_i
|
173
|
186
|
|
174
|
187
|
Usage: `set_i current_in_mA`
|
175
|
188
|
|
|
@@ -179,14 +192,9 @@ output on success, an error message on failure.
|
179
|
192
|
Note: values are rounded down to the nearest Power Delivery current unit
|
180
|
193
|
(10 mA).
|
181
|
194
|
|
182
|
|
-### identify
|
183
|
|
-
|
184
|
|
-Usage: `identify`
|
185
|
|
-
|
186
|
|
-Blinks the LED quickly. Useful for identifying which device you're connected
|
187
|
|
-to if several are plugged in to your computer at once.
|
|
195
|
+### Power Delivery
|
188
|
196
|
|
189
|
|
-### output
|
|
197
|
+#### output
|
190
|
198
|
|
191
|
199
|
Usage: `output [enable|disable]`
|
192
|
200
|
|
|
@@ -199,7 +207,7 @@ This command only affects whether the output can be turned on during the
|
199
|
207
|
ongoing run of Setup mode. The output is disabled in Setup mode by default,
|
200
|
208
|
and is always enabled in Sink mode.
|
201
|
209
|
|
202
|
|
-### get_source_cap
|
|
210
|
+#### get_source_cap
|
203
|
211
|
|
204
|
212
|
Usage: `get_source_cap`
|
205
|
213
|
|