Stefan/evcc-io
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Remove deprecated use of type instead of source for specifying plugin (#2899)

Browse source
This commit is contained in:
andig 2022-03-17 15:39:22 +00:00 • committed by GitHub
parent 38defb679e
commit 7649eff46a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 12 additions and 55 deletions
Download patch file Download diff file Expand all files Collapse all files

7
charger/charger.go
View file

@ -27,13 +27,6 @@ func NewConfigurableFromConfig(other map[string]interface{}) (api.Charger, error
return nil, err
}
// TODO deprecate
log := util.NewLogger("charger")
cc.Status.Deprecate(log)
cc.Enable.Deprecate(log)
cc.Enabled.Deprecate(log)
cc.MaxCurrent.Deprecate(log)
status, err := provider.NewStringGetterFromConfig(cc.Status)
if err != nil {
return nil, fmt.Errorf("status: %w", err)

9
meter/meter.go
View file

@ -33,15 +33,6 @@ func NewConfigurableFromConfig(other map[string]interface{}) (api.Meter, error)
return nil, fmt.Errorf("power: %w", err)
}
// TODO deprecate
log := util.NewLogger("meter")
cc.Power.Deprecate(log)
cc.Energy.Deprecate(log)
cc.SoC.Deprecate(log)
for _, p := range cc.Currents {
p.Deprecate(log)
}
m, _ := NewConfigurable(power)
// decorate Meter with MeterEnergy

44
provider/config.go
View file

@ -2,9 +2,6 @@ package provider
import (
"fmt"
"strings"
"github.com/evcc-io/evcc/util"
)
// provider types
@ -54,29 +51,12 @@ var registry providerRegistry = make(map[string]func(map[string]interface{}) (In
// Config is the general provider config
type Config struct {
Source string
Type string // TODO remove deprecated
Other map[string]interface{} `mapstructure:",remain"`
}
// TODO prepare for removing deprecated type attribute
func (c *Config) Deprecate(log *util.Logger) {
if c != nil && c.Type != "" {
log.WARN.Printf("type:%s is deprecated, use source:%s instead", c.Type, c.Type)
}
}
// PluginType returns the plugin type in a legacy-aware way
func (c Config) PluginType() string {
typ := c.Source
if typ == "" {
typ = c.Type
}
return strings.ToLower(typ)
}
// NewIntGetterFromConfig creates a IntGetter from config
func NewIntGetterFromConfig(config Config) (res func() (int64, error), err error) {
factory, err := registry.Get(config.PluginType())
factory, err := registry.Get(config.Source)
if err == nil {
var provider IntProvider
provider, err = factory(config.Other)
@ -87,7 +67,7 @@ func NewIntGetterFromConfig(config Config) (res func() (int64, error), err error
}
if err == nil && res == nil {
err = fmt.Errorf("invalid plugin type: %s", config.PluginType())
err = fmt.Errorf("invalid plugin type: %s", config.Source)
}
return
@ -95,7 +75,7 @@ func NewIntGetterFromConfig(config Config) (res func() (int64, error), err error
// NewFloatGetterFromConfig creates a FloatGetter from config
func NewFloatGetterFromConfig(config Config) (res func() (float64, error), err error) {
factory, err := registry.Get(config.PluginType())
factory, err := registry.Get(config.Source)
if err == nil {
var provider IntProvider
provider, err = factory(config.Other)
@ -106,7 +86,7 @@ func NewFloatGetterFromConfig(config Config) (res func() (float64, error), err e
}
if err == nil && res == nil {
err = fmt.Errorf("invalid plugin type: %s", config.PluginType())
err = fmt.Errorf("invalid plugin type: %s", config.Source)
}
return
@ -114,7 +94,7 @@ func NewFloatGetterFromConfig(config Config) (res func() (float64, error), err e
// NewStringGetterFromConfig creates a StringGetter from config
func NewStringGetterFromConfig(config Config) (res func() (string, error), err error) {
switch typ := config.PluginType(); typ {
switch typ := config.Source; typ {
case "combined", "openwb":
res, err = NewOpenWBStatusProviderFromConfig(config.Other)
@ -131,7 +111,7 @@ func NewStringGetterFromConfig(config Config) (res func() (string, error), err e
}
if err == nil && res == nil {
err = fmt.Errorf("invalid plugin type: %s", config.PluginType())
err = fmt.Errorf("invalid plugin type: %s", config.Source)
}
}
@ -140,7 +120,7 @@ func NewStringGetterFromConfig(config Config) (res func() (string, error), err e
// NewBoolGetterFromConfig creates a BoolGetter from config
func NewBoolGetterFromConfig(config Config) (res func() (bool, error), err error) {
factory, err := registry.Get(config.PluginType())
factory, err := registry.Get(config.Source)
if err == nil {
var provider IntProvider
provider, err = factory(config.Other)
@ -151,7 +131,7 @@ func NewBoolGetterFromConfig(config Config) (res func() (bool, error), err error
}
if err == nil && res == nil {
err = fmt.Errorf("invalid plugin type: %s", config.PluginType())
err = fmt.Errorf("invalid plugin type: %s", config.Source)
}
return
@ -159,7 +139,7 @@ func NewBoolGetterFromConfig(config Config) (res func() (bool, error), err error
// NewIntSetterFromConfig creates a IntSetter from config
func NewIntSetterFromConfig(param string, config Config) (res func(int64) error, err error) {
factory, err := registry.Get(config.PluginType())
factory, err := registry.Get(config.Source)
if err == nil {
var provider IntProvider
provider, err = factory(config.Other)
@ -170,7 +150,7 @@ func NewIntSetterFromConfig(param string, config Config) (res func(int64) error,
}
if err == nil && res == nil {
err = fmt.Errorf("invalid plugin type: %s", config.PluginType())
err = fmt.Errorf("invalid plugin type: %s", config.Source)
}
return
@ -178,7 +158,7 @@ func NewIntSetterFromConfig(param string, config Config) (res func(int64) error,
// NewBoolSetterFromConfig creates a BoolSetter from config
func NewBoolSetterFromConfig(param string, config Config) (res func(bool) error, err error) {
factory, err := registry.Get(config.PluginType())
factory, err := registry.Get(config.Source)
if err == nil {
var provider IntProvider
provider, err = factory(config.Other)
@ -189,7 +169,7 @@ func NewBoolSetterFromConfig(param string, config Config) (res func(bool) error,
}
if err == nil && res == nil {
err = fmt.Errorf("invalid plugin type: %s", config.PluginType())
err = fmt.Errorf("invalid plugin type: %s", config.Source)
}
return

7
vehicle/vehicle.go
View file

@ -35,13 +35,6 @@ func NewConfigurableFromConfig(other map[string]interface{}) (api.Vehicle, error
return nil, err
}
// TODO deprecate
log := util.NewLogger("vehicle")
cc.Soc.Deprecate(log)
cc.Status.Deprecate(log)
cc.Range.Deprecate(log)
cc.Odometer.Deprecate(log)
socG, err := provider.NewFloatGetterFromConfig(cc.Soc)
if err != nil {
return nil, fmt.Errorf("soc: %w", err)