skutils 0.3.3__tar.gz → 0.4.0__tar.gz

{skutils-0.3.3 → skutils-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: skutils
-Version: 0.3.3
+Version: 0.4.0
 Summary: SkuTek Instrumentation utilities for control, orchestration, and data analysis using SkuTek products
 Author-email: SkuTek Instrumentation <support@skutek.com>
 Maintainer-email: Hugh Gallo <hugh@skutek.com>, Jeff Maggio <jeff@skutek.com>, SkuTek Instrumentation <support@skutek.com>

{skutils-0.3.3 → skutils-0.4.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 [project]
 license = "BSD-3-Clause"
 name = "skutils"
-version = "0.3.3"
+version = "0.4.0"
 requires-python = ">=3.9"
 authors = [{ name = "SkuTek Instrumentation", email = "support@skutek.com" }]
 maintainers = [

{skutils-0.3.3 → skutils-0.4.0}/src/skutils/ChickadeeController.py

@@ -251,7 +251,8 @@ class ChickadeeDspRemote(Namespace):
         #: url for setting/reading DSP signals
         self.control_url = hostname_or_ip + '/dsp/control'
         #: url for grabbing waveforms
-        self.wave_url    = hostname_or_ip + '/dsp/wavedata'
+        self.wave_url     = hostname_or_ip + '/dsp/wavedata'
+        self.spy_wave_url = hostname_or_ip + '/dsp/spy_wavedata'
         #: whether or not to automatically write to registers when 
         # :py:meth:`.close` is callsed
         self.auto_write_on_close = auto_write_on_close
@@ -330,6 +331,27 @@ class ChickadeeDspRemote(Namespace):
             wavedata = np.asarray(resp_data['wavedata'])
         return wavedata
 
+    # _________________________________________________________________________
+    def read_spy_wave(self, channel:Union[int,Literal['all']], as_binary=True):
+        """Reads the SPY waveform for the specified channel as a numpy array
+        
+        This returns the waveform "as is" currently in the FPGA buffer. User
+        is responsible for checking if event capture is ongoing. Check your Chickadee
+        manual for details.
+
+        :param channel: desired channel waveform
+        :param as_binary: True to read the wavedata as b64 encoded string, False to use a json list
+        """
+        url = self.spy_wave_url + f'/{channel}'        
+        payload = {'waveform_as_base64':as_binary}
+        resp = requests.get(url, json=payload)
+        resp_data = resp.json()
+        if resp_data['waveform_as_base64']:
+            wavedata = pickle.loads( base64.standard_b64decode(resp_data['wavedata'].encode('utf-8')) )
+        else:
+            wavedata = np.asarray(resp_data['wavedata'])
+        return wavedata
+
     # _________________________________________________________________________
     def read_all_waves(self, num_waveform_samples:Optional[int]=None, as_binary=True):
         """Reads the waveforms for all channels as 2D numpy array. 
@@ -565,6 +587,26 @@ class ChickadeeController:
             raise RuntimeError("The server failed to return a bool for adc_firmware_invert!")
         return bool_val
 
+    # _________________________________________________________________________
+    def arbitrary_reg_read(self, reg_address: int) -> int:
+        req = requests.post(self.address + "/sw_api/arbitrary_reg_read", json={"reg_address": reg_address})
+        self.__report_json_error(req)
+        json_block = req.json()
+        int_val = json_block["read_value"]
+        if not isinstance(int_val, int):
+            raise RuntimeError("The server failed to return an int for read_value!")
+        return int_val
+
+    # _________________________________________________________________________
+    def arbitrary_reg_write_with_readback(self, reg_address: int, value: int) -> int:
+        req = requests.post(self.address + "/sw_api/arbitrary_reg_write_with_readback", json={"reg_address": reg_address, "value": value})
+        self.__report_json_error(req)
+        json_block = req.json()
+        int_val = json_block["readback_value"]
+        if not isinstance(int_val, int):
+            raise RuntimeError("The server failed to return an int for readback_value!")
+        return int_val
+
     # _________________________________________________________________________
     @property
     def address(self) -> str:

{skutils-0.3.3 → skutils-0.4.0}/src/skutils/FemtoDAQController.py

@@ -293,6 +293,36 @@ class FemtoDAQController:
         data = {f"enable": enable, "force": force}
         self.__post(route, data)
 
+    # _________________________________________________________________________
+    # TriggerType
+    def getTriggerType(self) -> str:
+        """
+        Get what type of trigger is currently set for the digitizer.
+        "diff_smooth" is the default trigger for Vireo: a differential trigger that can be (optionally) smoothed by Trigger Averaging
+        "simple" is a threshold trigger on the digitally-offset ADC samples only.
+        """
+        route = self.__config_url("global", "TriggerType")
+        resp = self.__get(route)
+        return str(resp["data"])
+
+    def setTriggerType(
+        self,
+        trg_type: Union[Union[Literal["diff_smooth"], Literal["simple"]], int],
+        force: bool = False,
+    ):
+        """
+        Set what type of trigger is currently used on the digitizer.
+
+        :param trg_type: "diff_smooth" is the default trigger for Vireo: a differential trigger that can be (optionally) smoothed by Trigger Averaging. "simple" is a threshold trigger on the digitally-offset ADC samples only.
+        :param force: apply change even if data collection is ongoing.
+        """
+        route = self.__config_url("global", "TriggerType")
+        data: Dict[str, Any] = {
+            f"trg_type": trg_type,
+            "force": force,
+        }
+        self.__post(route, data)
+
     # _________________________________________________________________________
     # TriggerEdge
     def getTriggerEdge(self, channel: int) -> str:

{skutils-0.3.3 → skutils-0.4.0}/src/skutils/constants.py

@@ -2,7 +2,7 @@ from collections import namedtuple
 from struct import Struct
 import bitstruct
 
-__min_femtodaq_version__ = "6.0.0"
+__min_femtodaq_version__ = "6.2.0"
 
 FEMTODAQ_USB = "192.168.7.2"
 

{skutils-0.3.3 → skutils-0.4.0}/src/skutils.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: skutils
-Version: 0.3.3
+Version: 0.4.0
 Summary: SkuTek Instrumentation utilities for control, orchestration, and data analysis using SkuTek products
 Author-email: SkuTek Instrumentation <support@skutek.com>
 Maintainer-email: Hugh Gallo <hugh@skutek.com>, Jeff Maggio <jeff@skutek.com>, SkuTek Instrumentation <support@skutek.com>