This is an old revision of the document!
Table of Contents
04 API Tester
The API Tester of any given HSE DQMH module will come with the following additions to the default DQMH API tester:
Properties
In order to be able to launch the API tester programmatically from our UI Framework, it's necessary to make the VI show its front panel when called and close it afterwards.
Front Panel
-
make good use of space
Block Diagram
-
start and cleanup hse-application class
-
don't stop while loop in error case, but use a logger
-
handle only errors after while loop has stopped
-
have atomic cases for configure, prepare and display
-
implement standard display for System Message Broadcast Event
-
implement standard display for Logging Event
-
implement case for global shutdown event
-
do not rename the boolean constant in the “Panel Close?” case labeled “Discard?”
HSE Libraries
For the API tester to be able to start a module that depends on the various HSE Libraries helper functions (eg hse-application, hse-configuration or hse-logger), the API tester needs to initialise the HSE Libraries first.
 |
| hse-dqmh.lvlib:DQMH Tester Prepare hse-appl.vi |
|---|
 |
| hse-dqmh.lvlib:DQMH Tester Cleanup hse-appl.vi |
|---|
The API Tester will first check if the hse-application object is already in memory (ie the application template is running). If not, then it will try to start an instance itself. In order to do that, it needs to know where the project is stored, so it can deduce other information (app name, config folder location…).
When starting the tester from the development environment, the project location is detected automatically.
When starting from the runtime engine, a dialog will pop up asking the user to “select the folder containing the “hapelsoft-libraries”-based application (i.e. the .lvproj file)”.
Broadcasts
 |
| “System Message” broadcast |
|---|
 |
| “hse-logger logging event” broadcast |
|---|
 |
| “Global Shutdown Event” broadcast |
|---|
Requests
-
Buttons for calling the “Configure” and “Prepare” events