Skip to content

Commit fddd64d

Browse files
author
pyocd-bot
committed
Deploying to main from @ pyocd/pyocd-website-source@760e2a8 🚀
1 parent 339a07b commit fddd64d

31 files changed

+1676
-74
lines changed

‎docs/adding_new_targets.html‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -153,11 +153,14 @@ <h5 class="sidebar-header level-1">Python API</h5>
153153
<li class="sidebar-item level-1">
154154
<a href="/docs/api_examples.html" class="sidebar-link ">Python API examples</a>
155155
</li>
156+
<li class="sidebar-item level-1">
157+
<a href="/docs/api/using_session_options.html" class="sidebar-link ">Using session options</a>
158+
</li>
156159
</ul>
157160
<h5 class="sidebar-header level-1">Developers</h5>
158161
<ul class="list-unstyled level-1">
159162
<li class="sidebar-item level-1">
160-
<a href="/docs/developers_guide.html" class="sidebar-link ">Developers' guide</a>
163+
<a href="/docs/developers_guide.html" class="sidebar-link ">Developers’ guide</a>
161164
</li>
162165
<li class="sidebar-item level-1">
163166
<p class="sidebar-item-selected">Adding a new built-in target</p>
@@ -173,6 +176,9 @@ <h5 class="sidebar-header level-1">Developers</h5>
173176
<li class="sidebar-item level-2">
174177
<a href="/docs/architecture.html" class="sidebar-link ">Architecture</a>
175178
</li>
179+
<li class="sidebar-item level-2">
180+
<a href="/docs/developer/board_ids.html" class="sidebar-link ">Board IDs</a>
181+
</li>
176182
<li class="sidebar-item level-2">
177183
<a href="/docs/remote_probe_protocol.html" class="sidebar-link ">Remote probe protocol</a>
178184
</li>

‎docs/api/using_session_options.html‎

Lines changed: 393 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/api_examples.html‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -153,11 +153,14 @@ <h5 class="sidebar-header level-1">Python API</h5>
153153
<li class="sidebar-item level-1">
154154
<p class="sidebar-item-selected">Python API examples</p>
155155
</li>
156+
<li class="sidebar-item level-1">
157+
<a href="/docs/api/using_session_options.html" class="sidebar-link ">Using session options</a>
158+
</li>
156159
</ul>
157160
<h5 class="sidebar-header level-1">Developers</h5>
158161
<ul class="list-unstyled level-1">
159162
<li class="sidebar-item level-1">
160-
<a href="/docs/developers_guide.html" class="sidebar-link ">Developers' guide</a>
163+
<a href="/docs/developers_guide.html" class="sidebar-link ">Developers’ guide</a>
161164
</li>
162165
<li class="sidebar-item level-1">
163166
<a href="/docs/adding_new_targets.html" class="sidebar-link ">Adding a new built-in target</a>
@@ -173,6 +176,9 @@ <h5 class="sidebar-header level-1">Developers</h5>
173176
<li class="sidebar-item level-2">
174177
<a href="/docs/architecture.html" class="sidebar-link ">Architecture</a>
175178
</li>
179+
<li class="sidebar-item level-2">
180+
<a href="/docs/developer/board_ids.html" class="sidebar-link ">Board IDs</a>
181+
</li>
176182
<li class="sidebar-item level-2">
177183
<a href="/docs/remote_probe_protocol.html" class="sidebar-link ">Remote probe protocol</a>
178184
</li>

‎docs/architecture.html‎

