ni / niveristand-scan-engine-ethercat-custom-device

Provides NI Scan Engine, EtherCAT and Remote IO support for NI VeriStand
MIT License
16 stars 22 forks source link

Custom Device User Help Documentation #226

Closed tarmanan closed 1 year ago

tarmanan commented 1 year ago

Is your feature request related to a problem? Please describe. Help documentation for the Scan Engine and EtherCAT custom device requires external sources such as LabVIEW, web help documents

Describe the solution you'd like Most of our VeriStand / Scan Engine and EtherCAT Custom Device installations do not have LabVIEW installed or internet access. Our team has very little LabVIEW experience. For example, to find information on configuration of specialty digital settings, it requires using a PC with LabVIEW and/or internet access to understand configuration settings

Describe alternatives you've considered PC with LabVIEW and/or internet access

Additional context Add any other context or screenshots about the feature request here. image

image

Karl-G1 commented 1 year ago

@tarmanan Would adding a simple button to the Slot page that launches the help be a good enough solution? We could include the CompactRIO and C Series CHM files in the Scan Engine Custom Device directory, then link to it from the page fairly easily for something like this: image

I could see a solution where we link to the specific module's help page once it is selected (requiring a change in the modules libraries which serves the sub-panels with the configuration options). However, that would take a lot more time to implement.

tarmanan commented 1 year ago

@Karl-G1 , this would be an excellent solution!

Karl-G1 commented 1 year ago

This fix will be included in the next release. Closing issue.