internal

package
v0.7.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 21, 2024 License: MIT Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var PhaseNameMapping = []model.ElectricalConnectionPhaseNameType{
	model.ElectricalConnectionPhaseNameTypeA,
	model.ElectricalConnectionPhaseNameTypeB,
	model.ElectricalConnectionPhaseNameTypeC}

Functions

This section is empty.

Types

type DeviceClassificationCommon 

type DeviceClassificationCommon struct {
	// contains filtered or unexported fields
}

func NewLocalDeviceClassification 

func NewLocalDeviceClassification(featureLocal spineapi.FeatureLocalInterface) *DeviceClassificationCommon

func NewRemoteDeviceClassification 

func NewRemoteDeviceClassification(featureRemote spineapi.FeatureRemoteInterface) *DeviceClassificationCommon

func (*DeviceClassificationCommon) GetManufacturerDetails 

func (d *DeviceClassificationCommon) GetManufacturerDetails() (*model.DeviceClassificationManufacturerDataType, error)

get the current manufacturer details for a remote device entity

type DeviceConfigurationCommon 

type DeviceConfigurationCommon struct {
	// contains filtered or unexported fields
}

func NewLocalDeviceConfiguration 

func NewLocalDeviceConfiguration(featureLocal spineapi.FeatureLocalInterface) *DeviceConfigurationCommon

func NewRemoteDeviceConfiguration 

func NewRemoteDeviceConfiguration(featureRemote spineapi.FeatureRemoteInterface) *DeviceConfigurationCommon

func (*DeviceConfigurationCommon) CheckEventPayloadDataForFilter 

func (d *DeviceConfigurationCommon) CheckEventPayloadDataForFilter(payloadData any, filter any) bool

check if spine.EventPayload Data contains data for a given filter

data type will be checked for model.DeviceConfigurationKeyValueListDataType, filter type will be checked for model.DeviceConfigurationKeyValueDescriptionDataType

func (*DeviceConfigurationCommon) GetKeyValueDataForFilter 

func (d *DeviceConfigurationCommon) GetKeyValueDataForFilter(filter model.DeviceConfigurationKeyValueDescriptionDataType) (
	*model.DeviceConfigurationKeyValueDataType, error)

Get key value data for a given filter

Will return nil if no data is available

func (*DeviceConfigurationCommon) GetKeyValueDataForKeyId 

func (d *DeviceConfigurationCommon) GetKeyValueDataForKeyId(keyId model.DeviceConfigurationKeyIdType) (
	*model.DeviceConfigurationKeyValueDataType, error)

Get the key value data for a given keyId

Will return nil if no data is available

func (*DeviceConfigurationCommon) GetKeyValueDescriptionFoKeyId 

func (d *DeviceConfigurationCommon) GetKeyValueDescriptionFoKeyId(keyId model.DeviceConfigurationKeyIdType) (
	*model.DeviceConfigurationKeyValueDescriptionDataType, error)

Get the description for a given keyId

Will return nil if no matching description is found

func (*DeviceConfigurationCommon) GetKeyValueDescriptionsForFilter 

func (d *DeviceConfigurationCommon) GetKeyValueDescriptionsForFilter(
	filter model.DeviceConfigurationKeyValueDescriptionDataType,
) ([]model.DeviceConfigurationKeyValueDescriptionDataType, error)

Get the description for a given value combination

Returns an error if no matching description is found

type DeviceDiagnosisCommon 

type DeviceDiagnosisCommon struct {
	// contains filtered or unexported fields
}

func NewLocalDeviceDiagnosis 

func NewLocalDeviceDiagnosis(featureLocal spineapi.FeatureLocalInterface) *DeviceDiagnosisCommon

func NewRemoteDeviceDiagnosis 

func NewRemoteDeviceDiagnosis(featureRemote spineapi.FeatureRemoteInterface) *DeviceDiagnosisCommon

func (*DeviceDiagnosisCommon) GetState 

