[RFC] Add NI-TClk support

CHANGELOG.md

@@ -50,6 +50,7 @@ All notable changes to this project will be documented in this file.
         * `runt_high_threshold`, `runt_low_threshold`, `runt_polarity`, `runt_condition`, `runt_time_high_limit`, `runt_time_low_limit` properties and associated enums
         * `width_condition`, `width_high_threshold`, `width_low_threshold`, `width_polarity` properties and associated enums
     * #### Changed
+        * Fixed enum values for `TIME_HISTOGRAM_MEAN_PLUS_STDEV`, `TIME_HISTOGRAM_MEAN_PLUS_2_STDEV`, `HF_REJECT` and `LF_REJECT`
     * #### Removed
 * ### NI Switch Executive
     * #### Added
@@ -78,8 +79,12 @@ All notable changes to this project will be documented in this file.
             `get_number_of_vectors()`, `get_pattern_file_path()`, `get_pin_type()`, `get_time_set_compare_edges()`, `get_time_set_drive_edges()`,
             `is_pattern_file_modified_since_load()`, `load_levels_internal()`, `load_pattern_internal()`, `load_timing_internal()`, `uncommit()`
         * Need to determine how to generate this function - `fetch_capture_waveform_u32()`
-
-
+* ### NI-TClk
+    * #### Added
+        * Initial support
+    * #### Changed
+    * #### Removed
+
 ## 1.1.2 - 2019-06-06
 * ### ALL
     * #### Changed

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 nidigital nidmm nifgen niscope niswitch nise nimodinst
+ALL_DRIVERS := nifake nitclk nidcpower nidigital nidmm nifgen niscope niswitch nise nimodinst
 DRIVERS ?= $(ALL_DRIVERS)
 
 ROOT_DIR := $(abspath .)

README.rst

@@ -391,6 +391,47 @@ NI-SWITCH Python API Status
     :target: https://github.com/ni/nimi-python/pulls?q=is%3Aopen+is%3Aissue+label%3Aniswitch
 
 
+
+NI-TClk Python API Status
+-------------------------
+
++-------------------------------+-----------------------+
+| NI-TClk (nitclk)              |                       |
++===============================+=======================+
+| Driver Version Tested Against | 18.0.0                |
++-------------------------------+-----------------------+
+| Driver API Version            | 255.0.0d0             |
++-------------------------------+-----------------------+
+| PyPI Version                  | |nitclkLatestVersion| |
++-------------------------------+-----------------------+
+| Supported Python Version      | |nitclkPythonVersion| |
++-------------------------------+-----------------------+
+| Open Issues                   | |nitclkOpenIssues|    |
++-------------------------------+-----------------------+
+| Open Pull Requests            | |nitclkOpenPRs|       |
++-------------------------------+-----------------------+
+
+
+.. |nitclkLatestVersion| image:: http://img.shields.io/pypi/v/nitclk.svg
+    :alt: Latest NI-TClk Version
+    :target: http://pypi.python.org/pypi/nitclk
+
+
+.. |nitclkPythonVersion| image:: http://img.shields.io/pypi/pyversions/nitclk.svg
+    :alt: NI-TClk supported Python versions
+    :target: http://pypi.python.org/pypi/nitclk
+
+
+.. |nitclkOpenIssues| image:: https://img.shields.io/github/issues/ni/nimi-python/nitclk.svg
+    :alt: Open Issues + Pull Requests for NI-TClk
+    :target: https://github.com/ni/nimi-python/issues?q=is%3Aopen+is%3Aissue+label%3Anitclk
+
+
+.. |nitclkOpenPRs| image:: https://img.shields.io/github/issues-pr/ni/nimi-python/nitclk.svg
+    :alt: Pull Requests for NI-TClk
+    :target: https://github.com/ni/nimi-python/pulls?q=is%3Aopen+is%3Aissue+label%3Anitclk
+
+
 .. _installation-section:
 
 Installation

build/helper/codegen_helper.py

