Constants

The module keba_keenergy_api.constants defines the endpoints and their values, e.g. for read_data() and write_data(). Paths are relative to PAYLOAD_PREFIX (APPL.CtrlAppl), %s is replaced by the zero-based device index.

Endpoints

System

The system endpoint settings.

Member	Type	Writable	Values	Path
BUFFER_TANK_NUMBERS	int	no		sParam.options.systemNumberOfBuffers
HOT_WATER_TANK_NUMBERS	int	no		sParam.options.systemNumberOfHotWaterTanks
HEAT_PUMP_NUMBERS	int	no		sParam.options.systemNumberOfHeatPumps
HEAT_CIRCUIT_NUMBERS	int	no		sParam.options.systemNumberOfHeatingCircuits
SOLAR_CIRCUIT_NUMBERS	int	no		sParam.options.systemNumberOfSolarCircuits
EXTERNAL_HEAT_SOURCE_NUMBERS	int	no		sParam.options.systemNumberOfExtHeatSources
SWITCH_VALVE_NUMBERS	int	no		sParam.options.systemNumberOfSwitchValves
HAS_PHOTOVOLTAICS	str	no	BoolEnum	sParam.options.hasPhotovoltaics
HAS_OUTDOOR_TEMPERATURE	str	no	BoolEnum	sParam.options.hasOutdoorTemp
OPERATING_MODE	int	yes	SystemOperatingMode	sParam.param.operatingMode
OUTDOOR_TEMPERATURE	float	no		sParam.outdoorTemp.values.actValue
CPU_USAGE	float	no		sProcData.globalCpuTimePercent
WEBVIEW_CPU_USAGE	float	no		sProcData.processStatus[0].cpuTimePercent
WEBSERVER_CPU_USAGE	float	no		sProcData.processStatus[1].cpuTimePercent
CONTROL_CPU_USAGE	float	no		sProcData.processStatus[2].cpuTimePercent
RAM_USAGE	int	no		sProcData.RAMstatus.tmpfs
FREE_RAM	int	no		sProcData.totFreeRAM

BufferTank

The buffer tank endpoint settings.

Member	Type	Writable	Values	Path
NAME	str	yes		sParam.bufferTank[%s].param.name
CURRENT_TOP_TEMPERATURE	float	no		sParam.bufferTank[%s].topTemp.values.actValue
CURRENT_BOTTOM_TEMPERATURE	float	no		sParam.bufferTank[%s].midTemp.values.actValue
OPERATING_MODE	int	yes	BufferTankOperatingMode	sParam.bufferTank[%s].param.operatingMode
STANDBY_TEMPERATURE	float	yes		sParam.bufferTank[%s].param.backupTemp
TARGET_TEMPERATURE	float	no		sParam.bufferTank[%s].values.setTemp
EXCESS_ENERGY_TARGET_TEMPERATURE	float	yes		sParam.bufferTank[%s].param.excessEnergyTemp.value
EXCESS_ENERGY_TARGET_TEMPERATURE_HYSTERESIS	float	yes		sParam.bufferTank[%s].param.excessEnergyTemp.hyst
OUTDOOR_TEMPERATURE_EXCESS_ENERGY_LIMIT	float	yes		sParam.bufferTank[%s].param.thresholdOutTempExcessEnergy.value
USE_EXCESS_ENERGY	str	yes	BoolEnum	sParam.bufferTank[%s].param.useExcessEnergy
EXCESS_ENERGY_MODE	int	no	BufferTankExcessEnergyMode	sParam.bufferTank[%s].values.useExcessEnergy
HEAT_REQUEST	str	no	BoolEnum	sParam.bufferTank[%s].values.heatRequestTop
COOL_REQUEST	str	no	BoolEnum	sParam.bufferTank[%s].values.coolRequestBot

HotWaterTank

The hot water tank endpoint settings.