func (d *DeviceDiagnosisCommon) GetState() (*model.DeviceDiagnosisStateDataType, error)

get the current diagnosis state for an device entity

func (*DeviceDiagnosisCommon) IsHeartbeatWithinDuration 

func (d *DeviceDiagnosisCommon) IsHeartbeatWithinDuration(duration time.Duration) bool

check if the currently available heartbeat data is within a time duration

type ElectricalConnectionCommon 

type ElectricalConnectionCommon struct {
	// contains filtered or unexported fields
}

func NewLocalElectricalConnection 

func NewLocalElectricalConnection(featureLocal spineapi.FeatureLocalInterface) *ElectricalConnectionCommon

func NewRemoteElectricalConnection 

func NewRemoteElectricalConnection(featureRemote spineapi.FeatureRemoteInterface) *ElectricalConnectionCommon

func (*ElectricalConnectionCommon) AdjustValueToBeWithinPermittedValuesForParameterId 

func (e *ElectricalConnectionCommon) AdjustValueToBeWithinPermittedValuesForParameterId(
	value float64, parameterId model.ElectricalConnectionParameterIdType) float64

Adjust a value to be within the permitted value range

func (*ElectricalConnectionCommon) CheckEventPayloadDataForFilter 

func (e *ElectricalConnectionCommon) CheckEventPayloadDataForFilter(payloadData any, filter any) bool

check if spine.EventPayload Data contains data for a given filter

data type will be checked for model.ElectricalConnectionPermittedValueSetListDataType, filter type will be checked for model.ElectricalConnectionParameterDescriptionDataType

func (*ElectricalConnectionCommon) GetCharacteristicsForFilter 

func (e *ElectricalConnectionCommon) GetCharacteristicsForFilter(
	filter model.ElectricalConnectionCharacteristicDataType,
) ([]model.ElectricalConnectionCharacteristicDataType, error)

Get the characteristics for a given filter

Returns an error if no matching description is found

func (*ElectricalConnectionCommon) GetDescriptionForParameterDescriptionFilter 

func (e *ElectricalConnectionCommon) GetDescriptionForParameterDescriptionFilter(
	filter model.ElectricalConnectionParameterDescriptionDataType) (
	*model.ElectricalConnectionDescriptionDataType, error)

return current electrical description for a given parameter description

func (*ElectricalConnectionCommon) GetDescriptionsForFilter 

func (e *ElectricalConnectionCommon) GetDescriptionsForFilter(
	filter model.ElectricalConnectionDescriptionDataType,
) ([]model.ElectricalConnectionDescriptionDataType, error)

Get the description for a given filter

Returns an error if no matching description is found

func (*ElectricalConnectionCommon) GetParameterDescriptionsForFilter 

func (e *ElectricalConnectionCommon) GetParameterDescriptionsForFilter(
	filter model.ElectricalConnectionParameterDescriptionDataType,
) ([]model.ElectricalConnectionParameterDescriptionDataType, error)

Get the description for a given filter

Returns an error if no matching description is found

func (*ElectricalConnectionCommon) GetPermittedValueDataForFilter 

func (e *ElectricalConnectionCommon) GetPermittedValueDataForFilter(
	filter model.ElectricalConnectionPermittedValueSetDataType) (
	float64, float64, float64, error)

returns minimum, maximum, default/pause limit values

func (*ElectricalConnectionCommon) GetPermittedValueSetForFilter 

func (e *ElectricalConnectionCommon) GetPermittedValueSetForFilter(
	filter model.ElectricalConnectionPermittedValueSetDataType) (
	[]model.ElectricalConnectionPermittedValueSetDataType, error)

return permitted values for all Electrical Connections

func (*ElectricalConnectionCommon) GetPhaseCurrentLimits 

func (e *ElectricalConnectionCommon) GetPhaseCurrentLimits(measurementDescs []model.MeasurementDescriptionDataType) (
	resultMin []float64, resultMax []float64, resultDefault []float64, resultErr error)

