citylearn.electric_vehicle_charger module

class citylearn.electric_vehicle_charger.Charger(nominal_power: float, efficiency: float = None, charger_id: str = None, charger_type: int = None, max_charging_power: float = None, min_charging_power: float = None, max_discharging_power: float = None, min_discharging_power: float = None, charge_efficiency_curve: Dict[float, float] = None, discharge_efficiency_curve: Dict[float, float] = None, connected_electric_vehicle: ElectricVehicle = None, incoming_electric_vehicle: ElectricVehicle = None, **kwargs)[source]

Bases: Environment

associate_incoming_car(electric_vehicle: ElectricVehicle)[source]

Associates incoming electric_vehicle to the charger.

Parameters:

electric_vehicle (object) – electric_vehicle instance to be connected to the charger.

Raises:

ValueError – If the charger has reached its maximum associated electric_vehicle’ capacity.

property available_nominal_power: float

Difference between nominal_power and electricity_consumption at current time_step.

property charge_efficiency_curve: dict

Efficiency curve for charging containing power levels and corresponding efficiency values.

property charger_id: str

ID of the charger.

property charger_type: int

Type of the charger.

property connected_electric_vehicle: ElectricVehicle

Electric_Vehicle currently connected to charger

disassociate_incoming_car()[source]

Disassociates incoming electric_vehicle from the charger.

Parameters:

electric_vehicle (object) – electric_vehicle instance to be disconnected from the charger.

property discharge_efficiency_curve: dict

Efficiency curve for discharging containing power levels and corresponding efficiency values.

property efficiency: float

Technical efficiency.

property electricity_consumption: List[float]

Electricity consumption time series.

property incoming_electric_vehicle: ElectricVehicle

Electric_Vehicle incoming to charger

property max_charging_power: float

Maximum charging power in kW.

property max_discharging_power: float

Maximum discharging power in kW.

property min_charging_power: float

Minimum charging power in kW.

property min_discharging_power: float

Minimum discharging power in kW.

next_time_step()[source]

Advance to next time_step and set electricity_consumption at new time_step to 0.0.

property nominal_power: float

Nominal power.

property past_charging_action_values: List[float]

Actions given to charge/discharge in [kWh]. Different from the electricity consumption as in this an action can be given but no electric_vehicle being connect it will not consume such energy

property past_connected_evs: List[ElectricVehicle]

Each timestep with the list of Past connected Evs or None in the case no electric_vehicle was connected

plug_car(electric_vehicle: ElectricVehicle)[source]

Connects a electric_vehicle to the charger.

Parameters:

electric_vehicle (object) – electric_vehicle instance to be connected to the charger.

Raises:

ValueError – If the charger has reached its maximum connected electric_vehicle’ capacity.

reset()[source]

Resets the Charger to its initial state by disconnecting all electric_vehicles.

unplug_car()[source]

Disconnects a electric_vehicle from the charger.

Parameters:

electric_vehicle (object) – electric_vehicle instance to be disconnected from the charger.

update_connected_electric_vehicle_soc(action_value: float)[source]