Technical information
The RMS Enterprise SDK (v4)
24
RMS Enterprise - NetLinx Programmer’s Guide
//
// Power Distribution Unit RMS Monitor
//
// - include one of these for each physical PDU hardware unit.
// this module will monitor and report power and energy usage
// information into the RMS system.
//
DEFINE_MODULE 'RmsPowerDistributionUnitMonitor' mdlRmsPowerDistributionUnitMonitorMod(vdvRMS,
dvPDU_Base, dvPowerMonitoredDevices);
This RmsPowerDistributionUnitMonitor module is provided as a full open source NetLinx module in the RMS SDK. Sample
source files are included in the RMS SDK that provide a complete PDU integration example.
RMS Source Usage Monitor Module & Include File
The RMS SDK includes a RmsSourceUsageMonitor module and a RmsSourceUsage.axi Include File to provide source device
usage tracking in the RMS system. Source usage tracking can provide a site some insight into how frequently their installed
devices are actively being used and what devices may be in high demand versus devices that are used infrequently.
The source usage tracking in the RMS Enterprise SDK differs from the implementation in prior versions in that it avoids making
assumptions about how device usage should be tracked. This means that the NetLinx programmer implementing RMS and source
usage tracking has a greater responsibility in controlling when source devices are active and when they have been deactivated. The
implementation in RMS Enterprise provides greater capabilities and tools to help the programmer accomplish these goals.
The source usage tracking in the RMS Enterprise SDK works by registering each source asset that you wish to track to a unique
index number. Then there are several API calls you can use to control which sources are activated and deactivated. The RMS
Enterprise SDK supports both mutually exclusive and non-mutually exclusive source device tracking.
Mutually Exclusive Source Usage Tracking
Mutually exclusive source usage tracking only allows a single source’s asset to be active at any given time. When using mutually
exclusive source tracking, the implementation programmer is only responsible for 'Activating' the newly selected source. The RMS
source usage tracking module will automatically 'Deactivate' any other currently activated mutually exclusive source.
Non-Mutually Exclusive Source Usage Tracking
Non-mutually exclusive source usage tracking allows any combination of sources to be active concurrently at any given time.
When using non-mutually exclusive source tracking, the implementation programmer is 100% responsible for coordinating the
'Activated' and 'Deactivated' states for each source index in the source usage tracking monitor.
Non-mutually exclusive source usage tracking is provided to allow you to handle complex or more sophisticated setups where
perhaps more than one source can be active at the same time such as cases with split or quad screen setups, or in cases where there
are multiple display outputs devices that can accept a variety of different selected sources.
The diagram in FIG. 13 illustrates the file dependency chain for the RmsSourceUsageMonitor module and RmsSourceUsage
Include File integration:
If you combine both mutually exclusive and non-mutually exclusive source usage
registrations, then be aware that you cannot reuse the index number. Each source
usage asset must be assigned exclusively to a single index number.