Heating

The heating module allows settings for heating control to be configured.

warp1

Not supported on this hardware!

warp2

Not supported on this hardware!

warp3

Not supported on this hardware!

wem

Not supported on this hardware!

wem2

heating/config

The heating control configuration.

Example

HTTP (curl)

# $HOST e.g. wem2-AbCd

Read

curl http://$HOST/heating/config

{
    "sgr_blocking_type": 0,
    "sgr_extended_type": 0,
    "min_hold_time": 15,
    "meter_slot_grid_power": 1,
    "control_period": 0,
    "extended_logging": false,
    "yield_forecast": true,
    "yield_forecast_threshold": 10,
    "extended": true,
    "extended_hours": 3,
    "blocking": true,
    "blocking_hours": 14,
    "pv_excess_control": true,
    "pv_excess_control_threshold": 1400,
    "p14enwg": false,
    "p14enwg_input": 0,
    "p14enwg_type": 0
}

Write

curl http://$HOST/heating/config -d '{
    "sgr_blocking_type": 0,
    "sgr_extended_type": 0,
    "min_hold_time": 15,
    "meter_slot_grid_power": 1,
    "control_period": 0,
    "extended_logging": false,
    "yield_forecast": true,
    "yield_forecast_threshold": 10,
    "extended": true,
    "extended_hours": 3,
    "blocking": true,
    "blocking_hours": 14,
    "pv_excess_control": true,
    "pv_excess_control_threshold": 1400,
    "p14enwg": false,
    "p14enwg_input": 0,
    "p14enwg_type": 0
}'

MQTT (mosquitto)

# $BROKER e.g. my_mosquitto.localdomain
# $PREFIX e.g. wem2/AbCd

Read

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/heating/config

{
    "sgr_blocking_type": 0,
    "sgr_extended_type": 0,
    "min_hold_time": 15,
    "meter_slot_grid_power": 1,
    "control_period": 0,
    "extended_logging": false,
    "yield_forecast": true,
    "yield_forecast_threshold": 10,
    "extended": true,
    "extended_hours": 3,
    "blocking": true,
    "blocking_hours": 14,
    "pv_excess_control": true,
    "pv_excess_control_threshold": 1400,
    "p14enwg": false,
    "p14enwg_input": 0,
    "p14enwg_type": 0
}

Write

With MQTT on $PREFIX/heating/config_update

mosquitto_pub -h $BROKER -t $PREFIX/heating/config_update -m '{
    "sgr_blocking_type": 0,
    "sgr_extended_type": 0,
    "min_hold_time": 15,
    "meter_slot_grid_power": 1,
    "control_period": 0,
    "extended_logging": false,
    "yield_forecast": true,
    "yield_forecast_threshold": 10,
    "extended": true,
    "extended_hours": 3,
    "blocking": true,
    "blocking_hours": 14,
    "pv_excess_control": true,
    "pv_excess_control_threshold": 1400,
    "p14enwg": false,
    "p14enwg_input": 0,
    "p14enwg_type": 0
}'

Name	Description
sgr_blocking_type int	SG-Ready output 1 configuration (used for blocking operation). 0 - Active when closed 1 - Active when open
sgr_extended_type int	SG-Ready output 2 configuration (used for extended operation). 0 - Active when closed 1 - Active when open
min_hold_time int	Minimum hold time for SG-Ready output 1 and SG-Ready output 2.
meter_slot_grid_power int	Specifies which electricity meter is considered the grid connection meter for control.
control_period int	0 - 24 hours 1 - 12 hours 2 - 8 hours 3 - 6 hours 4 - 4 hours
extended_logging bool	Specifies whether detailed information about control decisions should be recorded in the event log.
yield_forecast bool	Specifies whether the PV yield forecast should be used for heating control.
yield_forecast_threshold int (kWh)	Threshold for the PV yield forecast. When PV yield forecast control is enabled and the forecast exceeds the configured energy, dynamic electricity price control is disabled and only PV excess is used.
extended bool	Specifies whether extended operation control should be enabled.
extended_hours int (h)	Number of (cheapest) hours for which extended operation should be used.
blocking bool	Specifies whether blocking operation control should be enabled.
blocking_hours int (h)	Number of (most expensive) hours for which blocking operation should be used.
pv_excess_control bool	Specifies whether PV excess control should be enabled.
pv_excess_control_threshold int (W)	Threshold for PV excess control. When PV excess control is enabled and PV excess exceeds the configured value, heating is only switched to extended operation when there is PV excess.
p14enwg bool	Specifies whether §14a EnWG control should be enabled.
p14enwg_input int	Specifies which input of the energy manager should be used for shutdown via §14a EnWG. 0 - Input 1 1 - Input 2 1 - Input 3 1 - Input 4
p14enwg_type int	Configuration for the input. 0 - Active when closed 1 - Active when open

heating/state

The heating control state.

Example

HTTP (curl)

# $HOST e.g. wem2-AbCd

Read

curl http://$HOST/heating/state

MQTT (mosquitto)

# $BROKER e.g. my_mosquitto.localdomain
# $PREFIX e.g. wem2/AbCd

Read

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/heating/state

{
    "sgr_blocking": true,
    "sgr_extended": false,
    "p14enwg": false,
    "next_update": 28899735
}

Name	Description
sgr_blocking bool	Indicates whether blocking operation is active.
sgr_extended bool	Indicates whether extended operation is active.
p14enwg bool	Indicates whether blocking operation is active due to §14a EnWG.
next_update int	A Unix timestamp in minutes indicating when the heating control will perform the next update.

