horiba-sdk 0.4.0__py3-none-any.whl → 0.5.4__py3-none-any.whl

horiba_sdk/__init__.py

@@ -1,6 +1,8 @@
 # mypy: disable-error-code="attr-defined"
 """'horiba-sdk' is a package that provides source code for the development with Horiba devices"""
 
+from loguru import logger
+
 __version__ = '0.2.0'  # It MUST match the version in pyproject.toml file
 from importlib import metadata as importlib_metadata
 
@@ -13,3 +15,7 @@ def get_version() -> str:
 
 
 version: str = get_version()
+
+# it is good practice to disable the logging for a library, this is done here.
+# on initialization of a device manager, this can be enabled.
+logger.disable(__name__)

horiba_sdk/communication/websocket_communicator.py

@@ -166,13 +166,13 @@ class WebsocketCommunicator(AbstractCommunicator):
 
     def register_binary_message_callback(self, callback: Callable[[bytes], Any]) -> None:
         """Registers a callback to be called with every incoming binary message."""
-        logger.info('Binary message callback registered.')
+        logger.debug('Binary message callback registered.')
         self.binary_message_callback = callback
 
     async def _receive_data(self) -> None:
         try:
             async for message in self.websocket:  # type: ignore
-                logger.info(f'Received message: {message!r}')
+                logger.debug(f'Received message: {message!r}')
                 if isinstance(message, str):
                     await self.json_message_queue.put(message)
                 elif isinstance(message, bytes):

horiba_sdk/core/acquisition_format.py

@@ -4,6 +4,16 @@ from typing import final
 
 @final
 class AcquisitionFormat(Enum):
+    """Formats for the acquisition.
+
+    Attributes:
+        SPECTRA: X axis in nm, Y axis in counts
+        IMAGE: X axis in pixels, Y axis in counts
+        CROP: TBD
+        FAST_KINETICS: TBD
+
+    """
+
     SPECTRA = 0
     IMAGE = 1
     CROP = 2

horiba_sdk/core/clean_count_mode.py

@@ -4,6 +4,8 @@ from typing import final
 
 @final
 class CleanCountMode(Enum):
+    """TODO"""
+
     NEVER = 0
     FIRST_ONLY = 1
     BETWEEN_ONLY = 2

horiba_sdk/core/timer_resolution.py

@@ -4,9 +4,11 @@ from typing import final
 
 @final
 class TimerResolution(Enum):
-    """
-    .. note:: The timer resolution value of 1 microsecond is not supported by all CCDs.
+    """Resolution for the timer for the acquisition time.
+
+    .. note:: The timer resolution value MICROSECONDS is not supported by all CCDs.
     """
 
-    _1000_MICROSECONDS = 0
-    _1_MICROSECOND = 1
+    MILLISECONDS = 0
+    MICROSECONDS = 1
+    NOTHING_EVAL = 2

horiba_sdk/core/x_axis_conversion_type.py

@@ -5,7 +5,12 @@ from typing import final
 @final
 class XAxisConversionType(Enum):
     """
-    Enumeration of possible XAxisConversionTypes
+    Conversion types for the x axis of acquired data.
+
+    Attributes:
+        NONE: No conversion.
+        FROM_CCD_FIRMWARE: CCD FIT parameters contained in the CCD firmware.
+        FROM_ICL_SETTINGS_INI: Mono Wavelength parameters contained in the icl_settings.ini file
     """
 
     NONE = 0

horiba_sdk/devices/device_manager.py

@@ -66,6 +66,7 @@ class DeviceManager(AbstractDeviceManager):
         icl_ip: str = '127.0.0.1',
         icl_port: str = '25010',
         enable_binary_messages: bool = True,
+        enable_logging: bool = False
     ):
         """
         Initializes the DeviceManager with the specified communicator class.
@@ -75,7 +76,15 @@ class DeviceManager(AbstractDeviceManager):
             icl_ip (str) = '127.0.0.1': websocket IP
             icl_port (str) = '25010': websocket port
             enable_binary_messages (bool) = True: If True, binary messages are enabled.
+            enable_logging (bool) = True: If True, logging with the loguru library is enabled.
         """
+        # By default, logging is disabled for a library, so if desired it can be enabled
+        root_name_space: str = __name__.split('.')[0]
+        if enable_logging:
+            logger.info(f"Initializing logger for namespace: {root_name_space}")
+            logger.enable(root_name_space)
+        else:
+            logger.disable(root_name_space)
         super().__init__()
         self._start_icl = start_icl
         self._icl_communicator: WebsocketCommunicator = WebsocketCommunicator('ws://' + icl_ip + ':' + str(icl_port))
@@ -129,6 +138,8 @@ class DeviceManager(AbstractDeviceManager):
             logger.info('icl not running, starting it...')
             # subprocess.Popen([r'C:\Program Files\HORIBA Scientific\SDK\icl.exe'])
             self._icl_process = await asyncio.create_subprocess_exec(r'C:\Program Files\HORIBA Scientific\SDK\icl.exe')
+            await asyncio.sleep(4)
+
         # except subprocess.CalledProcessError:
         #    logger.error('Failed to start ICL software.')
         # TODO: [saga] is this the best way handle exceptions?

horiba_sdk/devices/single_devices/abstract_device.py

@@ -1,5 +1,5 @@
 from abc import ABC, abstractmethod
-from typing import Any
+from typing import Any, List, Optional
 
 from horiba_sdk.communication import AbstractCommunicator, Command, Response
 from horiba_sdk.icl_error import AbstractError, AbstractErrorDB
@@ -51,6 +51,43 @@ class AbstractDevice(ABC):
         """
         pass
 