Member	Type	Writable	Values	Path
NAME	str	yes		sParam.hotWaterTank[%s].param.name
CURRENT_TEMPERATURE	float	no		sParam.hotWaterTank[%s].topTemp.values.actValue
OPERATING_MODE	int	yes	HotWaterTankOperatingMode	sParam.hotWaterTank[%s].param.operatingMode
STANDBY_TEMPERATURE	float	yes		sParam.hotWaterTank[%s].param.reducedSetTempMax.value
TARGET_TEMPERATURE	float	yes		sParam.hotWaterTank[%s].param.normalSetTempMax.value
EXCESS_ENERGY_TARGET_TEMPERATURE	float	yes		sParam.hotWaterTank[%s].param.excessEnergyTemp.value
EXCESS_ENERGY_TARGET_TEMPERATURE_HYSTERESIS	float	yes		sParam.hotWaterTank[%s].param.excessEnergyTemp.hyst
USE_EXCESS_ENERGY	str	yes	BoolEnum	sParam.hotWaterTank[%s].param.useExcessEnergy
EXCESS_ENERGY_MODE	int	no	HotWaterTankExcessEnergyMode	sParam.hotWaterTank[%s].values.useExcessEnergy
HEAT_REQUEST	str	no	BoolEnum	sParam.hotWaterTank[%s].values.heatRequestTop
HAS_FRESH_WATER_MODULE	str	no	BoolEnum	sParam.options.hotWaterTank[%s].hasFreshWaterModule
FRESH_WATER_FLOW	str	no	BoolEnum	sParam.hotWaterTank[%s].FreshWater.freshWaterFlow.values.actValue
FRESH_WATER_MODULE_TEMPERATURE	float	no		sParam.hotWaterTank[%s].FreshWater.freshWaterTemp.values.actValue
FRESH_WATER_MODULE_PUMP_SPEED	float	no		sParam.hotWaterTank[%s].FreshWater.freshWaterPump.values.setValueScaled
CIRCULATION_RETURN_TEMPERATURE	float	no		sParam.hotWaterTank[%s].circTemp.values.actValue
CIRCULATION_PUMP_STATE	str	no	BoolEnum	sParam.hotWaterTank[%s].circPump.pump.values.setValueB

HeatPump

The heat pump endpoint settings.

