STATUS.md

Status

Instrument Based Session API

(Excluding HSDIO)

Instrument Type	.NET Method	Python	Python System Tests
NI-DAQmx	GetNIDAQmxTaskNames	get_all_nidaqmx_task_names	test_nidaqmx
NI-DAQmx	SetNIDAQmxTask	set_nidaqmx_task	test_nidaqmx
NI-DAQmx	GetNIDAQmxTask(s)	pins_to_nidaqmx_task(s)	test_nidaqmx
NI-DAQmx	GetAllNIDAQmxTasks	get_all_nidaqmx_tasks	test_nidaqmx
NI-DCPower	GetNIDCPowerInstrumentNames	*omitted on purpose
NI-DCPower	GetNIDCPowerResourceStrings	get_all_nidcpower_resource_strings	test_nidcpower
NI-DCPower	GetNIDCPowerSession(s)	pins_to_nidcpower_session(s)	test_nidcpower
NI-DCPower	SetNIDCPowerSession (name/channel)	*omitted on purpose
NI-DCPower	SetNIDCPowerSession (resourceString)	set_nidcpower_session	test_nidcpower
NI-DCPower	GetAllNIDCPowerSessions	get_all_nidcpower_sessions	test_nidcpower
NI-Digital	GetNIDigitalPatternInstrumentNames	get_all_nidigital_instrument_names	test_nidigital
NI-Digital	GetNIDigitalPatternSession(s)	*omitted on purpose
NI-Digital	GetNIDigitalPatternSession(s)ForPattern	get_nidigital_session_for_pattern	test_nidigital
NI-Digital	GetNIDigitalPatternSession(s)ForPpmu	get_nidigital_session_for_ppmu	test_nidigital
NI-Digital	SetNIDigitalPatternSession	set_nidigital_session	test_nidigital
NI-Digital	GetAllNIDigitalPatternSessions	get_all_nidigital_sessions	test_nidigital
NI-Digital	FetchMultisiteHistoryRamInformation* *NI-Digital driver extension
NI-Digital	NIDigitalHistoryRamCycleInformation* *class to support HRAM data
NI-DMM	GetNIDmmInstrumentNames	get_all_nidmm_instrument_names	test_nidmm
NI-DMM	GetNIDmmSession(s)	pin_to_nidmm_session(s)	test_nidmm
NI-DMM	SetNIDmmSession	set_nidmm_session	test_nidmm
NI-DMM	GetAllNIDmmSessions	get_all_nidmm_sessions	test_nidmm
NI-FGEN	GetNIFGenInstrumentNames	get_all_nifgen_instrument_names	test_nifgen
NI-FGEN	GetNIFgenSession(s)	pins_to_nifgen_session(s)	test_nifgen
NI-FGEN	SetNIFGenSession	set_nifgen_session	test_nifgen
NI-FGEN	GetAllNIFGenSessions	get_all_nifgen_sessions	test_nifgen
NI-RFmx	GetNIRfmxInstrumentNames
NI-RFmx	GetNIRfmxMultipleDeembeddingData
NI-RFmx	GetNIRfmxSingleDeembeddingData
NI-RFmx	GetNIRfmxSession(s)
NI-RFmx	SetNIRfmxSession
NI-RFmx	GetAllNIRFmxSessions
NI-RFPM	GetNIRfpmInstrumentNames
NI-RFPM	GetNIRfpmSessions
NI-RFPM	SetNIRfpmSession
NI-RFPM	GetAllNIRfpmSessions
NI-RFSA	GetNIRfsaInstrumentNames
NI-RFSA	GetNIRfsaMultipleDeembeddingData
NI-RFSA	GetNIRfsaSingleDeembeddingData
NI-RFSA	GetNIRfsaSession(s)
NI-RFSA	SetNIRfsaSession
NI-RFSA	GetAllNIRfsaSessions
NI-RFSG	GetNIRfsgInstrumentNames
NI-RFSG	GetNIRfsgMultipleDeembeddingData
NI-RFSG	GetNIRfsgSingleDeembeddingData
NI-RFSG	GetNIRfsgSession(s)
NI-RFSG	SetNIRfsgSession
NI-RFSG	GetAllNIRfsgSessions
NI-Scope	GetNIScopeInstrumentNames	get_all_niscope_instrument_names	test_niscope
NI-Scope	GetNIScopeSession(s)	pins_to_niscope_session(s)	test_niscope
NI-Scope	SetNIScopeSession	set_niscope_session	test_niscope
NI-Scope	GetAllNIScopeSessions	get_all_niscope_sessions	test_niscope
FPGA	GetFpgaInstrumentNames
FPGA	SetFpgaVIReference
FPGA	GetFpgaVIReference(s)
FPGA	GetAllFpgaVIReferences
Relay Driver	GetRelayDriverModuleNames	get_relay_driver_module_names	test_nirelaydriver
Relay Driver	GetRelayDriverNISwitchSession(s)	relays_to_relay_driver_niswitch_session(s)	test_nirelaydriver
Relay Driver	SetRelayDriverNISwitchSession	set_relay_driver_niswitch_session	test_nirelaydriver
Relay Driver	GetAllRelayDriverNISwitchSessions	get_all_relay_driver_niswitch_sessions	test_nirelaydriver
Relay Driver	ControlRelay	control_relays	unit test suffices
Relay Driver	ApplyRelayConfiguration	apply_relay_configuration	unit test suffices
Custom	GetCustomInstrumentNames	get_custom_instrument_names	test_custom_instruments
Custom	SetCustomSession	set_custom_session	test_custom_instruments
Custom	GetCustomSession(s)	pins_to_custom_session(s)	test_custom_instruments
Custom	GetAllCustomSessions	get_all_custom_sessions	test_custom_instruments
Multiplexer	GetSwitchNames	get_all_switch_names	test_switch
Multiplexer	SetSwitchSession	set_switch_session	test_switch
Multiplexer	GetSwitchSession(s)	pin_to_switch_sessions	test_switch
Multiplexer	GetAllSwitchSessions	get_all_switch_sessions	test_switch