+    async def pass_command(
+        self, command: str, params: Optional[List[Any]] = None, values: Optional[List[Any]] = None
+    ) -> Response:
+        """command to pass user input strings to ICL
+
+        .. note: used for internal usage
+        """
+
+        parameters = params if params else []
+        parameter_values = values if values else []
+
+        def convert_to_float(s):
+            try:
+                float(s)
+                return True
+            except ValueError:
+                return False
+
+        j = 0
+        for i in parameter_values:
+            if convert_to_float(i):
+                parameter_values[j] = float(parameter_values[j])
+                print(parameter_values[j])
+                print(type(parameter_values[j]))
+                j += 1
+            else:
+                j += 1
+
+        params_dict = dict(zip(parameters, parameter_values))
+        params_dict['index'] = self._id
+
+        if params[0] == '':
+            response: Response = await self._execute_command(str(command), {'index': self._id})
+        else:
+            response: Response = await self._execute_command(str(command), params_dict)
+        return response
+
     async def _execute_command(self, command_name: str, parameters: dict[Any, Any], timeout: int = 5) -> Response:
         """
         Creates a command from the command name, and it's parameters

horiba_sdk/devices/single_devices/ccd.py

@@ -1,5 +1,5 @@
 from types import TracebackType
-from typing import Any, List, Optional, final
+from typing import Any, Optional, final
 
 from loguru import logger
 from overrides import override
@@ -155,6 +155,27 @@ class ChargeCoupledDevice(AbstractDevice):
         """
         await super()._execute_command('ccd_setSpeed', {'index': self._id, 'token': speed_token})
 
+    async def get_parallel_speed(self) -> int:
+        """Gets the current parallel speed token
+
+        Returns:
+            int: current parallel speed token
+
+        Raises:
+            Exception: When an error occurred on the device side
+        """
+        response: Response = await super()._execute_command('ccd_getParallelSpeed', {'index': self._id})
+        parallel_speed_token: int = int(response.results['token'])
+        return parallel_speed_token
+
+    async def set_parallel_speed(self, parallel_speed_token: int) -> None:
+        """Sets the desired parallel speed token
+
+        Raises:
+            Exception: When an error occurred on the device side
+        """
+        await super()._execute_command('ccd_setParallelSpeed', {'index': self._id, 'token': parallel_speed_token})
+
     async def get_fit_parameters(self) -> list[int]:
         """Returns the fit parameters of the CCD
 
@@ -337,7 +358,7 @@ class ChargeCoupledDevice(AbstractDevice):
         response: Response = await super()._execute_command('ccd_getDataSize', {'index': self._id})
         return int(response.results['size'])
 
-    async def get_temperature(self) -> float:
+    async def get_chip_temperature(self) -> float:
         """Chip temperature of the CCD.
 
         Returns:
@@ -558,7 +579,7 @@ class ChargeCoupledDevice(AbstractDevice):
         response: Response = await super()._execute_command('ccd_getAcquisitionReady', {'index': self._id})
         return bool(response.results['ready'])
 
-    async def set_acquisition_start(self, open_shutter: bool) -> None:
+    async def acquisition_start(self, open_shutter: bool) -> None:
         """Starts an acquisition that has been set up according to the previously defined acquisition parameters.
 
         Note: To specify the acquisiton parameters please see set_region_of_interest, set_x_axis_conversion_type.
@@ -569,16 +590,16 @@ class ChargeCoupledDevice(AbstractDevice):
         Raises:
             Exception: When an error occurred on the device side
         """
-        await super()._execute_command('ccd_setAcquisitionStart', {'index': self._id, 'openShutter': open_shutter})
+        await super()._execute_command('ccd_acquisitionStart', {'index': self._id, 'openShutter': open_shutter})
 
     async def get_acquisition_busy(self) -> bool:
         """Returns true if the CCD is busy with the acquisition"""
         response: Response = await super()._execute_command('ccd_getAcquisitionBusy', {'index': self._id})
         return bool(response.results['isBusy'])
 
-    async def set_acquisition_abort(self, reset_port: bool = True) -> None:
+    async def acquisition_abort(self) -> None:
         """Stops the acquisition of the CCD"""
-        await super()._execute_command('ccd_setAcquisitionAbort', {'index': self._id, 'resetPort': reset_port})
+        await super()._execute_command('ccd_acquisitionAbort', {'index': self._id})
 
     async def get_acquisition_data(self) -> dict[Any, Any]:
         """Retrieves data from the last acquisition.
@@ -599,12 +620,13 @@ class ChargeCoupledDevice(AbstractDevice):
         response: Response = await super()._execute_command('ccd_getAcquisitionData', {'index': self._id})
         return response.results['acquisition']
 
-    async def set_center_wavelength(self, center_wavelength: float) -> None:
+    async def set_center_wavelength(self, mono_index: float, center_wavelength: float) -> None:
         """Sets the center wavelength value to be used in the grating equation.
 
         Used when X axis conversion is XAxisConversionType.FROM_ICL_SETTINGS_INI
 
         Args:
+            mono_index (float): Index for which mono to pull info from icl_settings.ini for
             center_wavelength (float): Center wavelength
 
         Raises:
@@ -612,12 +634,12 @@ class ChargeCoupledDevice(AbstractDevice):
         """
         await super()._execute_command(
             'ccd_setCenterWavelength',
-            {'index': self._id, 'wavelength': center_wavelength},
+            {'index': self._id, 'monoIndex': mono_index, 'wavelength': center_wavelength},
         )
 
     async def range_mode_center_wavelengths(
         self, monochromator_index: int, start_wavelength: float, end_wavelength: float, pixel_overlap: int
-    ) -> List[float]:
+    ) -> list[float]:
         """Finds the center wavelength positions based on the input range and pixel overlap.
 
         The following commands are prerequisites and should be called prior to using this command:
@@ -647,3 +669,20 @@ class ChargeCoupledDevice(AbstractDevice):
             },
         )
         return response.results['centerWavelengths']
+
+    @staticmethod
+    async def raman_convert(spectrum: list[float], excitation_wavelength: float) -> list[float]:
+        """Calculates the raman shift for every wavelength in the list relative to the excitation wavelength.
+
+        Args:
+            spectrum (list[float]): Wavelengths
+            excitation_wavelength: Excitation wavelength
+
+        Returns:
+            list[float]: Wavelengths converted to raman shifts
+        """
+        raman_values = []
+        for wave_length in spectrum:
+            raman_shift = ((1 / excitation_wavelength) - (1 / wave_length)) * (10**7)
+            raman_values.append(raman_shift)
+        return raman_values

