Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

api

package

Go to main page

Versions in this module

v0

v0.7.0

Sep 21, 2024

v0.6.2

Aug 12, 2024

v0.6.1

Jul 16, 2024

v0.6.0

Jun 29, 2024

Changes in this version

+ var ErrDeviceDisconnected = errors.New("device is disconnected")

+ var ErrNoCompatibleEntity = errors.New("no compatible entity")

+ type DeviceClassificationClientInterface interface

+ RequestManufacturerDetails func() (*model.MsgCounterType, error)

+ type DeviceClassificationCommonInterface interface

+ GetManufacturerDetails func() (*model.DeviceClassificationManufacturerDataType, error)

+ type DeviceClassificationServerInterface interface

+ type DeviceConfigurationClientInterface interface

+ RequestKeyValueDescriptions func(selector *model.DeviceConfigurationKeyValueDescriptionListDataSelectorsType, ...) (*model.MsgCounterType, error)

+ RequestKeyValues func(selector *model.DeviceConfigurationKeyValueListDataSelectorsType, ...) (*model.MsgCounterType, error)

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

+ type DeviceConfigurationCommonInterface interface

+ CheckEventPayloadDataForFilter func(payloadData any, filter any) bool

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

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

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

+ GetKeyValueDescriptionsForFilter func(filter model.DeviceConfigurationKeyValueDescriptionDataType) ([]model.DeviceConfigurationKeyValueDescriptionDataType, error)

+ type DeviceConfigurationServerInterface interface

+ AddKeyValueDescription func(description model.DeviceConfigurationKeyValueDescriptionDataType) *model.DeviceConfigurationKeyIdType

+ UpdateKeyValueDataForFilter func(data model.DeviceConfigurationKeyValueDataType, ...) error

+ UpdateKeyValueDataForKeyId func(data model.DeviceConfigurationKeyValueDataType, ...) error

+ type DeviceDiagnosisClientInterface interface

+ RequestHeartbeat func() (*model.MsgCounterType, error)

+ RequestState func() (*model.MsgCounterType, error)

+ type DeviceDiagnosisCommonInterface interface

+ GetState func() (*model.DeviceDiagnosisStateDataType, error)

+ IsHeartbeatWithinDuration func(duration time.Duration) bool

+ type DeviceDiagnosisServerInterface interface

+ SetLocalState func(operatingState *model.DeviceDiagnosisStateDataType)

+ type ElectricalConnectionClientInterface interface

+ RequestCharacteristics func(selector *model.ElectricalConnectionCharacteristicListDataSelectorsType, ...) (*model.MsgCounterType, error)

+ RequestDescriptions func(selector *model.ElectricalConnectionDescriptionListDataSelectorsType, ...) (*model.MsgCounterType, error)

+ RequestParameterDescriptions func(selector *model.ElectricalConnectionParameterDescriptionListDataSelectorsType, ...) (*model.MsgCounterType, error)

+ RequestPermittedValueSets func(selector *model.ElectricalConnectionPermittedValueSetListDataSelectorsType, ...) (*model.MsgCounterType, error)

+ type ElectricalConnectionCommonInterface interface

+ AdjustValueToBeWithinPermittedValuesForParameterId func(value float64, parameterId model.ElectricalConnectionParameterIdType) float64

+ CheckEventPayloadDataForFilter func(payloadData any, filter any) bool

+ GetCharacteristicsForFilter func(filter model.ElectricalConnectionCharacteristicDataType) ([]model.ElectricalConnectionCharacteristicDataType, error)

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

+ GetDescriptionsForFilter func(filter model.ElectricalConnectionDescriptionDataType) ([]model.ElectricalConnectionDescriptionDataType, error)

+ GetParameterDescriptionsForFilter func(filter model.ElectricalConnectionParameterDescriptionDataType) ([]model.ElectricalConnectionParameterDescriptionDataType, error)

+ GetPermittedValueDataForFilter func(filter model.ElectricalConnectionPermittedValueSetDataType) (float64, float64, float64, error)

+ GetPermittedValueSetForFilter func(filter model.ElectricalConnectionPermittedValueSetDataType) ([]model.ElectricalConnectionPermittedValueSetDataType, error)

+ GetPhaseCurrentLimits func(measDesc []model.MeasurementDescriptionDataType) (resultMin []float64, resultMax []float64, resultDefault []float64, ...)

+ type ElectricalConnectionServerInterface interface

+ AddCharacteristic func(data model.ElectricalConnectionCharacteristicDataType) (*model.ElectricalConnectionCharacteristicIdType, error)

+ AddDescription func(description model.ElectricalConnectionDescriptionDataType) error

+ AddParameterDescription func(description model.ElectricalConnectionParameterDescriptionDataType) *model.ElectricalConnectionParameterIdType

+ UpdateCharacteristic func(data model.ElectricalConnectionCharacteristicDataType, ...) error

+ type EntityEventCallback func(ski string, device spineapi.DeviceRemoteInterface, ...)

+ type EventType string

