site

Documentation

Index

• type API
• type Vehicles

Types

type API

type API interface {
	Healthy() bool
	Loadpoints() []loadpoint.API
	Vehicles() Vehicles

	// Meta
	GetTitle() string
	SetTitle(string)

	// Config
	GetGridMeterRef() string
	SetGridMeterRef(string)
	GetPVMeterRefs() []string
	SetPVMeterRefs([]string)
	GetBatteryMeterRefs() []string
	SetBatteryMeterRefs([]string)

	// circuits
	GetCircuit() api.Circuit
	SetCircuit(api.Circuit)

	GetPrioritySoc() float64
	SetPrioritySoc(float64) error
	GetBufferSoc() float64
	SetBufferSoc(float64) error
	GetBufferStartSoc() float64
	SetBufferStartSoc(float64) error

	// GetBatteryGridChargeLimit get the grid charge limit
	GetBatteryGridChargeLimit() *float64
	// SetBatteryGridChargeLimit sets the grid charge limit
	SetBatteryGridChargeLimit(limit *float64)

	GetResidualPower() float64
	SetResidualPower(float64) error

	// GetTariff returns the respective tariff
	GetTariff(string) api.Tariff

	GetBatteryDischargeControl() bool
	SetBatteryDischargeControl(bool) error
}

API is the external site API

type Vehicles

type Vehicles interface {
	// Settings returns the list of vehicle adapters
	Settings() []vehicle.API

	// ByName returns a single vehicle adapter by name
	ByName(string) (vehicle.API, error)

	// All returns the list of vehicle instances
	Instances() []api.Vehicle
}