Lines changed: 8 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -153,11 +153,14 @@ <h5 class="sidebar-header level-1">Python API</h5>
153153
<li class="sidebar-item level-1">
154154
<a href="/docs/api_examples.html" class="sidebar-link ">Python API examples</a>
155155
</li>
156+
<li class="sidebar-item level-1">
157+
<a href="/docs/api/using_session_options.html" class="sidebar-link ">Using session options</a>
158+
</li>
156159
</ul>
157160
<h5 class="sidebar-header level-1">Developers</h5>
158161
<ul class="list-unstyled level-1">
159162
<li class="sidebar-item level-1">
160-
<a href="/docs/developers_guide.html" class="sidebar-link ">Developers' guide</a>
163+
<a href="/docs/developers_guide.html" class="sidebar-link ">Developers’ guide</a>
161164
</li>
162165
<li class="sidebar-item level-1">
163166
<a href="/docs/adding_new_targets.html" class="sidebar-link ">Adding a new built-in target</a>
@@ -173,6 +176,9 @@ <h5 class="sidebar-header level-1">Developers</h5>
173176
<li class="sidebar-item level-2">
174177
<p class="sidebar-item-selected">Architecture</p>
175178
</li>
179+
<li class="sidebar-item level-2">
180+
<a href="/docs/developer/board_ids.html" class="sidebar-link ">Board IDs</a>
181+
</li>
176182
<li class="sidebar-item level-2">
177183
<a href="/docs/remote_probe_protocol.html" class="sidebar-link ">Remote probe protocol</a>
178184
</li>
@@ -210,7 +216,6 @@ <h5 class="sidebar-header">On this page</h5>
210216
<li class="toc-entry toc-h2"><a href="#targets-and-boards">Targets and boards</a>
211217
<ul>
212218
<li class="toc-entry toc-h4"><a href="#target-support">Target support</a></li>
213-
<li class="toc-entry toc-h4"><a href="#board-information">Board information</a></li>
214219
</ul>
215220
</li>
216221
</ul>
@@ -223,24 +228,7 @@ <h2 id="object-graph">Object graph</h2>
223228
that a user of the Python API will interact with. The connections in the diagram represent
224229
composition, not inheritance.</p>
225230

226-
<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code> Session
227-
|
228-
|----------------\
229-
| |
230-
Board DebugProbe
231-
|
232-
CoreSightTarget
233-
|
234-
|----------------\
235-
| |
236-
CortexM[] DebugPort
237-
| |
238-
MemoryMap AccessPort[]
239-
|
240-
MemoryRegion[]
241-
|
242-
Flash
243-
</code></pre></div></div>
231+
<p><img src="resources/internal_architecture.svg" alt="" /></p>
244232

245233
<p>The root of the runtime object graph is a <code class="highlighter-rouge">Session</code> object. This object holds references to the debug
246234
probe and the board. It is also responsible for managing per-session options that control
@@ -271,14 +259,6 @@ <h4 id="target-support">Target support</h4>
271259
are set on flash memory regions when they are created in the memory map. Some device families have
272260
family subclasses under <code class="highlighter-rouge">pyocd/target/family</code>.</p>
273261

274-
<h4 id="board-information">Board information</h4>
275-
276-
<p>pyOCD can automatically identify a board and its target type using the board information.
277-
The board information is stored in the <code class="highlighter-rouge">BOARD_ID_TO_INFO</code> dictionary in <code class="highlighter-rouge">pyocd/board/board_ids.py</code>.
278-
This dictionary maps a 4-character board ID to a board name, target type, and test firmware binary.
279-
The board ID is generally the same as the board’s Mbed platform ID, though non-Mbed boards that use
280-
<a href="https://github.com/ARMmbed/DAPLink">Arm DAPLink</a> firmware also have board IDs allocated from
281-
the same namespace.</p>
282262

283263

284264
</div>

‎docs/automated_tests.html‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -153,11 +153,14 @@ <h5 class="sidebar-header level-1">Python API</h5>
153153
<li class="sidebar-item level-1">
154154
<a href="/docs/api_examples.html" class="sidebar-link ">Python API examples</a>
155155
</li>
156+
<li class="sidebar-item level-1">
157+
<a href="/docs/api/using_session_options.html" class="sidebar-link ">Using session options</a>
158+
</li>
156159
</ul>
157160
<h5 class="sidebar-header level-1">Developers</h5>
158161
<ul class="list-unstyled level-1">
159162
<li class="sidebar-item level-1">
160-
<a href="/docs/developers_guide.html" class="sidebar-link ">Developers' guide</a>
163+
<a href="/docs/developers_guide.html" class="sidebar-link ">Developers’ guide</a>
161164
</li>
162165
<li class="sidebar-item level-1">
163166
<a href="/docs/adding_new_targets.html" class="sidebar-link ">Adding a new built-in target</a>
@@ -173,6 +176,9 @@ <h5 class="sidebar-header level-1">Developers</h5>
173176
<li class="sidebar-item level-2">
174177
<a href="/docs/architecture.html" class="sidebar-link ">Architecture</a>
175178
</li>
179+
<li class="sidebar-item level-2">
180+
<a href="/docs/developer/board_ids.html" class="sidebar-link ">Board IDs</a>
181+
</li>
176182
<li class="sidebar-item level-2">
177183
<a href="/docs/remote_probe_protocol.html" class="sidebar-link ">Remote probe protocol</a>
178184
</li>

