You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: emhass/DOCS.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -44,7 +44,7 @@ These are the configuration parameters needed to correctly use this module.
44
44
- long_lived_token: A Long-Lived Access Token that can be created from the Lovelace profile page. This defaults to empty. If using the supervisor you can leave this to the default empty value.
45
45
- costfun: Define the type of cost function, this is optional and the options are: `profit` (default), `cost`, `self-consumption`
46
46
- optimization_time_step: The time step to resample retrieved data from hass. This parameter is given in minutes. It should not be defined too low or you will run into memory problems when defining the Linear Programming optimization. Defaults to 30.
47
-
- historic_days_to_retrieve: We will retrieve data from now and up to days_to_retrieve days. Defaults to 2.
47
+
- historic_days_to_retrieve: We will retrieve data from now and up to historic_days_to_retrieve days. Defaults to 2. This will be used for the `perfect-optim` task.
48
48
- method_ts_round: Set the method for timestamp rounding, options are: first, last and nearest.
49
49
- set_total_pv_sell: Set this parameter to true to consider that all the PV power produced is injected to the grid. No direct self-consumption. The default is false, for as system with direct self-consumption.
50
50
- lp_solver: Set the name of the linear programming solver that will be used. Defaults to 'COIN_CMD'. The options are 'PULP_CBC_CMD', 'GLPK_CMD' and 'COIN_CMD'.
description: Enter the URL of your Home Assistant instance. This defaults to empty. If using the supervisor you can leave this to the default empty value.
5
+
long_lived_token:
6
+
name: A Long-Lived Access Token
7
+
description: This can be created from the Lovelace profile page. This defaults to empty. If using the supervisor you can leave this to the default empty value.
8
+
costfun:
9
+
name: Define the type of cost function
10
+
description: This is optional and the options are profit (default), cost and self-consumption
11
+
optimization_time_step:
12
+
name: The time step to resample retrieved data from hass
13
+
description: This parameter is given in minutes. It should not be defined too low or you will run into memory problems when defining the Linear Programming optimization. Defaults to 30.
14
+
historic_days_to_retrieve:
15
+
name: The number of history days to retrieve for perfect-optim
16
+
description: We will retrieve data from now and up to historic_days_to_retrieve days. Defaults to 2. This will be used for the perfect-optim task.
17
+
method_ts_round:
18
+
name: Set the method for timestamp rounding
19
+
description: options are first, last and nearest.
20
+
set_total_pv_sell:
21
+
name: Set the total PV prouction to sell
22
+
description: Set this parameter to true to consider that all the PV power produced is injected to the grid. No direct self-consumption. The default is false, for as system with direct self-consumption.
23
+
lp_solver:
24
+
name: Linear programming solver
25
+
description: Set the name of the linear programming solver that will be used. Defaults to COIN_CMD. The options are PULP_CBC_CMD, GLPK_CMD and COIN_CMD.
26
+
lp_solver_path:
27
+
name: The path to the linear programming solver
28
+
description: Set the path to the LP solver. Defaults to /usr/bin/cbc.
29
+
sensor_power_photovoltaics:
30
+
name: The Home Assistant sensor for PV power production
31
+
description: This is the name of the photovoltaic produced power sensor in Watts from Home Assistant. For example sensor.power_photovoltaics.
32
+
sensor_power_load_no_var_loads:
33
+
name: The Home Assistant sensor for the load power without the deferrable loads
34
+
description: The name of the household power consumption sensor in Watts from Home Assistant. The deferrable loads that we will want to include in the optimization problem should be substracted from this sensor in HASS. For example sensor.power_load_no_var_loads.
35
+
number_of_deferrable_loads:
36
+
name: The number of deferrable loads
37
+
description: Define the number of deferrable loads to consider. Defaults to 2.
38
+
list_nominal_power_of_deferrable_loads:
39
+
name: The nominal power for each deferrable load in Watts
40
+
description: This is a list of comma separated values with a number of elements consistent with the number of deferrable loads defined before. For example 3000, 750
41
+
list_operating_hours_of_each_deferrable_load:
42
+
name: The total number of hours that each deferrable load should operate
43
+
description: A list of comma separated values. For example 5, 8
44
+
list_peak_hours_periods_start_hours:
45
+
name: This is a list of start hours of peak hours periods
46
+
description: A list of hours in 24h HH:MM format.
47
+
list_peak_hours_periods_end_hours:
48
+
name: This is a list of end hours of peak hours periods
49
+
description: A list of hours in 24h HH:MM format.
50
+
list_treat_deferrable_load_as_semi_cont:
51
+
name: A list to define if we should treat each deferrable load as a semi-continuous variable
52
+
description: Semi-continuous variables are variables that can take either their nominal value or zero.
53
+
load_peak_hours_cost:
54
+
name: The cost of the electrical energy during peak hours
55
+
description: The cost of the electrical energy from the grid during peak hours in €/kWh. Defaults to 0.1907.
56
+
load_offpeak_hours_cost:
57
+
name: The cost of the electrical energy during non-peak hours
58
+
description: The cost of the electrical energy from the grid during non-peak hours in €/kWh. Defaults to 0.1419.
59
+
photovoltaic_production_sell_price:
60
+
name: The paid price for energy injected to the grid
61
+
description: The paid price for energy injected to the grid from excedent PV production in €/kWh. Defaults to 0.065.
62
+
maximum_power_from_grid:
63
+
name: The maximum power from the grid
64
+
description: The maximum power that can be supplied by the utility grid in Watts. Defaults to 9000.
65
+
list_pv_module_model:
66
+
name: A list of the PV module model
67
+
description: For example 'CSUN_Eurasia_Energy_Systems_Industry_and_Trade_CSUN295_60M'. This parameter can be a list of strings to enable the simulation of mixed orientation systems, for example one east-facing array (azimuth=90) and one west-facing array (azimuth=270). When finding the correct model for your installation remember to replace all the special characters in the model name by '_'.
68
+
list_pv_inverter_model:
69
+
name: A list of the PV inverter model
70
+
description: For example 'Fronius_International_GmbH__Fronius_Primo_5_0_1_208_240__240V_'. This parameter can be a list of strings to enable the simulation of mixed orientation systems, for example one east-facing array (azimuth=90) and one west-facing array (azimuth=270). When finding the correct model for your installation remember to replace all the special characters in the model name by '_'.
71
+
list_surface_tilt:
72
+
name: The tilt angle of your solar panels
73
+
description: This is a value between 0 and 90. Defaults to 30. This parameter can be a list of integers to enable the simulation of mixed orientation systems, for example one east-facing array (azimuth=90) and one west-facing array (azimuth=270).
74
+
list_surface_azimuth:
75
+
name: The azimuth of your PV installation
76
+
description: This is a value between 0 and 360. Defaults to 205. This parameter can be a list of integers to enable the simulation of mixed orientation systems, for example one east-facing array (azimuth=90) and one west-facing array (azimuth=270).
77
+
list_modules_per_string:
78
+
name: The number of modules per string
79
+
description: Defaults to 16. This parameter can be a list of integers to enable the simulation of mixed orientation systems, for example one east-facing array and one west-facing array.
80
+
list_strings_per_inverter:
81
+
name: The number of used strings per inverter
82
+
description: Defaults to 1. This parameter can be a list of integers to enable the simulation of mixed orientation systems, for example one east-facing array and one west-facing array.
83
+
set_use_battery:
84
+
name: Set if a battery is present
85
+
description: Set to True if we should consider an energy storage device such as a Li-Ion battery. Defaults to False.
86
+
battery_discharge_power_max:
87
+
name: The maximum discharge power in Watts
88
+
description: Defaults to 1000.
89
+
battery_charge_power_max:
90
+
name: The maximum charge power in Watts
91
+
description: Defaults to 1000.
92
+
battery_discharge_efficiency:
93
+
name: The discharge efficiency
94
+
description: Defaults to 0.95.
95
+
battery_charge_efficiency:
96
+
name: The charge efficiency
97
+
description: Defaults to 0.95.
98
+
battery_nominal_energy_capacity:
99
+
name: The total capacity of the battery stack in Wh
100
+
description: Defaults to 5000.
101
+
battery_minimum_state_of_charge:
102
+
name: The minimun allowable battery state of charge
103
+
description: Defaults to 0.3.
104
+
battery_maximum_state_of_charge:
105
+
name: The maximum allowable battery state of charge
106
+
description: Defaults to 0.9.
107
+
battery_target_state_of_charge:
108
+
name: The desired battery state of charge at the end of each optimization cycle
0 commit comments