Yamcs Studio User Guide
- Overview
- Display Builder
- Display Runner
- Processed Variables
- Widgets
- Actions
- Borders
- Rules
- Scripts
- Macros
- Tuning
Related
Yamcs Studio Release Notes
Source Code Documentation
Download this Document
Script API¶
Global Variables
The following global variables are available in all scripts:
triggerPV
PV object for the PV that triggered this particular script execution. Sample usage:
if (triggerPV === pvs[1]) { ConsoleUtil.writeInfo("I was triggered by the second input PV."); }
pvs
Array of PV objects. One for each Input PV. The order in the array matches with the order in which they appear in the Attach Scripts dialog.
widget
Widget object for the widget that this script is attached to.
display
Widget object for the display that this script’s widget belongs to.
Utilities
Support Classes