Raritan PX2/PX3 JSON-RPC API
|
Power Meter Controller (PMC) interface. More...
import"PowerMeterController.idl";
Classes | |
struct | ScanResult |
Meter board scan result. More... | |
Public Member Functions | |
int | scanMeterBoard (in int powerMeterId, out ScanResult result) |
Scan for presence and configuration of a meter board. More... | |
map< int, PowerMeter_1_1_2 > | getPowerMeters () |
Retrieve the list of power meters and panels. More... | |
int | createPowerMeter (out PowerMeter_1_1_2 powerMeter, in PowerMeter_1_1_2::Config config, in PowerMeter_1_1_2::Settings settings) |
Create a new standalone power meter (no panel). More... | |
int | createPanel (out Panel_1_1_2 panel, in PowerMeter_1_1_2::Config config, in PowerMeter_1_1_2::Settings powerMeterSettings, in Panel_1_1_2::PanelSettings panelSettings) |
Create a new panel. More... | |
int | deletePowerMeter (in int powerMeterId) |
Delete a panel or power meter. More... | |
Public Attributes | |
constant int | ERR_INVALID_PARAM = 1 |
Invalid parameters. | |
constant int | ERR_METER_BOARD_BUSY = 2 |
A power meter with the given ID already exists. | |
valueobject | PowerMeterCreatedEvent: event::UserEvent { PowerMeter_1_1_2 powerMeter |
Event: A power meter or panel was created. More... | |
PowerMeter_1_1_2::Config | config |
New power meter config. | |
PowerMeter_1_1_2::Settings | settings |
New power meter settings. More... | |
valueobject | PowerMeterDeletedEvent: event::UserEvent { PowerMeter_1_1_2::Config config |
Event: A power meter was deleted. More... | |
valueobject | PanelCreatedEvent: PowerMeterCreatedEvent { Panel_1_1_2::PanelSettings panelSettings |
Event: A panel was created. More... | |
valueobject | PanelDeletedEvent: PowerMeterDeletedEvent { Panel_1_1_2::PanelSettings panelSettings |
Event:: A panel was deleted. More... | |
Power Meter Controller (PMC) interface.
int pdumodel::PowerMeterController_1_1_2::createPanel | ( | out Panel_1_1_2 | panel, |
in PowerMeter_1_1_2::Config | config, | ||
in PowerMeter_1_1_2::Settings | powerMeterSettings, | ||
in Panel_1_1_2::PanelSettings | panelSettings | ||
) |
Create a new panel.
panel | Result: Newly created instance |
config | New power meter config |
powerMeterSettings | Power meter settings |
panelSettings | Panel settings |
int pdumodel::PowerMeterController_1_1_2::createPowerMeter | ( | out PowerMeter_1_1_2 | powerMeter, |
in PowerMeter_1_1_2::Config | config, | ||
in PowerMeter_1_1_2::Settings | settings | ||
) |
Create a new standalone power meter (no panel).
powerMeter | Result: Newly created instance |
config | New power meter config |
settings | Power meter settings |
int pdumodel::PowerMeterController_1_1_2::deletePowerMeter | ( | in int | powerMeterId | ) |
Delete a panel or power meter.
powerMeterId | Power meter ID |
map<int, PowerMeter_1_1_2> pdumodel::PowerMeterController_1_1_2::getPowerMeters | ( | ) |
Retrieve the list of power meters and panels.
int pdumodel::PowerMeterController_1_1_2::scanMeterBoard | ( | in int | powerMeterId, |
out ScanResult | result | ||
) |
Scan for presence and configuration of a meter board.
powerMeterId | ID of meter board to be scanned |
result | Detected meter board properties |
valueobject pdumodel::PowerMeterController_1_1_2::PanelCreatedEvent |
Event: A panel was created.
New panel settings
valueobject pdumodel::PowerMeterController_1_1_2::PanelDeletedEvent |
Event:: A panel was deleted.
Old panel settings
valueobject pdumodel::PowerMeterController_1_1_2::PowerMeterCreatedEvent |
Event: A power meter or panel was created.
New power meter instance
valueobject pdumodel::PowerMeterController_1_1_2::PowerMeterDeletedEvent |
Event: A power meter was deleted.
Old power meter config
PowerMeter_1_1_2::Settings pdumodel::PowerMeterController_1_1_2::settings |
New power meter settings.
Old power meter settings.