horiba_sdk/devices/single_devices/monochromator.py

@@ -145,7 +145,7 @@ class Monochromator(AbstractDevice):
         response: Response = await super()._execute_command('mono_isBusy', {'index': self._id})
         return bool(response.results['busy'])
 
-    async def home(self) -> None:
+    async def initialize(self) -> None:
         """Starts the monochromator initialization process called "homing".
 
         Use :func:`Monochromator.is_busy()` to know if the operation is still taking place.
@@ -155,6 +155,19 @@ class Monochromator(AbstractDevice):
         """
         await super()._execute_command('mono_init', {'index': self._id})
 
+    async def is_initialized(self) -> bool:
+        """This command returns true when the mono is initialized. Otherwise, it returns false.
+        Note: This command may also return false when the mono is busy with another command.
+
+        Returns:
+            bool: If the monochromator is initialized or not
+
+        Raises:
+            Exception: When an error occurred on the device side
+        """
+        response: Response = await super()._execute_command('mono_isInitialized', {'index': self._id})
+        return bool(response.results['initialized'])
+
     async def configuration(self) -> dict[str, Any]:
         """Returns the configuration of the monochromator.
 

horiba_sdk/sync/communication/websocket_communicator.py

@@ -169,7 +169,7 @@ class WebsocketCommunicator(AbstractCommunicator):
             raise CommunicationException(None, 'Binary message callback already registered')
 
         self.binary_message_callback = callback
-        logger.info('Binary message callback registered.')
+        logger.debug('Binary message callback registered.')
         self.running_binary_message_handling_thread = True
         self.binary_message_handling_thread = Thread(target=self._run_binary_message_callback)
         self.binary_message_handling_thread.start()

horiba_sdk/sync/devices/device_manager.py

@@ -3,6 +3,7 @@ Synchronous Device Manager Module
 
 This Device Manager uses threads instead of asyncio
 """
+
 import importlib.resources
 import platform
 import subprocess

horiba_sdk/sync/devices/single_devices/ccd.py

@@ -1,5 +1,5 @@
 from types import TracebackType
-from typing import Any, List, Optional, final
+from typing import Any, Optional, final
 
 from loguru import logger
 from overrides import override
@@ -142,6 +142,27 @@ class ChargeCoupledDevice(AbstractDevice):
         """
         super()._execute_command('ccd_setSpeed', {'index': self._id, 'token': speed_token})
 
+    def get_parallel_speed(self) -> int:
+        """Gets the current parallel speed token
+
+        Returns:
+            int: current parallel speed token
+
+        Raises:
+            Exception: When an error occurred on the device side
+        """
+        response: Response = super()._execute_command('ccd_getParallelSpeed', {'index': self._id})
+        parallel_speed_token: int = int(response.results['token'])
+        return parallel_speed_token
+
+    def set_parallel_speed(self, parallel_speed_token: int) -> None:
+        """Sets the desired parallel speed token
+
+        Raises:
+            Exception: When an error occurred on the device side
+        """
+        super()._execute_command('ccd_setParallelSpeed', {'index': self._id, 'token': parallel_speed_token})
+
     def get_fit_parameters(self) -> list[int]:
         """Returns the fit parameters of the CCD
 
@@ -324,7 +345,7 @@ class ChargeCoupledDevice(AbstractDevice):
         response: Response = super()._execute_command('ccd_getDataSize', {'index': self._id})
         return int(response.results['size'])
 
-    def get_temperature(self) -> float:
+    def get_chip_temperature(self) -> float:
         """Chip temperature of the CCD.
 
         Returns:
@@ -545,7 +566,7 @@ class ChargeCoupledDevice(AbstractDevice):
         response: Response = super()._execute_command('ccd_getAcquisitionReady', {'index': self._id})
         return bool(response.results['ready'])
 
-    def set_acquisition_start(self, open_shutter: bool) -> None:
+    def acquisition_start(self, open_shutter: bool) -> None:
         """Starts an acquisition that has been set up according to the previously defined acquisition parameters.
 
         Note: To specify the acquisiton parameters please see set_region_of_interest, set_x_axis_conversion_type.
@@ -556,16 +577,16 @@ class ChargeCoupledDevice(AbstractDevice):
         Raises:
             Exception: When an error occurred on the device side
         """
-        super()._execute_command('ccd_setAcquisitionStart', {'index': self._id, 'openShutter': open_shutter})
+        super()._execute_command('ccd_acquisitionStart', {'index': self._id, 'openShutter': open_shutter})
 
     def get_acquisition_busy(self) -> bool:
         """Returns true if the CCD is busy with the acquisition"""
         response: Response = super()._execute_command('ccd_getAcquisitionBusy', {'index': self._id})
         return bool(response.results['isBusy'])
 
-    def set_acquisition_abort(self, reset_port: bool = True) -> None:
+    def acquisition_abort(self) -> None:
         """Stops the acquisition of the CCD"""
-        super()._execute_command('ccd_setAcquisitionAbort', {'index': self._id, 'resetPort': reset_port})
+        super()._execute_command('ccd_acquisitionStart', {'index': self._id})
 
     def get_acquisition_data(self) -> dict[Any, Any]:
         """Retrieves data from the last acquisition.
