PowerLogicPowerMeter.idl
/* SPDX-License-Identifier: BSD-3-Clause */
/*
* Copyright 2012 Raritan Inc. All rights reserved.
*/
#ifndef __POWERLOGIC_POWERMETER_IDL__
#define __POWERLOGIC_POWERMETER_IDL__
#include <Event.idl>
#include <NumericSensor.idl>
#include <ModbusDevice.idl>
module powerlogic {
/** PowerLogic Power Meter Interface */
interface PowerMeter_1_2_5 extends modbus.Device {
/** Structured object grouping minimum, maximum and current sensor */
structure MinMaxReading {
sensors.NumericSensor_4_0_3 min; ///< minimum reading
sensors.NumericSensor_4_0_3 max; ///< maximum reading
sensors.NumericSensor_4_0_3 reading; ///< current reading
};
/** Structured object for line to neutral sensors including neutral and average */
structure L2N_N_Avg {
MinMaxReading l1; ///< L1
MinMaxReading l2; ///< L2
MinMaxReading l3; ///< L3
sensors.NumericSensor_4_0_3 n; ///< neutral
sensors.NumericSensor_4_0_3 average; ///< average
};
/** Structured object for line to line sensors including average */
structure L2L_Avg {
MinMaxReading l1l2; ///< L1-L2
MinMaxReading l2l3; ///< L2-L3
MinMaxReading l3l1; ///< L3-L1
sensors.NumericSensor_4_0_3 average; ///< average
};
/** Structured object for line to neutral sensors including average */
structure L2N_Avg {
MinMaxReading l1; ///< L1-L2
MinMaxReading l2; ///< L2-L3
MinMaxReading l3; ///< L3-L1
sensors.NumericSensor_4_0_3 average; ///< average
};
/** Structured object for line to neutral voltage sensors */
structure L2N {
MinMaxReading l1; ///< L1
MinMaxReading l2; ///< L2
MinMaxReading l3; ///< L3
};
/** Structured object for line to line sensors */
structure L2L {
MinMaxReading l1l2; ///< L1-L2
MinMaxReading l2l3; ///< L2-L3
MinMaxReading l3l1; ///< L3-L1
};
/** Structured object for line to neutral voltage sensors */
structure L2N_plain_total {
sensors.NumericSensor_4_0_3 l1; ///< L1
sensors.NumericSensor_4_0_3 l2; ///< L2
sensors.NumericSensor_4_0_3 l3; ///< L3
MinMaxReading total; ///< total
};
/** Sensors */
structure Sensors {
L2N_N_Avg current; ///< current sensors (L1, L2, L3, N, 3P average)
L2L_Avg voltageL2L; ///< line to line voltage sensors (L1-L2, L2-L3, L3-L1, 3P average)
L2N_Avg voltageL2N; ///< line to neutral voltage sensors (L1-N, L2-N, L3-N, 3P average)
sensors.NumericSensor_4_0_3 frequency; ///< frequency sensor
L2N_plain_total activePower; ///< real power sensor (L1, L2, L3, total)
L2N_plain_total reactivePower; ///< reactive power sensor (L1, L2, L3, total)
L2N_plain_total apparentPower; ///< apparent power sensor (L1, L2, L3, total)
MinMaxReading powerFactor; ///< power factor sensor (total)
sensors.NumericSensor_4_0_3 activeEnergy; ///< real energy sensor (total)
sensors.NumericSensor_4_0_3 reactiveEnergy; ///< reactive energy sensor (total)
sensors.NumericSensor_4_0_3 apparentEnergy; ///< apparent energy sensor (total)
L2N thdCurrent; ///< total harmonic distortion sensors for current (L1, L2, L3)
L2L thdVoltageL2L; ///< total harmonic distortion sensors for voltage (L1-L2, L2-L3, L3-L1)
L2N thdVoltageL2N; ///< total harmonic distortion sensors for voltage (L1-N, L2-N, L3-N)
};
/** PowerLogic Power Meter setup */
structure Setup {
int systemType; ///< wiring identifier
int displayMode; ///< IEC / IEEE units
};
/** Error status flags */
structure ErrorStatus {
boolean vL1saturation; ///< voltage L1 saturation
boolean vL2saturation; ///< voltage L2 saturation
boolean vL3saturation; ///< voltage L3 saturation
boolean cL1saturation; ///< current L1 saturation
boolean cL2saturation; ///< current L2 saturation
boolean cL3saturation; ///< current L3 saturation
boolean freqInvalid; ///< frequency invalid
};
/** Event: Power meter setup has changed */
valueobject SetupChangedEvent extends idl.Event {
Setup oldSetup; ///< Setup before change
Setup newSetup; ///< Setup after change
};
/** Event: Error status has changed */
valueobject ErrorStatusChangedEvent extends idl.Event {
ErrorStatus oldStatus; ///< Error status flags before change
ErrorStatus newStatus; ///< Error status flags after change
};
/**
* Get the sensors.
* Not available sensors will be 'null'.
*
* @return Power Meter sensors.
*/
Sensors getSensors();
/**
* Read out Power Meter setup.
*
* @return Power Meter setup
*/
Setup getSetup();
/**
* Get error status.
*
* @return ErrorStatus flags
*/
ErrorStatus getErrorStatus();
/**
* Reset the min/max values to defaults.
*/
void resetAllMinMaxValues();
/**
* Reset the energy accumulators to 0.
*/
void clearAllEnergyAccumulators();
};
}
#endif /* !__POWERLOGIC_POWERMETER_IDL__ */
powerlogic::PowerMeter_1_2_5::Sensors::frequency
sensors::NumericSensor_4_0_3 frequency
frequency sensor
Definition: PowerLogicPowerMeter.idl:77
powerlogic::PowerMeter_1_2_5::Sensors::thdVoltageL2N
L2N thdVoltageL2N
total harmonic distortion sensors for voltage (L1-N, L2-N, L3-N)
Definition: PowerLogicPowerMeter.idl:87
powerlogic::PowerMeter_1_2_5::Sensors::thdCurrent
L2N thdCurrent
total harmonic distortion sensors for current (L1, L2, L3)
Definition: PowerLogicPowerMeter.idl:85
powerlogic::PowerMeter_1_2_5::L2N::l2
MinMaxReading l2
L2.
Definition: PowerLogicPowerMeter.idl:53
powerlogic::PowerMeter_1_2_5
PowerLogic Power Meter Interface.
Definition: PowerLogicPowerMeter.idl:16
powerlogic::PowerMeter_1_2_5::L2L
Structured object for line to line sensors.
Definition: PowerLogicPowerMeter.idl:58
powerlogic::PowerMeter_1_2_5::L2N_N_Avg::l1
MinMaxReading l1
L1.
Definition: PowerLogicPowerMeter.idl:27
powerlogic::PowerMeter_1_2_5::L2N::l1
MinMaxReading l1
L1.
Definition: PowerLogicPowerMeter.idl:52
powerlogic::PowerMeter_1_2_5::ErrorStatus::cL2saturation
boolean cL2saturation
current L2 saturation
Definition: PowerLogicPowerMeter.idl:102
powerlogic::PowerMeter_1_2_5::newStatus
ErrorStatus newStatus
Error status flags after change.
Definition: PowerLogicPowerMeter.idl:116
powerlogic::PowerMeter_1_2_5::Setup::systemType
int systemType
wiring identifier
Definition: PowerLogicPowerMeter.idl:92
powerlogic::PowerMeter_1_2_5::MinMaxReading::reading
sensors::NumericSensor_4_0_3 reading
current reading
Definition: PowerLogicPowerMeter.idl:22
powerlogic::PowerMeter_1_2_5::Sensors::voltageL2N
L2N_Avg voltageL2N
line to neutral voltage sensors (L1-N, L2-N, L3-N, 3P average)
Definition: PowerLogicPowerMeter.idl:76
modbus
Definition: ModbusDevice.idl:9
powerlogic::PowerMeter_1_2_5::L2L_Avg::l2l3
MinMaxReading l2l3
L2-L3.
Definition: PowerLogicPowerMeter.idl:37
powerlogic::PowerMeter_1_2_5::L2N_plain_total
Structured object for line to neutral voltage sensors.
Definition: PowerLogicPowerMeter.idl:65
powerlogic::PowerMeter_1_2_5::L2N_Avg
Structured object for line to neutral sensors including average.
Definition: PowerLogicPowerMeter.idl:43
powerlogic::PowerMeter_1_2_5::ErrorStatus::vL1saturation
boolean vL1saturation
voltage L1 saturation
Definition: PowerLogicPowerMeter.idl:98
powerlogic::PowerMeter_1_2_5::ErrorStatus::vL3saturation
boolean vL3saturation
voltage L3 saturation
Definition: PowerLogicPowerMeter.idl:100
powerlogic::PowerMeter_1_2_5::L2N_plain_total::total
MinMaxReading total
total
Definition: PowerLogicPowerMeter.idl:69
powerlogic::PowerMeter_1_2_5::L2N_N_Avg::l2
MinMaxReading l2
L2.
Definition: PowerLogicPowerMeter.idl:28
powerlogic::PowerMeter_1_2_5::ErrorStatus
Error status flags.
Definition: PowerLogicPowerMeter.idl:97
powerlogic::PowerMeter_1_2_5::ErrorStatus::vL2saturation
boolean vL2saturation
voltage L2 saturation
Definition: PowerLogicPowerMeter.idl:99
powerlogic::PowerMeter_1_2_5::L2L_Avg
Structured object for line to line sensors including average.
Definition: PowerLogicPowerMeter.idl:35
powerlogic::PowerMeter_1_2_5::L2L_Avg::l3l1
MinMaxReading l3l1
L3-L1.
Definition: PowerLogicPowerMeter.idl:38
powerlogic::PowerMeter_1_2_5::MinMaxReading
Structured object grouping minimum, maximum and current sensor.
Definition: PowerLogicPowerMeter.idl:19
powerlogic::PowerMeter_1_2_5::Sensors::apparentEnergy
sensors::NumericSensor_4_0_3 apparentEnergy
apparent energy sensor (total)
Definition: PowerLogicPowerMeter.idl:84
powerlogic::PowerMeter_1_2_5::L2N_plain_total::l1
sensors::NumericSensor_4_0_3 l1
L1.
Definition: PowerLogicPowerMeter.idl:66
idl
Basic IDL definitions.
Definition: Event.idl:10
powerlogic::PowerMeter_1_2_5::L2N_plain_total::l3
sensors::NumericSensor_4_0_3 l3
L3.
Definition: PowerLogicPowerMeter.idl:68
powerlogic::PowerMeter_1_2_5::L2N_Avg::l2
MinMaxReading l2
L2-L3.
Definition: PowerLogicPowerMeter.idl:45
powerlogic::PowerMeter_1_2_5::newSetup
Setup newSetup
Setup after change.
Definition: PowerLogicPowerMeter.idl:110
powerlogic::PowerMeter_1_2_5::L2N_N_Avg::l3
MinMaxReading l3
L3.
Definition: PowerLogicPowerMeter.idl:29
powerlogic::PowerMeter_1_2_5::L2N::l3
MinMaxReading l3
L3.
Definition: PowerLogicPowerMeter.idl:54
powerlogic::PowerMeter_1_2_5::Sensors::current
L2N_N_Avg current
current sensors (L1, L2, L3, N, 3P average)
Definition: PowerLogicPowerMeter.idl:74
powerlogic::PowerMeter_1_2_5::L2N_N_Avg::average
sensors::NumericSensor_4_0_3 average
average
Definition: PowerLogicPowerMeter.idl:31
powerlogic::PowerMeter_1_2_5::L2N_Avg::l1
MinMaxReading l1
L1-L2.
Definition: PowerLogicPowerMeter.idl:44
powerlogic::PowerMeter_1_2_5::Sensors::thdVoltageL2L
L2L thdVoltageL2L
total harmonic distortion sensors for voltage (L1-L2, L2-L3, L3-L1)
Definition: PowerLogicPowerMeter.idl:86
powerlogic::PowerMeter_1_2_5::L2L_Avg::l1l2
MinMaxReading l1l2
L1-L2.
Definition: PowerLogicPowerMeter.idl:36
powerlogic::PowerMeter_1_2_5::L2L_Avg::average
sensors::NumericSensor_4_0_3 average
average
Definition: PowerLogicPowerMeter.idl:39
powerlogic::PowerMeter_1_2_5::ErrorStatus::freqInvalid
boolean freqInvalid
frequency invalid
Definition: PowerLogicPowerMeter.idl:104
powerlogic::PowerMeter_1_2_5::L2N_N_Avg::n
sensors::NumericSensor_4_0_3 n
neutral
Definition: PowerLogicPowerMeter.idl:30
powerlogic::PowerMeter_1_2_5::Sensors::reactivePower
L2N_plain_total reactivePower
reactive power sensor (L1, L2, L3, total)
Definition: PowerLogicPowerMeter.idl:79
powerlogic::PowerMeter_1_2_5::L2N
Structured object for line to neutral voltage sensors.
Definition: PowerLogicPowerMeter.idl:51
powerlogic::PowerMeter_1_2_5::L2N_Avg::average
sensors::NumericSensor_4_0_3 average
average
Definition: PowerLogicPowerMeter.idl:47
powerlogic::PowerMeter_1_2_5::MinMaxReading::max
sensors::NumericSensor_4_0_3 max
maximum reading
Definition: PowerLogicPowerMeter.idl:21
powerlogic::PowerMeter_1_2_5::ErrorStatus::cL1saturation
boolean cL1saturation
current L1 saturation
Definition: PowerLogicPowerMeter.idl:101
sensors
Sensors Model.
Definition: AccumulatingNumericSensor.idl:13
powerlogic::PowerMeter_1_2_5::L2N_N_Avg
Structured object for line to neutral sensors including neutral and average.
Definition: PowerLogicPowerMeter.idl:26
powerlogic::PowerMeter_1_2_5::Sensors::powerFactor
MinMaxReading powerFactor
power factor sensor (total)
Definition: PowerLogicPowerMeter.idl:81
powerlogic
Definition: PowerLogicConfig.idl:11
powerlogic::PowerMeter_1_2_5::ErrorStatus::cL3saturation
boolean cL3saturation
current L3 saturation
Definition: PowerLogicPowerMeter.idl:103
powerlogic::PowerMeter_1_2_5::Setup
PowerLogic Power Meter setup.
Definition: PowerLogicPowerMeter.idl:91
powerlogic::PowerMeter_1_2_5::Sensors::activeEnergy
sensors::NumericSensor_4_0_3 activeEnergy
real energy sensor (total)
Definition: PowerLogicPowerMeter.idl:82
powerlogic::PowerMeter_1_2_5::L2N_plain_total::l2
sensors::NumericSensor_4_0_3 l2
L2.
Definition: PowerLogicPowerMeter.idl:67
powerlogic::PowerMeter_1_2_5::Setup::displayMode
int displayMode
IEC / IEEE units.
Definition: PowerLogicPowerMeter.idl:93
powerlogic::PowerMeter_1_2_5::Sensors::activePower
L2N_plain_total activePower
real power sensor (L1, L2, L3, total)
Definition: PowerLogicPowerMeter.idl:78
sensors::NumericSensor_4_0_3
A sensor with numeric readings.
Definition: NumericSensor.idl:17
powerlogic::PowerMeter_1_2_5::Sensors
Sensors.
Definition: PowerLogicPowerMeter.idl:73
powerlogic::PowerMeter_1_2_5::MinMaxReading::min
sensors::NumericSensor_4_0_3 min
minimum reading
Definition: PowerLogicPowerMeter.idl:20
powerlogic::PowerMeter_1_2_5::L2N_Avg::l3
MinMaxReading l3
L3-L1.
Definition: PowerLogicPowerMeter.idl:46
powerlogic::PowerMeter_1_2_5::L2L::l2l3
MinMaxReading l2l3
L2-L3.
Definition: PowerLogicPowerMeter.idl:60
powerlogic::PowerMeter_1_2_5::Sensors::voltageL2L
L2L_Avg voltageL2L
line to line voltage sensors (L1-L2, L2-L3, L3-L1, 3P average)
Definition: PowerLogicPowerMeter.idl:75
powerlogic::PowerMeter_1_2_5::Sensors::apparentPower
L2N_plain_total apparentPower
apparent power sensor (L1, L2, L3, total)
Definition: PowerLogicPowerMeter.idl:80
powerlogic::PowerMeter_1_2_5::L2L::l1l2
MinMaxReading l1l2
L1-L2.
Definition: PowerLogicPowerMeter.idl:59
powerlogic::PowerMeter_1_2_5::L2L::l3l1
MinMaxReading l3l1
L3-L1.
Definition: PowerLogicPowerMeter.idl:61
powerlogic::PowerMeter_1_2_5::Sensors::reactiveEnergy
sensors::NumericSensor_4_0_3 reactiveEnergy
reactive energy sensor (total)
Definition: PowerLogicPowerMeter.idl:83