Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add device lifecycle #16513

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 14 additions & 13 deletions charger/charger.go
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
package charger

import (
"context"
"errors"
"fmt"

Expand All @@ -20,13 +21,13 @@ type Charger struct {
}

func init() {
registry.Add(api.Custom, NewConfigurableFromConfig)
registry.AddCtx(api.Custom, NewConfigurableFromConfig)
}

//go:generate go run ../cmd/tools/decorate.go -f decorateCustom -b *Charger -r api.Charger -t "api.ChargerEx,MaxCurrentMillis,func(float64) error" -t "api.Identifier,Identify,func() (string, error)" -t "api.PhaseSwitcher,Phases1p3p,func(int) error" -t "api.Resurrector,WakeUp,func() error" -t "api.Battery,Soc,func() (float64, error)" -t "api.Meter,CurrentPower,func() (float64, error)" -t "api.MeterEnergy,TotalEnergy,func() (float64, error)" -t "api.PhaseCurrents,Currents,func() (float64, float64, float64, error)" -t "api.PhaseVoltages,Voltages,func() (float64, float64, float64, error)"

// NewConfigurableFromConfig creates a new configurable charger
func NewConfigurableFromConfig(other map[string]interface{}) (api.Charger, error) {
func NewConfigurableFromConfig(ctx context.Context, other map[string]interface{}) (api.Charger, error) {
var cc struct {
embed `mapstructure:",squash"`
Status, Enable, Enabled, MaxCurrent provider.Config
Expand All @@ -47,22 +48,22 @@ func NewConfigurableFromConfig(other map[string]interface{}) (api.Charger, error
return nil, err
}

status, err := provider.NewStringGetterFromConfig(cc.Status)
status, err := provider.NewStringGetterFromConfig(ctx, cc.Status)
if err != nil {
return nil, fmt.Errorf("status: %w", err)
}

enabled, err := provider.NewBoolGetterFromConfig(cc.Enabled)
enabled, err := provider.NewBoolGetterFromConfig(ctx, cc.Enabled)
if err != nil {
return nil, fmt.Errorf("enabled: %w", err)
}

enable, err := provider.NewBoolSetterFromConfig("enable", cc.Enable)
enable, err := provider.NewBoolSetterFromConfig(ctx, "enable", cc.Enable)
if err != nil {
return nil, fmt.Errorf("enable: %w", err)
}

maxcurrent, err := provider.NewIntSetterFromConfig("maxcurrent", cc.MaxCurrent)
maxcurrent, err := provider.NewIntSetterFromConfig(ctx, "maxcurrent", cc.MaxCurrent)
if err != nil {
return nil, fmt.Errorf("maxcurrent: %w", err)
}
Expand All @@ -76,7 +77,7 @@ func NewConfigurableFromConfig(other map[string]interface{}) (api.Charger, error

var maxcurrentmillis func(float64) error
if cc.MaxCurrentMillis != nil {
maxcurrentmillis, err = provider.NewFloatSetterFromConfig("maxcurrentmillis", *cc.MaxCurrentMillis)
maxcurrentmillis, err = provider.NewFloatSetterFromConfig(ctx, "maxcurrentmillis", *cc.MaxCurrentMillis)
if err != nil {
return nil, fmt.Errorf("maxcurrentmillis: %w", err)
}
Expand All @@ -89,7 +90,7 @@ func NewConfigurableFromConfig(other map[string]interface{}) (api.Charger, error
return nil, errors.New("1p3p does no longer handle disable/enable. Use tos: true to confirm you understand the consequences")
}

phases1p3pS, err := provider.NewIntSetterFromConfig("phases", *cc.Phases1p3p)
phases1p3pS, err := provider.NewIntSetterFromConfig(ctx, "phases", *cc.Phases1p3p)
if err != nil {
return nil, fmt.Errorf("phases: %w", err)
}
Expand All @@ -102,7 +103,7 @@ func NewConfigurableFromConfig(other map[string]interface{}) (api.Charger, error
// decorate identifier
var identify func() (string, error)
if cc.Identify != nil {
identify, err = provider.NewStringGetterFromConfig(*cc.Identify)
identify, err = provider.NewStringGetterFromConfig(ctx, *cc.Identify)
if err != nil {
return nil, fmt.Errorf("identify: %w", err)
}
Expand All @@ -111,7 +112,7 @@ func NewConfigurableFromConfig(other map[string]interface{}) (api.Charger, error
// decorate wakeup
var wakeup func() error
if cc.Wakeup != nil {
wakeupS, err := provider.NewBoolSetterFromConfig("wakeup", *cc.Wakeup)
wakeupS, err := provider.NewBoolSetterFromConfig(ctx, "wakeup", *cc.Wakeup)
if err != nil {
return nil, fmt.Errorf("wakeup: %w", err)
}
Expand All @@ -124,19 +125,19 @@ func NewConfigurableFromConfig(other map[string]interface{}) (api.Charger, error
// decorate soc
var soc func() (float64, error)
if cc.Soc != nil {
soc, err = provider.NewFloatGetterFromConfig(*cc.Soc)
soc, err = provider.NewFloatGetterFromConfig(ctx, *cc.Soc)
if err != nil {
return nil, fmt.Errorf("soc: %w", err)
}
}

// decorate measurements
powerG, energyG, err := meter.BuildMeasurements(cc.Power, cc.Energy)
powerG, energyG, err := meter.BuildMeasurements(ctx, cc.Power, cc.Energy)
if err != nil {
return nil, err
}

currentsG, voltagesG, _, err := meter.BuildPhaseMeasurements(cc.Currents, cc.Voltages, nil)
currentsG, voltagesG, _, err := meter.BuildPhaseMeasurements(ctx, cc.Currents, cc.Voltages, nil)
if err != nil {
return nil, err
}
Expand Down
4 changes: 2 additions & 2 deletions charger/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,13 @@ func Types() []string {
}

// NewFromConfig creates charger from configuration
func NewFromConfig(typ string, other map[string]interface{}) (api.Charger, error) {
func NewFromConfig(ctx context.Context, typ string, other map[string]interface{}) (api.Charger, error) {
factory, err := registry.Get(strings.ToLower(typ))
if err != nil {
return nil, err
}

v, err := factory(context.TODO(), other)
v, err := factory(ctx, other)
if err != nil {
err = fmt.Errorf("cannot create charger type '%s': %w", typ, err)
}
Expand Down
2 changes: 1 addition & 1 deletion charger/openwb.go
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ func NewOpenWB(log *util.Logger, mqttconf mqtt.Config, id int, topic string, p1p
if err != nil {
return nil, err
}
statusG := provider.NewOpenWBStatusProvider(pluggedG, chargingG).StringGetter
statusG := provider.NewCombinedProvider(pluggedG, chargingG).StringGetter

// setters
currentTopic := openwb.SlaveChargeCurrentTopic
Expand Down
12 changes: 7 additions & 5 deletions charger/switchsocket.go
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
package charger

import (
"context"

"github.com/evcc-io/evcc/api"
"github.com/evcc-io/evcc/core/loadpoint"
"github.com/evcc-io/evcc/provider"
"github.com/evcc-io/evcc/util"
)

func init() {
registry.Add("switchsocket", NewSwitchSocketFromConfig)
registry.AddCtx("switchsocket", NewSwitchSocketFromConfig)
}

type SwitchSocket struct {
Expand All @@ -17,7 +19,7 @@ type SwitchSocket struct {
*switchSocket
}

func NewSwitchSocketFromConfig(other map[string]interface{}) (api.Charger, error) {
func NewSwitchSocketFromConfig(ctx context.Context, other map[string]interface{}) (api.Charger, error) {
var cc struct {
embed `mapstructure:",squash"`
Enabled provider.Config
Expand All @@ -30,17 +32,17 @@ func NewSwitchSocketFromConfig(other map[string]interface{}) (api.Charger, error
return nil, err
}

enabled, err := provider.NewBoolGetterFromConfig(cc.Enabled)
enabled, err := provider.NewBoolGetterFromConfig(ctx, cc.Enabled)
if err != nil {
return nil, err
}

enable, err := provider.NewBoolSetterFromConfig("enable", cc.Enable)
enable, err := provider.NewBoolSetterFromConfig(ctx, "enable", cc.Enable)
if err != nil {
return nil, err
}

power, err := provider.NewFloatGetterFromConfig(cc.Power)
power, err := provider.NewFloatGetterFromConfig(ctx, cc.Power)
if err != nil {
return nil, err
}
Expand Down
8 changes: 5 additions & 3 deletions charger/template.go
Original file line number Diff line number Diff line change
@@ -1,19 +1,21 @@
package charger

import (
"context"

"github.com/evcc-io/evcc/api"
"github.com/evcc-io/evcc/util/templates"
)

func init() {
registry.Add("template", NewChargerFromTemplateConfig)
registry.AddCtx("template", NewChargerFromTemplateConfig)
}

func NewChargerFromTemplateConfig(other map[string]interface{}) (api.Charger, error) {
func NewChargerFromTemplateConfig(ctx context.Context, other map[string]interface{}) (api.Charger, error) {
instance, err := templates.RenderInstance(templates.Charger, other)
if err != nil {
return nil, err
}

return NewFromConfig(instance.Type, instance.Other)
return NewFromConfig(ctx, instance.Type, instance.Other)
}
3 changes: 2 additions & 1 deletion charger/template_test.go
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
package charger

import (
"context"
"testing"

"github.com/evcc-io/evcc/util/templates"
Expand Down Expand Up @@ -35,7 +36,7 @@ var acceptable = []string{
func TestTemplates(t *testing.T) {
templates.TestClass(t, templates.Charger, func(t *testing.T, values map[string]any) {
t.Helper()
if _, err := NewFromConfig("template", values); err != nil && !test.Acceptable(err, acceptable) {
if _, err := NewFromConfig(context.TODO(), "template", values); err != nil && !test.Acceptable(err, acceptable) {
t.Log(values)
t.Error(err)
}
Expand Down
8 changes: 5 additions & 3 deletions cmd/configure/devicetest.go
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
package configure

import (
"context"
"errors"
"time"

Expand Down Expand Up @@ -68,13 +69,14 @@ func (d *DeviceTest) configure() (interface{}, error) {

var v interface{}

ctx := context.TODO()
switch DeviceCategories[d.DeviceCategory].class {
case templates.Meter:
v, err = meter.NewFromConfig(instance.Type, instance.Other)
v, err = meter.NewFromConfig(ctx, instance.Type, instance.Other)
case templates.Charger:
v, err = charger.NewFromConfig(instance.Type, instance.Other)
v, err = charger.NewFromConfig(ctx, instance.Type, instance.Other)
case templates.Vehicle:
v, err = vehicle.NewFromConfig(instance.Type, instance.Other)
v, err = vehicle.NewFromConfig(ctx, instance.Type, instance.Other)
}

return v, err
Expand Down
27 changes: 18 additions & 9 deletions cmd/setup.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ package cmd

import (
"cmp"
"context"
"errors"
"fmt"
"net/http"
Expand Down Expand Up @@ -219,7 +220,9 @@ func configureMeters(static []config.Named, names ...string) error {
}

eg.Go(func() error {
instance, err := meter.NewFromConfig(cc.Type, cc.Other)
ctx := util.WithLogger(context.TODO(), util.NewLogger(cc.Name))

instance, err := meter.NewFromConfig(ctx, cc.Type, cc.Other)
if err != nil {
return &DeviceError{cc.Name, fmt.Errorf("cannot create meter '%s': %w", cc.Name, err)}
}
Expand All @@ -246,9 +249,9 @@ func configureMeters(static []config.Named, names ...string) error {
return nil
}

// TODO add fake devices
ctx := util.WithLogger(context.TODO(), util.NewLogger(cc.Name))

instance, err := meter.NewFromConfig(cc.Type, cc.Other)
instance, err := meter.NewFromConfig(ctx, cc.Type, cc.Other)
if err != nil {
return &DeviceError{cc.Name, fmt.Errorf("cannot create meter '%s': %w", cc.Name, err)}
}
Expand Down Expand Up @@ -281,7 +284,9 @@ func configureChargers(static []config.Named, names ...string) error {
}

eg.Go(func() error {
instance, err := charger.NewFromConfig(cc.Type, cc.Other)
ctx := util.WithLogger(context.TODO(), util.NewLogger(cc.Name))

instance, err := charger.NewFromConfig(ctx, cc.Type, cc.Other)
if err != nil {
return &DeviceError{cc.Name, fmt.Errorf("cannot create charger '%s': %w", cc.Name, err)}
}
Expand All @@ -308,9 +313,9 @@ func configureChargers(static []config.Named, names ...string) error {
return nil
}

// TODO add fake devices
ctx := util.WithLogger(context.TODO(), util.NewLogger(cc.Name))

instance, err := charger.NewFromConfig(cc.Type, cc.Other)
instance, err := charger.NewFromConfig(ctx, cc.Type, cc.Other)
if err != nil {
return fmt.Errorf("cannot create charger '%s': %w", cc.Name, err)
}
Expand All @@ -327,7 +332,9 @@ func configureChargers(static []config.Named, names ...string) error {
}

func vehicleInstance(cc config.Named) (api.Vehicle, error) {
instance, err := vehicle.NewFromConfig(cc.Type, cc.Other)
ctx := util.WithLogger(context.TODO(), util.NewLogger(cc.Name))

instance, err := vehicle.NewFromConfig(ctx, cc.Type, cc.Other)
if err != nil {
var ce *util.ConfigError
if errors.As(err, &ce) {
Expand Down Expand Up @@ -656,7 +663,7 @@ func configureHEMS(conf config.Typed, site *core.Site, httpd *server.HTTPd) erro
// }
// }

hems, err := hems.NewFromConfig(conf.Type, conf.Other, site, httpd)
hems, err := hems.NewFromConfig(context.TODO(), conf.Type, conf.Other, site, httpd)
if err != nil {
return fmt.Errorf("failed configuring hems: %w", err)
}
Expand Down Expand Up @@ -761,7 +768,9 @@ func configureMessengers(conf globalconfig.Messaging, vehicles push.Vehicles, va
}

func tariffInstance(name string, conf config.Typed) (api.Tariff, error) {
instance, err := tariff.NewFromConfig(conf.Type, conf.Other)
ctx := util.WithLogger(context.TODO(), util.NewLogger(name))

instance, err := tariff.NewFromConfig(ctx, conf.Type, conf.Other)
if err != nil {
var ce *util.ConfigError
if errors.As(err, &ce) {
Expand Down
3 changes: 2 additions & 1 deletion cmd/tariff.go
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
package cmd

import (
"context"
"fmt"
"os"
"text/tabwriter"
Expand Down Expand Up @@ -52,7 +53,7 @@ func runTariff(cmd *cobra.Command, args []string) {
fmt.Println(key + ":")
}

tf, err := tariff.NewFromConfig(cc.Type, cc.Other)
tf, err := tariff.NewFromConfig(context.TODO(), cc.Type, cc.Other)
if err != nil {
fatal(err)
}
Expand Down
5 changes: 3 additions & 2 deletions hems/config.go
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
package hems

import (
"context"
"errors"
"strings"

Expand All @@ -17,14 +18,14 @@ type HEMS interface {
}

// NewFromConfig creates new HEMS from config
func NewFromConfig(typ string, other map[string]interface{}, site site.API, httpd *server.HTTPd) (HEMS, error) {
func NewFromConfig(ctx context.Context, typ string, other map[string]interface{}, site site.API, httpd *server.HTTPd) (HEMS, error) {
switch strings.ToLower(typ) {
case "sma", "shm", "semp":
return semp.New(other, site, httpd)
case "eebus":
return eebus.New(other, site)
case "relay":
return relay.New(other, site)
return relay.New(ctx, other, site)
default:
return nil, errors.New("unknown hems: " + typ)
}
Expand Down
Loading