Add config's full description to the PendingDeviceConfiguration return

This allows to more easily check for what a new value is trying to be set and what kind of value is being set (i.e. a duration, a bool, string etc.)

Author: LucaRoth-EnQS

examples/hems/main.go

@@ -14,7 +14,6 @@ import (
 	"time"
 
 	"github.com/enbility/eebus-go/api"
-	"github.com/enbility/eebus-go/features/server"
 	"github.com/enbility/eebus-go/service"
 	ucapi "github.com/enbility/eebus-go/usecases/api"
 	"github.com/enbility/eebus-go/usecases/cem/vabd"
@@ -94,7 +93,7 @@ func (h *hems) run() {
 	configuration.SetAlternateIdentifier("Demo-HEMS-123456789")
 
 	h.myService = service.NewService(configuration, h)
-	h.myService.SetLogging(h)
+	//h.myService.SetLogging(h)
 
 	if err = h.myService.Setup(); err != nil {
 		fmt.Println(err)
@@ -161,22 +160,9 @@ func (h *hems) OnLPCEvent(ski string, device spineapi.DeviceRemoteInterface, ent
 			h.uccslpc.ApproveOrDenyConsumptionLimit(msgCounter, true, "")
 		}
 		for msgCounter, configs := range pendingDeviceConfigWrites {
-			localEntity := h.myService.LocalDevice().EntityForType(model.EntityTypeTypeCEM)
-			dc, err := server.NewDeviceConfiguration(localEntity)
-			if err != nil {
-				fmt.Println("Not approving LPC device configuration writes because of error:")
-				fmt.Println(err)
-				return
-			}
-			fmt.Printf("Approving LPC device config write with msgCounter %d ", msgCounter)
+			fmt.Printf("Approving LPC device config write with msgCounter %d for features: ", msgCounter)
 			for _, config := range(configs) {
-				description, err := dc.GetKeyValueDescriptionFoKeyId(*config.KeyId)
-				if description == nil || err != nil {
-					fmt.Printf("LPC approving device configuation writes: no device configuration for KeyID %d found\n", *config.KeyId)
-					continue
-				}
-
-				fmt.Printf("including %s ", *description.KeyName)
+				fmt.Printf("%s ", *config.Description.KeyName)
 			}
 			fmt.Print("\n")
 			h.uccslpc.ApproveOrDenyDeviceConfiguration(msgCounter, true, "")
@@ -203,25 +189,12 @@ func (h *hems) OnLPPEvent(ski string, device spineapi.DeviceRemoteInterface, ent
 			h.uccslpp.ApproveOrDenyProductionLimit(msgCounter, true, "")
 		}
 		for msgCounter, configs := range pendingDeviceConfigWrites {
-			localEntity := h.myService.LocalDevice().EntityForType(model.EntityTypeTypeCEM)
-			dc, err := server.NewDeviceConfiguration(localEntity)
-			if err != nil {
-				fmt.Println("Not approving LPC device configuration writes because of error:")
-				fmt.Println(err)
-				return
-			}
-
-			fmt.Printf("Approving LPP device config write with msgCounter %d ", msgCounter)
+			fmt.Printf("Approving LPP device config write with msgCounter %d for features: ", msgCounter)
 			for _, config := range(configs) {
-				description, err := dc.GetKeyValueDescriptionFoKeyId(*config.KeyId)
-				if description == nil || err != nil {
-					fmt.Printf("LPP approving device configuation writes: no device configuration for KeyID %d found\n", *config.KeyId)
-					continue
-				}
-				fmt.Printf("including %s  ", *description.KeyName)
+				fmt.Printf("%s ", *config.Description.KeyName)
 			}
 			fmt.Print("\n")
-			h.uccslpc.ApproveOrDenyDeviceConfiguration(msgCounter, true, "")
+			h.uccslpp.ApproveOrDenyDeviceConfiguration(msgCounter, true, "")
 		}
 	case cslpp.DataUpdateLimit:
 		if currentLimit, err := h.uccslpp.ProductionLimit(); err != nil {

usecases/api/cs_lpc.go

@@ -73,7 +73,7 @@ type CsLPCInterface interface {
 	SetFailsafeDurationMinimum(duration time.Duration, changeable bool) (resultErr error)
 
 	// return the currently pending incoming device configuration writes
-	PendingDeviceConfigurations() map[model.MsgCounterType][]model.DeviceConfigurationKeyValueDataType
+	PendingDeviceConfigurations() map[model.MsgCounterType][]PendingDeviceConfiguration
 
 	// accept or deny an incoming device configuration writes
 	//

usecases/api/cs_lpp.go

@@ -73,7 +73,7 @@ type CsLPPInterface interface {
 	SetFailsafeDurationMinimum(duration time.Duration, changeable bool) (resultErr error)
 
 	// return the currently pending incoming device configuration writes
-	PendingDeviceConfigurations() map[model.MsgCounterType][]model.DeviceConfigurationKeyValueDataType
+	PendingDeviceConfigurations() map[model.MsgCounterType][]PendingDeviceConfiguration
 
 	// accept or deny an incoming device configuration writes
 	//

usecases/api/types.go

@@ -165,4 +165,10 @@ type IncentiveTariffDescription struct {
 type DurationSlotValue struct {
 	Duration time.Duration // Duration of this slot
 	Value    float64       // Energy Cost or Power Limit
+}
+
+type PendingDeviceConfiguration struct {
+	Description     	*model.DeviceConfigurationKeyValueDescriptionDataType     	`json:"description,omitempty"`
+	Value             	*model.DeviceConfigurationKeyValueValueType 				`json:"value,omitempty"`
+	IsValueChangeable 	*bool                                 						`json:"isValueChangeable,omitempty" eebus:"writecheck"`
 }

usecases/cs/lpc/public.go

@@ -267,23 +267,38 @@ func (e *LPC) SetFailsafeDurationMinimum(duration time.Duration, changeable bool
 }
 
 // return the currently pending incoming failsafe consumption limit writes
-func (e *LPC) PendingDeviceConfigurations() map[model.MsgCounterType][]model.DeviceConfigurationKeyValueDataType {
-	result := make(map[model.MsgCounterType][]model.DeviceConfigurationKeyValueDataType)
+func (e *LPC) PendingDeviceConfigurations() map[model.MsgCounterType][]ucapi.PendingDeviceConfiguration {
+	result := make(map[model.MsgCounterType][]ucapi.PendingDeviceConfiguration)
 
 	e.pendingDeviceConfigMux.Lock()
 	defer e.pendingDeviceConfigMux.Unlock()
 
+	dc, err := server.NewDeviceConfiguration(e.LocalEntity)
+	if err != nil {
+		return result
+	}
+
 	for msgCounter, msg := range e.pendingDeviceConfigs {
 		data := msg.Cmd.DeviceConfigurationKeyValueListData
 		for _, configKeyValueData := range data.DeviceConfigurationKeyValueData {
-			if _, exists := result[msgCounter]; exists {
-				result[msgCounter] = append(result[msgCounter], configKeyValueData)
+			description, err := dc.GetKeyValueDescriptionFoKeyId(*configKeyValueData.KeyId)
+			if err != nil {
+				continue
+			}
+			
+			pendingConfigData := ucapi.PendingDeviceConfiguration{
+				Description: description,
+				Value: configKeyValueData.Value,
+				IsValueChangeable: configKeyValueData.IsValueChangeable,
+			}
+
+			if _, exists := result[msgCounter]; !exists {
+				result[msgCounter] = []ucapi.PendingDeviceConfiguration{pendingConfigData}
 			} else {
-				result[msgCounter] = []model.DeviceConfigurationKeyValueDataType{configKeyValueData}
+				result[msgCounter] = append(result[msgCounter], pendingConfigData)
 			}
 		}
 	}
-
 	return result
 }
 

usecases/cs/lpp/public.go

@@ -268,23 +268,38 @@ func (e *LPP) SetFailsafeDurationMinimum(duration time.Duration, changeable bool
 }
 
 // return the currently pending incoming failsafe consumption limit writes
-func (e *LPP) PendingDeviceConfigurations() map[model.MsgCounterType][]model.DeviceConfigurationKeyValueDataType {
-	result := make(map[model.MsgCounterType][]model.DeviceConfigurationKeyValueDataType)
+func (e *LPP) PendingDeviceConfigurations() map[model.MsgCounterType][]ucapi.PendingDeviceConfiguration {
+	result := make(map[model.MsgCounterType][]ucapi.PendingDeviceConfiguration)
 
 	e.pendingDeviceConfigMux.Lock()
 	defer e.pendingDeviceConfigMux.Unlock()
 
+	dc, err := server.NewDeviceConfiguration(e.LocalEntity)
+	if err != nil {
+		return result
+	}
+
 	for msgCounter, msg := range e.pendingDeviceConfigs {
 		data := msg.Cmd.DeviceConfigurationKeyValueListData
 		for _, configKeyValueData := range data.DeviceConfigurationKeyValueData {
-			if _, exists := result[msgCounter]; exists {
-				result[msgCounter] = append(result[msgCounter], configKeyValueData)
+			description, err := dc.GetKeyValueDescriptionFoKeyId(*configKeyValueData.KeyId)
+			if err != nil {
+				continue
+			}
+			
+			pendingConfigData := ucapi.PendingDeviceConfiguration{
+				Description: description,
+				Value: configKeyValueData.Value,
+				IsValueChangeable: configKeyValueData.IsValueChangeable,
+			}
+
+			if _, exists := result[msgCounter]; !exists {
+				result[msgCounter] = []ucapi.PendingDeviceConfiguration{pendingConfigData}
 			} else {
-				result[msgCounter] = []model.DeviceConfigurationKeyValueDataType{configKeyValueData}
+				result[msgCounter] = append(result[msgCounter], pendingConfigData)
 			}
 		}
 	}
-
 	return result
 }