‎docs/builtin-targets.html‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -153,11 +153,14 @@ <h5 class="sidebar-header level-1">Python API</h5>
153153
<li class="sidebar-item level-1">
154154
<a href="/docs/api_examples.html" class="sidebar-link ">Python API examples</a>
155155
</li>
156+
<li class="sidebar-item level-1">
157+
<a href="/docs/api/using_session_options.html" class="sidebar-link ">Using session options</a>
158+
</li>
156159
</ul>
157160
<h5 class="sidebar-header level-1">Developers</h5>
158161
<ul class="list-unstyled level-1">
159162
<li class="sidebar-item level-1">
160-
<a href="/docs/developers_guide.html" class="sidebar-link ">Developers' guide</a>
163+
<a href="/docs/developers_guide.html" class="sidebar-link ">Developers’ guide</a>
161164
</li>
162165
<li class="sidebar-item level-1">
163166
<a href="/docs/adding_new_targets.html" class="sidebar-link ">Adding a new built-in target</a>
@@ -173,6 +176,9 @@ <h5 class="sidebar-header level-1">Developers</h5>
173176
<li class="sidebar-item level-2">
174177
<a href="/docs/architecture.html" class="sidebar-link ">Architecture</a>
175178
</li>
179+
<li class="sidebar-item level-2">
180+
<a href="/docs/developer/board_ids.html" class="sidebar-link ">Board IDs</a>
181+
</li>
176182
<li class="sidebar-item level-2">
177183
<a href="/docs/remote_probe_protocol.html" class="sidebar-link ">Remote probe protocol</a>
178184
</li>

‎docs/command_reference.html‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -153,11 +153,14 @@ <h5 class="sidebar-header level-1">Python API</h5>
153153
<li class="sidebar-item level-1">
154154
<a href="/docs/api_examples.html" class="sidebar-link ">Python API examples</a>
155155
</li>
156+
<li class="sidebar-item level-1">
157+
<a href="/docs/api/using_session_options.html" class="sidebar-link ">Using session options</a>
158+
</li>
156159
</ul>
157160
<h5 class="sidebar-header level-1">Developers</h5>
158161
<ul class="list-unstyled level-1">
159162
<li class="sidebar-item level-1">
160-
<a href="/docs/developers_guide.html" class="sidebar-link ">Developers' guide</a>
163+
<a href="/docs/developers_guide.html" class="sidebar-link ">Developers’ guide</a>
161164
</li>
162165
<li class="sidebar-item level-1">
163166
<a href="/docs/adding_new_targets.html" class="sidebar-link ">Adding a new built-in target</a>
@@ -173,6 +176,9 @@ <h5 class="sidebar-header level-1">Developers</h5>
173176
<li class="sidebar-item level-2">
174177
<a href="/docs/architecture.html" class="sidebar-link ">Architecture</a>
175178
</li>
179+
<li class="sidebar-item level-2">
180+
<a href="/docs/developer/board_ids.html" class="sidebar-link ">Board IDs</a>
181+
</li>
176182
<li class="sidebar-item level-2">
177183
<a href="/docs/remote_probe_protocol.html" class="sidebar-link ">Remote probe protocol</a>
178184
</li>

‎docs/configuration.html‎

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -153,11 +153,14 @@ <h5 class="sidebar-header level-1">Python API</h5>
153153
<li class="sidebar-item level-1">
154154
<a href="/docs/api_examples.html" class="sidebar-link ">Python API examples</a>
155155
</li>
156+
<li class="sidebar-item level-1">
157+
<a href="/docs/api/using_session_options.html" class="sidebar-link ">Using session options</a>
158+
</li>
156159
</ul>
157160
<h5 class="sidebar-header level-1">Developers</h5>
158161
<ul class="list-unstyled level-1">
159162
<li class="sidebar-item level-1">
160-
<a href="/docs/developers_guide.html" class="sidebar-link ">Developers' guide</a>
163+
<a href="/docs/developers_guide.html" class="sidebar-link ">Developers’ guide</a>
161164
</li>
162165
<li class="sidebar-item level-1">
163166
<a href="/docs/adding_new_targets.html" class="sidebar-link ">Adding a new built-in target</a>
@@ -173,6 +176,9 @@ <h5 class="sidebar-header level-1">Developers</h5>
173176
<li class="sidebar-item level-2">
174177
<a href="/docs/architecture.html" class="sidebar-link ">Architecture</a>
175178
</li>
179+
<li class="sidebar-item level-2">
180+
<a href="/docs/developer/board_ids.html" class="sidebar-link ">Board IDs</a>
181+
</li>
176182
<li class="sidebar-item level-2">
177183
<a href="/docs/remote_probe_protocol.html" class="sidebar-link ">Remote probe protocol</a>
178184
</li>
@@ -218,25 +224,24 @@ <h5 class="sidebar-header">On this page</h5>
218224
<h2 id="introduction">Introduction</h2>
219225

