# pyOCD **Repository Path**: wanggjghost/pyOCD ## Basic Information - **Project Name**: pyOCD - **Description**: No description available - **Primary Language**: Unknown - **License**: Apache-2.0 - **Default Branch**: main - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 1 - **Forks**: 0 - **Created**: 2021-12-03 - **Last Updated**: 2023-01-15 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README pyOCD ===== [\[pyocd.io\]](https://pyocd.io/) [\[Docs\]](https://pyocd.io/docs) [\[Slack\]](https://join.slack.com/t/pyocd/shared_invite/zt-wmy3zvg5-nRLj1GBWYh708TVfIx9Llg) [\[Mailing list\]](https://groups.google.com/g/pyocd)
### News - pyOCD has several new community resources: the [pyocd.io](https://pyocd.io/) website, a [Slack workspace](https://join.slack.com/t/pyocd/shared_invite/zt-zqjv6zr5-ZfGAXl_mFCGGmFlB_8riHA), and a [mailing list](https://groups.google.com/g/pyocd) for announcements. - Branch configuration changes: the default branch `master` has been renamed to `main`, and a `develop` branch has been added to be used for active development. New pull requests should generally target `develop`. See [this discussion](https://github.com/pyocd/pyOCD/discussions/1169) for more information about this change. See the [wiki news page](https://github.com/pyocd/pyOCD/wiki/News) for all recent news.
pyOCD is an open source Python package for programming and debugging Arm Cortex-M microcontrollers using multiple supported types of USB debug probes. It is fully cross-platform, with support for Linux, macOS, Windows, and FreeBSD. A command line tool is provided that covers most use cases, or you can make use of the Python API to enable low-level target control. A common use for the Python API is to run and control CI tests. Support for more than 70 popular MCUs is built-in. In addition, through the use of CMSIS Device Family Packs, [nearly every Cortex-M device](https://www.keil.com/dd2/pack/) on the market is supported. The `pyocd` command line tool gives you total control over your device with these subcommands: - `gdbserver`: GDB remote server allows you to debug using gdb via either the console or [several GUI debugger options](#recommended-gdb-and-ide-setup). - `load`: Program files of various formats into flash or RAM. - `erase`: Erase part or all of an MCU's flash memory. - `pack`: Manage [CMSIS Device Family Packs](http://arm-software.github.io/CMSIS_5/Pack/html/index.html) that provide additional target device support. - `commander`: Interactive REPL control and inspection of the MCU. - `server`: Share a debug probe with a TCP/IP server. - `reset`: Hardware or software reset of a device. - `list`: Show connected devices. The API and tools provide these features: - halt, step, resume control - read/write memory - read/write core registers - set/remove hardware and software breakpoints - set/remove watchpoints - write to flash memory - load binary, hex, or ELF files into flash - reset control - access CoreSight DP and APs - SWO and SWV - and more! Configuration and customization is supported through [config files](docs/configuration.md), [user scripts](docs/user_scripts.md), and the Python API. Requirements ------------ - Python 3.6.0 or later.† - macOS, Linux, Windows 7 or newer, or FreeBSD - A recent version of [libusb](https://libusb.info/). See [libusb installation](#libusb-installation) for details. - Microcontroller with an Arm Cortex-M CPU - Supported debug probe - [CMSIS-DAP](http://www.keil.com/pack/doc/CMSIS/DAP/html/index.html) v1 (HID) or v2 (WinUSB), including: - Atmel EDBG/nEDBG - Atmel-ICE - Cypress KitProg3 or MiniProg4 - [DAPLink](https://github.com/ARMmbed/DAPLink) based debug probe, either on-board or standalone - Keil ULINKplus - NXP LPC-LinkII - NXP MCU-Link - [PE Micro](https://pemicro.com/) Cyclone and Multilink - Raspberry Pi Picoprobe - SEGGER J-Link - STLinkV2 or STLinkV3, either on-board or the standalone versions † Version [0.29](https://github.com/pyocd/pyOCD/releases/tag/v0.29.0) is the last version to support Python 2. Status ------ PyOCD is beta quality. The Python API is considered stable for version 0.x, but will be changed in version 1.0. Documentation ------------- The pyOCD documentation is available on the [pyocd.io website](https://pyocd.io/docs). In addition to user guides, you can generate reference documentation using Doxygen with the supplied [config file](docs/Doxyfile). Installing ---------- **The full installation guide is available [in the documentation](https://pyocd.io/docs/installing).** For notes about installing and using on non-x86 systems such as Raspberry Pi, see the [relevant documentation](https://pyocd.io/docs/installing-on-non-x86). The latest stable version of pyOCD may be installed via [pip](https://pip.pypa.io/en/stable/index.html) as follows: ``` $ python3 -mpip install -U pyocd ``` _Note: depending on your system, you may need to use `python` instead of `python3`._ The latest pyOCD package is available [on PyPI](https://pypi.python.org/pypi/pyOCD/) as well as [on GitHub](https://github.com/pyocd/pyOCD/releases). To install the latest prerelease version from the HEAD of the `develop` branch, you can do the following: ``` $ python3 -mpip install --pre -U git+https://github.com/pyocd/pyOCD.git@develop ``` You can also install directly from the source by cloning the git repository and running: ``` $ python3 pip install . ``` Note that, depending on your operating system, you may run into permissions issues running these commands. You have a few options here: 1. Under Linux, run with `sudo -H` to install pyOCD and dependencies globally. On macOS, installing with sudo should never be required, although sometimes permissions can become modified such that installing without using sudo fails. 3. Specify the `--user` option to install local to your user account. 4. Run the command in a [virtualenv](https://virtualenv.pypa.io/en/latest/) local to a specific project working set. ### libusb installation [pyusb](https://github.com/pyusb/pyusb) and its backend library [libusb](https://libusb.info/) are dependencies on all supported operating systems. pyusb is a regular Python package and will be installed along with pyOCD. However, libusb is a binary shared library that does not get installed automatically via pip dependency management. How to install libusb depends on your OS: - macOS: use Homebrew: `brew install libusb` - Linux and BSD: should already be installed. - Windows: download libusb from [libusb.info](https://libusb.info/) and place the .dll file in your Python installation folder next to python.exe. Make sure to use the same 32- or 64-bit architecture as your Python installation. The latest release is [available on GitHub](https://github.com/libusb/libusb/releases); download the .7z archive under Assets. Use the library from the VS2019 folder in the archive. ### udev rules on Linux On Linux, particularly Ubuntu 16.04+, you must configure udev rules to allow pyOCD to access debug probes from user space. Otherwise you will need to run pyOCD as root, using sudo, which is very highly discouraged. (You should _never_ run pyOCD as root on any OS.) To help with this, example udev rules files are included with pyOCD in the [udev](https://github.com/pyocd/pyOCD/tree/main/udev) folder. The [readme](https://github.com/pyocd/pyOCD/tree/main/udev/README.md) in this folder has detailed instructions. ### Target support See the [target support documentation](https://pyocd.io/docs/target-support) for information on how to check if the MCU(s) you are using have built-in support, and how to install support for additional MCUs via CMSIS-Packs. Using GDB --------- See the [GDB setup](https://pyocd.io/docs/gdb-setup) documentation for a guide for setting up and using pyocd with gdb and IDEs. Community resources ------------------- Join the pyOCD community! [pyocd.io website](https://pyocd.io) \ [Documentation](https://pyocd.io/docs) \ [Issues](https://github.com/pyocd/pyOCD/issues) \ [Discussions](https://github.com/pyocd/pyOCD/discussions) \ [Wiki](https://github.com/pyocd/pyOCD/wiki) \ [Mailing list](https://groups.google.com/g/pyocd) for announcements In order to foster a healthy and safe environment, we expect contributors and all members of the community to follow our [Code of Conduct](https://github.com/pyocd/pyOCD/tree/main/CODE_OF_CONDUCT.md). Contributions ------------- We welcome contributions in any area, even if you just create an issue. If you would like to get involved but aren't sure what to start with, just ask on [Slack](https://join.slack.com/t/pyocd/shared_invite/zt-zqjv6zr5-ZfGAXl_mFCGGmFlB_8riHA) or [GitHub discussions](https://github.com/pyocd/pyOCD/discussions) and we'll be happy to help you. Or you can look for an open issue. Any work on major changes should be discussed with the maintainers to make everyone is aligned. Please see the [contribution guidelines](https://github.com/pyocd/pyOCD/tree/main/CONTRIBUTING.md) for detailed requirements. The [developers' Guide](https://pyocd.io/docs/developers-guide) has instructions on how to set up a development environment for pyOCD. New pull requests should be [created](https://github.com/pyocd/pyOCD/pull/new/develop) against the `develop` branch. License ------- PyOCD is licensed with the permissive Apache 2.0 license. See the [LICENSE](https://github.com/pyocd/pyOCD/tree/main/LICENSE) file for the full text of the license. All documentation and the website are licensed with [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/). Copyright © 2006-2021 PyOCD Authors