Raritan PX2/PX3 JSON-RPC API
AssetStripConfig.idl
1 #ifndef __ASSETMGRMODEL_ASSETSTRIP_CONFIG_IDL__
2 #define __ASSETMGRMODEL_ASSETSTRIP_CONFIG_IDL__
3 
4 #include <Event.idl>
5 #include <UserEvent.idl>
6 
10 module assetmgrmodel {
13 
21  enumeration ScanMode {
23  SCANMODE_BOTH
24  };
25 
36  enumeration NumberingMode {
38  BOTTOM_UP
39  };
40 
51  enumeration Orientation {
53  BOTTOM_CONNECTOR
54  };
55 
63  enumeration LEDOperationMode {
65  LED_OPERATION_AUTO
66  };
67 
71  enumeration LEDMode {
75  LED_MODE_BLINK_SLOW
76  };
77 
83  structure LEDColor {
84  int r;
85  int g;
86  int b;
87  };
88 
92  structure StripSettings {
94  string name;
101  };
102 
106  structure RackUnitSettings {
110  string name;
111  };
112 
114  valueobject StripSettingsChangedEvent extends event.UserEvent {
115  StripSettings oldSettings;
117  };
118 
120  valueobject RackUnitSettingsChangedEvent extends event.UserEvent {
121  int rackUnitNumber;
124  };
125 
131  StripSettings getStripSettings();
132 
140  int setStripSettings(in StripSettings settings);
141 
150  int getRackUnitSettings(in int rackUnitNumber, out RackUnitSettings settings);
151 
157  vector<RackUnitSettings> getAllRackUnitSettings();
158 
169  int setRackUnitSettings(in int rackUnitNumber, in RackUnitSettings settings);
170 
180  int setMultipleRackUnitSettings(in map<int, RackUnitSettings> settings);
181  };
182 }
183 
184 #endif /* __ASSETMGRMODEL_ASSETSTRIP_CONFIG_IDL__ */
NumberingMode numberingMode
rack unit numbering mode (top down, bottom up)
Definition: AssetStripConfig.idl:98
Asset Strip Config interface.
Definition: AssetStripConfig.idl:12
ScanMode scanMode
LED scan (demo) mode.
Definition: AssetStripConfig.idl:95
LED off.
Definition: AssetStripConfig.idl:73
Orientation
AssetStripConfig orientation
Definition: AssetStripConfig.idl:51
int numberingOffset
rack unit numbering starting offset (default is 1)
Definition: AssetStripConfig.idl:99
RackUnitSettings newSettings
Settings after change.
Definition: AssetStripConfig.idl:123
LEDOperationMode opmode
Operation mode for this rack unit.
Definition: AssetStripConfig.idl:107
LEDMode
Mode for the LED of a single rack unit.
Definition: AssetStripConfig.idl:71
LED is blinking (fast)
Definition: AssetStripConfig.idl:74
ScanMode
AssetStripConfig scan mode is active
Definition: AssetStripConfig.idl:21
int b
blue channel of the LED
Definition: AssetStripConfig.idl:86
cable connector on top, strip growing top->bottom
Definition: AssetStripConfig.idl:52
LEDMode mode
LED mode (on,off,blinking)
Definition: AssetStripConfig.idl:108
LED on.
Definition: AssetStripConfig.idl:72
string name
user defined name (up to 64 alphanumeric characters)
Definition: AssetStripConfig.idl:110
LEDColor color
Color of the LED at this rack unit.
Definition: AssetStripConfig.idl:109
Orientation orientation
orientation. If orientationSensAvailable, writes are ignored
Definition: AssetStripConfig.idl:100
Settings for this Asset Strip.
Definition: AssetStripConfig.idl:92
numbering goes from top to bottom, top is the smallest number
Definition: AssetStripConfig.idl:37
int g
green channel of the LED
Definition: AssetStripConfig.idl:85
LEDColor defaultColorConnected
auto color for rack units with an asset tag connected
Definition: AssetStripConfig.idl:96
RackUnitSettings oldSettings
Settings before change.
Definition: AssetStripConfig.idl:122
LEDColor defaultColorDisconnected
auto color for rack units without an asset tag connected
Definition: AssetStripConfig.idl:97
The LED color in RGB format, 8 bit per channel.
Definition: AssetStripConfig.idl:83
int rackUnitCount
rack unit count, number of rack units (range: 8..64), will be ignored on strips that auto-detect thei...
Definition: AssetStripConfig.idl:93
Asset Management Model.
Definition: AssetStrip.idl:10
StripSettings newSettings
Settings after change.
Definition: AssetStripConfig.idl:116
NumberingMode
AssetStripConfig rack unit numbering mode
Definition: AssetStripConfig.idl:36
LED scanmode is disabled, all LEDs are lit up statically.
Definition: AssetStripConfig.idl:22
string name
user defined name (up to 64 alphanumeric characters)
Definition: AssetStripConfig.idl:94
int r
red channel of the LED
Definition: AssetStripConfig.idl:84
LED color and mode is manually controlled.
Definition: AssetStripConfig.idl:64
LEDOperationMode
Operation mode for the LED of a single rack unit.
Definition: AssetStripConfig.idl:63
Settings for a single rack unit (LED state)
Definition: AssetStripConfig.idl:106