Technical information

The RMS Enterprise SDK (v4)
15
RMS Enterprise - NetLinx Programmer’s Guide
When setting up or changing the RMS configuration settings, always use the Test Connection button to verify that the RMS client
can successfully connect and communicate with the RMS server.
RMS NetLinx Adapter Module
The RMS NetLinx Adapter module exposes the RMS NetLinx Virtual Device API for consumption in NetLinx programs. This
module is required to interact with RMS from a NetLinx program.
For more information on the RMS NetLinx API, see the RMS NetLinx Virtual Device API section on page 121.
RMS Virtual Device (vdvRMS)
This device will be the NetLinx virtual Device ID used to communicate with the RMS subsystem from a NetLinx program (Note
this Device ID must exist in the Duet Device ID range).
The following code can be included to load the RMS NetLinx Adapter module.
DEFINE_DEVICE
vdvRMS = 41001:1:0 // RMS Client (Duet Module)
DEFINE_START
// RMS Client - NetLinx Adapter Module
// This module includes the RMS client module
// and enables communication via SEND_COMMAND,
// SEND_STRINGS, CHANNELS, and LEVELS with the
// RMS Client.
DEFINE_MODULE 'RmsNetLinxAdapter_dr4_0_0' mdlRMSNetLinx(vdvRMS)
RMS Client Application User Interface Module
RMS can expose RMS-specific user interface functionality including help & maintenance requests and a location Hotlist view.
To enable this functionality, an array of touch panels must be defined, and then the RMS Client Application User Interface module
must be instantiated. RMS Touch Panel files are also provided in the RMS Enterprise SDK. These touch panel files will need to be
integrated with any existing TPD file to add the RMS functionality.
By default, all RMS user interface implementation is defined on Port 7 of the touch panel.
The following code illustrates the inclusion of the RMS Client Application User Interface module.
DEFINE_DEVICE
dvTP1 = 10001:1:0 // Touch Panels
dvTP2 = 10002:1:0 // (must be port 1 for base device)
dvTP3 = 10003:1:0
dvTP1_RMS = 10001:7:0 // RMS Touch Panels
dvTP2_RMS = 10002:7:0 // (RMS uses port 7 by default)
dvTP3_RMS = 10003:7:0
DEFINE_VARIABLE
FIG. 7 RMS Client Web Configuration
This module should be defined in the user program before any other modules.