|
| 1 | +<!DOCTYPE html> |
| 2 | +<html lang="en" dir="ltr"> |
| 3 | + <head> |
| 4 | + <meta charset="utf-8"> |
| 5 | + <meta name="viewport" content="width=device-width, initial-scale=1.0"> |
| 6 | + |
| 7 | +<!-- |
| 8 | + <link rel="icon" type="image/png" href="/assets/images/favicon.png" /> |
| 9 | + --> |
| 10 | + |
| 11 | + <link rel="preconnect" href="https://fonts.googleapis.com"> |
| 12 | + <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin> |
| 13 | + |
| 14 | + <link href="https://fonts.googleapis.com/css2?family=Sarabun:ital,wght@0,100;0,200;0,300;0,400;0,500;0,600;0,700;0,800;1,100;1,200;1,300;1,400;1,500;1,600;1,700;1,800&display=swap" rel="stylesheet"> |
| 15 | + <link href="https://fonts.googleapis.com/css2?family=Roboto+Mono:ital,wght@0,100;0,200;0,300;0,400;0,500;0,600;0,700;1,100;1,200;1,300;1,400;1,500;1,600;1,700&display=swap" rel="stylesheet"> |
| 16 | + <link href="https://fonts.googleapis.com/css2?family=Nunito+Sans:ital,wght@0,200;0,300;0,400;0,600;0,700;0,800;0,900;1,200;1,300;1,400;1,600;1,700;1,800;1,900&display=swap" rel="stylesheet"> |
| 17 | + |
| 18 | + <link rel=" stylesheet" href=" https://cdn.jsdelivr.net/npm/[email protected]/font/bootstrap-icons.css" > |
| 19 | + |
| 20 | + <link href=" https://cdn.jsdelivr.net/npm/[email protected]/dist/css/bootstrap.min.css" rel=" stylesheet" integrity=" sha384-F3w7mX95PdgyTmZZMECAngseQB83DfGTowi0iMjiWaeVhAn4FJkqJByhZMI3AhiU" crossorigin=" anonymous" > |
| 21 | + |
| 22 | + <link rel="stylesheet" href="/assets/styles/main.css"> |
| 23 | + |
| 24 | + <title>About — pyOCD</title> |
| 25 | + |
| 26 | + <!-- Global site tag (gtag.js) - Google Analytics --> |
| 27 | + <script async src="https://www.googletagmanager.com/gtag/js?id=G-2RKCB4KZ7S"></script> |
| 28 | + <script> |
| 29 | + window.dataLayer = window.dataLayer || []; |
| 30 | + function gtag(){dataLayer.push(arguments);} |
| 31 | + gtag('js', new Date()); |
| 32 | + |
| 33 | + gtag('config', 'G-2RKCB4KZ7S'); |
| 34 | + </script> |
| 35 | +</head> |
| 36 | + |
| 37 | + <body id="top"> |
| 38 | + <div class="full-view-height d-flex flex-column"> |
| 39 | + <div class="flex-shrink-0"> |
| 40 | + <nav class="navbar navbar-expand-md navbar-dark p-0"> |
| 41 | + <div class="container-fluid"> |
| 42 | + <a class="navbar-brand" href="/"> |
| 43 | + <img src="/assets/pyocd_logo_white.svg" height="42" width="auto" alt=""></img> |
| 44 | + </a> |
| 45 | + <a class="navbar-brand color-secondary" href="/"> |
| 46 | + <span class="display-lg project-name">pyOCD</span> |
| 47 | + </a> |
| 48 | + |
| 49 | + <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbarCollapse" aria-controls="navbarCollapse" aria-expanded="false" aria-label="Toggle navigation"> |
| 50 | + <span class="navbar-toggler-icon"></span> |
| 51 | + </button> |
| 52 | + |
| 53 | + <div class="collapse navbar-collapse justify-content-end" id="navbarCollapse"> |
| 54 | + <ul class="navbar-nav"> |
| 55 | + |
| 56 | + |
| 57 | + <li class="nav-item mr-auto mx-1"> |
| 58 | + <a class="nav-link" href="/docs/">Documentation</a> |
| 59 | + </li> |
| 60 | + |
| 61 | + <li class="nav-item mr-auto mx-1"> |
| 62 | + <a class="nav-link" href="/posts/">Posts</a> |
| 63 | + </li> |
| 64 | + |
| 65 | + <li class="nav-item mr-auto mx-1"> |
| 66 | + <a class="nav-link" href="https://github.com/pyocd/pyOCD"><i class="bi bi-github"></i></a> |
| 67 | + </li> |
| 68 | + |
| 69 | + </ul> |
| 70 | + </div> |
| 71 | + </div> |
| 72 | +</nav> |
| 73 | + |
| 74 | + </div> |
| 75 | + <div class="container flex-grow-1"> |
| 76 | + <div class="row"> |
| 77 | + <main role="main" class="content-scroll p-3 p-md-4"> |
| 78 | + <p>pyOCD is an open source Python package for programming and debugging Arm Cortex-M microcontrollers |
| 79 | +using multiple supported types of USB debug probes. It is fully cross-platform, with support for |
| 80 | +Linux, macOS, and Windows.</p> |
| 81 | + |
| 82 | +<p>A command line tool is provided that covers most use cases, or you can make use of the Python |
| 83 | +API to enable low-level target control. A common use for the Python API is to run and control CI |
| 84 | +tests.</p> |
| 85 | + |
| 86 | +<p>Upwards of 70 popular MCUs are supported built-in. In addition, through the use of CMSIS-Packs, |
| 87 | +nearly every Cortex-M device on the market is supported.</p> |
| 88 | + |
| 89 | +<p>The <code class="highlighter-rouge">pyocd</code> command line tool gives you total control over your device with these subcommands:</p> |
| 90 | + |
| 91 | +<ul> |
| 92 | + <li><code class="highlighter-rouge">gdbserver</code>: GDB remote server allows you to debug using gdb via either |
| 93 | + <a href="https://gnu-mcu-eclipse.github.io/">GNU MCU Eclipse plug-in</a> or the console.</li> |
| 94 | + <li><code class="highlighter-rouge">flash</code>: Program files of various formats into flash memory.</li> |
| 95 | + <li><code class="highlighter-rouge">erase</code>: Erase part or all of an MCU’s flash memory.</li> |
| 96 | + <li><code class="highlighter-rouge">pack</code>: Manage <a href="http://arm-software.github.io/CMSIS_5/Pack/html/index.html">CMSIS Device Family Packs</a> |
| 97 | + that provide additional target device support.</li> |
| 98 | + <li><code class="highlighter-rouge">commander</code>: Interactive REPL control and inspection of the MCU.</li> |
| 99 | + <li><code class="highlighter-rouge">list</code>: Show connected devices.</li> |
| 100 | +</ul> |
| 101 | + |
| 102 | +<p>The API and tools provide these features:</p> |
| 103 | + |
| 104 | +<ul> |
| 105 | + <li>halt, step, resume control</li> |
| 106 | + <li>read/write memory</li> |
| 107 | + <li>read/write core registers</li> |
| 108 | + <li>set/remove hardware and software breakpoints</li> |
| 109 | + <li>set/remove watchpoints</li> |
| 110 | + <li>write to flash memory</li> |
| 111 | + <li>load binary, hex, or ELF files into flash</li> |
| 112 | + <li>reset control</li> |
| 113 | + <li>access CoreSight DP and APs</li> |
| 114 | + <li>SWO and SWV</li> |
| 115 | + <li>and more!</li> |
| 116 | +</ul> |
| 117 | + |
| 118 | +<p>Configuration and customization is supported through <a href="docs/configuration.md">config files</a> and |
| 119 | +<a href="docs/user_scripts.md">user scripts</a>.</p> |
| 120 | + |
| 121 | + |
| 122 | + </main> |
| 123 | + </div> |
| 124 | + </div> |
| 125 | + |
| 126 | + <div class="flex-shrink-0"> |
| 127 | + <footer class="pyocd-footer p-0 mt-3"> |
| 128 | + <div class="row row-cols-1 row-cols-sm-2 row-cols-md-4 pt-4"> |
| 129 | + <div class="col-3"> |
| 130 | + <p class="small"> |
| 131 | + Copyright © 2021 PyOCD Authors. |
| 132 | + </p> |
| 133 | + <p class="small"> |
| 134 | + Site and docs are <a href="https://creativecommons.org/licenses/by/4.0/">CC BY 4.0</a>.<br/> |
| 135 | + Project code is <a href="https://www.apache.org/licenses/LICENSE-2.0">Apache 2.0</a>. |
| 136 | + </p> |
| 137 | + </div> |
| 138 | + <div class="col-3"> <!-- mt-3 mb-3 mx-4 --> |
| 139 | + <h5>Links</h5> |
| 140 | + <ul class="list-unstyled"> |
| 141 | + <li> |
| 142 | + <a href="/docs/">Documentation</a> |
| 143 | + </li> |
| 144 | + <li> |
| 145 | + <a href="/posts/">Posts</a> |
| 146 | + </li> |
| 147 | + <li> |
| 148 | + <a href="https://github.com/pyocd/pyOCD/blob/main/CONTRIBUTING.md">Contributing</a> |
| 149 | + </li> |
| 150 | + <li> |
| 151 | + <a href="https://github.com/pyocd/.github/blob/main/CODE_OF_CONDUCT.md">Code of Conduct</a> |
| 152 | + </li> |
| 153 | + <li> |
| 154 | + <a href="https://github.com/pyocd/">GitHub</a> |
| 155 | + </li> |
| 156 | + </ul> |
| 157 | + </div> |
| 158 | + <div class="col-3"> |
| 159 | + <h5>Projects</h5> |
| 160 | + <ul class="list-unstyled"> |
| 161 | + <li> |
| 162 | + <a href="https://github.com/pyocd/pyOCD">pyOCD</a> |
| 163 | + </li> |
| 164 | + <li> |
| 165 | + <a href="https://github.com/pyocd/cmsis-pack-manager">cmsis-pack-manager</a> |
| 166 | + </li> |
| 167 | + <li> |
| 168 | + <a href="https://github.com/pyocd/FlashAlgo">FlashAlgo</a> |
| 169 | + </li> |
| 170 | + </ul> |
| 171 | + </div> |
| 172 | + <div class="col-3"> |
| 173 | + <h5>Community</h5> |
| 174 | + <ul class="list-unstyled"> |
| 175 | + <li> |
| 176 | + <a href="https://github.com/pyocd/pyOCD/issues">Issues</a> |
| 177 | + </li> |
| 178 | + <li> |
| 179 | + <a href="https://github.com/pyocd/pyOCD/discussions">Discussions</a> |
| 180 | + </li> |
| 181 | + <li> |
| 182 | + <a href="https://join.slack.com/t/pyocd/shared_invite/zt-wmy3zvg5-nRLj1GBWYh708TVfIx9Llg">Slack</a> |
| 183 | + </li> |
| 184 | + <li> |
| 185 | + <a href="https://groups.google.com/g/pyocd">Mailing list</a> |
| 186 | + </li> |
| 187 | + </ul> |
| 188 | + </div> |
| 189 | + </div> |
| 190 | +</footer> |
| 191 | + |
| 192 | + </div> |
| 193 | + </div> |
| 194 | + <script src=" https://cdn.jsdelivr.net/npm/[email protected]/dist/js/bootstrap.bundle.min.js" integrity=" sha384-/bQdsTh/da6pkI1MST/rWKFNjaCP5gBSY4sEBT38Q/9RBh9AH40zEOg7Hlq2THRZ" crossorigin=" anonymous" ></script> |
| 195 | +<script src="/assets/javascript/jquery-3.6.0.slim.min.js"></script> |
| 196 | +<!-- |
| 197 | +<script type="text/javascript" src="/assets/javascript/index.js"></script> |
| 198 | + --> |
| 199 | + |
| 200 | + </body> |
| 201 | +</html> |
0 commit comments