pyflashgui 0.1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (105) hide show
  1. pyflashgui-0.1.0/LICENSE +202 -0
  2. pyflashgui-0.1.0/NOTICE +30 -0
  3. pyflashgui-0.1.0/PKG-INFO +80 -0
  4. pyflashgui-0.1.0/PYPI.md +40 -0
  5. pyflashgui-0.1.0/README.md +157 -0
  6. pyflashgui-0.1.0/pyflashgui/__init__.py +6 -0
  7. pyflashgui-0.1.0/pyflashgui/__main__.py +334 -0
  8. pyflashgui-0.1.0/pyflashgui/backends/__init__.py +40 -0
  9. pyflashgui-0.1.0/pyflashgui/backends/base.py +272 -0
  10. pyflashgui-0.1.0/pyflashgui/backends/jlink_backend.py +596 -0
  11. pyflashgui-0.1.0/pyflashgui/backends/pyocd_backend.py +271 -0
  12. pyflashgui-0.1.0/pyflashgui/backends/simulated.py +240 -0
  13. pyflashgui-0.1.0/pyflashgui/core/__init__.py +2 -0
  14. pyflashgui-0.1.0/pyflashgui/core/checkout.py +134 -0
  15. pyflashgui-0.1.0/pyflashgui/core/compare.py +157 -0
  16. pyflashgui-0.1.0/pyflashgui/core/context.py +37 -0
  17. pyflashgui-0.1.0/pyflashgui/core/events.py +71 -0
  18. pyflashgui-0.1.0/pyflashgui/core/excepthook.py +110 -0
  19. pyflashgui-0.1.0/pyflashgui/core/flasher.py +419 -0
  20. pyflashgui-0.1.0/pyflashgui/core/images.py +279 -0
  21. pyflashgui-0.1.0/pyflashgui/core/installation.py +137 -0
  22. pyflashgui-0.1.0/pyflashgui/core/layout.py +72 -0
  23. pyflashgui-0.1.0/pyflashgui/core/memory_map.py +234 -0
  24. pyflashgui-0.1.0/pyflashgui/core/packages.py +104 -0
  25. pyflashgui-0.1.0/pyflashgui/core/paths.py +49 -0
  26. pyflashgui-0.1.0/pyflashgui/core/settings.py +44 -0
  27. pyflashgui-0.1.0/pyflashgui/core/shortcut.py +154 -0
  28. pyflashgui-0.1.0/pyflashgui/core/slow_start.py +101 -0
  29. pyflashgui-0.1.0/pyflashgui/core/timing.py +312 -0
  30. pyflashgui-0.1.0/pyflashgui/core/updates.py +195 -0
  31. pyflashgui-0.1.0/pyflashgui/core/worker.py +71 -0
  32. pyflashgui-0.1.0/pyflashgui/core/workspaces.py +250 -0
  33. pyflashgui-0.1.0/pyflashgui/help/__init__.py +129 -0
  34. pyflashgui-0.1.0/pyflashgui/help/about.md +21 -0
  35. pyflashgui-0.1.0/pyflashgui/help/changelog.md +46 -0
  36. pyflashgui-0.1.0/pyflashgui/help/files.md +60 -0
  37. pyflashgui-0.1.0/pyflashgui/help/main-window.png +0 -0
  38. pyflashgui-0.1.0/pyflashgui/help/manual.md +44 -0
  39. pyflashgui-0.1.0/pyflashgui/help/memory-map.md +28 -0
  40. pyflashgui-0.1.0/pyflashgui/help/memory.md +59 -0
  41. pyflashgui-0.1.0/pyflashgui/help/probe.md +71 -0
  42. pyflashgui-0.1.0/pyflashgui/resources/__init__.py +10 -0
  43. pyflashgui-0.1.0/pyflashgui/resources/pyflashgui.ico +0 -0
  44. pyflashgui-0.1.0/pyflashgui/resources/pyflashgui.png +0 -0
  45. pyflashgui-0.1.0/pyflashgui/resources/pyflashgui.svg +32 -0
  46. pyflashgui-0.1.0/pyflashgui/resources/pyflashgui_small.svg +20 -0
  47. pyflashgui-0.1.0/pyflashgui/ui/__init__.py +2 -0
  48. pyflashgui-0.1.0/pyflashgui/ui/confirm.py +312 -0
  49. pyflashgui-0.1.0/pyflashgui/ui/detached.py +101 -0
  50. pyflashgui-0.1.0/pyflashgui/ui/erase_dialog.py +141 -0
  51. pyflashgui-0.1.0/pyflashgui/ui/event_colours.py +66 -0
  52. pyflashgui-0.1.0/pyflashgui/ui/files_view.py +716 -0
  53. pyflashgui-0.1.0/pyflashgui/ui/folders.py +176 -0
  54. pyflashgui-0.1.0/pyflashgui/ui/fonts.py +75 -0
  55. pyflashgui-0.1.0/pyflashgui/ui/help_menu.py +587 -0
  56. pyflashgui-0.1.0/pyflashgui/ui/main_window.py +754 -0
  57. pyflashgui-0.1.0/pyflashgui/ui/map_view.py +215 -0
  58. pyflashgui-0.1.0/pyflashgui/ui/memory_view.py +724 -0
  59. pyflashgui-0.1.0/pyflashgui/ui/messages.py +78 -0
  60. pyflashgui-0.1.0/pyflashgui/ui/pane_bar.py +92 -0
  61. pyflashgui-0.1.0/pyflashgui/ui/panes.py +1068 -0
  62. pyflashgui-0.1.0/pyflashgui/ui/persist.py +132 -0
  63. pyflashgui-0.1.0/pyflashgui/ui/probe_bar.py +315 -0
  64. pyflashgui-0.1.0/pyflashgui/ui/read_dialog.py +161 -0
  65. pyflashgui-0.1.0/pyflashgui/ui/session.py +53 -0
  66. pyflashgui-0.1.0/pyflashgui/ui/theme.py +85 -0
  67. pyflashgui-0.1.0/pyflashgui.egg-info/PKG-INFO +80 -0
  68. pyflashgui-0.1.0/pyflashgui.egg-info/SOURCES.txt +103 -0
  69. pyflashgui-0.1.0/pyflashgui.egg-info/dependency_links.txt +1 -0
  70. pyflashgui-0.1.0/pyflashgui.egg-info/entry_points.txt +2 -0
  71. pyflashgui-0.1.0/pyflashgui.egg-info/requires.txt +9 -0
  72. pyflashgui-0.1.0/pyflashgui.egg-info/top_level.txt +1 -0
  73. pyflashgui-0.1.0/pyproject.toml +112 -0
  74. pyflashgui-0.1.0/setup.cfg +4 -0
  75. pyflashgui-0.1.0/tests/test_backends.py +251 -0
  76. pyflashgui-0.1.0/tests/test_build_version.py +68 -0
  77. pyflashgui-0.1.0/tests/test_changelog.py +85 -0
  78. pyflashgui-0.1.0/tests/test_checkout.py +103 -0
  79. pyflashgui-0.1.0/tests/test_compare.py +358 -0
  80. pyflashgui-0.1.0/tests/test_erase.py +284 -0
  81. pyflashgui-0.1.0/tests/test_events.py +242 -0
  82. pyflashgui-0.1.0/tests/test_excepthook.py +128 -0
  83. pyflashgui-0.1.0/tests/test_flash_panes.py +462 -0
  84. pyflashgui-0.1.0/tests/test_flasher.py +296 -0
  85. pyflashgui-0.1.0/tests/test_folders.py +307 -0
  86. pyflashgui-0.1.0/tests/test_fonts.py +78 -0
  87. pyflashgui-0.1.0/tests/test_headers.py +88 -0
  88. pyflashgui-0.1.0/tests/test_help.py +624 -0
  89. pyflashgui-0.1.0/tests/test_icon.py +72 -0
  90. pyflashgui-0.1.0/tests/test_images.py +235 -0
  91. pyflashgui-0.1.0/tests/test_installation.py +107 -0
  92. pyflashgui-0.1.0/tests/test_jlink_backend.py +442 -0
  93. pyflashgui-0.1.0/tests/test_launcher.py +514 -0
  94. pyflashgui-0.1.0/tests/test_memory_map.py +156 -0
  95. pyflashgui-0.1.0/tests/test_messages.py +85 -0
  96. pyflashgui-0.1.0/tests/test_notice.py +115 -0
  97. pyflashgui-0.1.0/tests/test_packages.py +75 -0
  98. pyflashgui-0.1.0/tests/test_packaging.py +101 -0
  99. pyflashgui-0.1.0/tests/test_persist.py +108 -0
  100. pyflashgui-0.1.0/tests/test_read_back.py +867 -0
  101. pyflashgui-0.1.0/tests/test_readme.py +95 -0
  102. pyflashgui-0.1.0/tests/test_shortcut.py +108 -0
  103. pyflashgui-0.1.0/tests/test_slow_start.py +105 -0
  104. pyflashgui-0.1.0/tests/test_theme.py +146 -0
  105. pyflashgui-0.1.0/tests/test_workspaces.py +292 -0
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright [yyyy] [name of copyright owner]
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
@@ -0,0 +1,30 @@
1
+ pyflashgui
2
+ Copyright 2026 davhodg
3
+
4
+ Licensed under the Apache License, Version 2.0 (the "License"); you may not use
5
+ this file except in compliance with the License. You may obtain a copy of the
6
+ License in the LICENSE file, or at http://www.apache.org/licenses/LICENSE-2.0
7
+
8
+ This product includes software developed by third parties, each used unmodified
9
+ under its own licence and installed as a separate package:
10
+
11
+ PySide6-Essentials, shiboken6 LGPL-3.0 https://www.qt.io/qt-for-python
12
+ (Qt for Python; the GPL-only add-on modules are not installed at all)
13
+ pyOCD Apache-2.0 https://pyocd.io
14
+ libusb (through libusb-package) LGPL-2.1 https://libusb.info
15
+ bincopy MIT https://github.com/eerimoq/bincopy
16
+ Python PSF-2.0 https://www.python.org
17
+
18
+ The LGPL-licensed components are dynamically linked and separately replaceable;
19
+ their sources are available from the projects listed above. Only LGPL Qt
20
+ modules are used -- the GPL-only Qt modules (Qt Charts, Qt Data Visualization,
21
+ Qt Graphs, Qt Virtual Keyboard) are deliberately not used.
22
+
23
+ THIRD-PARTY-NOTICES.txt, generated when the application is built, lists every
24
+ package shipped with it, pyOCD's own dependencies included.
25
+
26
+ Debug probe drivers and vendor libraries (ST's ST-Link driver and others) are
27
+ not distributed with pyflashgui; pyOCD loads the vendor's own at run time.
28
+
29
+ Development note: pyflashgui is developed with the assistance of Anthropic's
30
+ Claude.
@@ -0,0 +1,80 @@
1
+ Metadata-Version: 2.4
2
+ Name: pyflashgui
3
+ Version: 0.1.0
4
+ Summary: Graphical flash programming tool: Arm Cortex-M with any probe pyOCD supports, and more through J-Link Commander
5
+ Author: davhodg
6
+ License-Expression: Apache-2.0
7
+ Project-URL: Homepage, https://github.com/davhodg/pyflashgui
8
+ Project-URL: Documentation, https://github.com/davhodg/pyflashgui/blob/master/pyflashgui/help/manual.md
9
+ Project-URL: Repository, https://github.com/davhodg/pyflashgui
10
+ Project-URL: Issues, https://github.com/davhodg/pyflashgui/issues
11
+ Project-URL: Discussions, https://github.com/davhodg/pyflashgui/discussions
12
+ Project-URL: Releases, https://github.com/davhodg/pyflashgui/releases
13
+ Project-URL: Changelog, https://github.com/davhodg/pyflashgui/blob/master/pyflashgui/help/changelog.md
14
+ Keywords: flash,programmer,debug probe,SWD,CMSIS-DAP,ST-Link,J-Link,pyOCD,Cortex-M,microcontroller,embedded,firmware,Intel HEX,S-record,ELF,Qt
15
+ Classifier: Development Status :: 3 - Alpha
16
+ Classifier: Intended Audience :: Developers
17
+ Classifier: Natural Language :: English
18
+ Classifier: Operating System :: Microsoft :: Windows
19
+ Classifier: Operating System :: POSIX :: Linux
20
+ Classifier: Programming Language :: Python :: 3
21
+ Classifier: Programming Language :: Python :: 3 :: Only
22
+ Classifier: Programming Language :: Python :: 3.12
23
+ Classifier: Programming Language :: Python :: 3.13
24
+ Classifier: Programming Language :: Python :: 3.14
25
+ Classifier: Topic :: Software Development :: Embedded Systems
26
+ Classifier: Topic :: System :: Hardware
27
+ Requires-Python: >=3.12
28
+ Description-Content-Type: text/markdown
29
+ License-File: LICENSE
30
+ License-File: NOTICE
31
+ Requires-Dist: PySide6-Essentials>=6.8
32
+ Requires-Dist: pyocd>=0.45
33
+ Requires-Dist: bincopy>=20.0
34
+ Provides-Extra: dev
35
+ Requires-Dist: pytest; extra == "dev"
36
+ Requires-Dist: pytest-xdist; extra == "dev"
37
+ Requires-Dist: ruff==0.16.*; extra == "dev"
38
+ Requires-Dist: trove-classifiers; extra == "dev"
39
+ Dynamic: license-file
40
+
41
+ <p align="center">
42
+ <img src="https://raw.githubusercontent.com/davhodg/pyflashgui/master/pyflashgui/resources/pyflashgui.png" alt="pyflashgui icon: a chip with pins on every side and a flash across it" width="128">
43
+ </p>
44
+
45
+ # pyflashgui
46
+
47
+ [![CI](https://github.com/davhodg/pyflashgui/actions/workflows/ci.yml/badge.svg)](https://github.com/davhodg/pyflashgui/actions/workflows/ci.yml)
48
+ [![release](https://img.shields.io/github/v/release/davhodg/pyflashgui?include_prereleases)](https://github.com/davhodg/pyflashgui/releases)
49
+ [![PyPI](https://img.shields.io/pypi/v/pyflashgui)](https://pypi.org/project/pyflashgui/)
50
+ ![python](https://img.shields.io/badge/python-3.12+-blue)
51
+ ![platform](https://img.shields.io/badge/platform-Windows%20%7C%20Linux-lightgrey)
52
+ ![license](https://img.shields.io/badge/license-Apache--2.0-green)
53
+
54
+ A graphical flash programming tool. It works with any debug probe [pyOCD](https://pyocd.io) supports, for Arm Cortex-M targets: CMSIS-DAP probes such as the Raspberry Pi Debug Probe, DAPLink, NXP MCU-Link and Atmel-ICE, TI XDS110 and the probes built into many development boards, as well as ST-Link and J-Link. With a J-Link it can also use SEGGER's J-Link Commander, for the many other devices that supports.
55
+
56
+ ![pyflashgui on its simulated probe: the Files pane with a firmware file and a read, the memory map under them, the bytes of the read beside them, and the Event Log below](https://raw.githubusercontent.com/davhodg/pyflashgui/master/pyflashgui/help/main-window.png)
57
+
58
+ **It is a tool for the bench**: for development, debugging and hobby use. It is not meant for production programming.
59
+
60
+ ## Install and run
61
+
62
+ To install it:
63
+
64
+ ```
65
+ pip install pyflashgui
66
+ ```
67
+
68
+ To run it:
69
+
70
+ ```
71
+ pyflashgui
72
+ ```
73
+
74
+ It needs Python 3.12 or newer, on Windows or Linux.
75
+
76
+ ## More
77
+
78
+ The [README](https://github.com/davhodg/pyflashgui#readme) says which probes need which drivers, and the [manual](https://github.com/davhodg/pyflashgui/blob/master/pyflashgui/help/manual.md) ships inside pyflashgui, under *Help > Documentation*.
79
+
80
+ Apache-2.0.
@@ -0,0 +1,40 @@
1
+ <p align="center">
2
+ <img src="https://raw.githubusercontent.com/davhodg/pyflashgui/master/pyflashgui/resources/pyflashgui.png" alt="pyflashgui icon: a chip with pins on every side and a flash across it" width="128">
3
+ </p>
4
+
5
+ # pyflashgui
6
+
7
+ [![CI](https://github.com/davhodg/pyflashgui/actions/workflows/ci.yml/badge.svg)](https://github.com/davhodg/pyflashgui/actions/workflows/ci.yml)
8
+ [![release](https://img.shields.io/github/v/release/davhodg/pyflashgui?include_prereleases)](https://github.com/davhodg/pyflashgui/releases)
9
+ [![PyPI](https://img.shields.io/pypi/v/pyflashgui)](https://pypi.org/project/pyflashgui/)
10
+ ![python](https://img.shields.io/badge/python-3.12+-blue)
11
+ ![platform](https://img.shields.io/badge/platform-Windows%20%7C%20Linux-lightgrey)
12
+ ![license](https://img.shields.io/badge/license-Apache--2.0-green)
13
+
14
+ A graphical flash programming tool. It works with any debug probe [pyOCD](https://pyocd.io) supports, for Arm Cortex-M targets: CMSIS-DAP probes such as the Raspberry Pi Debug Probe, DAPLink, NXP MCU-Link and Atmel-ICE, TI XDS110 and the probes built into many development boards, as well as ST-Link and J-Link. With a J-Link it can also use SEGGER's J-Link Commander, for the many other devices that supports.
15
+
16
+ ![pyflashgui on its simulated probe: the Files pane with a firmware file and a read, the memory map under them, the bytes of the read beside them, and the Event Log below](https://raw.githubusercontent.com/davhodg/pyflashgui/master/pyflashgui/help/main-window.png)
17
+
18
+ **It is a tool for the bench**: for development, debugging and hobby use. It is not meant for production programming.
19
+
20
+ ## Install and run
21
+
22
+ To install it:
23
+
24
+ ```
25
+ pip install pyflashgui
26
+ ```
27
+
28
+ To run it:
29
+
30
+ ```
31
+ pyflashgui
32
+ ```
33
+
34
+ It needs Python 3.12 or newer, on Windows or Linux.
35
+
36
+ ## More
37
+
38
+ The [README](https://github.com/davhodg/pyflashgui#readme) says which probes need which drivers, and the [manual](https://github.com/davhodg/pyflashgui/blob/master/pyflashgui/help/manual.md) ships inside pyflashgui, under *Help > Documentation*.
39
+
40
+ Apache-2.0.
@@ -0,0 +1,157 @@
1
+ <p align="center">
2
+ <img src="pyflashgui/resources/pyflashgui.png" alt="pyflashgui icon: a chip with pins on every side and a flash across it" width="128">
3
+ </p>
4
+
5
+ # pyflashgui
6
+
7
+ [![CI](https://github.com/davhodg/pyflashgui/actions/workflows/ci.yml/badge.svg)](https://github.com/davhodg/pyflashgui/actions/workflows/ci.yml)
8
+ [![release](https://img.shields.io/github/v/release/davhodg/pyflashgui?include_prereleases)](https://github.com/davhodg/pyflashgui/releases)
9
+ [![PyPI](https://img.shields.io/pypi/v/pyflashgui)](https://pypi.org/project/pyflashgui/)
10
+ ![python](https://img.shields.io/badge/python-3.12+-blue)
11
+ ![platform](https://img.shields.io/badge/platform-Windows%20%7C%20Linux-lightgrey)
12
+ ![license](https://img.shields.io/badge/license-Apache--2.0-green)
13
+
14
+ A graphical flash programming tool. It works with any debug probe [pyOCD](https://pyocd.io) supports, for Arm Cortex-M targets: CMSIS-DAP probes such as the Raspberry Pi Debug Probe, DAPLink, NXP MCU-Link and Atmel-ICE, TI XDS110 and the probes built into many development boards, as well as ST-Link and J-Link. With a J-Link it can also use SEGGER's J-Link Commander, for the many other devices that supports.
15
+
16
+ ![pyflashgui on its simulated probe: the Files pane with a firmware file and a read, the memory map under them, the bytes of the read beside them, and the Event Log below](pyflashgui/help/main-window.png)
17
+
18
+ ## What it is for
19
+
20
+ **It is a tool for the bench**: for development, debugging and hobby use. It is not meant for production programming.
21
+
22
+ - **Any probe.** A low-cost CMSIS-DAP probe or the ST-Link on a development board does the job a dedicated programmer does.
23
+ - **Workspaces.** The target, the probe, its speed and the files to program are kept together, one workspace per product, so programming a board is one click.
24
+ - **Files.** ELF, Intel HEX, Motorola S-record and raw binary, with a map of what will be written where.
25
+
26
+ ## Installing
27
+
28
+ There are three options:
29
+
30
+ 1. **With pip** -- from [PyPI](https://pypi.org/project/pyflashgui/), into whichever Python environment you choose. Python 3.12 or newer is needed.
31
+
32
+ To install it:
33
+
34
+ ```
35
+ pip install pyflashgui
36
+ ```
37
+
38
+ To run it:
39
+
40
+ ```
41
+ pyflashgui
42
+ ```
43
+
44
+ To update it:
45
+
46
+ ```
47
+ pip install --upgrade pyflashgui
48
+ ```
49
+
50
+ It is an ordinary Python package with an ordinary entry point, so the choice of environment is yours.
51
+
52
+ On Linux, Qt needs one system library first: see *On Linux* below.
53
+
54
+ 2. **The Windows installer** -- `pyflashgui-<version>-setup.exe` from the [releases page](https://github.com/davhodg/pyflashgui/releases). Nothing else is needed: **not even Python.** It installs a self-contained application, offers a desktop shortcut, and uninstalls cleanly. This is the one for somebody who wants a flash programming tool rather than a Python package.
55
+
56
+ It asks first who it is for: **everybody who uses the computer**, which needs administrator rights, or **only you**, which does not.
57
+
58
+ 3. **From a Git clone** -- clone the repository, then double-click `pyflashgui.cmd` (Windows) or run `./pyflashgui.sh` (Linux). This is the way to have the latest changes before they are released, or to contribute. Python 3.12 or newer must be on the PATH.
59
+
60
+ The first run sets itself up: it creates a *virtual environment* -- a folder called `.venv` holding its own copy of Python and only the libraries pyflashgui needs, so nothing else on the machine is touched -- and downloads a couple of hundred megabytes into it. That takes a few minutes once; every later start is immediate, and deleting `.venv` undoes the whole thing. If `uv` is installed it is used instead of pip, which makes rebuilding that folder a matter of seconds.
61
+
62
+ **On Linux**, run it from a terminal, so its messages can be read:
63
+
64
+ ```
65
+ ./pyflashgui.sh
66
+ ```
67
+
68
+ Debian, Ubuntu, Linux Mint and the like often leave out the package that lets Python create `.venv`. The launcher names it if it is missing:
69
+
70
+ ```
71
+ sudo apt install python3-venv
72
+ ```
73
+
74
+ Double-clicking `pyflashgui.sh` in a file manager works too: choose *Run in Terminal* when it asks, for the same reason.
75
+
76
+ At the end of the first run it offers to add pyflashgui to the Start menu, or to the applications menu on Linux, and *Tools > Settings > Add shortcut to Start menu* does the same later. The entry starts the launcher, so a start from the menu after a pull still picks up new libraries.
77
+
78
+ The launcher keeps its own `.venv` on purpose and will not use an environment you already have. That is the point of it: it is the way in for somebody who does not want to think about Python environments, and one that sometimes used yours and sometimes did not would be worse than one that never does. To run a checkout in an environment of your own instead, `pip install -e .` installs it there, reading the source.
79
+
80
+ **On Linux**, however pyflashgui is installed -- with pip or from a clone -- Qt needs a system library to draw the window, and Debian, Ubuntu, Linux Mint and the like often leave it out:
81
+
82
+ ```
83
+ sudo apt install libxcb-cursor0
84
+ ```
85
+
86
+ Without it pyflashgui stops as it starts, naming the package that is missing.
87
+
88
+ **Where your own files are kept** is the same whichever way it was installed: your workspaces and settings are in `%APPDATA%\pyflashgui` on Windows and `~/.config/pyflashgui` on Linux. Upgrading and uninstalling leave that folder alone.
89
+
90
+ ## Probes
91
+
92
+ Every probe is reached through [pyOCD](https://pyocd.io), which has a driver for each of the ways a probe talks over USB. Which probes work is therefore pyOCD's list:
93
+
94
+ | Probe | How pyOCD talks to it | What to install | Worth knowing |
95
+ |---|---|---|---|
96
+ | **CMSIS-DAP probes** | Arm's open CMSIS-DAP protocol | Windows: nothing. Linux: a udev rule. | The widest choice, and the one to pick when there is a choice. |
97
+ | **ST-Link** v2, v2-1 and v3 | ST's own protocol | Windows: ST's USB driver, where Windows has none for it. Linux: a udev rule. | Recent ST-Link firmware reaches only STM32 targets: for any other maker's device, use another probe. Firmware V2J24 or newer. |
98
+ | **J-Link** | SEGGER's own library, or CMSIS-DAP for a J-Link switched to that mode | SEGGER's J-Link software, on Windows and on Linux. | In its own mode it is not offered until that software is installed. Current J-Link BASE, PLUS, EDU, ULTRA+ and PRO models can be set to start as a CMSIS-DAP probe instead, with SEGGER's Configurator, and are then used like any other. |
99
+ | **Picoprobe** | The original Raspberry Pi Pico probe firmware | Linux: a udev rule. | The Pico's current debug probe firmware is CMSIS-DAP instead, and is the one to have. |
100
+
101
+ CMSIS-DAP is a protocol and not a product, so a great many probes speak it. Among those pyOCD's documentation names:
102
+
103
+ - Raspberry Pi Debug Probe, and a Pico running the debug probe firmware
104
+ - DAPLink, on its own and built into Arm Mbed and micro:bit boards
105
+ - NXP MCU-Link, MCU-Link Pro, LPC-Link2 and OpenSDA
106
+ - Microchip Atmel-ICE, and the EDBG on Microchip's boards
107
+ - Infineon (Cypress) KitProg3 and MiniProg4
108
+ - Keil ULINKplus
109
+ - TI XDS110, standalone and on TI LaunchPads. It is asked for one reply at a time, which some versions of its firmware need; pyflashgui sets that itself. pyOCD's udev rules do not include it, so on Linux it wants a rule of its own or the one TI's software installs.
110
+
111
+ **With pyOCD, the target has to be an Arm Cortex-M, whichever probe it is.** The probe carries the debug port; what is on the far side of it is pyOCD's to understand, and Cortex-M is what it understands. A probe that can reach other kinds of processor with its maker's own software -- a Cortex-A or Cortex-R, a RISC-V core -- still reaches only Cortex-M here.
112
+
113
+ pyflashgui has not yet been tried with any of these probes: this is what pyOCD says it supports, and how.
114
+
115
+ ### Beyond Cortex-M, with a J-Link
116
+
117
+ pyflashgui can instead drive a J-Link through SEGGER's own J-Link Commander, which comes with SEGGER's J-Link software. That reaches every device SEGGER's software knows -- Cortex-A and Cortex-R, RISC-V and others -- and works with a J-Link and nothing else. SEGGER's software is yours to install, under SEGGER's licence: it is for genuine SEGGER probes, and SEGGER describes J-Link Commander as a tool for development, not for production programming. Of this, listing the probe, connecting and reading have been tried, on one board.
118
+
119
+ On Linux a probe is usable without root once a udev rule allows it; pyOCD publishes [a set of them](https://github.com/pyocd/pyOCD/tree/main/udev). Vendor software is never bundled with pyflashgui: install the vendor's own, and pyflashgui finds it.
120
+
121
+ ## Built with
122
+
123
+ | Package | For | Licence |
124
+ |---|---|---|
125
+ | [PySide6](https://www.qt.io/qt-for-python) (Essentials) | the windows | LGPL-3.0 |
126
+ | [pyOCD](https://pyocd.io) | probes, targets and flash algorithms | Apache-2.0 |
127
+ | [bincopy](https://github.com/eerimoq/bincopy) | Intel HEX, S-record and binary files | MIT |
128
+
129
+ ## Uninstalling
130
+
131
+ - **The Windows installer:** *Settings > Apps* (or *Add or remove programs*), or *Uninstall
132
+ pyflashgui* in its Start menu folder. It takes away its shortcuts too.
133
+ - **pip:** `pip uninstall pyflashgui`.
134
+ - **A Git clone:** delete the folder. If a Start menu entry was added, take that away as well:
135
+ it is `%APPDATA%\Microsoft\Windows\Start Menu\Programs\pyflashgui.lnk` (on Linux,
136
+ `~/.local/share/applications/pyflashgui.desktop`).
137
+
138
+ Your workspaces and settings are in `%APPDATA%\pyflashgui` (`~/.config/pyflashgui` on Linux),
139
+ and no way of uninstalling touches them; delete that folder to remove them too.
140
+
141
+ ## Contributing
142
+
143
+ See [CONTRIBUTING.md](CONTRIBUTING.md): the policy for changes, setting up to work on pyflashgui, running the tests, and building the Windows installer. Everyone taking part is asked to follow the [code of conduct](CODE_OF_CONDUCT.md). Security problems go through [SECURITY.md](SECURITY.md).
144
+
145
+ ## Safety notice
146
+
147
+ pyflashgui talks to real equipment. It is intended only for people trained and experienced in working with microcontrollers, debug probes and the equipment they are part of. It is a tool for development and the bench, and is not meant for production programming.
148
+
149
+ Erasing and programming replace what a device holds, and cannot be undone. A device given the wrong file, or one that changes its protection or configuration, may not run, and may no longer be reachable through its debug port. Connecting, resetting and reading can stop or restart a device that is running, and with it whatever that device controls.
150
+
151
+ Like any software, pyflashgui can have faults, so do not rely on it alone to say that a device holds what was meant. Where a mistake could hurt someone or damage equipment, keep a way to stop that equipment within reach.
152
+
153
+ ## Licence
154
+
155
+ pyflashgui is free software, provided under the Apache License 2.0, without warranty of any kind; see [LICENSE](LICENSE) and [NOTICE](NOTICE).
156
+
157
+ Development has made use of Anthropic's Claude.
@@ -0,0 +1,6 @@
1
+ # SPDX-License-Identifier: Apache-2.0
2
+ # SPDX-FileCopyrightText: 2026 davhodg
3
+ """pyflashgui — a graphical flash programming tool."""
4
+
5
+ __version__ = "0.1.0"
6
+ APP_NAME = "pyflashgui" # single place to change the display name