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

Site: remove root circuit configuration #14244

Merged
merged 7 commits into from
Jun 16, 2024
Merged
Show file tree
Hide file tree
Changes from 3 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
32 changes: 20 additions & 12 deletions cmd/setup.go
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@ import (
"github.com/evcc-io/evcc/cmd/shutdown"
"github.com/evcc-io/evcc/core"
"github.com/evcc-io/evcc/core/keys"
"github.com/evcc-io/evcc/core/site"
"github.com/evcc-io/evcc/hems"
"github.com/evcc-io/evcc/meter"
"github.com/evcc-io/evcc/provider/golang"
Expand Down Expand Up @@ -911,34 +910,47 @@ func configureSiteAndLoadpoints(conf *globalconfig.All) (*core.Site, error) {
}

if len(config.Circuits().Devices()) > 0 {
if err := validateCircuits(site, loadpoints); err != nil {
if err := validateCircuits(loadpoints); err != nil {
return nil, &ClassError{ClassCircuit, err}
}
}

return site, nil
}

func validateCircuits(site site.API, loadpoints []*core.Loadpoint) error {
func validateCircuits(loadpoints []*core.Loadpoint) error {
var hasRoot bool

CONTINUE:
for _, dev := range config.Circuits().Devices() {
instance := dev.Instance()

if instance.HasMeter() || site.GetCircuit() == instance {
continue
isRoot := instance.GetParent() == nil
if isRoot {
if hasRoot {
return errors.New("multiple root circuits")
}

hasRoot = true
}

for _, lp := range loadpoints {
if lp.GetCircuit() == instance {
if isRoot {
return fmt.Errorf("root circuit %s cannot be assigned to loadpoint %s", dev.Config().Name, lp.Title())
andig marked this conversation as resolved.
Show resolved Hide resolved
}

continue CONTINUE
}
}

return fmt.Errorf("circuit %s has no meter or loadpoint assigned", dev.Config().Name)
if !instance.HasMeter() {
return fmt.Errorf("circuit %s has no meter or loadpoint assigned", dev.Config().Name)
}
}

if site.GetCircuit() == nil {
return errors.New("site has no circuit")
if !hasRoot {
return errors.New("missing root circuit")
}

return nil
Expand All @@ -955,10 +967,6 @@ func configureSite(conf map[string]interface{}, loadpoints []*core.Loadpoint, ta
return nil, fmt.Errorf("failed configuring site: %w", err)
}

if len(config.Circuits().Devices()) > 0 && site.GetCircuit() == nil {
return nil, errors.New("site has no circuit")
}

return site, nil
}

Expand Down
48 changes: 24 additions & 24 deletions cmd/setup_circuits_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,7 @@ import (

"github.com/evcc-io/evcc/api"
"github.com/evcc-io/evcc/api/globalconfig"
"github.com/evcc-io/evcc/core"
"github.com/evcc-io/evcc/meter"
"github.com/evcc-io/evcc/server/db"
"github.com/evcc-io/evcc/tariff"
"github.com/evcc-io/evcc/util/config"
"github.com/stretchr/testify/suite"
"go.uber.org/mock/gomock"
Expand Down Expand Up @@ -94,47 +91,50 @@ loadpoints:
lps, err := configureLoadpoints(conf)
suite.Require().NoError(err)

site := core.NewSite()
circuit.EXPECT().HasMeter().Return(false)
suite.Require().Error(validateCircuits(site, lps))
// root circuit
circuit.EXPECT().GetParent().Return(nil)
circuit.EXPECT().HasMeter().Return(true)
suite.Require().NoError(validateCircuits(lps))

// no root circuit
circuit.EXPECT().GetParent().Return(circuit)
circuit.EXPECT().HasMeter().Return(true)
err = validateCircuits(lps)
suite.Require().Error(err)
suite.Require().Equal("missing root circuit", err.Error())
}

func (suite *circuitsTestSuite) TestSiteMissingCircuitError() {
func (suite *circuitsTestSuite) TestLoadpointUsingRootCircuit() {
var conf globalconfig.All
viper.SetConfigType("yaml")

suite.Require().NoError(viper.ReadConfig(strings.NewReader(`
loadpoints:
- charger: test
site:
meters:
grid: grid
circuit: root
`)))

suite.Require().NoError(viper.UnmarshalExact(&conf))

lps := []*core.Loadpoint{
new(core.Loadpoint),
}
ctrl := gomock.NewController(suite.T())
circuit := api.NewMockCircuit(ctrl)

// mock circuit
suite.Require().NoError(config.Circuits().Add(config.NewStaticDevice(config.Named{
Name: "test",
}, api.Circuit(nil))))

// mock meter
m, _ := meter.NewConfigurable(func() (float64, error) {
return 0, nil
})
suite.Require().NoError(config.Meters().Add(config.NewStaticDevice(config.Named{
Name: "grid",
}, api.Meter(m))))
Name: "root",
}, api.Circuit(circuit))))

// mock charger
suite.Require().NoError(config.Chargers().Add(config.NewStaticDevice(config.Named{
Name: "test",
}, api.Charger(nil))))

_, err := configureSite(conf.Site, lps, new(tariff.Tariffs))
lps, err := configureLoadpoints(conf)
suite.Require().NoError(err)

// root circuit
circuit.EXPECT().GetParent().Return(nil)
err = validateCircuits(lps)
suite.Require().Error(err)
suite.Require().Equal("root circuit root cannot be assigned to loadpoint ", err.Error())
}
15 changes: 15 additions & 0 deletions core/circuit/config.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
package circuit

import (
"github.com/evcc-io/evcc/api"
"github.com/evcc-io/evcc/util/config"
)

func Root() api.Circuit {
for _, dev := range config.Circuits().Devices() {
if c := dev.Instance(); c.GetParent() == nil {
return c
}
}
return nil
}
12 changes: 5 additions & 7 deletions core/site.go
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ import (
"github.com/cenkalti/backoff/v4"
"github.com/evcc-io/evcc/api"
"github.com/evcc-io/evcc/cmd/shutdown"
"github.com/evcc-io/evcc/core/circuit"
"github.com/evcc-io/evcc/core/coordinator"
"github.com/evcc-io/evcc/core/keys"
"github.com/evcc-io/evcc/core/loadpoint"
Expand Down Expand Up @@ -69,7 +70,8 @@ type Site struct {
Voltage float64 `mapstructure:"voltage"` // Operating voltage. 230V for Germany.
ResidualPower float64 `mapstructure:"residualPower"` // PV meter only: household usage. Grid meter: household safety margin
Meters MetersConfig `mapstructure:"meters"` // Meter references
CircuitRef string `mapstructure:"circuit"` // Circuit reference
// TODO deprecated
CircuitRef_ string `mapstructure:"circuit"` // Circuit reference

MaxGridSupplyWhileBatteryCharging float64 `mapstructure:"maxGridSupplyWhileBatteryCharging"` // ignore battery charging if AC consumption is above this value

Expand Down Expand Up @@ -170,12 +172,8 @@ func (site *Site) Boot(log *util.Logger, loadpoints []*Loadpoint, tariffs *tarif
}

// circuit
if site.CircuitRef != "" {
dev, err := config.Circuits().ByName(site.CircuitRef)
if err != nil {
return err
}
site.circuit = dev.Instance()
if c := circuit.Root(); c != nil {
site.circuit = c
}

// grid meter
Expand Down
Loading