vabd

Documentation

Index

• Constants
• type VABD
  • func NewVABD(localEntity spineapi.EntityLocalInterface, eventCB api.EntityEventCallback) *VABD
  • func (e *VABD) AddFeatures()
  • func (e *VABD) EnergyCharged(entity spineapi.EntityRemoteInterface) (float64, error)
  • func (e *VABD) EnergyDischarged(entity spineapi.EntityRemoteInterface) (float64, error)
  • func (e *VABD) HandleEvent(payload spineapi.EventPayload)
  • func (e *VABD) Power(entity spineapi.EntityRemoteInterface) (float64, error)
  • func (e *VABD) StateOfCharge(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-vabd-UseCaseSupportUpdate"

	// Battery System (dis)charge power data updated
	//
	// Use `Power` to get the current data
	//
	// Use Case VABD, Scenario 1
	DataUpdatePower api.EventType = "cem-vabd-DataUpdatePower"

	// Battery System cumulated charge energy data updated
	//
	// Use `EnergyCharged` to get the current data
	//
	// Use Case VABD, Scenario 2
	DataUpdateEnergyCharged api.EventType = "cem-vabd-DataUpdateEnergyCharged"

	// Battery System cumulated discharge energy data updated
	//
	// Use `EnergyDischarged` to get the current data
	//
	// Use Case VABD, Scenario 3
	DataUpdateEnergyDischarged api.EventType = "cem-vabd-DataUpdateEnergyDischarged"

	// Battery System state of charge data updated
	//
	// Use `StateOfCharge` to get the current data
	//
	// Use Case VABD, Scenario 4
	DataUpdateStateOfCharge api.EventType = "cem-vabd-DataUpdateStateOfCharge"
)

Types

type VABD

type VABD struct {
	*usecase.UseCaseBase
}

func NewVABD

func NewVABD(localEntity spineapi.EntityLocalInterface, eventCB api.EntityEventCallback) *VABD

func (*VABD) AddFeatures

func (e *VABD) AddFeatures()

func (*VABD) EnergyCharged

func (e *VABD) EnergyCharged(entity spineapi.EntityRemoteInterface) (float64, error)

return the total charge energy (Wh)

possible errors:

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

func (*VABD) EnergyDischarged

func (e *VABD) EnergyDischarged(entity spineapi.EntityRemoteInterface) (float64, error)

return the total discharge energy (Wh)

possible errors:

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

func (*VABD) HandleEvent

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

handle SPINE events

func (*VABD) Power

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

return the current battery (dis-)charge power (W)

• positive values charge power
• negative values discharge power

possible errors:

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

func (*VABD) StateOfCharge

func (e *VABD) StateOfCharge(entity spineapi.EntityRemoteInterface) (float64, error)

return the current state of charge in %

possible errors:

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