Skip to content

Heating Circuits

matsdune edited this page Feb 13, 2021 · 1 revision

GET /heatingCircuits

List heating circuits

{
    "id": "/heatingCircuits",
    "type": "refEnum",
    "references": [
        {
            "id": "/heatingCircuits/hc1",
            "uri": "http://192.168.1.100/heatingCircuits/hc1"
        }
    ]
}

GET /heatingCircuits/hc1/operationMode

{
    "id": "/heatingCircuits/hc1/operationMode",
    "type": "stringValue",
    "writeable": 1,
    "recordable": 0,
    "value": "manual",
    "allowedValues": [
        "auto",
        "manual"
    ]
}

GET /heatingCircuits/hc1/temperatureLevels

n/a

GET /heatingCircuits/hc1/manualRoomSetpoint

{
    "id": "/heatingCircuits/hc1/manualRoomSetpoint",
    "type": "floatValue",
    "writeable": 1,
    "recordable": 0,
    "value": 21,
    "unitOfMeasure": "C",
    "minValue": 5,
    "maxValue": 30,
    "state": [
        {
            "off": 0
        }
    ]
}

GET /heatingCircuits/hc1/holidayMode/activated

{
    "id": "/heatingCircuits/hc1/holidayMode/activated",
    "type": "stringValue",
    "writeable": 0,
    "recordable": 0,
    "value": "",
    "allowedValues": [
        "",
        "hm1",
        "hm2",
        "hm3",
        "hm4",
        "hm5"
    ]
}

GET /heatingCircuits/hc1/currentRoomSetpoint

{
    "id": "/heatingCircuits/hc1/currentRoomSetpoint",
    "type": "floatValue",
    "writeable": 0,
    "recordable": 0,
    "value": 21,
    "unitOfMeasure": "C",
    "state": [
        {
            "off": 0
        }
    ]
}

GET /heatingCircuits/hc1/actualSupplyTemperature

{
    "id": "/heatingCircuits/hc1/actualSupplyTemperature",
    "type": "floatValue",
    "writeable": 0,
    "recordable": 0,
    "value": 42.3,
    "unitOfMeasure": "C",
    "state": [
        {
            "open": -3276.8
        },
        {
            "short": 3276.7
        }
    ]
}

GET /heatingCircuits/hc1/operationMode

{
    "id": "/heatingCircuits/hc1/operationMode",
    "type": "stringValue",
    "writeable": 1,
    "recordable": 0,
    "value": "manual",
    "allowedValues": [
        "auto",
        "manual"
    ]
}

GET /heatingCircuits/hc1/temperatureRoomSetpoint

{
    "id": "/heatingCircuits/hc1/temperatureRoomSetpoint",
    "type": "floatValue",
    "writeable": 1,
    "recordable": 0,
    "value": 21,
    "unitOfMeasure": "C",
    "minValue": 5,
    "maxValue": 30,
    "state": [
        {
            "off": 0
        }
    ]
}

GET /heatingCircuits/hc1/supplyTemperatureSetpoint

{
    "id": "/heatingCircuits/hc1/supplyTemperatureSetpoint",
    "type": "floatValue",
    "writeable": 0,
    "recordable": 0,
    "value": 42,
    "unitOfMeasure": "C",
    "state": [
        {
            "off_heat": 0
        },
        {
            "off_cool": 90
        }
    ]
}

GET /heatingCircuits/hc1/manualRoomSetpoint

{
    "id": "/heatingCircuits/hc1/manualRoomSetpoint",
    "type": "floatValue",
    "writeable": 1,
    "recordable": 0,
    "value": 21,
    "unitOfMeasure": "C",
    "minValue": 5,
    "maxValue": 30,
    "state": [
        {
            "off": 0
        }
    ]
}

GET /heatingCircuits/hc1/roomtemperature

{
    "id": "/heatingCircuits/hc1/roomtemperature",
    "type": "floatValue",
    "writeable": 0,
    "recordable": 1,
    "value": -3276.8,
    "unitOfMeasure": "C",
    "state": [
        {
            "open": -3276.8
        },
        {
            "short": 3276.7
        }
    ]
}

GET /heatingCircuits/hc1/switchPrograms/A

{
    "id": "/heatingCircuits/hc1/switchPrograms/A",
    "type": "switchProgram",
    "setpointProperty": {
        "id": "/heatingCircuits/hc1/temperatureLevels",
        "uri": "http://192.168.1.100/heatingCircuits/hc1/temperatureLevels"
    },
    "maxNbOfSwitchPoints": 14,
    "maxNbOfSwitchPointsPerDay": 2,
    "switchPointTimeRaster": 15,
    "writeable": 1,
    "switchPoints": [
        {
            "dayOfWeek": "Mo",
            "setpoint": "comfort2",
            "time": 360
        },
        {
            "dayOfWeek": "Mo",
            "setpoint": "eco",
            "time": 1380
        },
        {
            "dayOfWeek": "Tu",
            "setpoint": "comfort2",
            "time": 360
        },
        {
            "dayOfWeek": "Tu",
            "setpoint": "eco",
            "time": 1380
        },
        {
            "dayOfWeek": "We",
            "setpoint": "comfort2",
            "time": 360
        },
        {
            "dayOfWeek": "We",
            "setpoint": "eco",
            "time": 1380
        },
        {
            "dayOfWeek": "Th",
            "setpoint": "comfort2",
            "time": 360
        },
        {
            "dayOfWeek": "Th",
            "setpoint": "eco",
            "time": 1380
        },
        {
            "dayOfWeek": "Fr",
            "setpoint": "comfort2",
            "time": 360
        },
        {
            "dayOfWeek": "Fr",
            "setpoint": "eco",
            "time": 1380
        },
        {
            "dayOfWeek": "Sa",
            "setpoint": "comfort2",
            "time": 480
        },
        {
            "dayOfWeek": "Sa",
            "setpoint": "eco",
            "time": 1380
        },
        {
            "dayOfWeek": "Su",
            "setpoint": "comfort2",
            "time": 480
        },
        {
            "dayOfWeek": "Su",
            "setpoint": "eco",
            "time": 1380
        }
    ]
}