@@ -604,7 +625,7 @@ class ChargeCoupledDevice(AbstractDevice):
 
     def range_mode_center_wavelengths(
         self, monochromator_index: int, start_wavelength: float, end_wavelength: float, pixel_overlap: int
-    ) -> List[float]:
+    ) -> list[float]:
         """Finds the center wavelength positions based on the input range and pixel overlap.
 
         The following commands are prerequisites and should be called prior to using this command:
@@ -634,3 +655,20 @@ class ChargeCoupledDevice(AbstractDevice):
             },
         )
         return response.results['centerWavelengths']
+
+    @staticmethod
+    def raman_convert(spectrum: list[float], excitation_wavelength: float) -> list[float]:
+        """Calculates the raman shift for every wavelength in the list relative to the excitation wavelength.
+
+        Args:
+            spectrum (list[float]): Wavelengths
+            excitation_wavelength: Excitation wavelength
+
+        Returns:
+            list[float]: Wavelengths converted to raman shifts
+        """
+        raman_values = []
+        for wave_length in spectrum:
+            raman_shift = ((1 / excitation_wavelength) - (1 / wave_length)) * (10**7)
+            raman_values.append(raman_shift)
+        return raman_values

horiba_sdk/sync/devices/single_devices/monochromator.py

@@ -147,7 +147,7 @@ class Monochromator(AbstractDevice):
         response: Response = super()._execute_command('mono_isBusy', {'index': self._id})
         return bool(response.results['busy'])
 
-    def home(self) -> None:
+    def initialize(self) -> None:
         """Starts the monochromator initialization process called "homing".
 
         Use :func:`Monochromator.is_busy()` to know if the operation is still taking place.
@@ -157,6 +157,19 @@ class Monochromator(AbstractDevice):
         """
         super()._execute_command('mono_init', {'index': self._id})
 
+    def is_initialized(self) -> bool:
+        """This command returns true when the mono is initialized. Otherwise, it returns false.
+        Note: This command may also return false when the mono is busy with another command.
+
+        Returns:
+            bool: If the monochromator is initialized or not
+
+        Raises:
+            Exception: When an error occurred on the device side
+        """
+        response: Response = super()._execute_command('mono_isInitialized', {'index': self._id})
+        return bool(response.results['initialized'])
+
     def configuration(self) -> dict[str, Any]:
         """Returns the configuration of the monochromator.
 

