ents 2.3.4__py3-none-any.whl → 2.3.6__py3-none-any.whl

ents/simulator/node.py

@@ -10,6 +10,8 @@ from ..proto.encode import (
     encode_bme280_measurement,
 )
 
+from ..proto.sensor import encode_repeated_sensor_measurements
+
 
 class NodeSimulator:
     """Simulation class to simulate measurements for different sensors"""
@@ -159,3 +161,160 @@ class NodeSimulator:
             )
             self.measurements.append(meas)
             self.measurement_buffer.append(meas)
+
+
+class NodeSimulatorGeneric:
+    """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] = []
+    # all requests in format (headers, body)
+    requests: list[tuple[str, 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], _min=-1, _max=1, fn=sin
+    ):
+        """Initializes the simulation class.
+
+        Args:
+            cell: Cell ID of the node.
+            logger: Logger ID of the node.
+            sensors: List of sensors to simulate.
+            _min: Minimum value for the simulated sensor data.
+            _max: Maximum value for the simulated sensor data.
+            fn: Function to generate the simulated sensor data.
+        """
+
+        self.cell = cell
+        self.logger = logger
+        self.sensors = sensors
+        self.fn = fn
+        self._min = _min
+        self._max = _max
+
+    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.measurement_buffer.pop()
+        except IndexError as _:
+            return False
+
+        headers = {
+            "Content-Type": "application/octet-stream",
+            "SensorVersion": "2",
+        }
+        result = requests.post(url, data=meas, headers=headers)
+
+        # store result
+        self.requests.append((result.request.headers, result.request.body))
+        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
+        """
+
+        meas = {
+            "meta": {
+                "ts": ts,
+                "loggerId": self.logger,
+                "cellId": self.cell,
+            },
+            "measurements": [],
+        }
+
+        scale = (self._max - self._min) / 2
+        offset = (self._max + self._min) / 2
+
+        for s in self.sensors:
+            meas["measurements"].append(
+                {
+                    "type": s,
+                    "decimal": self.fn(ts) * scale + offset,
+                }
+            )
+
+        serialized = encode_repeated_sensor_measurements(meas)
+        self.measurements.append(serialized)
+        self.measurement_buffer.append(serialized)
+
+    def last_measurement(self) -> bytes:
+        """Gets the last encoded measurement.
+
+
+        Returns:
+            Last encoded measurement.
+        """
+
+        return self.measurements[-1]
+
+    def last_request(self) -> str:
+        """Gets the last sent request.
+
+        Returns:
+            Formatted headers and body.
+        """
+
+        headers = self.requests[-1][0]
+        body = self.requests[-1][1]
+        request_str = f"{headers}\n\n{body}"
+        return request_str
+
+    def last_response(self) -> str:
+        """Gets the last response.
+
+        Returns:
+            Response from server.
+        """
+
+        return self.responses[-1]

