xref: /openbmc/entity-manager/schemas/valve.json (revision 86780aa23e01a4215314f067b139d01fa0b320d0)

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "$defs": {
        "GPIOValve": {
            "additionalProperties": false,
            "description": "Configuration for GPIO based Valve.",
            "type": "object",
            "properties": {
                "Name": {
                    "description": "The name of the valve.",
                    "type": "string"
                },
                "Type": {
                    "description": "The type of configuration object",
                    "const": "GPIOValve"
                },
                "OpenPinName": {
                    "description": "The name of the GPIO pin that shows the valve's open status.",
                    "type": "string"
                },
                "OpenPolarity": {
                    "description": "The GPIO polarity depicting valve's open status.",
                    "$ref": "legacy.json#/$defs/Types/Polarity"
                },
                "OpenControlPinName": {
                    "description": "The name of the GPIO pin that controls opening the valve.",
                    "type": "string"
                },
                "OpenControlValue": {
                    "description": "The GPIO value to set to open the valve.",
                    "type": "boolean"
                },
                "CoolantLoopName": {
                    "description": "The name of the coolant loop to which this valve is connected.",
                    "type": "string"
                }
            },
            "required": [
                "Name",
                "Type",
                "OpenPinName",
                "OpenPolarity",
                "OpenControlPinName",
                "OpenControlValue",
                "CoolantLoopName"
            ]
        }
    }
}