FloParamsBrickstorageheater

Python pydantic class corresponding to json type `flo.params.brickstorageheater`.

class gwatn.types.FloParamsBrickstorageheater(*, MaxBrickTempC=190, RatedMaxPowerKw=13.5, ROff=0.08, ROn=0.15, RoomTempF=70, CurrencyUnit=RecognizedCurrencyUnit.USD, TempUnit=RecognizedTemperatureUnit.F, TimezoneString='US/Eastern', HomeCity='MILLINOCKET_ME', IsRegulating=False, StorageSteps=100, SliceDurationMinutes=[60], PowerRequiredByHouseFromSystemAvgKwList=[3.42], C=200, RealtimeElectricityPrice=[10.35], OutsideTempF=[-5.1], DistributionPrice=[40.0], RtElecPriceUid, RegulationPrice=[25.3], WeatherUid, DistPriceUid, RegPriceUid=None, StartYearUtc=2020, StartMonthUtc=1, StartDayUtc=1, StartHourUtc=0, StartMinuteUtc=0, StartingStoreIdx=50, AmbientPowerInKw=1.25, HouseWorstCaseTempF=-7, GNodeAlias, FloParamsUid, TypeName='flo.params.brickstorageheater', Version='000')

.

FloParams for the BrickStorageHeater AtomicTNode strategy. [More info](https://gridworks-atn.readthedocs.io/en/latest/brick-storage-heater.html).

Parameters:

  • MaxBrickTempC (int) –

  • RatedMaxPowerKw (float) –

  • ROff (float) –

  • ROn (float) –

  • RoomTempF (int) –

  • CurrencyUnit (RecognizedCurrencyUnit) –

  • TempUnit (RecognizedTemperatureUnit) –

  • TimezoneString (str) –

  • HomeCity (str) –

  • IsRegulating (bool) –

  • StorageSteps (int) –

  • SliceDurationMinutes (List[int]) –

  • PowerRequiredByHouseFromSystemAvgKwList (List[float]) –

  • C (float) –

  • RealtimeElectricityPrice (List[float]) –

  • OutsideTempF (List[float]) –

  • DistributionPrice (List[float]) –

  • RtElecPriceUid (str) –

  • RegulationPrice (List[float]) –

  • WeatherUid (str) –

  • DistPriceUid (str) –

  • RegPriceUid (str | None) –

  • StartYearUtc (int) –

  • StartMonthUtc (int) –

  • StartDayUtc (int) –

  • StartHourUtc (int) –

  • StartMinuteUtc (int) –

  • StartingStoreIdx (int) –

  • AmbientPowerInKw (float) –

  • HouseWorstCaseTempF (int) –

  • GNodeAlias (str) –

  • FloParamsUid (str) –

  • TypeName (Literal['flo.params.brickstorageheater']) –

  • Version (str) –

MaxBrickTempC:

  • Description:

RatedMaxPowerKw:

  • Description:

ROff:

  • Description:

ROn:

  • Description:

RoomTempF:

  • Description:

CurrencyUnit:

  • Description:

TempUnit:

  • Description:

TimezoneString:

  • Description:

HomeCity:

  • Description:

IsRegulating:

  • Description:

StorageSteps:

  • Description:

SliceDurationMinutes:

  • Description:

PowerRequiredByHouseFromSystemAvgKwList:

  • Description:

C:

  • Description:

RealtimeElectricityPrice:

  • Description:

OutsideTempF:

  • Description:

DistributionPrice:

  • Description:

RtElecPriceUid:

  • Description:

  • Format: UuidCanonicalTextual

RegulationPrice:

  • Description:

WeatherUid:

  • Description:

  • Format: UuidCanonicalTextual

DistPriceUid:

  • Description:

  • Format: UuidCanonicalTextual

RegPriceUid:

  • Description:

  • Format: UuidCanonicalTextual

StartYearUtc:

  • Description:

StartMonthUtc:

  • Description:

StartDayUtc:

  • Description:

StartHourUtc:

  • Description:

StartMinuteUtc:

  • Description:

StartingStoreIdx:

  • Description:

AmbientPowerInKw:

  • Description:

HouseWorstCaseTempF:

  • Description:

GNodeAlias:

  • Description:

  • Format: LeftRightDot

FloParamsUid:

  • Description:

  • Format: UuidCanonicalTextual

class gwatn.types.flo_params_brickstorageheater.check_is_uuid_canonical_textual(v)

UuidCanonicalTextual format: A string of hex words separated by hyphens of length 8-4-4-4-12.

Raises:

ValueError – if not UuidCanonicalTextual format

Parameters:

v (str) –

class gwatn.types.flo_params_brickstorageheater.check_is_left_right_dot(v)

LeftRightDot format: Lowercase alphanumeric words separated by periods, most significant word (on the left) starting with an alphabet character.

Raises:

ValueError – if not LeftRightDot format

Parameters:

v (str) –

class gwatn.types.FloParamsBrickstorageheater_Maker(max_brick_temp_c, rated_max_power_kw, r_off, r_on, room_temp_f, currency_unit, temp_unit, timezone_string, home_city, is_regulating, storage_steps, slice_duration_minutes, power_required_by_house_from_system_avg_kw_list, c, realtime_electricity_price, outside_temp_f, distribution_price, rt_elec_price_uid, regulation_price, weather_uid, dist_price_uid, reg_price_uid, start_year_utc, start_month_utc, start_day_utc, start_hour_utc, start_minute_utc, starting_store_idx, ambient_power_in_kw, house_worst_case_temp_f, g_node_alias, flo_params_uid)
Parameters:

  • max_brick_temp_c (int) –

  • rated_max_power_kw (float) –

  • r_off (float) –

  • r_on (float) –

  • room_temp_f (int) –

  • currency_unit (RecognizedCurrencyUnit) –

  • temp_unit (RecognizedTemperatureUnit) –

  • timezone_string (str) –

  • home_city (str) –

  • is_regulating (bool) –

  • storage_steps (int) –

  • slice_duration_minutes (List[int]) –

  • power_required_by_house_from_system_avg_kw_list (List[float]) –

  • c (float) –

  • realtime_electricity_price (List[float]) –

  • outside_temp_f (List[float]) –

  • distribution_price (List[float]) –

  • rt_elec_price_uid (str) –

  • regulation_price (List[float]) –

  • weather_uid (str) –

  • dist_price_uid (str) –

  • reg_price_uid (str | None) –

  • start_year_utc (int) –

  • start_month_utc (int) –

  • start_day_utc (int) –

  • start_hour_utc (int) –

  • start_minute_utc (int) –

  • starting_store_idx (int) –

  • ambient_power_in_kw (float) –

  • house_worst_case_temp_f (int) –

  • g_node_alias (str) –

  • flo_params_uid (str) –

classmethod tuple_to_type(tuple)

Given a Python class object, returns the serialized JSON type object

Parameters:

tuple (FloParamsBrickstorageheater) –

Return type:

str

classmethod type_to_tuple(t)

Given a serialized JSON type object, returns the Python class object

Parameters:

t (str) –

Return type:

FloParamsBrickstorageheater