HardwareHealth.idl
/* SPDX-License-Identifier: BSD-3-Clause */
/*
* Copyright 2018 Raritan Inc. All rights reserved.
*/
#include <Event.idl>
module fitness {
interface HardwareHealth_1_0_1 {
/** hardware failure types */
constant int FAILURE_TYPE_NETWORK_DEVICE_NOT_DETECTED = 1;
constant int FAILURE_TYPE_I2C_BUS_STUCK = 2;
constant int FAILURE_TYPE_SLAVE_CTRL_NOT_REACHABLE = 3;
constant int FAILURE_TYPE_SLAVE_CTRL_MALFUNCTION = 4;
constant int FAILURE_TYPE_OUTLET_POWER_STATE_INCONSISTENT = 5;
/** Hardware Failure */
structure Failure {
int creationOrderId; ///< failures created later have a larger id; range 1..failure-count
string componentId; ///< the ID of the affected hardware component
int type; ///< one of the hardware failure type constants
string description; ///< human readable string describing HW component and failure
boolean isAsserted; ///< \c true when the failure is currently asserted
time lastAssertTimeStamp; ///< timestamp when the failure was last asserted
time lastDeassertTimeStamp; ///< timestamp when the failure was last deasserted (0 if asserted)
int assertCount; ///< count of assertions
};
/** Event that is send when the hardware failure status changes */
valueobject FailureStatusChangedEvent extends idl.Event {
string componentId; ///< the ID of the affected hardware component
int failureType; ///< one of the hardware failure type constants
boolean isAsserted; ///< \c true when the failure is currently asserted
};
/**
* Return a vector with past and present hardware failures.
*
* @return hardware failure vector
*/
vector<Failure> getFailures();
};
}
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::componentId
string componentId
the ID of the affected hardware component
Definition: HardwareHealth.idl:22
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::isAsserted
boolean isAsserted
true when the failure is currently asserted
Definition: HardwareHealth.idl:35
fitness::HardwareHealth_1_0_1::Failure
Hardware Failure.
Definition: HardwareHealth.idl:20
idl
Basic IDL definitions.
Definition: Event.idl:10
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::lastAssertTimeStamp
time lastAssertTimeStamp
timestamp 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::HardwareHealth_1_0_1::Failure::lastDeassertTimeStamp
time lastDeassertTimeStamp
timestamp when the failure was last deasserted (0 if asserted)
Definition: HardwareHealth.idl:27
fitness::HardwareHealth_1_0_1::Failure::assertCount
int assertCount
count of assertions
Definition: HardwareHealth.idl:28
fitness::HardwareHealth_1_0_1
Definition: HardwareHealth.idl:10
fitness
Fitness Daemon
Definition: Fitness.idl:7
fitness::HardwareHealth_1_0_1::failureType
int failureType
one of the hardware failure type constants
Definition: HardwareHealth.idl:34