Raritan PX2/PX3 JSON-RPC API
Controller.idl
1 /* SPDX-License-Identifier: BSD-3-Clause */
2 /*
3  * Copyright 2010 Raritan Inc. All rights reserved.
4  */
5 
6 #ifndef __PDUMODEL_CONTROLLER_IDL__
7 #define __PDUMODEL_CONTROLLER_IDL__
8 
9 #include <Event.idl>
10 
11 /**
12  * PDU Model
13  */
14 module pdumodel {
15 
16  /** Slave controller statistics */
17  structure CtrlStatistic {
18  int masterCSumErrCnt; ///< Master CRC error counter
19  int slaveCSumErrCnt; ///< Slave CRC error counter
20  int timeoutCnt; ///< Master timeout counter
21  int resetCnt; ///< Controller reset counter
22  int emResetCnt; ///< Energy meter reset counter
23  };
24 
25  /** Slave controller interface */
26  interface Controller_4_0_1 {
27  constant int ERR_NOT_SUPPORTED = 1; ///< Operation not supported
28 
29  /** Communication status */
30  enumeration Status {
31  OK, ///< Communication with controller is known to be working
32  COMMUNICATION_UNSTABLE, ///< Controller can be communicated with sporadically
33  COMMUNICATION_FAILURE, ///< Controller can't be communicated with
34  UNKNOWN, ///< Communication status is unknown, e.g. after startup
35  INCOMPATIBLE, ///< The characteristics of the controller don't meet the expectations
36  FIRMWARE_UPDATE ///< A controller firmware update is in progress
37  };
38 
39  /** Slave controller type */
40  enumeration Type {
41  OUTLET_CTRL, ///< %Outlet controller
42  INLET_CTRL, ///< %Inlet controller
43  METER_CTRL ///< %General metering controller
44  };
45 
46  /** Slave controller metadata */
47  structure MetaData {
48  Type type; ///< %Controller type
49  string address; ///< Slave address
50  int magic; ///< Magic code
51  boolean versionAvailable; ///< \c true if version information and serial number is available
52  int fwAppVersion; ///< Firmware application version; 0 if unavailable
53  int fwBootVersion; ///< Firmware bootloader version; 0 if unavailable
54  int hwVersion; ///< Hardware version; 0 if unavailable
55  string serial; ///< Serial number; empty if unavailable
56  boolean haveResetCnt; ///< \c true if controller reset counter is available
57  boolean haveEmResetCnt; ///< \c true if energy meter reset counter is available
58  };
59 
60  /** Event: Controller communication status has changed */
61  valueobject StatusChangedEvent extends idl.Event {
62  Status oldStatus; ///< Status before change
63  Status newStatus; ///< Status after change
64  };
65 
66  /** Event: Controller metadata has changed */
67  valueobject MetaDataChangedEvent extends idl.Event {
68  MetaData oldMetaData; ///< Metadata before change
69  MetaData newMetaData; ///< Metadata after change
70  };
71 
72  /**
73  * Retrieve the current status of communication with controller
74  *
75  * @return communication status
76  */
78 
79  /**
80  * Retrieve statistics
81  *
82  * @return statistics of %Controller
83  */
85 
86  /**
87  * Retrieve the slave controller metadata.
88  *
89  * @return %Controller metadata
90  */
92 
93  /**
94  * Reset this slave controller.
95  *
96  * Note: Depending on the hardware setup of the specific device, calling
97  * this method may also cause other slave controllers to be reset.
98 
99  * @return 0 on success
100  * ERR_NOT_SUPPORTED if the hardware setup doesn't allow resetting the controller
101  */
102  int reset();
103  };
104 
105 }
106 
107 #endif
pdumodel::CtrlStatistic::resetCnt
int resetCnt
Controller reset counter.
Definition: Controller.idl:21
pdumodel::Controller_4_0_1::MetaData::hwVersion
int hwVersion
Hardware version; 0 if unavailable.
Definition: Controller.idl:54
pdumodel::Controller_4_0_1::getStatistics
CtrlStatistic getStatistics()
Retrieve statistics.
pdumodel::Controller_4_0_1::MetaData::magic
int magic
Magic code.
Definition: Controller.idl:50
pdumodel::Controller_4_0_1::MetaData::fwBootVersion
int fwBootVersion
Firmware bootloader version; 0 if unavailable.
Definition: Controller.idl:53
pdumodel::Controller_4_0_1::MetaData::haveEmResetCnt
boolean haveEmResetCnt
true if energy meter reset counter is available
Definition: Controller.idl:57
pdumodel::Controller_4_0_1::COMMUNICATION_FAILURE
@ COMMUNICATION_FAILURE
Controller can't be communicated with.
Definition: Controller.idl:33
pdumodel::Controller_4_0_1::OUTLET_CTRL
@ OUTLET_CTRL
Outlet controller
Definition: Controller.idl:41
pdumodel::CtrlStatistic::slaveCSumErrCnt
int slaveCSumErrCnt
Slave CRC error counter.
Definition: Controller.idl:19
pdumodel::Controller_4_0_1::getCommunicationStatus
Status getCommunicationStatus()
Retrieve the current status of communication with controller.
pdumodel::Controller_4_0_1::UNKNOWN
@ UNKNOWN
Communication status is unknown, e.g. after startup.
Definition: Controller.idl:34
pdumodel::Controller_4_0_1::COMMUNICATION_UNSTABLE
@ COMMUNICATION_UNSTABLE
Controller can be communicated with sporadically.
Definition: Controller.idl:32
pdumodel
PDU Model.
Definition: Ade.idl:12
pdumodel::Controller_4_0_1::getMetaData
MetaData getMetaData()
Retrieve the slave controller metadata.
pdumodel::Controller_4_0_1::OK
@ OK
Communication with controller is known to be working.
Definition: Controller.idl:31
pdumodel::Controller_4_0_1::MetaData::versionAvailable
boolean versionAvailable
true if version information and serial number is available
Definition: Controller.idl:51
pdumodel::Controller_4_0_1::MetaData::haveResetCnt
boolean haveResetCnt
true if controller reset counter is available
Definition: Controller.idl:56
pdumodel::Controller_4_0_1::newStatus
Status newStatus
Status after change.
Definition: Controller.idl:63
pdumodel::Controller_4_0_1::MetaData::serial
string serial
Serial number; empty if unavailable.
Definition: Controller.idl:55
pdumodel::Controller_4_0_1::MetaData::type
Type type
Controller type
Definition: Controller.idl:48
idl
Basic IDL definitions.
Definition: Event.idl:10
pdumodel::Controller_4_0_1::MetaData::fwAppVersion
int fwAppVersion
Firmware application version; 0 if unavailable.
Definition: Controller.idl:52
pdumodel::CtrlStatistic
Slave controller statistics.
Definition: Controller.idl:17
pdumodel::Controller_4_0_1::MetaData::address
string address
Slave address.
Definition: Controller.idl:49
pdumodel::Controller_4_0_1::MetaData
Slave controller metadata.
Definition: Controller.idl:47
pdumodel::CtrlStatistic::masterCSumErrCnt
int masterCSumErrCnt
Master CRC error counter.
Definition: Controller.idl:18
pdumodel::Controller_4_0_1::INCOMPATIBLE
@ INCOMPATIBLE
The characteristics of the controller don't meet the expectations.
Definition: Controller.idl:35
pdumodel::Controller_4_0_1::Type
Type
Slave controller type.
Definition: Controller.idl:40
pdumodel::Controller_4_0_1::INLET_CTRL
@ INLET_CTRL
Inlet controller
Definition: Controller.idl:42
pdumodel::Controller_4_0_1::reset
int reset()
Reset this slave controller.
pdumodel::CtrlStatistic::emResetCnt
int emResetCnt
Energy meter reset counter.
Definition: Controller.idl:22
pdumodel::Controller_4_0_1::newMetaData
MetaData newMetaData
Metadata after change.
Definition: Controller.idl:69
pdumodel::CtrlStatistic::timeoutCnt
int timeoutCnt
Master timeout counter.
Definition: Controller.idl:20
pdumodel::Controller_4_0_1
Slave controller interface.
Definition: Controller.idl:26
pdumodel::Controller_4_0_1::Status
Status
Communication status.
Definition: Controller.idl:30