Member	Type	Writable	Values	Path
NAME	str	yes		sParam.heatpump[%s].param.name
STATE	int	no	HeatPumpState	sParam.heatpump[%s].values.heatpumpState
SUBSTATE	int	no	HeatPumpSubState	sParam.heatpump[%s].values.heatpumpSubState
OPERATING_MODE	int	yes	HeatPumpOperatingMode	sParam.heatpump[%s].param.operatingMode
COMPRESSOR_USE_NIGHT_SPEED	str	yes	BoolEnum	sParam.heatpump[%s].HeatPumpPowerCtrl.param.useDayNightSpeed
COMPRESSOR_NIGHT_SPEED	float	yes		sParam.heatpump[%s].HeatPumpPowerCtrl.param.maxPowerScaledNight
CIRCULATION_PUMP_SPEED	float	no		sParam.heatpump[%s].CircPump.values.setValueScaled
SOURCE_PUMP_SPEED	float	no		sParam.heatpump[%s].Source.values.setValueScaled
FLOW_TEMPERATURE	float	no		sParam.heatpump[%s].TempHeatFlow.values.actValue
RETURN_FLOW_TEMPERATURE	float	no		sParam.heatpump[%s].TempHeatReflux.values.actValue
SOURCE_INPUT_TEMPERATURE	float	no		sParam.heatpump[%s].TempSourceIn.values.actValue
SOURCE_OUTPUT_TEMPERATURE	float	no		sParam.heatpump[%s].TempSourceOut.values.actValue
COMPRESSOR_INPUT_TEMPERATURE	float	no		sParam.heatpump[%s].TempCompressorIn.values.actValue
COMPRESSOR_OUTPUT_TEMPERATURE	float	no		sParam.heatpump[%s].TempCompressorOut.values.actValue
COMPRESSOR	float	no		sParam.heatpump[%s].Compressor.values.setValueScaled
CONDENSER_TEMPERATURE	float	no		sParam.heatpump[%s].OverHeatCtrl.values.tempCond
VAPORIZER_TEMPERATURE	float	no		sParam.heatpump[%s].OverHeatCtrl.values.tempVap
TARGET_OVERHEATING	float	no		sParam.heatpump[%s].OverHeatCtrl.values.setOH
CURRENT_OVERHEATING	float	no		sParam.heatpump[%s].OverHeatCtrl.values.actOH
EXPANSION_VALVE_POSITION	int	no		sParam.heatpump[%s].OverHeatCtrl.values.stepperPos
HIGH_PRESSURE	float	no		sParam.heatpump[%s].HighPressure.values.actValue
LOW_PRESSURE	float	no		sParam.heatpump[%s].LowPressure.values.actValue
HEAT_REQUEST	str	no	BoolEnum	sParam.heatpump[%s].values.request
CONSUMING_EXCESS_ENERGY	str	no	BoolEnum	sParam.heatpump[%s].values.consumingExcessEnergy
EXCESS_ENERGY_OPERATING_TIME	int	no		sParam.heatpump[%s].operationalDataExcessEnergy.operationalTimeS
EXCESS_ENERGY_MAX_RUNTIME	int	no		sParam.heatpump[%s].operationalDataExcessEnergy.maxRunTimeS
EXCESS_ENERGY_ACTIVATION_COUNTER	int	no		sParam.heatpump[%s].operationalDataExcessEnergy.activationCounter
HEATING_POWER	float	no		sParam.heatpump[%s].HeatMeter.values.power
HEATING_MASS_FLOW_RATE	float	no		sParam.heatpump[%s].HeatMeter.values.massFlow
COOLING_MASS_FLOW_RATE	float	no		sParam.heatpump[%s].CoolMeter.values.massFlow
HOT_WATER_POWER	float	no		sParam.heatpump[%s].HotWaterMeter.values.power
HOT_WATER_MASS_FLOW_RATE	float	no		sParam.heatpump[%s].HotWaterMeter.values.massFlow
COMPRESSOR_POWER	float	no		sParam.heatpump[%s].ElectricEnergyMeter.values.power
COP	float	no		sParam.heatpump[%s].values.COP
HEATING_ENERGY	float	no		sStatisticalData.heatpump[%s].consumption.heating.energy
HEATING_ENERGY_CONSUMPTION	float	no		sStatisticalData.heatpump[%s].consumption.heating.electricalenergy
HEATING_SPF	float	no		sStatisticalData.heatpump[%s].EnergyEfficiencyRatioHeat
COOLING_ENERGY	float	no		sStatisticalData.heatpump[%s].consumption.cooling.energy
COOLING_ENERGY_CONSUMPTION	float	no		sStatisticalData.heatpump[%s].consumption.cooling.electricalenergy
COOLING_SPF	float	no		sStatisticalData.heatpump[%s].EnergyEfficiencyRatioCool
HOT_WATER_ENERGY	float	no		sStatisticalData.heatpump[%s].consumption.domHotWater.energy
HOT_WATER_ENERGY_CONSUMPTION	float	no		sStatisticalData.heatpump[%s].consumption.domHotWater.electricalenergy
HOT_WATER_SPF	float	no		sStatisticalData.heatpump[%s].EnergyEfficiencyRatioDomHotWater
TOTAL_THERMAL_ENERGY	float	no		sStatisticalData.heatpump[%s].consumption.energy
TOTAL_ENERGY_CONSUMPTION	float	no		sStatisticalData.heatpump[%s].consumption.electricalenergy
EXCESS_ENERGY_CONSUMPTION	float	no		sStatisticalData.heatpump[%s].consumption.consumedExcessEnergy
HEATING_EXCESS_ENERGY_CONSUMPTION	float	no		sStatisticalData.heatpump[%s].consumption.heating.consumedExcessEnergy
COOLING_EXCESS_ENERGY_CONSUMPTION	float	no		sStatisticalData.heatpump[%s].consumption.cooling.consumedExcessEnergy
HOT_WATER_EXCESS_ENERGY_CONSUMPTION	float	no		sStatisticalData.heatpump[%s].consumption.domHotWater.consumedExcessEnergy
TOTAL_SPF	float	no		sStatisticalData.heatpump[%s].EnergyEfficiencyRatio
HAS_ACTIVE_COOLING	str	no	BoolEnum	sParam.options.heatpump[%s].hasActiveCooling
HAS_PASSIVE_COOLING	str	no	BoolEnum	sParam.options.heatpump[%s].hasPassiveCooling
OPERATING_TIME	int	no		sParam.heatpump[%s].operationalData.operationalTimeS
MAX_RUNTIME	int	no		sParam.heatpump[%s].operationalData.maxRunTimeS
ACTIVATION_COUNTER	int	no		sParam.heatpump[%s].operationalData.activationCounter
HAS_COMPRESSOR_FAILURE	str	no	BoolEnum	sParam.heatpump[%s].FailureCompressor.values.actValue
HAS_SOURCE_FAILURE	str	no	BoolEnum	sParam.heatpump[%s].FailureSource.values.actValue
HAS_SOURCE_ACTUATOR_FAILURE	str	no	BoolEnum	sParam.heatpump[%s].FailureActuatorSource.values.actValue
HAS_THREE_PHASE_FAILURE	str	no	BoolEnum	sParam.heatpump[%s].FailureThreePhase.values.actValue
HAS_SOURCE_PRESSURE_FAILURE	str	no	BoolEnum	sParam.heatpump[%s].FailureSrcPressure.values.actValue
HAS_VFD_FAILURE	str	no	BoolEnum	sParam.heatpump[%s].FailureVFD.values.actValue
ELECTRIC_ENERGY_METER_TYPE	int	no		sParam.options.heatpump[%s].ElectricEnergyMeter.type
HEAT_METER_TYPE	int	no		sParam.options.heatpump[%s].HeatMeter.type
COOL_METER_TYPE	int	no		sParam.options.heatpump[%s].CoolMeter.type
HOT_WATER_METER_TYPE	int	no		sParam.options.heatpump[%s].HotWaterMeter.type

