xref: /openbmc/entity-manager/schemas/virtual_sensor.json (revision f7b0b472)

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "definitions": {
        "VirtualSensor": {
            "title": "phosphor-virtual-sensor configuration",
            "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."
            ],
            "type": "object",
            "properties": {
                "MaxValidInput": {
                    "description": ["Maximum valid value of an input sensor"],
                    "type": "number"
                },
                "MaxValue": {
                    "description": ["Maximum sensor value"],
                    "$ref": "legacy.json#/definitions/Types/MaxValue"
                },
                "MinValidInput": {
                    "description": ["Miniumum valid value of an input sensor"],
                    "type": "number"
                },
                "MinValue": {
                    "description": ["Minimum sensor value"],
                    "$ref": "legacy.json#/definitions/Types/MinValue"
                },
                "Name": {
                    "type": "string"
                },
                "Sensors": {
                    "description": [
                        "Any DBus sensors whose values are used to",
                        "determine the value of the virtual sensor."
                    ],
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                "Thresholds": {
                    "description": [
                        "Threshold values used to set and clear alarms"
                    ],
                    "$ref": "legacy.json#/definitions/Types/Thresholds"
                },
                "Type": {
                    "description": [
                        "The type of calculation this sensor uses."
                    ],
                    "type": "string",
                    "enum": ["ModifiedMedian", "Maximum"]
                },
                "Units": {
                    "description": [
                        "The sensor type, as it shows up in the D-Bus",
                        "object name."
                    ],
                    "$ref": "legacy.json#/definitions/Types/Units"
                }
            },
            "required": ["Name", "Sensors", "Type", "Units"]
        }
    }
}