@@ -325,10 +325,10 @@ def _get_ctype_variable_definition_snippet_for_scalar(parameter, parameters, ivi
                 for p in corresponding_buffer_parameters:
                     assert p['direction'] == 'out'
                     assert p['size']['mechanism'] != 'fixed-size'
-                definition = '{0}.{1}({2})  # case S190'.format(module_name, parameter['ctypes_type'], parameter['python_name'])
+                definition = '{0}.{1}({2})  # case S210'.format(module_name, parameter['ctypes_type'], parameter['python_name'])
     else:
         assert parameter['direction'] == 'out'
-        definition = '{0}.{1}()  # case S200'.format(module_name, parameter['ctypes_type'])
+        definition = '{0}.{1}()  # case S220'.format(module_name, parameter['ctypes_type'])
 
     if definition is not None:
         definitions.append(parameter['ctypes_variable_name'] + ' = ' + definition)
@@ -348,6 +348,7 @@ def _get_ctype_variable_definition_snippet_for_buffers(parameter, parameters, iv
         B600. Output buffer with mechanism passed-in:                              get_ctypes_pointer_for_buffer(value-array.array('d', [0] * buffer_size, library_type=ViInt32)
         B610. Output buffer with mechanism ivi-dance-with-a-twist, QUERY_SIZE:     None
         B620. Output buffer with mechanism ivi-dance-with-a-twist, GET_DATA:       get_ctypes_pointer_for_buffer(value=array.array('d', [0] * buffer_size_ctype.value, library_type=ViInt32)
+        B630. Input buffer of simple types with converter:                         get_ctypes_pointer_for_buffer(value=convert(array.array('d', list)), library_type=visatype.ViReal64)
 
     Return Value (list): each item in the list will be one line needed for the declaration of that parameter
 
@@ -360,6 +361,19 @@ def _get_ctype_variable_definition_snippet_for_buffers(parameter, parameters, iv
 
     if parameter['numpy'] is True and use_numpy_array is True:
         definition = 'get_ctypes_pointer_for_buffer(value={0})  # case B510'.format(parameter['python_name'])
+    elif parameter['direction'] == 'in' and 'python_api_converter_name' in parameter:
+        if custom_type is not None:
+            assert False, 'Custom type {} is not supported with converters'.format(custom_type)
+        else:
+            if parameter['use_array']:
+                # If the incoming type is array.array, we can just use that, otherwise we need to create an array.array that is initialized with the passed in value, which must be iterable
+                array_declaration = '{0}_array = get_ctypes_and_array(value=_converters.{2}({0}), array_type="{1}")  # case B630'.format(parameter['python_name'], get_array_type_for_api_type(parameter['ctypes_type'], parameter['python_api_converter_name']))
+                definitions.append(array_declaration)
+                definition = 'get_ctypes_pointer_for_buffer(value={0}_array, library_type={1}.{2})  # case B630'.format(parameter['python_name'], module_name, parameter['ctypes_type'])
+            elif parameter['use_list']:
+                definition = 'get_ctypes_pointer_for_buffer(value=_converters.{3}({0}), library_type={1}.{2})  # case B630'.format(parameter['python_name'], module_name, parameter['ctypes_type'], parameter['python_api_converter_name'])
+            else:
+                assert False, "Expected either 'use_array' or 'use_list' to be True. Both False."
     elif parameter['direction'] == 'in':
         if custom_type is not None:
             definition = 'get_ctypes_pointer_for_buffer([{0}.{1}(c) for c in {2}], library_type={0}.{1})  # case B540'.format(module_name, parameter['ctypes_type'], parameter['python_name'], parameter['python_name'])
@@ -1257,14 +1271,14 @@ def test_get_ctype_variable_declaration_snippet_case_s180():
     assert snippet == ["string_size_ctype = _visatype.ViInt32(error_code)  # case S180"]
 
 
-def test_get_ctype_variable_declaration_snippet_case_s190():
+def test_get_ctype_variable_declaration_snippet_case_s210():
     snippet = get_ctype_variable_declaration_snippet(parameters_for_testing[4], parameters_for_testing, IviDanceStep.NOT_APPLICABLE, config_for_testing, use_numpy_array=False)
-    assert snippet == ["number_of_elements_ctype = _visatype.ViInt32(number_of_elements)  # case S190"]
+    assert snippet == ["number_of_elements_ctype = _visatype.ViInt32(number_of_elements)  # case S210"]
 
 
-def test_get_ctype_variable_declaration_snippet_case_s200():
+def test_get_ctype_variable_declaration_snippet_case_s220():
     snippet = get_ctype_variable_declaration_snippet(parameters_for_testing[1], parameters_for_testing, IviDanceStep.NOT_APPLICABLE, config_for_testing, use_numpy_array=False)
-    assert snippet == ["output_ctype = _visatype.ViInt64()  # case S200"]
+    assert snippet == ["output_ctype = _visatype.ViInt64()  # case S220"]
 
 
 def test_get_ctype_variable_declaration_snippet_case_s210():

build/helper/metadata_add_all.py

@@ -292,7 +292,7 @@ def _add_is_session_handle(parameter):
 
 def _fix_type(parameter):
     '''Replace any spaces in the parameter type with an underscore.'''
-    parameter['type'] = parameter['type'].replace('[ ]', '[]').replace(' ', '_')
+    parameter['type'] = parameter['type'].replace('[ ]', '[]').replace(' []', '[]').replace(' ', '_')
 
 
 def _add_use_in_python_api(p, parameters):
@@ -314,7 +314,7 @@ def _setup_init_function(functions, config):
         # Change the init_function information for generating the docstring
         # We are assuming the last parameter is vi out
         for p in init_function['parameters']:
-            if p['name'] == 'vi':
+            if p['name'] == config['session_handle_parameter_name']:
                 p['documentation']['description'] = session_return_text
                 p['type_in_documentation'] = config['module_name'] + '.Session'
                 p['python_name'] = 'session'

build/templates/__init__.py.mako

@@ -1,7 +1,10 @@
 ${template_parameters['encoding_tag']}
 # This file was generated
 <%
+import build.helper as helper
+
 enums = template_parameters['metadata'].enums
+functions = helper.filter_codegen_functions(template_parameters['metadata'].functions)
 config = template_parameters['metadata'].config
 module_name = config['module_name']
 registry_name = config['driver_registry'] if 'driver_registry' in config else config['driver_name']
@@ -14,7 +17,22 @@ from ${module_name}.enums import *          # noqa: F403,F401,H303
 % endif
 from ${module_name}.errors import DriverWarning   # noqa: F401
 from ${module_name}.errors import Error     # noqa: F401
+<%
+# nitclk is different. It does not have a session class that we open a session on
+# Instead it is a bunch of stateless function calls. So if we are NOT building for
+# nitclk, we import the Session class like before. If it is nitclk then we will
+# import each function and the SessionReference class
+%>\
+% if config['module_name'] != 'nitclk':
 from ${module_name}.session import Session  # noqa: F401
+% else:
+from ${module_name}.session import SessionReference  # noqa: F401
+
+# Function imports
+%   for func_name in sorted([functions[k]['python_name'] for k in functions if not functions[k]['render_in_session_base']]):
+from ${module_name}.session import ${func_name}  # noqa: F401
+%   endfor
+% endif
 <%
  # Blank lines are to make each import separate so that they do not need to be sorted
  # Otherwise flake8 test fails

build/templates/_attributes.py.mako

@@ -2,6 +2,7 @@ ${template_parameters['encoding_tag']}
 # This file was generated
 <%
     module_name = template_parameters['metadata'].config['module_name']
+    config = template_parameters['metadata'].config
 %>\
 import ${module_name}._converters as _converters
 
@@ -112,4 +113,18 @@ class AttributeEnum(object):
         return self._underlying_attribute.__set__(session, value.value)
 
 
+% if config['module_name'] == 'nitclk':
+# nitclk specific attribute type
+class AttributeViInt32SessionReference(Attribute):
+
+    def __get__(self, session, session_type):
+        # Import here to avoid a circular dependency when initial import happens
+        from ${module_name}.session import SessionReference
+        return SessionReference(session._get_attribute_vi_int32(self._attribute_id))
+
+    def __set__(self, session, value):
+        session._set_attribute_vi_int32(self._attribute_id, _converters.convert_to_nitclk_session_num(value))
+
+
+% endif
 

build/templates/_converters.py.mako

@@ -215,6 +215,36 @@ def convert_init_with_options_dictionary(values, encoding):
     return init_with_options_string
 
 
+% if config['module_name'] == 'nitclk':
+# nitclk specific converters
+def convert_to_nitclk_session_num(item):
+    '''Convert from supported objects to NI-TClk Session Num
+
+    Supported objects are:
+    - class with .tclk object of type nitclk.SessionReference
+    - nitclk.SessionReference
+    - NI-TClk Session Num
+    '''
+    try:
+        return item.tclk.get_session_number()
+    except KeyError:
+        pass
+
+    try:
+        return item.get_session_number()
+    except KeyError:
+        pass
+
+    # If we haven't gotten a SessionReference, we assume the item is the actual nitclk session num and return it
+    return item
+
+
+def convert_to_nitclk_session_num_list(item_list):
+    '''Converts a list of items to nitclk session nums'''
+    return [convert_to_nitclk_session_num(i) for i in item_list]
+
+
+% endif
 # Let's run some tests
 def test_convert_init_with_options_dictionary():
     assert convert_init_with_options_dictionary('', 'ascii') == ''

docs/_static/nitclk_usage.inc

@@ -0,0 +1,13 @@
+Usage
+------
+
+The following is a basic example of using the **nitclk** module to TBD.
+
+.. code-block:: python
+
+    import nitclk
+    # Configure the session.
+
+
+Additional examples for NI-TClk are located in src/nitclk/examples/ directory.
+

docs/conf.py

@@ -63,7 +63,7 @@
 # built documents.
 #
 # The full version, including alpha/beta/rc tags.
-release = '0.1.1.dev0'
+release = '0.1.0.dev0'
 # The short X.Y version.
 version = release[:3]
 

docs/index.rst

@@ -36,6 +36,7 @@ Refer to your driver documentation for device-specific information and detailed
    niswitch
    nimodinst
    nise
+   nitclk
 
 Indices and tables
 ==================

docs/nitclk.rst

@@ -0,0 +1,10 @@
+nitclk module
+=============================================================
+
+.. include:: nitclk/installation.inc
+
+.. include:: _static/nitclk_usage.inc
+
+.. include:: nitclk/toc.inc
+
+