You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+20-12Lines changed: 20 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -99,26 +99,34 @@ pip show ni-measurement-service
99
99
100
100
### Developing a minimal python measurement
101
101
102
-
1.Open a command prompt, and change the working directory to `ni_measurement_generator`
102
+
1.Install the `ni-measurement-generator` package.
103
103
104
-
```cmd
105
-
cd <path_of_template.py>
106
-
REM Example: cd "..\measurement-services-python\ni_measurement_generator"
107
-
```
104
+
```cmd
105
+
REM Activate the required virtual environment if any.
106
+
pip install ni-measurement-generator
107
+
```
108
+
109
+
2. Run the `ni-measurement-generator` tool. Use command line arguments to specify the `display-name` and optionally the `version`, `measurement-type`, and `product-type`.
110
+
111
+
1. Running `ni-measurement-generator` without optional arguments:
108
112
109
-
2. Run `template.py` in a command prompt using command line arguments for `display_name`, `version`, `measurement_type`, and `product_type`.
110
-
1. Running `template` without optional arguments:
113
+
`ni-measurement-generator SampleMeasurement`
111
114
112
-
`poetry run python ni-measurement-generator SampleMeasurement 0.1.0.0 Measurement Product`
115
+
'SampleMeasurement' is the display name of your measurement service. Without the optional arguments,
116
+
the other arguments are generated for you based on the display name.
113
117
114
-
2. Running `template` with optional arguments for `ui_file`, `service_class`, `service_id`, and `description`:
118
+
2. Running `ni-measurement-generator` with optional arguments for `version`, `measurement-type`, `product-type`, `ui-file`,
If no output directory is specified, the files will
128
+
be placed in a new folder under the current directory
129
+
named after the display name without spaces.
122
130
123
131
3. To customize the created measurement, provide metadata of the measurement's configuration(input parameters) and outputs(output parameters) in `measurement.py`.
124
132
1. Use the `configuration()` decorator to provide metadata about the configurations.**The order of the configuration decorator must match with the order of the parameters defined in the function signature.**
0 commit comments