×
Menu
Index

Methods Defined Here

 
get_chp_data (...)
    get_chp_data()->[CHP data dictionary]
   
    Returns all CHP data.
    Dictionary fields are:
 
      is_enabled
 Whether CHP data is enabled
      source_meter
 Source meter name
      electrical_generation_meter
 Electrical generation meter name
      quality_index
 Quality index
      rated_heat_output
 Heat output
      rated_thermal_efficiency
 Thermal efficiency at rated output
      rated_power_efficiency
 Power efficiency at rated output
      min_fraction_rated_heat_output
 Fraction of rated heat
      min_thermal_efficiency
 Minimum thermal efficiency
      min_power_efficiency
 Minmum power efficiency
      profile
 Name of profile for heat matching strategy
 
get_pv_data (...)
    get_pv_data()->[List of dictionaries]
   
    Returns data for all PVs.
    Dictionary fields are:
 
      id
ID of the PV panel
      description
PV panel description
      type_id
PV type ID. Use with get_pv_type_by_id() to get PV type data
      area
Area of the PV panel
      azimuth
Azimuth of the PV
      inclination
PV inclination
      shading_factor
PV shading factor
 
get_pv_data_by_id (...)
    get_pv_data_by_id(id)->[Dictionary of PV data]
   
    Returns PV data from the given ID.
    Dictionary fields are:
 
      id
ID of the PV panel
      description
PV panel description
      type_id
PV type ID. Use with get_pv_type_by_id() to get     PV type data
      area
Area of the PV panel
      azimuth
Azimuth of the PV
      inclination
PV inclination
      shading_factor
PV shading factor
 
 
    Args:
      id (string): ID of the PV to get.
 
get_pv_type_by_id (...)
    get_pv_type_by_id(id)->[Dictionary of PV type data]
   
    Returns data for a PV type from the given ID.
    Dictionary fields are:
 
      id
 ID of the PV type
      description
 PV type description
      technology
 Name of PV type technology
      module_nominal_efficiency
 Module nominal efficiency
      noct
 Nominal cell temperature (NOCT)
      ref_irradiance
 Reference irradiance for NOCT
      temp_coefficient
 Temperature coefficient for module efficiency
      degradation_factor
 Degradation factor
      electrical_conversion_efficiency
 Electrical conversion efficiency
      meter
 Name of energy meter
 
    Args:
      id (string): ID of the PV type to get.
 
get_pv_types (...)
    get_pv_types()->[List of PV type data dictionaries]
   
    Returns data for all PV types.
    Dictionary fields are:
 
      id
 ID of the PV type
      description
 PV type description
      technology
 Name of PV type technology
      module_nominal_efficiency
 Module nominal efficiency
      noct
 Nominal cell temperature (NOCT)
      ref_irradiance
 Reference irradiance for NOCT
      temp_coefficient
 Temperature coefficient for module efficiency
      degradation_factor
 Degradation factor
      electrical_conversion_efficiency
 Electrical conversion efficiency
      meter
 Name of energy meter
 
get_wind_data (...)
    get_wind_data()->[Wind data dictionary]
   
    Returns all wind data.
    Dictionary fields are:
 
      is_enabled
 Whether wind data is enabled
      hub_height
 Hub height
      rated_power
 Rated power
      meter
 Energy meter name
 
set_chp_data (Dictionary of CHP data)
Sets CHP data.
Possible dictionary entries are:
 
is_enabled
quality_index
rated_heat_output
rated_thermal_efficiency
rated_power_efficiency
min_fraction_rated_heat_output
min_thermal_efficiency
min_power_efficiency
profile
 
set_pv_data (Dictionary of PV data, id)
Sets data for a PV panel.
Possible dictionary entries are:
 
description
type_id
area
azimuth
inclination
shading_factor
 
set_pv_type_data (Dictionary of PV type data, id)
Sets data for a PV type.
Possible dictionary entries are:
 
description
technology
module_nominal_efficiency
noct
ref_irradiance
temp_coefficient
degradation_factor
electrical_conversion_efficiency
 
set_wind_data (Dictionary of wind data)
Sets wind data.
Possible dictionary entries are:
 
is_enabled
hub_height
rated_power