tlbmc/fan_tach_config.proto

edition = "2023";

package milotic_tlbmc;

import "entity_common_config.proto";
import "hal_common_config.proto";
import "reading_range_config.proto";
import "threshold_config.proto";

enum FanTachType {
  TACH_SENSOR_TYPE_UNKNOWN = 0;
  TACH_SENSOR_TYPE_I2C_FAN = 1;
}

// Config for a Tach sensor device.
// A single device config generates a single sensor.
message FanTachConfig {
  // Specifies the type of the Tach sensor.
  FanTachType type = 1;
  // Specifies the bus/address information of the sensor so that libraries know
  // where and how to refresh the telemetry.
  HalCommonConfig hal_common_config = 2;
  // Specifies the name of the Tach reading when it is exposed.
  string name = 3;
  // The thresholds that we want to monitor for the sensor.
  ThresholdConfigs thresholds = 4;
  // Specifies the reading range of the sensor.
  ReadingRangeConfigs reading_ranges = 5;
  EntityCommonConfig entity_common_config = 6;
  // The 1 based index of the Tach sensor within the same controller.
  uint32 index = 7;
  // 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 = 8;
}