- Unreleased
- 1.4.5
- 1.4.4
- 1.4.3
- 1.4.2
- 1.4.1
- 1.4.0
- 1.3.3
- 1.3.2
- 1.3.1
- 1.3.0
- 1.2.1
- 1.2.0
- 1.1.5
- 1.1.4
- 1.1.3
- 1.1.2
- 1.1.0
- 1.0.1
- 1.0.0
- 0.9.0
- 0.8.0
- 0.7.0
- 0.6.0
- 0.5.0
- 0.4.0
- 0.3.0
- 0.2.0
- 0.1.0
All notable changes to this project will be documented in this file.
-
-
easy_installsupport
-
-
-
- Pass Python interpreter information if the driver runtime version supports it. This is used by NI in order to better understand client usage.
-
-
-
- Pass Python interpreter information if the driver runtime version supports it. This is used by NI in order to better understand client usage.
-
-
-
- Pass Python interpreter information if the driver runtime version supports it. This is used by NI in order to better understand client usage.
-
-
-
get_channel_names()- Pass Python interpreter information if the driver runtime version supports it. This is used by NI in order to better understand client usage.
-
- Fix #1770: fetch(), read(), and friends return wrong data when called with channel ranges on multi-instrument session.
-
-
-
- Pass Python interpreter information if the driver runtime version supports it. This is used by NI in order to better understand client usage.
-
-
-
- Support for Python 3.11
-
- Fix #1888: Deadlock on multithreaded usage due to UnlockSession always being called with callerHasLock=False.
-
-
-
- Pass Python interpreter information if the driver runtime version supports it. This is used by NI in order to better understand client usage.
- API parity with NI-DCPower 2023 Q2.
- Properties added:
lcr_ac_dither_enabledlcr_ac_electrical_cable_length_delaylcr_dc_bias_transient_responselcr_source_aperture_timemeasure_complete_event_output_behaviormeasure_complete_event_toggle_initial_statesequence_engine_done_event_output_behaviorsequence_engine_done_event_toggle_initial_statesequence_iteration_complete_event_output_behaviorsequence_iteration_complete_event_toggle_initial_statesource_complete_event_output_behaviorsource_complete_event_toggle_initial_state
- Enums added:
CurrentLimitBehaviorEventOutputBehaviorEventToggleInitialStateLCRDCBiasTransientResponse
- Enum values added:
AS_CONFIGUREDadded to enumLCROpenShortLoadCompensationDataSourceNI_STANDARD_0_5Madded to enumCableLength
- Methods added:
configure_lcr_compensationget_lcr_compensation_data
- Properties added:
-
- Enums reordered:
AutoZeroCableLength
- Enums reordered:
-
-
-
- Update
GRPC_SERVICE_INTERFACE_NAMEto use the correct gRPC package name (nidigitalpattern_grpc).
- Update
-
-
-
- Fix #1941: When calling niscope.Session.fetch_array_measurement in a MeasurementLink measurement plugin, meas_wfm_size cannot be set.
- Requires NI gRPC Device Server 2023 Q2 or later. Older versions do not support this parameter and return all available samples.
- Fix #1941: When calling niscope.Session.fetch_array_measurement in a MeasurementLink measurement plugin, meas_wfm_size cannot be set.
-
-
-
- Support for Python 3.10
-
- Support for Python 3.6
-
-
-
- MeasurementLink support
-
- Binary compatibility change for type
LCRLoadCompensationSpoton Linux. Client code using methodnidcpower.Session.perform_lcr_load_compensationon Linux now requires NI-DCPower 2023 Q1 driver runtime or newer.
- Binary compatibility change for type
-
-
-
- MeasurementLink support
-
-
-
- MeasurementLink support
-
-
-
- MeasurementLink support
-
-
-
- MeasurementLink support
-
-
-
- MeasurementLink support
-
- Fix #1652: Topology constants haven't been updated on help page
-
-
-
- API parity with NI-DCPower 2022 Q3.
- Properties added:
aperture_time_auto_modeautorange_maximum_delay_after_range_changecable_lengthinstrument_modeisolation_statelcr_actual_load_reactancelcr_actual_load_resistancelcr_automatic_level_controllcr_current_amplitudelcr_current_rangelcr_custom_measurement_timelcr_dc_bias_automatic_level_controllcr_dc_bias_current_levellcr_dc_bias_current_rangelcr_dc_bias_sourcelcr_dc_bias_voltage_levellcr_dc_bias_voltage_rangelcr_frequencylcr_impedance_auto_rangelcr_impedance_rangelcr_impedance_range_sourcelcr_load_capacitancelcr_load_compensation_enabledlcr_load_inductancelcr_load_resistancelcr_measured_load_reactancelcr_measured_load_resistancelcr_measurement_timelcr_open_compensation_enabledlcr_open_conductancelcr_open_short_load_compensation_data_sourcelcr_open_susceptancelcr_short_compensation_enabledlcr_short_custom_cable_compensation_enabledlcr_short_reactancelcr_short_resistancelcr_source_delay_modelcr_stimulus_functionlcr_voltage_amplitudelcr_voltage_range
- Enums added:
ApertureTimeAutoModeCableLengthInstrumentModeLCRCompensationTypeLCRDCBiasSourceLCRImpedanceRangeSourceLCRMeasurementTimeLCROpenShortLoadCompensationDataSourceLCRReferenceValueTypeLCRSourceDelayModeLCRStimulusFunction
- Methods added:
configure_lcr_custom_cable_compensationfetch_multiple_lcrget_lcr_compensation_last_date_and_timeget_lcr_custom_cable_compensation_datameasure_multiple_lcrperform_lcr_load_compensationperform_lcr_open_compensationperform_lcr_open_custom_cable_compensationperform_lcr_short_compensationperform_lcr_short_custom_cable_compensation
- Custom types added:
LCRLoadCompensationSpotLCRMeasurement
- Properties added:
nidcpower_lcr_source_ac_voltage.pyexample
- API parity with NI-DCPower 2022 Q3.
-
- Updated supported devices information in documentation for methods and properties
- Added
channelfield to theMeasurementnamedtuple instances returned byfetch_multipleandmeasure_multiple
-
-
-
data_markersrepeated capability support - #1668
-
- Addressed #1627 for attributes supporting the following repeated capabilities
channelsmarkersdata_markersscript_triggers
- Corrected multiple mistakes in repeated capability info of attribute metadata
- alters API behavior (repeated capability access of attributes) and documentation
- Addressed #1627 for attributes supporting the following repeated capabilities
-
-
-
- Support for Python 3.9
-
- Support for Python 3.5
-
-
-
- API parity with NI-DCPower 21.0.0.
- Properties added:
output_cutoff_delay
- Properties added:
- API parity with NI-DCPower 21.0.0.
-
-
-
- API parity with NI-Digital Pattern Driver 21.0.0.
- Properties added:
digital_edge_rio_trigger_edgedigital_edge_rio_trigger_sourceexported_rio_event_output_terminalrio_event_terminal_namerio_trigger_terminal_namerio_trigger_type
- Repeated Capabilities added:
rio_eventsrio_triggers
- Properties added:
- API parity with NI-Digital Pattern Driver 21.0.0.
-
-
-
get_channel_names- #1588create_advanced_sequence_commit_step- #1636- API parity with NI-DCPower 20.7.0 by adding Output Cutoff functionality.
- Properties added:
output_cutoff_current_change_limit_highoutput_cutoff_current_change_limit_lowoutput_cutoff_current_measure_limit_highoutput_cutoff_current_measure_limit_lowoutput_cutoff_current_overrange_enabledoutput_cutoff_enabledoutput_cutoff_voltage_change_limit_highoutput_cutoff_voltage_change_limit_lowoutput_cutoff_voltage_output_limit_highoutput_cutoff_voltage_output_limit_low
- Methods added:
clear_latched_output_cutoff_statequery_latched_output_cutoff_state
- Properties added:
- Support for independent operation of instrument channels. Creating an
nidcpower.Sessionwith independent channels allows you to use multiple instruments in the same session. With independent channels, you can configure multiple channels of the same instrument, or of multiple instruments, independently of one another within the same session. Requires NI-DCPower driver runtime 20.6.0 or later. In order to use with older runtime or to maintain old behavior, passindependent_channels=Falsetonidcpower.Sessionconstructor.
-
-
-
- API parity with NI-DCPower 20.6.0 by adding Merged Channels and Shutdown Triggers support. The following properties are added:
merged_channelsdigital_edge_shutdown_trigger_input_terminalshutdown_trigger_type
- API parity with NI-DCPower 20.6.0 by adding Merged Channels and Shutdown Triggers support. The following properties are added:
-
-
-
- 1.0.0 release:
- API reference documentation and API usage examples
- API parity with NI-Digital Pattern Driver 20.6.0 by adding support for configuration of frequency counter measurement mode. The following properties are added:
frequency_counter_measurement_modefrequency_counter_hysteresis_enabled
- 1.0.0 release:
-
-
-
- nifgen_trigger.py example to demonstrate pulling a trigger from another device.
-
-
-
- nitclk_niscope_synchronize_with_trigger.py to demonstrate homogenous triggering.
-
- nitclk_configure.py as it did not do anything.
-
-
-
- Fix #1491: import_attribute_configuration_buffer() fails intermittently when
listorarray.arrayis passed in. - Update "Driver Version Tested Against", in documentation, with latest versions installed on nimi-bot. The version is 20.5.0 for NI-DCPower, NI-SWITCH, and NI-DMM. no changes on other drivers.
- Fix #1491: import_attribute_configuration_buffer() fails intermittently when
-
-
-
- API parity with NI-DCPower 20.5.0 by adding measurement autoranging threshold range support, for which the following properties are added:
autorangeautorange_aperture_time_modeautorange_behaviorautorange_minimum_aperture_timeautorange_minimum_aperture_time_unitsautorange_minimum_current_rangeautorange_minimum_voltage_rangeautorange_threshold_mode
- API parity with NI-DCPower 20.5.0 by adding measurement autoranging threshold range support, for which the following properties are added:
-
-
-
- New methods for getting calibration information. - #1463
get_ext_cal_last_date_and_timeget_ext_cal_last_tempget_self_cal_last_date_and_timeget_self_cal_last_temp
- Measurement library methods. - #806
add_waveform_processingclear_waveform_measurement_statsclear_waveform_processingfetch_array_measurementfetch_measurement_stats
- Measurement library properties.
meas_array_gainmeas_array_offsetmeas_chan_high_ref_levelmeas_chan_low_ref_levelmeas_chan_mid_ref_levelmeas_filter_center_freqmeas_filter_cutoff_freqmeas_filter_ordermeas_filter_ripplemeas_filter_tapsmeas_filter_transient_waveform_percentmeas_filter_typemeas_filter_widthmeas_fir_filter_windowmeas_high_refmeas_low_refmeas_mid_refmeas_hysteresis_percentmeas_interpolation_sampling_factormeas_last_acq_histogram_sizemeas_other_channelmeas_percentage_methodmeas_polynomial_interpolation_ordermeas_ref_level_unitsmeas_time_histogram_high_timemeas_time_histogram_high_voltsmeas_time_histogram_low_timemeas_time_hisogram_low_voltsmeas_time_histogram_sizemeas_voltage_histogram_high_voltsmeas_voltage_histogram_low_voltsmeas_voltage_histogram_size
- New methods for getting calibration information. - #1463
-
-
-
- Change the type of applicable properties and method parameters from
datetime.timedeltatohightime.timedeltaand fromdatetime.datetimetohightime.datetime. - #744, #1368, #1382, #1397 - Update "Driver Version Tested Against", in documentation, with latest versions installed on nimi-bot. The version is 20.0.0 for all modules except
nidigital, for which it is 19.0.1.
- Change the type of applicable properties and method parameters from
-
-
-
- API parity with NI-DCPower 20.0 by adding the following properties:
Session.serial_numberSession.actual_power_allocationSession.requested_power_allocationSession.power_allocation_mode
- API parity with NI-DCPower 20.0 by adding the following properties:
-
-
-
- 0.9.0 release:
- Public API is considered complete, stable, and tested
- Parity with public API for other ADEs supported in NI-Digital Pattern Driver 19.0.1
- API reference documentation and example code are not complete
- 0.9.0 release:
-
-
-
- API parity with NI-SCOPE 20.0 by adding the following properties:
Session.end_of_acquisition_event_terminal_nameSession.end_of_record_event_terminal_nameSession.advance_trigger_terminal_nameSession.ref_trigger_terminal_nameSession.start_trigger_terminal_nameSession.ready_for_advance_event_terminal_nameSession.ready_for_ref_event_terminal_nameSession.ready_for_start_event_terminal_name
- API parity with NI-SCOPE 20.0 by adding the following properties:
-
-
-
-
Support for chained repeated capabilities. This allows things like
session.sites[0, 1].pins['PinA', 'PinB'].ppmu_voltage_level = 4
The repeated capabilities will be expanded to
'site0/PinA,site0/PinB,site1/PinA,site1/PinB'
-
-
-
-
get_pattern_pin_names- #1292- Support for
instrumentsrepeated capability in the following properties -instrument_firmware_revision,serial_number, andtiming_absolute_delay- #1228 load_specifications_levels_and_timingthat allows loading of multiple specs, levels, and/or timing files in a single call - #1392get_channel_names- #1386
-
- Change the type of applicable method parameters and properties to enums - #1066
get_site_pass_failreturns dictionary where each key is a site number and value is a bool indicating pass/fail - #1297burst_patternreturns dictionary where each key is a site number and value is a bool indicating pass/fail, ifwait_until_doneis specified asTrue- #1296- Update enum types to match the API in other ADEs - #1330:
- Update the names of many enum types. See #1330 for the full list.
- Added
WriteStaticPinStateenum type and changed the parameter type ofwrite_staticmethod to the newly added enum. - Added
SoftwareTriggerenum type and changed the parameter type ofsend_software_edge_triggermethod to the newly added enum.
- Update
fetch_history_ram_cycle_information,get_history_ram_sample_count, andis_site_enabledto usesitesrepeated capability - #1337 - Rename parameter
time_settotime_set_namein applicable time set methods - #1396 - Modified
unload_specificationsto allow unloading of one or more specs files in a single call - #1392 - In
load_pin_map, changed parameter namepin_map_file_pathtofile_path- #1393
-
get_pattern_pin_list,get_pattern_pin_indexesandget_pin_name- #1292get_site_results_site_numbersmethod andSiteResultTypeenum - #1298reset_attribute- #1364clear_error- #1366clock_generator_initiate- #1370load_specifications,load_levels, andload_timing- #1392get_channel_nameandget_channel_name_from_string- #1386
-
-
-
- Version updated to 1.2.1 to match other released nimi-python modules
-
-
-
- Zip file per driver for all examples and any helper files
- Link to zip file on examples documentation
- Support for Python 3.8
-
- Python 2.7 support - Python Software Foundation version status
- Python 3.4 support - Python Software Foundation PEP 429
- PyPy and PyPy3 support #1271
-
-
-
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_sequenceactive_advanced_sequence_step
-
-
-
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()
-
nifgen.Session.send_software_edge_trigger()now takes two parameters -triggerandtrigger_id- See documentation on how to call this function
- Calling the previous way will log a DeprecationWarning to the warning subsystem
- #1300
-
-
-
write_source_waveform_site_unique()now supportsnumpy.arrayandlistas site waveform types- sites are now a repeated capability instead of a parameter:
session.sites[1,2].fetch_capture_waveform(...)- #1111 fetch_history_ram_cycle_informationmethod now supports fetching multiple History RAM samples in a single API call - #1071- Update methods that require
pin_listto be passed in, such thatpin_listcan be passed in viapinsrepeated capability - #1294
-
- 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_dataandfetch_history_ram_scan_cycle_number. They are not needed sincefetch_history_ram_cycle_informationwas updated to return class instances that contains cycle pin data and scan cycle number - #1071
-
-
- Method parameters and properties that are time based now take or return a
datetime.timedeltaobject
- Method parameters and properties that are time based now take or return a
-
- Ability to pass an integer as a session / session reference
nitclk.SessionReference.script_trigger_master_sessionremoved - repeated capabilities not supported onnitclkattributes - #1221
-
-
-
- Fix #1140: Linux support was accidentally broken.
- Update "Driver Version Tested Against", in documentation, with latest versions installed on nimi-bot.
-
-
-
- Support for Python 3.8
ViUInt8is now a valid type in APIs
-
-
-
fetch_capture_waveform()- returns dictionary { site: data, site: data, ... }write_source_waveform_site_unique()- takes waveform_name and dictionary { site: data, site: data, ... }pinsis now a valid repeated capability
-
- 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()towrite_source_waveform_broadcast() get_pin_results_pin_information()- returns namedtuplePinInfo(pin_indexes, site_numbers, channel_indexes)
-
-
-
- Version updated to 1.1.4 to match other released nimi-python modules
-
-
-
- The development status in
setup.pywill 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
- version >= 1.0
- 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.
- The development status in
-
-
-
- Fix type of
sequence_step_delta_time_enabledproperty - #1015
- Fix type of
-
-
-
cable_sense_signal_enable,cable_sense_voltage,cable_sense_modeproperties and associated enumenabled_channels,product_codepropertiesglitch_condition,glitch_polarity,glitch_widthproperties and associated enumsrunt_high_threshold,runt_low_threshold,runt_polarity,runt_condition,runt_time_high_limit,runt_time_low_limitproperties and associated enumswidth_condition,width_high_threshold,width_low_threshold,width_polarityproperties and associated enums
-
-
-
- Update to 1.0 - now ready for production use
-
-
-
- Initial support
- Very basic at this point and subject to change
- Looking for any testing and/or feedback
get_channel_name_from_string()
-
-
New enums:
Enum name Where used DigitalEdgedigital_edge_conditional_jump_trigger_edge,digital_edge_start_trigger_edgeApertureTimeUnitsppmu_aperture_time_units,ppmu_configure_aperture_time(units)PPMUOutputFunctionppmu_output_functionSelectedFunctionselected_functionTDREndpointTerminationtdr_endpoint_terminationSignalexport_signal(signal) -
[Source Breaker] No longer return the "actual size" from functions that use 'ivi-dance-with-a-twist'. This only affects
nidigital.
-
-
- 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()
- Should be private -
-
-
-
- Initial support
-
-
-
- Switched to slightly different metadata format - Actual
True/Falseinstead of strings - New internal process for generating metadata
- Switched to slightly different metadata format - Actual
-
-
-
- Enum values for
HardwareStatewere incorrect - fix to match niFgen.h
- Enum values for
-
-
-
- Fixed enum values for
TIME_HISTOGRAM_MEAN_PLUS_STDEV,TIME_HISTOGRAM_MEAN_PLUS_2_STDEV,HF_REJECTandLF_REJECT
- Fixed enum values for
-
-
-
- Updated generated metadata
- Updated "Driver Version Tested Against"
- Update visatype definitions to work on Linux as well as Windows - #911
-
-
-
- import_attribute_configuration_file function
- export_attribute_configuration_file function
- import_attribute_configuration_buffer function
- import_attribute_configuration_buffer function
-
-
-
- import_attribute_configuration_file function
- export_attribute_configuration_file function
- import_attribute_configuration_buffer function
- import_attribute_configuration_buffer function
-
-
-
- import_attribute_configuration_file function
- export_attribute_configuration_file function
- import_attribute_configuration_buffer function
- import_attribute_configuration_buffer function
-
-
-
- No longer globally set warnings filter for
DriverWarning- if you want all warnings from the driver, you will need to setwarnings.filterwarnings("always", category=<driver>.DriverWarning)in your code - Fix __repr__ for niscope.WaveformInfo - #920
- No longer globally set warnings filter for
-
-
- Format of output of wavefrom_info.str()
-
-
-
- Initial Release
-
-
-
- Explicitly disallow using a repeated capability on Session.
session[0].vertical_range = 1.0will no longer work. Instead usesession.channels[0].vertical_range = 1.0- #853
- Explicitly disallow using a repeated capability on Session.
-
-
-
- Fixed name
freq_voltage_autorangebecamefreq_voltage_auto_range
- Fixed name
-
configure_ac_bandwidth()- #875configure_open_cable_comp_values()- #875configure_power_line_frequency()- #875configure_short_cable_comp_values()- #875get_aperture_time_info()- #875get_auto_range_value()- #875get_measurement_period()- #875latency- #875shunt_value- #875meas_dest_slope- #875sample_trigger_slope- #875trigger_slope- #875
-
-
-
- Double close will now allow NI-ModInst to return error
-
-
-
cabled_module_scan_advanced_bus- #881cabled_module_trigger_bus- #881master_slave_scan_advanced_bus- #881master_slave_trigger_bus- #881parsed_scan_list- #881trigger_mode- #881scan_advanced_polarity- #881trigger_input_polarity- #881configure_scan_list()- #881configure_scan_trigger()- #881route_trigger_input()- #881set_continuous_scan()- #881
-
-
-
- Remove trigger configuration methods, use attributes instead #860
configure_digital_edge_measure_trigger()- usesession.digital_edge_measure_trigger_edge&session.digital_edge_measure_trigger_input_terminalconfigure_digital_edge_pulse_trigger()- usesession.digital_edge_pulse_trigger_edge&session.digital_edge_pulse_trigger_input_terminalconfigure_digital_edge_sequence_advance_trigger()- usesession.digital_edge_sequence_advance_trigger_edge&session.digital_edge_sequence_advance_trigger_input_terminalconfigure_digital_edge_source_trigger()- usesession.digital_edge_source_trigger_edge&session.digital_edge_source_trigger_input_terminalconfigure_digital_edge_start_trigger()- usesession.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_edgedigital_edge_pulse_trigger_edgedigital_edge_sequence_advance_trigger_edgedigital_edge_source_trigger_edgedigital_edge_start_trigger_edge
- Remove trigger configuration methods, use attributes instead #860
-
-
-
num_channelsattribute renamed tochannel_count- now consistent with other driverssend_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()
- To send a start software trigger, call it on the session directly:
-
- Remove trigger configuration methods, use attributes instead #860
configure_digital_edge_script_trigger()- usesession.digital_edge_script_trigger_source&session.digital_edge_script_trigger_edgeconfigure_digital_level_script_trigger()- usesession.digital_level_script_trigger_source&session.digital_level_script_trigger_active_levelconfigure_digital_edge_start_trigger()- usesession.digital_edge_start_trigger_source&session.digital_edge_start_trigger_edge
- Removed
get_fir_filter_coefficients()- #535, #596
- Remove trigger configuration methods, use attributes instead #860
-
-
-
niscope_fetch_forever.pyexample
-
- Removed default value for
levelparameter onconfigure_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))
- parameter list is now
- Removed default values for
levelandhysteresisparameters onconfigure_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))
- parameter list is now
- Removed default value for
-
-
-
- IVI properties as applicable - some were already removed from some drivers #824
engine_major_versionengine_minor_versionengine_revisionprimary_errorsecondary_errorerror_elaborationio_session_typeio_session/visa_rm_sessiongroup_capabilitiesinterchange_checkrange_checkrecord_coercionsspecific_driver_class_spec_major_versionspecific_driver_class_spec_minor_versionquery_instrument_statuscachespecific_driver_prefix
- IVI properties as applicable - some were already removed from some drivers #824
-
-
- 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, ...)becomessession.script_triggers[0].configure_digital_edge_script_trigger(source, ...)session.configure_digital_level_script_trigger('ScriptTrigger0', source, ...)becomessession.script_triggers[0].configure_digital_level_script_trigger(source, ...)
- Combined named and un-named waveform methods into one #862
set_waveform_next_write_position()andset_named_waveform_next_write_position()becomesset_next_write_position()clear_arb_waveform()anddelete_named_waveform()becomesdelete_waveform()
- Some functions missed setting repeated capabilities, leaving these as parameters instead of using the repeated capabilites object.
-
export_signal()- #828osp_fir_filter_interpolation- #864osp_fir_filter_gaussian_bt- #864osp_fir_filter_flat_passband- #864osp_fir_filter_enabled- #864osp_enabled- #864osp_data_processing_mode- #864osp_compensate_for_filter_group_delay- #864osp_cic_filter_interpolation- #864osp_cic_filter_gain- #864osp_cic_filter_enabled- #864osp_carrier_phase_q- #864osp_carrier_phase_i- #864osp_carrier_frequency- #864osp_carrier_enabled- #864osp_pre_filter_offset_q- #864osp_pre_filter_offset_i- #864osp_pre_filter_gain_q- #864osp_pre_filter_gain_i- #864osp_overflow_status- #864osp_overflow_error_reporting- #864osp_mode- #864osp_frequency_shift- #864osp_fir_filter_type- #864osp_fir_filter_root_raised_cosine_alpha- #864osp_fir_filter_raised_cosine_alpha- #864ready_for_start_event_level_active_level- #859started_event_level_active_level- #859done_event_level_active_level- #859started_event_output_behavior- #859done_event_output_behavior- #859marker_event_output_behavior- #859marker_event_pulse_polarity- #859started_event_pulse_polarity- #859done_event_pulse_polarity- #859started_event_pulse_width- #859done_event_pulse_width- #859marker_event_pulse_width- #859started_event_pulse_width_units- #859done_event_pulse_width_units- #859marker_event_pulse_width_units- #859marker_event_toggle_initial_state- #859marker_event_live_status- #859ready_for_start_event_live_status- #859marker_event_latched_status- #859done_event_latched_status- #859started_event_latched_status- #859marker_event_delay- #859started_event_delay- #859done_event_delay- #859marker_event_delay_units- #859started_event_delay_units- #859done_event_delay_units- #859direct_dma_enabled- #858direct_dma_windowaddress- #858direct_dma_window_size#858gain_dac_value- #88offset_dac_vaue- #858id_query_respone- #858oscillator_freq_ac_value- #858oscillator_phase_dac_vale- #858post_amplifier_attenuatio- #858pre_amplifier_attenuation- #858p2p_endpoint_fullness_strt_trigger_level- #858pci_dma_optimizations_enabled- #858sample_clock_absolute_delay- #858synchronization- #858sync_duty_cycl_high- #858sync_out_output_terinal- #858trigger_source- #858video_wavefor_type- #858
-
-
-
- Properties removed
stream_relative_to#825oscillator_phase_dac_value#825mux_mode_register#825ddc_center_frequency#823ddc_data_processing_mode#823ddc_enabled#823ddc_frequency_translation_enabled#823ddc_frequency_translation_phase_i#823ddc_frequency_translation_phase_q#823ddc_q_source#823digital_gain#823digital_offset#823dither_enabled#823fetch_interleaved_iq_data#823fractional_resample_enabled#823overflow_error_reporting#823adjust_pretrigger_samples_5102#822five_v_out_output_terminal#822clock_sync_pulse_source#822device_number#822fetch_interleaved_data#822trigger_from_pfi_delay#822trigger_from_rtsi_delay#822trigger_from_star_delay#822trigger_to_pfi_delay#822trigger_to_rtsi_delay#822trigger_to_star_delay#822slave_trigger_delay#822
- Methods removed
- Properties removed
-
-
-
- Indexing on
nimodinst.Sessionis no longer allowedsession[0].device_namebecomessession.devices[0].device_name- This is to be consistent with other drivers
- Indexing on
-
-
-
- All exceptions raised by the Python bindings inherit from
<driver>.Error - Exception type formerly known as
<driver>.Erroris 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)andtimeout=0.1are identical. #796
- All exceptions raised by the Python bindings inherit from
-
-
-
- Enum values that start with an underscore + digit have been renamed
Function._2_WIRE_RES-->Function.TWO_WIRE_RESFunction._4_WIRE_RES-->Function.FOUR_WIRE_RESThermistorType._44004-->ThermistorType.THERMISTOR_44004ThermistorType._44006-->ThermistorType.THERMISTOR_44006ThermistorType._44007-->ThermistorType.THERMISTOR_44007TransducerType._2_WIRE_RTD-->TransducerType.TWO_WIRE_RTDTransducerType._4_WIRE_RTD-->TransducerType.FOUR_WIRE_RTD
Session.get_ext_cal_recommended_interval()now returns adatetime.timedeltafor the interval #794
- Enum values that start with an underscore + digit have been renamed
-
-
-
Session.fetch_multiple()andSession.measure_multiple()now return list of named tuples instead of multiple arrays. See fetch_multiple and measure_multipleSession.cal_self_calibration()renamed toSession.self_cal()to match other drivers - issue #615Session.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 adatetime.timedeltafor the interval #794
-
- Advanced Sequence functions - until #504 can be fixed in a proper way
create_advanced_sequence()create_advanced_sequence_step()delete_advanced_sequence()
- Advanced Sequence functions - until #504 can be fixed in a proper way
-
-
-
Session.cal_adc_inputattribute andSession.enums.CalADCInputenum - External Cal not supported in Python- Session constructor channel parameter can now use any channel format that repeated capabilities can use #807
-
-
Session.fetch(),Session.read()andSession.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
wfmparameter towaveforminfetch()andfetch_into() - Enum values and attribute names that start with an underscore + digit have been renamed
Session._5102_adjust_pretrigger_samples-->Session.adjust_pretrigger_samples_5102Session._5v_out_output_terminal-->Session.five_v_out_output_terminalExportableSignals._5V_OUT-->ExportableSignals.FIVE_V_OUTFlexFIRAntialiasFilterType._48_TAP_STANDARD-->FlexFIRAntialiasFilterType.FOURTYEIGHT_TAP_STANDARDFlexFIRAntialiasFilterType._48_TAP_HANNING-->FlexFIRAntialiasFilterType.FOURTYEIGHT_TAP_HANNINGFlexFIRAntialiasFilterType._16_TAP_HANNING-->FlexFIRAntialiasFilterType.SIXTEEN_TAP_HANNINGFlexFIRAntialiasFilterType._8_TAP_HANNING-->FlexFIRAntialiasFilterType.EIGHT_TAP_HANNINGVideoSignalFormat._480I_59_94_FIELDS_PER_SECOND-->VideoSignalFormat.VIDEO_480I_59_94_FIELDS_PER_SECONDVideoSignalFormat._480I_60_FIELDS_PER_SECOND-->VideoSignalFormat.VIDEO_480I_60_FIELDS_PER_SECONDVideoSignalFormat._480P_59_94_FRAMES_PER_SECOND-->VideoSignalFormat.VIDEO_480P_59_94_FRAMES_PER_SECONDVideoSignalFormat._480P_60_FRAMES_PER_SECOND-->VideoSignalFormat.VIDEO_480P_60_FRAMES_PER_SECONDVideoSignalFormat._576I_50_FIELDS_PER_SECOND-->VideoSignalFormat.VIDEO_576I_50_FIELDS_PER_SECONDVideoSignalFormat._576P_50_FRAMES_PER_SECOND-->VideoSignalFormat.VIDEO_576P_50_FRAMES_PER_SECONDVideoSignalFormat._720P_50_FRAMES_PER_SECOND-->VideoSignalFormat.VIDEO_720P_50_FRAMES_PER_SECONDVideoSignalFormat._720P_59_94_FRAMES_PER_SECOND-->VideoSignalFormat.VIDEO_720P_59_94_FRAMES_PER_SECONDVideoSignalFormat._720P_60_FRAMES_PER_SECOND-->VideoSignalFormat.VIDEO_720P_60_FRAMES_PER_SECONDVideoSignalFormat._1080I_50_FIELDS_PER_SECOND-->VideoSignalFormat.VIDEO_1080I_50_FIELDS_PER_SECONDVideoSignalFormat._1080I_59_94_FIELDS_PER_SECOND-->VideoSignalFormat.VIDEO_1080I_59_94_FIELDS_PER_SECONDVideoSignalFormat._1080I_60_FIELDS_PER_SECOND-->VideoSignalFormat.VIDEO_1080I_60_FIELDS_PER_SECONDVideoSignalFormat._1080P_24_FRAMES_PER_SECOND-->VideoSignalFormat.VIDEO_1080P_24_FRAMES_PER_SECOND
Session.cal_self_calibration()renamed toSession.self_cal()to match other drivers - issue #615
-
- Following properties are now removed (use parameters to fetch calls):
fetch_relative_tofetch_offsetfetch_record_numberfetch_num_records
- Removed
number_of_coefficientsparameter fromget_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_unitsmeas_other_channelmeas_hysteresis_percentmeas_last_acq_histogram_sizemeas_voltage_histogram_sizemeas_voltage_histogram_low_voltsmeas_voltage_histogram_high_voltsmeas_time_histogram_sizemeas_time_histogram_low_voltsmeas_time_histogram_high_voltsmeas_time_histogram_low_timemeas_time_histogram_high_timemeas_polynomial_interpolation_ordermeas_interpolation_sampling_factormeas_filter_cutoff_freqmeas_filter_center_freqmeas_filter_ripplemeas_filter_transient_waveform_percentmeas_filter_typemeas_filter_ordermeas_filter_tapsmeas_chan_low_ref_levelmeas_chan_mid_ref_levelmeas_chan_high_ref_levelmeas_filter_widthmeas_fir_filter_windowmeas_array_gainmeas_array_offsetmeas_percentage_methodfetch_meas_num_samples
- Following properties are now removed (use parameters to fetch calls):
-
-
-
- Option string can now be a python dictionary instead of a string. (Fix #661)
- Key/Value pairs approporiate for desired behavior
session = nidmm.Session('Dev1', False, {'simulate': True, 'driver_setup': {'Model': '4071', 'BoardType': 'PXI'}})
- Key/Value pairs approporiate for desired behavior
- Repeated capabilities are handled differently. See #737 for discussion
- All function parameters or attributes that represent time now use
datetime.timedelta(). See #659 for discussion - All functions that return calibration dates now return
datetime.datetime(). See #659 for discussion
- Option string can now be a python dictionary instead of a string. (Fix #661)
-
-
-
nidmm.Session()no longer takes id_query parameter (Fix #670)- The following functions timeout or delay parameter now is required to be a
datetime.timedelta()object:configure_multi_point()configure_trigger()fetch()fetch_multi_point()fetch_waveform()read()read_multi_point()read_waveform()
- The following functions return a
datetime.datetime()object representing the date and timeget_cal_date_and_time()
- Metadata updated to NI-DMM 17.5
-
- Removed these enums and disconnected them from the associated attribute (Fix #666)
DCBias-DC_BIASOffsetCompensatedOhms-OFFSET_COMP_OHMS
- Removed these enums and disconnected them from the associated attribute (Fix #666)
-
-
-
- The following functions timeout, delay or holdoff parameters now is required to be a
datetime.timedelta()object:configure_scan_trigger()wait_for_debounce()wait_for_scan_complete()
- The following functions timeout, delay or holdoff parameters now is required to be a
-
-
-
channelrepeated capability - See #737 for discussion
-
- Metadata updated to NI-DCPower 17.6.1
- The following functions timeout parameter now is required to be a
datetime.timedelta()object:fetch_multiple()wait_for_event()
- The following functions return a
datetime.datetime()object representing the date and timeget_ext_cal_last_date_and_time()get_self_cal_last_date_and_time()
-
- Removed these enums and disconnected them from the associated attribute (Fix #666)
CurrentLimitAutorange-CURRENT_LIMIT_AUTORANGECurrentLevelAutorange-CURRENT_LEVEL_AUTORANGEVoltageLevelAutorange-VOLTAGE_LEVEL_AUTORANGEVoltageLimitAutorange-VOLTAGE_LIMIT_AUTORANGE
- Removed these enums and disconnected them from the associated attribute (Fix #666)
-
-
-
- Repeated capablilites - See #737 for discussion:
channelrepeated capabilitymarkersrepeated capabilityscript_triggersrepeated capability
- The following functions timeout parameter now is required to be a
datetime.timedelta()object:adjust_sample_clock_relative_delay()wait_until_done()
- The following functions return a
datetime.datetime()object representing the date and timeget_ext_cal_last_date_and_time()get_self_cal_last_date_and_time()
- Repeated capablilites - See #737 for discussion:
-
-
-
- Repeated capablilites - See #737 for discussion:
channelrepeated capability
- Repeated capablilites - See #737 for discussion:
-
niscope.Session()no longer takes id_query parameter (Fix #670)- The following functions timeout, delay or holdoff parameters now is required to be a
datetime.timedelta()object:configure_trigger_digital()configure_trigger_edge()configure_trigger_hysteresis()configure_trigger_software()configure_trigger_video()configure_trigger_window()fetch()fetch_measurement_stats()read()
-
- Removed these enums and disconnected them from the associated attribute (Fix #666)
BoolEnableDisable-P2P_ENABLED,P2P_ADVANCED_ATTRIBUTES_ENABLED,P2P_ONBOARD_MEMORY_ENABLEDBoolEnableDisableChan-CHANNEL_ENABLEDBoolEnableDisableIQ-FETCH_INTERLEAVED_IQ_DATABoolEnableDisableRealtime-HORZ_ENFORCE_REALTIMEBoolEnableDisableTIS-ENABLE_TIME_INTERLEAVED_SAMPLING
- Removed these enums and disconnected them from the associated attribute (Fix #666)
-
-
-
abort. See #660.
-
-
-
fetch_waveform_intofor high-performance fetch using numpy.array of float64.
-
- Property powerline_freq no longer uses enum PowerlineFrequency.
- Property current_source no longer uses enum CurrentSource.
- Property input_resistance no longer uses enum InputResistance.
- Removed
actual_number_of_pointsfromfetch_waveform()returned tuple - Removed
actual_number_of_pointsfromfetch_multi_point()returned tuple - Removed
actual_number_of_pointsfromread_multi_point()returned tuple - Removed
actual_number_of_pointsfromread_waveform()returned tuple
-
-
-
- Removed
init_with_topology. Clients should useniswitch.Sessionconstructor. See #660.
- Removed
-
-
-
- Property power_line_frequency no longer uses enum PowerLineFrequency.
- Removed
actual_countfromfetch_multiple()returned tuple
-
-
-
- Support for calling
write_waveformusing list (float) or numpy.array (int16 or float64) - Support for calling
write_waveformwith a waveform handle (int) or a name (str). - Support for calling
create_waveformusing list (float) or numpy.array (int16 or float64)
- Support for calling
-
- Renamed
create_waveform_f64->create_waveform
- Renamed
-
create_waveform_i16write_binary16_waveform: Usewrite_waveformwrite_named_waveform_i16: Usewrite_waveformwrite_named_waveform_f64: Usewrite_waveform
-
-
-
fetch_intofor high-performance fetch using numpy.array. Supported element types:numpy.float64numpy.int8numpy.int16numpy.int32
-
- Added default values for timeout on all fetch and read functions.
- Property input_impedance no longer uses enum InputImpedance.
-
AddWaveformProcessing- See #667 for rationaleClearWaveformProcessing- See #667 for rationaleFetchArrayMeasurement- See #667 for rationale
-
-
-
- enum definitions that are not referenced by a function and/or an attributes
-
-
-
get_ext_cal_recommended_interval
-
-
-
get_ext_cal_last_date_and_timeget_ext_cal_last_tempget_ext_cal_recommended_intervalmeasure_multiple
-
-
-
adjust_sample_clock_relative_delay
-
-
-
- Initial release
-
- Removed Peer to Peer attributes
-
-
-
- Simplified examples by removing try/except
- SOURCE BREAKER: Changed names of enum value names to correspond to C #defines
-
-
-
- Removed incorrect leading underscore from some enum values:
Function.AC_VOLTS_DC_COUPLEDFunction.WAVEFORM_CURRENTMeasurementCompleteDest.LBR_TRIG_0OperationMode.IVIDMM_MODESampleTrigger.EXTERNALSampleTrigger.TTL_3TriggerSource.TTL_0TriggerSource.TTL_3TriggerSource.TTL_7TriggerSource.PXI_STAR
- Removed incorrect leading underscore from some enum values:
-
-
-
- Support for
is_debouncedandis_scanningfunctions. Instead use the attribute of the same name.
- Support for
-
-
-
- New example
nidcpower_advanced_sequence.py
- New example
-
- Fixed method signature for:
wait_for_eventcreate_sequencecreate_advanced_sequence
- Fixed method signature for:
-
- Support for
measure_multipleuntil issue #444 is addressed.
- Support for
-
-
-
- Initial release
-
-
-
- Support for ViInt64 (64-bit integers)
-
- Modified how methods with repeated capabilities are invoked. There's no longer (for example) a
channel_nameinput. Instead:# Sets sequence on channels 0 through 3 session['0-3'].set_sequence(values, source_delays)
- Enum value documentation lists the fully qualified name - this is to allow easy copy/paste
- Modified how methods with repeated capabilities are invoked. There's no longer (for example) a
-
-
-
- Added default values to some parameters.
-
- Removed methods that aren’t useful in the Python bindings.
-
-
-
- Added default values to some parameters.
-
- Removed methods that aren’t useful in the Python bindings.
-
-
-
- Initial release
-
-
-
- Suport for channel-based properties
-
- Warnings no longer raise an exception
- Warnings are now added to warnings.warn()
- Warnings no longer raise an exception
-
-
-
- Added support for enums with types other than ViInt32 (Fixes #330)
-
-
-
- Device index is now on session not attribute. The correct way is now
i = 0 with nimodinst.Session('nidmm') as session: name = session[i].device_name
- Device index is now on session not attribute. The correct way is now
-
-
-
- Initial release
-
-
-
- Initial release
-
-
-
- Initial release
-
The format is based on Keep a Changelog and this project adheres to Python Versioning.