Pdu.idl

#ifndef __PDUMODEL_PDU_IDL__
#define __PDUMODEL_PDU_IDL__

#include <Nameplate.idl>
#include <Outlet.idl>
#include <PeripheralDeviceManager.idl>
#include <Port.idl>
#include <OverCurrentProtector.idl>
#include <Inlet.idl>
#include <TransferSwitch.idl>
#include <StateSensor.idl>
#include <SensorLogger.idl>
#include <Controller.idl>
#include <InternalBeeper.idl>

module pdumodel {

    interface Pdu_4_1_2 {

        constant int ERR_INVALID_PARAM = 1;             

        structure MetaData {
            Nameplate nameplate;                        
            string ctrlBoardSerial;                     
            string hwRevision;                          
            string fwRevision;                          
            string macAddress;                          
            boolean hasSwitchableOutlets;               
            boolean hasMeteredOutlets;                  
            boolean hasLatchingOutletRelays;            
            boolean isInlineMeter;                      
            boolean isEnergyPulseSupported;             
        };

        structure Sensors {
            vector<sensors.StateSensor_4_0_2> powerSupplyStatus;    
            sensors.NumericSensor_4_0_2 activePower;                
            sensors.NumericSensor_4_0_2 activeEnergy;               
        };

        structure Statistic {
            vector<CircuitBreakerStatistic> cbStats;    
            vector<CtrlStatistic> ctrlStats;            
            vector<OutletStatistic> outletStats;        
            peripheral.DeviceManager_3_0_0.Statistics peripheralStats;  
        };

        enumeration StartupState {
            SS_ON,                                      
            SS_OFF,                                     
            SS_LASTKNOWN                                
        };

        structure Settings {
            string name;                                
            StartupState startupState;                  
            int cycleDelay;                             
            int inRushGuardDelay;                       
            vector<int> outletPowerStateSequence;       
            int powerOnDelay;                           
            boolean latchingRelays;                     
            boolean energyPulseEnabled;                 
            int energyPulsesPerKWh;                     
        };

        structure OutletSequenceState {
            boolean sequenceRunning;                    
            int nextOutletToSwitch;                     
            int timeUntilNextSwitch;                    
            int outletsRemaining;                       
        };

        valueobject SettingsChangedEvent extends event.UserEvent {
            Settings oldSettings;                       
            Settings newSettings;                       
        };

        valueobject LoadSheddingModeChangedEvent extends event.UserEvent {
            boolean enabled;                            
        };

        valueobject OutletSequenceStateChangedEvent extends idl.Event {
            OutletSequenceState newState;               
        };

        Nameplate getNameplate();

        MetaData getMetaData();

        Sensors getSensors();

        sensors.Logger_2_1_5 getSensorLogger();

        vector<Controller_4_0_0> getControllers();

        vector<Outlet_2_1_1> getOutlets();

        vector<OverCurrentProtector_3_0_1> getOverCurrentProtectors();

        vector<Inlet_2_0_1> getInlets();

        vector<TransferSwitch_4_0_2> getTransferSwitches();

        peripheral.DeviceManager_3_0_0 getPeripheralDeviceManager();

        hmi.InternalBeeper_2_0_0 getBeeper();

        Settings getSettings();

        boolean isLoadSheddingActive();

        int setSettings(in Settings settings);

        void setLoadSheddingActive(in boolean active);

        vector<portsmodel.Port_2_0_1> getFeaturePorts();

        int enterRS485ConfigModeAndAssignCtrlBoardAddress(in int addr);

        int enterRS485ConfigModeAndAssignSCBoardAddress(in int deviceId, in int addr);

        int leaveRS485ConfigMode();

        int setAllOutletPowerStates(in Outlet_2_1_1.PowerState pstate);

        int setMultipleOutletPowerStates(in vector<int> outletNumbers,
                                         in Outlet_2_1_1.PowerState state,
                                         in boolean respectSequence);

        int cycleAllOutletPowerStates();

        int cycleMultipleOutletPowerStates(in vector<int> outletNumbers,
                                           in boolean respectSequence);

        Statistic getStatistic();

        OutletSequenceState getOutletSequenceState();

        void cancelOutletSequence();

    };

}

#endif