slm_open_api_package 0.2.10__tar.gz

slm_open_api_package-0.2.10/PKG-INFO

@@ -0,0 +1,206 @@
+Metadata-Version: 2.3
+Name: slm_open_api_package
+Version: 0.2.10
+Summary: Add your description here
+Author: Sofus Vingaard
+Author-email: Sofus Vingaard <sofus.krebsvingaard@hbkworld.com>
+Requires-Dist: requests
+Requires-Dist: numpy
+Requires-Dist: websockets
+Requires-Dist: kaitaistruct
+Requires-Dist: packaging
+Requires-Dist: pyqtgraph
+Requires-Dist: pyqt5
+Requires-Dist: pyqt5-qt5<5.15.11
+Requires-Dist: miniaudio
+Requires-Dist: matplotlib>=3.11.1
+Requires-Dist: cryptography>=50.0.1
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+
+# SLM Open API Package
+
+Python helpers for streaming measurements and audio from an HBK sound level meter (SLM) through WebXi.
+
+This PyPI package is made for the [Open Interface for Sound Level Meter](https://github.com/hbkworld/Open-Interface-for-Sound-Level-Meter) repository. Refer to that repository for more detailed usage information and additional examples.
+
+
+
+## Install
+
+```powershell
+pip install slm_open_api_package
+```
+
+Or add it to an `uv` project:
+
+```powershell
+uv add slm_open_api_package
+```
+
+The package requires Python 3.12 or newer and a network connection to a compatible SLM.
+
+## Connect To A Device
+
+Give every stream one `host`, either an IP address or host name:
+
+```python
+host = "192.168.1.183"
+```
+
+The bundled examples use `set_host()` to read a host from a local `slm_ip` file. If the file is missing, it prompts once and creates it:
+
+```python
+from slm_api.helpers import webxi_helper_functions as webxi_helper
+
+host = webxi_helper.set_host(__file__)
+```
+
+## Basic Leq Stream
+
+`WebXiStreamHandler` is the main API. `mode="leq"` is the default and streams one sequence selected by `sequenceID`.
+
+```python
+from slm_api.enums.sequence_id_enum import SequenceIdEnums
+from slm_api.helpers.stream_handlers import WebXiStreamHandler
+
+streamer = WebXiStreamHandler(
+	host="192.168.1.183",
+	sequenceID=SequenceIdEnums.LAeq.value,
+	mode="leq",
+	saving="csv",
+	saving_path="saved_data/laeq",
+)
+
+try:
+	streamer.startStream()
+except KeyboardInterrupt:
+	streamer.stopStream()
+```
+
+`stopStream()` stops the measurement, removes the device stream, and writes buffered saved data. Supported saving formats are `"csv"`, `"json"`, and `"pickle"`; their extensions are added automatically.
+
+## Multiple Sequences
+
+Based on [example_multi.py](src/slm_api/example_multi.py), use `mode="multi"` for several enabled broadband sequences in a single stream:
+
+```python
+from slm_api.helpers.data_handler import DataHandler
+from slm_api.helpers.stream_handlers import WebXiStreamHandler
+
+
+class PrintHandler(DataHandler):
+	def handle(self, *, host, name, value, **data):
+		print(f"{host} {name}: {value}")
+
+
+streamer = WebXiStreamHandler(
+	host="192.168.1.183",
+	sequenceNames=["LAeq", "LCeq", "LAF"],
+	mode="multi",
+	saving="json",
+	saving_path="saved_data/broadband",
+)
+streamer.setDataHandler(PrintHandler())
+
+try:
+	streamer.startStream()
+except KeyboardInterrupt:
+	streamer.stopStream()
+```
+
+Enable the requested sequences and frequency weightings on the SLM before starting the stream. Each `DataHandler.handle()` call receives the source `host`, `name`, and `value`. The `saving=` handler continues saving when a custom handler is attached.
+
+## Fast Logging
+
+Based on [fast_log_example.py](src/slm_api/fast_log_example.py), use `mode="fast_logging"` for fast broadband samples:
+
+```python
+from slm_api.enums.fast_log_intervals_enum import FastLogInterval
+from slm_api.enums.sequence_id_enum import SequenceIdEnums
+from slm_api.helpers.stream_handlers import WebXiStreamHandler
+
+streamer = WebXiStreamHandler(
+	host="192.168.1.183",
+	sequenceID=SequenceIdEnums.FastLAF.value,
+	mode="fast_logging",
+	fast_logging_interval=FastLogInterval.interval_1000ms.value,
+	saving="csv",
+	saving_path="saved_data/fast_laf",
+)
+
+try:
+	streamer.startStream()
+except KeyboardInterrupt:
+	streamer.stopStream()
+```
+
+## Audio
+
+Use the MP3 or FLAC examples for decoded audio samples:
+
+```python
+from slm_api.enums.sequence_id_enum import SequenceIdEnums
+from slm_api.helpers.stream_handlers import WebXiStreamHandler
+
+streamer = WebXiStreamHandler(
+	host="192.168.1.183",
+	sequenceID=SequenceIdEnums.MP3Signal.value,
+	mode="mp3",
+)
+```
+
+The matching `flac` form uses `SequenceIdEnums.FLACSignal.value` and `mode="flac"`. Audio setup is enabled by the handler. The SLM can take a few seconds to initialize audio recording when its quality setting changes.
+
+## Synchronized Multi-Device Stream
+
+Based on [multi_device_flac.py](src/slm_api/multi_device_flac.py), pass `multi_device=True` and start/stop the group through the synchronized helpers:
+
+```python
+from slm_api.enums.sequence_id_enum import SequenceIdEnums
+from slm_api.helpers.stream_handlers import WebXiStreamHandler, start_all_synced, stop_all
+
+hosts = ["192.168.1.183", "192.168.1.216"]
+streams = [
+	WebXiStreamHandler(
+		host=host,
+		sequenceID=SequenceIdEnums.MP3Signal.value,
+		mode="mp3",
+		streamName=f"Audio_{host}",
+		multi_device=True,
+		saving="csv",
+		saving_path=f"saved_data/{host}",
+	)
+	for host in hosts
+]
+
+start_all_synced(streams)
+
+try:
+    while True:
+        time.sleep(1)
+except KeyboardInterrupt:
+    stop_all(streams)
+```
+
+`stop_all()` synchronizes the device measurement stops, flushes saving handlers, and removes each device stream.
+
+## Modes
+
+| Mode | Use |
+| --- | --- |
+| `"leq"` | One broadband sequence; this is the default. |
+| `"multi"` | Several named broadband sequences. |
+| `"cpb"` | Constant-percentage-band data. |
+| `"fast_logging"` | Fast broadband samples. |
+| `"flac"` / `"mp3"` | Decoded audio samples. |
+| `"screen_record"` | Latest SLM screen image in `streamer.image_bytes`. |
+
+Legacy flags such as `mp3=True` remain supported, but `mode=` is preferred. Only select one mode per stream.
+```
+
+## Troubleshooting
+
+- **No values arrive:** Confirm the requested sequences are enabled on the SLM.
+- **Audio returns no samples after first enable:** Allow the SLM a few seconds to initialize audio recording before retrying.
+- **Saved file is missing:** Call `stopStream()` or `stop_all()`; buffered files are written during shutdown.

slm_open_api_package-0.2.10/README.md

@@ -0,0 +1,186 @@
+# SLM Open API Package
+
+Python helpers for streaming measurements and audio from an HBK sound level meter (SLM) through WebXi.
+
+This PyPI package is made for the [Open Interface for Sound Level Meter](https://github.com/hbkworld/Open-Interface-for-Sound-Level-Meter) repository. Refer to that repository for more detailed usage information and additional examples.
+
+
+
+## Install
+
+```powershell
+pip install slm_open_api_package
+```
+
+Or add it to an `uv` project:
+
+```powershell
+uv add slm_open_api_package
+```
+
+The package requires Python 3.12 or newer and a network connection to a compatible SLM.
+
+## Connect To A Device
+
+Give every stream one `host`, either an IP address or host name:
+
+```python
+host = "192.168.1.183"
+```
+
+The bundled examples use `set_host()` to read a host from a local `slm_ip` file. If the file is missing, it prompts once and creates it:
+
+```python
+from slm_api.helpers import webxi_helper_functions as webxi_helper
+
+host = webxi_helper.set_host(__file__)
+```
+
+## Basic Leq Stream
+
+`WebXiStreamHandler` is the main API. `mode="leq"` is the default and streams one sequence selected by `sequenceID`.
+
+```python
+from slm_api.enums.sequence_id_enum import SequenceIdEnums
+from slm_api.helpers.stream_handlers import WebXiStreamHandler
+
+streamer = WebXiStreamHandler(
+	host="192.168.1.183",
+	sequenceID=SequenceIdEnums.LAeq.value,
+	mode="leq",
+	saving="csv",
+	saving_path="saved_data/laeq",
+)
+
+try:
+	streamer.startStream()
+except KeyboardInterrupt:
+	streamer.stopStream()
+```
+
+`stopStream()` stops the measurement, removes the device stream, and writes buffered saved data. Supported saving formats are `"csv"`, `"json"`, and `"pickle"`; their extensions are added automatically.
+
+## Multiple Sequences
+
+Based on [example_multi.py](src/slm_api/example_multi.py), use `mode="multi"` for several enabled broadband sequences in a single stream:
+
+```python
+from slm_api.helpers.data_handler import DataHandler
+from slm_api.helpers.stream_handlers import WebXiStreamHandler
+
+
+class PrintHandler(DataHandler):
+	def handle(self, *, host, name, value, **data):
+		print(f"{host} {name}: {value}")
+
+
+streamer = WebXiStreamHandler(
+	host="192.168.1.183",
+	sequenceNames=["LAeq", "LCeq", "LAF"],
+	mode="multi",
+	saving="json",
+	saving_path="saved_data/broadband",
+)
+streamer.setDataHandler(PrintHandler())
+
+try:
+	streamer.startStream()
+except KeyboardInterrupt:
+	streamer.stopStream()
+```
+
+Enable the requested sequences and frequency weightings on the SLM before starting the stream. Each `DataHandler.handle()` call receives the source `host`, `name`, and `value`. The `saving=` handler continues saving when a custom handler is attached.
+
+## Fast Logging
+
+Based on [fast_log_example.py](src/slm_api/fast_log_example.py), use `mode="fast_logging"` for fast broadband samples:
+
+```python
+from slm_api.enums.fast_log_intervals_enum import FastLogInterval
+from slm_api.enums.sequence_id_enum import SequenceIdEnums
+from slm_api.helpers.stream_handlers import WebXiStreamHandler
+
+streamer = WebXiStreamHandler(
+	host="192.168.1.183",
+	sequenceID=SequenceIdEnums.FastLAF.value,
+	mode="fast_logging",
+	fast_logging_interval=FastLogInterval.interval_1000ms.value,
+	saving="csv",
+	saving_path="saved_data/fast_laf",
+)
+
+try:
+	streamer.startStream()
+except KeyboardInterrupt:
+	streamer.stopStream()
+```
+
+## Audio
+
+Use the MP3 or FLAC examples for decoded audio samples:
+
+```python
+from slm_api.enums.sequence_id_enum import SequenceIdEnums
+from slm_api.helpers.stream_handlers import WebXiStreamHandler
+
+streamer = WebXiStreamHandler(
+	host="192.168.1.183",
+	sequenceID=SequenceIdEnums.MP3Signal.value,
+	mode="mp3",
+)
+```
+
+The matching `flac` form uses `SequenceIdEnums.FLACSignal.value` and `mode="flac"`. Audio setup is enabled by the handler. The SLM can take a few seconds to initialize audio recording when its quality setting changes.
+
+## Synchronized Multi-Device Stream
+
+Based on [multi_device_flac.py](src/slm_api/multi_device_flac.py), pass `multi_device=True` and start/stop the group through the synchronized helpers:
+
+```python
+from slm_api.enums.sequence_id_enum import SequenceIdEnums
+from slm_api.helpers.stream_handlers import WebXiStreamHandler, start_all_synced, stop_all
+
+hosts = ["192.168.1.183", "192.168.1.216"]
+streams = [
+	WebXiStreamHandler(
+		host=host,
+		sequenceID=SequenceIdEnums.MP3Signal.value,
+		mode="mp3",
+		streamName=f"Audio_{host}",
+		multi_device=True,
+		saving="csv",
+		saving_path=f"saved_data/{host}",
+	)
+	for host in hosts
+]
+
+start_all_synced(streams)
+
+try:
+    while True:
+        time.sleep(1)
+except KeyboardInterrupt:
+    stop_all(streams)
+```
+
+`stop_all()` synchronizes the device measurement stops, flushes saving handlers, and removes each device stream.
+
+## Modes
+
+| Mode | Use |
+| --- | --- |
+| `"leq"` | One broadband sequence; this is the default. |
+| `"multi"` | Several named broadband sequences. |
+| `"cpb"` | Constant-percentage-band data. |
+| `"fast_logging"` | Fast broadband samples. |
+| `"flac"` / `"mp3"` | Decoded audio samples. |
+| `"screen_record"` | Latest SLM screen image in `streamer.image_bytes`. |
+
+Legacy flags such as `mp3=True` remain supported, but `mode=` is preferred. Only select one mode per stream.
+```
+
+## Troubleshooting
+
+- **No values arrive:** Confirm the requested sequences are enabled on the SLM.
+- **Audio returns no samples after first enable:** Allow the SLM a few seconds to initialize audio recording before retrying.
+- **Saved file is missing:** Call `stopStream()` or `stop_all()`; buffered files are written during shutdown.

slm_open_api_package-0.2.10/pyproject.toml

@@ -0,0 +1,33 @@
+[project]
+name = "slm_open_api_package"
+version = "0.2.10"
+description = "Add your description here"
+readme = "README.md"
+requires-python = ">=3.12"
+dependencies = [
+    "requests",
+    "numpy",
+    "websockets",
+    "kaitaistruct",
+    "packaging",
+    "pyqtgraph",
+    "PyQt5",
+    "PyQt5-Qt5<5.15.11",
+    "miniaudio",
+    "matplotlib>=3.11.1",
+    "cryptography>=50.0.1",
+]
+
+[[project.authors]]
+name = "Sofus Vingaard"
+email = "sofus.krebsvingaard@hbkworld.com"
+
+[project.scripts]
+open-api-package = "slm_api:main"
+
+[tool.uv.build-backend]
+module-name = "slm_api"
+
+[build-system]
+requires = ["uv_build>=0.12.5,<0.13.0"]
+build-backend = "uv_build"

slm_open_api_package-0.2.10/pyproject.toml.orig

@@ -0,0 +1,32 @@
+[project]
+name = "slm_open_api_package"
+version = "0.2.10"
+description = "Add your description here"
+readme = "README.md"
+authors = [
+    { name = "Sofus Vingaard", email = "sofus.krebsvingaard@hbkworld.com" }
+]
+requires-python = ">=3.12"
+dependencies = [
+    "requests",
+    "numpy",
+    "websockets",
+    "kaitaistruct",
+    "packaging",
+    "pyqtgraph",
+    "PyQt5",
+    "PyQt5-Qt5<5.15.11",
+    "miniaudio",
+    "matplotlib>=3.11.1",
+    "cryptography>=50.0.1",
+]
+
+[project.scripts]
+open-api-package = "slm_api:main"
+
+[tool.uv.build-backend]
+module-name = "slm_api"
+
+[build-system]
+requires = ["uv_build>=0.12.5,<0.13.0"]
+build-backend = "uv_build"

slm_open_api_package-0.2.10/src/slm_api/CPB_example.py

@@ -0,0 +1,74 @@
+import threading
+import numpy as np
+import matplotlib.pyplot as plt
+from matplotlib.animation import FuncAnimation
+
+from slm_api.helpers.stream_handlers import WebXiStreamHandler
+from slm_api.helpers import webxi_helper_functions as webxi_helper 
+from slm_api.enums.sequence_id_enum import SequenceIdEnums
+from slm_api.helpers.data_handler import CsvDataHandler,PickleDataHandler,JsonDataHandler,MultiDataHandler, DataHandler
+
+
+host = webxi_helper.set_host(__file__)
+# sequence_names = ["LAeq"]
+cpb_sequence_names = ["CPBLAeq"]
+
+
+sequenceID= SequenceIdEnums.CPBLAeq.value   
+
+class PrintHandler(DataHandler):
+    def handle(self, value, **data ):
+        print(f"{value}")
+
+
+class FigureHandler:
+    
+    def __init__(self, dataHandler):
+        self.dataHandler = dataHandler
+        self.fig, self.ax = plt.subplots(1,1, figsize=(10,5))
+        self.CPBFreq = dataHandler.calcFreqBands()
+        self.freq = [(i.replace("000.0","k")).replace(".0", "") for i in [str(i) for i in self.CPBFreq]]
+        self.ln = self.ax.bar(self.freq, np.zeros(len(self.freq)), width=.99)
+        self.ax.set_ylim(bottom=-20, top=120)
+        self.ax.grid(axis='y')
+        self.ax.set_ylabel("dB [SPL]")
+        self.ax.set_xlabel("Frequency band [Hz]")
+        self.fig.autofmt_xdate()
+        self.fig.tight_layout()
+        self.fig.canvas.mpl_connect('close_event', on_close)
+
+    def _update(self, i): 
+        for rect, h in zip(self.ln.patches, self.dataHandler.CPB_values):
+            rect.set_height(h)
+
+    def startAnimation(self):
+        self.ani = FuncAnimation(self.fig, self._update, interval=1000) 
+
+def on_close(event):
+    streamer.stopStream()
+    streamer.data_handler.close()
+
+
+if __name__ == "__main__":
+    # turns off all CPB freq weights
+    webxi_helper.turn_off_CPB_freq_weight(host)
+
+    # turns on the CPB freq weight we want to use, in this case A weight
+    webxi_helper.turn_on_CPB_freq_weight(host, ["A"])
+
+    # turns on the CPB eq we want to use
+    webxi_helper.turn_on_cpb_leq(host, cpb_sequence_names)
+
+    streamer = WebXiStreamHandler(host,
+                                  sequenceID=sequenceID, 
+                                  mode="cpb",
+                                  sequenceNames=cpb_sequence_names, 
+                                  saving_path=r"./saved_data/test_file",
+                                  saving="json")
+    # streamer.setDataHandler(JsonDataHandler(r"C:\Users\SKREBSVINGAA\csv_test\csv_test.txt"))
+    streamer.setDataHandler(PrintHandler())
+    
+    fig = FigureHandler(streamer)
+    threading.Thread(target=streamer.startStream, daemon=True).start()
+    fig.startAnimation()
+    plt.show()

slm_open_api_package-0.2.10/src/slm_api/__init__.py

@@ -0,0 +1,5 @@
+"""Top-level package for slm_api (submodules are not auto-imported)."""
+
+
+def main() -> None:
+    print("Hello from open-api-package!")

slm_open_api_package-0.2.10/src/slm_api/enums/fast_log_intervals_enum.py

@@ -0,0 +1,16 @@
+from enum import Enum
+
+class FastLogInterval(Enum):
+    """ControlBBFastLoggingInterval enum indices (member value = device index, name = ms/sample)."""
+    interval_1ms = 0
+    interval_2ms = 1
+    interval_4ms = 2
+    interval_8ms = 3
+    interval_16ms = 4
+    interval_32ms = 5
+    interval_63ms = 6
+    interval_125ms = 7
+    interval_250ms = 8
+    interval_500ms = 9
+    interval_1000ms = 10
+