HeatCircuit

The heat circuit endpoint settings.

Member	Type	Writable	Values	Path
NAME	str	yes		sParam.heatCircuit[%s].param.name
MODE	int	no	HeatCircuitMode	sParam.options.heatCircuit[%s].type
HAS_ROOM_TEMPERATURE	str	no	BoolEnum	sParam.options.heatCircuit[%s].hasRoomTemp
ROOM_TEMPERATURE	float	no		sParam.heatCircuit[%s].tempRoom.values.actValue
HAS_ROOM_HUMIDITY	str	no	BoolEnum	sParam.options.heatCircuit[%s].hasRoomHumidity
ROOM_HUMIDITY	float	no		sParam.heatCircuit[%s].humidityRoom.values.actValue
DEW_POINT	float	no		sParam.heatCircuit[%s].dewPoint.values.actValue
FLOW_TEMPERATURE_SETPOINT	float	no		sParam.heatCircuit[%s].values.flowSetTemp
HAS_MIXER	str	no	BoolEnum	sParam.options.heatCircuit[%s].hasMixer
MIXER_FLOW_TEMPERATURE	float	no		sParam.heatCircuit[%s].heatCircuitMixer.flowTemp.values.actValue
MIXER_RETURN_FLOW_TEMPERATURE	float	no		sParam.heatCircuit[%s].heatCircuitMixer.refluxTemp.values.actValue
MIXER_POSITION	float	no	MixerSwitchValvePosition	sParam.heatCircuit[%s].heatCircuitMixer.mixer.values.setValueScaled
PUMP_STATE	str	no	BoolEnum	sParam.heatCircuit[%s].pump.values.setValueB
HAS_RETURN_FLOW_TEMPERATURE	str	no	BoolEnum	sParam.options.heatCircuit[%s].hasRefluxTemp
RETURN_FLOW_TEMPERATURE	float	no		sParam.heatCircuit[%s].tempReflux.values.actValue
TARGET_TEMPERATURE	float	no		sParam.heatCircuit[%s].values.setValue
USE_EXCESS_ENERGY	str	yes	BoolEnum	sParam.heatCircuit[%s].param.excessEnergy.useExcessEnergy
EXCESS_ENERGY_MODE	int	no	HeatCircuitExcessEnergyMode	sParam.heatCircuit[%s].values.useExcessEnergy
EXCESS_ENERGY_TARGET_TEMPERATURE	float	yes		sParam.heatCircuit[%s].param.excessEnergyTemp.value
EXCESS_ENERGY_TARGET_TEMPERATURE_HYSTERESIS	float	yes		sParam.heatCircuit[%s].param.excessEnergyTemp.hyst
EXCESS_ENERGY_TARGET_COOLING_TEMPERATURE	float	yes		sParam.heatCircuit[%s].param.excessEnergyTempCool.value
EXCESS_ENERGY_TARGET_COOLING_TEMPERATURE_HYSTERESIS	float	yes		sParam.heatCircuit[%s].param.excessEnergyTempCool.hyst
SELECTED_TARGET_TEMPERATURE	float	no		sParam.heatCircuit[%s].values.selectedSetTemp
TARGET_TEMPERATURE_DAY	float	yes		sParam.heatCircuit[%s].param.normalSetTemp
TARGET_COOLING_TEMPERATURE_DAY	float	yes		sParam.heatCircuit[%s].param.normalCoolSetTemp
HEATING_LIMIT_DAY	float	yes		sParam.heatCircuit[%s].param.thresholdDayTemp.value
COOLING_LIMIT_DAY	float	yes		sParam.heatCircuit[%s].param.thresholdDayCoolTemp.value
EXCESS_ENERGY_HEATING_LIMIT_DAY	float	yes		sParam.heatCircuit[%s].param.excessEnergy.thresholdDayTemp
EXCESS_ENERGY_COOLING_LIMIT_DAY	float	yes		sParam.heatCircuit[%s].param.excessEnergy.thresholdDayCoolTemp
TARGET_TEMPERATURE_NIGHT	float	yes		sParam.heatCircuit[%s].param.reducedSetTemp
TARGET_COOLING_TEMPERATURE_NIGHT	float	yes		sParam.heatCircuit[%s].param.reducedCoolSetTemp
HEATING_LIMIT_NIGHT	float	yes		sParam.heatCircuit[%s].param.thresholdNightTemp.value
COOLING_LIMIT_NIGHT	float	yes		sParam.heatCircuit[%s].param.thresholdNightCoolTemp.value
EXCESS_ENERGY_HEATING_LIMIT_NIGHT	float	yes		sParam.heatCircuit[%s].param.excessEnergy.thresholdNightTemp
EXCESS_ENERGY_COOLING_LIMIT_NIGHT	float	yes		sParam.heatCircuit[%s].param.excessEnergy.thresholdNightCoolTemp
TARGET_TEMPERATURE_AWAY	float	yes		sParam.heatCircuit[%s].param.holidaySetTemp
TARGET_TEMPERATURE_OFFSET	float	yes		sParam.heatCircuit[%s].param.offsetRoomTemp
OPERATING_MODE	int	yes	HeatCircuitOperatingMode	sParam.heatCircuit[%s].param.operatingMode
HEAT_REQUEST	int	no	HeatCircuitHeatRequest	sParam.heatCircuit[%s].values.heatRequest
COOL_REQUEST	int	no	HeatCircuitCoolRequest	sParam.heatCircuit[%s].values.coolRequest
AWAY_START_DATE	int	yes		sParam.heatCircuit[%s].param.holiday.start
AWAY_END_DATE	int	yes		sParam.heatCircuit[%s].param.holiday.stop
HEATING_CURVE_OFFSET	float	yes		sParam.heatCircuit[%s].param.heatCurveOffset
COOLING_CURVE_OFFSET	float	yes		sParam.heatCircuit[%s].param.coolCurveOffset
HEATING_CURVE_SLOPE	float	yes		sParam.heatCircuit[%s].param.heatCurveGradient
COOLING_CURVE_SLOPE	float	yes		sParam.heatCircuit[%s].param.coolCurveGradient
USE_HEATING_CURVE	str	yes	BoolEnum	sParam.heatCircuit[%s].param.enableHeatCurveLinTab
HEATING_CURVE	str	yes		sParam.heatCircuit[%s].param.linTab.fileName
COOLING_CURVE	str	yes		sParam.heatCircuit[%s].param.coollinTab.fileName
HAS_PUMP	str	no	BoolEnum	sParam.options.heatCircuit[%s].hasPump
HAS_VAR_SPEED_PUMP	str	no	BoolEnum	sParam.options.heatCircuit[%s].hasVarSpeedPump
PUMP_SPEED	float	no		sParam.heatCircuit[%s].pumpAO.values.setValueScaled

