Add MIT licence and package metadata

.github/workflows/release.yml

@@ -167,6 +167,39 @@ jobs:
           name: python-dist
           path: release-assets
 
+      - name: Download corresponding esptool source archive
+        run: |
+          python - <<'PY'
+          import subprocess
+          import sys
+          import tomllib
+          from pathlib import Path
+
+          project = tomllib.loads(Path("pyproject.toml").read_text(encoding="utf-8"))
+          requirement = next(
+              item for item in project["project"]["dependencies"]
+              if item.lower().startswith("esptool==")
+          )
+          version = requirement.split("==", 1)[1]
+          subprocess.run(
+              [
+                  sys.executable,
+                  "-m",
+                  "pip",
+                  "download",
+                  "--no-deps",
+                  "--no-binary=:all:",
+                  "--dest",
+                  "release-assets",
+                  "esptool==" + version,
+              ],
+              check=True,
+          )
+          source_archive = Path("release-assets") / ("esptool-" + version + ".tar.gz")
+          if not source_archive.is_file():
+              raise SystemExit("esptool corresponding source archive was not downloaded")
+          PY
+
       - name: Publish release
         uses: softprops/action-gh-release@v2
         with:

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Edward Chamberlain
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -229,3 +229,10 @@ Use GPIO numbers, not physical pin positions.
 - Disconnect power before changing wiring.
 - Once configured a "power only" cable will be ok as no data is transferred.
 - You can power this from the P1S internal USB port.
+
+## Licence
+
+Bambutton is released under the [MIT Licence](LICENSE). The distributed setup
+application and firmware also contain third-party components; see
+[third-party notices](THIRD_PARTY_NOTICES.md) and the notices shipped with the
+firmware.

THIRD_PARTY_LICENSES/pyserial-3.5-LICENSE.txt

@@ -0,0 +1,39 @@
+Copyright (c) 2001-2020 Chris Liechti <cliechti@gmx.net>
+All Rights Reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are
+met:
+
+  * Redistributions of source code must retain the above copyright
+    notice, this list of conditions and the following disclaimer.
+
+  * Redistributions in binary form must reproduce the above
+    copyright notice, this list of conditions and the following
+    disclaimer in the documentation and/or other materials provided
+    with the distribution.
+
+  * Neither the name of the copyright holder nor the names of its
+    contributors may be used to endorse or promote products derived
+    from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+---------------------------------------------------------------------------
+Note:
+Individual files contain the following tag instead of the full license text.
+
+    SPDX-License-Identifier:    BSD-3-Clause
+
+This enables machine processing of license information based on the SPDX
+License Identifiers that are here available: http://spdx.org/licenses/

THIRD_PARTY_NOTICES.md

