AMX RMS Technical Information

NetLinx Programmer’s GuideEnterprise ApplicationsRMS EnterpriseResource Management Suite®Last Revised: 10/17/2014

viii RMS Enterprise - NetLinx Programmer’s GuideTable of ContentsLevel API ...

Programming - Asset Management82 RMS Enterprise - NetLinx Programmer’s GuideAsset Metadata Registration Functions (Cont.)RmsAssetMetadataEnqueueDescri

Programming - Asset Management83RMS Enterprise - NetLinx Programmer’s GuideAsset Metadata Registration Functions (Cont.)RmsAssetMetadataSubmitDescript

Programming - Asset Management84 RMS Enterprise - NetLinx Programmer’s GuideSynchronizing Asset Metadata PropertiesThe following callback method will

Programming - Asset Management85RMS Enterprise - NetLinx Programmer’s GuideAsset Metadata Update FunctionsThe Asset Metadata Update functions in the R

Programming - Asset Management86 RMS Enterprise - NetLinx Programmer’s GuideAsset Metadata Update Functions (Cont.)RmsAssetMetadataUpdateBooleanDescri

Programming - Asset Management87RMS Enterprise - NetLinx Programmer’s GuideAsset Metadata Update Functions (Cont.)RmsAssetMetadataUpdateNumberDescript

Programming - Asset Management88 RMS Enterprise - NetLinx Programmer’s GuideAsset Metadata Update Functions (Cont.)RmsAssetMetadataUpdateDecimalDescri

Programming - Asset Management89RMS Enterprise - NetLinx Programmer’s GuideAsset Metadata Update Functions (Cont.)RmsAssetMetadataUpdateHyperlinkDescr

Programming - Asset Management90 RMS Enterprise - NetLinx Programmer’s GuideAsset Metadata Update Functions (Cont.)RmsAssetMetadataUpdateValueDescript

Programming - Asset Management91RMS Enterprise - NetLinx Programmer’s GuideRegistering Asset Control MethodsThe following callback method will be invo

Table of ContentsixRMS Enterprise - NetLinx Programmer’s Guide?CLIENT.CONNECTION.STATE ...

Programming - Asset Management92 RMS Enterprise - NetLinx Programmer’s GuideThe following code snippet provides an example of registering asset contro

Programming - Asset Management93RMS Enterprise - NetLinx Programmer’s GuideAsset Control Methods Registration FunctionsThe Asset Control Methods Regis

Programming - Asset Management94 RMS Enterprise - NetLinx Programmer’s GuideAsset Control Methods Registration Functions (Cont.)RmsAssetControlMethodA

Programming - Asset Management95RMS Enterprise - NetLinx Programmer’s GuideAsset Control Methods Registration Functions (Cont.)RmsAssetControlMethodAr

Programming - Asset Management96 RMS Enterprise - NetLinx Programmer’s GuideAsset Control Methods Registration Functions (Cont.)RmsAssetControlMethodA

Programming - Asset Management97RMS Enterprise - NetLinx Programmer’s GuideAsset Control Methods Registration Functions (Cont.)RmsAssetControlMethodAr

Programming - Asset Management98 RMS Enterprise - NetLinx Programmer’s GuideAsset Control Methods Registration Functions (Cont.)RmsAssetControlMethodA

Programming - Asset Management99RMS Enterprise - NetLinx Programmer’s GuideAsset Control Methods Registration Functions (Cont.)RmsAssetControlMethodAr

Programming - Asset Management100 RMS Enterprise - NetLinx Programmer’s GuideAsset Control Methods Registration Functions (Cont.)RmsAssetControlMethod

Programming - Asset Management101RMS Enterprise - NetLinx Programmer’s GuideAsset Control Methods Registration Functions (Cont.)RmsAssetControlMethodA

x RMS Enterprise - NetLinx Programmer’s GuideTable of ContentsRMS Client Configuration Event Notification Commands ...

Programming - Asset Management102 RMS Enterprise - NetLinx Programmer’s GuideAsset Control Methods Registration Functions (Cont.)RmsAssetControlMethod

Programming - Asset Management103RMS Enterprise - NetLinx Programmer’s GuideAsset Control Methods Registration Functions (Cont.)RmsAssetControlMethods

Programming - Asset Management104 RMS Enterprise - NetLinx Programmer’s GuideAsset Control Methods Registration Functions (Cont.)RmsAssetControlMethod

Programming - Asset Management105RMS Enterprise - NetLinx Programmer’s GuideExecuting Asset Control FunctionsThe following callback method will be inv

Programming - Asset Management106 RMS Enterprise - NetLinx Programmer’s GuideExcluding Default Asset ParametersIf the RMS Client and SDK register an a

