chore: rename ChargePhases api to PhaseSwitcher (evcc-io#4105)

api/api.go

@@ -10,7 +10,7 @@ import (
 	"github.com/fatih/structs"
 )
 
-//go:generate mockgen -package mock -destination ../mock/mock_api.go github.com/evcc-io/evcc/api Charger,ChargeState,ChargePhases,Identifier,Meter,MeterEnergy,Vehicle,ChargeRater,Battery
+//go:generate mockgen -package mock -destination ../mock/mock_api.go github.com/evcc-io/evcc/api Charger,ChargeState,PhaseSwitcher,Identifier,Meter,MeterEnergy,Vehicle,ChargeRater,Battery
 
 // ChargeMode are charge modes modeled after OpenWB
 type ChargeMode string
@@ -107,8 +107,8 @@ type ChargerEx interface {
 	MaxCurrentMillis(current float64) error
 }
 
-// ChargePhases provides 1p3p switching
-type ChargePhases interface {
+// PhaseSwitcher provides 1p3p switching
+type PhaseSwitcher interface {
 	Phases1p3p(phases int) error
 }
 

charger/_blueprint.go

@@ -116,9 +116,9 @@ func (wb *Blueprint) Identify() (string, error) {
 	return "", api.ErrNotAvailable
 }
 
-var _ api.ChargePhases = (*Blueprint)(nil)
+var _ api.PhaseSwitcher = (*Blueprint)(nil)
 
-// Phases1p3p implements the api.ChargePhases interface
+// Phases1p3p implements the api.PhaseSwitcher interface
 func (wb *Blueprint) Phases1p3p(phases int) error {
 	return api.ErrNotAvailable
 }

charger/abb.go

@@ -249,9 +249,9 @@ func (wb *ABB) Currents() (float64, float64, float64, error) {
 	return curr[0], curr[1], curr[2], nil
 }
 
-// var _ api.ChargePhases = (*ABB)(nil)
+// var _ api.PhaseSwitcher = (*ABB)(nil)
 
-// // Phases1p3p implements the api.ChargePhases interface
+// // Phases1p3p implements the api.PhaseSwitcher interface
 // func (wb *ABB) Phases1p3p(phases int) error {
 // 	var b uint16 = 1
 // 	if phases != 1 {

charger/alfen.go

@@ -228,9 +228,9 @@ func (wb *Alfen) Currents() (float64, float64, float64, error) {
 	return currents[0], currents[1], currents[2], nil
 }
 
-var _ api.ChargePhases = (*Alfen)(nil)
+var _ api.PhaseSwitcher = (*Alfen)(nil)
 
-// Phases1p3p implements the api.ChargePhases interface
+// Phases1p3p implements the api.PhaseSwitcher interface
 func (c *Alfen) Phases1p3p(phases int) error {
 	_, err := c.conn.WriteSingleRegister(alfenRegPhases, uint16(phases))
 	return err

charger/dadapower.go

@@ -205,9 +205,9 @@ func (wb *Dadapower) Currents() (float64, float64, float64, error) {
 	return currents[0], currents[1], currents[2], nil
 }
 
-var _ api.ChargePhases = (*Dadapower)(nil)
+var _ api.PhaseSwitcher = (*Dadapower)(nil)
 
-// Phases1p3p implements the api.ChargePhases interface
+// Phases1p3p implements the api.PhaseSwitcher interface
 func (wb *Dadapower) Phases1p3p(phases int) error {
 	_, err := wb.conn.WriteSingleRegister(dadapowerRegActivePhases+wb.regOffset, uint16(phases))
 	return err

charger/easee.go

@@ -406,9 +406,9 @@ func (c *Easee) MaxCurrent(current int64) error {
 	return err
 }
 
-var _ api.ChargePhases = (*Easee)(nil)
+var _ api.PhaseSwitcher = (*Easee)(nil)
 
-// Phases1p3p implements the api.ChargePhases interface
+// Phases1p3p implements the api.PhaseSwitcher interface
 func (c *Easee) Phases1p3p(phases int) error {
 	var err error
 	if c.circuit != 0 {

charger/go-e.go

@@ -41,7 +41,7 @@ func init() {
 	registry.Add("go-e", NewGoEFromConfig)
 }
 
-// go:generate go run ../cmd/tools/decorate.go -f decorateGoE -b *GoE -r api.Charger -t "api.MeterEnergy,TotalEnergy,func() (float64, error)" -t "api.ChargePhases,Phases1p3p,func(int) (error)"
+// go:generate go run ../cmd/tools/decorate.go -f decorateGoE -b *GoE -r api.Charger -t "api.MeterEnergy,TotalEnergy,func() (float64, error)" -t "api.PhaseSwitcher,Phases1p3p,func(int) (error)"
 
 // NewGoEFromConfig creates a go-e charger from generic config
 func NewGoEFromConfig(other map[string]interface{}) (api.Charger, error) {
@@ -205,7 +205,7 @@ func (c *GoE) totalEnergy() (float64, error) {
 	return val, err
 }
 
-// phases1p3p implements the api.ChargePhases interface - v2 only
+// phases1p3p implements the api.PhaseSwitcher interface - v2 only
 func (c *GoE) phases1p3p(phases int) error {
 	if phases == 3 {
 		phases = 2

charger/go-e_test.go

@@ -82,7 +82,7 @@ func TestGoEV2(t *testing.T) {
 		t.Error("missing MeterEnergy api")
 	}
 
-	if _, ok := wb.(api.ChargePhases); !ok {
-		t.Error("missing ChargePhases api")
+	if _, ok := wb.(api.PhaseSwitcher); !ok {
+		t.Error("missing PhaseSwitcher api")
 	}
 }

charger/kse.go

@@ -203,9 +203,9 @@ func (wb *KSE) Currents() (float64, float64, float64, error) {
 	return curr[0], curr[1], curr[2], nil
 }
 
-// var _ api.ChargePhases = (*KSE)(nil)
+// var _ api.PhaseSwitcher = (*KSE)(nil)
 
-// // Phases1p3p implements the api.ChargePhases interface
+// // Phases1p3p implements the api.PhaseSwitcher interface
 // func (wb *KSE) Phases1p3p(phases int) error {
 // 	var b uint16 = 0
 // 	if phases == 1 {

charger/ocpp.go

@@ -332,7 +332,7 @@ func (c *OCPP) Status() (api.ChargeStatus, error) {
 	return c.cp.Status()
 }
 
-// TODO: Phases1p3p implements the api.ChargePhases interface
+// TODO: Phases1p3p implements the api.PhaseSwitcher interface
 // func (c *OCPP) Phases1p3p(phases int) error {
 // 	if !c.phaseSwitchingSupported {
 // 		return fmt.Errorf("phase switching is not supported by the charger")

charger/openwb-pro.go

@@ -180,9 +180,9 @@ func (wb *OpenWBPro) Currents() (float64, float64, float64, error) {
 	return res.Currents[0], res.Currents[1], res.Currents[2], err
 }
 
-var _ api.ChargePhases = (*OpenWBPro)(nil)
+var _ api.PhaseSwitcher = (*OpenWBPro)(nil)
 
-// Phases1p3p implements the api.ChargePhases interface
+// Phases1p3p implements the api.PhaseSwitcher interface
 func (wb *OpenWBPro) Phases1p3p(phases int) error {
 	return wb.set(fmt.Sprintf("phasetarget=%d", phases))
 }

charger/openwb.go

@@ -29,7 +29,7 @@ type OpenWB struct {
 	authS         func(string) error
 }
 
-// go:generate go run ../cmd/tools/decorate.go -f decorateOpenWB -b *OpenWB -r api.Charger -t "api.ChargePhases,Phases1p3p,func(int) (error)" -t "api.Battery,SoC,func() (float64, error)"
+// go:generate go run ../cmd/tools/decorate.go -f decorateOpenWB -b *OpenWB -r api.Charger -t "api.PhaseSwitcher,Phases1p3p,func(int) (error)" -t "api.Battery,SoC,func() (float64, error)"
 
 // NewOpenWBFromConfig creates a new configurable charger
 func NewOpenWBFromConfig(other map[string]interface{}) (api.Charger, error) {

core/loadpoint.go

@@ -219,7 +219,7 @@ func NewLoadPointFromConfig(log *util.Logger, cp configProvider, other map[strin
 	// setup fixed phases:
 	// - simple charger starts with phases config if specified or 3p
 	// - switchable charger starts at 0p since we don't know the current setting
-	if _, ok := lp.charger.(api.ChargePhases); !ok {
+	if _, ok := lp.charger.(api.PhaseSwitcher); !ok {
 		if lp.DefaultPhases == 0 {
 			lp.DefaultPhases = 3
 			lp.log.WARN.Println("phases not configured, assuming 3p")
@@ -1014,13 +1014,13 @@ func (lp *LoadPoint) resetPVTimerIfRunning(typ ...string) {
 	lp.publishTimer(pvTimer, 0, timerInactive)
 }
 
-// scalePhasesIfAvailable scales if api.ChargePhases is available
+// scalePhasesIfAvailable scales if api.PhaseSwitcher is available
 func (lp *LoadPoint) scalePhasesIfAvailable(phases int) error {
 	if lp.DefaultPhases != 0 {
 		phases = lp.DefaultPhases
 	}
 
-	if _, ok := lp.charger.(api.ChargePhases); ok {
+	if _, ok := lp.charger.(api.PhaseSwitcher); ok {
 		return lp.scalePhases(phases)
 	}
 
@@ -1036,7 +1036,7 @@ func (lp *LoadPoint) setDefaultPhases(phases int) {
 	lp.phaseTimer = time.Time{}
 
 	// publish 1p3p capability and phase configuration
-	if _, ok := lp.charger.(api.ChargePhases); ok {
+	if _, ok := lp.charger.(api.PhaseSwitcher); ok {
 		lp.publish("phases1p3p", lp.DefaultPhases)
 	} else {
 		lp.publish("phases1p3p", nil)
@@ -1059,11 +1059,11 @@ func (lp *LoadPoint) setPhases(phases int) {
 }
 
 // scalePhases adjusts the number of active phases and returns the appropriate charging current.
-// Returns api.ErrNotAvailable if api.ChargePhases is not available.
+// Returns api.ErrNotAvailable if api.PhaseSwitcher is not available.
 func (lp *LoadPoint) scalePhases(phases int) error {
-	cp, ok := lp.charger.(api.ChargePhases)
+	cp, ok := lp.charger.(api.PhaseSwitcher)
 	if !ok {
-		panic("charger does not implement api.ChargePhases")
+		panic("charger does not implement api.PhaseSwitcher")
 	}
 
 	if lp.GetPhases() != phases {
@@ -1210,7 +1210,7 @@ func (lp *LoadPoint) pvMaxCurrent(mode api.ChargeMode, sitePower float64, batter
 	maxCurrent := lp.GetMaxCurrent()
 
 	// switch phases up/down
-	if _, ok := lp.charger.(api.ChargePhases); ok {
+	if _, ok := lp.charger.(api.PhaseSwitcher); ok {
 		availablePower := -sitePower + lp.chargePower
 
 		// in case of scaling, keep charger disabled for this cycle

core/loadpoint_api.go

@@ -108,7 +108,7 @@ func (lp *LoadPoint) GetPhases() int {
 // SetPhases sets loadpoint enabled phases
 func (lp *LoadPoint) SetPhases(phases int) error {
 	// limit auto mode (phases=0) to scalable charger
-	if _, ok := lp.charger.(api.ChargePhases); !ok && phases == 0 {
+	if _, ok := lp.charger.(api.PhaseSwitcher); !ok && phases == 0 {
 		return fmt.Errorf("invalid number of phases: %d", phases)
 	}
 
@@ -120,7 +120,7 @@ func (lp *LoadPoint) SetPhases(phases int) error {
 	lp.setDefaultPhases(phases)
 
 	// apply immediately if not 1p3p
-	if _, ok := lp.charger.(api.ChargePhases); !ok {
+	if _, ok := lp.charger.(api.PhaseSwitcher); !ok {
 		lp.setPhases(phases)
 	}
 

core/loadpoint_phases.go

@@ -64,7 +64,7 @@ func (lp *LoadPoint) maxActivePhases() int {
 	}
 
 	// if 1p3p supported then assume configured limit or 3p
-	if _, ok := lp.charger.(api.ChargePhases); ok {
+	if _, ok := lp.charger.(api.PhaseSwitcher); ok {
 		physical = lp.DefaultPhases
 		if physical == 0 {
 			physical = 3