Technical information

RMS NetLinx Scheduling Client API
174
RMS Enterprise - NetLinx Programmer’s Guide
RmsGuiApi.axi File
The convenience Functions and Send Commands contained in the RmsGuiApi.axi file provide the ability to designate a panel as
being for either external or internal use, as well as to define several default settings for the panel’s scheduling interface, as
described below.
Internal and External Scheduling Panel Designation
RMS Scheduling supports the concept of internal and external scheduling panels. This is to differentiate between panels that are
located inside a room versus panels located on the outside, regarding Doorbell and Do Not Disturb messages as well as End /
Extend Meeting messages. The same set of scheduling pages are used for both internal and external panels.
Designating a panel as being for either external or internal use is as simple as including the RmsGuiApi.axi file and invoking one of
the following convenience Functions or Send Commands:
RmsSetInternalPanel
RmsSetExternalPanel
RmsSetInternalPanel
Description:
Designates the touch panel for internal use.
Internal Panels:
• Will display pop-ups with messages from the RMS administrator.
• Have no "Ring Doorbell" button displayed (all Internal panels will display a pop-up message and play the doorbell sound when
the button is pushed on an external panel)
• Have "Do Not Disturb" button displayed
• Have "End Meeting" button displayed
• Have "Extend Meeting" button displayed
Function Syntax: DEFINE_FUNCTION CHAR RmsSetInternalPanel(DEV baseTouchPanelDps, DEV rmsTouchPanelDps)
SEND_COMMAND Syntax: SEND_COMMAND vdvRMSGui, 'SET_INTERNAL_PANEL-<baseTouchPanelDps>,<rmsTouchPanelDps>'
RmsSetExternalPanel
Description:
Designates the touch panel for external use.
External Panels:
• Will not display pop-ups with messages from the RMS administrator.
• Has "Ring Doorbell" button displayed
• Has no "Do Not Disturb" button displayed (all panels designated as external will show a "Do Not Disturb" message overlaying
other controls when the button is pushed on an internal panel)
• Has no "End Meeting" button displayed
• Has no "Extend Meeting" button displayed
Function Syntax: DEFINE_FUNCTION CHAR RmsSetExternalPanel(DEV baseTouchPanelDps, DEV rmsTouchPanelDps)
SEND_COMMAND Syntax: SEND_COMMAND vdvRMSGui, 'SET_EXTERNAL_PANEL-<baseTouchPanelDps>,<rmsTouchPanelDps>'