LineTablePool

Pool of heating curve points.

This is not a real section. Read and write only with client.heat_circuit.get_heating_curve_points() and client.heat_circuit.set_heating_curve_points().

Member	Type	Writable	Values	Path
HEATING_CURVE_NAME	str	no		sParam.linTabPool[%s].name
HEATING_CURVE_POINTS	int	yes		sParam.linTabPool[%s].noOfPoints
HEATING_CURVE_POINT_X	float	yes		sParam.linTabPool[%s].points[%s].x
HEATING_CURVE_POINT_Y	float	yes		sParam.linTabPool[%s].points[%s].y
SAVE_HEATING_CURVE	str	yes		sParam.linTabPool[%s].verCnt

SolarCircuit

The solar circuit endpoint settings.

Member	Type	Writable	Values	Path
NAME	str	yes		sParam.solarCircuit[%s].param.name
OPERATING_MODE	int	yes	BoolEnum	sParam.solarCircuit[%s].param.operatingMode
SOURCE_TEMPERATURE	float	no		sParam.solarCircuit[%s].collectorTemp.values.actValue
PUMP_1	float	no		sParam.solarCircuit[%s].values.pump1
PUMP_2	float	no		sParam.solarCircuit[%s].values.pump2
CURRENT_TEMPERATURE	float	no		sParam.genericHeat[%s].referenceTemp.values.actValue
TARGET_TEMPERATURE	float	yes		sParam.genericHeat[%s].param.setTempMax.value
HEAT_REQUEST	str	no	BoolEnum	sParam.genericHeat[%s].values.heatRequest
HEATING_ENERGY	float	no		sParam.solarCircuit[%s].heatMeter.values.accumulatedHeat
DAILY_ENERGY	float	no		sParam.solarCircuit[%s].heatMeter.values.heatDay
ACTUAL_POWER	float	no		sParam.solarCircuit[%s].heatMeter.values.power
PRIORITY_1_BEFORE_2	str	yes	BoolEnum	sParam.hmiRetainData.consumer1PrioritySolar[%s]

