Add simple nidigital API - no Pythonic niceties

CHANGELOG.md

@@ -50,7 +50,14 @@ All notable changes to this project will be documented in this file.
     * #### Added
     * #### Changed
     * #### Removed
-
+* ### NI-Digital Pattern Driver
+    * #### Added
+        * Initial support
+        * Very basic at this point and subject to change
+        * Looking for any testing and/or feedback
+    * #### Changed
+    * #### Removed
+
 
 ## 1.1.2 - 2019-06-06
 * ### ALL
@@ -750,6 +757,10 @@ and this project adheres to [Python Versioning](http://legacy.python.org/dev/pep
     * #### Added
     * #### Changed
     * #### Removed
+* ### NI-Digital Pattern Driver
+    * #### Added
+    * #### Changed
+    * #### Removed
 -->
 
 

Makefile

@@ -1,7 +1,7 @@
 # In alphabetical order except put nifake first and nimodinst last
 # - nifake first to get the most code generator coverage
 # - nimodinst last so that the version from nimodinst is used for any global versions (docs/conf.py)
-ALL_DRIVERS := nifake nidcpower nidmm nifgen niscope niswitch nise nimodinst
+ALL_DRIVERS := nifake nidcpower nidigital nidmm nifgen niscope niswitch nise nimodinst
 DRIVERS ?= $(ALL_DRIVERS)
 
 ROOT_DIR := $(abspath .)

README.rst

@@ -105,6 +105,47 @@ NI-DCPower Python API Status
 
 
 
+NI-Digital Pattern Driver Python API Status
+-------------------------------------------
+
++---------------------------------------+--------------------------+
+| NI-Digital Pattern Driver (nidigital) |                          |
++=======================================+==========================+
+| Driver Version Tested Against         | 19.1.0                   |
++---------------------------------------+--------------------------+
+| Driver API Version                    | 19.0.0d32                |
++---------------------------------------+--------------------------+
+| PyPI Version                          | |nidigitalLatestVersion| |
++---------------------------------------+--------------------------+
+| Supported Python Version              | |nidigitalPythonVersion| |
++---------------------------------------+--------------------------+
+| Open Issues                           | |nidigitalOpenIssues|    |
++---------------------------------------+--------------------------+
+| Open Pull Requests                    | |nidigitalOpenPRs|       |
++---------------------------------------+--------------------------+
+
+
+.. |nidigitalLatestVersion| image:: http://img.shields.io/pypi/v/nidigital.svg
+    :alt: Latest NI-Digital Pattern Driver Version
+    :target: http://pypi.python.org/pypi/nidigital
+
+
+.. |nidigitalPythonVersion| image:: http://img.shields.io/pypi/pyversions/nidigital.svg
+    :alt: NI-Digital Pattern Driver supported Python versions
+    :target: http://pypi.python.org/pypi/nidigital
+
+
+.. |nidigitalOpenIssues| image:: https://img.shields.io/github/issues/ni/nimi-python/nidigital.svg
+    :alt: Open Issues + Pull Requests for NI-Digital Pattern Driver
+    :target: https://github.com/ni/nimi-python/issues?q=is%3Aopen+is%3Aissue+label%3Anidigital
+
+
+.. |nidigitalOpenPRs| image:: https://img.shields.io/github/issues-pr/ni/nimi-python/nidigital.svg
+    :alt: Pull Requests for NI-Digital Pattern Driver
+    :target: https://github.com/ni/nimi-python/pulls?q=is%3Aopen+is%3Aissue+label%3Anidigital
+
+
+
 NI-DMM Python API Status
 ------------------------
 

build/templates/session.py.mako

@@ -22,7 +22,7 @@ ${template_parameters['encoding_tag']}
 %>\
 import array  # noqa: F401
 import ctypes
-import datetime
+import datetime  # noqa: F401
 % if config['use_locking']:
 # Used by @ivi_synchronized
 from functools import wraps

docs/_static/nidigital_usage.inc

@@ -0,0 +1,15 @@
+Usage
+------
+
+The following is a basic example of using the **nidigital** module to open a session to a ....
+
+.. code-block:: python
+
+    import nidigital
+    # Configure the session.
+
+    with nidigital.Session(resource_name='PXI1Slot2', channels='0') as session:
+        pass
+
+Additional examples for NI-Digital are located in src/nidigital/examples/ directory.
+

docs/nidigital/enums.rst

@@ -0,0 +1,27 @@
+Enums
+=====
+
+Enums used in NI-Digital Pattern Driver
+
+.. py:currentmodule:: nidigital
+
+
+TerminationMode
+---------------
+
+.. py:class:: TerminationMode
+
+    .. py:attribute:: TerminationMode.ACTIVE_LOAD
+
+
+
+    .. py:attribute:: TerminationMode.VTERM
+
+
+
+    .. py:attribute:: TerminationMode.HIGH_Z
+
+
+
+
+

docs/nidigital/errors.rst

@@ -0,0 +1,62 @@
+Exceptions and Warnings
+=======================
+
+DriverError
+-----------
+
+    .. py:currentmodule:: nidigital
+
+    .. exception:: DriverError
+
+        An error originating from the NI-Digital Pattern Driver driver
+
+
+UnsupportedConfigurationError
+-----------------------------
+
+    .. py:currentmodule:: nidigital
+
+    .. exception:: UnsupportedConfigurationError
+
+        An error due to using this module in an usupported platform.
+
+DriverNotInstalledError
+-----------------------
+
+    .. py:currentmodule:: nidigital
+
+    .. exception:: DriverNotInstalledError
+
+        An error due to using this module without the driver runtime installed.
+
+InvalidRepeatedCapabilityError
+------------------------------
+
+    .. py:currentmodule:: nidigital
+
+    .. exception:: InvalidRepeatedCapabilityError
+
+        An error due to an invalid character in a repeated capability
+
+
+SelfTestError
+-------------
+
+    .. py:currentmodule:: nidigital
+
+    .. exception:: SelfTestError
+
+        An error due to a failed self-test
+
+
+DriverWarning
+-------------
+
+    .. py:currentmodule:: nidigital
+
+    .. exception:: DriverWarning
+
+        A warning originating from the NI-Digital Pattern Driver driver
+
+
+

docs/nidigital/examples.rst

@@ -0,0 +1,12 @@
+Examples
+========
+
+nidigital_do_nothing.py
+-----------------------
+
+.. literalinclude:: ../../src/nidigital/examples/nidigital_do_nothing.py
+   :language: python
+   :linenos:
+   :encoding: utf8
+   :caption: `(nidigital_do_nothing.py) <https://github.com/ni/nimi-python/blob/master/src/nidigital/examples/nidigital_do_nothing.py>`_
+

docs/nidigital/installation.inc

@@ -0,0 +1,18 @@
+
+.. _nidigital_installation-section:
+
+Installation
+------------
+
+As a prerequisite to using the nidigital module, you must install the NI-Digital Pattern Driver runtime on your system. Visit `ni.com/downloads <http://www.ni.com/downloads/>`_ to download the driver runtime for your devices.
+
+The nimi-python modules (i.e. for **NI-Digital Pattern Driver**) can be installed with `pip <http://pypi.python.org/pypi/pip>`_::
+
+  $ python -m pip install nidigital~=0.1.0.dev0
+
+Or **easy_install** from
+`setuptools <http://pypi.python.org/pypi/setuptools>`_::
+
+  $ python -m easy_install nidigital
+
+

docs/nidigital/status.inc

@@ -0,0 +1,41 @@
+
+NI-Digital Pattern Driver Python API Status
+-------------------------------------------
+
++---------------------------------------+--------------------------+
+| NI-Digital Pattern Driver (nidigital) |                          |
++=======================================+==========================+
+| Driver Version Tested Against         | 19.1.0                   |
++---------------------------------------+--------------------------+
+| Driver API Version                    | 19.0.0d32                |
++---------------------------------------+--------------------------+
+| PyPI Version                          | |nidigitalLatestVersion| |
++---------------------------------------+--------------------------+
+| Supported Python Version              | |nidigitalPythonVersion| |
++---------------------------------------+--------------------------+
+| Open Issues                           | |nidigitalOpenIssues|    |
++---------------------------------------+--------------------------+
+| Open Pull Requests                    | |nidigitalOpenPRs|       |
++---------------------------------------+--------------------------+
+
+
+.. |nidigitalLatestVersion| image:: http://img.shields.io/pypi/v/nidigital.svg
+    :alt: Latest NI-Digital Pattern Driver Version
+    :target: http://pypi.python.org/pypi/nidigital
+
+
+.. |nidigitalPythonVersion| image:: http://img.shields.io/pypi/pyversions/nidigital.svg
+    :alt: NI-Digital Pattern Driver supported Python versions
+    :target: http://pypi.python.org/pypi/nidigital
+
+
+.. |nidigitalOpenIssues| image:: https://img.shields.io/github/issues/ni/nimi-python/nidigital.svg
+    :alt: Open Issues + Pull Requests for NI-Digital Pattern Driver
+    :target: https://github.com/ni/nimi-python/issues?q=is%3Aopen+is%3Aissue+label%3Anidigital
+
+
+.. |nidigitalOpenPRs| image:: https://img.shields.io/github/issues-pr/ni/nimi-python/nidigital.svg
+    :alt: Pull Requests for NI-Digital Pattern Driver
+    :target: https://github.com/ni/nimi-python/pulls?q=is%3Aopen+is%3Aissue+label%3Anidigital
+
+

docs/nidigital/toc.inc

@@ -0,0 +1,11 @@
+API Reference
+--------------
+
+.. toctree::
+   :maxdepth: 6
+
+   nidigital/class
+   nidigital/enums
+   nidigital/errors
+   nidigital/examples
+

generated/nidcpower/session.py

@@ -2,7 +2,7 @@
 # This file was generated
 import array  # noqa: F401
 import ctypes
-import datetime
+import datetime  # noqa: F401
 # Used by @ivi_synchronized
 from functools import wraps
 

generated/nidigital/__init__.py

@@ -0,0 +1,96 @@
+# -*- coding: utf-8 -*-
+# This file was generated
+
+
+__version__ = '0.1.0.dev0'
+
+from nidigital.enums import *          # noqa: F403,F401,H303
+from nidigital.errors import DriverWarning   # noqa: F401
+from nidigital.errors import Error     # noqa: F401
+from nidigital.session import Session  # noqa: F401
+
+
+def get_diagnostic_information():
+    '''Get diagnostic information about the system state that is suitable for printing or logging
+
+    returns: dict
+
+    note: Python bitness may be incorrect when running in a virtual environment
+    '''
+    import os
+    import pkg_resources
+    import platform
+    import struct
+    import sys
+
+    def is_python_64bit():
+        return (struct.calcsize("P") == 8)
+
+    def is_os_64bit():
+        return platform.machine().endswith('64')
+
+    def is_venv():
+        return 'VIRTUAL_ENV' in os.environ
+
+    info = {}
+    info['os'] = {}
+    info['python'] = {}
+    info['driver'] = {}
+    info['module'] = {}
+    if platform.system() == 'Windows':
+        try:
+            import winreg as winreg
+        except ImportError:
+            import _winreg as winreg
+
+        os_name = 'Windows'
+        try:
+            driver_version_key = winreg.OpenKey(winreg.HKEY_LOCAL_MACHINE, r"SOFTWARE\National Instruments\NI-Digital Pattern Driver\CurrentVersion")
+            driver_version = winreg.QueryValueEx(driver_version_key, "Version")[0]
+        except WindowsError:
+            driver_version = 'Unknown'
+    elif platform.system() == 'Linux':
+        os_name = 'Linux'
+        driver_version = 'Unknown'
+    else:
+        raise SystemError('Unsupported platform: {}'.format(platform.system()))
+
+    installed_packages = pkg_resources.working_set
+    installed_packages_list = [{'name': i.key, 'version': i.version, } for i in installed_packages]
+
+    info['os']['name'] = os_name
+    info['os']['version'] = platform.version()
+    info['os']['bits'] = '64' if is_os_64bit() else '32'
+    info['driver']['name'] = "NI-Digital Pattern Driver"
+    info['driver']['version'] = driver_version
+    info['module']['name'] = 'nidigital'
+    info['module']['version'] = "0.1.0.dev0"
+    info['python']['version'] = sys.version
+    info['python']['bits'] = '64' if is_python_64bit() else '32'
+    info['python']['is_venv'] = is_venv()
+    info['python']['packages'] = installed_packages_list
+
+    return info
+
+
+def print_diagnostic_information():
+    '''Print diagnostic information in a format suitable for issue report
+
+    note: Python bitness may be incorrect when running in a virtual environment
+    '''
+    info = get_diagnostic_information()
+
+    row_format = '    {:<10} {}'
+    for type in ['OS', 'Driver', 'Module', 'Python']:
+        typename = type.lower()
+        print(type + ':')
+        for item in info[typename]:
+            if item != 'packages':
+                print(row_format.format(item.title() + ':', info[typename][item]))
+    print('    Installed Packages:')
+    for p in info['python']['packages']:
+        print((' ' * 8) + p['name'] + '==' + p['version'])
+
+    return info
+
+