package
0.0.0-20240908172838-7bcebe7d766f
Repository: https://github.com/evcc-io/evcc.git
Documentation: pkg.go.dev
# Functions
BatteryModeString retrieves an enum value from the enum constants string name.
BatteryModeStrings returns a slice of all String values of the enum.
BatteryModeValues returns all values of the enum.
ChargeModeString converts string to ChargeMode.
ChargeStatusString converts a string to ChargeStatus.
ChargeStatusStringWithMapping converts a string to ChargeStatus.
FeatureString retrieves an enum value from the enum constants string name.
FeatureStrings returns a slice of all String values of the enum.
FeatureValues returns all values of the enum.
NewMockBattery creates a new mock instance.
NewMockBatteryController creates a new mock instance.
NewMockCharger creates a new mock instance.
NewMockChargeRater creates a new mock instance.
NewMockChargeState creates a new mock instance.
NewMockCircuit creates a new mock instance.
NewMockCurrentGetter creates a new mock instance.
NewMockCurrentLimiter creates a new mock instance.
NewMockIdentifier creates a new mock instance.
NewMockMeter creates a new mock instance.
NewMockMeterEnergy creates a new mock instance.
NewMockPhaseCurrents creates a new mock instance.
NewMockPhaseGetter creates a new mock instance.
NewMockPhaseSwitcher creates a new mock instance.
NewMockTariff creates a new mock instance.
NewMockVehicle creates a new mock instance.
ReasonString retrieves an enum value from the enum constants string name.
ReasonStrings returns a slice of all String values of the enum.
ReasonValues returns all values of the enum.
TariffTypeString retrieves an enum value from the enum constants string name.
TariffTypeStrings returns a slice of all String values of the enum.
TariffTypeValues returns all values of the enum.
# Constants
go:generate enumer -type BatteryMode -trimprefix Battery -transform=lower.
go:generate enumer -type BatteryMode -trimprefix Battery -transform=lower.
go:generate enumer -type BatteryMode -trimprefix Battery -transform=lower.
go:generate enumer -type BatteryMode -trimprefix Battery -transform=lower.
go:generate enumer -type Feature -text.
Custom meter/charger/vehicle type.
go:generate enumer -type Feature -text.
go:generate enumer -type Feature -text.
Charge modes.
Charge modes.
Charge modes.
Charge modes.
Charge modes.
go:generate enumer -type Feature -text.
go:generate enumer -type Reason -trimprefix Reason -transform=lower.
go:generate enumer -type Reason -trimprefix Reason -transform=lower.
go:generate enumer -type Reason -trimprefix Reason -transform=lower.
go:generate enumer -type Feature -text.
Fzg.
Fzg.
Fzg.
Fzg.
Fzg.
Fzg.
Charging states.
go:generate enumer -type Feature -text.
# Variables
ErrAsleep indicates that vehicle is asleep.
ErrMissingCredentials indicates that user/password are missing.
ErrMustRetry indicates that a rate-limited operation should be retried.
ErrNotAvailable indicates that a feature is not available.
ErrOutdated indicates that result is outdated.
ErrSponsorRequired indicates that a sponsor token is required.
ErrTimeout is the error returned when a timeout happened.
# Structs
ActionConfig defines an action to take on event.
MockBattery is a mock of Battery interface.
MockBatteryController is a mock of BatteryController interface.
MockBatteryControllerMockRecorder is the mock recorder for MockBatteryController.
MockBatteryMockRecorder is the mock recorder for MockBattery.
MockCharger is a mock of Charger interface.
MockChargeRater is a mock of ChargeRater interface.
MockChargeRaterMockRecorder is the mock recorder for MockChargeRater.
MockChargerMockRecorder is the mock recorder for MockCharger.
MockChargeState is a mock of ChargeState interface.
MockChargeStateMockRecorder is the mock recorder for MockChargeState.
MockCircuit is a mock of Circuit interface.
MockCircuitMockRecorder is the mock recorder for MockCircuit.
MockCurrentGetter is a mock of CurrentGetter interface.
MockCurrentGetterMockRecorder is the mock recorder for MockCurrentGetter.
MockCurrentLimiter is a mock of CurrentLimiter interface.
MockCurrentLimiterMockRecorder is the mock recorder for MockCurrentLimiter.
MockIdentifier is a mock of Identifier interface.
MockIdentifierMockRecorder is the mock recorder for MockIdentifier.
MockMeter is a mock of Meter interface.
MockMeterEnergy is a mock of MeterEnergy interface.
MockMeterEnergyMockRecorder is the mock recorder for MockMeterEnergy.
MockMeterMockRecorder is the mock recorder for MockMeter.
MockPhaseCurrents is a mock of PhaseCurrents interface.
MockPhaseCurrentsMockRecorder is the mock recorder for MockPhaseCurrents.
MockPhaseGetter is a mock of PhaseGetter interface.
MockPhaseGetterMockRecorder is the mock recorder for MockPhaseGetter.
MockPhaseSwitcher is a mock of PhaseSwitcher interface.
MockPhaseSwitcherMockRecorder is the mock recorder for MockPhaseSwitcher.
MockTariff is a mock of Tariff interface.
MockTariffMockRecorder is the mock recorder for MockTariff.
MockVehicle is a mock of Vehicle interface.
MockVehicleMockRecorder is the mock recorder for MockVehicle.
Rate is a grid tariff rate.
# Interfaces
Authorizer authorizes a charging session by supplying RFID credentials.
AuthProvider is the ability to provide OAuth authentication through the ui.
Battery provides battery Soc in %.
BatteryCapacity provides a capacity in kWh.
BatteryController optionally allows to control home battery (dis)charging behaviour.
ChargeController allows to start/stop the charging session on the vehicle side.
Charger provides current charging status and enable/disable charging.
ChargeRater provides charged energy amount in kWh.
ChargerEx provides milli-amp precision charger current control.
ChargeState provides current charging status.
ChargeTimer provides current charge cycle duration.
Circuit defines the load control domain.
CircuitLoad represents a loadpoint attached to a circuit.
CircuitMeasurements is the measurements a circuit or load must deliver.
CsvWriter converts to csv.
CurrentController provides settings charging maximum charging current.
CurrentGetter provides getting charging maximum charging current for validation.
CurrentLimiter returns the current limits.
Diagnosis is a helper interface that allows to dump diagnostic data to console.
FeatureDescriber optionally provides a list of supported non-api features.
IconDescriber optionally provides an icon.
Identifier identifies a vehicle and is implemented by the charger.
Meter provides total active power in W.
MeterEnergy provides total energy in kWh.
PhaseCurrents provides per-phase current A.
PhaseDescriber returns the number of availablephases.
PhasePowers provides signed per-phase power W.
PhaseSwitcher provides 1p3p switching.
PhaseVoltages provides per-phase voltage V.
Resurrector provides wakeup calls to the vehicle with an API call or a CP interrupt from the charger.
SocLimiter returns the soc limit.
Tariff is a tariff capable of retrieving tariff rates.
Vehicle represents the EV and it's battery.
VehicleClimater provides climatisation data.
VehicleFinishTimer provides estimated charge cycle finish time.
VehicleOdometer returns the vehicles milage.
VehiclePosition returns the vehicles position in latitude and longitude.
VehicleRange provides the vehicles remaining km range.
# Type aliases
BatteryMode is the home battery operation mode.
ChargeMode is the charge operation mode.
ChargeStatus is the EV's charging status from A to F.
Rates is a slice of (future) tariff rates.