Simplify service configuration and add voltage

Author: DerAndereAndi

README.md

@@ -241,6 +241,7 @@ Use `SetLogger` on `Service` to set the logger which needs to conform to the `lo
 Example:
 
 ```go
-h.myService = service.NewEEBUSService(serviceDescription, h)
+configuration = service.NewConfiguration(...)
+h.myService = service.NewEEBUSService(configuration, h)
 h.myService.SetLogging(h)
 ```

cmd/evse/main.go

@@ -60,15 +60,15 @@ func (h *evse) run() {
 		log.Fatal(err)
 	}
 
-	serviceDescription, err := service.NewServiceDescription(
+	configuration, err := service.NewConfiguration(
 		"Demo", "Demo", "EVSE", "234567890",
-		model.DeviceTypeTypeChargingStation, port, certificate)
+		model.DeviceTypeTypeChargingStation, port, certificate, 230)
 	if err != nil {
 		log.Fatal(err)
 	}
-	serviceDescription.SetAlternateIdentifier("Demo-EVSE-234567890")
+	configuration.SetAlternateIdentifier("Demo-EVSE-234567890")
 
-	h.myService = service.NewEEBUSService(serviceDescription, h)
+	h.myService = service.NewEEBUSService(configuration, h)
 	h.myService.SetLogging(h)
 
 	if err = h.myService.Setup(); err != nil {

cmd/hems/main.go

@@ -60,15 +60,15 @@ func (h *hems) run() {
 		log.Fatal(err)
 	}
 
-	serviceDescription, err := service.NewServiceDescription(
+	configuration, err := service.NewConfiguration(
 		"Demo", "Demo", "HEMS", "123456789",
-		model.DeviceTypeTypeEnergyManagementSystem, port, certificate)
+		model.DeviceTypeTypeEnergyManagementSystem, port, certificate, 230)
 	if err != nil {
 		log.Fatal(err)
 	}
-	serviceDescription.SetAlternateIdentifier("Demo-HEMS-123456789")
+	configuration.SetAlternateIdentifier("Demo-HEMS-123456789")
 
-	h.myService = service.NewEEBUSService(serviceDescription, h)
+	h.myService = service.NewEEBUSService(configuration, h)
 	h.myService.SetLogging(h)
 
 	if err = h.myService.Setup(); err != nil {

service/hub.go

@@ -65,8 +65,8 @@ type connectionsHub struct {
 	connectionAttemptCounter map[string]int
 	connectionAttemptRunning map[string]bool
 
-	serviceDescription *ServiceDescription
-	localService       *ServiceDetails
+	configuration *Configuration
+	localService  *ServiceDetails
 
 	serviceProvider serviceProvider
 
@@ -88,21 +88,21 @@ type connectionsHub struct {
 	muxMdns       sync.Mutex
 }
 
-func newConnectionsHub(serviceProvider serviceProvider, spineLocalDevice *spine.DeviceLocalImpl, serviceDescription *ServiceDescription, localService *ServiceDetails) (*connectionsHub, error) {
+func newConnectionsHub(serviceProvider serviceProvider, spineLocalDevice *spine.DeviceLocalImpl, configuration *Configuration, localService *ServiceDetails) (*connectionsHub, error) {
 	hub := &connectionsHub{
 		connections:              make(map[string]*ship.ShipConnection),
 		connectionAttemptCounter: make(map[string]int),
 		connectionAttemptRunning: make(map[string]bool),
 		pairedServices:           make([]ServiceDetails, 0),
 		serviceProvider:          serviceProvider,
 		spineLocalDevice:         spineLocalDevice,
-		serviceDescription:       serviceDescription,
+		configuration:            configuration,
 		localService:             localService,
 	}
 
 	localService.SKI = util.NormalizeSKI(localService.SKI)
 
-	mdns, err := newMDNS(localService.SKI, serviceDescription)
+	mdns, err := newMDNS(localService.SKI, configuration)
 	if err != nil {
 		return nil, err
 	}
@@ -251,14 +251,14 @@ func (h *connectionsHub) isSkiConnected(ski string) bool {
 
 // start the ship websocket server
 func (h *connectionsHub) startWebsocketServer() error {
-	addr := fmt.Sprintf(":%d", h.serviceDescription.port)
+	addr := fmt.Sprintf(":%d", h.configuration.port)
 	logging.Log.Debug("starting websocket server on", addr)
 
 	h.httpServer = &http.Server{
 		Addr:    addr,
 		Handler: h,
 		TLSConfig: &tls.Config{
-			Certificates: []tls.Certificate{h.serviceDescription.certificate},
+			Certificates: []tls.Certificate{h.configuration.certificate},
 			ClientAuth:   tls.RequireAnyClientCert, // SHIP 9: Client authentication is required
 			CipherSuites: ciperSuites,
 			VerifyPeerCertificate: func(rawCerts [][]byte, verifiedChains [][]*x509.Certificate) error {
@@ -372,7 +372,7 @@ func (h *connectionsHub) connectFoundService(remoteService *ServiceDetails, host
 		Proxy:            http.ProxyFromEnvironment,
 		HandshakeTimeout: 5 * time.Second,
 		TLSClientConfig: &tls.Config{
-			Certificates:       []tls.Certificate{h.serviceDescription.certificate},
+			Certificates:       []tls.Certificate{h.configuration.certificate},
 			InsecureSkipVerify: true,
 			CipherSuites:       ciperSuites,
 		},

service/mdns.go

@@ -34,8 +34,8 @@ type MdnsSearch interface {
 }
 
 type mdns struct {
-	serviceDescription *ServiceDescription
-	ski                string
+	configuration *Configuration
+	ski           string
 
 	isAnnounced         bool
 	isSearchingServices bool
@@ -58,12 +58,12 @@ type mdns struct {
 	mux sync.Mutex
 }
 
-func newMDNS(ski string, serviceDescription *ServiceDescription) (*mdns, error) {
+func newMDNS(ski string, configuration *Configuration) (*mdns, error) {
 	m := &mdns{
-		ski:                ski,
-		serviceDescription: serviceDescription,
-		entries:            make(map[string]MdnsEntry),
-		cancelChan:         make(chan bool),
+		ski:           ski,
+		configuration: configuration,
+		entries:       make(map[string]MdnsEntry),
+		cancelChan:    make(chan bool),
 	}
 
 	if av, err := m.setupAvahi(); err == nil {
@@ -112,10 +112,10 @@ func (m *mdns) interfaces() ([]net.Interface, []int32, error) {
 	var ifaces []net.Interface
 	var ifaceIndexes []int32
 
-	if len(m.serviceDescription.interfaces) > 0 {
-		ifaces = make([]net.Interface, len(m.serviceDescription.interfaces))
-		ifaceIndexes = make([]int32, len(m.serviceDescription.interfaces))
-		for i, ifaceName := range m.serviceDescription.interfaces {
+	if len(m.configuration.interfaces) > 0 {
+		ifaces = make([]net.Interface, len(m.configuration.interfaces))
+		ifaceIndexes = make([]int32, len(m.configuration.interfaces))
+		for i, ifaceName := range m.configuration.interfaces {
 			iface, err := net.InterfaceByName(ifaceName)
 			if err != nil {
 				return nil, nil, err
@@ -146,26 +146,26 @@ func (m *mdns) Announce() error {
 		return err
 	}
 
-	serviceIdentifier := m.serviceDescription.Identifier()
+	serviceIdentifier := m.configuration.Identifier()
 
 	txt := []string{ // SHIP 7.3.2
 		"txtvers=1",
 		"path=" + shipWebsocketPath,
 		"id=" + serviceIdentifier,
 		"ski=" + m.ski,
-		"brand=" + m.serviceDescription.deviceBrand,
-		"model=" + m.serviceDescription.deviceModel,
-		"type=" + string(m.serviceDescription.deviceType),
-		"register=" + fmt.Sprintf("%v", m.serviceDescription.registerAutoAccept),
+		"brand=" + m.configuration.deviceBrand,
+		"model=" + m.configuration.deviceModel,
+		"type=" + string(m.configuration.deviceType),
+		"register=" + fmt.Sprintf("%v", m.configuration.registerAutoAccept),
 	}
 
 	logging.Log.Debug("mdns: announce")
 
-	serviceName := m.serviceDescription.MdnsServiceName()
+	serviceName := m.configuration.MdnsServiceName()
 
 	if m.av == nil {
 		// use Zeroconf library if avahi is not available
-		mDNSServer, err := zeroconf.Register(serviceName, shipZeroConfServiceType, shipZeroConfDomain, m.serviceDescription.port, txt, ifaces)
+		mDNSServer, err := zeroconf.Register(serviceName, shipZeroConfServiceType, shipZeroConfDomain, m.configuration.port, txt, ifaces)
 		if err == nil {
 			m.zc = mDNSServer
 
@@ -188,7 +188,7 @@ func (m *mdns) Announce() error {
 	}
 
 	for _, iface := range ifaceIndexes {
-		err = entryGroup.AddService(iface, avahi.ProtoUnspec, 0, serviceName, shipZeroConfServiceType, shipZeroConfDomain, "", uint16(m.serviceDescription.port), btxt)
+		err = entryGroup.AddService(iface, avahi.ProtoUnspec, 0, serviceName, shipZeroConfServiceType, shipZeroConfDomain, "", uint16(m.configuration.port), btxt)
 		if err != nil {
 			return err
 		}

service/service.go

@@ -29,7 +29,7 @@ type EEBUSServiceHandler interface {
 // A service is the central element of an EEBUS service
 // including its websocket server and a zeroconf service.
 type EEBUSService struct {
-	ServiceDescription *ServiceDescription
+	Configuration *Configuration
 
 	// The local service details
 	LocalService *ServiceDetails
@@ -46,10 +46,10 @@ type EEBUSService struct {
 }
 
 // creates a new EEBUS service
-func NewEEBUSService(ServiceDescription *ServiceDescription, serviceHandler EEBUSServiceHandler) *EEBUSService {
+func NewEEBUSService(configuration *Configuration, serviceHandler EEBUSServiceHandler) *EEBUSService {
 	return &EEBUSService{
-		ServiceDescription: ServiceDescription,
-		serviceHandler:     serviceHandler,
+		Configuration:  configuration,
+		serviceHandler: serviceHandler,
 	}
 }
 
@@ -81,11 +81,11 @@ func (s *EEBUSService) SetLogging(logger logging.Logging) {
 
 // Starts the service by initializeing mDNS and the server.
 func (s *EEBUSService) Setup() error {
-	if s.ServiceDescription.port == 0 {
-		s.ServiceDescription.port = defaultPort
+	if s.Configuration.port == 0 {
+		s.Configuration.port = defaultPort
 	}
 
-	sd := s.ServiceDescription
+	sd := s.Configuration
 
 	leaf, err := x509.ParseCertificate(sd.certificate.Certificate[0])
 	if err != nil {
@@ -155,7 +155,7 @@ func (s *EEBUSService) Setup() error {
 	s.spineLocalDevice.AddEntity(entity)
 
 	// Setup connections hub with mDNS and websocket connection handling
-	hub, err := newConnectionsHub(s, s.spineLocalDevice, s.ServiceDescription, s.LocalService)
+	hub, err := newConnectionsHub(s, s.spineLocalDevice, s.Configuration, s.LocalService)
 	if err != nil {
 		return err
 	}

service/types.go

@@ -34,7 +34,7 @@ type ServiceDetails struct {
 }
 
 // defines requires meta information about this service
-type ServiceDescription struct {
+type Configuration struct {
 	// The vendors IANA PEN, optional but highly recommended.
 	// If not set, brand will be used instead
 	// Used for the Device Address: SPINE - Protocol Specification 7.1.1.2
@@ -90,93 +90,100 @@ type ServiceDescription struct {
 	// the spec defines that this should have a timeout and be activate
 	// e.g via a physical button
 	registerAutoAccept bool
+
+	// The sites grid voltage
+	// This is useful when e.g. power values are not available and therefor
+	// need to be calculated using the current values
+	voltage float64
 }
 
-// Setup a ServiceDescription with the required parameters
-func NewServiceDescription(
+// Setup a Configuration with the required parameters
+func NewConfiguration(
 	vendorCode,
 	deviceBrand,
 	deviceModel,
 	serialNumber string,
 	deviceType model.DeviceTypeType,
 	port int,
 	certificate tls.Certificate,
-) (*ServiceDescription, error) {
-	serviceDescription := &ServiceDescription{
+	voltage float64,
+) (*Configuration, error) {
+	configuration := &Configuration{
 		certificate: certificate,
 		port:        port,
+		voltage:     voltage,
 	}
 
 	isRequired := "is required"
 
 	if len(vendorCode) == 0 {
 		return nil, fmt.Errorf("vendorCode %s", isRequired)
 	} else {
-		serviceDescription.vendorCode = vendorCode
+		configuration.vendorCode = vendorCode
 	}
 	if len(deviceBrand) == 0 {
 		return nil, fmt.Errorf("brand %s", isRequired)
 	} else {
-		serviceDescription.deviceBrand = deviceBrand
+		configuration.deviceBrand = deviceBrand
 	}
 	if len(deviceModel) == 0 {
 		return nil, fmt.Errorf("model %s", isRequired)
 	} else {
-		serviceDescription.deviceModel = deviceModel
+		configuration.deviceModel = deviceModel
 	}
 	if len(serialNumber) == 0 {
 		return nil, fmt.Errorf("serialNumber %s", isRequired)
 	} else {
-		serviceDescription.deviceSerialNumber = serialNumber
+		configuration.deviceSerialNumber = serialNumber
 	}
 	if len(deviceType) == 0 {
 		return nil, fmt.Errorf("deviceType %s", isRequired)
 	} else {
-		serviceDescription.deviceType = deviceType
+		configuration.deviceType = deviceType
 	}
 
 	// set default
-	serviceDescription.featureSet = model.NetworkManagementFeatureSetTypeSmart
+	configuration.featureSet = model.NetworkManagementFeatureSetTypeSmart
 
-	return serviceDescription, nil
+	return configuration, nil
 }
 
 // define an alternative mDNS and SHIP identifier
 // usually this is only used when no deviceCode is available or identical to the brand
 // if this is not set, generated identifier is used
-func (s *ServiceDescription) SetAlternateIdentifier(identifier string) {
+func (s *Configuration) SetAlternateIdentifier(identifier string) {
 	s.alternateIdentifier = identifier
 }
 
 // define an alternative mDNS service name
 // this is normally not needed or used
-func (s *ServiceDescription) SetAlternateMdnsServiceName(name string) {
+func (s *Configuration) SetAlternateMdnsServiceName(name string) {
 	s.alternateMdnsServiceName = name
 }
 
 // define which network interfaces should be considered instead of all existing
 // expects a list of network interface names
-func (s *ServiceDescription) SetInterfaces(ifaces []string) {
+func (s *Configuration) SetInterfaces(ifaces []string) {
 	s.interfaces = ifaces
 }
 
 // define wether this service should announce auto accept
 // TODO: this needs to be redesigned!
-func (s *ServiceDescription) SetRegisterAutoAccept(auto bool) {
+func (s *Configuration) SetRegisterAutoAccept(auto bool) {
 	s.registerAutoAccept = auto
 }
 
 // generates a standard identifier used for mDNS ID and SHIP ID
 // Brand-Model-SerialNumber
-func (s *ServiceDescription) generateIdentifier() string {
+func (s *Configuration) generateIdentifier() string {
 	return fmt.Sprintf("%s-%s-%s", s.deviceBrand, s.deviceModel, s.deviceSerialNumber)
 }
 
 // return the identifier to be used for mDNS and SHIP ID
 // returns in this order:
 // - alternateIdentifier
 // - generateIdentifier
-func (s *ServiceDescription) Identifier() string {
+func (s *Configuration) Identifier() string {
 	// SHIP identifier is identical to the mDNS ID
 	if len(s.alternateIdentifier) > 0 {
 		return s.alternateIdentifier
@@ -189,11 +196,16 @@ func (s *ServiceDescription) Identifier() string {
 // returns in this order:
 // - alternateMdnsServiceName
 // - generateIdentifier
-func (s *ServiceDescription) MdnsServiceName() string {
+func (s *Configuration) MdnsServiceName() string {
 	// SHIP identifier is identical to the mDNS ID
 	if len(s.alternateMdnsServiceName) > 0 {
 		return s.alternateMdnsServiceName
 	}
 
 	return s.generateIdentifier()
 }
+
+// return the sites predefined grid voltage
+func (s *Configuration) Voltage() float64 {
+	return s.voltage
+}