any

heating/config

The heating control configuration.

Example

HTTP (curl)

# $HOST e.g. warp-AbCd

Read

curl http://$HOST/heating/config

{
    "sgr_blocking_type": 0,
    "sgr_extended_type": 0,
    "min_hold_time": 15,
    "meter_slot_grid_power": 1,
    "control_period": 0,
    "extended_logging": false,
    "yield_forecast": true,
    "yield_forecast_threshold": 10,
    "extended": true,
    "extended_hours": 3,
    "blocking": true,
    "blocking_hours": 14,
    "pv_excess_control": true,
    "pv_excess_control_threshold": 1400,
    "p14enwg": false,
    "p14enwg_input": 0,
    "p14enwg_type": 0
}

Write

curl http://$HOST/heating/config -d '{
    "sgr_blocking_type": 0,
    "sgr_extended_type": 0,
    "min_hold_time": 15,
    "meter_slot_grid_power": 1,
    "control_period": 0,
    "extended_logging": false,
    "yield_forecast": true,
    "yield_forecast_threshold": 10,
    "extended": true,
    "extended_hours": 3,
    "blocking": true,
    "blocking_hours": 14,
    "pv_excess_control": true,
    "pv_excess_control_threshold": 1400,
    "p14enwg": false,
    "p14enwg_input": 0,
    "p14enwg_type": 0
}'

MQTT (mosquitto)

# $BROKER e.g. my_mosquitto.localdomain
# $PREFIX e.g. warp/AbCd

Read

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/heating/config

{
    "sgr_blocking_type": 0,
    "sgr_extended_type": 0,
    "min_hold_time": 15,
    "meter_slot_grid_power": 1,
    "control_period": 0,
    "extended_logging": false,
    "yield_forecast": true,
    "yield_forecast_threshold": 10,
    "extended": true,
    "extended_hours": 3,
    "blocking": true,
    "blocking_hours": 14,
    "pv_excess_control": true,
    "pv_excess_control_threshold": 1400,
    "p14enwg": false,
    "p14enwg_input": 0,
    "p14enwg_type": 0
}

Write

With MQTT on $PREFIX/heating/config_update

mosquitto_pub -h $BROKER -t $PREFIX/heating/config_update -m '{
    "sgr_blocking_type": 0,
    "sgr_extended_type": 0,
    "min_hold_time": 15,
    "meter_slot_grid_power": 1,
    "control_period": 0,
    "extended_logging": false,
    "yield_forecast": true,
    "yield_forecast_threshold": 10,
    "extended": true,
    "extended_hours": 3,
    "blocking": true,
    "blocking_hours": 14,
    "pv_excess_control": true,
    "pv_excess_control_threshold": 1400,
    "p14enwg": false,
    "p14enwg_input": 0,
    "p14enwg_type": 0
}'

Name	Description
sgr_blocking_type int	SG-Ready output 1 configuration (used for blocking operation). 0 - Active when closed 1 - Active when open
sgr_extended_type int	SG-Ready output 2 configuration (used for extended operation). 0 - Active when closed 1 - Active when open
min_hold_time int	Minimum hold time for SG-Ready output 1 and SG-Ready output 2.
meter_slot_grid_power int	Specifies which electricity meter is considered the grid connection meter for control.
control_period int	0 - 24 hours 1 - 12 hours 2 - 8 hours 3 - 6 hours 4 - 4 hours
extended_logging bool	Specifies whether detailed information about control decisions should be recorded in the event log.
yield_forecast bool	Specifies whether the PV yield forecast should be used for heating control.
yield_forecast_threshold int (kWh)	Threshold for the PV yield forecast. When PV yield forecast control is enabled and the forecast exceeds the configured energy, dynamic electricity price control is disabled and only PV excess is used.
extended bool	Specifies whether extended operation control should be enabled.
extended_hours int (h)	Number of (cheapest) hours for which extended operation should be used.
blocking bool	Specifies whether blocking operation control should be enabled.
blocking_hours int (h)	Number of (most expensive) hours for which blocking operation should be used.
pv_excess_control bool	Specifies whether PV excess control should be enabled.
pv_excess_control_threshold int (W)	Threshold for PV excess control. When PV excess control is enabled and PV excess exceeds the configured value, heating is only switched to extended operation when there is PV excess.
p14enwg bool	Specifies whether §14a EnWG control should be enabled.
p14enwg_input int	Specifies which input of the energy manager should be used for shutdown via §14a EnWG. 0 - Input 1 1 - Input 2 1 - Input 3 1 - Input 4
p14enwg_type int	Configuration for the input. 0 - Active when closed 1 - Active when open

heating/state

The heating control state.

Example

HTTP (curl)

# $HOST e.g. warp-AbCd

Read

curl http://$HOST/heating/state

MQTT (mosquitto)

# $BROKER e.g. my_mosquitto.localdomain
# $PREFIX e.g. warp/AbCd

Read

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/heating/state

{
    "sgr_blocking": true,
    "sgr_extended": false,
    "p14enwg": false,
    "next_update": 28899735
}

Name	Description
sgr_blocking bool	Indicates whether blocking operation is active.
sgr_extended bool	Indicates whether extended operation is active.
p14enwg bool	Indicates whether blocking operation is active due to §14a EnWG.
next_update int	A Unix timestamp in minutes indicating when the heating control will perform the next update.