ents 2.3.2__py3-none-any.whl

ents/simulator/node.py

@@ -0,0 +1,161 @@
+from math import sin
+
+import requests
+import numpy as np
+
+from ..proto.encode import (
+    encode_power_measurement,
+    encode_teros12_measurement,
+    encode_teros21_measurement,
+    encode_bme280_measurement,
+)
+
+
+class NodeSimulator:
+    """Simulation class to simulate measurements for different sensors"""
+
+    # temporary storage for measurements to be uploaded
+    measurement_buffer: list[bytes] = []
+    # all measurements uploaded
+    measurements: list[bytes] = []
+    # all responses
+    responses: list[str] = []
+
+    # metrics for uploads
+    metrics: dict[str, int] = {
+        "total_requests": 0,
+        "failed_requests": 0,
+        "successful_requests": 0,
+    }
+
+    latency: list[float] = []
+
+    def __init__(self, cell: int, logger: int, sensors: list[str], fn=sin):
+        self.cell = cell
+        self.logger = logger
+        self.sensors = sensors
+        self.fn = fn
+
+    def __str__(self):
+        """String representation of the simulation class
+
+        Shows the current upload metrics
+        """
+        avg = np.array(self.latency).mean()
+
+        last = 0
+        if len(self.latency) > 0:
+            last = self.latency[-1]
+
+        return "total: {}, failed: {}, avg (ms): {}, last (ms): {}".format(
+            self.metrics["total_requests"],
+            self.metrics["failed_requests"],
+            avg * 100,
+            last * 100,
+        )
+
+    def send_next(self, url: str) -> bool:
+        """Sends measurements to a dirtviz instance
+
+        Args:
+            url: URL of the dirtviz instance
+
+        Returns:
+            True if there are measurements to send, False otherwise
+        """
+
+        # get next measurement
+        try:
+            meas = self.measurements.pop()
+        except IndexError as _:
+            return False
+
+        headers = {"Content-Type": "application/octet-stream"}
+        result = requests.post(url, data=meas, headers=headers)
+
+        # store result
+        self.responses.append(result.text)
+        self.metrics["total_requests"] += 1
+        if result.status_code == 200:
+            self.metrics["successful_requests"] += 1
+        else:
+            self.metrics["failed_requests"] += 1
+        self.latency.append(result.elapsed.total_seconds())
+
+        return True
+
+    def measure(self, ts: int):
+        """Simulate measurements
+
+        Args:
+            ts: Timestamp of the measurement
+
+        Returns:
+            None
+        """
+
+        if "power" in self.sensors:
+
+            voltage = self.fn(ts) * 2
+            current = self.fn(ts) * 0.5
+
+            meas = encode_power_measurement(
+                ts=ts,
+                cell_id=self.cell,
+                logger_id=self.logger,
+                voltage=voltage,
+                current=current,
+            )
+            self.measurements.append(meas)
+            self.measurement_buffer.append(meas)
+
+        if "teros12" in self.sensors:
+
+            vwc_raw = self.fn(ts) * 300 + 2500
+            vwc_adj = self.fn(ts) * 0.05 + 0.2
+            temp = self.fn(ts) * 5 + 25
+            ec = self.fn(ts) * 4 + 15
+
+            meas = encode_teros12_measurement(
+                ts=ts,
+                cell_id=self.cell,
+                logger_id=self.logger,
+                vwc_raw=vwc_raw,
+                vwc_adj=vwc_adj,
+                temp=temp,
+                ec=int(ec),
+            )
+            self.measurements.append(meas)
+            self.measurement_buffer.append(meas)
+
+        if "teros21" in self.sensors:
+
+            matric_pot = self.fn(ts) * 200 + 1000
+            temp = self.fn(ts) * 5 + 25
+
+            meas = encode_teros21_measurement(
+                ts=ts,
+                cell_id=self.cell,
+                logger_id=self.logger,
+                matric_pot=matric_pot,
+                temp=temp,
+            )
+            self.measurements.append(meas)
+            self.measurement_buffer.append(meas)
+
+        if "bme280" in self.sensors:
+
+            temp = self.fn(ts) * 50 + 250
+            humidity = self.fn(ts) * 200 + 2000
+            pressure = self.fn(ts) * 2000 + 43000
+
+            meas = encode_bme280_measurement(
+                ts=ts,
+                cell_id=self.cell,
+                logger_id=self.logger,
+                temperature=int(temp),
+                humidity=int(humidity),
+                pressure=int(pressure),
+            )
+            self.measurements.append(meas)
+            self.measurement_buffer.append(meas)

