qtpy-datalogger 1.0.1__tar.gz

qtpy_datalogger-1.0.1/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

qtpy_datalogger-1.0.1/PKG-INFO

@@ -0,0 +1,198 @@
+Metadata-Version: 2.4
+Name: qtpy-datalogger
+Version: 1.0.1
+Summary: Data acquisition application using Adafruit QT Py S3
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: circuitpython,daq,qtpy
+Author: Down to the Wire
+Author-email: all.wired.down@gmail.com
+Requires-Python: >=3.11,<4.0
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Software Development :: Embedded Systems
+Classifier: Topic :: Software Development :: User Interfaces
+Requires-Dist: beautifulsoup4 (>=4.14.3,<5.0.0)
+Requires-Dist: circup (>=3.0.1,<4.0.0)
+Requires-Dist: click (>=8.3.2,<9.0.0)
+Requires-Dist: findimports (>=3.0.0,<4.0.0)
+Requires-Dist: gmqtt (>=0.7.0,<0.8.0)
+Requires-Dist: matplotlib (>=3.10.8,<4.0.0)
+Requires-Dist: packaging (>=26.0,<27.0)
+Requires-Dist: pandas (>=3.0.2,<4.0.0)
+Requires-Dist: psutil (>=7.2.2,<8.0.0)
+Requires-Dist: pyserial (>=3.5,<4.0)
+Requires-Dist: tkfontawesome (>=0.3.2,<0.4.0)
+Requires-Dist: ttkbootstrap (>=1.20.2,<2.0.0)
+Requires-Dist: wmi (>=1.5.1,<2.0.0)
+Project-URL: Documentation, https://github.com/wireddown/qt-py-s3-daq-app/wiki
+Project-URL: Homepage, https://github.com/wireddown/qt-py-s3-daq-app
+Project-URL: changelog, https://github.com/wireddown/qt-py-s3-daq-app/releases
+Project-URL: issues, https://github.com/wireddown/qt-py-s3-daq-app/issues
+Project-URL: source, https://github.com/wireddown/qt-py-s3-daq-app
+Description-Content-Type: text/markdown
+
+# QT Py S3 DAQ App
+
+**`qtpy-datalogger`** -- A data acquisition application using the [Adafruit QT Py S3] and [CircuitPython].
+
+## Status
+
+[![CI: Tests and Analyzers](https://github.com/wireddown/qt-py-s3-daq-app/actions/workflows/ci.yml/badge.svg)](https://github.com/wireddown/qt-py-s3-daq-app/actions/workflows/ci.yml)
+[![Dependabot Updates]](https://github.com/wireddown/qt-py-s3-daq-app/actions/workflows/dependabot/dependabot-updates)
+[![Publish: Release on PyPI](https://github.com/wireddown/qt-py-s3-daq-app/actions/workflows/publish.yml/badge.svg)](https://github.com/wireddown/qt-py-s3-daq-app/actions/workflows/publish.yml)
+
+## Structure
+
+```mermaid
+graph LR
+    AP(🛜 Access Point)
+    App(🐍 App)
+    MQTT(📨 MQTT)
+    QTPy(🐍 QT Py S3)
+
+    subgraph "🌐 Network"
+        AP
+    end
+
+    subgraph "💻 PC Host"
+        App<-.->MQTT
+        MQTT<-.->AP
+    end
+
+    subgraph "🧪 Test Zone"
+        AP<-.->|🛜 WiFi|QTPy
+    end
+```
+
+**Supported Python versions**
+- Host
+  - Python 3.11
+  - Python 3.12
+  - Python 3.13
+- Node
+  - CircuitPython 9.0
+
+**Supported host platforms**
+- Windows
+
+**Supported connection types**
+- Serial / UART
+- Network / MQTT
+
+**Entry points**
+- Host program: [`qtpy_datalogger/console.py`](https://github.com/wireddown/qt-py-s3-daq-app/blob/main/src/qtpy_datalogger/console.py)
+- QT Py program: [`qtpy_datalogger/sensor_node/code.py`](https://github.com/wireddown/qt-py-s3-daq-app/blob/main/src/qtpy_datalogger/sensor_node/code.py)
+
+## Preview in 90 seconds
+
+1. Connect your QT Py device with USB
+   - _(Optional)_ Back up its `code.py` file
+1. Preview the program in a deletable Python virtual environment
+
+```pwsh
+# Create and enter a new Python virtual environment
+mkdir qtpy-preview
+cd qtpy-preview
+python -m venv --upgrade-deps .venv
+.\.venv\Scripts\activate.ps1
+
+# Install
+pip install qtpy-datalogger
+
+# Show the package help
+qtpy-datalogger --help
+
+# Search for devices
+qtpy-datalogger connect --discover-only
+
+# Install the node runtime on a device
+qtpy-datalogger equip
+
+# Open a serial connection, use Ctrl-] to quit
+qtpy-datalogger connect
+
+qtpycmd get_apps
+
+qtpycmd stats
+
+qtpycmd read A0 A1 A2 A3
+```
+
+This preview does not demonstrate MQTT communication over WiFi
+- Visit the wiki for [MQTT setup and commissioning] for more details
+
+## Gallery
+
+### Scanner
+
+```
+qtpy-datalogger run scanner
+```
+
+Scan for nodes by group.
+Select a node to send it messages.
+
+![Screenshot of the scanner app](https://raw.githubusercontent.com/wireddown/qt-py-s3-daq-app/refs/heads/main/docs/gallery/app-scanner.png)
+
+### Data Viewer
+
+```
+qtpy-datalogger run data-viewer
+```
+
+Open a CSV file for time series data.
+
+![Screenshot of the data viewer app](https://raw.githubusercontent.com/wireddown/qt-py-s3-daq-app/refs/heads/main/docs/gallery/app-data-viewer.png)
+
+CSV format
+- Series data are in columns
+- Series names are in the first row
+- The time axis is in the first column
+  - ISO timestamps and floating point values both accepted
+
+```csv
+Time,Sensor 1,Sensor 2
+0.0,1.284,2.713
+0.22,1.302,5.536
+...
+```
+
+## Questions and help
+
+Please go to the [wiki home page] for guidance.
+
+## Contributing
+
+This project manages its Python programs with `poetry`.
+
+The environment setup instructions are in the wiki on the [Contributing] page.
+
+The design documentation is in the wiki under the [Design Doc] pages.
+
+## Legacy system
+
+This project replaces a legacy system that uses Python and JeeNodes.
+
+See the [summary and source code] in the `docs/legacy` folder for details.
+
+
+[Dependabot Updates]: https://github.com/wireddown/qt-py-s3-daq-app/actions/workflows/dependabot/dependabot-updates/badge.svg
+
+[Adafruit QT Py S3]: https://learn.adafruit.com/adafruit-qt-py-esp32-s3
+[CircuitPython]: https://circuitpython.org/
+
+[MQTT setup and commissioning]: https://github.com/wireddown/qt-py-s3-daq-app/wiki/Walkthrough-5-MQTT
+
+[wiki home page]: https://github.com/wireddown/qt-py-s3-daq-app/wiki
+[Contributing]: https://github.com/wireddown/qt-py-s3-daq-app/wiki/Contributing
+[Design Doc]: https://github.com/wireddown/qt-py-s3-daq-app/wiki/Design-Doc-1-Overview
+[summary and source code]: https://github.com/wireddown/qt-py-s3-daq-app/blob/main/docs/legacy/README.md
+

qtpy_datalogger-1.0.1/README.md

@@ -0,0 +1,156 @@
+# QT Py S3 DAQ App
+
+**`qtpy-datalogger`** -- A data acquisition application using the [Adafruit QT Py S3] and [CircuitPython].
+
+## Status
+
+[![CI: Tests and Analyzers](https://github.com/wireddown/qt-py-s3-daq-app/actions/workflows/ci.yml/badge.svg)](https://github.com/wireddown/qt-py-s3-daq-app/actions/workflows/ci.yml)
+[![Dependabot Updates]](https://github.com/wireddown/qt-py-s3-daq-app/actions/workflows/dependabot/dependabot-updates)
+[![Publish: Release on PyPI](https://github.com/wireddown/qt-py-s3-daq-app/actions/workflows/publish.yml/badge.svg)](https://github.com/wireddown/qt-py-s3-daq-app/actions/workflows/publish.yml)
+
+## Structure
+
+```mermaid
+graph LR
+    AP(🛜 Access Point)
+    App(🐍 App)
+    MQTT(📨 MQTT)
+    QTPy(🐍 QT Py S3)
+
+    subgraph "🌐 Network"
+        AP
+    end
+
+    subgraph "💻 PC Host"
+        App<-.->MQTT
+        MQTT<-.->AP
+    end
+
+    subgraph "🧪 Test Zone"
+        AP<-.->|🛜 WiFi|QTPy
+    end
+```
+
+**Supported Python versions**
+- Host
+  - Python 3.11
+  - Python 3.12
+  - Python 3.13
+- Node
+  - CircuitPython 9.0
+
+**Supported host platforms**
+- Windows
+
+**Supported connection types**
+- Serial / UART
+- Network / MQTT
+
+**Entry points**
+- Host program: [`qtpy_datalogger/console.py`](https://github.com/wireddown/qt-py-s3-daq-app/blob/main/src/qtpy_datalogger/console.py)
+- QT Py program: [`qtpy_datalogger/sensor_node/code.py`](https://github.com/wireddown/qt-py-s3-daq-app/blob/main/src/qtpy_datalogger/sensor_node/code.py)
+
+## Preview in 90 seconds
+
+1. Connect your QT Py device with USB
+   - _(Optional)_ Back up its `code.py` file
+1. Preview the program in a deletable Python virtual environment
+
+```pwsh
+# Create and enter a new Python virtual environment
+mkdir qtpy-preview
+cd qtpy-preview
+python -m venv --upgrade-deps .venv
+.\.venv\Scripts\activate.ps1
+
+# Install
+pip install qtpy-datalogger
+
+# Show the package help
+qtpy-datalogger --help
+
+# Search for devices
+qtpy-datalogger connect --discover-only
+
+# Install the node runtime on a device
+qtpy-datalogger equip
+
+# Open a serial connection, use Ctrl-] to quit
+qtpy-datalogger connect
+
+qtpycmd get_apps
+
+qtpycmd stats
+
+qtpycmd read A0 A1 A2 A3
+```
+
+This preview does not demonstrate MQTT communication over WiFi
+- Visit the wiki for [MQTT setup and commissioning] for more details
+
+## Gallery
+
+### Scanner
+
+```
+qtpy-datalogger run scanner
+```
+
+Scan for nodes by group.
+Select a node to send it messages.
+
+![Screenshot of the scanner app](https://raw.githubusercontent.com/wireddown/qt-py-s3-daq-app/refs/heads/main/docs/gallery/app-scanner.png)
+
+### Data Viewer
+
+```
+qtpy-datalogger run data-viewer
+```
+
+Open a CSV file for time series data.
+
+![Screenshot of the data viewer app](https://raw.githubusercontent.com/wireddown/qt-py-s3-daq-app/refs/heads/main/docs/gallery/app-data-viewer.png)
+
+CSV format
+- Series data are in columns
+- Series names are in the first row
+- The time axis is in the first column
+  - ISO timestamps and floating point values both accepted
+
+```csv
+Time,Sensor 1,Sensor 2
+0.0,1.284,2.713
+0.22,1.302,5.536
+...
+```
+
+## Questions and help
+
+Please go to the [wiki home page] for guidance.
+
+## Contributing
+
+This project manages its Python programs with `poetry`.
+
+The environment setup instructions are in the wiki on the [Contributing] page.
+
+The design documentation is in the wiki under the [Design Doc] pages.
+
+## Legacy system
+
+This project replaces a legacy system that uses Python and JeeNodes.
+
+See the [summary and source code] in the `docs/legacy` folder for details.
+
+
+[Dependabot Updates]: https://github.com/wireddown/qt-py-s3-daq-app/actions/workflows/dependabot/dependabot-updates/badge.svg
+
+[Adafruit QT Py S3]: https://learn.adafruit.com/adafruit-qt-py-esp32-s3
+[CircuitPython]: https://circuitpython.org/
+
+[MQTT setup and commissioning]: https://github.com/wireddown/qt-py-s3-daq-app/wiki/Walkthrough-5-MQTT
+
+[wiki home page]: https://github.com/wireddown/qt-py-s3-daq-app/wiki
+[Contributing]: https://github.com/wireddown/qt-py-s3-daq-app/wiki/Contributing
+[Design Doc]: https://github.com/wireddown/qt-py-s3-daq-app/wiki/Design-Doc-1-Overview
+[summary and source code]: https://github.com/wireddown/qt-py-s3-daq-app/blob/main/docs/legacy/README.md