nitclk 1.0, nidigital 0.4, and 1.2 of other modules

• ALL

  • Added

    • Zip file per driver for all examples and any helper files
    • Link to zip file on examples documentation
    • Support for Python 3.8

  • Changed

    • import_attribute_configuration_buffer() now accepts list of numbers that are integers less than 255, array.array('b'), bytes, bytearray for configuration buffer - #1013
    • export_attribute_configuration_buffer() now returns bytes as the buffer type - #1013

  • Removed

    • Python 2.7 support - Python Software Foundation version status
    • Python 3.4 support - Python Software Foundation PEP 429
    • PyPy and PyPy3 support #1271

• NI-DCPower

  • Added

    • create_advanced_sequence() - #504
      • Instead of a list of attribute IDs, you pass in a list of property names as strings
      • Includes example to see how to use it
      • Additional methods and properties that were made public (rather than private)
        • create_advanced_sequence_step()
        • delete_advanced_sequence()
        • active_advanced_sequence
        • active_advanced_sequence_step

• NI-FGEN

  • Added

    • nifgen.Session.import_attribute_configuration_file()
    • nifgen.Session.import_attribute_configuration_buffer()
    • nifgen.Session.export_attribute_configuration_file()
    • nifgen.Session.export_attribute_configuration_buffer()
    • nifgen.Session.get_channel_name()

  • Changed

    • nifgen.Session.send_software_edge_trigger() now takes two parameters - trigger and trigger_id
      • See documentation on how to call this function
      • Calling the previous way will log a DeprecationWarning to the warning subsystem
      • #1300

• NI-Digital Pattern Driver

  • Added

    • conditional_jump_triggers and pattern_opcode_events repeated capabilities - #1191, #1192

  • Changed

    • write_source_waveform_site_unique() now supports numpy.array and list as site waveform types
    • fetch_history_ram_cycle_information method now supports fetching multiple History RAM samples in a single API call - #1071
    • Update methods that require pin_list to be passed in, such that pin_list can be passed in via pins repeated capability - #1294

  • Removed

    • Removed redundant (redundant because corresponding properties can be used instead) API methods - #1065
    • Removed programmatic pin map creation API - #1124
    • Removed fetch_history_ram_cycle_pin_data and fetch_history_ram_scan_cycle_number. They are not needed since fetch_history_ram_cycle_information
      was updated to return class instances that contains cycle pin data and scan cycle number - #1071

• NI-TClk

  • Changed

    • Method parameters and properties that are time based now take or return a datetime.timedelta object

  • Removed

    • Ability to pass an integer as a session / session reference
    • nitclk.SessionReference.script_trigger_master_session removed - repeated capabilities not supported on nitclk attributes - #1221

Fix Linux support, Update "Driver Version Tested Against" in documentation

• ALL

  • Changed

    • Fix #1140: Linux support was accidentally broken.
    • Update "Driver Version Tested Against", in documentation, with latest versions installed on nimi-bot.

nidigital improvements and bug fixes, Python 3.8 support, nise to 1.1.4

• ALL

  • Added

    • Support for Python 3.8
    • ViUInt8 is now a valid type in APIs

• NI-Digital Pattern Driver

  • Added

    • fetch_capture_waveform() - returns dictionary { site: data, site: data, ... }
    • write_source_waveform_site_unique() - takes waveform_name and dictionary { site: data, site: data, ... }
    • pins is now a valid repeated capability

  • Changed

    • Fix get/set properties - #1062
    • Removed array-size parameter from apply_tdr_offsets() and write_source_waveform_broadcast_u32() methods - #1070
    • Renamed write_source_waveform_broadcast_u32() to write_source_waveform_broadcast()
    • get_pin_results_pin_information() - returns namedtuple PinInfo(pin_indexes, site_numbers, channel_indexes)

• NI Switch Executive

  • Changed

    • Version updated to 1.1.4 to match other released nimi-python modules

NI-TClk initial release, niSwitchExecutive to 1.0, correctly identify phase, other minor fixes

1.1.3 - 2019-10-21