Pin Query API

Class	.NET Method	Python	Python System Tests
SemiconductorModuleContext	PublishPerSite	publish_per_site
SemiconductorModuleContext	PublishToTestStandVariablePerSite
PinQueryContext	ExtractPinData
PinQueryContext	PerInstrumentToPerSiteData
PinQueryContext	GetSessionAndChannelIndex	get_session_and_channel_index	unit test suffices
MultiplePinQueryContext	PerInstrumentToPerSiteData
__SingleSessionQueryContext	Publish	publish* *supports all variations of data types (float/bool) and number of pins and sessions	various
__MultipleSessionQueryContext	Publish	publish	various
NIDigitalPatternPinQueryContext	PublishPatternResults	publish_pattern_results	test_nidigital
NIDigitalPatternPinQueryContext	PerInstrumentToPerSitePatternResults
NIDigitalPatternPinQueryContext	PerInstrumentToPerSiteWaveforms
NIDigitalPatternPinQueryContext	PerSiteToPerInstrumentWaveforms
NIDAQmxPinQueryContext	CreateMultisiteDataForDAQmxAnalogOutput
NIDAQmxPinQueryContext	CreatePerSiteMultisiteDataForDAQmxAnalogOutput

Other

Category/Palette	.NET Method	Python	Python System Tests
Specifications	GetSpecificationsValue	get_specifications_value	test_specifications
Specifications	GetSpecificationsValues	get_specifications_values	test_specifications
Site and Global Data	GetGlobalData	get_global_data	test_site_and_global
Site and Global Data	GetSiteData	get_site_data	test_site_and_global
Site and Global Data	GlobalDataExists	global_data_exists	test_site_and_global
Site and Global Data	SetGlobalData	set_global_data	test_site_and_global
Site and Global Data	SetSiteData	set_site_data	test_site_and_global
Site and Global Data	SiteDataExists	site_data_exists	test_site_and_global
Advanced	GetSemiconductorModuleContextWithSites
Advanced	GetSiteSemiconductorModuleContext
Misc	FilterPinsByInstrumentType	filter_pins_by_instrument_type	unit test suffices
Misc	GetPins	get_pin_names	unit test suffices
Misc	GetPinsInPinGroup(s)	get_pins_in_pin_groups	unit test suffices
Misc	GetRelays	get_relay_names	unit test suffices
Misc	GetRelaysInRelayGroups
Misc	IsSemiconductorModuleInOfflineMode
Misc	PinMapFilePath	pin_map_file_path	unit test suffices
Misc	PinMapUsesNIDCPowerChannelGroups
Misc	SiteNumbers	site_numbers	unit test suffices
Misc	InstrumentTypeIdConstants	InstrumentTypeIdConstants	n/a
Digital Project	DigitalPatternProjectCaptureWaveformFilePaths	nidigital_project_capture_waveform_file_paths	test_nidigital
Digital Project	DigitalPatternProjectLevelsFilePaths	nidigital_project_levels_file_paths	test_nidigital
Digital Project	DigitalPatternProjectPatternFilePaths	nidigital_project_pattern_file_paths	test_nidigital
Digital Project	DigitalPatternProjectSourceWaveformFilePaths	nidigital_project_source_waveform_file_paths	test_nidigital
Digital Project	DigitalPatternProjectSpecificationsFilePaths	nidigital_project_specifications_file_paths	test_nidigital
Digital Project	DigitalPatternProjectTimingFilePaths	nidigital_project_timing_file_paths	test_nidigital
Input Data	GetInputDataAsBooleans
Input Data	GetInputDataAsDouble
Input Data	GetInputDataAsStrings

Model-Based Instruments

Class/Interface	Method/Property	Python
SemiconductorModuleContext	GetModelBasedInstruments
IModelBasedInstrument	Category
IModelBasedInstrument	ModelName
IModelBasedInstrument	Name
IModelBasedInstrument	Subcategory
IModelBasedInstrument	TryGetResource
IModelBasedResource	ModelResourceName
IModelBasedPropertyItemContainer	TryGetPropertyValue
ModelBasedInstrumentSearchOptions	Category
ModelBasedInstrumentSearchOptions	Subcategory