Technical information

RMS Enterprise NetLinx Programmer’s Guide

RMS Enterprise - NetLinx Programmer’s Guide

RMS Enterprise NetLinx Programmer’s Guide

Overview

This document outlines the RMS SDK (v4) programming concepts and RMS NetLinx API commands for RMS Enterprise, and

describes all channels, levels, and Send Commands available via the RMS NetLinx Virtual Device API.

System Requirements

The RMS SDK is a set of NetLinx and TPDesign4 files that are included in your control system programs. To utilize this SDK, you

will need the following applications installed:

NetLinx Studio 3.4 (or later)

TPDesign4 v3.1 (or later) for G4 panels

RMS Enterprise What's Changed?

RMS Enterprise represents a significant step forward in monitoring and managing controls system and devices. RMS Enterprise

focuses primarily on enterprise scalability and providing significant enhancements to the asset monitoring and management

capabilities of RMS. The new RMS Enterprise SDK and APIs provide a significantly enhanced programmatic API and when

coupled with Duet devices, can fully automate a large portion of the work previously required to electronically monitor and control

physical equipment.

The design goal of the RMS Enterprise SDK is to provide default implementations and integration across a large set of commonly

used device types thus significantly reducing the programming burden required to integrate RMS into a control system, while also

providing a very rich set of APIs and functionality empowering a NetLinx programmer to fully engage and provide customization

where needed. All of the RMS SDK NetLinx source files are provided as open source giving the programmer unprecedented

access to extend and modify the default behavior.

For programmers familiar with the RMS 3.x SDK, the most notable changes are that the RMS Engine is now provided as a Duet

module, i!-ConnectLinx has been replaced, and a new set of RMS API functions are available to interact with the RMS Engine.

To attain the scalability needs of RMS Enterprise, the underlying communications infrastructure between the control system

platform and the RMS server has changed from a proprietary statically connected socket to a REST based communications

protocol.

This new communications architecture is optimized for greater scalability and also provides greater fault tolerance in

communications links and traverses over standard HTTP ports as a true web service. RMS Enterprise leverages standard ports and

protocols in order to coexist with other hosted web services (bypassing the need for custom ports and firewall exceptions).

RMS Enterprise supports the use of Driver Design (XDD) modules as well as Duet Modules.

RMS Enterprise supports an option to enable “Legacy Support” which allows Legacy (existing RMS 3.x clients and NetLinx

masters) to be fully supported on the legacy RMS TCP/IP port 3839. New product features are only supported in the RMS

Enterprise SDK; however this legacy support is provided to allow a planned migration and roll-out plan of RMS Enterprise client

upgrades while still supporting existing functionality for the existing deployed systems.

RMS SDK v4 requires NetLinx Master version 4 firmware; connection instability

and Master lockups may result if using version 3 NetLinx Firmware with SDK

v4.