providers

Documentation

Index

• func IsSupported(providerType string) bool
• type EmissionsType
  • func GetSupportedEmissionsTypes() []EmissionsType
• type Provider
  • func GetProvider(ctx context.Context, req ctrl.Request, kClient client.Client, ...) (Provider, error)
• type ProviderType
  • func GetSupportedProviders() []ProviderType

Functions

func IsSupported

func IsSupported(providerType string) bool

Types

type EmissionsType

type EmissionsType string

const (
	Average  EmissionsType = "average"
	Marginal EmissionsType = "marginal"
)

func GetSupportedEmissionsTypes

func GetSupportedEmissionsTypes() []EmissionsType

type Provider

type Provider interface {
	GetCurrent(ctx context.Context, zone string) (float64, error)
	GetForecast(ctx context.Context, zone string) (map[time.Time]float64, error)
}

func GetProvider

func GetProvider(
	ctx context.Context,
	req ctrl.Request,
	kClient client.Client,
	providerRef *v1.ObjectReference,
) (Provider, error)

type ProviderType

type ProviderType string

const (
	WattTime        ProviderType = "watttime"
	ElectricityMaps ProviderType = "electricitymaps"
	Simulator       ProviderType = "simulator"
)

func GetSupportedProviders

func GetSupportedProviders() []ProviderType