+ type FeatureClientInterface interface

+ AddResponseCallback func(msgCounterReference model.MsgCounterType, ...) error

+ AddResultCallback func(function func(msg api.ResponseMessage))

+ Bind func() (*model.MsgCounterType, error)

+ HasBinding func() bool

+ HasSubscription func() bool

+ Subscribe func() (*model.MsgCounterType, error)

+ type FeatureServerInterface interface

+ type IdentificationClientInterface interface

+ RequestValues func() (*model.MsgCounterType, error)

+ type IdentificationCommonInterface interface

+ CheckEventPayloadDataForFilter func(payloadData any) bool

+ GetDataForFilter func(filter model.IdentificationDataType) ([]model.IdentificationDataType, error)

+ type IdentificationServerInterface interface

+ type IncentiveTableClientInterface interface

+ RequestConstraints func() (*model.MsgCounterType, error)

+ RequestDescriptions func() (*model.MsgCounterType, error)

+ RequestValues func() (*model.MsgCounterType, error)

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

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

+ type IncentiveTableCommonInterface interface

+ GetConstraints func() ([]model.IncentiveTableConstraintsType, error)

+ GetData func() ([]model.IncentiveTableType, error)

+ GetDescriptionsForFilter func(filter model.TariffDescriptionDataType) ([]model.IncentiveTableDescriptionType, error)

+ type IncentiveTableServerInterface interface

+ type LoadControlClientInterface interface

+ RequestLimitConstraints func(selector *model.LoadControlLimitConstraintsListDataSelectorsType, ...) (*model.MsgCounterType, error)

+ RequestLimitData func(selector *model.LoadControlLimitListDataSelectorsType, ...) (*model.MsgCounterType, error)

+ RequestLimitDescriptions func(selector *model.LoadControlLimitDescriptionListDataSelectorsType, ...) (*model.MsgCounterType, error)

+ WriteLimitData func(data []model.LoadControlLimitDataType, ...) (*model.MsgCounterType, error)

+ type LoadControlCommonInterface interface

+ CheckEventPayloadDataForFilter func(payloadData any, filter any) bool

+ GetLimitDataForFilter func(filter model.LoadControlLimitDescriptionDataType) ([]model.LoadControlLimitDataType, error)

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

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

+ GetLimitDescriptionsForFilter func(filter model.LoadControlLimitDescriptionDataType) ([]model.LoadControlLimitDescriptionDataType, error)

+ type LoadControlServerInterface interface

+ AddLimitDescription func(description model.LoadControlLimitDescriptionDataType) *model.LoadControlLimitIdType

+ UpdateLimitDataForFilter func(data model.LoadControlLimitDataType, ...) error

+ UpdateLimitDataForId func(data model.LoadControlLimitDataType, ...) error

+ type ManufacturerData struct

+ BrandName string

+ DeviceCode string

+ DeviceName string

+ HardwareRevision string

+ ManufacturerDescription string

+ ManufacturerLabel string

+ ManufacturerNodeIdentification string

+ PowerSource string

+ SerialNumber string

+ SoftwareRevision string

+ VendorCode string

+ VendorName string

+ type MeasurementClientInterface interface

+ RequestConstraints func(selector *model.MeasurementConstraintsListDataSelectorsType, ...) (*model.MsgCounterType, error)

+ RequestData func(selector *model.MeasurementListDataSelectorsType, ...) (*model.MsgCounterType, error)

+ RequestDescriptions func(selector *model.MeasurementDescriptionListDataSelectorsType, ...) (*model.MsgCounterType, error)

+ type MeasurementCommonInterface interface

+ CheckEventPayloadDataForFilter func(payloadData any, filter any) bool

+ GetConstraintsForFilter func(filter model.MeasurementConstraintsDataType) ([]model.MeasurementConstraintsDataType, error)

+ GetDataForFilter func(filter model.MeasurementDescriptionDataType) ([]model.MeasurementDataType, error)

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

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

+ GetDescriptionsForFilter func(filter model.MeasurementDescriptionDataType) ([]model.MeasurementDescriptionDataType, error)

+ type MeasurementServerInterface interface

+ AddDescription func(description model.MeasurementDescriptionDataType) *model.MeasurementIdType

+ UpdateDataForFilter func(data model.MeasurementDataType, ...) error

+ UpdateDataForId func(data model.MeasurementDataType, ...) error

+ type RemoteEntityScenarios struct

+ Entity spineapi.EntityRemoteInterface

+ Scenarios []uint

type ServiceInterface

+ AddUseCase func(useCase UseCaseInterface)

+ type SmartEnergyManagementPsClientInterface interface

+ RequestData func() (*model.MsgCounterType, error)

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

+ type SmartEnergyManagementPsCommonInterface interface

+ GetData func() (*model.SmartEnergyManagementPsDataType, error)

+ type SmartEnergyManagementPsServerInterface interface

+ type TimeSeriesClientInterface interface

+ RequestConstraints func(selector *model.TimeSeriesConstraintsListDataSelectorsType, ...) (*model.MsgCounterType, error)