• ALL

  • Changed

    • The development status in setup.py will be based on the module version:
      • version >= 1.0
        • .devN or .aN - Alpha
        • .bN, .cN or .rcN - Beta
        • <nothing> or .postN - Stable
      • version < 1.0 and version >= 0.5 - Beta
      • version < 0.5 - Alpha
    • Improved installation instructions by not putting a version to pin to. This is confusing in master (what read the docs shows by default) since that version doesn't exist yet.

• NI-DCPower

  • Changed

    • Fix type of sequence_step_delta_time_enabled property - #1015

• NI-FGEN

  • Removed

    • configure_custom_fir_filter_coefficients() - #996 - Should have been removed as part of - #891

• NI-SCOPE

  • Added

    • cable_sense_signal_enable, cable_sense_voltage, cable_sense_mode properties and associated enum
    • enabled_channels, product_code properties
    • glitch_condition, glitch_polarity, glitch_width properties and associated enums
    • 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

• NI Switch Executive

  • Changed

    • Update to 1.0 - now ready for production use

• NI-Digital Pattern Driver

  • Added

    • Initial support
    • Very basic at this point and subject to change
    • Looking for any testing and/or feedback
    • get_channel_name_from_string()

  • Changed

    • New enums:

      Enum name	Where used
      DigitalEdge	digital_edge_conditional_jump_trigger_edge, digital_edge_start_trigger_edge
      ApertureTimeUnits	ppmu_aperture_time_units, ppmu_configure_aperture_time(units)
      PPMUOutputFunction	ppmu_output_function
      SelectedFunction	selected_function
      TDREndpointTermination	tdr_endpoint_termination
      Signal	export_signal(signal)

    • [Source Breaker] No longer return the "actual size" from functions that use 'ivi-dance-with-a-twist'. This only affects nidigital.

  • Removed

    • Should be private - get_session_state(), get_desired_attribute_*(), ppmu_measure_cached(), read_static_cached(), configure_ref_clock(), disable(),
      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

Minor bug fixes

• ALL

  • Changed

    • Switched to slightly different metadata format - Actual True/False instead of strings
    • New internal process for generating metadata

• NI-FGEN

  • Changed

    • Enum values for HardwareState were incorrect - fix to match niFgen.h