@@ -0,0 +1,23 @@
+# Third-party software notices
+
+Bambutton includes and redistributes third-party software under the terms of
+its respective licence. These licences are separate from Bambutton's MIT
+licence. The desktop application includes licence documents supplied by its
+active runtime dependencies in `third_party_licenses/`. It also includes the
+pinned pyserial licence text from `THIRD_PARTY_LICENSES/` and the firmware
+notices and licence texts from `firmware/LICENSES/`.
+
+| Component | Version | Licence | Upstream licence/source |
+| --- | --- | --- | --- |
+| esptool | 5.2.0 | GPL-2.0-or-later | [Licence and source](https://github.com/espressif/esptool/tree/v5.2.0); the matching source archive is published with each Bambutton desktop release. |
+| FreeSimpleGUI | 5.2.0.post1 | LGPL-3.0-or-later | The desktop build includes the full licence text from the installed distribution metadata and its [upstream notice](https://github.com/spyoungtech/FreeSimpleGUI/blob/main/NOTICE). |
+| pyserial | 3.5 | BSD-3-Clause | The full text is included at `third_party_licenses/pyserial-3.5-LICENSE.txt`; see the [upstream licence](https://github.com/pyserial/pyserial/blob/v3.5/LICENSE.txt). |
+| mpremote | 1.28.0 | MIT | [MicroPython source](https://github.com/micropython/micropython/tree/v1.28.0/tools/mpremote) |
+| MicroPython ESP32-C3 firmware | v1.28.0 | MIT plus ESP-IDF component notices | See [`firmware/THIRD_PARTY_NOTICES.md`](firmware/THIRD_PARTY_NOTICES.md) and the included files under `firmware/LICENSES/`. |
+
+The application also installs transitive Python runtime dependencies. Their
+licence documents are collected from active runtime requirements when the
+desktop application is built. Long licence texts stored in package metadata
+are included too. Source and wheel distributions declare the runtime
+dependencies in `pyproject.toml`; each dependency retains its own licence and
+copyright terms.

firmware/LICENSES/ESP-IDF-COPYRIGHT-v5.5.1.rst

@@ -0,0 +1,178 @@
+Copyrights and Licenses
+***********************
+
+:link_to_translation:`zh_CN:[中文]`
+
+Software Copyrights
+===================
+
+All original source code in this repository is Copyright (C) 2015-2023 Espressif Systems. This source code is licensed under the Apache License 2.0 as described in the file LICENSE.
+
+Additional third party copyrighted code is included under the following licenses.
+
+Where source code headers specify Copyright & License information, this information takes precedence over the summaries made here.
+
+Some examples use external components which are not Apache licensed, please check the copyright description in each example source code.
+
+Firmware Components
+-------------------
+
+These third party libraries can be included into the application (firmware) produced by ESP-IDF.
+
+* :component:`Newlib <newlib>` is licensed under the BSD License, with copyright held by the respective parties, as described in :component_file:`COPYING.NEWLIB <newlib/COPYING.NEWLIB>`. If :ref:`CONFIG_LIBC_PICOLIBC<CONFIG_LIBC_PICOLIBC>` is enabled, see also :component_file:`COPYING.picolibc <newlib/COPYING.picolibc>`.
+
+:component:`Picolibc <newlib>` is licensed under the BSD License, with copyright held by the respective parties, as described in :component_file:`COPYING.picolibc <newlib/COPYING.NEWLIB>`.
+
+* :component:`Xtensa header files <xtensa/include/xtensa>` are Copyright (C) 2013 Tensilica Inc and are licensed under the MIT License as reproduced in the individual header files.
+
+* Original parts of FreeRTOS_ (components/freertos) are Copyright (C) 2017 Amazon.com, Inc. or its affiliates, and are licensed under the MIT License, as described in :component_file:`license.txt <freertos/FreeRTOS-Kernel/LICENSE.md>`.
+
+* Original parts of LWIP_ (components/lwip) are Copyright (C) 2001, 2002 Swedish Institute of Computer Science and are licensed under the BSD License as described in :component_file:`COPYING file <lwip/lwip/COPYING>`.
+
+* `wpa_supplicant`_, Copyright (C) 2003-2022 Jouni Malinen <j@w1.fi> and contributors and licensed under the BSD License.
+
+* :component_file:`Fast PBKDF2 <wpa_supplicant/esp_supplicant/src/crypto/crypto_mbedtls.c>`, Copyright (C) 2015 Joseph Birr-Pixton and licensed under CC0 Public Domain Dedication License.
+
+* `FreeBSD net80211`_, Copyright (C) 2004-2008 Sam Leffler, Errno Consulting and licensed under the BSD License.
+
+* `argtable3`_ argument parsing library, Copyright (C) 1998-2001,2003-2011,2013 Stewart Heitmann and licensed under 3-clause BSD license. argtable3 also includes the following software components. For details, please see argtable3 :component_file:`LICENSE file <console/argtable3/LICENSE>`.
+
+    * C Hash Table library, Copyright (C) 2002 Christopher Clark and licensed under 3-clause BSD License.
+    * The Better String library, Copyright (C) 2014 Paul Hsieh and licensed under 3-clause BSD License.
+    * TCL library, Copyright the Regents of the University of California, Sun Microsystems, Inc., Scriptics Corporation, ActiveState Corporation and other parties, and licensed under TCL/TK License.
+
+* `linenoise`_ line editing library, Copyright (C) 2010-2014 Salvatore Sanfilippo, Copyright (C) 2010-2013 Pieter Noordhuis, licensed under 2-clause BSD License.
+
+* `FatFS`_ library, Copyright (C) 2017 ChaN, is licensed under :component_file:`a BSD-style license <fatfs/src/ff.h#L1-L18>`.
+
+* `cJSON`_ library, Copyright (C) 2009-2017 Dave Gamble and cJSON contributors, is licensed under MIT License as described in :component_file:`LICENSE file <json/cJSON/LICENSE>`.
+
+* `micro-ecc`_ library, Copyright (C) 2014 Kenneth MacKay, is licensed under 2-clause BSD License.
+
+* `Mbed TLS`_ library, Copyright (C) 2006-2018 ARM Limited, is licensed under Apache License 2.0 as described in :component_file:`LICENSE file <mbedtls/mbedtls/LICENSE>`.
+
+* `SPIFFS`_ library, Copyright (C) 2013-2017 Peter Andersson, is licensed under MIT License as described in :component_file:`LICENSE file <spiffs/spiffs/LICENSE>`.
+
+* :component_file:`SD/MMC driver <sdmmc/sdmmc_cmd.c>` is derived from `OpenBSD SD/MMC driver`_, Copyright (C) 2006 Uwe Stuehler, and is licensed under BSD License.
+
+* :component:`ESP-MQTT <mqtt>` Package (contiki-mqtt), Copyright (C) 2014 Stephen Robinson, MQTT-ESP - Tuan PM <tuanpm at live dot com> is licensed under Apache License 2.0 as described in :component_file:`LICENSE file <mqtt/esp-mqtt/LICENSE>`.
+
+* :component:`BLE Mesh <bt/esp_ble_mesh>` is adapted from Zephyr Project, Copyright (C) 2017-2018 Intel Corporation and licensed under Apache License 2.0.
+
+* `mynewt-nimble`_, Copyright (C) 2015-2018 The Apache Software Foundation, is licensed under Apache License 2.0 as described in :component_file:`LICENSE file <bt/host/nimble/nimble/LICENSE>`.
+
+* `TLSF allocator <https://github.com/espressif/tlsf>`_, Copyright (C) 2006-2016 Matthew Conte, and licensed under the BSD 3-clause license.
+
+* :component:`openthread`, Copyright (C) The OpenThread Authors, is licensed under BSD License as described in :component_file:`LICENSE file <openthread/openthread/LICENSE>`.
+
+* :component_file:`UBSAN runtime <esp_system/ubsan.c>`, Copyright (C) 2016 Linaro Limited and Jiří Zárevúcky, licensed under the BSD 2-clause license.
+
+* :component:`HTTP Parser <http_parser>` is based on src/http/ngx_http_parse.c from NGINX copyright Igor Sysoev. Additional changes are licensed under the same terms as NGINX and Joyent, Inc. and other Node contributors. For details please check :component_file:`LICENSE file <http_parser/LICENSE.txt>`.
+
+* `SEGGER SystemView`_ target-side library, Copyright (C) 1995-2024 SEGGER Microcontroller GmbH, is licensed under BSD 1-clause license.
+
+* `protobuf-c`_ is Protocol Buffers implementation in C, Copyright (C) 2008-2022 Dave Benson and the protobuf-c authors. For details please check :component_file:`LICENSE file <protobuf-c/protobuf-c/LICENSE>`.
+
+* `CMock`_ mock/stub generator for C, Copyright (C) 2007-14 Mike Karlesky, Mark VanderVoord, Greg Williams, is licensed under MIT License as described in :component_file:`LICENSE file <cmock/CMock/LICENSE.txt>`.
+
+* `Unity`_ Simple Unit Testing library, Copyright (C) 2007-23 Mike Karlesky, Mark VanderVoord, Greg Williams, is licensed under MIT License as described in :component_file:`LICENSE file <unity/unity/LICENSE.txt>`.
+
+Documentation
+-------------
+
+* HTML version of the `ESP-IDF Programming Guide`_ uses the Sphinx theme `sphinx_idf_theme`_, which is Copyright (C) 2013-2020 Dave Snider, Read the Docs, Inc. & contributors, and Espressif Systems (Shanghai) CO., LTD. It is based on `sphinx_rtd_theme`_. Both are licensed under MIT License.
+
+ROM Source Code Copyrights
+==========================
+
+Espressif SoCs mask ROM hardware includes binaries compiled from portions of the following third party software:
+
+* :component:`Newlib <newlib>`, licensed under the BSD License and is Copyright of various parties, as described in :component_file:`COPYING.NEWLIB <newlib/COPYING.NEWLIB>`.
+
+* Xtensa libhal, Copyright (C) Tensilica Inc and licensed under the MIT License (see below).
+
+* TinyBasic_ Plus, Copyright (C) Mike Field & Scott Lawrence and licensed under the MIT License (see below).
+
+* miniz_, by Rich Geldreich - placed into the public domain.
+
+* TJpgDec_, Copyright (C) 2011 ChaN, all right reserved. See below for license.
+
+* Parts of Zephyr RTOS USB stack:
+    * `DesignWare USB device driver`_, Copyright (C) 2016 Intel Corporation and licensed under Apache License 2.0.
+    * `Generic USB device driver`_, Copyright (C) 2006 Bertrik Sikken (bertrik@sikken.nl), 2016 Intel Corporation and licensed under BSD 3-clause license.
+    * `USB descriptors functionality`_, Copyright (C) 2017 PHYTEC Messtechnik GmbH, 2017-2018 Intel Corporation and licensed under Apache License 2.0.
+    * `USB DFU class driver`_, Copyright (C) 2015-2016 Intel Corporation, 2017 PHYTEC Messtechnik GmbH and licensed under BSD 3-clause license.
+    * `USB CDC ACM class driver`_, Copyright (C) 2015-2016 Intel Corporation and licensed under Apache License 2.0.
+
+.. only:: CONFIG_ESP_ROM_HAS_MBEDTLS_CRYPTO_LIB
+
+    * `Mbed TLS`_ library, Copyright (C) 2006-2018 ARM Limited and licensed under Apache 2.0 License.
+
+Xtensa libhal MIT License
+=========================
+
+Copyright (C) 2003, 2006, 2010 Tensilica Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+TinyBasic Plus MIT License
+==========================
+
+Copyright (C) 2012-2013 Mike Field & Scott Lawrence.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+TJpgDec License
+===============
+
+TJpgDec - Tiny JPEG Decompressor R0.01 (C) 2011 ChaN, is a generic JPEG decompressor module for tiny embedded systems.This is a free software that opened for education, research and commercial developments under license policy of following terms:
+
+Copyright (C) 2011 ChaN, all right reserved.
+
+* The TJpgDec module is a free software and there is NO WARRANTY.
+* No restriction on use. You can use, modify and redistribute it for personal, non-profit or commercial products UNDER YOUR RESPONSIBILITY.
+* Redistributions of source code must retain the above copyright notice.
+
+
+.. _Newlib: https://sourceware.org/newlib/
+.. _Picolibc: https://keithp.com/picolibc/
+.. _FreeRTOS: https://freertos.org/
+.. _esptool.py: https://github.com/espressif/esptool
+.. _LWIP: https://savannah.nongnu.org/projects/lwip/
+.. _TinyBasic: https://github.com/BleuLlama/TinyBasicPlus
+.. _miniz: https://code.google.com/archive/p/miniz/
+.. _wpa_supplicant: https://w1.fi/wpa_supplicant/
+.. _FreeBSD net80211: https://github.com/freebsd/freebsd-src/tree/master/sys/net80211
+.. _TJpgDec: http://elm-chan.org/fsw/tjpgd/00index.html
+.. _argtable3: https://github.com/argtable/argtable3
+.. _linenoise: https://github.com/antirez/linenoise
+.. _fatfs: http://elm-chan.org/fsw/ff/00index_e.html
+.. _cJSON: https://github.com/DaveGamble/cJSON
+.. _micro-ecc: https://github.com/kmackay/micro-ecc
+.. _OpenBSD SD/MMC driver: https://github.com/openbsd/src/blob/f303646/sys/dev/sdmmc/sdmmc.c
+.. _Mbed TLS: https://github.com/Mbed-TLS/mbedtls
+.. _spiffs: https://github.com/pellepl/spiffs
+.. _CMock: https://github.com/ThrowTheSwitch/CMock
+.. _protobuf-c: https://github.com/protobuf-c/protobuf-c
+.. _Unity: https://github.com/ThrowTheSwitch/Unity
+.. _asio: https://github.com/chriskohlhoff/asio
+.. _mqtt: https://github.com/espressif/esp-mqtt
+.. _zephyr: https://github.com/zephyrproject-rtos/zephyr
+.. _mynewt-nimble: https://github.com/apache/mynewt-nimble
+.. _ESP-IDF Programming Guide: https://docs.espressif.com/projects/esp-idf/en/latest/
+.. _sphinx_idf_theme: https://github.com/espressif/sphinx_idf_theme
+.. _sphinx_rtd_theme: https://github.com/readthedocs/sphinx_rtd_theme
+.. _SEGGER SystemView: https://www.segger.com/downloads/systemview/
+.. _DesignWare USB device driver: https://github.com/zephyrproject-rtos/zephyr/blob/v1.12-branch/drivers/usb/device/usb_dc_dw.c
+.. _Generic USB device driver: https://github.com/zephyrproject-rtos/zephyr/blob/v1.12-branch/subsys/usb/usb_device.c
+.. _USB descriptors functionality: https://github.com/zephyrproject-rtos/zephyr/blob/v1.12-branch/subsys/usb/usb_descriptor.c
+.. _USB DFU class driver: https://github.com/zephyrproject-rtos/zephyr/blob/v1.12-branch/subsys/usb/class/usb_dfu.c
+.. _USB CDC ACM class driver: https://github.com/zephyrproject-rtos/zephyr/blob/v1.12-branch/subsys/usb/class/cdc_acm.c