Legrand / Raritan / Server Technology Xerus™ JSON-RPC API: Controller.idl Source File

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

Loading...
Searching...
No Matches
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 */
14module pdumodel {
15
16 /** Sub controller statistics */
17 structure CtrlStatistic {
18 int mainCSumErrCnt; ///< Main controller CRC error counter
19 int subCSumErrCnt; ///< Sub controller CRC error counter
20 int timeoutCnt; ///< Main controller timeout counter
21 int resetCnt; ///< Controller reset counter
22 int emResetCnt; ///< Energy meter reset counter
23 };
24
25 /** Sub controller interface */
26 interface Controller {
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 /** Sub controller type */
40 enumeration Type {
41 OUTLET_CTRL, ///< %Outlet controller
42 INLET_CTRL, ///< %Inlet controller
43 METER_CTRL ///< %General metering controller
44 };
45
46 /** Sub controller metadata */
47 structure MetaData {
48 Type type; ///< %Controller type
49 string address; ///< Sub controller 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 boolean isOptional; ///< \c true if this controller is optional (temporary absence may be expected)
59 };
60
61 /** Event: Controller communication status has changed */
62 valueobject StatusChangedEvent extends idl.Event {
63 Status oldStatus; ///< Status before change
64 Status newStatus; ///< Status after change
65 };
66
67 /** Event: Controller metadata has changed */
68 valueobject MetaDataChangedEvent extends idl.Event {
69 MetaData oldMetaData; ///< Metadata before change
70 MetaData newMetaData; ///< Metadata after change
71 };
72
73 /**
74 * Retrieve the current status of communication with controller
75 *
76 * @return communication status
77 */
78 Status getCommunicationStatus();
79
80 /**
81 * Retrieve statistics
82 *
83 * @return statistics of %Controller
84 */
85 CtrlStatistic getStatistics();
86
87 /**
88 * Retrieve the sub controller metadata.
89 *
90 * @return %Controller metadata
91 */
92 MetaData getMetaData();
93
94 /**
95 * Reset this sub controller.
96 *
97 * Note: Depending on the hardware setup of the specific device, calling
98 * this method may also cause other sub controllers to be reset.
99
100 * @return 0 on success
101 * ERR_NOT_SUPPORTED if the hardware setup doesn't allow resetting the controller
102 */
103 int reset();
104 };
105
106}
107
108#endif
pdumodel::Controller
Sub controller interface.
Definition Controller.idl:26
pdumodel::Controller::Type
Type
Sub controller type.
Definition Controller.idl:40
pdumodel::Controller::METER_CTRL
@ METER_CTRL
General metering controller
Definition Controller.idl:43
pdumodel::Controller::INLET_CTRL
@ INLET_CTRL
Inlet controller
Definition Controller.idl:42
pdumodel::Controller::OUTLET_CTRL
@ OUTLET_CTRL
Outlet controller
Definition Controller.idl:41
pdumodel::Controller::ERR_NOT_SUPPORTED
constant int ERR_NOT_SUPPORTED
Operation not supported.
Definition Controller.idl:27
pdumodel::Controller::getStatistics
CtrlStatistic getStatistics()
Retrieve statistics.
pdumodel::Controller::getMetaData
MetaData getMetaData()
Retrieve the sub controller metadata.
pdumodel::Controller::reset
int reset()
Reset this sub controller.
pdumodel::Controller::getCommunicationStatus
Status getCommunicationStatus()
Retrieve the current status of communication with controller.
pdumodel::Controller::Status
Status
Communication status.
Definition Controller.idl:30
pdumodel::Controller::COMMUNICATION_FAILURE
@ COMMUNICATION_FAILURE
Controller can't be communicated with.
Definition Controller.idl:33
pdumodel::Controller::FIRMWARE_UPDATE
@ FIRMWARE_UPDATE
A controller firmware update is in progress.
Definition Controller.idl:36
pdumodel::Controller::INCOMPATIBLE
@ INCOMPATIBLE
The characteristics of the controller don't meet the expectations.
Definition Controller.idl:35
pdumodel::Controller::OK
@ OK
Communication with controller is known to be working.
Definition Controller.idl:31
pdumodel::Controller::COMMUNICATION_UNSTABLE
@ COMMUNICATION_UNSTABLE
Controller can be communicated with sporadically.
Definition Controller.idl:32
pdumodel::Controller::UNKNOWN
@ UNKNOWN
Communication status is unknown, e.g. after startup.
Definition Controller.idl:34
idl
Basic IDL definitions.
Definition Event.idl:10
pdumodel
PDU Model.
Definition Circuit.idl:16
serial
Serial Ports.
Definition AnalogModem.idl:12
idl::Event
Common base for all events.
Definition Event.idl:13
pdumodel::Controller::MetaDataChangedEvent
Event: Controller metadata has changed.
Definition Controller.idl:68
pdumodel::Controller::MetaDataChangedEvent::oldMetaData
MetaData oldMetaData
Metadata before change.
Definition Controller.idl:69
pdumodel::Controller::MetaDataChangedEvent::newMetaData
MetaData newMetaData
Metadata after change.
Definition Controller.idl:70
pdumodel::Controller::MetaData
Sub controller metadata.
Definition Controller.idl:47
pdumodel::Controller::MetaData::isOptional
boolean isOptional
true if this controller is optional (temporary absence may be expected)
Definition Controller.idl:58
pdumodel::Controller::MetaData::hwVersion
int hwVersion
Hardware version; 0 if unavailable.
Definition Controller.idl:54
pdumodel::Controller::MetaData::magic
int magic
Magic code.
Definition Controller.idl:50
pdumodel::Controller::MetaData::address
string address
Sub controller address.
Definition Controller.idl:49
pdumodel::Controller::MetaData::fwBootVersion
int fwBootVersion
Firmware bootloader version; 0 if unavailable.
Definition Controller.idl:53
pdumodel::Controller::MetaData::haveResetCnt
boolean haveResetCnt
true if controller reset counter is available
Definition Controller.idl:56
pdumodel::Controller::MetaData::haveEmResetCnt
boolean haveEmResetCnt
true if energy meter reset counter is available
Definition Controller.idl:57
pdumodel::Controller::MetaData::fwAppVersion
int fwAppVersion
Firmware application version; 0 if unavailable.
Definition Controller.idl:52
pdumodel::Controller::MetaData::type
Type type
Controller type
Definition Controller.idl:48
pdumodel::Controller::MetaData::versionAvailable
boolean versionAvailable
true if version information and serial number is available
Definition Controller.idl:51
pdumodel::Controller::StatusChangedEvent
Event: Controller communication status has changed.
Definition Controller.idl:62
pdumodel::Controller::StatusChangedEvent::oldStatus
Status oldStatus
Status before change.
Definition Controller.idl:63
pdumodel::Controller::StatusChangedEvent::newStatus
Status newStatus
Status after change.
Definition Controller.idl:64
pdumodel::CtrlStatistic
Sub controller statistics.
Definition Controller.idl:17
pdumodel::CtrlStatistic::resetCnt
int resetCnt
Controller reset counter.
Definition Controller.idl:21
pdumodel::CtrlStatistic::subCSumErrCnt
int subCSumErrCnt
Sub controller CRC error counter.
Definition Controller.idl:19
pdumodel::CtrlStatistic::timeoutCnt
int timeoutCnt
Main controller timeout counter.
Definition Controller.idl:20
pdumodel::CtrlStatistic::mainCSumErrCnt
int mainCSumErrCnt
Main controller CRC error counter.
Definition Controller.idl:18
pdumodel::CtrlStatistic::emResetCnt
int emResetCnt
Energy meter reset counter.
Definition Controller.idl:22