{horiba_sdk-0.4.0.dist-info → horiba_sdk-0.5.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: horiba-sdk
-Version: 0.4.0
+Version: 0.5.4
 Summary: 'horiba-sdk' is a package that provides source code for the development with Horiba devices
 Home-page: https://github.com/ThatsTheEnd/horiba-python-sdk
 License: MIT
@@ -25,24 +25,23 @@ Requires-Dist: websockets (>=12.0,<13.0)
 Project-URL: Repository, https://github.com/ThatsTheEnd/horiba-python-sdk
 Description-Content-Type: text/markdown
 
-# horiba-python-sdk
+# HORIBA Python SDK
 
 <div align="center">
 
-[![build](https://github.com/ThatsTheEnd/horiba-python-sdk/actions/workflows/build.yml/badge.svg)](https://github.com/ThatsTheEnd/horiba-python-sdk/actions/workflows/build.yml)
+[![build](https://github.com/HORIBAEzSpecSDK/horiba-python-sdk/actions/workflows/build.yml/badge.svg)](https://github.com/HORIBAEzSpecSDK/horiba-python-sdk/actions/workflows/build.yml)
 [![PyPI - Version](https://img.shields.io/pypi/v/horiba-sdk)](https://pypi.org/project/horiba-sdk/)
 [![Python Version](https://img.shields.io/pypi/pyversions/horiba-sdk.svg)](https://pypi.org/project/horiba-sdk/)
-[![Dependencies Status](https://img.shields.io/badge/dependencies-up%20to%20date-brightgreen.svg)](https://github.com/ThatsTheEnd/horiba-python-sdk/pulls?utf8=%E2%9C%93&q=is%3Apr%20author%3Aapp%2Fdependabot)
+[![Dependencies Status](https://img.shields.io/badge/dependencies-up%20to%20date-brightgreen.svg)](https://github.com/HORIBAEzSpecSDK/horiba-python-sdk/pulls?utf8=%E2%9C%93&q=is%3Apr%20author%3Aapp%2Fdependabot)
 
 [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
 [![Security: bandit](https://img.shields.io/badge/security-bandit-green.svg)](https://github.com/PyCQA/bandit)
-[![Pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/ThatsTheEnd/horiba-python-sdk/blob/master/.pre-commit-config.yaml)
-[![Semantic Versions](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--versions-e10079.svg)](https://github.com/ThatsTheEnd/horiba-python-sdk/releases)
-[![License](https://img.shields.io/github/license/ThatsTheEnd/horiba-python-sdk)](https://github.com/ThatsTheEnd/horiba-python-sdk/blob/master/LICENSE)
+[![Pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/HORIBAEzSpecSDK/horiba-python-sdk/blob/master/.pre-commit-config.yaml)
+[![Semantic Versions](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--versions-e10079.svg)](https://github.com/HORIBAEzSpecSDK/horiba-python-sdk/releases)
+[![License](https://img.shields.io/github/license/HORIBAEzSpecSDK/horiba-python-sdk)](https://github.com/HORIBAEzSpecSDK/horiba-python-sdk/blob/master/LICENSE)
 ![Coverage Report](assets/images/coverage.svg)
 [![Documentation Status](https://readthedocs.org/projects/horiba-python-sdk/badge/?version=latest)](https://horiba-python-sdk.readthedocs.io/en/latest/?badge=latest)
 
-'horiba-sdk' is a package that provides source code for the development with Horiba devices
 
 </div>
 
@@ -61,11 +60,20 @@ ___
 
 ___
 
-**📦 Prerequisites**
+# 📦 About this repository
+`horiba-sdk` is a package that provides source code for the development of custom applications that include interaction with Horiba devices, namely monochromators and multichannel detectors (e.g. CCD cameras).
+Future versions of this package will include access to more devices. The SDK exists for several programming languages:
+- Python (this repo)
+- [C#](https://github.com/HORIBAEzSpecSDK/dotnet-sdk)
+- [C++](https://github.com/HORIBAEzSpecSDK/cpp-sdk)
+- [LabVIEW](https://github.com/HORIBAEzSpecSDK/labview-sdk)
 
-* Python `>=3.9`
-* ICL.exe installed as part of the Horiba SDK, licensed and activated
+# ☑️ Prerequisites
 
+To use this package, the following conditions must be met:
+* Python `>=3.9` is installed
+* ICL.exe installed as part of the `Horiba SDK`, licensed and activated. The Horiba SDK can be purchased by contacting the [Horiba Support](https://www.horiba.com/int/scientific/contact/) and sending a message to the `Scientific` business segment, specifying `no division` and selecting the `sales` department
+*
   <details>
   <summary>To make sure that the USB devices do not get disconnected, uncheck the following boxes in the properties</summary>
 
@@ -73,7 +81,7 @@ ___
 
   </details>
 
-## 🛠️ Usage
+# 🛠️ Getting Started
 
 <details>
 <summary>Video of the steps below</summary>
@@ -82,7 +90,7 @@ ___
 
 </details>
 
-0. (Optional but recommended) Work in a virtual environment:
+1. (Optional but recommended) Work in a virtual environment:
 
    Navigate to the (empty) project folder you want to work and run:
 
@@ -143,17 +151,40 @@ ___
    ```bash
    python center_scan.py
    ```
+# 🔗 Examples
+## Getting Started
+The files in the folder [examples/asynchronous_examples/](examples/asynchronous_examples) can be used as a starting point for a custom application.
 
-## 👩‍💻 First steps as contributor
+## Tests
+The files in the folder [tests/test_single_devices](tests/test_single_devices) can be used to explore further functionality.
 
-### Clone and setup the repo
+## Asynchronous vs Synchronous Examples
+This SDK is based on Websocket communication. The nature of this communication is asynchronous by its design.
+The way this SDK uses websockets is to send requests to the underlying `instrument control layer (ICL)` and get a (nearly immediate) reply back.
+This is true even for commands that longer to execute, e.g. to move the mono or to acquire data from the CCD. The way this is handled is by sending an acknowledgement back that the command is received and being processed. The user has then to inquire if `mono_isBusy` to see when the hardware is free to receive the next command.
+That means that every `async` function can be `awaited` immediately and handled just like any other function.
+To learn more about async and await, [check out this introduction](https://www.pythontutorial.net/python-concurrency/python-async-await/) or [take a deeper dive here](https://medium.com/@danielwume/an-in-depth-guide-to-asyncio-and-await-in-python-059c3ecc9d96).
 
-1. Clone the repo:
 
-```bash
-git clone https://github.com/ThatsTheEnd/horiba-python-sdk.git
-cd horiba-python-sdk
-```
+
+# 🏗️ Architecture
+The functionality is distributed over two parts, the `instrument control layer (ICL)` and the `github source code`. This split is shown in the following image:
+![SDK Split](docs/SDK_Overview_Dark.png#gh-dark-mode-only "SDK Split")
+![SDK Split](docs/SDK_Overview_Dark.png#gh-light-mode-only "SDK Split")
+
+The ICL itself is sold and distributed by Horiba. The source code to communicate with the ICL and drive the instruments is located in this repo for Python, but can be also found for C#, C++ and LabVIEW as described above.
+The communication between SDK and ICL is websocket based. I.e. in essence the ICL is steered by a `command and control` pattern where commands and their replies are JSON commands.
+
+# 👩‍💻 First steps as contributor
+
+## Clone and set up the repo
+
+1. Clone the repo:
+  
+  ```bash
+  git clone https://github.com/HORIBAEzSpecSDK/horiba-python-sdk.git
+  cd horiba-python-sdk
+  ```
 
 2. If you don't have `Poetry` installed run:
 
@@ -187,7 +218,7 @@ git push
 <!-- - Set up [Dependabot](https://docs.github.com/en/github/administering-a-repository/enabling-and-disabling-version-updates#enabling-github-dependabot-version-updates) to ensure you have the latest dependencies. -->
 <!-- - Set up [Stale bot](https://github.com/apps/stale) for automatic issue closing. -->
 
-### Poetry
+## Poetry
 
 Want to know more about Poetry? Check [its documentation](https://python-poetry.org/docs/).
 
@@ -205,7 +236,7 @@ etc
 </p>
 </details>
 
-### Building and releasing your package
+## Building and releasing your package
 
 Building a new version of the application contains steps:
 
@@ -219,12 +250,12 @@ Building a new version of the application contains steps:
   git push --tags
   ```
 
-### Makefile usage
+## Makefile usage
 
-[`Makefile`](https://github.com/ThatsTheEnd/horiba-python-sdk/blob/master/Makefile) contains a lot of functions for faster development.
+[`Makefile`](https://github.com/HORIBAEzSpecSDK/horiba-python-sdk/blob/master/Makefile) contains a lot of functions for faster development.
 
 <details>
-<summary>1. Download and remove Poetry</summary>
+<summary>1. Installation of Poetry</summary>
 <p>
 
 To download and install Poetry run:
@@ -252,7 +283,7 @@ Install requirements:
 make install
 ```
 
-Pre-commit hooks coulb be installed after `git init` via
+Pre-commit hooks could be installed after `git init` via
 
 ```bash
 make pre-commit-install
@@ -287,6 +318,8 @@ Update all dev libraries to the latest version using one comand
 ```bash
 make update-dev-deps
 ```
+</p>
+</details>
 
 <details>
 <summary>4. Code security</summary>
@@ -302,8 +335,6 @@ This command launches `Poetry` integrity checks as well as identifies security i
 make check-safety
 ```
 
-</p>
-</details>
 
 </p>
 </details>
@@ -406,7 +437,7 @@ Remove docker image with
 make docker-remove
 ```
 
-More information [about docker](https://github.com/ThatsTheEnd/horiba-python-sdk/tree/master/docker).
+More information [about docker](https://github.com/HORIBAEzSpecSDK/horiba-python-sdk/tree/master/docker).
 
 </p>
 </details>
@@ -443,11 +474,10 @@ Or to remove all above run:
 ```bash
 make cleanup
 ```
-
 </p>
 </details>
 
-## 📚 Documentation
+# 📚 Documentation
 
 The latest documentation can be found at
 [horiba-python-sdk.readthedocs.io](https://horiba-python-sdk.readthedocs.io/en/latest/).
@@ -463,63 +493,12 @@ Documentation is built each time a commit is pushed on `main` or for pull
 requests. When release tags are created in the repo, readthedocs will also tag
 the documentation accordingly
 
-## 🚀 Features
-
-### Development features
-
-- Supports for `Python 3.9` and higher.
-- [`Poetry`](https://python-poetry.org/) as the dependencies manager. See configuration in [`pyproject.toml`](https://github.com/ThatsTheEnd/horiba-python-sdk/blob/master/pyproject.toml).
-- Automatic codestyle with [`ruff`](https://github.com/astral-sh/ruff)
-- Ready-to-use [`pre-commit`](https://pre-commit.com/) hooks with code-formatting.
-- Type checks with [`mypy`](https://mypy.readthedocs.io); security checks with [`safety`](https://github.com/pyupio/safety) and [`bandit`](https://github.com/PyCQA/bandit)
-- Testing with [`pytest`](https://docs.pytest.org/en/latest/).
-- Ready-to-use [`.editorconfig`](https://github.com/ThatsTheEnd/horiba-python-sdk/blob/master/.editorconfig), [`.dockerignore`](https://github.com/ThatsTheEnd/horiba-python-sdk/blob/master/.dockerignore), and [`.gitignore`](https://github.com/ThatsTheEnd/horiba-python-sdk/blob/master/.gitignore). You don't have to worry about those things.
-
-### Deployment features
-
-- `GitHub` integration: issue and pr templates.
-- `Github Actions` with predefined [build workflow](https://github.com/ThatsTheEnd/horiba-python-sdk/blob/master/.github/workflows/build.yml) as the default CI/CD.
-- Everything is already set up for security checks, codestyle checks, code formatting, testing, linting, docker builds, etc with [`Makefile`](https://github.com/ThatsTheEnd/horiba-python-sdk/blob/master/Makefile#L89). More details in [makefile-usage](#makefile-usage).
-- [Dockerfile](https://github.com/ThatsTheEnd/horiba-python-sdk/blob/master/docker/Dockerfile) for your package.
-- Always up-to-date dependencies with [`@dependabot`](https://dependabot.com/). You will only [enable it](https://docs.github.com/en/github/administering-a-repository/enabling-and-disabling-version-updates#enabling-github-dependabot-version-updates).
-- Automatic drafts of new releases with [`Release Drafter`](https://github.com/marketplace/actions/release-drafter). You may see the list of labels in [`release-drafter.yml`](https://github.com/ThatsTheEnd/horiba-python-sdk/blob/master/.github/release-drafter.yml). Works perfectly with [Semantic Versions](https://semver.org/) specification.
-
-### Open source community features
-
-- Ready-to-use [Pull Requests templates](https://github.com/ThatsTheEnd/horiba-python-sdk/blob/master/.github/PULL_REQUEST_TEMPLATE.md) and several [Issue templates](https://github.com/ThatsTheEnd/horiba-python-sdk/tree/master/.github/ISSUE_TEMPLATE).
-- Files such as: `LICENSE`, `CONTRIBUTING.md`, `CODE_OF_CONDUCT.md`, and `SECURITY.md` are generated automatically.
-- [Semantic Versions](https://semver.org/) specification with [`Release Drafter`](https://github.com/marketplace/actions/release-drafter).
-<!-- - [`Stale bot`](https://github.com/apps/stale) that closes abandoned issues after a period of inactivity. (You will only [need to setup free plan](https://github.com/marketplace/stale)). Configuration is [here](https://github.com/ThatsTheEnd/horiba-python-sdk/blob/master/.github/.stale.yml). -->
-
-
-## 📈 Releases
-
-You can see the list of available releases on the [GitHub Releases](https://github.com/ThatsTheEnd/horiba-python-sdk/releases) page.
-
-We follow [Semantic Versions](https://semver.org/) specification.
-
-<!-- We use [`Release Drafter`](https://github.com/marketplace/actions/release-drafter). As pull requests are merged, a draft release is kept up-to-date listing the changes, ready to publish when you’re ready. With the categories option, you can categorize pull requests in release notes using labels. -->
-
-### List of labels and corresponding titles
-
-|               **Label**               |  **Title in Releases**  |
-| :-----------------------------------: | :---------------------: |
-|       `enhancement`, `feature`        |       🚀 Features       |
-| `bug`, `refactoring`, `bugfix`, `fix` | 🔧 Fixes & Refactoring  |
-|       `build`, `ci`, `testing`        | 📦 Build System & CI/CD |
-|              `breaking`               |   💥 Breaking Changes   |
-|            `documentation`            |    📝 Documentation     |
-|            `dependencies`             | ⬆️ Dependencies updates |
-
-<!-- You can update it in [`release-drafter.yml`](https://github.com/ThatsTheEnd/horiba-python-sdk/blob/master/.github/release-drafter.yml). -->
-
-<!-- GitHub creates the `bug`, `enhancement`, and `documentation` labels for you. Dependabot creates the `dependencies` label. Create the remaining labels on the Issues tab of your GitHub repository, when you need them. -->
 
 ## 🛡 License
 
-[![License](https://img.shields.io/github/license/ThatsTheEnd/horiba-python-sdk)](https://github.com/ThatsTheEnd/horiba-python-sdk/blob/master/LICENSE)
+[![License](https://img.shields.io/github/license/HORIBAEzSpecSDK/horiba-python-sdk)](https://github.com/HORIBAEzSpecSDK/horiba-python-sdk/blob/master/LICENSE)
 
-This project is licensed under the terms of the `MIT` license. See [LICENSE](https://github.com/ThatsTheEnd/horiba-python-sdk/blob/master/LICENSE) for more details.
+This project is licensed under the terms of the `MIT` license. See [LICENSE](https://github.com/HORIBAEzSpecSDK/horiba-python-sdk/blob/master/LICENSE) for more details.
 
 ## 📃 Citation
 
@@ -530,10 +509,11 @@ This project is licensed under the terms of the `MIT` license. See [LICENSE](htt
   year = {2023},
   publisher = {GitHub},
   journal = {GitHub repository},
-  howpublished = {\url{https://github.com/ThatsTheEnd/horiba-python-sdk}}
+  howpublished = {\url{https://github.com/HORIBAEzSpecSDK/horiba-python-sdk}}
 }
 ```
 
+
 ## Credits [![🚀 Your next Python package needs a bleeding-edge project structure.](https://img.shields.io/badge/python--package--template-%F0%9F%9A%80-brightgreen)](https://github.com/TezRomacH/python-package-template)
 
 This project was generated with [`python-package-template`](https://github.com/TezRomacH/python-package-template)

{horiba_sdk-0.4.0.dist-info → horiba_sdk-0.5.4.dist-info}/RECORD

@@ -1,20 +1,20 @@
-horiba_sdk/__init__.py,sha256=QS1eJSOd6_DgyxAQE3FoKhvHgWRG3JVhkKHpQ1Za8yM,485
+horiba_sdk/__init__.py,sha256=J8jCV90BJ2SCDFSpacDeAAsJa8PFqBUDpREOJeAgXug,679
 horiba_sdk/communication/__init__.py,sha256=nhS1rw1ZojM8zmRIx0VEFtYge0IH-B_L4zNBUNBJZYE,1564
 horiba_sdk/communication/abstract_communicator.py,sha256=E80dfOjrfuNay3W5jeSn4T2tUas6vygRcF46kSoP5j8,1498
 horiba_sdk/communication/communication_exception.py,sha256=d2ouOoVI6Q69_JL1bUEjjQOmjiO0CEm8K20WsaUuhB0,583
 horiba_sdk/communication/messages.py,sha256=Gxkw01JI0U5ShILANT0pezywcoSO2aHo06j1ixzZPEQ,2661
-horiba_sdk/communication/websocket_communicator.py,sha256=LzFaklePVAMkXKsdCQLFcx1XlOrJAAm1_Q9h2nAxeWY,8298
+horiba_sdk/communication/websocket_communicator.py,sha256=wQxGRtj3htQ8n_hMvcoBmZdD18iea0uiCEsTZYdR2Jg,8300
 horiba_sdk/core/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-horiba_sdk/core/acquisition_format.py,sha256=fpACwGAL8qXEdsWGPTY0HYt708XSw0AtZ2FYb0RhpRk,152
-horiba_sdk/core/clean_count_mode.py,sha256=jAiYvTBGnffgZpZAArifPINHd09884FaQ_x4Tq6uFzI,169
+horiba_sdk/core/acquisition_format.py,sha256=pHcHZck75BbJ4nn2FOZ9cUXq9juZUjoNxKdLUhIIINI,358
+horiba_sdk/core/clean_count_mode.py,sha256=7guLd3eUV3Y2Cnj3w0JJ7ry74I8a6MFQiqbK5pTb3oU,185
 horiba_sdk/core/resolution.py,sha256=VOQonjPBqZ2TbtiNVDBT3TI1Aymj1pPYWMoobFaXjG8,1029
-horiba_sdk/core/timer_resolution.py,sha256=sKu_Y2Ev0jfR_UbD3AwzFRAWAJmR6rYXTtdt37HE-Tw,240
-horiba_sdk/core/x_axis_conversion_type.py,sha256=w44y6NUu_O0klltbIMj_pwFZBIL0MIZ4ouryh65Rzyw,224
+horiba_sdk/core/timer_resolution.py,sha256=V6pXEZMVvUUoqrJmLFFI45pFt_7po6-5r1DmC8jY6gs,300
+horiba_sdk/core/x_axis_conversion_type.py,sha256=SQrdbciTR8x5UWOqLDgxWPy12o0-yIVLrkm7N3gpWpg,449
 horiba_sdk/devices/__init__.py,sha256=YYsJL2CSJwc2vsAjFQEKXjA5_QAnKlxSwlx32EgzFME,336
 horiba_sdk/devices/abstract_device_discovery.py,sha256=04ZCEB5IZkUuJxSisS78eW6lAQNXG4uaDoPv-eBccBA,178
 horiba_sdk/devices/abstract_device_manager.py,sha256=RXj5_pzFHpiolJe3ZfFsofwpD1hlwUMwYD1DyWMmlI0,1717
 horiba_sdk/devices/ccd_discovery.py,sha256=nGuskZ07Y9myI__dU8LeLnrNiJEBpGPby21EEwgSVUk,2376
-horiba_sdk/devices/device_manager.py,sha256=S5iIxnvJivXdMLUmEq0rmoG899ENE-BdL_4TLQWQWsg,10327
+horiba_sdk/devices/device_manager.py,sha256=ZmZjQjTLxJvs5NqWQLTfDcCNb3PFwBYbu1mg_qmMCVo,10847
 horiba_sdk/devices/fake_device_manager.py,sha256=Tr4Z067smYfy-ya29PO4PK4EWF6Sa1R2UQFZCWfPePE,5015
 horiba_sdk/devices/fake_icl_server.py,sha256=Yh9oh0YCbw-AXMnCHFWsZvJ7ZFjsnm1JG1y0ix1b-9Q,2348
 horiba_sdk/devices/fake_responses/ccd.json,sha256=sMg-UqU6W1I01n2kEbkFc5J0XF8E3JVdOjB-1MhufzM,17020
@@ -22,9 +22,9 @@ horiba_sdk/devices/fake_responses/icl.json,sha256=ZPKhjx0BmwmqNGwbb7reXSStddgVZe
 horiba_sdk/devices/fake_responses/monochromator.json,sha256=I9yBMsJyXXVCLF1J8mNPsfgXasIg60IL-4ToECcoGhw,4308
 horiba_sdk/devices/monochromator_discovery.py,sha256=KoZ8vfPsI6QRuiD4BiE0YvzO42dQzFZqvoxygDSllE8,2365
 horiba_sdk/devices/single_devices/__init__.py,sha256=Ai6HLstvMqT1c6A0yKLAH6227TUdS4ZMsC6zFrsmJic,192
-horiba_sdk/devices/single_devices/abstract_device.py,sha256=0OW4RnZi0NQhS6DsN5BRbbbqbqOGajnYsHz9Nu0L-ws,2800
-horiba_sdk/devices/single_devices/ccd.py,sha256=TN9sU2re2yhi6yxjtV0tDif7TnbCaOccKgf7n5sepyI,28466
-horiba_sdk/devices/single_devices/monochromator.py,sha256=kUn2OizpItjrTfB-2AAq8bYz35pdwZpXV8a75LEH150,13969
+horiba_sdk/devices/single_devices/abstract_device.py,sha256=CwCjHJWSp8WGrYsyq0ZhTQVnvYdoCG-kb4BU9SZXJm8,3994
+horiba_sdk/devices/single_devices/ccd.py,sha256=mnx0keMePP7JAxCs8ZgCm_05tyu89efjAcBn2FPv4FI,29995
+horiba_sdk/devices/single_devices/monochromator.py,sha256=r-9bI-ne_iGdfTWBvUnYSxxp1DQNlEt7wBN31cGfZ1E,14538
 horiba_sdk/icl_error/__init__.py,sha256=EtqHaUeoaLilpb7L7juuVamJgIZ3Anfnca0AO2o46rg,1053
 horiba_sdk/icl_error/abstract_error.py,sha256=5nQDI6MNfCi4xUx6taJcEWGwANOo8mPEb4kVxrO-DW8,1301
 horiba_sdk/icl_error/abstract_error_db.py,sha256=IJ3wGb6DWxnY35VIUwZX0X80IPi5k4QoQXnVjDy8lH8,589
@@ -35,19 +35,19 @@ horiba_sdk/sync/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 horiba_sdk/sync/communication/__init__.py,sha256=iVHHW0cQ9w_J5dGRkwdBnw7vYgRLn5MVsdIFWGZvJoA,186
 horiba_sdk/sync/communication/abstract_communicator.py,sha256=CEkGj2qVNoWYkFD9HOlxV82kls3gsJ517gWPK-9rUBw,1185
 horiba_sdk/sync/communication/test_client.py,sha256=7N5sM2Y63GSuFDmOEFRXeTHeAY7Nq7yX5MvbdPXeDko,651
-horiba_sdk/sync/communication/websocket_communicator.py,sha256=ThM2seSrMldQpX6pdacfi5_JCR05tF8aS8FgHy6V7RU,9233
+horiba_sdk/sync/communication/websocket_communicator.py,sha256=rCa0RVwl9Evwtr8VJUhkhTiIX2yG6pVtblhV3BGwnxU,9234
 horiba_sdk/sync/devices/__init__.py,sha256=NDHi3zfDC52aTO1RpaPIBfyp7PEXfTqiYdvY_ThkyRE,469
 horiba_sdk/sync/devices/abstract_device_discovery.py,sha256=hKDWbI8-I3r5mrU3O1Y1ve6vV7sg6KpUa5d3EfcLIE8,447
 horiba_sdk/sync/devices/abstract_device_manager.py,sha256=hF9BGgVqi6EK0n6hdUDu7dnKI1SfZ5mCweGvm6vCJ5o,1709
 horiba_sdk/sync/devices/device_discovery.py,sha256=eLErCF3mFYK5Za0jRg2xBLQnWJTwce7LcWdm8OQcI0A,2723
-horiba_sdk/sync/devices/device_manager.py,sha256=cK5roPvBMzxm9qI3sB9WN_UXmxm5ER89CyDSLP22WY4,8428
+horiba_sdk/sync/devices/device_manager.py,sha256=yGoijQnxJn7xyI3TpkBf-DpN3JGPNrQDkDtvvSLKNQk,8429
 horiba_sdk/sync/devices/fake_device_manager.py,sha256=myj1GwxjcOmv9jZbaTk8QwC6qYluNaZfuP9xPXrw3do,2809
 horiba_sdk/sync/devices/fake_icl_server.py,sha256=DlQOC54p7UCYBTdZOZCD9TgDdK4MarnbaWFUXRo7NP4,3298
 horiba_sdk/sync/devices/single_devices/__init__.py,sha256=Ai6HLstvMqT1c6A0yKLAH6227TUdS4ZMsC6zFrsmJic,192
 horiba_sdk/sync/devices/single_devices/abstract_device.py,sha256=ABQpU6wU5trH0j8OVjDP6MeGTj41e1ey5K5sw7tCCdQ,2883
-horiba_sdk/sync/devices/single_devices/ccd.py,sha256=Ig3aUFcKSZ3IAyir0onSioVtz08aG6eTp46iPnMOw4M,26833
-horiba_sdk/sync/devices/single_devices/monochromator.py,sha256=uix3ffDMfSHCHFtKb6aX_SgF4urRaUsRdUTRqg9NqtA,13794
-horiba_sdk-0.4.0.dist-info/LICENSE,sha256=JD-7TpNZoT7emooLwaTU9bJZbFbeM1ba90b8gpCYxzM,1083
-horiba_sdk-0.4.0.dist-info/METADATA,sha256=q3J-KfVJSxpHm-y9yF_fVhkRln1BRu_VfAnQtOEiSfA,16035
-horiba_sdk-0.4.0.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
-horiba_sdk-0.4.0.dist-info/RECORD,,
+horiba_sdk/sync/devices/single_devices/ccd.py,sha256=fHj3lU8pZJKCoo1W3xdLhucNd_7JM4XRRxbbHfAO5Os,28196
+horiba_sdk/sync/devices/single_devices/monochromator.py,sha256=ur0scHOnnX0f_xhxh4Wzz4CNyeltFPuGg49PmPKEFwg,14351
+horiba_sdk-0.5.4.dist-info/LICENSE,sha256=JD-7TpNZoT7emooLwaTU9bJZbFbeM1ba90b8gpCYxzM,1083
+horiba_sdk-0.5.4.dist-info/METADATA,sha256=MGbBOP5E9ZWO8D-gGsU8TInWUUWannU3v1K5D1t4CY0,14349
+horiba_sdk-0.5.4.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
+horiba_sdk-0.5.4.dist-info/RECORD,,