package client import ( "errors" "fmt" "github.com/enbility/eebus-go/api" spineapi "github.com/enbility/spine-go/api" "github.com/enbility/spine-go/model" ) type Feature struct { featureType model.FeatureTypeType localRole model.RoleType remoteRole model.RoleType spineLocalDevice spineapi.DeviceLocalInterface localEntity spineapi.EntityLocalInterface featureLocal spineapi.FeatureLocalInterface featureRemote spineapi.FeatureRemoteInterface remoteDevice spineapi.DeviceRemoteInterface remoteEntity spineapi.EntityRemoteInterface } var _ api.FeatureClientInterface = (*Feature)(nil) func NewFeature( featureType model.FeatureTypeType, localEntity spineapi.EntityLocalInterface, remoteEntity spineapi.EntityRemoteInterface) (*Feature, error) { if localEntity == nil { return nil, errors.New("local entity is nil") } if remoteEntity == nil { return nil, errors.New("remote entity is nil") } f := &Feature{ featureType: featureType, localRole: model.RoleTypeClient, remoteRole: model.RoleTypeServer, spineLocalDevice: localEntity.Device(), localEntity: localEntity, remoteDevice: remoteEntity.Device(), remoteEntity: remoteEntity, } var err error f.featureLocal, f.featureRemote, err = f.getLocalAndRemoteFeatures() return f, err } // check if there is a subscription to the remote feature func (f *Feature) HasSubscription() bool { subscription := f.featureLocal.HasSubscriptionToRemote(f.featureRemote.Address()) return subscription } // subscribe to the feature of the entity func (f *Feature) Subscribe() (*model.MsgCounterType, error) { msgCounter, fErr := f.featureLocal.SubscribeToRemote(f.featureRemote.Address()) if fErr != nil { return nil, errors.New(fErr.String()) } return msgCounter, nil } // unssubscribe to the feature of the entity func (f *Feature) Unsubscribe() (*model.MsgCounterType, error) { msgCounter, fErr := f.featureLocal.RemoveRemoteSubscription(f.featureRemote.Address()) if fErr != nil { return nil, errors.New(fErr.String()) } return msgCounter, nil } // check if there is a binding to the remote feature func (f *Feature) HasBinding() bool { binding := f.featureLocal.HasBindingToRemote(f.featureRemote.Address()) return binding } // bind to the feature of the entity func (f *Feature) Bind() (*model.MsgCounterType, error) { msgCounter, fErr := f.featureLocal.BindToRemote(f.featureRemote.Address()) if fErr != nil { return nil, errors.New(fErr.String()) } return msgCounter, nil } // remove a binding to the feature of the entity func (f *Feature) Unbind() (*model.MsgCounterType, error) { msgCounter, fErr := f.featureLocal.RemoveRemoteBinding(f.featureRemote.Address()) if fErr != nil { return nil, errors.New(fErr.String()) } return msgCounter, nil } // add a callback function to be invoked once a result or reply message for a msgCounter came in func (f *Feature) AddResponseCallback( msgCounterReference model.MsgCounterType, function func(msg spineapi.ResponseMessage)) error { return f.featureLocal.AddResponseCallback(msgCounterReference, function) } // add a callback function to be invoked once a result came in func (f *Feature) AddResultCallback(function func(msg spineapi.ResponseMessage)) { f.featureLocal.AddResultCallback(function) } // helper method which adds checking if the feature is available and the operation is allowed // selectors and elements are used if specific data should be requested by using // model.FilterType DataSelectors (selectors) and/or DataElements (elements) // both should use the proper data types for the used function // // Note: selectors and elements have to be pointers! func (f *Feature) requestData(function model.FunctionType, selectors any, elements any) (*model.MsgCounterType, error) { if f.featureRemote == nil { return nil, api.ErrDataNotAvailable } fTypes := f.featureRemote.Operations() op, exists := fTypes[function] if !exists || !op.Read() { errWithFunction := fmt.Sprintf("%s %s", api.ErrOperationOnFunctionNotSupported.Error(), function) return nil, errors.New(errWithFunction) } // remove the selectors if the remote does not allow partial reads // or partial writes, because in that case we need to have all data if selectors != nil && (!op.ReadPartial() || !op.WritePartial()) { selectors = nil elements = nil } msgCounter, fErr := f.featureLocal.RequestRemoteData(function, selectors, elements, f.featureRemote) if fErr != nil { return nil, errors.New(fErr.String()) } return msgCounter, nil } // internal helper method for getting local and remote feature for a given featureType and a given remoteDevice func (f *Feature) getLocalAndRemoteFeatures() ( spineapi.FeatureLocalInterface, spineapi.FeatureRemoteInterface, error) { featureLocal := f.localEntity.FeatureOfTypeAndRole(f.featureType, f.localRole) if featureLocal == nil { featureLocal = f.localEntity.FeatureOfTypeAndRole(model.FeatureTypeTypeGeneric, f.localRole) } if featureLocal == nil { return nil, nil, errors.New("local feature not found") } featureRemote := f.remoteEntity.Device().FeatureByEntityTypeAndRole(f.remoteEntity, f.featureType, f.remoteRole) if featureRemote == nil { return nil, nil, errors.New("remote feature not found") } return featureLocal, featureRemote, nil }