Get the min, max, default current limits for each phase

type IdentificationCommon 

type IdentificationCommon struct {
	// contains filtered or unexported fields
}

func NewLocalIdentification 

func NewLocalIdentification(featureLocal spineapi.FeatureLocalInterface) *IdentificationCommon

func NewRemoteIdentification 

func NewRemoteIdentification(featureRemote spineapi.FeatureRemoteInterface) *IdentificationCommon

func (*IdentificationCommon) CheckEventPayloadDataForFilter 

func (i *IdentificationCommon) CheckEventPayloadDataForFilter(payloadData any) bool

check if spine.EventPayload Data contains identification data

data type will be checked for model.IdentificationListDataType

func (*IdentificationCommon) GetDataForFilter 

func (i *IdentificationCommon) GetDataForFilter(filter model.IdentificationDataType) ([]model.IdentificationDataType, error)

return current values for Identification

type IncentiveTableCommon 

type IncentiveTableCommon struct {
	// contains filtered or unexported fields
}

func NewLocalIncentiveTable 

func NewLocalIncentiveTable(featureLocal spineapi.FeatureLocalInterface) *IncentiveTableCommon

func NewRemoteIncentiveTable 

func NewRemoteIncentiveTable(featureRemote spineapi.FeatureRemoteInterface) *IncentiveTableCommon

func (*IncentiveTableCommon) GetConstraints 

func (i *IncentiveTableCommon) GetConstraints() ([]model.IncentiveTableConstraintsType, error)

return list of constraints

func (*IncentiveTableCommon) GetData 

func (i *IncentiveTableCommon) GetData() ([]model.IncentiveTableType, error)

return current data for Time Series

func (*IncentiveTableCommon) GetDescriptionsForFilter 

func (i *IncentiveTableCommon) GetDescriptionsForFilter(
	filter model.TariffDescriptionDataType,
) ([]model.IncentiveTableDescriptionType, error)

return list of descriptions for a given filter

type LoadControlCommon 

type LoadControlCommon struct {
	// contains filtered or unexported fields
}

func NewLocalLoadControl 

func NewLocalLoadControl(featureLocal spineapi.FeatureLocalInterface) *LoadControlCommon

func NewRemoteLoadControl 

func NewRemoteLoadControl(featureRemote spineapi.FeatureRemoteInterface) *LoadControlCommon

func (*LoadControlCommon) CheckEventPayloadDataForFilter 

func (l *LoadControlCommon) CheckEventPayloadDataForFilter(payloadData any, filter any) bool

check if spine.EventPayload Data contains data for a given filter

data type will be checked for model.LoadControlLimitListDataType, filter type will be checked for model.LoadControlLimitDescriptionDataType

func (*LoadControlCommon) GetLimitDataForFilter 

func (l *LoadControlCommon) GetLimitDataForFilter(filter model.LoadControlLimitDescriptionDataType) ([]model.LoadControlLimitDataType, error)

Get limit data for a given filter

Will return nil if no data is available

func (*LoadControlCommon) GetLimitDataForId 

func (l *LoadControlCommon) GetLimitDataForId(limitId model.LoadControlLimitIdType) (*model.LoadControlLimitDataType, error)

Get the description for a given limitId

Will return nil if no data is available

func (*LoadControlCommon) GetLimitDescriptionForId 

func (l *LoadControlCommon) GetLimitDescriptionForId(limitId model.LoadControlLimitIdType) (*model.LoadControlLimitDescriptionDataType, error)

Get the description for a given limitId

Will return nil if no matching description is found

func (*LoadControlCommon) GetLimitDescriptionsForFilter 

func (l *LoadControlCommon) GetLimitDescriptionsForFilter(
	filter model.LoadControlLimitDescriptionDataType,
) ([]model.LoadControlLimitDescriptionDataType, error)

Get the description for a given filter

Returns an error if no matching description is found

type MeasurementCommon 

type MeasurementCommon struct {
	// contains filtered or unexported fields
}

