nimi-python icon indicating copy to clipboard operation
nimi-python copied to clipboard

Document Importing/Exporting Signals

Open gfisher-NI opened this issue 5 years ago • 2 comments

Description of issue

As per this pull request, the nimi-python APIs for several MI drivers no longer have the export_signal() function. This has led to some customer confusion, as this is a place where the Python APIs differ from the C APIs (where the corresponding ExportSignal() functions exist). Usually, if documentation doesn't exist for something in Python, users (and supporters) can reference the C or LabVIEW API and generally figure out what they need to do, but that's not the case here.

In cases like this, additional documentation noting this change and possibly showing an example of how to code the equivalent behavior should exist.

gfisher-NI avatar Dec 01 '20 18:12 gfisher-NI

For example, in either the documentation or the examples there is no indication of what values can be used for "digital_edge_start_trigger_source".

gfisher-NI avatar Dec 16 '20 21:12 gfisher-NI

The values that can be used change based on what instruments are in the system at any given time, so we cannot document it statically.

For example, you may want to set digital_edge_start_trigger_source to be "/mySignalGenerator/MarkerEvent4". But this only works if there is a Signal Generator named "mySignalGenerator" on the system.

There is a larger that Python problem surrounding the documentation of our routing capabilities throughout driver software that will require a more concerted effort to resolve.

marcoskirsch avatar Jan 04 '21 22:01 marcoskirsch