sensonet and vaillant-ebus charger now possible to use with parameter integrateddevice: true

- Upgrade to package sensonet v0.0.4 and sensonetEbus v0.0.1
- Charger modules sensonet and vaillant-ebus now both support to be used as integrated device or with vehicles
- New SG Ready charger vaillant-via-ebus
- Refactoring of template files for charger modules sensonet, vaillant-ebus and vaillant-via-ebus and their related vehicles
- The charger modules sensonet, vaillant-ebus and vaillant-via-ebus and their related vehicles now work in 'evcc configure'
- Refactoring of the sample yaml files

Author: WulfgarW

README.md

@@ -10,54 +10,51 @@ All other persons should visit github.com/evcc-io/evcc. There you can also find
 - Adds a charger module vaillant-ebus und a vehicle module vaillant-ebus_vehicle to allow PV optimised heating with a Vaillant heat pump
 - The vaillant-ebus module connects to an ebus daemon (https://github.com/john30/ebusd) to get system information from the heat pump and to start/stop quick modes. So to use this evcc extension, an ebus adapter (see https://adapter.ebusd.eu/) and the ebusd (=software) are needed. 
 - The current power consumption of the heat pump is read via ebus, but an external energy meter like Shelly 3EM can be used as well.
-- As the vaillant-ebus charger module supports two different charge modes ('Hotwater Boost' and 'Heating Quick Veto'), small additions were made to the
+- As the vaillant-ebus charger module supports two different charge modes ('Hotwater Boost' and 'Zone Quick Veto'), small additions were made to the
   module loadpoint.go and the vue file Vehicle.vue to display the current charge mode. The usage of these two changes is optional. 
 
 (2) sensonet
-- Adds a charger module sensonet und a vehicle module sensonet_vehicle to allow PV optimised heating with a Vaillant heat pump
+- Adds a charger module sensonet_und a vehicle module sensonet_vehicle to allow PV optimised heating with a Vaillant heat pump
 - The sensonet module connects to the myVaillant portal to get system information from the heat pump and to start/stop quick modes.
-- As the sensonet charger module supports two different charge modes ('Hotwater Boost' and 'Heating Quick Veto'), small additions were made to the
+- As the sensonet charger module supports two different charge modes ('Hotwater Boost' and 'Zone Quick Veto'), small additions were made to the
   module loadpoint.go and the vue file Vehicle.vue to display the current charge mode. The usage of these two changes is optional. 
 
 ## How it works
 (1) vaillant-ebus
-To use this extension a charger section for 'vaillant-ebus' and a vehicle section for 'vaillant-ebus_vehicle' have to be added to evcc.yaml. 
-evcc is able to read the current power consumption of the heat pump via ebusd and to display it in the web interface. Thus no external metering device like Shelly 3EM is necessary. (But if an energy meter like Shelly 3EM is present for the Vaillant heatpump and shall be used, then a meter section has to be added to evcc.yaml as well. The vaillant-ebus charger, the vaillant-ebus_vehicle vehicle and the energy meter have to be combinated as a loadpoint in the yaml file.)
+To use this extension a charger section for 'vaillant-ebus' has to be added to evcc.yaml. You can use vehicles of type vaillant-ebus_vehicle to switch between different PV use strategies without stopping evcc. Or you set the parameter 'integrateddevice: true' for the vaillant-ebus charger and define no vehicles.
 
-The vaillant-ebus charge module initiates a telnet connection to the ebusd which can reside on the same machine or on another machine in the local network. Via 'read' commands, information about the heat pump state is obtained. The vaillant-ebus_vehicle module is used to present some information like SoC (=current temperature) and TargetSoC (=temperature setpoint) to the loadpoint module of evcc.
+The vaillant-ebus charge module initiates a telnet connection to the ebusd which can reside on the same machine or on another machine in the local network. Via 'read' commands, information about the heat pump state is gathered and some of it like SoC (=current temperature), TargetSoC (=temperature setpoint) and current power consumption presented by the evcc web front end.
+As evcc is able to read the current power consumption of the heat pump via ebusd, no external metering device like Shelly 3EM is necessary. (But if an energy meter like Shelly 3EM is present for the Vaillant heatpump and shall be used, then a meter section has to be added to evcc.yaml as well.) 
+The vaillant-ebus charger, the vaillant-ebus_vehicle vehicles and the energy meter have to be combinated as a loadpoint in the yaml file.
 
 If the evcc loadpoint module signals to the vaillant-ebus charger module that a charging session should be started, then the vaillant-ebus module does the following:
    (a) If ('pvusestrategy='hotwater') or (pvusestrategy='hotwater_than_heating' and current hotwater temperature is more than 5°C below the setpoint), then a hotwater boost is initiated via a 'write' request to the ebusd.
-   (b) If ('pvusestrategy='heating') or (pvusestrategy='hotwater_than_heating' and current hotwater temperature is less than 5°C below the setpoint), then
-         a heating zone quick veto is initiated via a 'write' request to the ebusd for the zone given by the heatingzone parameter in the evcc.yaml file (default=0). 
-        The duration of the veto is 30 minutes and the veto_setpoint= normal_temperature_setpoint + heatingtemperatureoffset (default=2).
+   (b) If ('pvusestrategy='heating') or (pvusestrategy='hotwater_than_heating' and current hotwater temperature is less than 5°C below the setpoint), then a heating zone quick veto is initiated via a 'write' request to the ebusd for the zone given by the heatingzone parameter in the evcc.yaml file (default=0). The duration of the veto is 30 minutes and the veto_setpoint= normal_temperature_setpoint + heatingtemperatureoffset (default=2).
 Via the regular 'read' commands, the vaillant-ebus module notices when the hotwater boost or the zone quick veto ends and changes the enabled() status to false to report this to the loadpoint module of evcc.
 If the loadpoint module tells the vaillant-ebus module to stop a charging session, then the vaillant-ebus module ends the hotwater boost or the zone quick veto via a 'write' request to the ebusd.
 
 (2) sensonet
-To use this extension a charger section for 'sensonet' and a vehicle section for 'sensonet_vehicle' have to be added to evcc.yaml. If an energy meter
-like Shelly 3EM is present for the Vaillant heatpump, then a meter section has to be added to evcc.yaml as well.
-The sensonet charger, the sensonet_vehicle vehicle and the energy meter have to be combinated as a loadpoint in the yaml file.
+To use this extension a charger section for 'sensonet' has to be added to evcc.yaml. You can use vehicles of type sensonet_vehicle to switch between different PV use strategies. Or you set the parameter 'integrateddevice: true' for the sensonet charger and define no vehicles.
+(If an energy meter like Shelly 3EM is present for the Vaillant heatpump, then a meter section has to be added to evcc.yaml as well.)
+The sensonet charger, the sensonet_vehicle vehicles and the energy meter have to be combinated as a loadpoint in the yaml file.
 
-The sensonet charge module initiates a http API interface to the myVaillant portal and keeps this connection active by regular refresh token calls.
-A json system report is obtained about every two minutes using a http GET call. This report is analysed to extract information about heating zones, operating modes, current temperatures and temperature setpoints.
-The sensonet_vehicle module is used to present some information like SoC (=current temperature) and TargetSoC (=temperature setpoint) to the loadpoint module of evcc.
+The sensonet charge module initiates a http API interface to the myVaillant portal and keeps this connection active by regular refresh token calls. A json system report is obtained about every two minutes using a http GET call. This report is analysed to extract information about heating zones, operating modes, current temperatures and temperature setpoints.
+Some of the gathered data like SoC (=current temperature), TargetSoC (=temperature setpoint) and current power consumption are presented by the evcc web front end. (Some heat pump systems can not provide the current power consumption to the myVaillant portal and therefore the sensonet charger can not read it from there. Then the use of an external metering device is recommended but not mandatory.)
 
 If the evcc loadpoint module signals to the sensonet charger module that a charging session should be started, then the sensonet module does the following:
-   (a) If ('pvusestrategy='hotwater') or (pvusestrategy='hotwater_than_heating' and current hotwater temperature is more than 5°C below the setpoint), then
-         a hotwater boost is initiated via http POST request.
-   (b) If ('pvusestrategy='heating') or (pvusestrategy='hotwater_than_heating' and current hotwater temperature is less than 5°C below the setpoint), then
-         a heating zone quick veto is initiated via http POST request for the zone given by the heatingzone parameter in the evcc.yaml file (default=0). 
-        The duration of the veto is 30 minutes and the veto_setpoint= normal_temperature_setpoint + heatingtemperatureoffset (default=2).
-Via the json system reports, the sensonet module notices when the hotwater boost or the zone quick veto ends and changes the enabled() status to false to report
-this to the loadpoint module of evcc.
+   (a) If ('pvusestrategy='hotwater') or (pvusestrategy='hotwater_than_heating' and current hotwater temperature is more than 5°C below the setpoint), then a hotwater boost is initiated via http POST request.
+   (b) If ('pvusestrategy='heating') or (pvusestrategy='hotwater_than_heating' and current hotwater temperature is less than 5°C below the setpoint), then a heating zone quick veto is initiated via http POST request for the zone given by the heatingzone parameter in the evcc.yaml file (default=0). The duration of the veto is 3 hours and the veto_setpoint= normal_temperature_setpoint + heatingtemperatureoffset (default=2).
+Via the json system reports, the sensonet module notices when the hotwater boost or the zone quick veto ends and changes the enabled() status to false to report this to the loadpoint module of evcc.
 If the loadpoint module tells the sensonet module to stop a charging session, then the sensonet module sends a "cancel hotwater boost" or "cancel zone quick veto" to the myVaillant portal via http DELETE request.
 It happens, that it takes a few minutes before the json system report from the myVaillant portal reflects an initiated or canceled boost or quick veto. Don't worry!
 
 ## Custom ebus message definition file 15.ctlv2.csv
-At the moment, some ebus message definitions needed for the initiation of a zone quick veto are missing in the "official" ebus configuration files under https://cfg.ebusd.eu/ 
-Therefore the config files have to be downloaded from https://cfg.ebusd.eu/ to a local path and 15.ctlv2.csv has to be substituted by the file https://github.com/WulfgarW/ebusd-configuration/blob/master/ebusd-2.1.x/de/vaillant/15.ctlv2.csv 
+At the moment, some ebus message definitions needed for the initiation of a zone quick veto are missing in the "official" ebus configuration files under https://ebus.github.io/. 
+It works, if you start the ebusd service with the config path https://ebus.github.io/next/. Or you can download the config files to a local path and substitute 15.ctlv2.csv by the file https://github.com/WulfgarW/sensonetEbus/ebusd-config-files/15.ctlv2.csv 
 
-## Warning
-This extensions are still unstable and in first tests.
+## Request for feedback
 Feedback of beta testers is welcome.
+
+## Further notes
+The vaillant-ebus charger is based on the sensonetEbus package at https://github.com/WulfgarW/sensonetEbus.
+The sensonet charger is based on the sensonet package at https://github.com/WulfgarW/sensonet

charger/sensonet.go

@@ -1,8 +1,6 @@
 package charger
 
 import (
-	"fmt"
-
 	"github.com/evcc-io/evcc/api"
 	"github.com/evcc-io/evcc/charger/sensonet"
 	"github.com/evcc-io/evcc/util"
@@ -66,21 +64,7 @@ func (c *Sensonet) Enabled() (bool, error) {
 
 // Enable implements the api.Charger interface
 func (c *Sensonet) Enable(enable bool) error {
-	err := c.conn.Enable(enable)
-	if err != nil {
-		return err
-	}
-
-	enabled, err := c.Enabled()
-	switch {
-	case err != nil:
-		return err
-	case enable != enabled:
-		onoff := map[bool]string{true: "on", false: "off"}
-		return fmt.Errorf("switch %s failed", onoff[enable])
-	default:
-		return nil
-	}
+	return c.conn.Enable(enable)
 }
 
 func (c *Sensonet) Phases() int {
@@ -99,3 +83,15 @@ func (c *Sensonet) Status() (api.ChargeStatus, error) {
 func (c *Sensonet) ModeText() string {
 	return c.conn.ModeText()
 }
+
+func (c *Sensonet) Soc() (float64, error) {
+	return c.conn.CurrentTemp()
+}
+
+func (c *Sensonet) CurrentPower() (float64, error) {
+	return c.conn.CurrentPower()
+}
+
+func (c *Sensonet) GetLimitSoc() (int64, error) {
+	return c.conn.TargetTemp()
+}

charger/sensonet/connection.go

@@ -37,7 +37,7 @@ type Connection struct {
 	heatingTemperatureOffset float64
 	onoff                    bool
 	quickVetoSetPoint        float32
-	quickVetoExpiresAt       string
+	//quickVetoExpiresAt       string
 }
 
 // Global variable sensoNetConn is used to make data available in vehicle sensonet-vehicle
@@ -88,12 +88,9 @@ func NewConnection(user, password, realm, pvUseStrategy string, heatingZone, pha
 		sensoNetConn.log.DEBUG.Println("In connection.NewConnection: sensoNetConn already initialised")
 		return sensoNetConn, nil
 	} else {
-		utillog := util.NewLogger("sensonet")
+		utillog := util.NewLogger("sensonet").Redact(user, password)
 		client := request.NewClient(utillog)
 		ctxClient := request.NewClient(utillog)
-		/*client.CheckRedirect = func(req *http.Request, via []*http.Request) error {
-			return http.ErrUseLastResponse
-		}*/
 
 		conn := &Connection{
 			client: client,
@@ -109,11 +106,6 @@ func NewConnection(user, password, realm, pvUseStrategy string, heatingZone, pha
 		conn.log = utillog
 
 		var err error
-		/*conn.client.Jar, err = cookiejar.New(nil)
-		if err != nil {
-			err = fmt.Errorf("could not reset cookie jar. error: %s", err)
-			return conn, err
-		}*/
 
 		ctx := context.WithValue(context.TODO(), oauth2.HTTPClient, ctxClient)
 		clientCtx := context.WithValue(ctx, oauth2.HTTPClient, ctxClient)
@@ -214,7 +206,7 @@ func (d *Connection) CurrentTemp() (float64, error) {
 }
 
 // TargetTemp is called bei TargetSoc
-func (d *Connection) TargetTemp() (float64, error) {
+func (d *Connection) TargetTemp() (int64, error) {
 	state, err := d.sensonetCtrl.GetSystem(d.systemId)
 	if err != nil {
 		d.log.ERROR.Println("connection.TargetTemp. Error: ", err)
@@ -243,18 +235,18 @@ func (d *Connection) TargetTemp() (float64, error) {
 		zoneData := sensonetlib.GetZoneData(state, d.heatingZone)
 		if zoneData != nil {
 			if zoneData.State.CurrentSpecialFunction == "QUICK_VETO" {
-				return float64(zoneData.State.DesiredRoomTemperatureSetpoint), nil
+				return int64(zoneData.State.DesiredRoomTemperatureSetpoint), nil
 			} else {
-				return float64(d.quickVetoSetPoint), nil
+				return int64(d.quickVetoSetPoint), nil
 			}
 		}
-		return float64(d.quickVetoSetPoint), nil
+		return int64(d.quickVetoSetPoint), nil
 	}
 	if !hotWaterOn {
 		zoneData := sensonetlib.GetZoneData(state, d.heatingZone)
-		return zoneData.State.DesiredRoomTemperatureSetpoint, nil
+		return int64(zoneData.State.DesiredRoomTemperatureSetpoint), nil
 	} else {
-		return hotWaterSetpoint, nil
+		return int64(hotWaterSetpoint), nil
 	}
 }
 
@@ -309,11 +301,14 @@ func (d *Connection) ModeText() string {
 	case sensonetlib.QUICKMODE_HOTWATER:
 		return " (Hotwater Boost active)"
 	case sensonetlib.QUICKMODE_HEATING:
-		if d.quickVetoExpiresAt != "" {
-			return " (Heating Quick Veto active. Ends " + d.quickVetoExpiresAt + ")"
+		if d.sensonetCtrl.GetQuickModeExpiresAt() != "" {
+			return " (Heating Quick Veto active. Ends " + d.sensonetCtrl.GetQuickModeExpiresAt() + ")"
 		}
 		return " (Heating Quick Veto active)"
 	case sensonetlib.QUICKMODE_NOTHING:
+		if d.sensonetCtrl.GetQuickModeExpiresAt() != "" {
+			return " (charger running idle. Ends " + d.sensonetCtrl.GetQuickModeExpiresAt() + "; " + tempInfo
+		}
 		return " (charger running idle; " + tempInfo
 	}
 	return " (regular mode; " + tempInfo

charger/sensonet/switch.go

@@ -2,7 +2,7 @@ package sensonet
 
 import (
 	"fmt"
-	"time"
+	//"time"
 
 	sensonetlib "github.com/WulfgarW/sensonet"
 )
@@ -29,11 +29,11 @@ func (sh *Switch) Enabled() (bool, error) {
 		d.log.ERROR.Println("switch.Enabled. Error: ", err)
 		return d.onoff, err
 	}
-	d.log.DEBUG.Println("In Switch.Enabled: Zones[0].CurrentSpecialFunction=", state.State.Zones[0].CurrentSpecialFunction)
+	d.log.DEBUG.Println(fmt.Sprintf("In Switch.Enabled: Zones[%d].CurrentSpecialFunction=%s", d.heatingZone, state.State.Zones[d.heatingZone].CurrentSpecialFunction))
 
 	newQuickmode := d.sensonetCtrl.GetCurrentQuickMode()
 	d.log.DEBUG.Printf("In Switch.Enabled: GetCurrentQuickmode() returns \"%s\"", newQuickmode)
-	if newQuickmode == "" || newQuickmode == sensonetlib.QUICKMODE_NOTHING {
+	if newQuickmode == "" { //|| newQuickmode == sensonetlib.QUICKMODE_NOTHING {
 		d.onoff = false
 	} else {
 		d.onoff = true
@@ -73,11 +73,11 @@ func (sh *Switch) Enable(enable bool) error {
 			} else {
 				d.quickVetoSetPoint = heatingPar.VetoSetpoint
 			}
-			if heatingPar.VetoDuration < 0.0 {
+			/*if heatingPar.VetoDuration < 0.0 {
 				d.quickVetoExpiresAt = (time.Now().Add(time.Duration(int64(sensonetlib.ZONEVETODURATION_DEFAULT*60) * int64(time.Minute)))).Format("15:04")
 			} else {
 				d.quickVetoExpiresAt = (time.Now().Add(time.Duration(int64(heatingPar.VetoDuration*60) * int64(time.Minute)))).Format("15:04")
-			}
+			}*/
 		}
 	} else {
 		result, err := d.sensonetCtrl.StopStrategybased(d.systemId, &heatingPar, &hotwaterPar)
@@ -87,7 +87,7 @@ func (sh *Switch) Enable(enable bool) error {
 		}
 		d.log.DEBUG.Println("In Switch.Enable: StopStrategybased returns: ", result)
 		d.quickVetoSetPoint = 0.0
-		d.quickVetoExpiresAt = ""
+		//d.quickVetoExpiresAt = ""
 	}
 	d.onoff = enable
 	return err

charger/vaillant-ebus.go

@@ -97,3 +97,15 @@ func (c *VaillantEbus) Status() (api.ChargeStatus, error) {
 func (c *VaillantEbus) ModeText() string {
 	return c.conn.ModeText()
 }
+
+func (c *VaillantEbus) Soc() (float64, error) {
+	return c.conn.CurrentTemp()
+}
+
+func (c *VaillantEbus) CurrentPower() (float64, error) {
+	return c.conn.CurrentPower()
+}
+
+func (c *VaillantEbus) GetLimitSoc() (int64, error) {
+	return c.conn.TargetTemp()
+}