220226
<p>pyOCD allows you to control many aspects of its behaviour by setting
221-
<a href="/docs/options.html">session options</a>. There are multiple ways to set these options.</p>
227+
<em>session options</em>. There are multiple ways to set these options.</p>
222228

223229
<ul>
224230
<li>Many of the most commonly used session options have dedicated command line arguments.</li>
225231
<li>Options can be placed in a YAML config file.</li>
226232
<li>Arbitrary options can be set individually with the <tt>-O<i>option</i>=<i>value</i></tt> command line argument.</li>
227-
<li>If you are using the Python API, you may pass any option values directly
228-
to the <code class="highlighter-rouge">ConnectHelper</code> methods or <code class="highlighter-rouge">Session</code> constructor as keyword arguments. You can also
229-
pass a dictionary for the <code class="highlighter-rouge">options</code> parameter of these methods.</li>
233+
<li>If you are using the Python API, see the <a href="/docs/api/using_session_options.html">session options developer documentation</a> for information about using session options.</li>
230234
</ul>
231235

232236
<p>The priorities of the different session option sources, from highest to lowest:</p>
233237

234238
<ol>
235-
<li>Keyword arguments to the <code class="highlighter-rouge">Session</code> constructor. Applies to most command-line arguments.</li>
236-
<li><em>options</em> parameter to constructor. Applies to <code class="highlighter-rouge">-O</code> command-line arguments.</li>
239+
<li>Dedicated command-line arguments.</li>
240+
<li><code class="highlighter-rouge">-O</code> command-line arguments.</li>
237241
<li>Probe-specific options from a config file.</li>
238-
<li>General options from a config file.</li>
239-
<li><em>option_defaults</em> parameter to constructor. Used only in rare cases.</li>
242+
<li>Global options from a config file.</li>
243+
<li>Changes to an option’s default value. Used only in rare cases for certain subcommands.</li>
244+
<li>The option’s default value.</li>
240245
</ol>
241246

242247
<div class="alert alert-info">

‎docs/configuring_logging.html‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -153,11 +153,14 @@ <h5 class="sidebar-header level-1">Python API</h5>
153153
<li class="sidebar-item level-1">
154154
<a href="/docs/api_examples.html" class="sidebar-link ">Python API examples</a>
155155
</li>
156+
<li class="sidebar-item level-1">
157+
<a href="/docs/api/using_session_options.html" class="sidebar-link ">Using session options</a>
158+
</li>
156159
</ul>
157160
<h5 class="sidebar-header level-1">Developers</h5>
158161
<ul class="list-unstyled level-1">
159162
<li class="sidebar-item level-1">
160-
<a href="/docs/developers_guide.html" class="sidebar-link ">Developers' guide</a>
163+
<a href="/docs/developers_guide.html" class="sidebar-link ">Developers’ guide</a>
161164
</li>
162165
<li class="sidebar-item level-1">
163166
<a href="/docs/adding_new_targets.html" class="sidebar-link ">Adding a new built-in target</a>
@@ -173,6 +176,9 @@ <h5 class="sidebar-header level-1">Developers</h5>
173176
<li class="sidebar-item level-2">
174177
<a href="/docs/architecture.html" class="sidebar-link ">Architecture</a>
175178
</li>
179+
<li class="sidebar-item level-2">
180+
<a href="/docs/developer/board_ids.html" class="sidebar-link ">Board IDs</a>
181+
</li>
176182
<li class="sidebar-item level-2">
177183
<a href="/docs/remote_probe_protocol.html" class="sidebar-link ">Remote probe protocol</a>
178184
</li>

0 commit comments

Comments
 (0)