Add HvacOperationModeType to usecase types

Author: David Sapir

usecases/api/ca_cdt.go

@@ -3,34 +3,33 @@ package api
 import (
 	"github.com/enbility/eebus-go/api"
 	spineapi "github.com/enbility/spine-go/api"
-	"github.com/enbility/spine-go/model"
 )
 
 type CaCDTInterface interface {
 	api.UseCaseInterface
 
 	// Scenario 1
 
-	// Return the current setpoints data
+	// Return the setpoints.
 	//
 	// parameters:
 	//   - entity: the entity to get the setpoints data from
 	//
 	// return values:
-	//   - setpoints: A map of the setpoints for supported modes
+	//   - setpoints: A list of setpoints
 	//
 	// possible errors:
 	//   - ErrDataNotAvailable if no such limit is (yet) available
 	//   - and others
 	Setpoints(entity spineapi.EntityRemoteInterface) ([]Setpoint, error)
 
-	// Return the constraints for the setpoints
+	// Return the constraints for the setpoints.
 	//
 	// parameters:
 	//   - entity: the entity to get the setpoints constraints from
 	//
 	// return values:
-	//   - setpointConstraints: A map of the constraints for supported modes
+	//   - setpointConstraints: A list of setpoint constraints
 	//
 	// possible errors:
 	//   - ErrDataNotAvailable if no such limit is (yet) available
@@ -42,6 +41,6 @@ type CaCDTInterface interface {
 	// parameters:
 	//   - entity: the entity to write the setpoint to
 	//   - mode: the mode to write the setpoint for
-	//   - degC: the temperature setpoint value to write
-	WriteSetpoint(entity spineapi.EntityRemoteInterface, mode model.HvacOperationModeTypeType, degC float64) error
+	//   - temperature: the temperature setpoint value to write
+	WriteSetpoint(entity spineapi.EntityRemoteInterface, mode HvacOperationModeType, temperature float64) error
 }

usecases/api/types.go

@@ -17,6 +17,15 @@ const (
 	EVChargeStateTypeFinished  EVChargeStateType = "finished"
 )
 
+type HvacOperationModeType string
+
+const (
+	HvacOperationModeTypeAuto HvacOperationModeType = "auto"
+	HvacOperationModeTypeOn   HvacOperationModeType = "on"
+	HvacOperationModeTypeOff  HvacOperationModeType = "off"
+	HvacOperationModeTypeEco  HvacOperationModeType = "eco"
+)
+
 // Defines a phase specific limit data set
 type LoadLimitsPhase struct {
 	Phase        model.ElectricalConnectionPhaseNameType // the phase

usecases/ca/cdt/public.go

@@ -194,10 +194,10 @@ func (e *CDT) mapSetpointsToModes(entity spineapi.EntityRemoteInterface) error {
 //   - Other errors: Any other errors encountered during the process.
 func (e *CDT) WriteSetpoint(
 	entity spineapi.EntityRemoteInterface,
-	mode model.HvacOperationModeTypeType,
+	mode usecasesapi.HvacOperationModeType,
 	temperature float64,
 ) error {
-	if mode == model.HvacOperationModeTypeTypeAuto {
+	if model.HvacOperationModeTypeType(mode) == model.HvacOperationModeTypeTypeAuto {
 		// 'Auto' mode is controlled by a timetable, meaning the current setpoint
 		// for the HVAC system function changes according to the timetable.
 		// Only the 'Off', 'On', and 'Eco' modes can be directly controlled by a setpoint.
@@ -208,7 +208,7 @@ func (e *CDT) WriteSetpoint(
 		return api.ErrDataNotAvailable
 	}
 
-	setpointId, found := e.modes[mode]
+	setpointId, found := e.modes[model.HvacOperationModeTypeType(mode)]
 	if !found {
 		return api.ErrDataNotAvailable
 	}