ExternalHeatSource

External heat source API endpoints.

Member	Type	Writable	Values	Path
OPERATING_MODE	int	yes	BoolEnum	sParam.extHeatSource[%s].param.operatingMode
TARGET_TEMPERATURE	float	no		sParam.extHeatSource[%s].values.setTemp
HEAT_REQUEST	str	no	BoolEnum	sParam.extHeatSource[%s].DO.values.setValueB
OPERATING_TIME	int	no		sParam.extHeatSource[%s].DO.operationalData.operationalTimeS
MAX_RUNTIME	int	no		sParam.extHeatSource[%s].DO.operationalData.maxRunTimeS
ACTIVATION_COUNTER	int	no		sParam.extHeatSource[%s].DO.operationalData.activationCounter
CONSUMING_EXCESS_ENERGY	str	no	BoolEnum	sParam.extHeatSource[%s].values.consumingExcessEnergy
EXCESS_ENERGY_OPERATING_TIME	int	no		sParam.extHeatSource[%s].operationalDataExcessEnergy.operationalTimeS
EXCESS_ENERGY_MAX_RUNTIME	int	no		sParam.extHeatSource[%s].operationalDataExcessEnergy.maxRunTimeS
EXCESS_ENERGY_ACTIVATION_COUNTER	int	no		sParam.extHeatSource[%s].operationalDataExcessEnergy.activationCounter
USE_EXCESS_ENERGY	str	yes	BoolEnum	sParam.extHeatSource[%s].param.supportExcessEnergy
MIN_RUNTIME_EXCESS_ENERGY	int	yes		sParam.extHeatSource[%s].param.minRunTimeExcessEnergy

