client

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

This section is empty.

Functions

This section is empty.

Types

type DeviceClassification 

type DeviceClassification struct {
	*Feature

	*internal.DeviceClassificationCommon
}

func NewDeviceClassification 

func NewDeviceClassification(
	localEntity spineapi.EntityLocalInterface,
	remoteEntity spineapi.EntityRemoteInterface) (*DeviceClassification, error)

Get a new DeviceClassification features helper

- The feature on the local entity has to be of role client - The feature on the remote entity has to be of role server

func (*DeviceClassification) RequestManufacturerDetails 

func (d *DeviceClassification) RequestManufacturerDetails() (*model.MsgCounterType, error)

request DeviceClassificationManufacturerData from a remote device entity

type DeviceConfiguration 

type DeviceConfiguration struct {
	*Feature

	*internal.DeviceConfigurationCommon
}

func NewDeviceConfiguration 

func NewDeviceConfiguration(
	localEntity spineapi.EntityLocalInterface,
	remoteEntity spineapi.EntityRemoteInterface) (*DeviceConfiguration, error)

Get a new DeviceConfiguration features helper

- The feature on the local entity has to be of role client - The feature on the remote entity has to be of role server

func (*DeviceConfiguration) RequestKeyValueDescriptions 

func (d *DeviceConfiguration) RequestKeyValueDescriptions(
	selector *model.DeviceConfigurationKeyValueDescriptionListDataSelectorsType,
	elements *model.DeviceConfigurationKeyValueDescriptionDataElementsType,
) (*model.MsgCounterType, error)

request DeviceConfigurationKeyValueDescriptionDataType from a remote entity

func (*DeviceConfiguration) RequestKeyValues 

func (d *DeviceConfiguration) RequestKeyValues(
	selector *model.DeviceConfigurationKeyValueListDataSelectorsType,
	elements *model.DeviceConfigurationKeyValueDataElementsType,
) (*model.MsgCounterType, error)

request DeviceConfigurationKeyValueListData from a remote entity

func (*DeviceConfiguration) WriteKeyValues 

func (d *DeviceConfiguration) WriteKeyValues(data []model.DeviceConfigurationKeyValueDataType) (*model.MsgCounterType, error)

write key values returns an error if this failed

type DeviceDiagnosis 

type DeviceDiagnosis struct {
	*Feature

	*internal.DeviceDiagnosisCommon
}

func NewDeviceDiagnosis 

func NewDeviceDiagnosis(
	localEntity spineapi.EntityLocalInterface,
	remoteEntity spineapi.EntityRemoteInterface) (*DeviceDiagnosis, error)

Get a new DeviceDiagnosis features helper

- The feature on the local entity has to be of role client - The feature on the remote entity has to be of role server

func (*DeviceDiagnosis) RequestHeartbeat 

func (d *DeviceDiagnosis) RequestHeartbeat() (*model.MsgCounterType, error)

request FunctionTypeDeviceDiagnosisHeartbeatData from a remote device

func (*DeviceDiagnosis) RequestState 

func (d *DeviceDiagnosis) RequestState() (*model.MsgCounterType, error)

request DeviceDiagnosisStateData from a remote entity

type ElectricalConnection 

type ElectricalConnection struct {
	*Feature

	*internal.ElectricalConnectionCommon
}

func NewElectricalConnection 

func NewElectricalConnection(
	localEntity spineapi.EntityLocalInterface,
	remoteEntity spineapi.EntityRemoteInterface) (*ElectricalConnection, error)

Get a new ElectricalConnection features helper

- The feature on the local entity has to be of role client - The feature on the remote entity has to be of role server

func (*ElectricalConnection) RequestCharacteristics 

func (e *ElectricalConnection) RequestCharacteristics(
	selector *model.ElectricalConnectionCharacteristicListDataSelectorsType,
	elements *model.ElectricalConnectionCharacteristicDataElementsType,
) (*model.MsgCounterType, error)

request FunctionTypeElectricalConnectionCharacteristicListData from a remote entity

func (*ElectricalConnection) RequestDescriptions 

func (e *ElectricalConnection) RequestDescriptions(
	selector *model.ElectricalConnectionDescriptionListDataSelectorsType,
	elements *model.ElectricalConnectionDescriptionDataElementsType,
) (*model.MsgCounterType, error)

request ElectricalConnectionDescriptionListDataType from a remote entity

func (*ElectricalConnection) RequestParameterDescriptions 

func (e *ElectricalConnection) RequestParameterDescriptions(
	selector *model.ElectricalConnectionParameterDescriptionListDataSelectorsType,
	elements *model.ElectricalConnectionParameterDescriptionDataElementsType,
) (*model.MsgCounterType, error)

request FunctionTypeElectricalConnectionParameterDescriptionListData from a remote entity

