Support Python3 + cleanups and fixes

.github/workflows/lint.yaml

@@ -0,0 +1,48 @@
+name: Lint
+
+on:
+  - push
+  - pull_request
+
+defaults:
+    run:
+        shell: bash
+
+jobs:
+    ruff:
+        strategy:
+            matrix:
+                os:
+                    - ubuntu-latest
+                python-version:
+                    - "3.14"
+        runs-on: ${{ matrix.os }}
+        steps:
+          - uses: actions/checkout@v4
+          - uses: actions/setup-python@v5
+            with:
+                python-version: ${{ matrix.python-version }}
+          - name: Install ruff
+            run: pip install ruff
+          - name: Run ruff format check
+            run: ruff format --check src/stm32loader
+          - name: Run ruff lint check
+            run: ruff check src/stm32loader
+    pylint:
+        strategy:
+            fail-fast: true
+            matrix:
+                os:
+                    - ubuntu-latest
+                python-version:
+                    - "3.14"
+        runs-on: ${{ matrix.os }}
+        steps:
+            - uses: actions/checkout@v4
+            - uses: actions/setup-python@v5
+              with:
+                  python-version: ${{ matrix.python-version }}
+            - name: Install lint dependencies
+              run: pip install pylint pyserial intelhex
+            - name: Run pylint
+              run: pylint src/stm32loader

.github/workflows/test.yaml

@@ -0,0 +1,38 @@
+name: Test
+
+on:
+    - push
+    - pull_request
+
+defaults:
+    run:
+        shell: bash
+
+jobs:
+    pytest:
+        strategy:
+            fail-fast: true
+            matrix:
+                os:
+                    - ubuntu-latest
+                    - windows-latest
+                python-version:
+                    - "3.9"
+                    - "3.10"
+                    - "3.11"
+                    - "3.12"
+                    - "3.13"
+                    - "3.14"
+                    - "pypy-3.9"
+                    - "pypy-3.10"
+                    - "pypy-3.11"
+        runs-on: ${{ matrix.os }}
+        steps:
+            - uses: actions/checkout@v2
+            - uses: actions/setup-python@v2
+              with:
+                  python-version: ${{ matrix.python-version }}
+            - name: Install test dependencies
+              run: pip install tox tox-gh-actions pyserial pytest intelhex
+            - name: Run setup and tests as defined in tox.ini
+              run: tox

.gitignore

@@ -0,0 +1,10 @@
+build/
+dist/
+*.egg-info/
+.tox/
+.venv
+
+__pycache__/
+*.py[cod]
+.nox/
+uv.lock

.pylintrc

@@ -0,0 +1,16 @@
+[FORMAT]
+max-line-length=98
+
+[MESSAGES CONTROL]
+disable=
+    fixme,                    # TO DOs are not errors.
+    consider-using-f-string,  # We're not on Python >= 3.6 yet.
+
+[REPORT]
+score=no
+
+[BASIC]
+good-names=
+    i,
+    e,
+    namespace,

.python-version

@@ -0,0 +1 @@
+3.14

.travis.yml

@@ -0,0 +1,32 @@
+language: python
+
+matrix:
+  include:
+    # Lint using nox on native Python 3.6
+    - python: "3.6"
+      env: NOXSESSION="lint"
+
+    # Test using nox on native Python 3.5/3.6/3.7/3.8
+    - python: "3.5"
+      env: NOXSESSION="tests-3.5"
+    - python: "3.6"
+      env: NOXSESSION="tests-3.6"
+    - python: "3.7"
+      env: NOXSESSION="tests-3.7"
+      dist: xenial  # necessary for Python 3.7
+      sudo: required  # necessary for Python 3.7
+    - python: "3.8"
+      env: NOXSESSION="tests-3.8"
+      dist: xenial  # necessary for Python 3.8
+      sudo: required  # necessary for Python 3.8?
+
+    # Test using nox on non-native Python version 3.6
+    # (nox does not natively run on 3.4)
+    - python: "3.6"
+      env: NOXSESSION="tests-3.4"
+
+install:
+  - pip install --upgrade pip setuptools nox pyserial progress
+  - pip install .
+
+script: nox --session "$NOXSESSION"