Programming - Asset Management107RMS Enterprise - NetLinx Programmer’s GuideExcluding Default Asset Metadata PropertiesIf the RMS Client and SDK regis

Programming - Asset Management108 RMS Enterprise - NetLinx Programmer’s GuideExcluding Default Asset Control MethodsIf the RMS Client and SDK register

Programming - Client Messaging109RMS Enterprise - NetLinx Programmer’s GuideProgramming - Client MessagingListening for Client Display MessagesIf you

Programming - Client Messaging110 RMS Enterprise - NetLinx Programmer’s GuideSending Help Requests to RMS ServerSending a help request to the RMS syst

Programming - Advanced Topics111RMS Enterprise - NetLinx Programmer’s GuideProgramming - Advanced TopicsListening for RMS Notification EventsRMS Enter

Table of ContentsxiRMS Enterprise - NetLinx Programmer’s GuideASSET.PARAM.RESET- ...

Programming - Advanced Topics112 RMS Enterprise - NetLinx Programmer’s Guide// CALLBACK METHOD FOR RMS CLIENT EXCEPTION EVENT NOTIFICATIONSDEFINE_FUNC

Programming - Advanced Topics113RMS Enterprise - NetLinx Programmer’s GuideYou'll notice above that a mixture of virtual and real devices are bei

Programming - Advanced Topics114 RMS Enterprise - NetLinx Programmer’s GuideIf you need to implement some logic based on System Power state on a speci

Programming - Advanced Topics115RMS Enterprise - NetLinx Programmer’s GuideIf you need to implement some logic based on System Mode changes on a speci

Programming - Advanced Topics116 RMS Enterprise - NetLinx Programmer’s GuideThis event subscription and event notification callback method indicates w

RMS Duet Module Properties117RMS Enterprise - NetLinx Programmer’s GuideRMS Duet Module PropertiesOverviewWhen a Duet device is registered with RMS, R

RMS Duet Module Properties118 RMS Enterprise - NetLinx Programmer’s GuideRMS Duet Module Properties (Cont.)RMS-Asset-Make-Url This property will defin

HAS-PROPERTIES119RMS Enterprise - NetLinx Programmer’s GuideHAS-PROPERTIESDuet Module HAS-PROPERTIESThe RMS 4.0 SDK observes the pre-defined set of HA

HAS-PROPERTIES120 RMS Enterprise - NetLinx Programmer’s GuidePlease note that older Duet Device Modules may not have the applicable set of HAS-PROPERT

RMS NetLinx Virtual Device API121RMS Enterprise - NetLinx Programmer’s GuideRMS NetLinx Virtual Device APIOverviewThe RMS NetLinx virtual device API p

xii RMS Enterprise - NetLinx Programmer’s GuideTable of Contents?HOTLIST.RECORD.PRIORITY- ...

RMS NetLinx Virtual Device API122 RMS Enterprise - NetLinx Programmer’s GuideRMS Command Escaping Functions The Command Escaping Functions in the RmsA

RMS NetLinx Virtual Device API123RMS Enterprise - NetLinx Programmer’s GuideRMS Command Escaping Functions (Cont.)RmsPackCmdParam Description: Use thi

RMS NetLinx Virtual Device API124 RMS Enterprise - NetLinx Programmer’s GuideRMS Command Escaping Functions (Cont.)RmsParseCmdHeader Description: Use

RMS NetLinx Virtual Device API125RMS Enterprise - NetLinx Programmer’s GuideRMS Command Escaping Functions (Cont.)RmsParseCmdParamExDescription: Use t