func (*ElectricalConnection) RequestPermittedValueSets 

func (e *ElectricalConnection) RequestPermittedValueSets(
	selector *model.ElectricalConnectionPermittedValueSetListDataSelectorsType,
	elements *model.ElectricalConnectionPermittedValueSetDataElementsType,
) (*model.MsgCounterType, error)

request FunctionTypeElectricalConnectionPermittedValueSetListData from a remote entity

type Feature 

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

func NewFeature 

func NewFeature(
	featureType model.FeatureTypeType,
	localEntity spineapi.EntityLocalInterface,
	remoteEntity spineapi.EntityRemoteInterface) (*Feature, error)

func (*Feature) AddResponseCallback 

func (f *Feature) AddResponseCallback(
	msgCounterReference model.MsgCounterType,
	function func(msg spineapi.ResponseMessage)) error

add a callback function to be invoked once a result or reply message for a msgCounter came in

func (*Feature) AddResultCallback 

func (f *Feature) AddResultCallback(function func(msg spineapi.ResponseMessage))

add a callback function to be invoked once a result came in

func (*Feature) Bind 

func (f *Feature) Bind() (*model.MsgCounterType, error)

bind to the feature of the entity

func (*Feature) HasBinding 

func (f *Feature) HasBinding() bool

check if there is a binding to the remote feature

func (*Feature) HasSubscription 

func (f *Feature) HasSubscription() bool

check if there is a subscription to the remote feature

func (*Feature) Subscribe 

func (f *Feature) Subscribe() (*model.MsgCounterType, error)

subscribe to the feature of the entity

func (*Feature) Unbind 

func (f *Feature) Unbind() (*model.MsgCounterType, error)

remove a binding to the feature of the entity

func (*Feature) Unsubscribe 

func (f *Feature) Unsubscribe() (*model.MsgCounterType, error)

unssubscribe to the feature of the entity

type Identification 

type Identification struct {
	*Feature

	*internal.IdentificationCommon
}

func NewIdentification 

func NewIdentification(
	localEntity spineapi.EntityLocalInterface,
	remoteEntity spineapi.EntityRemoteInterface) (*Identification, error)

Get a new Identification features helper

- The feature on the local entity has to be of role client - The feature on the remote entity has to be of role server

func (*Identification) RequestValues 

func (i *Identification) RequestValues() (*model.MsgCounterType, error)

request FunctionTypeIdentificationListData from a remote entity

type IncentiveTable 

type IncentiveTable struct {
	*Feature

	*internal.IncentiveTableCommon
}

func NewIncentiveTable 

func NewIncentiveTable(
	localEntity spineapi.EntityLocalInterface,
	remoteEntity spineapi.EntityRemoteInterface) (*IncentiveTable, error)

Get a new IncentiveTable features helper

- The feature on the local entity has to be of role client - The feature on the remote entity has to be of role server

func (*IncentiveTable) RequestConstraints 

func (i *IncentiveTable) RequestConstraints() (*model.MsgCounterType, error)

request FunctionTypeIncentiveTableConstraintsData from a remote entity

func (*IncentiveTable) RequestDescriptions 

func (i *IncentiveTable) RequestDescriptions() (*model.MsgCounterType, error)

request FunctionTypeIncentiveTableDescriptionData from a remote entity

func (*IncentiveTable) RequestValues 

func (i *IncentiveTable) RequestValues() (*model.MsgCounterType, error)

request FunctionTypeIncentiveTableData from a remote entity

func (*IncentiveTable) WriteDescriptions 

func (i *IncentiveTable) WriteDescriptions(data []model.IncentiveTableDescriptionType) (*model.MsgCounterType, error)

write incentivetable descriptions returns an error if this failed

func (*IncentiveTable) WriteValues 

func (i *IncentiveTable) WriteValues(data []model.IncentiveTableType) (*model.MsgCounterType, error)

write incentivetable descriptions returns an error if this failed

type LoadControl 

type LoadControl struct {
	*Feature

	*internal.LoadControlCommon
}

func NewLoadControl 

func NewLoadControl(
	localEntity spineapi.EntityLocalInterface,
	remoteEntity spineapi.EntityRemoteInterface) (*LoadControl, error)

Get a new LoadControl features helper

- The feature on the local entity has to be of role client - The feature on the remote entity has to be of role server

func (*LoadControl) RequestLimitConstraints 

func (l *LoadControl) RequestLimitConstraints(
	selector *model.LoadControlLimitConstraintsListDataSelectorsType,
	elements *model.LoadControlLimitConstraintsDataElementsType,
) (*model.MsgCounterType, error)

request FunctionTypeLoadControlLimitConstraintsListData from a remote device

func (*LoadControl) RequestLimitData 