ents-2.3.2.dist-info/METADATA

@@ -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.dist-info/RECORD

@@ -0,0 +1,26 @@
+ents/__init__.py,sha256=KyqH3dz_BdFHWxD9n4DFItgsrxO7rDtt2IObWkdLsns,582
+ents/cli.py,sha256=QhH7ZQtpEEfM9pyF3SrpfHVPw5IMbLZSIe6ng9C4y_c,16570
+ents/calibrate/PingSMU.py,sha256=1iXozKaPE0ucgB3qsTI5mVk__n6pqC8Z2nV_GRfU2gA,1253
+ents/calibrate/PingSPS.py,sha256=pNQN1ngWQ2Z7Q1DoWCIe4DN02hZfNOrKpLH7I0bAd8U,1876
+ents/calibrate/README.md,sha256=ctdpfS5tN-PnDBn8sCTAn4gi0E-ZLUDXYnLZuqleDmM,109
+ents/calibrate/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+ents/calibrate/linear_regression.py,sha256=U-m55mRn-kMj9m-lP-YsbVwIU5ZuA8PiHfNiibefokY,1717
+ents/calibrate/plots.py,sha256=RmuvyL_oTxA4oMNqDR5k82XelvF6whRfYKXNmFbeYeo,2411
+ents/calibrate/recorder.py,sha256=fce5cW2DiCSOMQ-CSRL7raghbR2Yeg8Nx9obyY-0yOg,18416
+ents/calibrate/requirements.txt,sha256=zgyk2vKGVKLGatxI_q9Eik4JIOdtTAc6Gkuo-E7zbRI,87
+ents/config/README.md,sha256=SRtr5YuM64MSZQdy60F8Ib_AI2MR-MbbAdjS3jcjVD4,4447
+ents/config/__init__.py,sha256=3eyHUKg-ZPx82h2CGiNyzaaI7Y7koEOUX9pzrlnVcJw,51
+ents/config/adv_trace.py,sha256=hEDBNbVslJ2lJ-8tfJhPXxQMZN9Nylqv8RK42waRhsM,1290
+ents/config/user_config.py,sha256=SAudV12wyE-5Z0weZJQzBELRXR3-oevIgbrimUF2TmI,39198
+ents/proto/__init__.py,sha256=5THafGlxirjEUATIXB2EVpdOY5APEjztzOAHlRGNG2c,720
+ents/proto/decode.py,sha256=rVnfCBYK637EXYj9FJBOGUSDRQ0xVrqAo7ZHyNRcCCk,2864
+ents/proto/encode.py,sha256=kPAD5-bL6zNEjh6z1n1FusdM9z5UretypxHHAiuGGA4,7753
+ents/proto/esp32.py,sha256=4QOHZNH1SqkJg4TLvJgrAbhdJg88ZNtqoMNLBcWUX2U,4657
+ents/proto/soil_power_sensor_pb2.py,sha256=63Wthg0WROwYX6gkTYsHmY2KZYkPmv_Q6Jjkjcb4ZB4,6729
+ents/simulator/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+ents/simulator/node.py,sha256=vDdt_Q2BiEo1Z-aMZnm9_Y-aAtPU_lhcWW-xSDYR54c,4444
+ents-2.3.2.dist-info/METADATA,sha256=kYwyrbAbaLcxzxOGaP7_USrNQsWDsaJnmdg3EnzeRbA,5256
+ents-2.3.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+ents-2.3.2.dist-info/entry_points.txt,sha256=1U6ViZDTy4vv1jFp5RisBPC0NFqmtV3f18eUnWKX0Nk,95
+ents-2.3.2.dist-info/licenses/LICENSE,sha256=2WLObzfS99jXXcPS5INqnmDVZ1nlO8Rj8mzQn2xkn14,1086
+ents-2.3.2.dist-info/RECORD,,

ents-2.3.2.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.27.0
+Root-Is-Purelib: true
+Tag: py3-none-any

ents-2.3.2.dist-info/entry_points.txt

@@ -0,0 +1,5 @@
+[console_scripts]
+ents = ents.cli:entry
+
+[gui_scripts]
+ents-gui = ents.config.user_config:main

ents-2.3.2.dist-info/licenses/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.