{ents-2.3.4.dist-info → ents-2.3.6.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ents
-Version: 2.3.4
+Version: 2.3.6
 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
@@ -12,7 +12,7 @@ Classifier: Programming Language :: Python :: 3
 Requires-Python: >=3.11
 Requires-Dist: matplotlib
 Requires-Dist: pandas
-Requires-Dist: protobuf==6.31.1
+Requires-Dist: protobuf==6.33.4
 Requires-Dist: pyserial
 Requires-Dist: requests
 Requires-Dist: scikit-learn
@@ -34,14 +34,14 @@ The soil power sensor protobuf protocol is implemented as a Python package that
 Use the following to install the `ents` package with gui via `pip`:
 
 ```bash
-pip install ents[gui]
+pip install ents
 ```
 
 You can also install the package from source with the following:
 
 ```bash
 # install package
-pip install .[gui]
+pip install .
 ```
 
 If you are planning to develop the package we recommend you install the package
@@ -51,114 +51,68 @@ reinstall it.
 
 ```bash
 # install development dependencies
-pip install -e .[gui,dev]
+pip install -e .[dev]
 ```
 
-## Usage
+To install the *deprecated* user config gui, use the following: =
+```bash
+pip install -e ents[gui]
+```
 
-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 = ...
+## Simulator (New)
 
-meas_dict = decode(data)
+The webserver `tools/http_decoder.py` can be used to decode uploaded measurements.
+
+### CLI Usage
+
+```
+usage: ents sim_generic [-h] [-v] [--url URL] --sensor SENSOR [SENSOR ...] [--min MIN] [--max MAX] --cell CELL --logger LOGGER [--start START] [--end END] [--freq FREQ] {batch,stream}
+
+positional arguments:
+  {batch,stream}        Upload mode
+
+options:
+  -h, --help            show this help message and exit
+  -v, --verbose         Print addiitional request information.
+  --url URL             URL of the dirtviz instance (default: http://localhost:8000)
+  --sensor SENSOR [SENSOR ...]
+                        Type of sensor to simulate
+  --min MIN             Minimum sensor value (default: -1.0)
+  --max MAX             Maximum sensor value (default: 1.0)
+  --cell CELL           Cell Id
+  --logger LOGGER       Logger Id
+
+Batch:
+  --start START         Start date
+  --end END             End date
+
+Stream:
+  --freq FREQ           Frequency of uploads (default: 10s)
+```
+
+### Examples
+
+You can find the available sensors in the `sensors.proto` file.
+
+Example uploading single measurement
+```
+ents sim_generic stream --sensor POWER_VOLTAGE --min 20 --max 30 --cell 1 --logger 1
+```
+
+Example uploading multiple measuremnets
+```
+ents sim_generic stream --sensor TEROS12_VWC_ADJ TEROS12_TEMP TEROS12_EC --min 10 --max 100 --cell 1 --logger 1
+```
+
+Example batch uploads
+```
+ents sim_generic batch --sensor POWER_CURRENT --cell 1 --logger 1 --start 2026-01-19 --end 2026-01-20 --freq 60
+```
 
-# 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
+## Simulator (Old)
 
 Simulate WiFi sensor uploads without requiring ENTS hardware.
 

ents-2.3.6.dist-info/RECORD

@@ -0,0 +1,30 @@
+ents/__init__.py,sha256=IVe193OL25_F5AMMx272iGabJ1e4jPVNLFAJDktA0oU,706
+ents/cli.py,sha256=pQQTnj0B-OwBnk3d8E4wY03EM9XVDcmolsBvK13nHqg,25029
+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=jTSaXUAKHSy_O6g1N7LJQxbZnpXIWZySuNxOKgx5xFo,18479
+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=evaM3Lb0IU_qFugEeRiXUCMiCUyEbtnRNTXayqE6Qig,39182
+ents/dirtviz/__init__.py,sha256=GLjair60tPxGePVmkifOnfDeMEryDe1HOwVXzOXGrBI,117
+ents/dirtviz/client.py,sha256=LukuhBWFt4n6Z__BbIlWPxaALSrrxaJkp_kS_pvHcxI,5629
+ents/dirtviz/plots.py,sha256=Op_sROjZow5b-eXWz1IQU-ZS8XulCvorbIW4pLWp2lY,982
+ents/proto/__init__.py,sha256=5THafGlxirjEUATIXB2EVpdOY5APEjztzOAHlRGNG2c,720
+ents/proto/decode.py,sha256=_dn9Agv41YgUtMVHZ7l5-Y13ci3hnjyXrRPGKDIHzvo,2964
+ents/proto/encode.py,sha256=kPAD5-bL6zNEjh6z1n1FusdM9z5UretypxHHAiuGGA4,7753
+ents/proto/esp32.py,sha256=4QOHZNH1SqkJg4TLvJgrAbhdJg88ZNtqoMNLBcWUX2U,4657
+ents/proto/sensor.py,sha256=zdZXG-TtX5kpSc6aETOywHApM8xLMY_J2OO8oBlEqU4,7148
+ents/proto/sensor_pb2.py,sha256=Kxe7ZMeaJwQbqv4MHWUK5_4LxTY8Ou1n1bXMDq4KfQ0,3673
+ents/proto/soil_power_sensor_pb2.py,sha256=r7lcuo8A3YW-vsiR7gT0dvG2UMdolpMe3r8kGfKx54U,13442
+ents/simulator/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+ents/simulator/node.py,sha256=I3NQXK4xipJKQNmRjsGrt1hUGFiS0US0WgrnXWLHsmI,8726
+ents-2.3.6.dist-info/METADATA,sha256=eVW-dnErw-JoWaAvatBeiH9SMD_HLBpt8mtUgnEuBWM,4956
+ents-2.3.6.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+ents-2.3.6.dist-info/entry_points.txt,sha256=1U6ViZDTy4vv1jFp5RisBPC0NFqmtV3f18eUnWKX0Nk,95
+ents-2.3.6.dist-info/licenses/LICENSE,sha256=2WLObzfS99jXXcPS5INqnmDVZ1nlO8Rj8mzQn2xkn14,1086
+ents-2.3.6.dist-info/RECORD,,

{ents-2.3.4.dist-info → ents-2.3.6.dist-info}/WHEEL

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

ents/demo/demoPullRequests.py

@@ -1,119 +0,0 @@
-import requests
-from datetime import datetime, timezone
-import pandas as pd
-from tabulate import tabulate
-
-
-class DirtVizClient:
-    BASE_URL = "https://dirtviz.jlab.ucsc.edu/api/"
-
-    def __init__(self):
-        self.session = requests.Session()
-
-    def cell_from_name(self, name, start=None, end=None):
-        """Get power data for a specific cell"""
-
-    def get_power_data(self, cell_id, start=None, end=None):
-        """Get power data for a specific cell"""
-        endpoint = f"power/{cell_id}"
-        params = {}
-
-        if start and end:
-            params = {
-                "startTime": start.strftime("%a, %d %b %Y %H:%M:%S GMT"),
-                "endTime": end.strftime("%a, %d %b %Y %H:%M:%S GMT"),
-            }
-
-        response = self.session.get(f"{self.BASE_URL}{endpoint}", params=params)
-        response.raise_for_status()
-        return response.json()
-
-
-def format_data_display(df, cell_id):
-    """Format the data output with timestamp as first column"""
-
-    # Ensure timestamp exists and is first column
-    if "timestamp" in df.columns:
-        cols = ["timestamp"] + [col for col in df.columns if col != "timestamp"]
-        df = df[cols]
-
-        # Format timestamp nicely
-        df["timestamp"] = pd.to_datetime(df["timestamp"])
-        df["timestamp"] = df["timestamp"].dt.strftime("%m-%d-%Y %H:%M:%S")
-
-    # Calculate statistics
-    stats = {
-        "Cell ID": cell_id,
-        "Time Range": (
-            f"{df['timestamp'].iloc[0]} to {df['timestamp'].iloc[-1]}"
-            if len(df) > 0
-            else "N/A"
-        ),
-        "Data Points": len(df),
-        "Avg Voltage (mV)": f"{df['v'].mean():.2f}" if "v" in df.columns else "N/A",
-        "Max Voltage (mV)": f"{df['v'].max():.2f}" if "v" in df.columns else "N/A",
-        "Avg Current (µA)": f"{df['i'].mean():.2f}" if "i" in df.columns else "N/A",
-        "Avg Power (µW)": f"{df['p'].mean():.2f}" if "p" in df.columns else "N/A",
-    }
-
-    column_rename = {
-        "timestamp": "Measurement Times",
-        "v": "Voltage (mV)",
-        "i": "Current (µA)",
-        "p": "Power (µW)",
-    }
-    # Apply renaming
-    df = df.rename(columns=column_rename)
-
-    # Display header
-    print("\n" + "=" * 60)
-    print(f"CELL {cell_id} POWER DATA SUMMARY".center(60))
-    for key, value in stats.items():
-        print(f"• {key:<20}: {value}")  # Display the summary information
-    print("=" * 60 + "\n")
-
-    # Display sample data with timestamp first
-    if len(df) > 0:
-        print("DATA BY TIMESTAMPS:")
-        print(
-            tabulate(
-                df,
-                headers="keys",
-                tablefmt="grid",  # Changed to grid for better column alignment
-                stralign="center",  # Right-align numbers
-                showindex=False,
-                numalign="center",
-            )
-        )
-    else:
-        print("No data available to display")
-
-    print("\n" + "=" * 80)
-
-
-if __name__ == "__main__":
-    client = DirtVizClient()
-
-    try:
-        cell_id = 893  # Figure out how to do by name on DirtViz
-        start = datetime(2025, 8, 12, tzinfo=timezone.utc)
-        end = datetime.now(timezone.utc)
-
-        print(f"\nFetching power data for cell {cell_id}...")
-        data = client.get_power_data(cell_id, start, end)
-
-        if data:
-            df = pd.DataFrame(data)
-            format_data_display(df, cell_id)
-
-            # Save to CSV with timestamp first
-            # df.to_csv(f"cell_{cell_id}_power_data.csv", index=False)
-            # print(f"Data saved to cell_{cell_id}_power_data.csv")
-        else:
-            print("No data received for the specified time range.")
-
-    except requests.exceptions.HTTPError as e:
-        print(f"\nHTTP Error: {e}")
-        print(f"Response: {e.response.text[:500]}...")
-    except Exception as e:
-        print(f"\n⚠️ Unexpected error: {str(e)}")

ents-2.3.4.dist-info/RECORD

@@ -1,26 +0,0 @@
-ents/__init__.py,sha256=KyqH3dz_BdFHWxD9n4DFItgsrxO7rDtt2IObWkdLsns,582
-ents/cli.py,sha256=O071Ot2u7yeMFZyoOY--hp4UepXOHEX2nNiiQ5TxpI4,16573
-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/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/demo/demoPullRequests.py,sha256=YSTVa59puMtER8sjOppiMshUCDjdsIikXLNOM0U6zmU,3864
-ents/proto/__init__.py,sha256=5THafGlxirjEUATIXB2EVpdOY5APEjztzOAHlRGNG2c,720
-ents/proto/decode.py,sha256=_dn9Agv41YgUtMVHZ7l5-Y13ci3hnjyXrRPGKDIHzvo,2964
-ents/proto/encode.py,sha256=kPAD5-bL6zNEjh6z1n1FusdM9z5UretypxHHAiuGGA4,7753
-ents/proto/esp32.py,sha256=4QOHZNH1SqkJg4TLvJgrAbhdJg88ZNtqoMNLBcWUX2U,4657
-ents/proto/soil_power_sensor_pb2.py,sha256=sNf-97udroXqmimooH0x1IWOTSm-4IoRsFzbyb9aLRg,9491
-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.4.dist-info/METADATA,sha256=FMxd6PnezpUeq3ZBVty08iRL-CzgVo5YTugULlzxHZ4,5258
-ents-2.3.4.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-ents-2.3.4.dist-info/entry_points.txt,sha256=1U6ViZDTy4vv1jFp5RisBPC0NFqmtV3f18eUnWKX0Nk,95
-ents-2.3.4.dist-info/licenses/LICENSE,sha256=2WLObzfS99jXXcPS5INqnmDVZ1nlO8Rj8mzQn2xkn14,1086
-ents-2.3.4.dist-info/RECORD,,