GET /heatingCircuits/hc1/switchPrograms/B

{
    "id": "/heatingCircuits/hc1/switchPrograms/B",
    "type": "switchProgram",
    "setpointProperty": {
        "id": "/heatingCircuits/hc1/temperatureLevels",
        "uri": "http://192.168.1.100/heatingCircuits/hc1/temperatureLevels"
    },
    "maxNbOfSwitchPoints": 14,
    "maxNbOfSwitchPointsPerDay": 2,
    "switchPointTimeRaster": 15,
    "writeable": 1,
    "switchPoints": [
        {
            "dayOfWeek": "Mo",
            "setpoint": "comfort2",
            "time": 360
        },
        {
            "dayOfWeek": "Mo",
            "setpoint": "eco",
            "time": 1380
        },
        {
            "dayOfWeek": "Tu",
            "setpoint": "comfort2",
            "time": 360
        },
        {
            "dayOfWeek": "Tu",
            "setpoint": "eco",
            "time": 1380
        },
        {
            "dayOfWeek": "We",
            "setpoint": "comfort2",
            "time": 360
        },
        {
            "dayOfWeek": "We",
            "setpoint": "eco",
            "time": 1380
        },
        {
            "dayOfWeek": "Th",
            "setpoint": "comfort2",
            "time": 360
        },
        {
            "dayOfWeek": "Th",
            "setpoint": "eco",
            "time": 1380
        },
        {
            "dayOfWeek": "Fr",
            "setpoint": "comfort2",
            "time": 360
        },
        {
            "dayOfWeek": "Fr",
            "setpoint": "eco",
            "time": 1380
        },
        {
            "dayOfWeek": "Sa",
            "setpoint": "comfort2",
            "time": 480
        },
        {
            "dayOfWeek": "Sa",
            "setpoint": "eco",
            "time": 1380
        },
        {
            "dayOfWeek": "Su",
            "setpoint": "comfort2",
            "time": 480
        },
        {
            "dayOfWeek": "Su",
            "setpoint": "eco",
            "time": 1380
        }
    ]
}

GET /heatingCircuits/hc1/pumpModulation

{
    "id": "/heatingCircuits/hc1/pumpModulation",
    "type": "floatValue",
    "writeable": 0,
    "recordable": 0,
    "value": 1,
    "unitOfMeasure": "%"
}

GET /heatingCircuits/hc1/suWiThreshold

{
    "id": "/heatingCircuits/hc1/suWiThreshold",
    "type": "floatValue",
    "writeable": 1,
    "recordable": 0,
    "value": 17,
    "unitOfMeasure": "C",
    "minValue": 10,
    "maxValue": 30
}

GET /heatingCircuits/hc1/designTemp

n/a

GET /heatingCircuits/hc1/roomTempOffset

n/a

GET /heatingCircuits/hc1/heatCurveMax

n/a

GET /heatingCircuits/hc1/controlType

n/a

GET /heatingCircuits/hc1/roomInfluence

n/a

GET /heatingCircuits/hc1/fastHeatupFactor

{
    "id": "/heatingCircuits/hc1/fastHeatupFactor",
    "type": "floatValue",
    "writeable": 1,
    "recordable": 0,
    "value": 0,
    "unitOfMeasure": "%",
    "minValue": 1,
    "maxValue": 100,
    "state": [
        {
            "off": 0
        }
    ]
}

GET /heatingCircuits/hc1/suWiSwitchMode

{
    "id": "/heatingCircuits/hc1/suWiSwitchMode",
    "type": "stringValue",
    "writeable": 1,
    "recordable": 0,
    "value": "automatic",
    "allowedValues": [
        "off",
        "automatic",
        "forced"
    ]
}

GET /heatingCircuits/hc1/currentOpModeInfo

n/a

GET /heatingCircuits/hc1/cooling

{
    "id": "/heatingCircuits/hc1/cooling",
    "type": "refEnum",
    "references": []
}

GET /heatingCircuits/hc1/currentSuWiMode

{
    "id": "/heatingCircuits/hc1/currentSuWiMode",
    "type": "stringValue",
    "writeable": 0,
    "recordable": 0,
    "value": "forced",
    "allowedValues": [
        "off",
        "forced",
        "cooling"
    ]
}

GET /heatingCircuits/hc1/holidayMode/activated

{
    "id": "/heatingCircuits/hc1/holidayMode/activated",
    "type": "stringValue",
    "writeable": 0,
    "recordable": 0,
    "value": "",
    "allowedValues": [
        "",
        "hm1",
        "hm2",
        "hm3",
        "hm4",
        "hm5"
    ]
}

GET /heatingCircuits/hc1/status

{
    "id": "/heatingCircuits/hc1/status",
    "type": "stringValue",
    "writeable": 0,
    "recordable": 0,
    "value": "ACTIVE",
    "allowedValues": [
        "INACTIVE",
        "ACTIVE"
    ]
}