Raritan PX2/PX3 JSON-RPC API
HardwareHealth.idl
1 /* SPDX-License-Identifier: BSD-3-Clause */
2 /*
3  * Copyright 2018 Raritan Inc. All rights reserved.
4  */
5 
6 #include <Event.idl>
7 
8 module fitness {
9 
11 
12  /** hardware failure types */
13  constant int FAILURE_TYPE_NETWORK_DEVICE_NOT_DETECTED = 1;
14  constant int FAILURE_TYPE_I2C_BUS_STUCK = 2;
15  constant int FAILURE_TYPE_SLAVE_CTRL_NOT_REACHABLE = 3;
16  constant int FAILURE_TYPE_SLAVE_CTRL_MALFUNCTION = 4;
17  constant int FAILURE_TYPE_OUTLET_POWER_STATE_INCONSISTENT = 5;
18 
19  /** Hardware Failure */
20  structure Failure {
21  int creationOrderId; ///< failures created later have a larger id; range 1..failure-count
22  string componentId; ///< the ID of the affected hardware component
23  int type; ///< one of the hardware failure type constants
24  string description; ///< human readable string describing HW component and failure
25  boolean isAsserted; ///< \c true when the failure is currently asserted
26  time lastAssertTimeStamp; ///< UNIX timestamp (UTC) when the failure was last asserted
27  time lastDeassertTimeStamp; ///< UNIX timestamp (UTC) when the failure was last deasserted (0 if asserted)
28  int assertCount; ///< count of assertions
29  };
30 
31  /** Event that is send when the hardware failure status changes */
32  valueobject FailureStatusChangedEvent extends idl.Event {
33  string componentId; ///< the ID of the affected hardware component
34  int failureType; ///< one of the hardware failure type constants
35  boolean isAsserted; ///< \c true when the failure is currently asserted
36  };
37 
38  /**
39  * Return a vector with past and present hardware failures.
40  *
41  * @return hardware failure vector
42  */
43  vector<Failure> getFailures();
44 
45  };
46 
47 }
fitness::HardwareHealth_1_0_1::failureType
int failureType
one of the hardware failure type constants
Definition: HardwareHealth.idl:34
fitness::HardwareHealth_1_0_1::Failure::lastAssertTimeStamp
time lastAssertTimeStamp
UNIX timestamp (UTC) when the failure was last asserted.
Definition: HardwareHealth.idl:26
fitness::HardwareHealth_1_0_1::Failure::creationOrderId
int creationOrderId
failures created later have a larger id; range 1..failure-count
Definition: HardwareHealth.idl:21
fitness
Fitness Daemon
Definition: Fitness.idl:7
fitness::HardwareHealth_1_0_1::Failure::type
int type
one of the hardware failure type constants
Definition: HardwareHealth.idl:23
fitness::HardwareHealth_1_0_1::Failure::assertCount
int assertCount
count of assertions
Definition: HardwareHealth.idl:28
idl
Basic IDL definitions.
Definition: Event.idl:10
fitness::HardwareHealth_1_0_1
Definition: HardwareHealth.idl:10
fitness::HardwareHealth_1_0_1::getFailures
vector< Failure > getFailures()
Return a vector with past and present hardware failures.
fitness::HardwareHealth_1_0_1::Failure::isAsserted
boolean isAsserted
true when the failure is currently asserted
Definition: HardwareHealth.idl:25
fitness::HardwareHealth_1_0_1::Failure
Hardware Failure.
Definition: HardwareHealth.idl:20
fitness::HardwareHealth_1_0_1::Failure::componentId
string componentId
the ID of the affected hardware component
Definition: HardwareHealth.idl:22
fitness::HardwareHealth_1_0_1::isAsserted
boolean isAsserted
true when the failure is currently asserted
Definition: HardwareHealth.idl:35
fitness::HardwareHealth_1_0_1::Failure::description
string description
human readable string describing HW component and failure
Definition: HardwareHealth.idl:24
fitness::HardwareHealth_1_0_1::Failure::lastDeassertTimeStamp
time lastDeassertTimeStamp
UNIX timestamp (UTC) when the failure was last deasserted (0 if asserted)
Definition: HardwareHealth.idl:27