vapd

Documentation

Index

• Constants
• type VAPD
  • func NewVAPD(localEntity spineapi.EntityLocalInterface, eventCB api.EntityEventCallback) *VAPD
  • func (e *VAPD) AddFeatures()
  • func (e *VAPD) HandleEvent(payload spineapi.EventPayload)
  • func (e *VAPD) PVYieldTotal(entity spineapi.EntityRemoteInterface) (float64, error)
  • func (e *VAPD) Power(entity spineapi.EntityRemoteInterface) (float64, error)
  • func (e *VAPD) PowerNominalPeak(entity spineapi.EntityRemoteInterface) (float64, error)

Constants

const (
	// Update of the list of remote entities supporting the Use Case
	//
	// Use `RemoteEntities` to get the current data
	UseCaseSupportUpdate api.EventType = "cem-vapd-UseCaseSupportUpdate"

	// PV System total power data updated
	//
	// Use `Power` to get the current data
	//
	// Use Case VAPD, Scenario 1
	DataUpdatePower api.EventType = "cem-vapd-DataUpdatePower"

	// PV System nominal peak power data updated
	//
	// Use `PowerNominalPeak` to get the current data
	//
	// Use Case VAPD, Scenario 2
	DataUpdatePowerNominalPeak api.EventType = "cem-vapd-DataUpdatePowerNominalPeak"

	// PV System total yield data updated
	//
	// Use `PVYieldTotal` to get the current data
	//
	// Use Case VAPD, Scenario 3
	DataUpdatePVYieldTotal api.EventType = "cem-vapd-DataUpdatePVYieldTotal"
)

Types

type VAPD

type VAPD struct {
	*usecase.UseCaseBase
}

func NewVAPD

func NewVAPD(localEntity spineapi.EntityLocalInterface, eventCB api.EntityEventCallback) *VAPD

func (*VAPD) AddFeatures

func (e *VAPD) AddFeatures()

func (*VAPD) HandleEvent

func (e *VAPD) HandleEvent(payload spineapi.EventPayload)

handle SPINE events

func (*VAPD) PVYieldTotal

func (e *VAPD) PVYieldTotal(entity spineapi.EntityRemoteInterface) (float64, error)

return the total photovoltaic yield (Wh)

possible errors:

• ErrDataNotAvailable if no such measurement is (yet) available
• and others

func (*VAPD) Power

func (e *VAPD) Power(entity spineapi.EntityRemoteInterface) (float64, error)

return the current photovoltaic production power (W)

possible errors:

• ErrDataNotAvailable if no such measurement is (yet) available
• and others

func (*VAPD) PowerNominalPeak

func (e *VAPD) PowerNominalPeak(entity spineapi.EntityRemoteInterface) (float64, error)

return the nominal photovoltaic peak power (W)

possible errors:

• ErrDataNotAvailable if no such measurement is (yet) available
• and others