blob: 5239b30f70c8350ae8a70d7b8f89b6b6e09f657a [file] [log] [blame]
Rashmica Guptae23af562021-07-29 15:12:16 +10001{
2 "$schema": "http://json-schema.org/draft-07/schema#",
Patrick Williams7d6080d2024-09-04 12:54:45 -04003 "$defs": {
Rashmica Guptae23af562021-07-29 15:12:16 +10004 "VirtualSensor": {
5 "title": "phosphor-virtual-sensor configuration",
Andrew Jefferybb8aa372024-03-20 11:24:32 +10306 "description": "The configuration used by the virtual-sensor daemon in the phosphor-virtual-sensor repository. Virtual sensors are xyz.openbmc_project.Sensor.Value D-Bus objects that have sensor values calculated from the D-Bus sensors listed here.",
Rashmica Guptae23af562021-07-29 15:12:16 +10007 "type": "object",
8 "properties": {
9 "MaxValidInput": {
Andrew Jefferybb8aa372024-03-20 11:24:32 +103010 "description": "Maximum valid value of an input sensor",
Rashmica Guptae23af562021-07-29 15:12:16 +100011 "type": "number"
12 },
13 "MaxValue": {
Andrew Jefferybb8aa372024-03-20 11:24:32 +103014 "description": "Maximum sensor value",
Patrick Williams7d6080d2024-09-04 12:54:45 -040015 "$ref": "legacy.json#/$defs/Types/MaxValue"
Rashmica Guptae23af562021-07-29 15:12:16 +100016 },
17 "MinValidInput": {
Andrew Jefferybb8aa372024-03-20 11:24:32 +103018 "description": "Miniumum valid value of an input sensor",
Rashmica Guptae23af562021-07-29 15:12:16 +100019 "type": "number"
20 },
21 "MinValue": {
Andrew Jefferybb8aa372024-03-20 11:24:32 +103022 "description": "Minimum sensor value",
Patrick Williams7d6080d2024-09-04 12:54:45 -040023 "$ref": "legacy.json#/$defs/Types/MinValue"
Rashmica Guptae23af562021-07-29 15:12:16 +100024 },
25 "Name": {
26 "type": "string"
27 },
28 "Sensors": {
Andrew Jefferybb8aa372024-03-20 11:24:32 +103029 "description": "Any DBus sensors whose values are used to determine the value of the virtual sensor.",
Rashmica Guptae23af562021-07-29 15:12:16 +100030 "items": {
31 "type": "string"
32 },
33 "type": "array"
34 },
35 "Thresholds": {
Andrew Jefferybb8aa372024-03-20 11:24:32 +103036 "description": "Threshold values used to set and clear alarms",
Patrick Williams7d6080d2024-09-04 12:54:45 -040037 "$ref": "legacy.json#/$defs/Types/Thresholds"
Rashmica Guptae23af562021-07-29 15:12:16 +100038 },
39 "Type": {
Andrew Jefferybb8aa372024-03-20 11:24:32 +103040 "description": "The type of calculation this sensor uses.",
Rashmica Guptae23af562021-07-29 15:12:16 +100041 "type": "string",
George Liuae36f5e2024-09-19 15:43:04 +080042 "enum": [
43 "Average",
44 "Maximum",
45 "Minimum",
46 "Sum",
47 "ModifiedMedian"
48 ]
Rashmica Guptae23af562021-07-29 15:12:16 +100049 },
50 "Units": {
Andrew Jefferybb8aa372024-03-20 11:24:32 +103051 "description": "The sensor type, as it shows up in the D-Bus object name.",
Patrick Williams7d6080d2024-09-04 12:54:45 -040052 "$ref": "legacy.json#/$defs/Types/Units"
Rashmica Guptae23af562021-07-29 15:12:16 +100053 }
54 },
Patrick Williamsfa8ee872022-12-07 07:00:42 -060055 "required": ["Name", "Sensors", "Type", "Units"]
Rashmica Guptae23af562021-07-29 15:12:16 +100056 }
57 }
58}