PyCubeProgrammer_API

This is a Python wrapper for STM32 CubeProgrammer_API. It uses Cython, resulting in a .pyd python-DLL file that is imported by a user's Python program.

The STM32 CubeProgrammer_API is a C-library, created by ST for ST-Link access to micro-controllers for the purpose of flash downloads or general memory access. The CubeProgrammer is required, including its drivers, and can be downloaded from st.com and installed.

This has been tested on Windows and although CubeProgrammer is available for other OS's. The main focus so far is USB-to-SWD access.

Two examples are included:

• TestHotPlug.py - a console app that gracefully recovers from a hot-plug of either end of an ST-Link (USB end or the SWD end).
• runme.py - based loosely on C examples included in the CubeProgrammer_API.

Installation

copy CubeProgrammer_API.cp39-win_amd64.pyd locally. It's assumed that CubeProgrammer has been installed (C:/Program Files/STMicroelectronics/STM32Cube/STM32CubeProgrammer/api/lib/) and has all the necessary DLLs required by the CubeProgrammer_API .pyd file. See the top of the examples for code to reference the location of those DLLs.

Usage

In a Python application, reference the API's DLLs with a statement like...
os.add_dll_directory('C:/Program Files/STMicroelectronics/STM32Cube/STM32CubeProgrammer/api/lib/')
The os will, of course need an import os

Then import the .PYD extension like this... import CubeProgrammer_API The import needs to be done after the add_dll_directory().

This Cython/Python wrapper performs default initialization that the C-API omitted such as initialization of callbacks. This default initialization will prevent faults/exceptions that halt/crash the application without diagnostic information.

Development

• setup.py and run_setup.py are used to compile the Cython .pyx file to a .dll with the .pyd extension.
• CppExample is a Visual Studio project that uses the CubeProgrammer_API, used only to isolate C-vs-Python issues.
• CubeProgrammer_API.cpp is a temporary intermediate file used by Cython to generate the .pyd file.

Other similar projects:

• pyOCD
• PyStLink
• OpenOcd

Although there are several other libraries that provide debug interfaces to ARM micro-controllers, some with Python bindings, this PyCubeProgrammer_API is intended to leverage ST's support for driver installation and support for new chip variants.