Support SMA Sunny Home Manager as Energy Management System (#353)

andig · web-flow · commit 7eb85ad8b9b5 · 2020-09-20T17:03:39.000+02:00
diff --git a/.gitignore b/.gitignore
@@ -8,3 +8,4 @@ linux-*.Dockerfile
 !evcc.dist.yaml
 !modules/**
 dist
+*.py
diff --git a/README.md b/README.md
@@ -34,6 +34,7 @@ EVCC is an extensible EV Charge Controller with PV integration implemented in [G
   - [Charger](#charger)
   - [Meter](#meter)
   - [Vehicle](#vehicle)
+  - [Home Energy Management System](#home-energy-management-system)
 - [Plugins](#plugins)
   - [Modbus](#modbus-read-only)
   - [MQTT](#mqtt-readwrite)
@@ -216,6 +217,16 @@ Available vehicle implementations are:
 
 Configuration examples are documented at [andig/evcc-config#vehicles](https://github.com/andig/evcc-config#vehicles)
 
+### Home Energy Management System
+
+EVCC can integrate itself with Home Energy Management Systems. At this time, the SMA Home Manager (SHM) is the only supported system. To enable add
+
+```yaml
+hems: sma
+```
+
+to the configuration. The EVCC loadpoints can then be added to the SHM configuration.
+
 ## Plugins
 
 Plugins are used to integrate various devices and external data sources with EVCC. Plugins can be used in combination with a `default` type meter, charger or vehicle.
diff --git a/cmd/config.go b/cmd/config.go
@@ -19,6 +19,7 @@ type config struct {
 	Interval   time.Duration
 	Mqtt       provider.MqttConfig
 	Influx     server.InfluxConfig
+	HEMS       string
 	Menu       []server.MenuConfig
 	Messaging  messagingConfig
 	Meters     []qualifiedConfig
diff --git a/cmd/root.go b/cmd/root.go
@@ -156,6 +156,12 @@ func run(cmd *cobra.Command, args []string) {
 	socketHub := server.NewSocketHub()
 	httpd := server.NewHTTPd(uri, conf.Menu, site, socketHub, cache)
 
+	// start HEMS server
+	if conf.HEMS != "" {
+		hems := configureHEMS(conf.HEMS, site, cache, httpd)
+		go hems.Run()
+	}
+
 	// publish to UI
 	go socketHub.Run(tee.Attach(), cache)
 
diff --git a/cmd/setup.go b/cmd/setup.go
@@ -7,6 +7,7 @@ import (
 	"time"
 
 	"github.com/andig/evcc/core"
+	"github.com/andig/evcc/hems"
 	"github.com/andig/evcc/provider"
 	"github.com/andig/evcc/push"
 	"github.com/andig/evcc/server"
@@ -51,6 +52,16 @@ func configureMQTT(conf provider.MqttConfig) {
 	provider.MQTT = provider.NewMqttClient(conf.Broker, conf.User, conf.Password, mqttClientID(), 1)
 }
 
+// setup HEMS
+func configureHEMS(conf string, site *core.Site, cache *util.Cache, httpd *server.HTTPd) hems.HEMS {
+	hems, err := hems.NewFromConfig(conf, site, cache, httpd)
+	if err != nil {
+		log.FATAL.Fatal(err)
+	}
+	return hems
+}
+
+// setup messaging
 func configureMessengers(conf messagingConfig, cache *util.Cache) chan push.Event {
 	notificationChan := make(chan push.Event, 1)
 	notificationHub := push.NewHub(conf.Events, cache)
diff --git a/core/loadpoint.go b/core/loadpoint.go
@@ -603,7 +603,7 @@ func (lp *LoadPoint) publishSoC() {
 	}
 
 	lp.publish("socCharge", -1)
-	lp.publish("chargeEstimate", -1)
+	lp.publish("chargeEstimate", time.Duration(-1))
 }
 
 // Update is the main control function. It reevaluates meters and charger state
diff --git a/core/site.go b/core/site.go
@@ -146,7 +146,8 @@ func (site *Site) SetTargetSoC(targetSoC int) {
 	}
 }
 
-func (lp *LoadPoint) hasChargeMeter() bool {
+// HasChargeMeter determines if a physical charge meter is attached
+func (lp *LoadPoint) HasChargeMeter() bool {
 	_, isWrapped := lp.chargeMeter.(*wrapper.ChargeMeter)
 	return lp.chargeMeter != nil && !isWrapped
 }
@@ -172,7 +173,7 @@ func (site *Site) Configuration() SiteConfiguration {
 			Phases:      lp.Phases,
 			MinCurrent:  lp.MinCurrent,
 			MaxCurrent:  lp.MaxCurrent,
-			ChargeMeter: lp.hasChargeMeter(),
+			ChargeMeter: lp.HasChargeMeter(),
 		}
 
 		if lp.vehicle != nil {
@@ -215,8 +216,8 @@ func (site *Site) DumpConfig() {
 		lp.log.INFO.Printf("loadpoint %d config:", i+1)
 
 		lp.log.INFO.Printf("  vehicle %s", presence[lp.vehicle != nil])
-		lp.log.INFO.Printf("  charge %s", presence[lp.hasChargeMeter()])
-		if lp.hasChargeMeter() {
+		lp.log.INFO.Printf("  charge %s", presence[lp.HasChargeMeter()])
+		if lp.HasChargeMeter() {
 			lp.log.INFO.Println("  charge meter config:")
 			logMeter(site.log, lp.chargeMeter)
 		}
diff --git a/go.mod b/go.mod
@@ -27,6 +27,8 @@ require (
 	github.com/joeshaw/carwings v0.0.0-20191118152321-61b46581307a
 	github.com/jsgoecke/tesla v0.0.0-20200530171421-e02ebd220e5a
 	github.com/kballard/go-shellquote v0.0.0-20180428030007-95032a82bc51
+	github.com/koron/go-ssdp v0.0.0-20191105050749-2e1c40ed0b5d
+	github.com/kr/pretty v0.2.0 // indirect
 	github.com/lunixbochs/struc v0.0.0-20200707160740-784aaebc1d40
 	github.com/mitchellh/mapstructure v1.3.2
 	github.com/mjibson/esc v0.2.0
@@ -41,6 +43,7 @@ require (
 	github.com/tcnksm/go-latest v0.0.0-20170313132115-e3007ae9052e
 	github.com/volkszaehler/mbmd v0.0.0-20200831092453-b235d6a65b21
 	golang.org/x/net v0.0.0-20200707034311-ab3426394381
+	gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15 // indirect
 	gopkg.in/ini.v1 v1.57.0
 	gopkg.in/yaml.v3 v3.0.0-20200605160147-a5ece683394c
 )
diff --git a/go.sum b/go.sum
@@ -225,10 +225,14 @@ github.com/konsorten/go-windows-terminal-sequences v1.0.2 h1:DB17ag19krx9CFsz4o3
 github.com/konsorten/go-windows-terminal-sequences v1.0.2/go.mod h1:T0+1ngSBFLxvqU3pZ+m/2kptfBszLMUkC4ZK/EgS/cQ=
 github.com/konsorten/go-windows-terminal-sequences v1.0.3 h1:CE8S1cTafDpPvMhIxNJKvHsGVBgn1xWYf1NbHQhywc8=
 github.com/konsorten/go-windows-terminal-sequences v1.0.3/go.mod h1:T0+1ngSBFLxvqU3pZ+m/2kptfBszLMUkC4ZK/EgS/cQ=
+github.com/koron/go-ssdp v0.0.0-20191105050749-2e1c40ed0b5d h1:68u9r4wEvL3gYg2jvAOgROwZ3H+Y3hIDk4tbbmIjcYQ=
+github.com/koron/go-ssdp v0.0.0-20191105050749-2e1c40ed0b5d/go.mod h1:5Ky9EC2xfoUKUor0Hjgi2BJhCSXJfMOFlmyYrVKGQMk=
 github.com/kr/fs v0.1.0/go.mod h1:FFnZGqtBN9Gxj7eW1uZ42v5BccTP0vu6NEaFoC2HwRg=
 github.com/kr/logfmt v0.0.0-20140226030751-b84e30acd515/go.mod h1:+0opPa2QZZtGFBFZlji/RkVcI2GknAs/DXo4wKdlNEc=
 github.com/kr/pretty v0.1.0 h1:L/CwN0zerZDmRFUapSPitk6f+Q3+0za1rQkzVuMiMFI=
 github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo=
+github.com/kr/pretty v0.2.0 h1:s5hAObm+yFO5uHYt5dYjxi2rXrsnmRpJx4OYvIWUaQs=
+github.com/kr/pretty v0.2.0/go.mod h1:ipq/a2n7PKx3OHsz4KJII5eveXtPO4qwEXGdVfWzfnI=
 github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ=
 github.com/kr/text v0.1.0 h1:45sCR5RtlFHMR4UwH9sdQ5TC8v0qDQCHnXt+kaKSTVE=
 github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI=
@@ -569,6 +573,8 @@ gopkg.in/alecthomas/kingpin.v2 v2.2.6/go.mod h1:FMv+mEhP44yOT+4EoQTLFTRgOQ1FBLks
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127 h1:qIbj1fsPNlZgppZ+VLlY7N33q108Sa+fhmuc+sWQYwY=
 gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15 h1:YR8cESwS4TdDjEe65xsg0ogRM/Nc3DYOhEAlW+xobZo=
+gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/errgo.v2 v2.1.0/go.mod h1:hNsd1EY+bozCKY1Ytp96fpM3vjJbqLJn88ws8XvfDNI=
 gopkg.in/fsnotify.v1 v1.4.7 h1:xOHLXZwVvI9hhs+cLKq5+I5onOuwQLhQwiu63xxlHs4=
 gopkg.in/fsnotify.v1 v1.4.7/go.mod h1:Tz8NjZHkW78fSQdbUxIjBTcgA1z1m8ZHf0WmKUhAMys=
diff --git a/hems/config.go b/hems/config.go
@@ -0,0 +1,26 @@
+package hems
+
+import (
+	"errors"
+	"strings"
+
+	"github.com/andig/evcc/core"
+	"github.com/andig/evcc/hems/semp"
+	"github.com/andig/evcc/server"
+	"github.com/andig/evcc/util"
+)
+
+// HEMS describes the HEMS system interface
+type HEMS interface {
+	Run()
+}
+
+// NewFromConfig creates new HEMS from config
+func NewFromConfig(typ string, site *core.Site, cache *util.Cache, httpd *server.HTTPd) (HEMS, error) {
+	switch strings.ToLower(typ) {
+	case "sma", "shm", "semp":
+		return semp.New(site, cache, httpd)
+	default:
+		return nil, errors.New("unknown hems: " + typ)
+	}
+}
diff --git a/hems/semp/helper.go b/hems/semp/helper.go
@@ -0,0 +1,30 @@
+package semp
+
+import "net"
+
+// LocalIPs returns a slice of local IPv4 addresses
+func LocalIPs() []net.IP {
+	ips := make([]net.IP, 0)
+
+	ifaces, err := net.Interfaces()
+	if err != nil {
+		panic(err)
+	}
+
+	for _, i := range ifaces {
+		addrs, err := i.Addrs()
+		if err != nil {
+			panic(err)
+		}
+
+		for _, addr := range addrs {
+			if ip, ok := addr.(*net.IPNet); ok {
+				if !ip.IP.IsLoopback() && ip.IP.To4() != nil {
+					ips = append(ips, ip.IP)
+				}
+			}
+		}
+	}
+
+	return ips
+}
diff --git a/hems/semp/messages.go b/hems/semp/messages.go
@@ -0,0 +1,163 @@
+package semp
+
+import "encoding/xml"
+
+const (
+	urnUPNPDevice  = "urn:schemas-upnp-org:device-1-0"
+	urnSEMPService = "urn:schemas-simple-energy-management-protocol:service-1-0"
+)
+
+type DeviceDescription struct {
+	XMLName     xml.Name    `xml:"root"`
+	Xmlns       string      `xml:"xmlns,attr"`
+	SpecVersion SpecVersion `xml:"specVersion"`
+	Device      Device      `xml:"device"`
+}
+
+type SpecVersion struct {
+	Major int `xml:"major"`
+	Minor int `xml:"minor"`
+}
+
+type Device struct {
+	DeviceType      string      `xml:"deviceType"`
+	FriendlyName    string      `xml:"friendlyName"`
+	Manufacturer    string      `xml:"manufacturer"`
+	ModelName       string      `xml:"modelName"`
+	UDN             string      `xml:"UDN"`
+	PresentationURL string      `xml:"presentationURL"`
+	SEMPService     SEMPService `xml:"semp:X_SEMPSERVICE"`
+	ServiceList     []Service   `xml:"serviceList"` // optional
+}
+
+type Service struct {
+	ServiceType string `xml:"serviceType"`
+	ServiceID   string `xml:"serviceId"`
+	SCPDURL     string `xml:"SCPDURL"`
+	ControlURL  string `xml:"controlURL"`
+	EventSubURL string `xml:"eventSubURL"`
+}
+
+type SEMPService struct {
+	Xmlns          string `xml:"xmlns:semp,attr"`
+	Server         string `xml:"semp:server"`
+	BasePath       string `xml:"semp:basePath"`
+	Transport      string `xml:"semp:transport"`
+	ExchangeFormat string `xml:"semp:exchangeFormat"`
+	WsVersion      string `xml:"semp:wsVersion"`
+}
+
+// Device2EM is the device to EM message
+type Device2EM struct {
+	Xmlns           string            `xml:"xmlns,attr"`
+	DeviceInfo      []DeviceInfo      `xml:",omitempty"`
+	DeviceStatus    []DeviceStatus    `xml:",omitempty"`
+	PlanningRequest []PlanningRequest `xml:",omitempty"`
+}
+
+type DeviceInfo struct {
+	Identification  Identification
+	Characteristics Characteristics
+	Capabilities    Capabilities
+}
+
+type Identification struct {
+	DeviceID     string `xml:"DeviceId"`
+	DeviceName   string
+	DeviceType   string
+	DeviceSerial string
+	DeviceVendor string
+}
+
+type Characteristics struct {
+	MinPowerConsumption int
+	MaxPowerConsumption int
+	MinOnTime           int `xml:",omitempty"`
+	MinOffTime          int `xml:",omitempty"`
+}
+
+type Capabilities struct {
+	CurrentPower  CurrentPower
+	Timestamps    Timestamps
+	Interruptions Interruptions
+	Requests      Requests
+}
+
+const (
+	MethodMeasurement = "Measurement"
+	MethodEstimation  = "Estimation"
+)
+
+type CurrentPower struct {
+	Method string
+}
+
+type Timestamps struct {
+	AbsoluteTimestamps bool
+}
+
+type Interruptions struct {
+	InterruptionsAllowed bool
+}
+
+type Requests struct {
+	OptionalEnergy bool
+}
+
+const (
+	StatusOn  = "On"
+	StatusOff = "Off"
+)
+
+type DeviceStatus struct {
+	DeviceID          string `xml:"DeviceId"`
+	EMSignalsAccepted bool
+	Status            string
+	PowerConsumption  PowerConsumption
+}
+
+type PowerConsumption struct {
+	PowerInfo PowerInfo
+}
+
+type PowerInfo struct {
+	AveragePower      int
+	Timestamp         int
+	AveragingInterval int
+}
+
+type PlanningRequest struct {
+	Timeframe Timeframe
+}
+
+type Timeframe struct {
+	DeviceID       string `xml:"DeviceId"`
+	EarliestStart  int
+	LatestEnd      int
+	MinRunningTime int
+	MaxRunningTime int `xml:",omitempty"`
+}
+
+// EM2Device is the EM to device message
+type EM2Device struct {
+	Xmlns           string            `xml:"xmlns,attr"`
+	DeviceControl   []DeviceControl   `xml:",omitempty"`
+	PlanningRequest []PlanningRequest `xml:",omitempty"`
+}
+
+type DeviceControl struct {
+	DeviceID  string `xml:"DeviceId"`
+	On        bool
+	Timestamp int
+}
+
+// Device2EMMsg is the XML message container
+func Device2EMMsg() Device2EM {
+	msg := Device2EM{
+		Xmlns:        "http://www.sma.de/communication/schema/SEMP/v1",
+		DeviceInfo:   make([]DeviceInfo, 0),
+		DeviceStatus: make([]DeviceStatus, 0),
+	}
+
+	return msg
+}
diff --git a/hems/semp/semp.go b/hems/semp/semp.go
diff --git a/server/http.go b/server/http.go

Original file line number	Diff line number	Diff line change
`@@ -603,7 +603,7 @@ func (lp *LoadPoint) publishSoC() {`
`603`	`603`	`}`
`604`	`604`
`605`	`605`	`lp.publish("socCharge", -1)`
`606`		`- lp.publish("chargeEstimate", -1)`
	`606`	`+ lp.publish("chargeEstimate", time.Duration(-1))`
`607`	`607`	`}`
`608`	`608`
`609`	`609`	`// Update is the main control function. It reevaluates meters and charger state`
Original file line number	Diff line number	Diff line change
`@@ -146,7 +146,8 @@ func (site *Site) SetTargetSoC(targetSoC int) {`
`146`	`146`	`}`
`147`	`147`	`}`
`148`	`148`
`149`		`-func (lp *LoadPoint) hasChargeMeter() bool {`
	`149`	`+// HasChargeMeter determines if a physical charge meter is attached`
	`150`	`+func (lp *LoadPoint) HasChargeMeter() bool {`
`150`	`151`	`_, isWrapped := lp.chargeMeter.(*wrapper.ChargeMeter)`
`151`	`152`	`return lp.chargeMeter != nil && !isWrapped`
`152`	`153`	`}`
`@@ -172,7 +173,7 @@ func (site *Site) Configuration() SiteConfiguration {`
`172`	`173`	`Phases: lp.Phases,`
`173`	`174`	`MinCurrent: lp.MinCurrent,`
`174`	`175`	`MaxCurrent: lp.MaxCurrent,`
`175`		`- ChargeMeter: lp.hasChargeMeter(),`
	`176`	`+ ChargeMeter: lp.HasChargeMeter(),`
`176`	`177`	`}`
`177`	`178`
`178`	`179`	`if lp.vehicle != nil {`
`@@ -215,8 +216,8 @@ func (site *Site) DumpConfig() {`
`215`	`216`	`lp.log.INFO.Printf("loadpoint %d config:", i+1)`
`216`	`217`
`217`	`218`	`lp.log.INFO.Printf(" vehicle %s", presence[lp.vehicle != nil])`
`218`		`- lp.log.INFO.Printf(" charge %s", presence[lp.hasChargeMeter()])`
`219`		`- if lp.hasChargeMeter() {`
	`219`	`+ lp.log.INFO.Printf(" charge %s", presence[lp.HasChargeMeter()])`
	`220`	`+ if lp.HasChargeMeter() {`
`220`	`221`	`lp.log.INFO.Println(" charge meter config:")`
`221`	`222`	`logMeter(site.log, lp.chargeMeter)`
`222`	`223`	`}`