ents 2.3.4__tar.gz → 2.3.6__tar.gz

{ents-2.3.4 → ents-2.3.6}/PKG-INFO

@@ -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.4 → ents-2.3.6}/README.md

@@ -8,14 +8,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
@@ -25,114 +25,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.4 → ents-2.3.6}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "ents"
-version = "2.3.4"
+version = "2.3.6"
 authors = [
   { name="John Madden", email="jmadden173@pm.me" },
 ]
@@ -17,7 +17,7 @@ classifiers = [
   "Operating System :: OS Independent",
 ]
 dependencies = [
-  'protobuf==6.31.1',
+  'protobuf==6.33.4',
   'matplotlib',
   'pandas',
   'pyserial',

{ents-2.3.4 → ents-2.3.6}/src/ents/__init__.py

@@ -3,10 +3,11 @@ from .proto.encode import (
     encode_power_measurement,
     encode_teros12_measurement,
     encode_phytos31_measurement,
+    encode_user_configuration,
     encode_bme280_measurement,
 )
 
-from .proto.decode import decode_response, decode_measurement
+from .proto.decode import decode_response, decode_measurement, decode_user_configuration
 
 from .proto.esp32 import encode_esp32command, decode_esp32command
 
@@ -20,4 +21,6 @@ __all__ = [
     "decode_measurement",
     "encode_esp32command",
     "decode_esp32command",
+    "encode_user_configuration",
+    "decode_user_configuration",
 ]

{ents-2.3.4 → ents-2.3.6}/src/ents/calibrate/recorder.py

@@ -16,7 +16,7 @@ import socket
 import serial
 from typing import Tuple
 from tqdm import tqdm
-from ..proto import decode_measurement
+from ..proto.sensor import decode_repeated_sensor_measurements
 
 
 class SerialController:
@@ -116,10 +116,10 @@ class SoilPowerSensorController(SerialController):
 
         reply = self.ser.read(resp_len)  # read said measurment
 
-        meas_dict = decode_measurement(reply)  # decode using protobuf
+        meas_dict = decode_repeated_sensor_measurements(reply)  # decode using protobuf
 
-        voltage_value = meas_dict["data"]["voltage"]
-        current_value = meas_dict["data"]["current"]
+        voltage_value = meas_dict["measurements"][0]["decimal"]
+        current_value = meas_dict["measurements"][1]["decimal"]
 
         return float(voltage_value), float(current_value)