Preheat_open
Contents:
Welcome to the preheat_open Quick Start Guide!
Loading a Location
Getting units, zones, components etc.
Getting measurements
Getting setpoint schedules, electricity prices and comfort profiles
Posting a setpoint schedule
Package Documentation
Tutorials
Preheat_open
Index
Index
_
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
I
|
L
|
M
|
N
|
O
|
P
|
Q
|
R
|
S
|
T
|
U
|
V
|
W
|
Z
_
__init__() (preheat_open.api.adapter.ApiAdapter method)
(preheat_open.api.adapter.EndpointInformation method)
(preheat_open.api.adapter.MeasurementEndpointType method)
(preheat_open.api.adapter.MeasurementsGetter method)
(preheat_open.api.adapter.TimestampType method)
(preheat_open.api.cache.Cache method)
(preheat_open.api.cache.CacheItem method)
(preheat_open.api.cache.ShelveCache method)
(preheat_open.api.cache.SimplePickleCache method)
(preheat_open.api.configuration.CacheConfig method)
(preheat_open.api.configuration.CaseConverter method)
(preheat_open.api.configuration.ConfigBase method)
(preheat_open.api.configuration.ConfigLoader method)
(preheat_open.api.configuration.LoggingConfig method)
(preheat_open.api.configuration.NeogridApiConfig method)
(preheat_open.api.configuration.PersonalConfig method)
(preheat_open.api.configuration.RuntimeMode method)
(preheat_open.api.configuration.UpdateProxy method)
(preheat_open.api.factories.AppliedPriceComponentFactory method)
(preheat_open.api.factories.AuthorityFactory method)
(preheat_open.api.factories.ComfortProfileFactory method)
(preheat_open.api.factories.ComfortProfilesFactory method)
(preheat_open.api.factories.ControlSettingFactory method)
(preheat_open.api.factories.ControlSettingsFactory method)
(preheat_open.api.factories.DeviceComponentFactory method)
(preheat_open.api.factories.DeviceFactory method)
(preheat_open.api.factories.ElectricityPriceItemFactory method)
(preheat_open.api.factories.FixedPriceDataFactory method)
(preheat_open.api.factories.FixedPricePeriodFactory method)
(preheat_open.api.factories.LocationCharacteristicsFactory method)
(preheat_open.api.factories.LocationFactory method)
(preheat_open.api.factories.LocationInformationFactory method)
(preheat_open.api.factories.PriceAreaFactory method)
(preheat_open.api.factories.PriceComponentFactory method)
(preheat_open.api.factories.PriceComponentTypeFactory method)
(preheat_open.api.factories.PriceDataFactory method)
(preheat_open.api.factories.ScheduleItemFactory method)
(preheat_open.api.factories.SetpointFactory method)
(preheat_open.api.factories.SupplyPointFactory method)
(preheat_open.api.factories.UnitComponentFactory method)
(preheat_open.api.factories.UnitFactory method)
(preheat_open.api.factories.WeatherComponentFactory method)
(preheat_open.api.factories.WeatherFactory method)
(preheat_open.api.factories.ZoneFactory method)
(preheat_open.api.mocks.CCDailyPeriodic method)
(preheat_open.api.mocks.CCMonotonicAscending method)
(preheat_open.api.mocks.CCNoisy method)
(preheat_open.api.mocks.CCRangeConstricted method)
(preheat_open.api.mocks.CCYearlyPeriodic method)
(preheat_open.api.mocks.ComponentCharacteristic method)
(preheat_open.api.mocks.MockApiAdapter method)
(preheat_open.api.session.ApiSession method)
(preheat_open.api.types.BuildingType method)
(preheat_open.api.types.ComponentQuery method)
(preheat_open.api.types.ComponentType method)
(preheat_open.api.types.ControlSettingDataType method)
(preheat_open.api.types.ControlSettingType method)
(preheat_open.api.types.ControlSettingUiType method)
(preheat_open.api.types.DeviceQuery method)
(preheat_open.api.types.RelatedUnitType method)
(preheat_open.api.types.UnitDescriptorType method)
(preheat_open.api.types.UnitQuery method)
(preheat_open.api.types.UnitSubType method)
(preheat_open.api.types.UnitType method)
(preheat_open.api.types.ZoneQuery method)
(preheat_open.collection.Collection method)
(preheat_open.interfaces.Adapter method)
(preheat_open.interfaces.BuildingModel method)
(preheat_open.interfaces.Factory method)
(preheat_open.loadable_types.ComfortProfile method)
(preheat_open.loadable_types.ComfortProfiles method)
(preheat_open.loadable_types.ComponentData method)
(preheat_open.loadable_types.ElectricityPriceItem method)
(preheat_open.loadable_types.ElectricityPrices method)
(preheat_open.loadable_types.LoadableData method)
(preheat_open.loadable_types.LoadableDataType method)
(preheat_open.loadable_types.OperationType method)
(preheat_open.loadable_types.ScheduleItem method)
(preheat_open.loadable_types.Setpoint method)
(preheat_open.loadable_types.SetpointSchedule method)
(preheat_open.location.Location method)
(preheat_open.location.LocationCharacteristics method)
(preheat_open.location.LocationInformation method)
(preheat_open.measurements.AttrMap method)
(preheat_open.measurements.MapItem method)
(preheat_open.measurements.Mapper method)
(preheat_open.measurements.MeasurementRequest method)
(preheat_open.measurements.MeasurementRequestHandler method)
(preheat_open.measurements.MeasurementsRetriever method)
(preheat_open.measurements.PostProcess method)
(preheat_open.measurements.StrMap method)
(preheat_open.query.Query method)
(preheat_open.supplypoint.ApplicationContext method)
(preheat_open.supplypoint.ApplicationType method)
(preheat_open.supplypoint.AppliedPriceComponent method)
(preheat_open.supplypoint.Authority method)
(preheat_open.supplypoint.BillingContext method)
(preheat_open.supplypoint.FixedPriceData method)
(preheat_open.supplypoint.FixedPricePeriod method)
(preheat_open.supplypoint.FormatType method)
(preheat_open.supplypoint.PriceArea method)
(preheat_open.supplypoint.PriceComponent method)
(preheat_open.supplypoint.PriceComponentType method)
(preheat_open.supplypoint.PriceData method)
(preheat_open.supplypoint.SupplyPoint method)
(preheat_open.time.DateRange method)
(preheat_open.time.SubDateRange method)
(preheat_open.time.TimeResolution method)
(preheat_open.unit.Component method)
(preheat_open.unit.ControlSetting method)
(preheat_open.unit.ControlSettings method)
(preheat_open.unit.Device method)
(preheat_open.unit.Unit method)
(preheat_open.unit.UnitDescriptors method)
(preheat_open.zone.VentilationInfo method)
(preheat_open.zone.Zone method)
A
Adapter (class in preheat_open.interfaces)
adapter (preheat_open.location.Location property)
add_data() (preheat_open.loadable_types.ComfortProfile method)
(preheat_open.loadable_types.ComfortProfiles method)
(preheat_open.loadable_types.ComponentData method)
(preheat_open.loadable_types.ElectricityPrices method)
(preheat_open.loadable_types.LoadableDataType method)
(preheat_open.loadable_types.SetpointSchedule method)
all() (preheat_open.api.configuration.UpdateProxy method)
AmbigiuousMapError
anonymize_building_model_dict() (in module preheat_open.api.mocks)
api_string_to_datetime() (in module preheat_open.api.session)
ApiAdapter (class in preheat_open.api.adapter)
APIDataExtractError
ApiSession (class in preheat_open.api.session)
ApplicationContext (class in preheat_open.supplypoint)
ApplicationType (class in preheat_open.supplypoint)
AppliedPriceComponent (class in preheat_open.supplypoint)
AppliedPriceComponentFactory (class in preheat_open.api.factories)
apply() (preheat_open.measurements.PostProcess method)
astimezone() (preheat_open.loadable_types.ComfortProfile method)
(preheat_open.loadable_types.ComfortProfiles method)
(preheat_open.loadable_types.SetpointSchedule method)
(preheat_open.time.DateRange method)
AttrMap (class in preheat_open.measurements)
Authority (class in preheat_open.supplypoint)
AuthorityFactory (class in preheat_open.api.factories)
B
BillingContext (class in preheat_open.supplypoint)
build_instance_from_dict() (in module preheat_open.query)
BuildingModel (class in preheat_open.interfaces)
BuildingType (class in preheat_open.api.types)
C
Cache (class in preheat_open.api.cache)
CacheConfig (class in preheat_open.api.configuration)
CacheConfig.TempContext (class in preheat_open.api.configuration)
CacheItem (class in preheat_open.api.cache)
CaseConverter (class in preheat_open.api.configuration)
CCDailyPeriodic (class in preheat_open.api.mocks)
CCMonotonicAscending (class in preheat_open.api.mocks)
CCNoisy (class in preheat_open.api.mocks)
CCRangeConstricted (class in preheat_open.api.mocks)
CCYearlyPeriodic (class in preheat_open.api.mocks)
check_ambigiousness() (preheat_open.measurements.Mapper method)
check_key() (preheat_open.api.cache.ShelveCache method)
check_measurement() (preheat_open.unit.Component method)
check_start_end() (preheat_open.time.SubDateRange method)
clear() (preheat_open.api.cache.ShelveCache method)
close() (preheat_open.api.cache.ShelveCache method)
(preheat_open.api.session.ApiSession method)
Collection (class in preheat_open.collection)
ComfortProfile (class in preheat_open.loadable_types)
ComfortProfileFactory (class in preheat_open.api.factories)
ComfortProfiles (class in preheat_open.loadable_types)
ComfortProfilesFactory (class in preheat_open.api.factories)
Component (class in preheat_open.unit)
ComponentCharacteristic (class in preheat_open.api.mocks)
ComponentData (class in preheat_open.loadable_types)
ComponentQuery (class in preheat_open.api.types)
ComponentType (class in preheat_open.api.types)
ConfigBase (class in preheat_open.api.configuration)
ConfigBase.TempContext (class in preheat_open.api.configuration)
ConfigLoader (class in preheat_open.api.configuration)
control_setting_types() (in module preheat_open.api.types)
ControlSetting (class in preheat_open.unit)
ControlSettingDataType (class in preheat_open.api.types)
ControlSettingFactory (class in preheat_open.api.factories)
ControlSettings (class in preheat_open.unit)
ControlSettingsFactory (class in preheat_open.api.factories)
ControlSettingType (class in preheat_open.api.types)
ControlSettingUiType (class in preheat_open.api.types)
convert_attr() (preheat_open.api.types.ComponentQuery class method)
(preheat_open.api.types.DeviceQuery class method)
(preheat_open.api.types.UnitQuery class method)
(preheat_open.api.types.ZoneQuery class method)
(preheat_open.query.Query class method)
create_map() (preheat_open.measurements.Mapper method)
D
DateRange (class in preheat_open.time)
datetime_to_api_string() (in module preheat_open.api.session)
default_column_name() (preheat_open.measurements.Mapper method)
delete() (preheat_open.api.cache.ShelveCache method)
(preheat_open.api.session.ApiSession method)
Device (class in preheat_open.unit)
DeviceComponentFactory (class in preheat_open.api.factories)
DeviceFactory (class in preheat_open.api.factories)
DeviceQuery (class in preheat_open.api.types)
devices (preheat_open.location.Location property)
E
easy_cache() (in module preheat_open.api.cache)
ElectricityPriceItem (class in preheat_open.loadable_types)
ElectricityPriceItemFactory (class in preheat_open.api.factories)
ElectricityPrices (class in preheat_open.loadable_types)
empty (preheat_open.loadable_types.SetpointSchedule property)
(preheat_open.time.DateRange property)
EndpointInformation (class in preheat_open.api.adapter)
F
Factory (class in preheat_open.interfaces)
filter() (preheat_open.collection.Collection method)
find_config_path() (preheat_open.api.configuration.ConfigLoader method)
FixedPriceData (class in preheat_open.supplypoint)
FixedPriceDataFactory (class in preheat_open.api.factories)
FixedPricePeriod (class in preheat_open.supplypoint)
FixedPricePeriodFactory (class in preheat_open.api.factories)
FormatType (class in preheat_open.supplypoint)
from_building_model_dict() (preheat_open.location.Location class method)
(preheat_open.unit.Component class method)
(preheat_open.unit.ControlSettings class method)
(preheat_open.unit.Unit class method)
(preheat_open.zone.Zone class method)
from_frame() (preheat_open.loadable_types.SetpointSchedule class method)
from_kwargs() (preheat_open.api.types.ComponentQuery class method)
(preheat_open.api.types.DeviceQuery class method)
(preheat_open.api.types.UnitQuery class method)
(preheat_open.api.types.ZoneQuery class method)
(preheat_open.query.Query class method)
from_location_ids() (preheat_open.collection.Collection class method)
from_location_information_list() (preheat_open.collection.Collection class method)
from_series() (preheat_open.loadable_types.SetpointSchedule class method)
G
gaps() (preheat_open.time.DateRange method)
generate_convention() (preheat_open.measurements.Mapper method)
generate_random_string() (in module preheat_open.api.mocks)
generate_unique_random_ints() (in module preheat_open.api.mocks)
get() (preheat_open.api.cache.ShelveCache method)
(preheat_open.api.session.ApiSession method)
(preheat_open.unit.ControlSettings method)
get_cache() (in module preheat_open.api.cache)
get_comfort_profile() (preheat_open.zone.Zone method)
get_comfort_profiles() (preheat_open.location.Location method)
get_component_type_mocks() (in module preheat_open.api.mocks)
get_components() (preheat_open.collection.Collection method)
(preheat_open.location.Location method)
(preheat_open.unit.Device method)
(preheat_open.unit.Unit method)
(preheat_open.zone.Zone method)
get_data() (preheat_open.loadable_types.ComfortProfile method)
(preheat_open.loadable_types.ComfortProfiles method)
(preheat_open.loadable_types.ComponentData method)
(preheat_open.loadable_types.ElectricityPrices method)
(preheat_open.loadable_types.LoadableDataType method)
(preheat_open.loadable_types.SetpointSchedule method)
get_devices() (preheat_open.collection.Collection method)
(preheat_open.location.Location method)
get_electricity_price() (preheat_open.unit.Unit method)
get_measurement() (preheat_open.unit.Component method)
get_measurements() (in module preheat_open.measurements)
(preheat_open.collection.Collection method)
(preheat_open.location.Location method)
(preheat_open.measurements.MeasurementsRetriever method)
(preheat_open.unit.Device method)
(preheat_open.unit.Unit method)
(preheat_open.zone.Zone method)
get_name() (preheat_open.measurements.Mapper method)
get_parents() (preheat_open.unit.Unit method)
get_profile() (preheat_open.loadable_types.ComfortProfiles method)
get_schedule() (preheat_open.unit.Unit method)
get_sub_units() (preheat_open.unit.Unit method)
get_sub_zones() (preheat_open.zone.Zone method)
get_units() (preheat_open.collection.Collection method)
(preheat_open.location.Location method)
(preheat_open.zone.Zone method)
get_zones() (preheat_open.collection.Collection method)
(preheat_open.location.Location method)
I
intersection() (preheat_open.time.DateRange method)
InvalidScheduleError
io_decorator() (in module preheat_open.api.cache)
is_type() (preheat_open.api.types.ComponentQuery class method)
(preheat_open.api.types.DeviceQuery class method)
(preheat_open.api.types.UnitQuery class method)
(preheat_open.api.types.ZoneQuery class method)
(preheat_open.query.Query class method)
isin() (preheat_open.api.types.ComponentQuery method)
(preheat_open.api.types.DeviceQuery method)
(preheat_open.api.types.UnitQuery method)
(preheat_open.api.types.ZoneQuery method)
(preheat_open.query.Query method)
iter_items() (preheat_open.api.configuration.CacheConfig method)
(preheat_open.api.configuration.ConfigBase method)
(preheat_open.api.configuration.LoggingConfig method)
(preheat_open.api.configuration.NeogridApiConfig method)
(preheat_open.api.configuration.PersonalConfig method)
iter_ranges() (preheat_open.time.DateRange method)
L
load_building_models() (preheat_open.collection.Collection method)
load_config_file() (preheat_open.api.configuration.ConfigLoader method)
LoadableData (class in preheat_open.loadable_types)
LoadableDataType (class in preheat_open.loadable_types)
Location (class in preheat_open.location)
LocationCharacteristics (class in preheat_open.location)
LocationCharacteristicsFactory (class in preheat_open.api.factories)
LocationFactory (class in preheat_open.api.factories)
LocationInformation (class in preheat_open.location)
LocationInformationFactory (class in preheat_open.api.factories)
LocationNotFoundError
log_method_call() (in module preheat_open.interfaces)
LoggingConfig (class in preheat_open.api.configuration)
LoggingConfig.TempContext (class in preheat_open.api.configuration)
lstart (preheat_open.time.DateRange property)
M
map() (preheat_open.measurements.AttrMap method)
(preheat_open.measurements.MapItem method)
(preheat_open.measurements.StrMap method)
MapItem (class in preheat_open.measurements)
Mapper (class in preheat_open.measurements)
MeasurementEndpointType (class in preheat_open.api.adapter)
MeasurementRequest (class in preheat_open.measurements)
MeasurementRequestHandler (class in preheat_open.measurements)
MeasurementsGetter (class in preheat_open.api.adapter)
MeasurementsRetriever (class in preheat_open.measurements)
merge() (preheat_open.time.SubDateRange method)
MissingElectricityContractError
mock_component_data() (in module preheat_open.api.mocks)
MockApiAdapter (class in preheat_open.api.mocks)
module
preheat_open
preheat_open.api
preheat_open.api.adapter
preheat_open.api.cache
preheat_open.api.configuration
preheat_open.api.factories
preheat_open.api.mocks
preheat_open.api.session
preheat_open.api.types
preheat_open.collection
preheat_open.interfaces
preheat_open.loadable_types
preheat_open.location
preheat_open.measurements
preheat_open.query
preheat_open.supplypoint
preheat_open.time
preheat_open.unit
preheat_open.zone
N
NeogridApiConfig (class in preheat_open.api.configuration)
NeogridApiConfig.TempContext (class in preheat_open.api.configuration)
NoElementError
NotFoundError
NoUniqueElementError
O
open() (preheat_open.api.cache.ShelveCache method)
OperationType (class in preheat_open.loadable_types)
overlap() (preheat_open.time.SubDateRange method)
P
pandas_alias (preheat_open.time.TimeResolution property)
pascal_to_snake() (preheat_open.api.configuration.CaseConverter method)
patch() (preheat_open.api.session.ApiSession method)
PersonalConfig (class in preheat_open.api.configuration)
PersonalConfig.TempContext (class in preheat_open.api.configuration)
post() (preheat_open.api.session.ApiSession method)
PostProcess (class in preheat_open.measurements)
preheat_open
module
preheat_open.api
module
preheat_open.api.adapter
module
preheat_open.api.cache
module
preheat_open.api.configuration
module
preheat_open.api.factories
module
preheat_open.api.mocks
module
preheat_open.api.session
module
preheat_open.api.types
module
preheat_open.collection
module
preheat_open.interfaces
module
preheat_open.loadable_types
module
preheat_open.location
module
preheat_open.measurements
module
preheat_open.query
module
preheat_open.supplypoint
module
preheat_open.time
module
preheat_open.unit
module
preheat_open.zone
module
prepare() (in module preheat_open.api.session)
pretty_print() (preheat_open.api.configuration.CacheConfig method)
(preheat_open.api.configuration.ConfigBase method)
(preheat_open.api.configuration.LoggingConfig method)
(preheat_open.api.configuration.NeogridApiConfig method)
(preheat_open.api.configuration.PersonalConfig method)
price_components (preheat_open.supplypoint.SupplyPoint property)
PriceArea (class in preheat_open.supplypoint)
PriceAreaFactory (class in preheat_open.api.factories)
PriceComponent (class in preheat_open.supplypoint)
PriceComponentFactory (class in preheat_open.api.factories)
PriceComponentType (class in preheat_open.supplypoint)
PriceComponentTypeFactory (class in preheat_open.api.factories)
PriceData (class in preheat_open.supplypoint)
PriceDataFactory (class in preheat_open.api.factories)
put() (preheat_open.api.session.ApiSession method)
Q
Query (class in preheat_open.query)
query_stuff() (in module preheat_open.query)
R
RelatedUnitType (class in preheat_open.api.types)
remove_overlaps() (preheat_open.time.DateRange method)
rename_dataframe() (preheat_open.measurements.Mapper method)
rend (preheat_open.time.DateRange property)
request() (preheat_open.loadable_types.LoadableData method)
request_schedule() (preheat_open.unit.Unit method)
run_if_production_mode() (in module preheat_open.api.configuration)
RuntimeMode (class in preheat_open.api.configuration)
RuntimeModeError
S
ScheduleItem (class in preheat_open.loadable_types)
ScheduleItemFactory (class in preheat_open.api.factories)
segmented (preheat_open.time.DateRange property)
set() (preheat_open.api.cache.ShelveCache method)
Setpoint (class in preheat_open.loadable_types)
SetpointFactory (class in preheat_open.api.factories)
SetpointSchedule (class in preheat_open.loadable_types)
setup_logging() (preheat_open.api.configuration.LoggingConfig method)
ShelveCache (class in preheat_open.api.cache)
SimplePickleCache (class in preheat_open.api.cache)
snake_to_pascal() (preheat_open.api.configuration.CaseConverter method)
StrMap (class in preheat_open.measurements)
SubDateRange (class in preheat_open.time)
SupplyPoint (class in preheat_open.supplypoint)
SupplyPointFactory (class in preheat_open.api.factories)
T
temporary() (preheat_open.api.configuration.CacheConfig method)
(preheat_open.api.configuration.ConfigBase method)
(preheat_open.api.configuration.LoggingConfig method)
(preheat_open.api.configuration.NeogridApiConfig method)
(preheat_open.api.configuration.PersonalConfig method)
timedelta (preheat_open.time.TimeResolution property)
TimeResolution (class in preheat_open.time)
TimestampType (class in preheat_open.api.adapter)
timestep_start() (in module preheat_open.time)
timezone (preheat_open.collection.Collection property)
(preheat_open.location.Location property)
(preheat_open.unit.Device property)
(preheat_open.unit.Unit property)
to_building_model_dict() (preheat_open.location.Location method)
(preheat_open.unit.Component method)
(preheat_open.unit.ControlSetting method)
(preheat_open.unit.ControlSettings method)
(preheat_open.unit.Unit method)
(preheat_open.zone.Zone method)
to_frame() (preheat_open.loadable_types.ComfortProfile method)
(preheat_open.loadable_types.ElectricityPrices method)
(preheat_open.loadable_types.SetpointSchedule method)
to_pandas_date_range() (preheat_open.time.DateRange method)
total_seconds (preheat_open.time.TimeResolution property)
tz_aware (preheat_open.time.DateRange property)
(preheat_open.time.SubDateRange property)
U
union() (preheat_open.time.DateRange method)
unique() (in module preheat_open.query)
Unit (class in preheat_open.unit)
UnitComponentFactory (class in preheat_open.api.factories)
UnitDescriptors (class in preheat_open.unit)
UnitDescriptorType (class in preheat_open.api.types)
UnitFactory (class in preheat_open.api.factories)
UnitQuery (class in preheat_open.api.types)
UnitSubType (class in preheat_open.api.types)
UnitType (class in preheat_open.api.types)
update (preheat_open.api.configuration.CacheConfig property)
(preheat_open.api.configuration.ConfigBase property)
(preheat_open.api.configuration.LoggingConfig property)
(preheat_open.api.configuration.NeogridApiConfig property)
(preheat_open.api.configuration.PersonalConfig property)
UpdateProxy (class in preheat_open.api.configuration)
V
VentilationInfo (class in preheat_open.zone)
W
WeatherComponentFactory (class in preheat_open.api.factories)
WeatherFactory (class in preheat_open.api.factories)
Z
Zone (class in preheat_open.zone)
ZoneFactory (class in preheat_open.api.factories)
ZoneQuery (class in preheat_open.api.types)