ents 2.3.2__tar.gz

ents-2.3.2/.gitignore

@@ -0,0 +1,160 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/

ents-2.3.2/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 jLab in Smart Sensing at UCSC
+
+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.

ents-2.3.2/PKG-INFO

@@ -0,0 +1,206 @@
+Metadata-Version: 2.4
+Name: ents
+Version: 2.3.2
+Summary: Python package for Environmental NeTworked Sensor (ENTS)
+Project-URL: Homepage, https://github.com/jlab-sensing/soil-power-sensor-firmware
+Project-URL: Issues, https://github.com/jlab-sensing/soil-power-sensor-firmware/issues
+Author-email: John Madden <jmadden173@pm.me>
+License-File: LICENSE
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.11
+Requires-Dist: matplotlib
+Requires-Dist: pandas
+Requires-Dist: protobuf>5.0.0
+Requires-Dist: pyserial
+Requires-Dist: requests
+Requires-Dist: scikit-learn
+Requires-Dist: tqdm
+Provides-Extra: dev
+Requires-Dist: black; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Provides-Extra: gui
+Requires-Dist: pyqt5; extra == 'gui'
+Description-Content-Type: text/markdown
+
+# Soil Power Sensor Python Protobuf Bindings
+
+The soil power sensor protobuf protocol is implemented as a Python package that allows for `Measurement` messages to be decoded into a dictionary and `Response` messages to be encoded. The generated files from protobuf are also accessible for more complex use cases.
+
+
+## Installation
+
+Use the following to install the `ents` package with gui via `pip`:
+
+```bash
+pip install ents[gui]
+```
+
+You can also install the package from source with the following:
+
+```bash
+# install package
+pip install .[gui]
+```
+
+If you are planning to develop the package we recommend you install the package
+in editable mode with development dependencies. This allows you to make changes
+to the source code and have them reflected in the package without needing to
+reinstall it.
+
+```bash
+# install development dependencies
+pip install -e .[gui,dev]
+```
+
+## Usage
+
+The following example code demonstrates decoding the measurement message and encoding a response.
+
+```python
+from ents import encode, decode
+
+# get data encoded by the soil power sensor
+data = ...
+
+meas_dict = decode(data)
+
+# process data
+...
+
+# send response
+resp_str = encode(success=True)
+```
+
+The formatting of the dictionary depends on the type of measurement sent. The key `type` is included on all measurement types and can be used to determine the type of message. See the source `*.proto` files to get the full list of types to get the full list of types and keys. A list is provided in [Message Types](#message-types). The Python protobuf API uses camel case when naming keys. The key `ts` is in ISO 8601 format as a string.
+
+## Message Types
+
+Type `power`
+```python
+meas_dict = {
+  "type": "power",
+  "loggerId": ...,
+  "cellId": ...,
+  "ts": ...,
+  "data": {
+    "voltage": ...,
+    "current": ...
+  },
+  "data_type": {
+    "voltage": float,
+    "voltage": float
+  }
+}
+```
+
+Type `teros12`
+```python
+meas_dict = {
+  "type": "teros12",
+  "loggerId": ...,
+  "cellId": ...,
+  "ts": ...,
+  "data": {
+    "vwcRaw": ...,
+    "vwcAdj": ...,
+    "temp": ...,
+    "ec": ...
+  },
+  "data_type": {
+    "vwcRaw": float,
+    "vwcAdj": float,
+    "temp": float,
+    "ec": int
+  }
+}
+```
+
+Type `bme280` with `raw=True` (default)
+```python
+meas_dict = {
+  "type": "bme280",
+  "loggerId": ...,
+  "cellId": ...,
+  "ts": ...,
+  "data": {
+    "pressure": ...,
+    "temperature": ...,
+    "humidity": ...,
+  },
+  "data_type": {
+    "pressure": int,
+    "temperature": int,
+    "humidity": int, 
+  }
+}
+```
+
+Type `bme280` with `raw=False`
+```python
+meas_dict = {
+  "type": "bme280",
+  "loggerId": ...,
+  "cellId": ...,
+  "ts": ...,
+  "data": {
+    "pressure": ...,
+    "temperature": ...,
+    "humidity": ...,
+  },
+  "data_type": {
+    "pressure": float,
+    "temperature": float,
+    "humidity": float, 
+  }
+}
+```
+
+
+## Simulator
+
+Simulate WiFi sensor uploads without requiring ENTS hardware.
+
+### Examples
+
+The examples below can be tested standalone (without ents-backend), by running the http server in `tools/http_server.py` to see the request format.
+
+#### Upload a days worth of power measurements on a 60 second interval
+
+```shell
+ents sim --url http://localhost:3000/api/sensor/ --mode batch --sensor power --cell 200 --logger 200 --start 2025-05-01 --end 2025-05-02 --freq 60
+```
+
+```
+...
+total: 1437, failed: 0, avg (ms): 0.10716012526096033, last (ms): 0.0896
+total: 1438, failed: 0, avg (ms): 0.10714290681502087, last (ms): 0.0824
+total: 1439, failed: 0, avg (ms): 0.10712599027102154, last (ms): 0.0828
+total: 1440, failed: 0, avg (ms): 0.10710909722222223, last (ms): 0.0828
+total: 1441, failed: 0, avg (ms): 0.10709035392088828, last (ms): 0.08009999999999999
+Done!
+```
+
+#### Upload measurements every 10 seconds
+
+```shell
+ents sim --url http://localhost:3000/api/sensor/ --mode stream --sensor power --cell 200 --logger 200 --freq 10
+```
+
+```
+Use CTRL+C to stop the simulation
+total: 1, failed: 1, avg (ms): 23.386100000000003, last (ms): 23.386100000000003
+total: 2, failed: 2, avg (ms): 13.668950000000002, last (ms): 3.9517999999999995
+total: 3, failed: 3, avg (ms): 10.795566666666668, last (ms): 5.0488
+total: 4, failed: 4, avg (ms): 8.97235, last (ms): 3.5027000000000004
+```
+
+## Testing
+
+To run the package tests, create a virtual environment, install as an editable package (if you haven't done so already), and run `unittest`.
+
+```bash
+cd python/
+python -m unittest
+```

ents-2.3.2/README.md

@@ -0,0 +1,180 @@
+# Soil Power Sensor Python Protobuf Bindings
+
+The soil power sensor protobuf protocol is implemented as a Python package that allows for `Measurement` messages to be decoded into a dictionary and `Response` messages to be encoded. The generated files from protobuf are also accessible for more complex use cases.
+
+
+## Installation
+
+Use the following to install the `ents` package with gui via `pip`:
+
+```bash
+pip install ents[gui]
+```
+
+You can also install the package from source with the following:
+
+```bash
+# install package
+pip install .[gui]
+```
+
+If you are planning to develop the package we recommend you install the package
+in editable mode with development dependencies. This allows you to make changes
+to the source code and have them reflected in the package without needing to
+reinstall it.
+
+```bash
+# install development dependencies
+pip install -e .[gui,dev]
+```
+
+## Usage
+
+The following example code demonstrates decoding the measurement message and encoding a response.
+
+```python
+from ents import encode, decode
+
+# get data encoded by the soil power sensor
+data = ...
+
+meas_dict = decode(data)
+
+# process data
+...
+
+# send response
+resp_str = encode(success=True)
+```
+
+The formatting of the dictionary depends on the type of measurement sent. The key `type` is included on all measurement types and can be used to determine the type of message. See the source `*.proto` files to get the full list of types to get the full list of types and keys. A list is provided in [Message Types](#message-types). The Python protobuf API uses camel case when naming keys. The key `ts` is in ISO 8601 format as a string.
+
+## Message Types
+
+Type `power`
+```python
+meas_dict = {
+  "type": "power",
+  "loggerId": ...,
+  "cellId": ...,
+  "ts": ...,
+  "data": {
+    "voltage": ...,
+    "current": ...
+  },
+  "data_type": {
+    "voltage": float,
+    "voltage": float
+  }
+}
+```
+
+Type `teros12`
+```python
+meas_dict = {
+  "type": "teros12",
+  "loggerId": ...,
+  "cellId": ...,
+  "ts": ...,
+  "data": {
+    "vwcRaw": ...,
+    "vwcAdj": ...,
+    "temp": ...,
+    "ec": ...
+  },
+  "data_type": {
+    "vwcRaw": float,
+    "vwcAdj": float,
+    "temp": float,
+    "ec": int
+  }
+}
+```
+
+Type `bme280` with `raw=True` (default)
+```python
+meas_dict = {
+  "type": "bme280",
+  "loggerId": ...,
+  "cellId": ...,
+  "ts": ...,
+  "data": {
+    "pressure": ...,
+    "temperature": ...,
+    "humidity": ...,
+  },
+  "data_type": {
+    "pressure": int,
+    "temperature": int,
+    "humidity": int, 
+  }
+}
+```
+
+Type `bme280` with `raw=False`
+```python
+meas_dict = {
+  "type": "bme280",
+  "loggerId": ...,
+  "cellId": ...,
+  "ts": ...,
+  "data": {
+    "pressure": ...,
+    "temperature": ...,
+    "humidity": ...,
+  },
+  "data_type": {
+    "pressure": float,
+    "temperature": float,
+    "humidity": float, 
+  }
+}
+```
+
+
+## Simulator
+
+Simulate WiFi sensor uploads without requiring ENTS hardware.
+
+### Examples
+
+The examples below can be tested standalone (without ents-backend), by running the http server in `tools/http_server.py` to see the request format.
+
+#### Upload a days worth of power measurements on a 60 second interval
+
+```shell
+ents sim --url http://localhost:3000/api/sensor/ --mode batch --sensor power --cell 200 --logger 200 --start 2025-05-01 --end 2025-05-02 --freq 60
+```
+
+```
+...
+total: 1437, failed: 0, avg (ms): 0.10716012526096033, last (ms): 0.0896
+total: 1438, failed: 0, avg (ms): 0.10714290681502087, last (ms): 0.0824
+total: 1439, failed: 0, avg (ms): 0.10712599027102154, last (ms): 0.0828
+total: 1440, failed: 0, avg (ms): 0.10710909722222223, last (ms): 0.0828
+total: 1441, failed: 0, avg (ms): 0.10709035392088828, last (ms): 0.08009999999999999
+Done!
+```
+
+#### Upload measurements every 10 seconds
+
+```shell
+ents sim --url http://localhost:3000/api/sensor/ --mode stream --sensor power --cell 200 --logger 200 --freq 10
+```
+
+```
+Use CTRL+C to stop the simulation
+total: 1, failed: 1, avg (ms): 23.386100000000003, last (ms): 23.386100000000003
+total: 2, failed: 2, avg (ms): 13.668950000000002, last (ms): 3.9517999999999995
+total: 3, failed: 3, avg (ms): 10.795566666666668, last (ms): 5.0488
+total: 4, failed: 4, avg (ms): 8.97235, last (ms): 3.5027000000000004
+```
+
+## Testing
+
+To run the package tests, create a virtual environment, install as an editable package (if you haven't done so already), and run `unittest`.
+
+```bash
+cd python/
+python -m unittest
+```

ents-2.3.2/pyproject.toml

@@ -0,0 +1,55 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "ents"
+version = "2.3.2"
+authors = [
+  { name="John Madden", email="jmadden173@pm.me" },
+]
+description = "Python package for Environmental NeTworked Sensor (ENTS)"
+readme = "README.md"
+requires-python = ">=3.11"
+classifiers = [
+  "Programming Language :: Python :: 3",
+  "License :: OSI Approved :: MIT License",
+  "Operating System :: OS Independent",
+]
+dependencies = [
+  'protobuf>5.0.0',
+  'matplotlib',
+  'pandas',
+  'pyserial',
+  'scikit-learn',
+  'tqdm',
+  'requests',
+]
+
+[project.optional-dependencies]
+gui = [
+  'PyQt5',
+]
+
+dev = [
+  "black",
+  "ruff",
+]
+
+[project.scripts]
+ents = "ents.cli:entry"
+
+[project.gui-scripts]
+ents-gui = "ents.config.user_config:main"
+
+[project.urls]
+Homepage = "https://github.com/jlab-sensing/soil-power-sensor-firmware"
+Issues = "https://github.com/jlab-sensing/soil-power-sensor-firmware/issues"
+
+[tool.ruff]
+exclude = [
+  "src/ents/proto/soil_power_sensor_pb2.py",
+]
+
+[tool.black]
+exclude = ".*_pb2.py"

ents-2.3.2/src/ents/__init__.py

@@ -0,0 +1,23 @@
+from .proto.encode import (
+    encode_response,
+    encode_power_measurement,
+    encode_teros12_measurement,
+    encode_phytos31_measurement,
+    encode_bme280_measurement,
+)
+
+from .proto.decode import decode_response, decode_measurement
+
+from .proto.esp32 import encode_esp32command, decode_esp32command
+
+__all__ = [
+    "encode_response",
+    "encode_power_measurement",
+    "encode_teros12_measurement",
+    "encode_phytos31_measurement",
+    "encode_bme280_measurement",
+    "decode_response",
+    "decode_measurement",
+    "encode_esp32command",
+    "decode_esp32command",
+]

ents-2.3.2/src/ents/calibrate/PingSMU.py

@@ -0,0 +1,51 @@
+"""To test connection via socket to Kiethley 2450
+
+Stephen Taylor, 5/20/2024
+"""
+
+import socket
+
+
+def ping_smu(host, port):
+    try:
+        # Create a TCP/IP socket
+        sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
+
+        # Set a timeout for the connection attempt
+        sock.settimeout(1)
+
+        # Connect to the SMU
+        sock.connect((host, port))
+
+        # Send the *IDN? command
+        sock.sendall(b"*RST\n")
+        sock.sendall(b"*IDN?\n")
+
+        # Receive the response
+        response = sock.recv(1024)
+        response = response.strip()
+        print("Response from SMU:", response)
+
+        # Close the socket
+        sock.close()
+
+        # Return True if connection successful
+        return True
+    except Exception as e:
+        # Connection failed
+        print(f"Error: {e}")
+        return False
+
+
+if __name__ == "__main__":
+    # Specify the IP address or hostname of the SMU and its port
+    smu_host = (
+        "128.114.204.56"  # Replace with the actual IP address or hostname of the SMU
+    )
+    smu_port = 23  # Replace with the actual port used by the SMU
+
+    # Ping the SMU
+    if ping_smu(smu_host, smu_port):
+        print("SMU is reachable.")
+    else:
+        print("Failed to ping SMU.")