SwitchValve

Switch valve API endpoints.

Member	Type	Writable	Values	Path
POSITION	int	no	SwitchValvePosition	sParam.switchvalve[%s].values.actPosition

PassiveCooling

Passive cooling API endpoints.

Member	Type	Writable	Values	Path
TEMPERATURE	float	no		sParam.passivecooling[%s].TempCoolPassive.values.actValue
SWITCH_VALVE_POSITION	int	no	SwitchValvePosition	sParam.passivecooling[%s].SwitchValvePassiveCool.values.actPosition
CIRCULATION_PUMP_SPEED	float	no		sParam.passivecooling[%s].Pump.values.setValueScaled
MIXER_TARGET_TEMPERATURE	float	no		sParam.passivecooling[%s].Mixer.values.setValue
MIXER_FLOW_TEMPERATURE	float	no		sParam.passivecooling[%s].Mixer.flowTemp.values.actValue
MIXER_POSITION	float	no	MixerSwitchValvePosition	sParam.passivecooling[%s].Mixer.mixer.values.setValueScaled

Photovoltaics

Photovoltaics API endpoints.

Member	Type	Writable	Values	Path
EXCESS_ENERGY_ACTIVE	str	no	BoolEnum	sParam.photovoltaics.values.excessEnergyActive
EXCESS_POWER	float	no		sParam.photovoltaics.ElectricEnergyMeter.values.power
DAILY_ENERGY	float	no		sParam.photovoltaics.ElectricEnergyMeter.values.heatDay
TOTAL_ENERGY	float	no		sParam.photovoltaics.ElectricEnergyMeter.values.accumulatedHeat

Values

Enums of the readable names, returned with human_readable=True and accepted by the setters.

BoolEnum

Boolean values (OFF / ON).

Member	Value
OFF	0
ON	1

SystemOperatingMode

Available system operating modes.

Member	Value
SETUP	-1
STANDBY	0
SUMMER	1
AUTO_HEAT	2
AUTO_COOL	3
AUTO	4

BufferTankOperatingMode

Available buffer tank operating modes.

Member	Value
OFF	0
ON	1
HEAT_UP	2

BufferTankExcessEnergyMode

Available buffer tank excess energy modes.

Member	Value
OFF	0
HEATING	1
COOLING	2

HotWaterTankOperatingMode

Available hot water tank operating modes.

Member	Value
OFF	0
AUTO	1
ON	2
HEAT_UP	3

HotWaterTankExcessEnergyMode

Available hot water tank excess energy modes.

Member	Value
OFF	0
HEATING	1
COOLING	2

HeatPumpState

Available heat pump states.

Member	Value
STANDBY	0
FLOW	1
AUTO_HEAT	2
DEFROST	3
AUTO_COOL	4
INFLOW	5
PUMP_DOWN	6
SHUTDOWN	7
ERROR	8

HeatPumpSubState

Available heat pump substates. Some substates have more than one value.