+ RequestData func(selector *model.TimeSeriesListDataSelectorsType, ...) (*model.MsgCounterType, error)

+ RequestDescriptions func(selector *model.TimeSeriesDescriptionListDataSelectorsType, ...) (*model.MsgCounterType, error)

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

+ type TimeSeriesCommonInterface interface

+ GetConstraints func() ([]model.TimeSeriesConstraintsDataType, error)

+ GetDataForFilter func(filter model.TimeSeriesDescriptionDataType) ([]model.TimeSeriesDataType, error)

+ GetDescriptionsForFilter func(filter model.TimeSeriesDescriptionDataType) ([]model.TimeSeriesDescriptionDataType, error)

+ type TimeSeriesServerInterface interface

+ type UseCaseBaseInterface interface

+ AddUseCase func()

+ AvailableScenariosForEntity func(entity spineapi.EntityRemoteInterface) []uint

+ IsCompatibleEntityType func(entity spineapi.EntityRemoteInterface) bool

+ IsScenarioAvailableAtEntity func(entity spineapi.EntityRemoteInterface, scenario uint) bool

+ RemoteEntitiesScenarios func() []RemoteEntityScenarios

+ RemoveUseCase func()

+ UpdateUseCaseAvailability func(available bool)

+ type UseCaseInterface interface

+ AddFeatures func()

+ type UseCaseScenario struct

+ Mandatory bool

+ Scenario model.UseCaseScenarioSupportType

+ ServerFeatures []model.FeatureTypeType

v0.5.0

May 18, 2024

Changes in this version

+ var ErrDataForMetadataKeyNotFound = errors.New("data for key not found")

+ var ErrDataNotAvailable = errors.New("data not available")

+ var ErrEntityNotFound = errors.New("entity not found")

+ var ErrFunctionNotSupported = errors.New("function is not supported")

+ var ErrMetadataNotAvailable = errors.New("meta data not available")

+ var ErrMissingData = errors.New("missing data")

+ var ErrNotSupported = errors.New("not supported")

+ var ErrOperationOnFunctionNotSupported = errors.New("operation is not supported on function")

+ var ErrUsecCaseNotSupported = errors.New("usecase is not supported")

+ type Configuration struct

+ func NewConfiguration(vendorCode, deviceBrand, deviceModel, serialNumber string, ...) (*Configuration, error)

+ func (s *Configuration) Certificate() tls.Certificate

+ func (s *Configuration) DeviceBrand() string

+ func (s *Configuration) DeviceModel() string

+ func (s *Configuration) DeviceSerialNumber() string

+ func (s *Configuration) DeviceType() model.DeviceTypeType

+ func (s *Configuration) EntityTypes() []model.EntityTypeType

+ func (s *Configuration) FeatureSet() model.NetworkManagementFeatureSetType

+ func (s *Configuration) HeartbeatTimeout() time.Duration

+ func (s *Configuration) Identifier() string

+ func (s *Configuration) Interfaces() []string

+ func (s *Configuration) MdnsProviderSelection() mdns.MdnsProviderSelection

+ func (s *Configuration) MdnsServiceName() string

+ func (s *Configuration) Port() int

+ func (s *Configuration) SetAlternateIdentifier(identifier string)

+ func (s *Configuration) SetAlternateMdnsServiceName(name string)

+ func (s *Configuration) SetCertificate(cert tls.Certificate)

+ func (s *Configuration) SetInterfaces(ifaces []string)

+ func (s *Configuration) SetMdnsProviderSelection(providerSelection mdns.MdnsProviderSelection)

+ func (s *Configuration) VendorCode() string

+ func (s *Configuration) Voltage() float64

+ type ServiceInterface interface

+ CancelPairingWithSKI func(ski string)

+ Configuration func() *Configuration

+ DisconnectSKI func(ski string, reason string)

+ IsAutoAcceptEnabled func() bool

+ LocalDevice func() spineapi.DeviceLocalInterface

+ LocalService func() *shipapi.ServiceDetails

+ PairingDetailForSki func(ski string) *shipapi.ConnectionStateDetail

+ RegisterRemoteSKI func(ski string)

+ RemoteServiceForSKI func(ski string) *shipapi.ServiceDetails

+ SetAutoAccept func(value bool)

+ SetLogging func(logger logging.LoggingInterface)

+ Setup func() error

+ Shutdown func()

+ Start func()

+ UnregisterRemoteSKI func(ski string)

+ UserIsAbleToApproveOrCancelPairingRequests func(allow bool)

+ type ServiceReaderInterface interface

+ RemoteSKIConnected func(service ServiceInterface, ski string)

+ RemoteSKIDisconnected func(service ServiceInterface, ski string)

+ ServicePairingDetailUpdate func(ski string, detail *shipapi.ConnectionStateDetail)

+ ServiceShipIDUpdate func(ski string, shipdID string)

+ VisibleRemoteServicesUpdated func(service ServiceInterface, entries []shipapi.RemoteService)