func NewLocalMeasurement 

func NewLocalMeasurement(featureLocal spineapi.FeatureLocalInterface) *MeasurementCommon

func NewRemoteMeasurement 

func NewRemoteMeasurement(featureRemote spineapi.FeatureRemoteInterface) *MeasurementCommon

func (*MeasurementCommon) CheckEventPayloadDataForFilter 

func (m *MeasurementCommon) CheckEventPayloadDataForFilter(payloadData any, filter any) bool

check if spine.EventPayload Data contains data for a given filter

data type will be checked for model.MeasurementListDataType, filter type will be checked for model.MeasurementDescriptionDataType

func (*MeasurementCommon) GetConstraintsForFilter 

func (m *MeasurementCommon) GetConstraintsForFilter(
	filter model.MeasurementConstraintsDataType,
) ([]model.MeasurementConstraintsDataType, error)

Get the constraints for a given filter

Returns an error if no matching constraint is found

func (*MeasurementCommon) GetDataForFilter 

func (m *MeasurementCommon) GetDataForFilter(filter model.MeasurementDescriptionDataType) (
	[]model.MeasurementDataType, error)

Get measuement data for a given filter

Will return nil if no data is available

func (*MeasurementCommon) GetDataForId 

func (m *MeasurementCommon) GetDataForId(measurementId model.MeasurementIdType) (
	*model.MeasurementDataType, error)

Get the measuement data for a given measurementId

Will return nil if no data is available

func (*MeasurementCommon) GetDescriptionForId 

func (m *MeasurementCommon) GetDescriptionForId(
	measurementId model.MeasurementIdType,
) (*model.MeasurementDescriptionDataType, error)

Get the description for a given id

Returns an error if no matching description is found

func (*MeasurementCommon) GetDescriptionsForFilter 

func (m *MeasurementCommon) GetDescriptionsForFilter(
	filter model.MeasurementDescriptionDataType,
) ([]model.MeasurementDescriptionDataType, error)

Get the description for a given filter

Returns an error if no matching description is found

type SmartEnergyManagementPsCommon 

type SmartEnergyManagementPsCommon struct {
	// contains filtered or unexported fields
}

func NewLocalSmartEnergyManagementPs 

func NewLocalSmartEnergyManagementPs(featureLocal spineapi.FeatureLocalInterface) *SmartEnergyManagementPsCommon

func NewRemoteSmartEnergyManagementPs 

func NewRemoteSmartEnergyManagementPs(featureRemote spineapi.FeatureRemoteInterface) *SmartEnergyManagementPsCommon

func (*SmartEnergyManagementPsCommon) GetData 

func (i *SmartEnergyManagementPsCommon) GetData() (*model.SmartEnergyManagementPsDataType, error)

return current data for FunctionTypeSmartEnergyManagementPsData

type TimeSeriesCommon 

type TimeSeriesCommon struct {
	// contains filtered or unexported fields
}

func NewLocalTimeSeries 

func NewLocalTimeSeries(featureLocal spineapi.FeatureLocalInterface) *TimeSeriesCommon

func NewRemoteTimeSeries 

func NewRemoteTimeSeries(featureRemote spineapi.FeatureRemoteInterface) *TimeSeriesCommon

func (*TimeSeriesCommon) GetConstraints 

func (t *TimeSeriesCommon) GetConstraints() ([]model.TimeSeriesConstraintsDataType, error)

return current constraints for Time Series

func (*TimeSeriesCommon) GetDataForFilter 

func (t *TimeSeriesCommon) GetDataForFilter(filter model.TimeSeriesDescriptionDataType) ([]model.TimeSeriesDataType, error)

return current data for Time Series for a given filter

func (*TimeSeriesCommon) GetDescriptionsForFilter 

func (t *TimeSeriesCommon) GetDescriptionsForFilter(
	filter model.TimeSeriesDescriptionDataType,
) ([]model.TimeSeriesDescriptionDataType, error)

return list of descriptions for a given filter

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.