Skip to content

Add instrument type for pin parameters in examples #168

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bkeryan merged 6 commits into from
Dec 15, 2022
Merged

Add instrument type for pin parameters in examples #168

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
056660c
add instrument type for corresponding measurements
subash-suresh Dec 14, 2022
9907131
Update for doc instrument type param
subash-suresh Dec 14, 2022
9645693
fix lint errors
subash-suresh Dec 14, 2022
2e7e42e
use instrument type constants
subash-suresh Dec 15, 2022
2373e97
added instrument type for niscope_acquire_waveform
subash-suresh Dec 15, 2022
ced64a5
update niscope example
subash-suresh Dec 15, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion examples/nidcpower_source_dc_voltage/measurement.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,12 @@


@measurement_service.register_measurement
@measurement_service.configuration("pin_name", nims.DataType.Pin, "Pin1")
@measurement_service.configuration(
"pin_name",
nims.DataType.Pin,
"Pin1",
instrument_type=nims.session_management.INSTRUMENT_TYPE_NI_DCPOWER,
)
@measurement_service.configuration("voltage_level", nims.DataType.Double, 6.0)
@measurement_service.configuration("voltage_level_range", nims.DataType.Double, 6.0)
@measurement_service.configuration("current_limit", nims.DataType.Double, 0.01)
Expand Down
7 changes: 6 additions & 1 deletion examples/nidcpower_source_dc_voltage_with_labview_ui/measurement.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,12 @@


@measurement_service.register_measurement
@measurement_service.configuration("pin_names", nims.DataType.PinArray1D, ["Pin1"])
@measurement_service.configuration(
"pin_names",
nims.DataType.PinArray1D,
["Pin1"],
instrument_type=nims.session_management.INSTRUMENT_TYPE_NI_DCPOWER,
)
@measurement_service.configuration("voltage_level", nims.DataType.Double, 6.0)
@measurement_service.configuration("voltage_level_range", nims.DataType.Double, 6.0)
@measurement_service.configuration("current_limit", nims.DataType.Double, 0.01)
Expand Down
7 changes: 6 additions & 1 deletion examples/nidmm_measurement/measurement.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,12 @@


@measurement_service.register_measurement
@measurement_service.configuration("pin_name", nims.DataType.Pin, "Pin1")
@measurement_service.configuration(
"pin_name",
nims.DataType.Pin,
"Pin1",
instrument_type=nims.session_management.INSTRUMENT_TYPE_NI_DMM,
)
@measurement_service.configuration("measurement_type", nims.DataType.String, "DC Volts")
@measurement_service.configuration("range", nims.DataType.Double, 10.0)
@measurement_service.configuration("resolution_digits", nims.DataType.Double, 5.5)
Expand Down
7 changes: 6 additions & 1 deletion examples/nifgen_standard_function/measurement.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,12 @@

@measurement_service.register_measurement
# TODO: Rename pin_name to pin_names and make it PinArray1D
@measurement_service.configuration("pin_name", nims.DataType.Pin, "Pin1")
@measurement_service.configuration(
"pin_name",
nims.DataType.Pin,
"Pin1",
instrument_type=nims.session_management.INSTRUMENT_TYPE_NI_FGEN,
)
@measurement_service.configuration("waveform_type", nims.DataType.String, "Sine")
@measurement_service.configuration("frequency", nims.DataType.Double, 1.0e6)
@measurement_service.configuration("amplitude", nims.DataType.Double, 2.0)
Expand Down
14 changes: 12 additions & 2 deletions examples/niscope_acquire_waveform/measurement.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,13 +50,23 @@

@measurement_service.register_measurement
# TODO: Make pin_names PinArray1D
@measurement_service.configuration("pin_names", nims.DataType.Pin, "Pin1,Pin2,Pin3,Pin4")
@measurement_service.configuration(
"pin_names",
nims.DataType.Pin,
"Pin1,Pin2,Pin3,Pin4",
instrument_type=nims.session_management.INSTRUMENT_TYPE_NI_SCOPE,
Comment thread
bkeryan marked this conversation as resolved.
)
@measurement_service.configuration("vertical_range", nims.DataType.Double, 5.0)
@measurement_service.configuration("vertical_coupling", nims.DataType.String, "DC")
@measurement_service.configuration("input_impedance", nims.DataType.Double, 1e6)
@measurement_service.configuration("min_sample_rate", nims.DataType.Double, 10e6)
@measurement_service.configuration("min_record_length", nims.DataType.Int32, 40000)
@measurement_service.configuration("trigger_source", nims.DataType.Pin, "Pin1")
@measurement_service.configuration(
"trigger_source",
nims.DataType.Pin,
"Pin1",
instrument_type=nims.session_management.INSTRUMENT_TYPE_NI_SCOPE,
)
@measurement_service.configuration("trigger_level", nims.DataType.Double, 0.5)
@measurement_service.configuration("trigger_slope", nims.DataType.String, "Positive")
@measurement_service.configuration("auto_trigger", nims.DataType.Boolean, False)
Expand Down
9 changes: 7 additions & 2 deletions ni_measurement_service/measurement/service.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -184,8 +184,13 @@ def configuration(
default_value (Any): Default value of the configuration.

instrument_type (str): Optional.
Instrument type to be used to show instrument specific values to the configurations.
This is only supported when configuration type is DataType.Pin.
Filter pins by instrument type. This is only supported when configuration type
is DataType.Pin. Pin maps have built in instrument definitions using the
NI driver based instrument type ids. These can be found as constants
in `nims.session_management`. For example, for an NI DCPower instrument
the instrument type is `nims.session_management.INSTRUMENT_TYPE_NI_DCPOWER`.
For custom instruments the user defined instrument type id is defined in the
pin map file.

Returns
-------
Expand Down