Loading...
Searching...
No Matches
OverCurrentProtectorTripSensor.idl
/* SPDX-License-Identifier: BSD-3-Clause */
/*
* Copyright 2017 Raritan Inc. All rights reserved.
*/
#ifndef __PDUMODEL_OCP_TRIP_SENSOR_IDL__
#define __PDUMODEL_OCP_TRIP_SENSOR_IDL__
#include <Outlet.idl>
#include <StateSensor.idl>
#include <Waveform.idl>
/** PDU Model */
module pdumodel {
/** Overcurrent protector trip sensor interface */
interface OverCurrentProtectorTripSensor extends sensors.StateSensor {
structure TripEventInformation {
Outlet cause; ///< Outlet that is most likely to have caused the OCP to trip.
time timestamp; ///< Timestamp of trip event
double current; ///< Current flow in outlet causing the event at trip time.
///< If current flow can not be determined, this value is sent as 0.
};
/** Event: Overcurrent protector trip state has changed */
valueobject TripStateChangedEvent extends sensors.StateSensor.StateChangedEvent {
Outlet tripCause; ///< Outlet that is most likely to have caused the OCP to trip.
///< Deprecated, use the tripInformation field instead.
TripEventInformation tripInformation; ///< Information about the event that caused a trip event.
};
/**
* Get the outlet that is most likely to have caused the last OCP trip.
*
* @return The outlet that most likely caused the OCP to trip. If either
* the OCP is not currently tripped or no outlet can be determined
* to have caused the trip, null is returned.
*
* This method is deprecated, use {@link getTripEventInformation} instead.
*/
[deprecated]
Outlet getTripCause();
/**
* Get information about the last trip event.
*
* @return Trip event information, or an empty structure if the OCP currently isn't tripped.
*/
TripEventInformation getTripEventInformation();
/**
* Get the voltage and current waveform during the last OCP trip event.
*
* @return The waveform during OCP trip in case both
* - A potential trip cause outlet could be determined and
* - The device supports waveform reading
* If either condition is not met, an empty waveform is returned.
*/
Waveform getTripWaveform();
};
}
#endif
pdumodel::Outlet
Outlet interface
Definition Outlet.idl:30
pdumodel::OverCurrentProtectorTripSensor
Overcurrent protector trip sensor interface.
Definition OverCurrentProtectorTripSensor.idl:17
pdumodel::OverCurrentProtectorTripSensor::getTripCause
Outlet getTripCause()
Get the outlet that is most likely to have caused the last OCP trip.
pdumodel::OverCurrentProtectorTripSensor::getTripEventInformation
TripEventInformation getTripEventInformation()
Get information about the last trip event.
pdumodel::OverCurrentProtectorTripSensor::getTripWaveform
Waveform getTripWaveform()
Get the voltage and current waveform during the last OCP trip event.
sensors::StateSensor
Sensor with discrete readings.
Definition StateSensor.idl:43
pdumodel
PDU Model.
Definition Circuit.idl:16
sensors
Sensors Model.
Definition AccumulatingNumericSensor.idl:13
pdumodel::OverCurrentProtectorTripSensor::TripEventInformation
Definition OverCurrentProtectorTripSensor.idl:18
pdumodel::OverCurrentProtectorTripSensor::TripEventInformation::timestamp
time timestamp
Timestamp of trip event.
Definition OverCurrentProtectorTripSensor.idl:20
pdumodel::OverCurrentProtectorTripSensor::TripEventInformation::current
double current
Current flow in outlet causing the event at trip time.
Definition OverCurrentProtectorTripSensor.idl:21
pdumodel::OverCurrentProtectorTripSensor::TripEventInformation::cause
Outlet cause
Outlet that is most likely to have caused the OCP to trip.
Definition OverCurrentProtectorTripSensor.idl:19
pdumodel::OverCurrentProtectorTripSensor::TripStateChangedEvent
Event: Overcurrent protector trip state has changed.
Definition OverCurrentProtectorTripSensor.idl:26
pdumodel::OverCurrentProtectorTripSensor::TripStateChangedEvent::tripCause
Outlet tripCause
Outlet that is most likely to have caused the OCP to trip.
Definition OverCurrentProtectorTripSensor.idl:27
pdumodel::OverCurrentProtectorTripSensor::TripStateChangedEvent::tripInformation
TripEventInformation tripInformation
Information about the event that caused a trip event.
Definition OverCurrentProtectorTripSensor.idl:29
pdumodel::Waveform
Waveform data, including metadata.
Definition Waveform.idl:12
sensors::StateSensor::StateChangedEvent
Definition StateSensor.idl:52