func (l *LoadControl) RequestLimitData(
	selector *model.LoadControlLimitListDataSelectorsType,
	elements *model.LoadControlLimitDataElementsType,
) (*model.MsgCounterType, error)

request FunctionTypeLoadControlLimitListData from a remote device

func (*LoadControl) RequestLimitDescriptions 

func (l *LoadControl) RequestLimitDescriptions(
	selector *model.LoadControlLimitDescriptionListDataSelectorsType,
	elements *model.LoadControlLimitDescriptionDataElementsType,
) (*model.MsgCounterType, error)

request FunctionTypeLoadControlLimitDescriptionListData from a remote device

func (*LoadControl) WriteLimitData 

func (l *LoadControl) WriteLimitData(
	data []model.LoadControlLimitDataType,
	deleteSelectors *model.LoadControlLimitListDataSelectorsType,
	deleteElements *model.LoadControlLimitDataElementsType,
) (*model.MsgCounterType, error)

write load control limits returns an error if this failed

type Measurement 

type Measurement struct {
	*Feature

	*internal.MeasurementCommon
}

func NewMeasurement 

func NewMeasurement(
	localEntity spineapi.EntityLocalInterface,
	remoteEntity spineapi.EntityRemoteInterface) (*Measurement, error)

Get a new Measurement features helper

- The feature on the local entity has to be of role client - The feature on the remote entity has to be of role server

func (*Measurement) RequestConstraints 

func (m *Measurement) RequestConstraints(
	selector *model.MeasurementConstraintsListDataSelectorsType,
	elements *model.MeasurementConstraintsDataElementsType,
) (*model.MsgCounterType, error)

request FunctionTypeMeasurementConstraintsListData from a remote entity

func (*Measurement) RequestData 

func (m *Measurement) RequestData(
	selector *model.MeasurementListDataSelectorsType,
	elements *model.MeasurementDataElementsType,
) (*model.MsgCounterType, error)

request FunctionTypeMeasurementListData from a remote entity

func (*Measurement) RequestDescriptions 

func (m *Measurement) RequestDescriptions(
	selector *model.MeasurementDescriptionListDataSelectorsType,
	elements *model.MeasurementDescriptionDataElementsType,
) (*model.MsgCounterType, error)

request FunctionTypeMeasurementDescriptionListData from a remote device

type SmartEnergyManagementPs 

type SmartEnergyManagementPs struct {
	*Feature

	*internal.SmartEnergyManagementPsCommon
}

func NewSmartEnergyManagementPs 

func NewSmartEnergyManagementPs(
	localEntity spineapi.EntityLocalInterface,
	remoteEntity spineapi.EntityRemoteInterface) (*SmartEnergyManagementPs, error)

Get a new Identification features helper

- The feature on the local entity has to be of role client - The feature on the remote entity has to be of role server

func (*SmartEnergyManagementPs) RequestData 

func (i *SmartEnergyManagementPs) RequestData() (*model.MsgCounterType, error)

request FunctionTypeSmartEnergyManagementPsData from a remote entity

func (*SmartEnergyManagementPs) WriteData 

func (l *SmartEnergyManagementPs) WriteData(data *model.SmartEnergyManagementPsDataType) (*model.MsgCounterType, error)

write SmartEnergyManagementPsData returns an error if this failed

type TimeSeries 

type TimeSeries struct {
	*Feature

	*internal.TimeSeriesCommon
}

func NewTimeSeries 

func NewTimeSeries(
	localEntity spineapi.EntityLocalInterface,
	remoteEntity spineapi.EntityRemoteInterface) (*TimeSeries, error)

Get a new TimeSeries features helper

- The feature on the local entity has to be of role client - The feature on the remote entity has to be of role server

func (*TimeSeries) RequestConstraints 

func (t *TimeSeries) RequestConstraints(
	selector *model.TimeSeriesConstraintsListDataSelectorsType,
	elements *model.TimeSeriesConstraintsDataElementsType,
) (*model.MsgCounterType, error)

request FunctionTypeTimeSeriesConstraintsListData from a remote entity

func (*TimeSeries) RequestData 

func (t *TimeSeries) RequestData(
	selector *model.TimeSeriesListDataSelectorsType,
	elements *model.TimeSeriesDataElementsType,
) (*model.MsgCounterType, error)

request FunctionTypeTimeSeriesListData from a remote device

func (*TimeSeries) RequestDescriptions 

func (t *TimeSeries) RequestDescriptions(
	selector *model.TimeSeriesDescriptionListDataSelectorsType,
	elements *model.TimeSeriesDescriptionDataElementsType,
) (*model.MsgCounterType, error)

request FunctionTypeTimeSeriesDescriptionListData from a remote entity

func (*TimeSeries) WriteData 

func (t *TimeSeries) WriteData(data []model.TimeSeriesDataType) (*model.MsgCounterType, error)

write Time Series values returns an error if this failed

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.