Legrand / Raritan / Server Technology Xerus™ JSON-RPC API

Loading...
Searching...
No Matches
OverCurrentProtectorTripSensor.idl
1/* SPDX-License-Identifier: BSD-3-Clause */
2/*
3 * Copyright 2017 Raritan Inc. All rights reserved.
4 */
5
6#ifndef __PDUMODEL_OCP_TRIP_SENSOR_IDL__
7#define __PDUMODEL_OCP_TRIP_SENSOR_IDL__
8
9#include <Outlet.idl>
10#include <StateSensor.idl>
11#include <Waveform.idl>
12
13/** PDU Model */
14module pdumodel {
15
16 /** Overcurrent protector trip sensor interface */
17 interface OverCurrentProtectorTripSensor extends sensors.StateSensor {
18 structure TripEventInformation {
19 Outlet cause; ///< Outlet that is most likely to have caused the OCP to trip.
20 time timestamp; ///< Timestamp of trip event
21 double current; ///< Current flow in outlet causing the event at trip time.
22 ///< If current flow can not be determined, this value is sent as 0.
23 };
24
25 /** Event: Overcurrent protector trip state has changed */
26 valueobject TripStateChangedEvent extends sensors.StateSensor.StateChangedEvent {
27 Outlet tripCause; ///< Outlet that is most likely to have caused the OCP to trip.
28 ///< Deprecated, use the tripInformation field instead.
29 TripEventInformation tripInformation; ///< Information about the event that caused a trip event.
30 };
31
32 /**
33 * Get the outlet that is most likely to have caused the last OCP trip.
34 *
35 * @return The outlet that most likely caused the OCP to trip. If either
36 * the OCP is not currently tripped or no outlet can be determined
37 * to have caused the trip, null is returned.
38 *
39 * This method is deprecated, use {@link getTripEventInformation} instead.
40 */
41 [deprecated]
42 Outlet getTripCause();
43
44 /**
45 * Get information about the last trip event.
46 *
47 * @return Trip event information, or an empty structure if the OCP currently isn't tripped.
48 */
49 TripEventInformation getTripEventInformation();
50
51 /**
52 * Get the voltage and current waveform during the last OCP trip event.
53 *
54 * @return The waveform during OCP trip in case both
55 * - A potential trip cause outlet could be determined and
56 * - The device supports waveform reading
57 * If either condition is not met, an empty waveform is returned.
58 */
59 Waveform getTripWaveform();
60 };
61
62}
63
64#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