PeripheralDeviceManager.idl

#ifndef __PERIPHERAL_DEVICE_MANAGER_IDL__
#define __PERIPHERAL_DEVICE_MANAGER_IDL__

#include <PeripheralDeviceSlot.idl>
#include <PeripheralDevicePackage.idl>
#include <NumericSensor.idl>
#include <Sensor.idl>
#include <UserEvent.idl>

module peripheral {

    interface DeviceManager_3_0_0 {

        constant int ERR_INVALID_PARAMS = 1; 
        
        enumeration ZCoordMode {
            RACKUNITS,    
            FREEFORM      
        };
        
        structure Settings {
            ZCoordMode  zCoordMode;               
            boolean     autoManageNewDevices;     
            float       deviceAltitude;           
            int         presenceDetectionTimeout; 
            map<string, sensors.NumericSensor_4_0_2.Thresholds> defaultThresholdsMap; 
            int         maxActivePoweredDryContacts; 
        };
        
        structure MetaData {
            int     oneWirePortCount;   
            int     onboardDeviceCount; 
        };

        structure DeviceTypeInfo {
            sensors.Sensor_4_0_2.TypeSpec       type;       
            boolean                             isActuator; 
            string                              identifier; 
            string                              name;       
            sensors.NumericSensor_4_0_2.Range   defaultRange;  
            int                                 defaultDecDigits;  
        };

        structure FirmwareUpdateState {
            boolean active;                     
            int remaining;                      
        };

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

        valueobject DeviceEvent_2_0_0 extends idl.Event {
            vector<Device_3_0_1> devices;       
            vector<Device_3_0_1> allDevices;    
        };

        valueobject DeviceAddedEvent_2_0_0 extends DeviceEvent_2_0_0 { };

        valueobject DeviceRemovedEvent_2_0_0 extends DeviceEvent_2_0_0 { };

        valueobject UnknownDeviceAttachedEvent extends idl.Event {
            string romCode;                     
            vector<PosElement> position;        
        };

        enumeration DeviceFirmwareUpdateState {
            UPDATE_STARTED,                     
            UPDATE_SUCCESSFUL,                  
            UPDATE_FAILED                       
        };

        valueobject DeviceFirmwareUpdateStateChangedEvent extends idl.Event {
            string oldVersion;                  
            string newVersion;                  
            string serial;                      
            DeviceFirmwareUpdateState state;    
        };

        valueobject FirmwareUpdateStateChangedEvent extends idl.Event {
            FirmwareUpdateState newState;               
        };

        valueobject PackageEvent_2_0_0 extends idl.Event {
            vector<PackageInfo_2_0_0> packageInfos;     
            vector<PackageInfo_2_0_0> allPackages;      
        };

        valueobject PackageAddedEvent_2_0_0 extends PackageEvent_2_0_0 { };
        valueobject PackageRemovedEvent_2_0_0 extends PackageEvent_2_0_0 { };

        structure Statistics {
            int cSumErrCnt;         
        };
        
        vector<DeviceSlot_2_0_2> getDeviceSlots();

        DeviceSlot_2_0_2 getDeviceSlot(in int idx);

        vector<Device_3_0_1> getDiscoveredDevices();

        vector<PackageInfo_2_0_0> getDiscoveredPackageInfos();
        
        Settings getSettings();

        int setSettings(in Settings settings);
        
        MetaData getMetaData();

        vector<DeviceTypeInfo> getDeviceTypeInfos();

        FirmwareUpdateState getFirmwareUpdateState();

        Statistics getStatistics();

        vector<Package> getDiscoveredPackages();

    };
}

#endif /* !__PERIPHERAL_DEVICE_MANAGER_IDL__ */