README.md

@@ -0,0 +1,192 @@
+# STM32Loader
+
+[![PyPI package](https://badge.fury.io/py/stm32loader.svg)](https://badge.fury.io/py/stm32loader)
+[![Test](https://github.com/florisla/stm32loader/actions/workflows/test.yaml/badge.svg)](https://github.com/florisla/stm32loader/actions/workflows/test.yaml)
+[![Lint](https://github.com/florisla/stm32loader/actions/workflows/lint.yaml/badge.svg)](https://github.com/florisla/stm32loader/actions/workflows/lint.yaml)
+[![License](https://img.shields.io/pypi/l/stm32loader.svg)](https://pypi.org/project/stm32loader/)
+[![Downloads](https://pepy.tech/badge/stm32loader)](https://pepy.tech/project/stm32loader)
+
+Python module to upload or download firmware to / from
+ST Microelectronics STM32 microcontrollers over UART.
+
+Also supports ST BlueNRG devices, and the SweetPeas bootloader
+for Wiznet W7500.
+
+Compatible with Python version 3.9-3.14 and PyPy 3.10-3.11.
+
+
+## Run using `uvx`
+
+    uvx stm32loader
+
+
+## Installation with pip
+
+    pip install stm32loader
+
+To install the latest development version:
+
+    pip install git+https://github.com/florisla/stm32loader.git
+
+
+## Usage
+
+<!-- [[[cog
+import sys
+from io import StringIO
+import cog
+from stm32loader.main import main
+
+sys.stdout = StringIO()
+
+main("--help", avoid_system_exit=True)
+
+cog.out(f"```\n{sys.stdout.getvalue()}```")
+
+sys.stdout.close()
+sys.stdout = sys.__stdout__
+]]] -->
+```
+usage: stm32loader [-h] [-e] [-u] [-x] [-w] [-v] [-r] [-l LENGTH] -p PORT [-b BAUD] [-a ADDRESS] [-g ADDRESS] [-f FAMILY] [-V] [-q] [-s] [-R] [-B] [-n] [-P {even,none}] [--version] [FILE.BIN]
+
+Flash firmware to STM32 microcontrollers.
+
+positional arguments:
+  FILE.BIN              File to read from or store to flash.
+
+options:
+  -h, --help            show this help message and exit
+  -e, --erase           Erase the full flash memory or a specific region (support --address and --length). Note: this is required on previously written memory.
+  -u, --unprotect       Unprotect flash from readout.
+  -x, --protect         Protect flash against readout.
+  -w, --write           Write file content to flash.
+  -v, --verify          Verify flash content versus local file (recommended).
+  -r, --read            Read from flash and store in local file.
+  -l, --length LENGTH   Length of read or erase.
+  -p, --port PORT       Serial port (default: $STM32LOADER_SERIAL_PORT).
+  -b, --baud BAUD       Baudrate. (default: 115200)
+  -a, --address ADDRESS
+                        Target address for read or write. For erase, this is used when you supply --length. (default: 134217728)
+  -g, --go-address ADDRESS
+                        Start executing from address (0x08000000, usually).
+  -f, --family FAMILY   Device family to read out device UID and flash size; e.g F1 for STM32F1xx. Possible values: F0, F1, F3, F4, F7, H7, L4, L0, G0, G4, NRG. (default: $STM32LOADER_FAMILY).
+  -V, --verbose         Verbose mode.
+  -q, --quiet           Quiet mode.
+  -s, --swap-rts-dtr    Swap RTS and DTR: use RTS for reset and DTR for boot0.
+  -R, --reset-active-high
+                        Make RESET active high.
+  -B, --boot0-active-low
+                        Make BOOT0 active low.
+  -n, --no-progress     Don't show progress bar.
+  -P, --parity {even,none}
+                        Parity: "even" for STM32, "none" for BlueNRG. (default: even)
+  --version             show program's version number and exit
+
+examples:
+  stm32loader --port COM7 --family F1
+  stm32loader --erase --write --verify example/main.bin
+```
+<!-- [[[end]]] -->
+
+## Command-line example
+
+```
+stm32loader --port /dev/tty.usbserial-ftCYPMYJ --erase --write --verify somefile.bin
+```
+
+This will pre-erase flash, write `somefile.bin` to the flash on the device, and then
+perform a verification after writing is finished.
+
+You can skip the `--port` option by configuring environment variable
+`STM32LOADER_SERIAL_PORT`.
+Similarly, `--family` may be supplied through `STM32LOADER_FAMILY`.
+
+To read out firmware and store it in a file:
+
+```
+stm32loader --read --port /dev/cu.usbserial-A5XK3RJT --family F1 --length 0x10000 --address 0x08000000 dump.bin 
+```
+
+
+To erase the full device:
+
+```
+stm32loader --erase --port /dev/cu.usbserial-A5XK3RJT
+```
+
+Or erase only a specific region of the flash:
+
+```
+stm32loader --erase --address 0x08000000 --length 0x2000 --port /dev/cu.usbserial-A5XK3RJT
+```
+
+
+
+## Reference documents
+
+* ST `AN2606`: STM32 microcontroller system memory boot mode
+* ST `AN3155`: USART protocol used in the STM32 bootloader
+* ST `AN4872`: BlueNRG-1 and BlueNRG-2 UART bootloader protocol
+
+
+## Acknowledgement
+
+Original Version by Ivan A-R (tuxotronic.org).
+Contributions by Domen Puncer, James Snyder, Floris Lambrechts,
+Atokulus, sam-bristow, NINI1988, Omer Kilic, Szymon Szantula, rdaforno,
+Mikolaj Stawiski, Tyler Coy, Alex Klimaj, Ondrej Mikle, denniszollo,
+emilzay, michsens, blueskull, Mattia Maldini, etrommer, jadeaffenjaeger,
+tosmaz.
+
+Inspiration for features from:
+
+* Configurable RTS/DTR and polarity, extended erase with pages:
+  https://github.com/pazzarpj/stm32loader
+
+* Memory unprotect
+  https://github.com/3drobotics/stm32loader
+
+* Correct checksum calculation for paged erase:
+  https://github.com/jsnyder/stm32loader/pull/4
+
+* ST BlueNRG chip support
+  https://github.com/lchish/stm32loader
+
+* Wiznet W7500 chip / SweetPeas custom bootloader support
+  https://github.com/Sweet-Peas/WiznetLoader
+
+
+## Alternatives
+
+If you don't need the flexibility of a Python tool, you can take
+a look at other similar tools in `ALTERNATIVES.md`.
+
+
+## Electrically
+
+The below assumes you are connecting an STM32F10x.
+For other chips, the serial pins and/or the BOOT0 / BOOT1 values
+may differ.
+
+Make the following connections:
+
+- Serial adapter `GND` to MCU `GND`.
+- Serial adapter power to MCU power or vice versa (either 3.3 or 5 Volt).
+- Note if you're using 5 Volt signaling or 3V3 on the serial adapter.
+- Serial `TX` to MCU `RX` (`PA10`).
+- Serial `RX` to MCU `TX` (`PA9`).
+- Serial `DTR` to MCU `RESET`.
+- Serial `RTS` to MCU `BOOT0` (or `BOOT0` to 3.3V).
+- MCU `BOOT1` to `GND`.
+
+If either `RTS` or `DTR` are not available on your serial adapter, you'll have to
+manually push buttons or work with jumpers.
+When given a choice, set `BOOT0` manually high and drive `RESET` through the serial
+adapter (it needs to toggle, whereas `BOOT0` does not).
+
+
+## Not currently supported
+
+* Command-line argument for write protection for some devices (e.g. those with dual-bank flash).
+* STM8 devices (ST `UM0560`).
+* Other bootloader protocols (e.g. I2C, HEX -> implemented in `stm32flash`).