Unitary | Pre-APOGEE | APOGEE | BACnet | PXC.A |
|---|---|---|---|---|
● | ● | ● |
Syntax
OIP(trigger, ''seq'')
trigger | The trigger for the operator interface sequence. - This parameter can be an LDO or LDI point name or a local variable. |
seq | This variable represents the sequence of keystrokes you would enter if you were using a terminal. - The sequence must not exceed 80 characters (including slashes) in length. - The sequence must be enclosed in double quotes ('' ''). - For each level in the sequence that you advance, you must enter a slash (/). - If a pause is needed in a phone number, do the following: - For APOGEE firmware, enter a comma. - For pre-APOGEE firmware, enter a period. |
Use
This statement is no longer supported in PXC.A devices. The PXC.A PPCL runtime will consider this statement invalid, and no replacements have been provided.
Allows most operator functions to be executed from within a PPCL program. This command is generally used for the following functions:
- Generating reports
- Changing point priorities
- Sending messages
- Triggering auto-dial
The OIP command uses a trigger point to determine the conditions for execution. When the trigger point is turned on, the operator sequence is executed once. To execute the operator sequence again, the trigger point must be turned OFF, and then turned ON again.
Example
100 C
102 C OIP COMMAND INFORMATION:
104 C OPERATOR SEQUENCE
106 C
108 C - POINT
110 C - DISPLAY
112 C - PRINTER
114 C - YES
116 C - VALUE
118 C - ANY
120 C - NAME
122 C - ALL NAMES
124 C
130 C TRIGGER POINT - RPT7AM
150 OIP(RPT7AM,"P/D/P/Y/V/A/N/*")
Example to Dial Out Using a Modem—APOGEE Firmware
100 C APOGEE OIP COMMAND INFORMATION:
102 C DIAL-OUT TO MODEM
110 OIP(TRIGGER,”S/H/P/I/C/P/<field panel #>/<partner id>”)
Notes
- OIP commands used to generate messages, displays, and reports should be staggered in time (that is, do not use the same trigger point for all OIP commands). This allows one command to complete before another begins.
- The OIP command will appear as FAILED if the operator sequence was entered incorrectly and the control program attempts to execute it.
- On return from power failure, after an enable command has been executed, or during the first execution of the control program after a database load, the OIP command will not execute until the trigger point toggles.
- After the OIP command has been executed, the trigger point must be reset (commanded back to its original state) before the OIP command can be executed again.
- When using an OIP command with an LDO type subpoint, you must command the point ON/OFF with the number 1 or 0. Using any text other than 1 or 0 will cause the statement to fail.
- If the trigger point name begins with a number, then the point name should be preceded by an @ sign. If a variable in the keystroke sequence begins with a number, then the point name should not be preceded by an @ sign.
Correct
100 OIP(TRIG,"P/T/D/H///FAN/1FAN//60/")
Incorrect
100 OIP(TRIG,"P/T/D/H///FAN/@1FAN//60/")
- The OIP command must be executed with every pass of the program in order to see the trigger point change value.
- The OIP command cannot be used to perform loop tuning.
- In an OIP statement, a slash / can be used to represent a carriage return. An example of a multi-point trend display would look like:
OIP (TRIG, "P/T/D/P/// Name1/Name2/Name3//10/")
- To specify which trend instance should display, use the following syntax for the Multi-Point Trend Report:
OIP (TRIG, "P/T/D/P/// Name1//Name2//Name3//10/")