nisync 0.1__tar.gz

nisync-0.1/LICENSE

@@ -0,0 +1,23 @@
+This is the MIT license: http://www.opensource.org/licenses/mit-license.php
+
+Copyright (c) 2024, National Instruments Corp. NI-Sync is a trademark of National
+Instruments.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be included
+in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

nisync-0.1/PKG-INFO

@@ -0,0 +1,143 @@
+Metadata-Version: 2.1
+Name: nisync
+Version: 0.1
+Summary: NI-Sync Python API
+Home-page: https://github.com/ni/nisync-python
+License: MIT
+Author: NI
+Author-email: opensource@ni.com
+Maintainer: NI
+Maintainer-email: opensource@ni.com
+Requires-Python: >=3.8.1,<4.0.0
+Classifier: Development Status :: 1 - Planning
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Manufacturing
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: System :: Hardware
+Requires-Dist: hightime
+Project-URL: Repository, https://github.com/ni/nisync-python
+Description-Content-Type: text/markdown
+
+| **Info**      | Contains a Python API for interacting with NI-Sync. See [GitHub](https://github.com/ni/nisync-python/) for the latest source. | 
+| :------------ | :---------------------| 
+| **Author**    | National Instruments  | 
+
+# Table of Contents
+- [About](#about)
+  - [Documentation](#documentation)
+  - [Implementation](#implementation)
+  - [Supported NI-Sync Driver Versions](#supported-ni-sync-driver-versions)
+  - [Operating System Support](#operating-system-support)
+  - [Python Version Support](#python-version-support)
+- [Installation](#installation)
+  - [Manual Driver Installation](#manual-driver-installation)
+- [Getting Started](#getting-started)
+- [Usage](#usage)
+  - [Python Examples](#python-examples)
+- [License](#license)
+
+# About
+
+The **nisync** package allows you to develop timing and synchronization applications 
+for both time-based and signal-based synchronizations with NI-Sync devices in Python.
+
+## Documentation
+
+Refer to the [NI-Sync User Manual](https://www.ni.com/docs/en-US/bundle/ni-sync/page/user-manual-welcome.html)
+for API-agnostic information about NI-Sync concepts.
+
+## Implementation
+
+The package is implemented in Python as an 
+object-oriented wrapper around the NI-Sync C API using the
+[ctypes](https://docs.python.org/3/library/ctypes.html) Python library.
+
+## Supported NI-Sync Driver Versions
+
+**nisync** supports all versions of NI-Sync. Some functions in the **nisync** 
+package may be unavailable with earlier versions of NI-Sync driver. Refer to 
+the [Installation](#installation) section for details on how to install the latest version 
+of the NI-Sync driver.
+
+## Operating System Support
+
+**nisync** supports Windows and Linux operating systems where the NI-Sync
+driver is supported. Refer to
+[NI Hardware and Operating System Compatibility](https://www.ni.com/r/hw-support)
+for which versions of the driver support your hardware on a given operating
+system.
+
+## Python Version Support
+
+**nisync** supports CPython 3.8+ and PyPy3.
+
+# Installation
+ 
+Running **nisync** requires NI-Sync to be installed.
+**nisync** can be installed with [pip](http://pypi.python.org/pypi/pip>):
+
+```shell
+python -m pip install nisync
+```
+
+## Manual Driver Installation
+
+Visit [ni.com/downloads](http://www.ni.com/downloads/) to download the latest
+version of NI-Sync. None of the recommended **Additional items** are required
+for **nisync** to function, and they can be removed to minimize installation
+size. It is recommended you continue to install the **NI Certificates** package
+to allow your Operating System to trust NI built binaries, improving your
+software and hardware installation experience.
+
+# Getting Started
+
+In order to use the **nisync** package, you must have at least one device that supports NI-Sync 
+installed on your system. Both physical and simulated devices are supported.
+You can use **NI MAX** or **NI Hardware Configuration Utility** to verify and configure your devices.
+
+Finding and configuring device name in **NI MAX**:
+![NI Max Device Name](https://github.com/ni/nisync-python/blob/a3b91643a1e110fbc3a6bc9c5dc517f74c13ee80/docs/img/max_device_name.png)
+
+Finding and configuring device name in **NI Hardware Configuration Utility**:
+![NI HWCU Device Name](https://github.com/ni/nisync-python/blob/a3b91643a1e110fbc3a6bc9c5dc517f74c13ee80/docs/img/hwcu_device_name.png)
+
+
+# Usage
+The following is a basic example of using an **nisync.nisync.Session** object. This example illustrates how to connect and disconnect clock terminals to synchronize devices using the onboard oscillator as the clock source. This is particularly useful in applications requiring precise timing and synchronization across multiple devices.
+
+## Python Examples
+
+```python
+import nisync
+from nisync.constants import PXI_CLK10_IN, OSCILLATOR
+
+# Create a new session with the nisync library
+with nisync.Session(resource_name="PXI1Slot10") as session:
+    # Connect the onboard oscillator to the PXI_CLK10_IN terminal
+    # This setup is typically used for synchronizing measurements across devices
+    session.connect_clock_terminals(OSCILLATOR, PXI_CLK10_IN)
+    
+    # Perform measurements or operations that require synchronization
+    
+    # Once operations are complete, disconnect the terminals
+    session.disconnect_clock_terminals(OSCILLATOR, PXI_CLK10_IN)
+```
+
+# License
+
+**nisync** is licensed under an MIT-style license (see
+[LICENSE](https://github.com/ni/nisync-python/blob/main/LICENSE)).
+Other incorporated projects may be licensed under different licenses. All
+licenses allow for non-commercial and commercial use.
+

nisync-0.1/README.md

@@ -0,0 +1,111 @@
+| **Info**      | Contains a Python API for interacting with NI-Sync. See [GitHub](https://github.com/ni/nisync-python/) for the latest source. | 
+| :------------ | :---------------------| 
+| **Author**    | National Instruments  | 
+
+# Table of Contents
+- [About](#about)
+  - [Documentation](#documentation)
+  - [Implementation](#implementation)
+  - [Supported NI-Sync Driver Versions](#supported-ni-sync-driver-versions)
+  - [Operating System Support](#operating-system-support)
+  - [Python Version Support](#python-version-support)
+- [Installation](#installation)
+  - [Manual Driver Installation](#manual-driver-installation)
+- [Getting Started](#getting-started)
+- [Usage](#usage)
+  - [Python Examples](#python-examples)
+- [License](#license)
+
+# About
+
+The **nisync** package allows you to develop timing and synchronization applications 
+for both time-based and signal-based synchronizations with NI-Sync devices in Python.
+
+## Documentation
+
+Refer to the [NI-Sync User Manual](https://www.ni.com/docs/en-US/bundle/ni-sync/page/user-manual-welcome.html)
+for API-agnostic information about NI-Sync concepts.
+
+## Implementation
+
+The package is implemented in Python as an 
+object-oriented wrapper around the NI-Sync C API using the
+[ctypes](https://docs.python.org/3/library/ctypes.html) Python library.
+
+## Supported NI-Sync Driver Versions
+
+**nisync** supports all versions of NI-Sync. Some functions in the **nisync** 
+package may be unavailable with earlier versions of NI-Sync driver. Refer to 
+the [Installation](#installation) section for details on how to install the latest version 
+of the NI-Sync driver.
+
+## Operating System Support
+
+**nisync** supports Windows and Linux operating systems where the NI-Sync
+driver is supported. Refer to
+[NI Hardware and Operating System Compatibility](https://www.ni.com/r/hw-support)
+for which versions of the driver support your hardware on a given operating
+system.
+
+## Python Version Support
+
+**nisync** supports CPython 3.8+ and PyPy3.
+
+# Installation
+ 
+Running **nisync** requires NI-Sync to be installed.
+**nisync** can be installed with [pip](http://pypi.python.org/pypi/pip>):
+
+```shell
+python -m pip install nisync
+```
+
+## Manual Driver Installation
+
+Visit [ni.com/downloads](http://www.ni.com/downloads/) to download the latest
+version of NI-Sync. None of the recommended **Additional items** are required
+for **nisync** to function, and they can be removed to minimize installation
+size. It is recommended you continue to install the **NI Certificates** package
+to allow your Operating System to trust NI built binaries, improving your
+software and hardware installation experience.
+
+# Getting Started
+
+In order to use the **nisync** package, you must have at least one device that supports NI-Sync 
+installed on your system. Both physical and simulated devices are supported.
+You can use **NI MAX** or **NI Hardware Configuration Utility** to verify and configure your devices.
+
+Finding and configuring device name in **NI MAX**:
+![NI Max Device Name](https://github.com/ni/nisync-python/blob/a3b91643a1e110fbc3a6bc9c5dc517f74c13ee80/docs/img/max_device_name.png)
+
+Finding and configuring device name in **NI Hardware Configuration Utility**:
+![NI HWCU Device Name](https://github.com/ni/nisync-python/blob/a3b91643a1e110fbc3a6bc9c5dc517f74c13ee80/docs/img/hwcu_device_name.png)
+
+
+# Usage
+The following is a basic example of using an **nisync.nisync.Session** object. This example illustrates how to connect and disconnect clock terminals to synchronize devices using the onboard oscillator as the clock source. This is particularly useful in applications requiring precise timing and synchronization across multiple devices.
+
+## Python Examples
+
+```python
+import nisync
+from nisync.constants import PXI_CLK10_IN, OSCILLATOR
+
+# Create a new session with the nisync library
+with nisync.Session(resource_name="PXI1Slot10") as session:
+    # Connect the onboard oscillator to the PXI_CLK10_IN terminal
+    # This setup is typically used for synchronizing measurements across devices
+    session.connect_clock_terminals(OSCILLATOR, PXI_CLK10_IN)
+    
+    # Perform measurements or operations that require synchronization
+    
+    # Once operations are complete, disconnect the terminals
+    session.disconnect_clock_terminals(OSCILLATOR, PXI_CLK10_IN)
+```
+
+# License
+
+**nisync** is licensed under an MIT-style license (see
+[LICENSE](https://github.com/ni/nisync-python/blob/main/LICENSE)).
+Other incorporated projects may be licensed under different licenses. All
+licenses allow for non-commercial and commercial use.

nisync-0.1/nisync/__init__.py

@@ -0,0 +1,6 @@
+"""NI-Sync Python API."""
+
+from nisync import constants  # noqa: F401
+from nisync import enums  # noqa: F401
+from nisync import errors  # noqa: F401
+from nisync.session import Session  # noqa: F401

nisync-0.1/nisync/_attributes.py

@@ -0,0 +1,35 @@
+class Attribute(object):
+    def __init__(self, attribute_id):
+        self._attribute_id = attribute_id
+
+
+class AttributeViInt32(Attribute):
+    def __get__(self, session, session_type):
+        return session._get_attribute_vi_int32(self._attribute_id)
+
+    def __set__(self, session, value):
+        session._set_attribute_vi_int32(self._attribute_id, value)
+
+
+class AttributeViReal64(Attribute):
+    def __get__(self, session, session_type):
+        return session._get_attribute_vi_real64(self._attribute_id)
+
+    def __set__(self, session, value):
+        session._set_attribute_vi_real64(self._attribute_id, value)
+
+
+class AttributeViBoolean(Attribute):
+    def __get__(self, session, session_type):
+        return session._get_attribute_vi_boolean(self._attribute_id)
+
+    def __set__(self, session, value):
+        session._set_attribute_vi_boolean(self._attribute_id, value)
+
+
+class AttributeViString(Attribute):
+    def __get__(self, session, session_type):
+        return session._get_attribute_vi_string(self._attribute_id)
+
+    def __set__(self, session, value):
+        session._set_attribute_vi_string(self._attribute_id, value)