RMS NetLinx Virtual Device API126 RMS Enterprise - NetLinx Programmer’s GuideRMS Command Escaping Functions (Cont.)RmsParseCmdParamEx (Cont.)Syntax (C

RMS NetLinx Virtual Device API127RMS Enterprise - NetLinx Programmer’s GuideUnicode Strings/CommandsRMS Enterprise supports Unicode characters for int

RMS NetLinx Virtual Device API128 RMS Enterprise - NetLinx Programmer’s GuideLevel APIRMS RMS Hotlist Levels RMS Client Logging - Command APIAll RMS l

RMS NetLinx Virtual Device API129RMS Enterprise - NetLinx Programmer’s GuideRMS Client Logging Query CommandsAll RMS logging information is emitted in

RMS NetLinx Virtual Device API130 RMS Enterprise - NetLinx Programmer’s GuideRMS Client Exceptions / Errors - Command APIRMS Client Error/Exception No

RMS NetLinx Virtual Device API131RMS Enterprise - NetLinx Programmer’s GuideRMS Client Query Commands (Cont.)Query Command Description / Response Comm

Table of ContentsxiiiRMS Enterprise - NetLinx Programmer’s GuideRmsBookingsSummariesDailyRequest ...

RMS NetLinx Virtual Device API132 RMS Enterprise - NetLinx Programmer’s GuideRMS Client Query Commands (Cont.)Query Command Description / Response Com

RMS NetLinx Virtual Device API133RMS Enterprise - NetLinx Programmer’s GuideRMS Client Instruction Commands RMS Client Event Notification Commands RMS

RMS NetLinx Virtual Device API134 RMS Enterprise - NetLinx Programmer’s GuideRMS Client Event Notification Commands (Cont.)Command DescriptionVERSIONS

RMS NetLinx Virtual Device API135RMS Enterprise - NetLinx Programmer’s GuideRMS Location Information - Command API RMS Default Location QueriesCommand

RMS NetLinx Virtual Device API136 RMS Enterprise - NetLinx Programmer’s GuideRMS Default Location Event Notification Commands RMS Client Settings &

RMS NetLinx Virtual Device API137RMS Enterprise - NetLinx Programmer’s GuideRMS Client Configuration Query Commands RMS Client Configuration Instructi

RMS NetLinx Virtual Device API138 RMS Enterprise - NetLinx Programmer’s GuideRMS Client Configuration Event Notification Commands RMS Status Type Mana

RMS NetLinx Virtual Device API139RMS Enterprise - NetLinx Programmer’s GuideRMS Status Types Query Commands RMS Asset Registration - Command APIRMS As

RMS NetLinx Virtual Device API140 RMS Enterprise - NetLinx Programmer’s GuideRMS Asset Registration Commands RMS Asset Registration CommandsCommand De

RMS NetLinx Virtual Device API141RMS Enterprise - NetLinx Programmer’s GuideRMS Asset Registration Commands (Cont.)Command DescriptionASSET.REGISTER-&

xiv RMS Enterprise - NetLinx Programmer’s GuideTable of ContentsSECURITY SYSTEM ...

RMS NetLinx Virtual Device API142 RMS Enterprise - NetLinx Programmer’s GuideRMS Asset Registration Commands (Cont.)Command DescriptionASSET.GLOBAL.KE

RMS NetLinx Virtual Device API143RMS Enterprise - NetLinx Programmer’s GuideRMS Asset Registration Commands (Cont.)Command DescriptionASSET.MANUFACTUR

RMS NetLinx Virtual Device API144 RMS Enterprise - NetLinx Programmer’s GuideRMS Asset Location - Command APIRMS Asset Location Query Commands RMS Ass

RMS NetLinx Virtual Device API145RMS Enterprise - NetLinx Programmer’s GuideRMS Asset Metadata Properties Registration Commands RMS Asset Metadata Pro

RMS NetLinx Virtual Device API146 RMS Enterprise - NetLinx Programmer’s GuideRMS Asset Metadata Properties Registration Commands (Cont.)Command Descri

RMS NetLinx Virtual Device API147RMS Enterprise - NetLinx Programmer’s GuideRMS Asset Parameters - Command APIRMS Asset Parameters Event Notification

RMS NetLinx Virtual Device API148 RMS Enterprise - NetLinx Programmer’s GuideRMS Asset Parameters Registration & Update Commands RMS Asset Paramet

RMS NetLinx Virtual Device API149RMS Enterprise - NetLinx Programmer’s GuideRMS Asset Parameters Registration & Update Commands (Cont.)Command Des

RMS NetLinx Virtual Device API150 RMS Enterprise - NetLinx Programmer’s GuideRMS Asset Parameters Registration & Update Commands (Cont.)Command De

RMS NetLinx Virtual Device API151RMS Enterprise - NetLinx Programmer’s GuideRMS Asset Parameters Registration & Update Commands (Cont.)Command Des

Table of ContentsxvRMS Enterprise - NetLinx Programmer’s Guide

RMS NetLinx Virtual Device API152 RMS Enterprise - NetLinx Programmer’s GuideRMS Asset Control Methods - Command APIRMS Asset Control Methods Event No

RMS NetLinx Virtual Device API153RMS Enterprise - NetLinx Programmer’s GuideRMS Asset Control Method Registration Commands (Cont.)Command DescriptionA

RMS NetLinx Virtual Device API154 RMS Enterprise - NetLinx Programmer’s GuideRMS Asset Control Method Registration Commands (Cont.)Command Description

RMS NetLinx Virtual Device API155RMS Enterprise - NetLinx Programmer’s GuideRMS Hotlist - Command APIRMS Hotlist Event Notification Commands RMS Hotli

RMS NetLinx Virtual Device API156 RMS Enterprise - NetLinx Programmer’s GuideRMS Hotlist Query Commands (Cont.)Query Command Description / Response Co

RMS NetLinx Virtual Device API157RMS Enterprise - NetLinx Programmer’s GuideRMS Hotlist Query Commands (Cont.)Query Command Description / Response Com

RMS NetLinx Virtual Device API158 RMS Enterprise - NetLinx Programmer’s GuideRMS Hotlist Query Commands (Cont.)Query Command Description / Response Co

RMS NetLinx Virtual Device API159RMS Enterprise - NetLinx Programmer’s GuideRMS Hotlist Query Commands (Cont.)Query Command Description / Response Com

RMS NetLinx Virtual Device API160 RMS Enterprise - NetLinx Programmer’s GuideRMS Hotlist Query Commands (Cont.)Query Command Description / Response Co

RMS NetLinx Virtual Device API161RMS Enterprise - NetLinx Programmer’s GuideRMS Messaging - Command APIRMS Messaging Event Notification Commands RMS M

xvi RMS Enterprise - NetLinx Programmer’s GuideTable of Contents

RMS NetLinx Virtual Device API162 RMS Enterprise - NetLinx Programmer’s GuideRMS Messaging Instruction Commands RMS Messaging Instruction CommandsComm

RMS NetLinx Virtual Device API163RMS Enterprise - NetLinx Programmer’s GuideRMS RFID Management - Command APIFor more information on the RFID reader a

RMS NetLinx Virtual Device API164 RMS Enterprise - NetLinx Programmer’s GuideRMS Service Provider - Command APIRMS Service Provider Commands RMS RFID

RMS NetLinx Scheduling Client API165RMS Enterprise - NetLinx Programmer’s GuideRMS NetLinx Scheduling Client APIOverviewNetLinx programmers can make u

RMS NetLinx Scheduling Client API166 RMS Enterprise - NetLinx Programmer’s GuideNotice in the above sample that the #DEFINE compiler directive is spec

RMS NetLinx Scheduling Client API167RMS Enterprise - NetLinx Programmer’s GuideRmsEventSchedulingDailyCount (see page 173)RmsEventSchedulingMonthl

RMS NetLinx Scheduling Client API168 RMS Enterprise - NetLinx Programmer’s GuideRmsBookingRequestRmsBookingsSummariesDailyRequestRmsBookingRequestDesc

RMS NetLinx Scheduling Client API169RMS Enterprise - NetLinx Programmer’s GuideRmsBookingsSummaryDailyRequestRmsBookingActiveRequestRmsBookingsSummary

RMS NetLinx Scheduling Client API170 RMS Enterprise - NetLinx Programmer’s GuideRmsBookingNextActiveRequest RmsBookingNextActiveRequestDescription:Que

RMS NetLinx Scheduling Client API171RMS Enterprise - NetLinx Programmer’s GuideRmsBookingCreateRmsBookingExtend RmsBookingCreateDescription:Create an

RMS Enterprise NetLinx Programmer’s Guide1RMS Enterprise - NetLinx Programmer’s GuideRMS Enterprise NetLinx Programmer’s GuideOverviewThis document ou

RMS NetLinx Scheduling Client API172 RMS Enterprise - NetLinx Programmer’s GuideRmsBookingEnd Server Initiated EventsRMS provides information regardin

RMS NetLinx Scheduling Client API173RMS Enterprise - NetLinx Programmer’s GuideRmsEventSchedulingEventEnded RmsEventSchedulingEventStarted RmsEventSch

RMS NetLinx Scheduling Client API174 RMS Enterprise - NetLinx Programmer’s GuideRmsGuiApi.axi FileThe convenience Functions and Send Commands containe

RMS NetLinx Scheduling Client API175RMS Enterprise - NetLinx Programmer’s GuideSetting Defaults for the Scheduling Panel’s UIThe following functions p

RMS NetLinx Scheduling Client API176 RMS Enterprise - NetLinx Programmer’s GuideSetting The Client Time and Date FormatUse the following functions to

Duet Device API Implementation177RMS Enterprise - NetLinx Programmer’s GuideDuet Device API ImplementationOverviewThe tables in this section provide d

Duet Device API Implementation178 RMS Enterprise - NetLinx Programmer’s GuideAUDIO CONFERENCERAUDIO CONFERENCERKey Register?Data TypeUnitsBargraphKeyD

Duet Device API Implementation179 RMS Enterprise - NetLinx Programmer’s GuideCAMERACAMERAKey Register?Data TypeUnitsBargraphKeyDefaultValueResetValueP

Duet Device API Implementation180 RMS Enterprise - NetLinx Programmer’s GuideDIGITAL SATELLITE SYSTEM DIGITAL SATELLITE SYSTEMKey Register?Data TypeU

Duet Device API Implementation181 RMS Enterprise - NetLinx Programmer’s GuideDIGITAL VIDEO RECORDER DIGITAL VIDEO RECORDERKey Register?Data TypeUnitsB

AMX Software License and Warranty Agreement• LICENSE GRANT. AMX grants to Licensee the non-exclusive right to use the AMX Software in the manner descr

RMS Enterprise NetLinx Programmer’s Guide2 RMS Enterprise - NetLinx Programmer’s GuideUpgrading From RMS v3.3 to RMS EnterpriseRMS Enterprise (SDK4) s

Duet Device API Implementation182 RMS Enterprise - NetLinx Programmer’s GuideDISC DEVICE DISC DEVICEKey Register?Data TypeUnitsBargraphKeyDefaultValue

Duet Device API Implementation183 RMS Enterprise - NetLinx Programmer’s GuideDOCUMENT CAMERA DOCUMENT CAMERAKey Register?Data TypeUnitsBargraphKeyDefa

Duet Device API Implementation184 RMS Enterprise - NetLinx Programmer’s GuideHVAC Note: The RMS SDK includes support for "HVAC" as a RMS Net

Duet Device API Implementation185 RMS Enterprise - NetLinx Programmer’s GuideLIGHT SYSTEM LIGHT SYSTEMKey Register?Data TypeUnitsBargraphKeyDefaultVa

Duet Device API Implementation186 RMS Enterprise - NetLinx Programmer’s GuideMONITOR MONITORKey Register?Data TypeUnitsBargraphKeyDefaultValueResetVal

Duet Device API Implementation187 RMS Enterprise - NetLinx Programmer’s GuideRECEIVER RECEIVERKey Register?Data TypeUnitsBargraphKeyDefaultValueResetV

Duet Device API Implementation188 RMS Enterprise - NetLinx Programmer’s GuideSECURITY SYSTEM Note: The RMS SDK includes support for "Security Sys

Duet Device API Implementation189 RMS Enterprise - NetLinx Programmer’s GuideSETTOP BOX SETTOP BOXKey Register?Data TypeUnitsBargraphKeyDefaultValueRe

Duet Device API Implementation190 RMS Enterprise - NetLinx Programmer’s GuideSWITCHER SWITCHERKey Register?Data TypeUnitsBargraphKeyDefaultValueResetV

Duet Device API Implementation191 RMS Enterprise - NetLinx Programmer’s GuideTV TVKey Register?Data TypeUnitsBargraphKeyDefaultValueResetValueParam Ty

RMS Enterprise NetLinx Programmer’s Guide3RMS Enterprise - NetLinx Programmer’s GuideAssetsAssets (formerly known as 'Devices') represent ph

Duet Device API Implementation192 RMS Enterprise - NetLinx Programmer’s GuideVIDEO CONFERENCER VIDEO CONFERENCERKey Register?Data TypeUnitsBargraphKey

Duet Device API Implementation193 RMS Enterprise - NetLinx Programmer’s GuideVIDEO PROJECTOR VIDEO PROJECTORKey Register?Data TypeUnitsBargraphKeyDefa

Duet Device API Implementation194 RMS Enterprise - NetLinx Programmer’s GuideAMX TOUCH PANEL AMX TOUCH PANELKey Register?Data TypeUnitsBargraphKeyDefa

Appendix A: RmsApi - Structures195RMS Enterprise - NetLinx Programmer’s GuideAppendix A: RmsApi - StructuresOverviewThis section provides a consolidat

Appendix A: RmsApi - Structures196 RMS Enterprise - NetLinx Programmer’s GuideRMS Asset Control Method Data StructureSTRUCTURE RmsAssetControlMethodAr

Appendix A: RmsApi - Structures197RMS Enterprise - NetLinx Programmer’s GuideRMS Client Gateway Data StructureSTRUCTURE RmsClientGateway RMS Location

Appendix A: RmsApi - Structures198 RMS Enterprise - NetLinx Programmer’s GuideRMS Asset Control Method Data StructureSTRUCTURE RmsAssetControlMethod R

Appendix B: RmsSchedulingApi - Structures199RMS Enterprise - NetLinx Programmer’s GuideAppendix B: RmsSchedulingApi - StructuresOverviewThis section p

Appendix B: RmsSchedulingApi - Structures200 RMS Enterprise - NetLinx Programmer’s GuideRMS Event Booking Monthly Summary Data StructureThis structure

Duet Device API Implementation201RMS Enterprise - NetLinx Programmer’s Guide

RMS Enterprise NetLinx Programmer’s Guide4 RMS Enterprise - NetLinx Programmer’s GuideControl methods are named functions with an optional list of arg

10/14 ©2014 AMX. All rights reserved. AMX and the AMX logo are registered trademarks of AMX. AMX reserves the right to alter specifications without n

The RMS Enterprise SDK (v4)5RMS Enterprise - NetLinx Programmer’s GuideThe RMS Enterprise SDK (v4)OverviewThe RMS Enterprise Software Development Kit

The RMS Enterprise SDK (v4)6 RMS Enterprise - NetLinx Programmer’s GuideRMS SDK - Duet.apw (Duet Workspace)FIG. 2 shows the NetLinx Studio Workspace B

The RMS Enterprise SDK (v4)7RMS Enterprise - NetLinx Programmer’s GuideFiles Included in the Duet Workspace (RMS SDK - Duet.apw) - Cont.File Name Desc

The RMS Enterprise SDK (v4)8 RMS Enterprise - NetLinx Programmer’s GuideFiles Included in the Duet Workspace (RMS SDK - Duet.apw) - Cont.File Name Des

The RMS Enterprise SDK (v4)9RMS Enterprise - NetLinx Programmer’s GuideRMS SDK - NetLinx.apw (Duet Workspace)FIG. 2 shows the NetLinx Studio Workspace

The RMS Enterprise SDK (v4)10 RMS Enterprise - NetLinx Programmer’s GuideFiles Included in the NetLinx Workspace (RMS SDK - NetLinx.apw) - Cont.File N

The RMS Enterprise SDK (v4)11RMS Enterprise - NetLinx Programmer’s GuideMonitors - GenericThe RMS Enterprise SDK includes the following default asset

Table of ContentsiRMS Enterprise - NetLinx Programmer’s GuideTable of ContentsRMS Enterprise NetLinx Programmer’s Guide ...

The RMS Enterprise SDK (v4)12 RMS Enterprise - NetLinx Programmer’s GuideDefault File Locations of NetLinx Studio Workspace and Support Files RMS Ente

The RMS Enterprise SDK (v4)13RMS Enterprise - NetLinx Programmer’s GuideRMS SDK File Dependencies FIG. 4 shows the dependencies and relations between

The RMS Enterprise SDK (v4)14 RMS Enterprise - NetLinx Programmer’s GuideRMS Client OverviewFIG. 5 illustrates the RMS Client components deployed to a

The RMS Enterprise SDK (v4)15RMS Enterprise - NetLinx Programmer’s GuideWhen setting up or changing the RMS configuration settings, always use the Tes

The RMS Enterprise SDK (v4)16 RMS Enterprise - NetLinx Programmer’s Guide// RMS Touch Panel ArrayVOLATILE DEV dvRMSTP[] ={ dvTP1_RMS, dvTP2_RMS,

The RMS Enterprise SDK (v4)17RMS Enterprise - NetLinx Programmer’s GuideThe following code illustrates the inclusion of the RMS Touch Panel Monitor mo

The RMS Enterprise SDK (v4)18 RMS Enterprise - NetLinx Programmer’s GuideRMS RFID Adapter Module & RMS RFID Monitor (Anterus)RMS supports RFID ass

The RMS Enterprise SDK (v4)19RMS Enterprise - NetLinx Programmer’s GuideDEFINE_MODULE 'RmsAnterusRFIDAdapter_dr4_0_0' mdlRMSAnterusAdapter(v

The RMS Enterprise SDK (v4)20 RMS Enterprise - NetLinx Programmer’s GuideIt is important to note that any location-wide monitoring or control function

The RMS Enterprise SDK (v4)21RMS Enterprise - NetLinx Programmer’s GuideIt is important to note that by default RMS does not implement System Power or

ii RMS Enterprise - NetLinx Programmer’s GuideTable of ContentsRMS Engine ...

The RMS Enterprise SDK (v4)22 RMS Enterprise - NetLinx Programmer’s GuideRmsSystemEventHandler.axi - Functions (Cont.)RmsEventSystemModeChangeRequest

The RMS Enterprise SDK (v4)23RMS Enterprise - NetLinx Programmer’s GuideRMS Power Distribution Unit (PDU) Monitor Devices such as the NXA-PDU-1508 pro

The RMS Enterprise SDK (v4)24 RMS Enterprise - NetLinx Programmer’s Guide//// Power Distribution Unit RMS Monitor//// - include one of these for each

The RMS Enterprise SDK (v4)25RMS Enterprise - NetLinx Programmer’s GuideThe RmsSourceUsage.axi Include File contains the necessary source usage virtua

The RMS Enterprise SDK (v4)26 RMS Enterprise - NetLinx Programmer’s Guide // add all assets to tracked for source usage // using the mutually exclus

The RMS Enterprise SDK (v4)27RMS Enterprise - NetLinx Programmer’s GuideSee the Tracking Source Usage section on page 112 for more information.RmsSour

The RMS Enterprise SDK (v4)28 RMS Enterprise - NetLinx Programmer’s GuideRmsSourceUsage.axi - Defined ConstantsThe "RmsSourceUsage.axi" Incl

The RMS Enterprise SDK (v4)29RMS Enterprise - NetLinx Programmer’s GuideSTRUCTURE RmsAssetParameter{ CHAR key[50]; CHAR name[50]; CHAR description[

The RMS Enterprise SDK (v4)30 RMS Enterprise - NetLinx Programmer’s GuideRmsApi.axi - General Utility FunctionsThe following list of General Utility F

The RMS Enterprise SDK (v4)31RMS Enterprise - NetLinx Programmer’s GuideRmsApi.axi Functions (Cont.)General Utility Functions (Cont.)RmsDeviceStringIn

Table of ContentsiiiRMS Enterprise - NetLinx Programmer’s GuideRMS NetLinx Device Monitoring Modules...

The RMS Enterprise SDK (v4)32 RMS Enterprise - NetLinx Programmer’s GuideRmsApi.axi - Miscellaneous FunctionsThe following list of other Miscellaneous

The RMS Enterprise SDK (v4)33RMS Enterprise - NetLinx Programmer’s GuideFor detailed information, please review the source code and code comments insi

The RMS Enterprise SDK (v4)34 RMS Enterprise - NetLinx Programmer’s GuideRMS Duet Device Monitoring ModulesThe RMS Enterprise SDK includes default ass

The RMS Enterprise SDK (v4)35RMS Enterprise - NetLinx Programmer’s GuideThe following code snippet illustrates a defined Duet module and its correspon

The RMS Enterprise SDK (v4)36 RMS Enterprise - NetLinx Programmer’s GuideThis does not mean that you have to implement Duet-based devices, however the

The RMS Enterprise SDK (v4)37RMS Enterprise - NetLinx Programmer’s Guide dvVideoProj

The RMS Enterprise SDK (v4)38 RMS Enterprise - NetLinx Programmer’s Guide

Getting Started39RMS Enterprise - NetLinx Programmer’s GuideGetting StartedSource Code SamplesThe RMS Enterprise Software Development Kit (SDK) provid

Getting Started40 RMS Enterprise - NetLinx Programmer’s GuideUnderstanding the RMS Client Connection LifecycleWhen the RMS client is loaded on the Net

Getting Started41RMS Enterprise - NetLinx Programmer’s GuideINITWhen the NetLinx system starts and loads all modules and the user program, the RMS Cli

iv RMS Enterprise - NetLinx Programmer’s GuideTable of ContentsRmsAssetExclude ...

Getting Started42 RMS Enterprise - NetLinx Programmer’s GuideONLINE-UNREGISTEREDWhen the RMS Client enters the ONLINE-UNREGISTERED state, it means tha

Getting Started43RMS Enterprise - NetLinx Programmer’s GuideFrom the Hotlist or from the Client Gateway management page, an administrator can “Assign”

Getting Started44 RMS Enterprise - NetLinx Programmer’s GuideIf you select Create a New Location, you will be prompted with a location entry dialog to

Programming - RMS Required Modules45RMS Enterprise - NetLinx Programmer’s GuideProgramming - RMS Required ModulesOverviewTo implement the RMS Client t

Programming - RMS Required Modules46 RMS Enterprise - NetLinx Programmer’s GuideDEFINE_MODULE 'RmsClientGui_dr4_0_0' mdlRMSGUI(vdvRMSGui,

Programming - Asset Management47RMS Enterprise - NetLinx Programmer’s GuideProgramming - Asset ManagementAsset Monitoring ModulesAll RMS asset monitor

Programming - Asset Management48 RMS Enterprise - NetLinx Programmer’s GuideAsset Registration - Required & Optional InformationAsset Type (String

Programming - Asset Management49RMS Enterprise - NetLinx Programmer’s GuideAsset TypesThe default RMS asset types are defined as constants in the RmsA

Programming - Asset Management50 RMS Enterprise - NetLinx Programmer’s GuideAsset Registration Functions The Asset Registration functions in the RmsAp

Programming - Asset Management51RMS Enterprise - NetLinx Programmer’s GuideAsset Registration Functions (Cont.)RmsAssetRegisterAmxDeviceDescription: T

Table of ContentsvRMS Enterprise - NetLinx Programmer’s GuideRmsAssetParameterSetValueDecimal...

Programming - Asset Management52 RMS Enterprise - NetLinx Programmer’s GuideAsset Registration Functions (Cont.)RmsAssetRegisterDuetDeviceDescription:

Programming - Asset Management53RMS Enterprise - NetLinx Programmer’s GuideAsset Registration Functions (Cont.)RmsAssetRegistrationSubmitDescription:

Programming - Asset Management54 RMS Enterprise - NetLinx Programmer’s GuideRegistering Asset ParametersThe following callback method will be invoked

Programming - Asset Management55RMS Enterprise - NetLinx Programmer’s GuideEach asset parameter requires the following information: Asset Parameters -

Programming - Asset Management56 RMS Enterprise - NetLinx Programmer’s GuideThe following code snippets provide an example of registering two asset pa

Programming - Asset Management57RMS Enterprise - NetLinx Programmer’s GuideAsset Parameters Registration and Update Functions The Asset Parameters Reg

Programming - Asset Management58 RMS Enterprise - NetLinx Programmer’s GuideAsset Parameters Registration and Update Functions (Cont.)RmsAssetParamete

Programming - Asset Management59RMS Enterprise - NetLinx Programmer’s GuideAsset Parameters Registration and Update Functions (Cont.)RmsAssetParameter

Programming - Asset Management60 RMS Enterprise - NetLinx Programmer’s GuideAsset Parameters Registration and Update Functions (Cont.)RmsAssetParamete

Programming - Asset Management61RMS Enterprise - NetLinx Programmer’s GuideAsset Parameters Registration and Update Functions (Cont.)RmsAssetParameter

vi RMS Enterprise - NetLinx Programmer’s GuideTable of ContentsAsset Control Methods Registration Functions ...

Programming - Asset Management62 RMS Enterprise - NetLinx Programmer’s GuideAsset Parameters Registration and Update Functions (Cont.)RmsAssetParamete

Programming - Asset Management63RMS Enterprise - NetLinx Programmer’s GuideAsset Parameters Registration and Update Functions (Cont.)RmsAssetOnlinePar

Programming - Asset Management64 RMS Enterprise - NetLinx Programmer’s GuideAsset Parameters Registration and Update Functions (Cont.)RmsAssetParamete

Programming - Asset Management65RMS Enterprise - NetLinx Programmer’s GuideRegistering Asset Parameters ThresholdsDuring asset parameter registration

Programming - Asset Management66 RMS Enterprise - NetLinx Programmer’s Guide // create a threshold for when the OVERCURRENT alarm occurs RmsAssetPar

Programming - Asset Management67RMS Enterprise - NetLinx Programmer’s GuideUpdating Asset Parameter ValuesAsset parameter value changes will need to b

Programming - Asset Management68 RMS Enterprise - NetLinx Programmer’s GuideEach asset parameter value update requires the following information: Ea

Programming - Asset Management69RMS Enterprise - NetLinx Programmer’s GuideAsset Parameter Set Value Functions (Cont.)RmsAssetParameterSetValueNumberD

Programming - Asset Management70 RMS Enterprise - NetLinx Programmer’s GuideAsset Parameter Set Value Functions (Cont.)RmsAssetParameterSetValueDescri

Programming - Asset Management71RMS Enterprise - NetLinx Programmer’s GuideAsset Parameter Set Value Functions via Update QueueThe Asset Parameter Set

Table of ContentsviiRMS Enterprise - NetLinx Programmer’s GuideRMS-Asset-Global-Key...

Programming - Asset Management72 RMS Enterprise - NetLinx Programmer’s GuideAsset Parameter Set Value Functions via Update Queue (Cont.)RmsAssetParame

Programming - Asset Management73RMS Enterprise - NetLinx Programmer’s GuideAsset Parameter Set Value Functions via Update Queue (Cont.)RmsAssetParamet

Programming - Asset Management74 RMS Enterprise - NetLinx Programmer’s GuideSynchronizing Asset Parameter ValuesThe following callback method will be

Programming - Asset Management75RMS Enterprise - NetLinx Programmer’s GuideThe following code snippet provides an example of queuing asset parameter v

Programming - Asset Management76 RMS Enterprise - NetLinx Programmer’s GuideThe following code snippet provides an example of registering asset metada

Programming - Asset Management77RMS Enterprise - NetLinx Programmer’s GuideAsset Metadata Registration FunctionsThe Asset Metadata Registration functi

Programming - Asset Management78 RMS Enterprise - NetLinx Programmer’s GuideAsset Metadata Registration Functions (Cont.)RmsAssetMetadataEnqueueBoolea

Programming - Asset Management79RMS Enterprise - NetLinx Programmer’s GuideAsset Metadata Registration Functions (Cont.)RmsAssetMetadataEnqueueNumberD

Programming - Asset Management80 RMS Enterprise - NetLinx Programmer’s GuideAsset Metadata Registration Functions (Cont.)RmsAssetMetadataEnqueueDecima

Programming - Asset Management81RMS Enterprise - NetLinx Programmer’s GuideAsset Metadata Registration Functions (Cont.)RmsAssetMetadataEnqueueHyperli