tlbmc/status.proto

edition = "2023";

package milotic_tlbmc;

option java_multiple_files = true;
option java_outer_classname = "StatusProto";

// Expected hardware information of the resource from deterministic BMC.
message ExpectedHardwareInfo {
  string expected_barepath = 1;
  string expected_part_number = 2;
  string expected_serial_number = 3;
}

// Presence status of the resource.
enum PresenceStatus {
  // the initial status of all resources before any probing happens or probing
  // is in progress.
  PRESENCE_STATUS_NOT_SCANNED = 0;
  // The probing/scanning has been performed, probing is done and the component
  // is found.
  PRESENCE_STATUS_PRESENT = 1;
  // The probing/scanning has been performed but the component is not found.
  PRESENCE_STATUS_NOT_FOUND = 2;
  // The probing/scanning has been performed and the component is present but
  // not anticipated to be there. (i,e. misplaced or extra elements)
  PRESENCE_STATUS_PRESENT_ILLOGICAL = 3;
}

// Operation status of the resource, typically used for resources that are
// polled periodically for telemetry.
// OperationStatus is only meaningful if the PresenceStatus is
// PRESENCE_STATUS_PRESENT. Otherwise, this field is meaningless.
enum OperationStatus {
  // The status where the sensor is not probed yet, expected not to be there,
  // or polling is still being set up, reading reporting should be discarded or
  // simply ignored.
  OPERATION_STATUS_UNAVAILABLE = 0;
  // The sensor is functioning properly, the reading is trustworthy, i.e. the
  // sensor polling and data acquisition process has executed successfully
  // without encountering any errors and the reading reflect the most current
  // reading from the sensor.
  OPERATION_STATUS_FUNCTIONAL = 1;
  // The sensor polling has encountered some error and the reading should be
  // discarded.
  OPERATION_STATUS_ERROR = 2;
}