Loading...
Searching...
No Matches
HardwareHealth.idl
/* SPDX-License-Identifier: BSD-3-Clause */
/*
* Copyright 2018 Raritan Inc. All rights reserved.
*/
#include <Event.idl>
module fitness {
interface HardwareHealth {
/** hardware failure types */
constant int FAILURE_TYPE_NETWORK_DEVICE_NOT_DETECTED = 1;
constant int FAILURE_TYPE_I2C_BUS_STUCK = 2;
constant int FAILURE_TYPE_SUB_CTRL_NOT_REACHABLE = 3;
constant int FAILURE_TYPE_SUB_CTRL_MALFUNCTION = 4;
constant int FAILURE_TYPE_OUTLET_POWER_STATE_INCONSISTENT = 5;
constant int FAILURE_TYPE_SUB_CTRL_INCOMPATIBLE = 6;
/** 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; ///< UNIX timestamp (UTC) when the failure was last asserted
time lastDeassertTimeStamp; ///< UNIX timestamp (UTC) 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
Definition HardwareHealth.idl:10
fitness::HardwareHealth::getFailures
vector< Failure > getFailures()
Return a vector with past and present hardware failures.
fitness
Fitness Daemon
Definition Fitness.idl:7
idl
Basic IDL definitions.
Definition Event.idl:10
fitness::HardwareHealth::FailureStatusChangedEvent
Event that is send when the hardware failure status changes.
Definition HardwareHealth.idl:33
fitness::HardwareHealth::FailureStatusChangedEvent::failureType
int failureType
one of the hardware failure type constants
Definition HardwareHealth.idl:35
fitness::HardwareHealth::FailureStatusChangedEvent::isAsserted
boolean isAsserted
true when the failure is currently asserted
Definition HardwareHealth.idl:36
fitness::HardwareHealth::FailureStatusChangedEvent::componentId
string componentId
the ID of the affected hardware component
Definition HardwareHealth.idl:34
fitness::HardwareHealth::Failure
Hardware Failure.
Definition HardwareHealth.idl:21
fitness::HardwareHealth::Failure::assertCount
int assertCount
count of assertions
Definition HardwareHealth.idl:29
fitness::HardwareHealth::Failure::type
int type
one of the hardware failure type constants
Definition HardwareHealth.idl:24
fitness::HardwareHealth::Failure::creationOrderId
int creationOrderId
failures created later have a larger id; range 1..failure-count
Definition HardwareHealth.idl:22
fitness::HardwareHealth::Failure::description
string description
human readable string describing HW component and failure
Definition HardwareHealth.idl:25
fitness::HardwareHealth::Failure::isAsserted
boolean isAsserted
true when the failure is currently asserted
Definition HardwareHealth.idl:26
fitness::HardwareHealth::Failure::lastAssertTimeStamp
time lastAssertTimeStamp
UNIX timestamp (UTC) when the failure was last asserted.
Definition HardwareHealth.idl:27
fitness::HardwareHealth::Failure::componentId
string componentId
the ID of the affected hardware component
Definition HardwareHealth.idl:23
fitness::HardwareHealth::Failure::lastDeassertTimeStamp
time lastDeassertTimeStamp
UNIX timestamp (UTC) when the failure was last deasserted (0 if asserted)
Definition HardwareHealth.idl:28
idl::Event
Common base for all events.
Definition Event.idl:13