Member	Value
NONE	0
OIL_PREHEATING	1
PUMP_PRE_RUN	(2, 3)
RANDOM_DELAY	4
PRESSURE_EQUALIZATION	(5, 21, 22)
DEFROST_PRE_FLOW	6
DEFROST_MONITORING	7
SNOW_DETECTION	8
FLUSHING	9
DEFROST_INITIALIZATION	10
PREHEAT_FLOW	11
DEFROST	12
DRIP	(13, 25)
DEFROST_END	14
OPEN	(15, 16)
COMPRESSOR_POST_RUN	17
PUMP_POST_RUN	18
LUBRICATION_PULSE	19
REDUCED_SPEED	(20, 26)
COMPRESSOR_DELAY	23
DEFROST_VENTING	24
SWITCH_HEATING_COOLING	27
WAIT_FOR_COMPRESSOR	(28, 33)
COMPRESSOR_STOP	29
BIVALENT_LOCK	30
LOCKED	31
RETURN_FLOW_OFF	32
MIXER_OPEN	34
ZONE_VALVE	35
ELECTRIC_DEFROST	36
COUNTERFLOW_VALVE	37

HeatPumpOperatingMode

Available heat pump operating modes.

Member	Value
OFF	0
ON	1
BACKUP	2

HeatCircuitMode

Available heat circuit modes.

Member	Value
HEATING	0
COOLING	1
HEATING_AND_COOLING	2
HEATING_AND_ACTIVE_COOLING	3

HeatCircuitExcessEnergyMode

Available heat circuit excess energy modes.

Member	Value
OFF	0
HEATING	1
COOLING	2

HeatCircuitOperatingMode

Available heat circuit operating modes.

Member	Value
OFF	0
AUTO	1
DAY	2
NIGHT	3
HOLIDAY	4
PARTY	5
EXTERNAL	8
ROOM_CONTROL	9

SolarCircuitPriority

Available solar circuit consumer priorities.

Member	Value
LOW	14
HIGH	15

HeatCircuitHeatRequest

Available heat circuit heat request states.

Member	Value
OFF	0
ON	1
FLOW_OFF	2
TEMPORARY_OFF	3
ROOM_OFF	4
OUTDOOR_OFF	5
INFLOW_OFF	6

HeatCircuitCoolRequest

Available heat circuit cool request states.

Member	Value
OFF	0
ON	1
FLOW_OFF	2
TEMPORARY_OFF	3
ROOM_OFF	4
OUTDOOR_OFF	5
INFLOW_OFF	6

SwitchValvePosition

Available switch valve positions.

Member	Value
NEUTRAL	0
OPEN	1
CLOSED	2

MixerSwitchValvePosition

Available mixer positions.

Member	Value
CLOSED	-1
OFF	0
OPEN	1

Other constants

Name	Value
API_DEFAULT_TIMEOUT	10
MIN_HEATING_CURVE_POINTS	7
MAX_HEATING_CURVE_POINTS	16
PAYLOAD_PREFIX	'APPL.CtrlAppl'
ACT_VALUE_SUFFIX	'.values.actValue'
MESSAGE_ID_SUFFIX	'.state.msgId'

EndpointPath

The endpoint paths.

Member	Value
READ_WRITE_VARS	'/var/readWriteVars'
READ_VAR_CHILDREN	'/var/readVarChildren'
DEVICE_CONTROL	'/deviceControl'
SW_UPDATE	'/swupdate'
DATE_TIME	'/dateTime'

SectionPrefix

Prefixes of the grouped read_data response.

Member	Value
SYSTEM	'system'
BUFFER_TANK	'buffer_tank'
HOT_WATER_TANK	'hot_water_tank'
HEAT_PUMP	'heat_pump'
HEAT_CIRCUIT	'heat_circuit'
SOLAR_CIRCUIT	'solar_circuit'
EXTERNAL_HEAT_SOURCE	'external_heat_source'
SWITCH_VALVE	'switch_valve'
PASSIVE_COOLING	'passive_cooling'
PHOTOVOLTAICS	'photovoltaics'