ecoControl
Getting Started
Install Requirements
How to Run ecoControl Locally
How to Deploy ecoControl
REST API Documentation
List of All API End Points
General
Technician
Manager
Models
Devices
Forecasting
Simulation
Statistical Forecasting
Holt-Winters Methods
Weather
Helping functions for Forecasting
Forecasts
Auto-Optimization
Front End
Structure
Multi-language Support
ecoControl
Docs
»
Edit on GitHub
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
|
W
A
add_energy() (PowerMeter method)
(SimulatedHeatStorage method)
(SimulatedPowerMeter method)
additive() (in module server.forecasting.statistical.holt_winters)
API
append_values() (DayTypeForecast method)
(DSHWForecast method)
(StatisticalForecast method)
approximate_index() (in module server.forecasting.helpers)
auto_optimize() (in module server.forecasting.optimizing.auto_optimization)
B
base_temperature (HeatStorage attribute)
BaseDevice (class in server.devices.base)
BaseEnvironment (class in server.devices.base)
BilanceResult (class in server.forecasting.optimizing.auto_optimization)
BOOL (Configuration attribute)
(DeviceConfiguration attribute)
C
cached_data() (in module server.forecasting.helpers)
calculate() (SimulatedThermalConsumer method)
calculate_new_workload() (SimulatedCogenerationUnit method)
calculate_workload() (SimulatedPeakLoadBoiler method)
Choltwinters (module)
CogenerationUnit (class in server.devices.producers)
,
[1]
Configuration (class in server.models)
Configuration.DoesNotExist
Configuration.MultipleObjectsReturned
connected() (CogenerationUnit method)
,
[1]
(ElectricalConsumer method)
(PeakLoadBoiler method)
,
[1]
(ThermalConsumer method)
consume_and_produce_energy() (SimulatedCogenerationUnit method)
(SimulatedPeakLoadBoiler method)
consume_energy() (PowerMeter method)
(SimulatedHeatStorage method)
(SimulatedPowerMeter method)
CU (Device attribute)
current_electrical_production (CogenerationUnit attribute)
,
[1]
current_gas_consumption (CogenerationUnit attribute)
,
[1]
(PeakLoadBoiler attribute)
,
[1]
current_thermal_production (CogenerationUnit attribute)
,
[1]
(PeakLoadBoiler attribute)
,
[1]
CurrentWeatherForecast (class in server.forecasting.weather)
D
daily_demand (ThermalConsumer attribute)
Danger (Threshold attribute)
DataLoader (class in server.forecasting.dataloader)
DATE (Configuration attribute)
(DeviceConfiguration attribute)
DayTypeForecast (class in server.forecasting.statistical)
Default (Threshold attribute)
DEFAULT_FORECAST_INTERVAL (in module server.forecasting.optimizing.auto_optimization)
demo_mode (BaseEnvironment attribute)
DemoSimulation (class in server.forecasting)
DemoWeather (class in server.forecasting.weather)
Device (class in server.models)
device (DeviceConfiguration attribute)
(Sensor attribute)
Device.DoesNotExist
Device.MultipleObjectsReturned
DEVICE_TYPES (Device attribute)
DeviceConfiguration (class in server.models)
DeviceConfiguration.DoesNotExist
DeviceConfiguration.MultipleObjectsReturned
deviceconfiguration_set (Device attribute)
double_seasonal() (in module server.forecasting.statistical.holt_winters)
DSHWForecast (class in server.forecasting.statistical)
E
EC (Device attribute)
electrical_costs (PowerMeter attribute)
ElectricalConsumer (class in server.devices.consumers)
empty_count (SimulatedHeatStorage attribute)
energy_consumed (PowerMeter attribute)
energy_produced (PowerMeter attribute)
energy_stored() (SimulatedHeatStorage method)
estimate_cost() (in module server.forecasting.optimizing.auto_optimization)
evenly_sampled() (server.forecasting.dataloader.DataLoader class method)
F
fed_in_electricity (PowerMeter attribute)
feed_in_reward (PowerMeter attribute)
find_city() (CurrentWeatherForecast method)
find_optimal_config() (in module server.forecasting.optimizing.auto_optimization)
FLOAT (Configuration attribute)
(DeviceConfiguration attribute)
forecast (BaseEnvironment attribute)
Forecast (class in server.forecasting)
forecast_demands() (DayTypeForecast method)
(DSHWForecast method)
(StatisticalForecast method)
ForecastQueue (class in server.forecasting)
Front End
G
gas_costs (CogenerationUnit attribute)
,
[1]
(PeakLoadBoiler attribute)
,
[1]
get() (Forecast method)
get_average_outside_temperature() (CurrentWeatherForecast method)
get_by_id() (ForecastQueue method)
get_calculated_workload_electric() (SimulatedCogenerationUnit method)
get_calculated_workload_thermal() (SimulatedCogenerationUnit method)
get_category_display() (Threshold method)
get_consumption_energy() (SimulatedElectricalConsumer method)
(SimulatedThermalConsumer method)
get_consumption_power() (SimulatedElectricalConsumer method)
get_costs() (PowerMeter method)
get_day_of_year() (BaseEnvironment method)
get_device_type_display() (Device method)
get_efficiency_loss_factor() (SimulatedCogenerationUnit method)
get_electrical_energy_production() (SimulatedCogenerationUnit method)
get_energy_capacity() (SimulatedHeatStorage method)
get_forecast() (in module server.forecasting)
get_forecast_at() (StatisticalForecast method)
get_forecast_temperature_daily() (CurrentWeatherForecast method)
get_forecast_temperature_hourly() (CurrentWeatherForecast method)
get_initialized_scenario() (in module server.devices)
(in module server.forecasting)
get_next_by_target_time() (WeatherValue method)
get_next_by_timestamp() (RealWeatherValue method)
(SensorValue method)
(SensorValueDaily method)
(SensorValueHourly method)
(SensorValueMonthlyAvg method)
(SensorValueMonthlySum method)
(WeatherValue method)
get_openweathermapdata() (CurrentWeatherForecast method)
get_operating_costs() (CogenerationUnit method)
,
[1]
(PeakLoadBoiler method)
,
[1]
get_outside_temperature() (SimulatedThermalConsumer method)
get_previous_by_target_time() (WeatherValue method)
get_previous_by_timestamp() (RealWeatherValue method)
(SensorValue method)
(SensorValueDaily method)
(SensorValueHourly method)
(SensorValueMonthlyAvg method)
(SensorValueMonthlySum method)
(WeatherValue method)
get_required_energy() (SimulatedHeatStorage method)
get_reward() (PowerMeter method)
get_target_energy() (SimulatedHeatStorage method)
get_temperature() (DemoWeather method)
(SimulatedHeatStorage method)
(in module server.forecasting.weather)
get_temperature_estimate() (CurrentWeatherForecast method)
(DemoWeather method)
get_thermal_energy_production() (SimulatedCogenerationUnit method)
(SimulatedPeakLoadBoiler method)
get_user_function() (in module server.devices)
get_value_type_display() (Configuration method)
(DeviceConfiguration method)
get_warmwater_consumption_energy() (SimulatedThermalConsumer method)
get_warmwater_consumption_power() (SimulatedThermalConsumer method)
get_weather_forecast() (CurrentWeatherForecast method)
Getting Started
H
heat_apartments() (SimulatedThermalConsumer method)
heat_loss_power() (SimulatedThermalConsumer method)
HeatStorage (class in server.devices.storages)
HS (Device attribute)
I
Info (Threshold attribute)
initial_date (BaseEnvironment attribute)
INT (Configuration attribute)
(DeviceConfiguration attribute)
interpolate_year() (in module server.forecasting.helpers)
is_demo_simulation() (BaseEnvironment method)
L
linear() (in module server.forecasting.statistical.holt_winters)
load_from_file() (server.forecasting.dataloader.DataLoader class method)
M
make_hourly() (server.forecasting.statistical.StatisticalForecast class method)
MASE() (in module server.forecasting.statistical.holt_winters)
(server.forecasting.statistical.StatisticalForecast class method)
MSE() (in module server.forecasting.statistical.holt_winters)
multiplicative() (in module server.forecasting.statistical.holt_winters)
N
Notification (class in server.models)
Notification.DoesNotExist
Notification.MultipleObjectsReturned
notification_set (SensorValue attribute)
(Threshold attribute)
O
objects (Configuration attribute)
(Device attribute)
(DeviceConfiguration attribute)
(Notification attribute)
(RealWeatherValue attribute)
(Sensor attribute)
(SensorValue attribute)
(SensorValueDaily attribute)
(SensorValueHourly attribute)
(SensorValueMonthlyAvg attribute)
(SensorValueMonthlySum attribute)
(Threshold attribute)
(WeatherValue attribute)
off_time (SimulatedCogenerationUnit attribute)
(SimulatedPeakLoadBoiler attribute)
overwrite_workload (SimulatedCogenerationUnit attribute)
(SimulatedPeakLoadBoiler attribute)
P
PeakLoadBoiler (class in server.devices.producers)
,
[1]
perdelta() (in module server.forecasting.helpers)
perform_configuration() (in module server.devices)
PLB (Device attribute)
PM (Device attribute)
PowerMeter (class in server.devices.storages)
Primary (Threshold attribute)
process_inputdata() (DayTypeForecast method)
(DSHWForecast method)
(StatisticalForecast method)
purchased (PowerMeter attribute)
R
read_from_cache() (StatisticalForecast method)
RealWeatherValue (class in server.models)
RealWeatherValue.DoesNotExist
RealWeatherValue.MultipleObjectsReturned
room_height (ThermalConsumer attribute)
run() (DemoSimulation method)
(Forecast method)
S
schedule_new() (ForecastQueue method)
Sensor (class in server.models)
sensor (SensorValue attribute)
(SensorValueDaily attribute)
(SensorValueHourly attribute)
(SensorValueMonthlyAvg attribute)
(SensorValueMonthlySum attribute)
(Threshold attribute)
Sensor.DoesNotExist
Sensor.MultipleObjectsReturned
sensor_set (Device attribute)
sensor_value (Notification attribute)
SensorValue (class in server.models)
SensorValue.DoesNotExist
SensorValue.MultipleObjectsReturned
sensorvalue_set (Sensor attribute)
SensorValueDaily (class in server.models)
SensorValueDaily.DoesNotExist
SensorValueDaily.MultipleObjectsReturned
sensorvaluedaily_set (Sensor attribute)
SensorValueHourly (class in server.models)
SensorValueHourly.DoesNotExist
SensorValueHourly.MultipleObjectsReturned
sensorvaluehourly_set (Sensor attribute)
SensorValueMonthlyAvg (class in server.models)
SensorValueMonthlyAvg.DoesNotExist
SensorValueMonthlyAvg.MultipleObjectsReturned
sensorvaluemonthlyavg_set (Sensor attribute)
SensorValueMonthlySum (class in server.models)
SensorValueMonthlySum.DoesNotExist
SensorValueMonthlySum.MultipleObjectsReturned
sensorvaluemonthlysum_set (Sensor attribute)
server.devices (module)
server.devices.base (module)
server.devices.consumers (module)
server.devices.producers (module)
server.devices.storages (module)
server.forecasting (module)
server.forecasting.dataloader (module)
server.forecasting.helpers (module)
server.forecasting.optimizing.auto_optimization (module)
server.forecasting.simulation.devices.consumers (module)
server.forecasting.simulation.devices.producers (module)
server.forecasting.simulation.devices.storages (module)
server.forecasting.statistical (module)
server.forecasting.statistical.holt_winters (module)
server.forecasting.weather (module)
server.models (module)
set_temperature() (SimulatedHeatStorage method)
set_workload() (SimulatedCogenerationUnit method)
simplified_forecast() (in module server.forecasting.optimizing.auto_optimization)
simulate_consumption() (SimulatedThermalConsumer method)
SimulatedCogenerationUnit (class in server.forecasting.simulation.devices.producers)
SimulatedElectricalConsumer (class in server.forecasting.simulation.devices.consumers)
SimulatedHeatStorage (class in server.forecasting.simulation.devices.storages)
SimulatedPeakLoadBoiler (class in server.forecasting.simulation.devices.producers)
SimulatedPowerMeter (class in server.forecasting.simulation.devices.storages)
SimulatedThermalConsumer (class in server.forecasting.simulation.devices.consumers)
specific_heat_capacity (HeatStorage attribute)
start() (DemoSimulation method)
start_or_get() (server.forecasting.DemoSimulation class method)
StatisticalForecast (class in server.forecasting.statistical)
step() (Forecast method)
(SimulatedCogenerationUnit method)
(SimulatedElectricalConsumer method)
(SimulatedHeatStorage method)
(SimulatedPeakLoadBoiler method)
(SimulatedPowerMeter method)
(SimulatedThermalConsumer method)
step_size (BaseEnvironment attribute)
store_values() (DemoSimulation method)
(Forecast method)
STR (Configuration attribute)
(DeviceConfiguration attribute)
Success (Threshold attribute)
T
TC (Device attribute)
temperature_loss (SimulatedHeatStorage attribute)
temperature_warmwater (ThermalConsumer attribute)
ThermalConsumer (class in server.devices.consumers)
Threshold (class in server.models)
threshold (Notification attribute)
Threshold.DoesNotExist
Threshold.MultipleObjectsReturned
threshold_set (Sensor attribute)
total_costs() (in module server.forecasting.optimizing.auto_optimization)
total_electrical_production (CogenerationUnit attribute)
,
[1]
total_gas_consumption (CogenerationUnit attribute)
,
[1]
(PeakLoadBoiler attribute)
,
[1]
total_thermal_production (CogenerationUnit attribute)
,
[1]
(PeakLoadBoiler attribute)
,
[1]
TYPES (Configuration attribute)
(DeviceConfiguration attribute)
(Threshold attribute)
U
undersupplied() (SimulatedHeatStorage method)
update_if_needed() (StatisticalForecast method)
W
Warning (Threshold attribute)
WeatherValue (class in server.models)
WeatherValue.DoesNotExist
WeatherValue.MultipleObjectsReturned
workload() (CogenerationUnit method)
,
[1]
workload_percent() (PeakLoadBoiler method)
,
[1]
Read the Docs
v: latest
Versions
stable
latest
Downloads
HTML
Epub
On Read the Docs
Project Home
Builds
Free document hosting provided by
Read the Docs
.