tlbmc/entity_common_config.proto

edition = "2023";

package milotic_tlbmc;

import "google/protobuf/duration.proto";
import "resource.proto";

message RelatedItem {
  string id = 1;
  ResourceType type = 2;
  string system_id = 3 [default = "system"];
}

enum SensorPowerRequirement {
  // reference:
  // https://github.com/openbmc/dbus-sensors/blob/5d5910ff96f8a8e4d5f6f868d9438e4a55eca158/src/Utils.hpp#L187
  SENSOR_POWER_REQUIREMENT_UNKNOWN = 0;
  // This sensor regardless of host power state.
  SENSOR_POWER_REQUIREMENT_ALWAYS = 1;
  // This sensor is only active when the chassis is in power on state.
  SENSOR_POWER_REQUIREMENT_CHASSIS_ON = 2;
  // This sensor is only active when the host is in the BIOS POST state.
  SENSOR_POWER_REQUIREMENT_BIOS_POST = 3;
}

message EntityCommonConfig {
  // Board with the config key that this entity belongs to.
  string board_config_key = 1;
  // Specifies the refresh interval of this device.
  google.protobuf.Duration refresh_interval = 2;
  // Specifies the size of the queue storing the readings associated with the
  // entity. This together with refresh interval is useful for generating time
  // series data.
  uint64 queue_size = 3 [default = 10];
  // Is the entity detected? If false, we expect the entity to be detected later
  // via ad hoc FRU scan.
  bool config_detected = 4 [default = true];
  // The sensor group that this sensor belongs to. Likely a unique identifier
  // for the root bus that this sensor is associated with.
  string sensor_group = 5;
  // Specifies the name of the config for this entity.
  string config_name = 6;
  // Specifies the power state dependency of this entity.
  SensorPowerRequirement power_state = 7
      [default = SENSOR_POWER_REQUIREMENT_ALWAYS];
  // Specifies the host that this entity's power state depends on if power state
  // is not SENSOR_POWER_REQUIREMENT_ALWAYS.
  string host_id = 8;
}