internal

Documentation

Index

• func Deref(v *string) string
• func IsDeviceConnected(payload spineapi.EventPayload) bool
• func IsDeviceDisconnected(payload spineapi.EventPayload) bool
• func IsEntityConnected(payload spineapi.EventPayload) bool
• func IsEntityDisconnected(payload spineapi.EventPayload) bool
• func IsHeartbeat(payload spineapi.EventPayload) bool
• func LoadControlLimits(localEntity spineapi.EntityLocalInterface, ...) (limits []ucapi.LoadLimitsPhase, resultErr error)
• func ManufacturerData(localEntity spineapi.EntityLocalInterface, ...) (ucapi.ManufacturerData, error)
• func MeasurementPhaseSpecificDataForFilter(localEntity spineapi.EntityLocalInterface, ...) ([]float64, error)
• func WriteLoadControlLimit(localEntity spineapi.EntityLocalInterface, ...) (*model.MsgCounterType, error)
• func WriteLoadControlPhaseLimits(localEntity spineapi.EntityLocalInterface, ...) (*model.MsgCounterType, error)

Functions

func Deref

func Deref(v *string) string

func IsDeviceConnected

func IsDeviceConnected(payload spineapi.EventPayload) bool

func IsDeviceDisconnected

func IsDeviceDisconnected(payload spineapi.EventPayload) bool

func IsEntityConnected

func IsEntityConnected(payload spineapi.EventPayload) bool

func IsEntityDisconnected

func IsEntityDisconnected(payload spineapi.EventPayload) bool

func IsHeartbeat

func IsHeartbeat(payload spineapi.EventPayload) bool

IsHeartbeat checks if the given payload represents a heartbeat event. It returns true if the payload is a heartbeat event, and false otherwise.

func LoadControlLimits

func LoadControlLimits(
	localEntity spineapi.EntityLocalInterface,
	remoteEntity spineapi.EntityRemoteInterface,
	filter model.LoadControlLimitDescriptionDataType,
) (limits []ucapi.LoadLimitsPhase, resultErr error)

return the current loadcontrol limits for a categoriy

possible errors:

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

func ManufacturerData

func ManufacturerData(localEntity spineapi.EntityLocalInterface, entity spineapi.EntityRemoteInterface) (ucapi.ManufacturerData, error)

return the current manufacturer data for a entity

possible errors:

• ErrNoCompatibleEntity if entity is not compatible
• and others

func MeasurementPhaseSpecificDataForFilter

func MeasurementPhaseSpecificDataForFilter(
	localEntity spineapi.EntityLocalInterface,
	remoteEntity spineapi.EntityRemoteInterface,
	measurementFilter model.MeasurementDescriptionDataType,
	energyDirection model.EnergyDirectionType,
	validPhaseNameTypes []model.ElectricalConnectionPhaseNameType,
) ([]float64, error)

return the phase specific measurement data

func WriteLoadControlLimit

func WriteLoadControlLimit(
	localEntity spineapi.EntityLocalInterface,
	remoteEntity spineapi.EntityRemoteInterface,
	filter model.LoadControlLimitDescriptionDataType,
	limit ucapi.LoadLimit,
	resultCB func(result model.ResultDataType),
) (*model.MsgCounterType, error)

generic helper to be used in UCLPC & UCLPP send new LoadControlLimit to the remote entity

parameters:

• limits: a set of limits for a given limit category containing phase specific limit data
• resultCB: callback function for handling the result response

func WriteLoadControlPhaseLimits

func WriteLoadControlPhaseLimits(
	localEntity spineapi.EntityLocalInterface,
	remoteEntity spineapi.EntityRemoteInterface,
	filter model.LoadControlLimitDescriptionDataType,
	limits []ucapi.LoadLimitsPhase,
	resultCB func(result model.ResultDataType),
) (*model.MsgCounterType, error)

generic helper to be used in UCOPEV & UCOSCEV send new LoadControlLimits to the remote EV

parameters:

• limits: a set of limits for a given limit category containing phase specific limit data
• resultCB: callback function for handling the result response

category obligations: Sets a maximum A limit for each phase that the EV may not exceed. Mainly used for implementing overload protection of the site or limiting the maximum charge power of EVs when the EV and EVSE communicate via IEC61851 and with ISO15118 if the EV does not support the Optimization of Self Consumption usecase.

category recommendations: Sets a recommended charge power in A for each phase. This is mainly used if the EV and EVSE communicate via ISO15118 to support charging excess solar power. The EV either needs to support the Optimization of Self Consumption usecase or the EVSE needs to be able map the recommendations into oligation limits which then works for all EVs communication either via IEC61851 or ISO15118.

notes:

• For obligations to work for optimizing solar excess power, the EV needs to have an energy demand.
• Recommendations work even if the EV does not have an active energy demand, given it communicated with the EVSE via ISO15118 and supports the usecase.
• In ISO15118-2 the usecase is only supported via VAS extensions which are vendor specific and needs to have specific EVSE support for the specific EV brand.
• In ISO15118-20 this is a standard feature which does not need special support on the EVSE.
• Min power data is only provided via IEC61851 or using VAS in ISO15118-2.