• NI-SCOPE

  • Changed

    • Fixed enum values for TIME_HISTOGRAM_MEAN_PLUS_STDEV, TIME_HISTOGRAM_MEAN_PLUS_2_STDEV, HF_REJECT and `LF_REJECT

Bug fixes and updated metadata

• ALL

  • Changed

    • Updated generated metadata
    • Updated "Driver Version Tested Against"
    • Update visatype definitions to work on Linux as well as Windows - #911

• NI-DMM

  • Added

    • import_attribute_configuration_file function
    • export_attribute_configuration_file function
    • import_attribute_configuration_buffer function
    • import_attribute_configuration_buffer function

• NI-DCPower

  • Added

    • import_attribute_configuration_file function
    • export_attribute_configuration_file function
    • import_attribute_configuration_buffer function
    • import_attribute_configuration_buffer function

• NI-SCOPE

  • Added

    • import_attribute_configuration_file function
    • export_attribute_configuration_file function
    • import_attribute_configuration_buffer function
    • import_attribute_configuration_buffer function

Bug fixes

• ALL

  • Added

    • Support for Python 3.7 - #895
    • __version__ for all drivers - #928

  • Changed

    • No longer globally set warnings filter for DriverWarning - if you want all warnings from the driver, you will need to set warnings.filterwarnings("always", category=<driver>.DriverWarning) in your code
    • Fix __repr__ for niscope.WaveformInfo - #920

• NI-SCOPE

  • Changed

    • Format of output of wavefrom_info.str()

• NI Switch Executive

  • Added

    • Initial Release

Official 1.0 release

1.0.0 - 2018-06-08

• ALL

  • Removed

    • Explicitly disallow using a repeated capability on Session. session[0].vertical_range = 1.0 will no longer work. Instead use session.channels[0].vertical_range = 1.0 - #853

• NI-DMM

  • Changed

    • Fixed name freq_voltage_autorange became freq_voltage_auto_range

  • Removed

    • configure_ac_bandwidth() - #875
    • configure_open_cable_comp_values() - #875
    • configure_power_line_frequency() - #875
    • configure_short_cable_comp_values() - #875
    • get_aperture_time_info() - #875
    • get_auto_range_value() - #875
    • get_measurement_period() - #875
    • latency - #875
    • shunt_value - #875
    • meas_dest_slope - #875
    • sample_trigger_slope - #875
    • trigger_slope - #875

• NI-ModInst

  • Changed

    • Double close will now allow NI-ModInst to return error

• NI-Switch

  • Removed

    • cabled_module_scan_advanced_bus - #881
    • cabled_module_trigger_bus - #881
    • master_slave_scan_advanced_bus - #881
    • master_slave_trigger_bus - #881
    • parsed_scan_list - #881
    • trigger_mode - #881
    • scan_advanced_polarity - #881
    • trigger_input_polarity - #881
    • configure_scan_list() - #881
    • configure_scan_trigger() - #881
    • route_trigger_input() - #881
    • set_continuous_scan() - #881

• NI-DCPower

  • Removed

    • Remove trigger configuration methods, use attributes instead #860
      • configure_digital_edge_measure_trigger() - use session.digital_edge_measure_trigger_edge & session.digital_edge_measure_trigger_input_terminal
      • configure_digital_edge_pulse_trigger() - use session.digital_edge_pulse_trigger_edge & session.digital_edge_pulse_trigger_input_terminal
      • configure_digital_edge_sequence_advance_trigger() - use session.digital_edge_sequence_advance_trigger_edge & session.digital_edge_sequence_advance_trigger_input_terminal
      • configure_digital_edge_source_trigger() - use session.digital_edge_source_trigger_edge & session.digital_edge_source_trigger_input_terminal
      • configure_digital_edge_start_trigger() - use session.digital_edge_start_trigger_edge & session.digital_edge_start_trigger_input_terminal
    • Remove polarity attributes for triggers that are PXI backplane only (only support rising edge) #860
      • digital_edge_measure_trigger_edge
      • digital_edge_pulse_trigger_edge
      • digital_edge_sequence_advance_trigger_edge
      • digital_edge_source_trigger_edge
      • digital_edge_start_trigger_edge

• NI-FGEN

  • Changed

    • num_channels attribute renamed to channel_count - now consistent with other drivers
    • send_software_edge_trigger() no longer takes any parameters.
      • To send a start software trigger, call it on the session directly:
        python session.send_software_edge_trigger()
      • To send a script software trigger, call it on the script triggers container:
        python session.script_triggers[1].send_software_edge_trigger()

  • Removed

    • Remove trigger configuration methods, use attributes instead #860
      • configure_digital_edge_script_trigger() - use session.digital_edge_script_trigger_source & session.digital_edge_script_trigger_edge
      • configure_digital_level_script_trigger() - use session.digital_level_script_trigger_source & session.digital_level_script_trigger_active_level
      • configure_digital_edge_start_trigger() - use session.digital_edge_start_trigger_source & session.digital_edge_start_trigger_edge
    • Removed get_fir_filter_coefficients() - #535, #596

• NI-SCOPE

  • Added

    • niscope_fetch_forever.py example

  • Removed

    • Removed default value for level parameter on configure_trigger_edge()
      • parameter list is now

        configure_trigger_edge(self, trigger_source, level, trigger_coupling, slope=enums.TriggerSlope.POSITIVE, holdoff=datetime.timedelta(seconds=0.0), delay=datetime.timedelta(seconds=0.0))

    • Removed default values for level and hysteresis parameters on configure_trigger_hysteresis()
      • parameter list is now

        configure_trigger_hysteresis(self, trigger_source, level, hysteresis, trigger_coupling, slope=enums.TriggerSlope.POSITIVE, holdoff=datetime.timedelta(seconds=0.0), delay=datetime.timedelta(seconds=0.0))

API and Documentation cleanup

• ALL

  • Added

    • Add session.lock() and session.unlock() to all drivers except nimodinst - #846
    • session.lock() returns a context manager for managing locks - #846
    • Fix thread-safety issues by using IVI session lock where aplicable

  • Changed

    • SelfTestError now inherits from <driver>.Error rather than Exception - #830
    • Warning class name changed to <driver>.DriverWarning for all drivers - #658

  • Removed

    • IVI properties as applicable - some were already removed from some drivers #824
      • engine_major_version
      • engine_minor_version
      • engine_revision
      • primary_error
      • secondary_error
      • error_elaboration
      • io_session_type
      • io_session / visa_rm_session
      • group_capabilities
      • interchange_check
      • range_check
      • record_coercions
      • specific_driver_class_spec_major_version
      • specific_driver_class_spec_minor_version
      • query_instrument_status
      • cache
      • specific_driver_prefix

• NI-DCPower

  • Removed

    • export_signal() - #828
    • active_advanced_sequence #832
    • active_advanced_sequence_step #832
    • Default value for trigger parameter on send_software_edge_trigger() #832

• NI-FGEN

  • Changed

    • Some functions missed setting repeated capabilities, leaving these as parameters instead of using the repeated capabilites object.
      • session.configure_digital_edge_script_trigger('ScriptTrigger0', source, ...) becomes session.script_triggers[0].configure_digital_edge_script_trigger(source, ...)
      • session.configure_digital_level_script_trigger('ScriptTrigger0', source, ...) becomes session.script_triggers[0].configure_digital_level_script_trigger(source, ...)

  • Removed

    • export_signal() - #828
    • osp_fir_filter_interpolation - #864
    • osp_fir_filter_gaussian_bt - #864
    • osp_fir_filter_flat_passband - #864
    • osp_fir_filter_enabled - #864
    • osp_enabled - #864
    • osp_data_processing_mode - #864
    • osp_compensate_for_filter_group_delay - #864
    • osp_cic_filter_interpolation - #864
    • osp_cic_filter_gain - #864
    • osp_cic_filter_enabled - #864
    • osp_carrier_phase_q - #864
    • osp_carrier_phase_i - #864
    • osp_carrier_frequency - #864
    • osp_carrier_enabled - #864
    • osp_pre_filter_offset_q - #864
    • osp_pre_filter_offset_i - #864
    • osp_pre_filter_gain_q - #864
    • osp_pre_filter_gain_i - #864
    • osp_overflow_status - #864
    • osp_overflow_error_reporting - #864
    • osp_mode - #864
    • osp_frequency_shift - #864
    • osp_fir_filter_type - #864
    • osp_fir_filter_root_raised_cosine_alpha - #864
    • osp_fir_filter_raised_cosine_alpha - #864
    • ready_for_start_event_level_active_level - #859
    • started_event_level_active_level - #859
    • done_event_level_active_level - #859
    • started_event_output_behavior - #859
    • done_event_output_behavior - #859
    • marker_event_output_behavior - #859
    • marker_event_pulse_polarity - #859
    • started_event_pulse_polarity - #859
    • done_event_pulse_polarity - #859
    • started_event_pulse_width - #859
    • done_event_pulse_width - #859
    • marker_event_pulse_width - #859
    • started_event_pulse_width_units - #859
    • done_event_pulse_width_units - #859
    • marker_event_pulse_width_units - #859
    • marker_event_toggle_initial_state - #859
    • marker_event_live_status - #859
    • ready_for_start_event_live_status - #859
    • marker_event_latched_status - #859
    • done_event_latched_status - #859
    • started_event_latched_status - #859
    • marker_event_delay - #859
    • started_event_delay - #859
    • done_event_delay - #859
    • marker_event_delay_units - #859
    • started_event_delay_units - #859
    • done_event_delay_units - #859
    • direct_dma_enabled - #858
    • direct_dma_windowaddress - #858
    • direct_dma_window_size #858
    • gain_dac_value - #88
    • offset_dac_vaue - #858
    • id_query_respone - #858
    • oscillator_freq_ac_value - #858
    • oscillator_phase_dac_vale - #858
    • post_amplifier_attenuatio - #858
    • pre_amplifier_attenuation - #858
    • p2p_endpoint_fullness_strt_trigger_level - #858
    • pci_dma_optimizations_enabled - #858
    • sample_clock_absolute_delay- #858
    • synchronization - #858
    • sync_duty_cycl_high - #858
    • sync_out_output_terinal - #858
    • trigger_source - #858
    • video_wavefor_type - #858

• NI-SCOPE

  • Removed

    • Properties removed
      • stream_relative_to #825
      • oscillator_phase_dac_value #825
      • mux_mode_register #825
      • ddc_center_frequency #823
      • ddc_data_processing_mode #823
      • ddc_enabled #823
      • ddc_frequency_translation_enabled #823
      • ddc_frequency_translation_phase_i #823
      • ddc_frequency_translation_phase_q [#823](#823...

More API Clean up - multiple source breakers

• ALL

  • Changed

    • All exceptions raised by the Python bindings inherit from <driver>.Error
    • Exception type formerly known as <driver>.Error is now known as <driver>.DriverError
      • This encapsulates any error that is returned by the underlying driver
    • All timeout parameters can now also take a simple number in seconds. timeout=datetime.timedelta(milliseconds=100) and timeout=0.1 are identical. #796

• NI-DMM

  • Changed

    • Enum values that start with an underscore + digit have been renamed
      • Function._2_WIRE_RES --> Function.TWO_WIRE_RES
      • Function._4_WIRE_RES --> Function.FOUR_WIRE_RES
      • ThermistorType._44004 --> ThermistorType.THERMISTOR_44004
      • ThermistorType._44006 --> ThermistorType.THERMISTOR_44006
      • ThermistorType._44007 --> ThermistorType.THERMISTOR_44007
      • TransducerType._2_WIRE_RTD --> TransducerType.TWO_WIRE_RTD
      • TransducerType._4_WIRE_RTD --> TransducerType.FOUR_WIRE_RTD
    • Session.get_ext_cal_recommended_interval() now returns a datetime.timedelta for the interval #794

• NI-DCPower

  • Changed

    • Session.fetch_multiple() and Session.measure_multiple() now return list of named tuples instead of multiple arrays. See fetch_multiple and measure_multiple
    • Session.cal_self_calibration() renamed to Session.self_cal() to match other drivers - issue #615
    • Session.set_sequence() values parameter no longer has a default value and must be passed in. Parameter order has changed as a result of this - issue #797
    • Session constructor channel parameter can now use any channel format that repeated capabilities can use #807
    • Session.get_ext_cal_recommended_interval() now returns a datetime.timedelta for the interval #794

  • Removed

    • Advanced Sequence functions - until #504 can be fixed in a proper way
      • create_advanced_sequence()
      • create_advanced_sequence_step()
      • delete_advanced_sequence()

• NI-FGEN

  • Changed

    • Session.export_signal() signal_identifier now has a default of "". This moves it to the end of the parameter list #801
    • Session.get_ext_cal_recommended_interval() now returns a datetime.timedelta for the interval #794

  • Removed

    • Session.cal_adc_input attribute and Session.enums.CalADCInput enum - External Cal not supported in Python
    • Session constructor channel parameter can now use any channel format that repeated capabilities can use #807

• NI-SCOPE

  • Changed

    • Session.fetch(), Session.read() and Session.fetch_into() updated
      • Takes additional parameters that modify fetch behavior
      • Add resulting record as part of the waveform info
      • Channel name and record number added to waveform info
      • See documentation for fetch,
        read,
        and fetch_into for more details.
    • Rename wfm parameter to waveform in fetch() and fetch_into()
    • Enum values and attribute names that start with an underscore + digit have been renamed
      • Session._5102_adjust_pretrigger_samples --> Session.adjust_pretrigger_samples_5102
      • Session._5v_out_output_terminal --> Session.five_v_out_output_terminal
      • ExportableSignals._5V_OUT --> ExportableSignals.FIVE_V_OUT
      • FlexFIRAntialiasFilterType._48_TAP_STANDARD --> FlexFIRAntialiasFilterType.FOURTYEIGHT_TAP_STANDARD
      • FlexFIRAntialiasFilterType._48_TAP_HANNING --> FlexFIRAntialiasFilterType.FOURTYEIGHT_TAP_HANNING
      • FlexFIRAntialiasFilterType._16_TAP_HANNING --> FlexFIRAntialiasFilterType.SIXTEEN_TAP_HANNING
      • FlexFIRAntialiasFilterType._8_TAP_HANNING --> FlexFIRAntialiasFilterType.EIGHT_TAP_HANNING
      • VideoSignalFormat._480I_59_94_FIELDS_PER_SECOND --> VideoSignalFormat.VIDEO_480I_59_94_FIELDS_PER_SECOND
      • VideoSignalFormat._480I_60_FIELDS_PER_SECOND --> VideoSignalFormat.VIDEO_480I_60_FIELDS_PER_SECOND
      • VideoSignalFormat._480P_59_94_FRAMES_PER_SECOND --> VideoSignalFormat.VIDEO_480P_59_94_FRAMES_PER_SECOND
      • VideoSignalFormat._480P_60_FRAMES_PER_SECOND --> VideoSignalFormat.VIDEO_480P_60_FRAMES_PER_SECOND
      • VideoSignalFormat._576I_50_FIELDS_PER_SECOND --> VideoSignalFormat.VIDEO_576I_50_FIELDS_PER_SECOND
      • VideoSignalFormat._576P_50_FRAMES_PER_SECOND --> VideoSignalFormat.VIDEO_576P_50_FRAMES_PER_SECOND
      • VideoSignalFormat._720P_50_FRAMES_PER_SECOND --> VideoSignalFormat.VIDEO_720P_50_FRAMES_PER_SECOND
      • VideoSignalFormat._720P_59_94_FRAMES_PER_SECOND --> VideoSignalFormat.VIDEO_720P_59_94_FRAMES_PER_SECOND
      • VideoSignalFormat._720P_60_FRAMES_PER_SECOND --> VideoSignalFormat.VIDEO_720P_60_FRAMES_PER_SECOND
      • VideoSignalFormat._1080I_50_FIELDS_PER_SECOND --> VideoSignalFormat.VIDEO_1080I_50_FIELDS_PER_SECOND
      • VideoSignalFormat._1080I_59_94_FIELDS_PER_SECOND --> VideoSignalFormat.VIDEO_1080I_59_94_FIELDS_PER_SECOND
      • VideoSignalFormat._1080I_60_FIELDS_PER_SECOND --> VideoSignalFormat.VIDEO_1080I_60_FIELDS_PER_SECOND
      • VideoSignalFormat._1080P_24_FRAMES_PER_SECOND --> VideoSignalFormat.VIDEO_1080P_24_FRAMES_PER_SECOND
    • Session.cal_self_calibration() renamed to Session.self_cal() to match other drivers - issue #615

  • Removed

    • Following properties are now removed (use parameters to fetch calls):
      • fetch_relative_to
      • fetch_offset
      • fetch_record_number
      • fetch_num_records
    • Removed number_of_coefficients parameter from get_equalization_filter_coefficients()
    • Removed Measurement Library waveform methods and properties - issue #809
      • actual_meas_wfm_size()
      • add_waveform_processing()
      • clear_waveform_processing()
      • fetch_array_measurement()
      • clear_waveform_measurement_stats()
      • fetch_measurement()
      • fetch_measurement_stats()
      • read_measurement()
      • configure_ref_levels()
      • meas_ref_level_units
      • meas_other_channel
      • meas_hysteresis_percent
      • meas_last_acq_histogram_size
      • meas_voltage_histogram_size
      • meas_voltage_histogram_low_volts
      • meas_voltage_histogram_high_volts
      • meas_time_histogram_size
      • meas_time_histogram_low_volts
      • meas_time_histogram_high_volts
      • meas_time_histogram_low_time
      • meas_time_histogram_high_time
      • meas_polynomial_interpolation_order
      • meas_interpolation_sampling_factor
      • meas_filter_cutoff_freq
      • meas_filter_center_freq
      • meas_filter_ripple
      • meas_filter_transient_waveform_percent
      • meas_filter_type
      • meas_filter_order
      • meas_filter_taps
      • meas_chan_low_ref_level
      • meas_chan_mid_ref_level
      • meas_chan_high_ref_level
      • meas_filter_width
      • meas_fir_filter_window
      • meas_array_gain
      • meas_array_offset
      • meas_percentage_method
      • fetch_meas_num_samples